com.github.fluorumlabs.disconnect.highcharts.XAxisTitleOptions 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 axis title, showing next to the axis
* line.
*
* @see https://api.highcharts.com/highcharts/xAxis.title
* @see https://api.highcharts.com/highstock/xAxis.title
* @see https://api.highcharts.com/highmaps/xAxis.title
*
*/
public interface XAxisTitleOptions extends Any {
/**
* (Highcharts, Highstock, Highmaps) Alignment of the title relative to the
* axis values. Possible values are "low", "middle" or "high".
*
* @see https://api.highcharts.com/highcharts/xAxis.title.align
* @see https://api.highcharts.com/highstock/xAxis.title.align
* @see https://api.highcharts.com/highmaps/xAxis.title.align
*
* @implspec align?: ("high"|"low"|"middle");
*
*/
@JSProperty("align")
@Nullable
Align getAlign();
/**
* (Highcharts, Highstock, Highmaps) Alignment of the title relative to the
* axis values. Possible values are "low", "middle" or "high".
*
* @see https://api.highcharts.com/highcharts/xAxis.title.align
* @see https://api.highcharts.com/highstock/xAxis.title.align
* @see https://api.highcharts.com/highmaps/xAxis.title.align
*
* @implspec align?: ("high"|"low"|"middle");
*
*/
@JSProperty("align")
void setAlign(Align value);
/**
* (Highcharts) Deprecated. Set the text to null to disable the title.
*
* @see https://api.highcharts.com/highcharts/xAxis.title.enabled
*
* @implspec enabled?: string;
*
*/
@JSProperty("enabled")
@Nullable
String getEnabled();
/**
* (Highcharts) Deprecated. Set the text to null to disable the title.
*
* @see https://api.highcharts.com/highcharts/xAxis.title.enabled
*
* @implspec enabled?: string;
*
*/
@JSProperty("enabled")
void setEnabled(String value);
/**
* (Highcharts, Highstock, Highmaps) The pixel distance between the axis
* labels or line and the title. Defaults to 0 for horizontal axes, 10 for
* vertical
*
* @see https://api.highcharts.com/highcharts/xAxis.title.margin
* @see https://api.highcharts.com/highstock/xAxis.title.margin
* @see https://api.highcharts.com/highmaps/xAxis.title.margin
*
* @implspec margin?: number;
*
*/
@JSProperty("margin")
double getMargin();
/**
* (Highcharts, Highstock, Highmaps) The pixel distance between the axis
* labels or line and the title. Defaults to 0 for horizontal axes, 10 for
* vertical
*
* @see https://api.highcharts.com/highcharts/xAxis.title.margin
* @see https://api.highcharts.com/highstock/xAxis.title.margin
* @see https://api.highcharts.com/highmaps/xAxis.title.margin
*
* @implspec margin?: number;
*
*/
@JSProperty("margin")
void setMargin(double value);
/**
* (Highcharts, Highstock, Highmaps) The distance of the axis title from the
* axis line. By default, this distance is computed from the offset width of
* the labels, the labels' distance from the axis and the title's margin.
* However when the offset option is set, it overrides all this.
*
* @see https://api.highcharts.com/highcharts/xAxis.title.offset
* @see https://api.highcharts.com/highstock/xAxis.title.offset
* @see https://api.highcharts.com/highmaps/xAxis.title.offset
*
* @implspec offset?: number;
*
*/
@JSProperty("offset")
double getOffset();
/**
* (Highcharts, Highstock, Highmaps) The distance of the axis title from the
* axis line. By default, this distance is computed from the offset width of
* the labels, the labels' distance from the axis and the title's margin.
* However when the offset option is set, it overrides all this.
*
* @see https://api.highcharts.com/highcharts/xAxis.title.offset
* @see https://api.highcharts.com/highstock/xAxis.title.offset
* @see https://api.highcharts.com/highmaps/xAxis.title.offset
*
* @implspec offset?: number;
*
*/
@JSProperty("offset")
void setOffset(double value);
/**
* (Highcharts) Defines how the title is repositioned according to the 3D
* chart orientation.
*
*
* -
*
'offset': Maintain a fixed horizontal/vertical distance from the tick
* marks, despite the chart orientation. This is the backwards compatible
* behavior, and causes skewing of X and Z axes.
*
*
* -
*
'chart': Preserve 3D position relative to the chart. This looks nice,
* but hard to read if the text isn't forward-facing.
*
*
* -
*
'flap': Rotated text along the axis to compensate for the chart
* orientation. This tries to maintain text as legible as possible on all
* orientations.
*
*
* -
*
'ortho': Rotated text along the axis direction so that the labels are
* orthogonal to the axis. This is very similar to 'flap', but prevents
* skewing the labels (X and Y scaling are still present).
*
*
* -
*
undefined: Will use the config from labels.position3d
*
*
*
* @see https://api.highcharts.com/highcharts/xAxis.title.position3d
*
* @implspec position3d?: ("chart"|"flap"|"offset"|"ortho"|null);
*
*/
@JSProperty("position3d")
@Nullable
Position3d getPosition3d();
/**
* (Highcharts) Defines how the title is repositioned according to the 3D
* chart orientation.
*
*
* -
*
'offset': Maintain a fixed horizontal/vertical distance from the tick
* marks, despite the chart orientation. This is the backwards compatible
* behavior, and causes skewing of X and Z axes.
*
*
* -
*
'chart': Preserve 3D position relative to the chart. This looks nice,
* but hard to read if the text isn't forward-facing.
*
*
* -
*
'flap': Rotated text along the axis to compensate for the chart
* orientation. This tries to maintain text as legible as possible on all
* orientations.
*
*
* -
*
'ortho': Rotated text along the axis direction so that the labels are
* orthogonal to the axis. This is very similar to 'flap', but prevents
* skewing the labels (X and Y scaling are still present).
*
*
* -
*
undefined: Will use the config from labels.position3d
*
*
*
* @see https://api.highcharts.com/highcharts/xAxis.title.position3d
*
* @implspec position3d?: ("chart"|"flap"|"offset"|"ortho"|null);
*
*/
@JSProperty("position3d")
void setPosition3d(Position3d value);
/**
* (Highcharts, Highstock, Gantt) Whether to reserve space for the title
* when laying out the axis.
*
* @see https://api.highcharts.com/highcharts/xAxis.title.reserveSpace
* @see https://api.highcharts.com/highstock/xAxis.title.reserveSpace
* @see https://api.highcharts.com/gantt/xAxis.title.reserveSpace
*
* @implspec reserveSpace?: boolean;
*
*/
@JSProperty("reserveSpace")
boolean getReserveSpace();
/**
* (Highcharts, Highstock, Gantt) Whether to reserve space for the title
* when laying out the axis.
*
* @see https://api.highcharts.com/highcharts/xAxis.title.reserveSpace
* @see https://api.highcharts.com/highstock/xAxis.title.reserveSpace
* @see https://api.highcharts.com/gantt/xAxis.title.reserveSpace
*
* @implspec reserveSpace?: boolean;
*
*/
@JSProperty("reserveSpace")
void setReserveSpace(boolean value);
/**
* (Highcharts, Highstock, Highmaps) The rotation of the text in degrees. 0
* is horizontal, 270 is vertical reading from bottom to top.
*
* @see https://api.highcharts.com/highcharts/xAxis.title.rotation
* @see https://api.highcharts.com/highstock/xAxis.title.rotation
* @see https://api.highcharts.com/highmaps/xAxis.title.rotation
*
* @implspec rotation?: number;
*
*/
@JSProperty("rotation")
double getRotation();
/**
* (Highcharts, Highstock, Highmaps) The rotation of the text in degrees. 0
* is horizontal, 270 is vertical reading from bottom to top.
*
* @see https://api.highcharts.com/highcharts/xAxis.title.rotation
* @see https://api.highcharts.com/highstock/xAxis.title.rotation
* @see https://api.highcharts.com/highmaps/xAxis.title.rotation
*
* @implspec rotation?: number;
*
*/
@JSProperty("rotation")
void setRotation(double value);
/**
* (Highcharts) If enabled, the axis title will skewed to follow the
* perspective.
*
* This will fix overlapping labels and titles, but texts become less
* legible due to the distortion.
*
* The final appearance depends heavily on title.position3d.
*
* A null value will use the config from labels.skew3d.
*
* @see https://api.highcharts.com/highcharts/xAxis.title.skew3d
*
* @implspec skew3d?: (boolean|null);
*
*/
@JSProperty("skew3d")
boolean getSkew3d();
/**
* (Highcharts) If enabled, the axis title will skewed to follow the
* perspective.
*
* This will fix overlapping labels and titles, but texts become less
* legible due to the distortion.
*
* The final appearance depends heavily on title.position3d.
*
* A null value will use the config from labels.skew3d.
*
* @see https://api.highcharts.com/highcharts/xAxis.title.skew3d
*
* @implspec skew3d?: (boolean|null);
*
*/
@JSProperty("skew3d")
void setSkew3d(boolean value);
/**
* (Highcharts, Highstock, Highmaps) CSS styles for the title. If the title
* text is longer than the axis length, it will wrap to multiple lines by
* default. This can be customized by setting textOverflow: 'ellipsis', by
* setting a specific width or by setting whiteSpace: 'nowrap'.
*
* In styled mode, the stroke width is given in the .highcharts-axis-title
* class.
*
* @see https://api.highcharts.com/highcharts/xAxis.title.style
* @see https://api.highcharts.com/highstock/xAxis.title.style
* @see https://api.highcharts.com/highmaps/xAxis.title.style
*
* @implspec style?: CSSObject;
*
*/
@JSProperty("style")
@Nullable
CSSObject getStyle();
/**
* (Highcharts, Highstock, Highmaps) CSS styles for the title. If the title
* text is longer than the axis length, it will wrap to multiple lines by
* default. This can be customized by setting textOverflow: 'ellipsis', by
* setting a specific width or by setting whiteSpace: 'nowrap'.
*
* In styled mode, the stroke width is given in the .highcharts-axis-title
* class.
*
* @see https://api.highcharts.com/highcharts/xAxis.title.style
* @see https://api.highcharts.com/highstock/xAxis.title.style
* @see https://api.highcharts.com/highmaps/xAxis.title.style
*
* @implspec style?: CSSObject;
*
*/
@JSProperty("style")
void setStyle(CSSObject value);
/**
* (Highcharts, Highstock, Highmaps) The actual text of the axis title. It
* can contain basic HTML text markup like , and spans with style.
*
* @see https://api.highcharts.com/highcharts/xAxis.title.text
* @see https://api.highcharts.com/highstock/xAxis.title.text
* @see https://api.highcharts.com/highmaps/xAxis.title.text
*
* @implspec text?: (string|null);
*
*/
@JSProperty("text")
@Nullable
String getText();
/**
* (Highcharts, Highstock, Highmaps) The actual text of the axis title. It
* can contain basic HTML text markup like , and spans with style.
*
* @see https://api.highcharts.com/highcharts/xAxis.title.text
* @see https://api.highcharts.com/highstock/xAxis.title.text
* @see https://api.highcharts.com/highmaps/xAxis.title.text
*
* @implspec text?: (string|null);
*
*/
@JSProperty("text")
void setText(String value);
/**
* (Highcharts, Highstock, Highmaps) Alignment of the text, can be "left",
* "right" or "center". Default alignment depends on the title.align:
*
* Horizontal axes:
*
*
* -
* for
align = "low", textAlign is set to left
*
*
* -
* for
align = "middle", textAlign is set to center
*
*
* -
* for
align = "high", textAlign is set to right
*
*
*
* Vertical axes:
*
*
* -
* for
align = "low" and opposite = true, textAlign is set to
* right
*
*
* -
* for
align = "low" and opposite = false, textAlign is set to
* left
*
*
* -
* for
align = "middle", textAlign is set to center
*
*
* -
* for
align = "high" and opposite = true textAlign is set to
* left
*
*
* -
* for
align = "high" and opposite = false textAlign is set to
* right
*
*
*
* @see https://api.highcharts.com/highcharts/xAxis.title.textAlign
* @see https://api.highcharts.com/highstock/xAxis.title.textAlign
* @see https://api.highcharts.com/highmaps/xAxis.title.textAlign
*
* @implspec textAlign?: string;
*
*/
@JSProperty("textAlign")
@Nullable
String getTextAlign();
/**
* (Highcharts, Highstock, Highmaps) Alignment of the text, can be "left",
* "right" or "center". Default alignment depends on the title.align:
*
* Horizontal axes:
*
*
* -
* for
align = "low", textAlign is set to left
*
*
* -
* for
align = "middle", textAlign is set to center
*
*
* -
* for
align = "high", textAlign is set to right
*
*
*
* Vertical axes:
*
*
* -
* for
align = "low" and opposite = true, textAlign is set to
* right
*
*
* -
* for
align = "low" and opposite = false, textAlign is set to
* left
*
*
* -
* for
align = "middle", textAlign is set to center
*
*
* -
* for
align = "high" and opposite = true textAlign is set to
* left
*
*
* -
* for
align = "high" and opposite = false textAlign is set to
* right
*
*
*
* @see https://api.highcharts.com/highcharts/xAxis.title.textAlign
* @see https://api.highcharts.com/highstock/xAxis.title.textAlign
* @see https://api.highcharts.com/highmaps/xAxis.title.textAlign
*
* @implspec textAlign?: string;
*
*/
@JSProperty("textAlign")
void setTextAlign(String value);
/**
* (Highcharts, Highstock, Gantt) Whether to use HTML to render the axis
* title.
*
* @see https://api.highcharts.com/highcharts/xAxis.title.useHTML
* @see https://api.highcharts.com/highstock/xAxis.title.useHTML
* @see https://api.highcharts.com/gantt/xAxis.title.useHTML
*
* @implspec useHTML?: boolean;
*
*/
@JSProperty("useHTML")
boolean getUseHTML();
/**
* (Highcharts, Highstock, Gantt) Whether to use HTML to render the axis
* title.
*
* @see https://api.highcharts.com/highcharts/xAxis.title.useHTML
* @see https://api.highcharts.com/highstock/xAxis.title.useHTML
* @see https://api.highcharts.com/gantt/xAxis.title.useHTML
*
* @implspec useHTML?: boolean;
*
*/
@JSProperty("useHTML")
void setUseHTML(boolean value);
/**
* (Highcharts, Highstock, Gantt) Horizontal pixel offset of the title
* position.
*
* @see https://api.highcharts.com/highcharts/xAxis.title.x
* @see https://api.highcharts.com/highstock/xAxis.title.x
* @see https://api.highcharts.com/gantt/xAxis.title.x
*
* @implspec x?: number;
*
*/
@JSProperty("x")
double getX();
/**
* (Highcharts, Highstock, Gantt) Horizontal pixel offset of the title
* position.
*
* @see https://api.highcharts.com/highcharts/xAxis.title.x
* @see https://api.highcharts.com/highstock/xAxis.title.x
* @see https://api.highcharts.com/gantt/xAxis.title.x
*
* @implspec x?: number;
*
*/
@JSProperty("x")
void setX(double value);
/**
* (Highcharts, Highstock, Gantt) Vertical pixel offset of the title
* position.
*
* @see https://api.highcharts.com/highcharts/xAxis.title.y
* @see https://api.highcharts.com/highstock/xAxis.title.y
* @see https://api.highcharts.com/gantt/xAxis.title.y
*
* @implspec y?: number;
*
*/
@JSProperty("y")
double getY();
/**
* (Highcharts, Highstock, Gantt) Vertical pixel offset of the title
* position.
*
* @see https://api.highcharts.com/highcharts/xAxis.title.y
* @see https://api.highcharts.com/highstock/xAxis.title.y
* @see https://api.highcharts.com/gantt/xAxis.title.y
*
* @implspec y?: number;
*
*/
@JSProperty("y")
void setY(double value);
/**
*/
abstract class Align extends JsEnum {
public static final Align HIGH = JsEnum.of("high");
public static final Align LOW = JsEnum.of("low");
public static final Align MIDDLE = JsEnum.of("middle");
}
/**
*/
abstract class Position3d extends JsEnum {
public static final Position3d CHART = JsEnum.of("chart");
public static final Position3d FLAP = JsEnum.of("flap");
public static final Position3d OFFSET = JsEnum.of("offset");
public static final Position3d ORTHO = JsEnum.of("ortho");
}
}