com.github.fluorumlabs.disconnect.highcharts.SubtitleOptions Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of disconnect-highcharts Show documentation
Show all versions of disconnect-highcharts Show documentation
Highcharts API bindings for Disconnect Zero
package com.github.fluorumlabs.disconnect.highcharts;
import java.lang.String;
import javax.annotation.Nullable;
import js.extras.JsEnum;
import js.lang.Any;
import org.teavm.jso.JSProperty;
/**
* (Highcharts, Highstock, Highmaps) The chart's subtitle. This can be used both
* to display a subtitle below the main title, and to display random text
* anywhere in the chart. The subtitle can be updated after chart initialization
* through the Chart.setTitle method.
*
* @see https://api.highcharts.com/highcharts/subtitle
* @see https://api.highcharts.com/highstock/subtitle
* @see https://api.highcharts.com/highmaps/subtitle
*
*/
public interface SubtitleOptions extends Any {
/**
* (Highcharts, Highstock, Highmaps) The horizontal alignment of the
* subtitle. Can be one of "left", "center" and "right".
*
* @see https://api.highcharts.com/highcharts/subtitle.align
* @see https://api.highcharts.com/highstock/subtitle.align
* @see https://api.highcharts.com/highmaps/subtitle.align
*
* @implspec align?: ("center"|"left"|"right");
*
*/
@JSProperty("align")
@Nullable
Align getAlign();
/**
* (Highcharts, Highstock, Highmaps) The horizontal alignment of the
* subtitle. Can be one of "left", "center" and "right".
*
* @see https://api.highcharts.com/highcharts/subtitle.align
* @see https://api.highcharts.com/highstock/subtitle.align
* @see https://api.highcharts.com/highmaps/subtitle.align
*
* @implspec align?: ("center"|"left"|"right");
*
*/
@JSProperty("align")
void setAlign(Align value);
/**
* (Highcharts, Highstock, Highmaps) When the subtitle is floating, the plot
* area will not move to make space for it.
*
* @see https://api.highcharts.com/highcharts/subtitle.floating
* @see https://api.highcharts.com/highstock/subtitle.floating
* @see https://api.highcharts.com/highmaps/subtitle.floating
*
* @implspec floating?: boolean;
*
*/
@JSProperty("floating")
boolean getFloating();
/**
* (Highcharts, Highstock, Highmaps) When the subtitle is floating, the plot
* area will not move to make space for it.
*
* @see https://api.highcharts.com/highcharts/subtitle.floating
* @see https://api.highcharts.com/highstock/subtitle.floating
* @see https://api.highcharts.com/highmaps/subtitle.floating
*
* @implspec floating?: boolean;
*
*/
@JSProperty("floating")
void setFloating(boolean value);
/**
* (Highcharts, Highstock, Highmaps) CSS styles for the title.
*
* In styled mode, the subtitle style is given in the .highcharts-subtitle
* class.
*
* @see https://api.highcharts.com/highcharts/subtitle.style
* @see https://api.highcharts.com/highstock/subtitle.style
* @see https://api.highcharts.com/highmaps/subtitle.style
*
* @implspec style?: CSSObject;
*
*/
@JSProperty("style")
@Nullable
CSSObject getStyle();
/**
* (Highcharts, Highstock, Highmaps) CSS styles for the title.
*
* In styled mode, the subtitle style is given in the .highcharts-subtitle
* class.
*
* @see https://api.highcharts.com/highcharts/subtitle.style
* @see https://api.highcharts.com/highstock/subtitle.style
* @see https://api.highcharts.com/highmaps/subtitle.style
*
* @implspec style?: CSSObject;
*
*/
@JSProperty("style")
void setStyle(CSSObject value);
/**
* (Highcharts, Highstock, Highmaps) The subtitle of the chart.
*
* @see https://api.highcharts.com/highcharts/subtitle.text
* @see https://api.highcharts.com/highstock/subtitle.text
* @see https://api.highcharts.com/highmaps/subtitle.text
*
* @implspec text?: string;
*
*/
@JSProperty("text")
@Nullable
String getText();
/**
* (Highcharts, Highstock, Highmaps) The subtitle of the chart.
*
* @see https://api.highcharts.com/highcharts/subtitle.text
* @see https://api.highcharts.com/highstock/subtitle.text
* @see https://api.highcharts.com/highmaps/subtitle.text
*
* @implspec text?: string;
*
*/
@JSProperty("text")
void setText(String value);
/**
* (Highcharts, Highstock, Highmaps) Whether to use HTML to render the text.
*
* @see https://api.highcharts.com/highcharts/subtitle.useHTML
* @see https://api.highcharts.com/highstock/subtitle.useHTML
* @see https://api.highcharts.com/highmaps/subtitle.useHTML
*
* @implspec useHTML?: boolean;
*
*/
@JSProperty("useHTML")
boolean getUseHTML();
/**
* (Highcharts, Highstock, Highmaps) Whether to use HTML to render the text.
*
* @see https://api.highcharts.com/highcharts/subtitle.useHTML
* @see https://api.highcharts.com/highstock/subtitle.useHTML
* @see https://api.highcharts.com/highmaps/subtitle.useHTML
*
* @implspec useHTML?: boolean;
*
*/
@JSProperty("useHTML")
void setUseHTML(boolean value);
/**
* (Highcharts, Highstock, Highmaps) The vertical alignment of the title.
* Can be one of "top", "middle" and "bottom". When a value is given, the
* title behaves as floating.
*
* @see https://api.highcharts.com/highcharts/subtitle.verticalAlign
* @see https://api.highcharts.com/highstock/subtitle.verticalAlign
* @see https://api.highcharts.com/highmaps/subtitle.verticalAlign
*
* @implspec verticalAlign?: ("bottom"|"middle"|"top");
*
*/
@JSProperty("verticalAlign")
@Nullable
VerticalAlign getVerticalAlign();
/**
* (Highcharts, Highstock, Highmaps) The vertical alignment of the title.
* Can be one of "top", "middle" and "bottom". When a value is given, the
* title behaves as floating.
*
* @see https://api.highcharts.com/highcharts/subtitle.verticalAlign
* @see https://api.highcharts.com/highstock/subtitle.verticalAlign
* @see https://api.highcharts.com/highmaps/subtitle.verticalAlign
*
* @implspec verticalAlign?: ("bottom"|"middle"|"top");
*
*/
@JSProperty("verticalAlign")
void setVerticalAlign(VerticalAlign value);
/**
* (Highcharts, Highstock, Highmaps) Adjustment made to the subtitle width,
* normally to reserve space for the exporting burger menu.
*
* @see https://api.highcharts.com/highcharts/subtitle.widthAdjust
* @see https://api.highcharts.com/highstock/subtitle.widthAdjust
* @see https://api.highcharts.com/highmaps/subtitle.widthAdjust
*
* @implspec widthAdjust?: number;
*
*/
@JSProperty("widthAdjust")
double getWidthAdjust();
/**
* (Highcharts, Highstock, Highmaps) Adjustment made to the subtitle width,
* normally to reserve space for the exporting burger menu.
*
* @see https://api.highcharts.com/highcharts/subtitle.widthAdjust
* @see https://api.highcharts.com/highstock/subtitle.widthAdjust
* @see https://api.highcharts.com/highmaps/subtitle.widthAdjust
*
* @implspec widthAdjust?: number;
*
*/
@JSProperty("widthAdjust")
void setWidthAdjust(double value);
/**
* (Highcharts, Highstock, Highmaps) The x position of the subtitle relative
* to the alignment within chart.spacingLeft and chart.spacingRight.
*
* @see https://api.highcharts.com/highcharts/subtitle.x
* @see https://api.highcharts.com/highstock/subtitle.x
* @see https://api.highcharts.com/highmaps/subtitle.x
*
* @implspec x?: number;
*
*/
@JSProperty("x")
double getX();
/**
* (Highcharts, Highstock, Highmaps) The x position of the subtitle relative
* to the alignment within chart.spacingLeft and chart.spacingRight.
*
* @see https://api.highcharts.com/highcharts/subtitle.x
* @see https://api.highcharts.com/highstock/subtitle.x
* @see https://api.highcharts.com/highmaps/subtitle.x
*
* @implspec x?: number;
*
*/
@JSProperty("x")
void setX(double value);
/**
* (Highcharts, Highstock, Highmaps) The y position of the subtitle relative
* to the alignment within chart.spacingTop and chart.spacingBottom. By
* default the subtitle is laid out below the title unless the title is
* floating.
*
* @see https://api.highcharts.com/highcharts/subtitle.y
* @see https://api.highcharts.com/highstock/subtitle.y
* @see https://api.highcharts.com/highmaps/subtitle.y
*
* @implspec y?: number;
*
*/
@JSProperty("y")
double getY();
/**
* (Highcharts, Highstock, Highmaps) The y position of the subtitle relative
* to the alignment within chart.spacingTop and chart.spacingBottom. By
* default the subtitle is laid out below the title unless the title is
* floating.
*
* @see https://api.highcharts.com/highcharts/subtitle.y
* @see https://api.highcharts.com/highstock/subtitle.y
* @see https://api.highcharts.com/highmaps/subtitle.y
*
* @implspec y?: number;
*
*/
@JSProperty("y")
void setY(double value);
/**
*/
abstract class Align extends JsEnum {
public static final Align CENTER = JsEnum.of("center");
public static final Align LEFT = JsEnum.of("left");
public static final Align RIGHT = JsEnum.of("right");
}
/**
*/
abstract class VerticalAlign extends JsEnum {
public static final VerticalAlign BOTTOM = JsEnum.of("bottom");
public static final VerticalAlign MIDDLE = JsEnum.of("middle");
public static final VerticalAlign TOP = JsEnum.of("top");
}
}