com.github.fluorumlabs.disconnect.highcharts.NavigatorYAxisLabelsOptions 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 js.util.collections.Array;
import org.teavm.jso.JSProperty;
/**
* (Highstock) The axis labels show the number or category for each tick.
*
* @see https://api.highcharts.com/highstock/navigator.yAxis.labels
*
*/
public interface NavigatorYAxisLabelsOptions extends Any {
/**
* (Highstock) What part of the string the given position is anchored to.
* Can be one of "left", "center" or "right". The exact position also
* depends on the labels.x setting.
*
* Angular gauges and solid gauges defaults to center.
*
* @see https://api.highcharts.com/highstock/navigator.yAxis.labels.align
*
* @implspec align?: ("center"|"left"|"right");
*
*/
@JSProperty("align")
@Nullable
Align getAlign();
/**
* (Highstock) What part of the string the given position is anchored to.
* Can be one of "left", "center" or "right". The exact position also
* depends on the labels.x setting.
*
* Angular gauges and solid gauges defaults to center.
*
* @see https://api.highcharts.com/highstock/navigator.yAxis.labels.align
*
* @implspec align?: ("center"|"left"|"right");
*
*/
@JSProperty("align")
void setAlign(Align value);
/**
* (Highcharts, Highstock, Gantt) For horizontal axes, the allowed degrees
* of label rotation to prevent overlapping labels. If there is enough
* space, labels are not rotated. As the chart gets narrower, it will start
* rotating the labels -45 degrees, then remove every second label and try
* again with rotations 0 and -45 etc. Set it to false to disable
* rotation, which will cause the labels to word-wrap if possible.
*
* @see https://api.highcharts.com/highcharts/navigator.yAxis.labels.autoRotation
* @see https://api.highcharts.com/highstock/navigator.yAxis.labels.autoRotation
* @see https://api.highcharts.com/gantt/navigator.yAxis.labels.autoRotation
*
* @implspec autoRotation?: Array;
*
*/
@JSProperty("autoRotation")
@Nullable
double[] getAutoRotation();
/**
* (Highcharts, Highstock, Gantt) For horizontal axes, the allowed degrees
* of label rotation to prevent overlapping labels. If there is enough
* space, labels are not rotated. As the chart gets narrower, it will start
* rotating the labels -45 degrees, then remove every second label and try
* again with rotations 0 and -45 etc. Set it to false to disable
* rotation, which will cause the labels to word-wrap if possible.
*
* @see https://api.highcharts.com/highcharts/navigator.yAxis.labels.autoRotation
* @see https://api.highcharts.com/highstock/navigator.yAxis.labels.autoRotation
* @see https://api.highcharts.com/gantt/navigator.yAxis.labels.autoRotation
*
* @implspec autoRotation?: Array;
*
*/
@JSProperty("autoRotation")
void setAutoRotation(double[] value);
/**
* (Highcharts, Gantt) When each category width is more than this many
* pixels, we don't apply auto rotation. Instead, we lay out the axis label
* with word wrap. A lower limit makes sense when the label contains
* multiple short words that don't extend the available horizontal space for
* each label.
*
* @see https://api.highcharts.com/highcharts/navigator.yAxis.labels.autoRotationLimit
* @see https://api.highcharts.com/gantt/navigator.yAxis.labels.autoRotationLimit
*
* @implspec autoRotationLimit?: number;
*
*/
@JSProperty("autoRotationLimit")
double getAutoRotationLimit();
/**
* (Highcharts, Gantt) When each category width is more than this many
* pixels, we don't apply auto rotation. Instead, we lay out the axis label
* with word wrap. A lower limit makes sense when the label contains
* multiple short words that don't extend the available horizontal space for
* each label.
*
* @see https://api.highcharts.com/highcharts/navigator.yAxis.labels.autoRotationLimit
* @see https://api.highcharts.com/gantt/navigator.yAxis.labels.autoRotationLimit
*
* @implspec autoRotationLimit?: number;
*
*/
@JSProperty("autoRotationLimit")
void setAutoRotationLimit(double value);
/**
* (Highcharts) Angular gauges and solid gauges only. The label's pixel
* distance from the perimeter of the plot area.
*
* @see https://api.highcharts.com/highcharts/navigator.yAxis.labels.distance
*
* @implspec distance?: number;
*
*/
@JSProperty("distance")
double getDistance();
/**
* (Highcharts) Angular gauges and solid gauges only. The label's pixel
* distance from the perimeter of the plot area.
*
* @see https://api.highcharts.com/highcharts/navigator.yAxis.labels.distance
*
* @implspec distance?: number;
*
*/
@JSProperty("distance")
void setDistance(double value);
/**
* (Highstock) Enable or disable the axis labels.
*
* @see https://api.highcharts.com/highstock/navigator.yAxis.labels.enabled
*
* @implspec enabled?: boolean;
*
*/
@JSProperty("enabled")
boolean getEnabled();
/**
* (Highstock) Enable or disable the axis labels.
*
* @see https://api.highcharts.com/highstock/navigator.yAxis.labels.enabled
*
* @implspec enabled?: boolean;
*
*/
@JSProperty("enabled")
void setEnabled(boolean value);
/**
* (Highstock) A format string for the axis label.
*
* @see https://api.highcharts.com/highstock/navigator.yAxis.labels.format
*
* @implspec format?: string;
*
*/
@JSProperty("format")
@Nullable
String getFormat();
/**
* (Highstock) A format string for the axis label.
*
* @see https://api.highcharts.com/highstock/navigator.yAxis.labels.format
*
* @implspec format?: string;
*
*/
@JSProperty("format")
void setFormat(String value);
/**
* (Highstock) Callback JavaScript function to format the label. The value
* is given by this.value. Additional properties for this are axis,
* chart, isFirst and isLast. The value of the default label formatter
* can be retrieved by calling this.axis.defaultLabelFormatter.call(this)
* within the function.
*
* Defaults to:
*
* (see online documentation for example)
*
* @see https://api.highcharts.com/highstock/navigator.yAxis.labels.formatter
*
* @implspec formatter?: FormatterCallbackFunction;
*
*/
@JSProperty("formatter")
@Nullable
FormatterCallbackFunction getFormatter();
/**
* (Highstock) Callback JavaScript function to format the label. The value
* is given by this.value. Additional properties for this are axis,
* chart, isFirst and isLast. The value of the default label formatter
* can be retrieved by calling this.axis.defaultLabelFormatter.call(this)
* within the function.
*
* Defaults to:
*
* (see online documentation for example)
*
* @see https://api.highcharts.com/highstock/navigator.yAxis.labels.formatter
*
* @implspec formatter?: FormatterCallbackFunction;
*
*/
@JSProperty("formatter")
void setFormatter(FormatterCallbackFunction value);
/**
* (Gantt) The number of pixels to indent the labels per level in a treegrid
* axis.
*
* @see https://api.highcharts.com/gantt/navigator.yAxis.labels.indentation
*
* @implspec indentation?: number;
*
*/
@JSProperty("indentation")
double getIndentation();
/**
* (Gantt) The number of pixels to indent the labels per level in a treegrid
* axis.
*
* @see https://api.highcharts.com/gantt/navigator.yAxis.labels.indentation
*
* @implspec indentation?: number;
*
*/
@JSProperty("indentation")
void setIndentation(double value);
/**
* (Gantt) Set options on specific levels in a tree grid axis. Takes
* precedence over labels options.
*
* @see https://api.highcharts.com/gantt/navigator.yAxis.labels.levels
*
* @implspec levels?: Array;
*
*/
@JSProperty("levels")
@Nullable
Array getLevels();
/**
* (Gantt) Set options on specific levels in a tree grid axis. Takes
* precedence over labels options.
*
* @see https://api.highcharts.com/gantt/navigator.yAxis.labels.levels
*
* @implspec levels?: Array;
*
*/
@JSProperty("levels")
void setLevels(Array value);
/**
* (Highstock) Horizontal axis only. When staggerLines is not set,
* maxStaggerLines defines how many lines the axis is allowed to add to
* automatically avoid overlapping X labels. Set to 1 to disable overlap
* detection.
*
* @see https://api.highcharts.com/highstock/navigator.yAxis.labels.maxStaggerLines
*
* @implspec maxStaggerLines?: number;
*
*/
@JSProperty("maxStaggerLines")
double getMaxStaggerLines();
/**
* (Highstock) Horizontal axis only. When staggerLines is not set,
* maxStaggerLines defines how many lines the axis is allowed to add to
* automatically avoid overlapping X labels. Set to 1 to disable overlap
* detection.
*
* @see https://api.highcharts.com/highstock/navigator.yAxis.labels.maxStaggerLines
*
* @implspec maxStaggerLines?: number;
*
*/
@JSProperty("maxStaggerLines")
void setMaxStaggerLines(double value);
/**
* (Highstock) How to handle overflowing labels on horizontal axis. If set
* to "allow", it will not be aligned at all. By default it "justify"
* labels inside the chart area. If there is room to move it, it will be
* aligned to the edge, else it will be removed.
*
* @see https://api.highcharts.com/highstock/navigator.yAxis.labels.overflow
*
* @implspec overflow?: ("allow"|"justify");
*
*/
@JSProperty("overflow")
@Nullable
Overflow getOverflow();
/**
* (Highstock) How to handle overflowing labels on horizontal axis. If set
* to "allow", it will not be aligned at all. By default it "justify"
* labels inside the chart area. If there is room to move it, it will be
* aligned to the edge, else it will be removed.
*
* @see https://api.highcharts.com/highstock/navigator.yAxis.labels.overflow
*
* @implspec overflow?: ("allow"|"justify");
*
*/
@JSProperty("overflow")
void setOverflow(Overflow value);
/**
* (Highcharts, Gantt) The pixel padding for axis labels, to ensure white
* space between them.
*
* @see https://api.highcharts.com/highcharts/navigator.yAxis.labels.padding
* @see https://api.highcharts.com/gantt/navigator.yAxis.labels.padding
*
* @implspec padding?: number;
*
*/
@JSProperty("padding")
double getPadding();
/**
* (Highcharts, Gantt) The pixel padding for axis labels, to ensure white
* space between them.
*
* @see https://api.highcharts.com/highcharts/navigator.yAxis.labels.padding
* @see https://api.highcharts.com/gantt/navigator.yAxis.labels.padding
*
* @implspec padding?: number;
*
*/
@JSProperty("padding")
void setPadding(double value);
/**
* (Highcharts) Defines how the labels are be 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).
*
*
*
* @see https://api.highcharts.com/highcharts/navigator.yAxis.labels.position3d
*
* @implspec position3d?: ("chart"|"flap"|"offset"|"ortho");
*
*/
@JSProperty("position3d")
@Nullable
Position3d getPosition3d();
/**
* (Highcharts) Defines how the labels are be 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).
*
*
*
* @see https://api.highcharts.com/highcharts/navigator.yAxis.labels.position3d
*
* @implspec position3d?: ("chart"|"flap"|"offset"|"ortho");
*
*/
@JSProperty("position3d")
void setPosition3d(Position3d value);
/**
* (Highcharts, Gantt) Whether to reserve space for the labels. By default,
* space is reserved for the labels in these cases:
*
*
* -
* On all horizontal axes.
*
*
* -
* On vertical axes if
label.align is right on a left-side axis or
* left on a right-side axis.
*
*
* -
* On vertical axes if
label.align is center.
*
*
*
* This can be turned off when for example the labels are rendered inside
* the plot area instead of outside.
*
* @see https://api.highcharts.com/highcharts/navigator.yAxis.labels.reserveSpace
* @see https://api.highcharts.com/gantt/navigator.yAxis.labels.reserveSpace
*
* @implspec reserveSpace?: boolean;
*
*/
@JSProperty("reserveSpace")
boolean getReserveSpace();
/**
* (Highcharts, Gantt) Whether to reserve space for the labels. By default,
* space is reserved for the labels in these cases:
*
*
* -
* On all horizontal axes.
*
*
* -
* On vertical axes if
label.align is right on a left-side axis or
* left on a right-side axis.
*
*
* -
* On vertical axes if
label.align is center.
*
*
*
* This can be turned off when for example the labels are rendered inside
* the plot area instead of outside.
*
* @see https://api.highcharts.com/highcharts/navigator.yAxis.labels.reserveSpace
* @see https://api.highcharts.com/gantt/navigator.yAxis.labels.reserveSpace
*
* @implspec reserveSpace?: boolean;
*
*/
@JSProperty("reserveSpace")
void setReserveSpace(boolean value);
/**
* (Highstock) Rotation of the labels in degrees.
*
* @see https://api.highcharts.com/highstock/navigator.yAxis.labels.rotation
*
* @implspec rotation?: number;
*
*/
@JSProperty("rotation")
double getRotation();
/**
* (Highstock) Rotation of the labels in degrees.
*
* @see https://api.highcharts.com/highstock/navigator.yAxis.labels.rotation
*
* @implspec rotation?: number;
*
*/
@JSProperty("rotation")
void setRotation(double value);
/**
* (Highcharts) If enabled, the axis labels 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 labels.position3d.
*
* @see https://api.highcharts.com/highcharts/navigator.yAxis.labels.skew3d
*
* @implspec skew3d?: boolean;
*
*/
@JSProperty("skew3d")
boolean getSkew3d();
/**
* (Highcharts) If enabled, the axis labels 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 labels.position3d.
*
* @see https://api.highcharts.com/highcharts/navigator.yAxis.labels.skew3d
*
* @implspec skew3d?: boolean;
*
*/
@JSProperty("skew3d")
void setSkew3d(boolean value);
/**
* (Highstock) Horizontal axes only. The number of lines to spread the
* labels over to make room or tighter labels.
*
* @see https://api.highcharts.com/highstock/navigator.yAxis.labels.staggerLines
*
* @implspec staggerLines?: number;
*
*/
@JSProperty("staggerLines")
double getStaggerLines();
/**
* (Highstock) Horizontal axes only. The number of lines to spread the
* labels over to make room or tighter labels.
*
* @see https://api.highcharts.com/highstock/navigator.yAxis.labels.staggerLines
*
* @implspec staggerLines?: number;
*
*/
@JSProperty("staggerLines")
void setStaggerLines(double value);
/**
* (Highstock) To show only every n'th label on the axis, set the step to
* n. Setting the step to 2 shows every other label.
*
* By default, the step is calculated automatically to avoid overlap. To
* prevent this, set it to 1. This usually only happens on a category axis,
* and is often a sign that you have chosen the wrong axis type.
*
* Read more at Axis docs => What axis should I use?
*
* @see https://api.highcharts.com/highstock/navigator.yAxis.labels.step
*
* @implspec step?: number;
*
*/
@JSProperty("step")
double getStep();
/**
* (Highstock) To show only every n'th label on the axis, set the step to
* n. Setting the step to 2 shows every other label.
*
* By default, the step is calculated automatically to avoid overlap. To
* prevent this, set it to 1. This usually only happens on a category axis,
* and is often a sign that you have chosen the wrong axis type.
*
* Read more at Axis docs => What axis should I use?
*
* @see https://api.highcharts.com/highstock/navigator.yAxis.labels.step
*
* @implspec step?: number;
*
*/
@JSProperty("step")
void setStep(double value);
/**
* (Highstock) CSS styles for the label. Use whiteSpace: 'nowrap' to
* prevent wrapping of category labels. Use textOverflow: 'none' to
* prevent ellipsis (dots).
*
* In styled mode, the labels are styled with the .highcharts-axis-labels
* class.
*
* @see https://api.highcharts.com/highstock/navigator.yAxis.labels.style
*
* @implspec style?: CSSObject;
*
*/
@JSProperty("style")
@Nullable
CSSObject getStyle();
/**
* (Highstock) CSS styles for the label. Use whiteSpace: 'nowrap' to
* prevent wrapping of category labels. Use textOverflow: 'none' to
* prevent ellipsis (dots).
*
* In styled mode, the labels are styled with the .highcharts-axis-labels
* class.
*
* @see https://api.highcharts.com/highstock/navigator.yAxis.labels.style
*
* @implspec style?: CSSObject;
*
*/
@JSProperty("style")
void setStyle(CSSObject value);
/**
* (Gantt) The symbol for the collapse and expand icon in a treegrid.
*
* @see https://api.highcharts.com/gantt/navigator.yAxis.labels.symbol
*
* @implspec symbol?: NavigatorYAxisLabelsSymbolOptions;
*
*/
@JSProperty("symbol")
@Nullable
NavigatorYAxisLabelsSymbolOptions getSymbol();
/**
* (Gantt) The symbol for the collapse and expand icon in a treegrid.
*
* @see https://api.highcharts.com/gantt/navigator.yAxis.labels.symbol
*
* @implspec symbol?: NavigatorYAxisLabelsSymbolOptions;
*
*/
@JSProperty("symbol")
void setSymbol(NavigatorYAxisLabelsSymbolOptions value);
/**
* (Highstock) Whether to use HTML to render the labels.
*
* @see https://api.highcharts.com/highstock/navigator.yAxis.labels.useHTML
*
* @implspec useHTML?: boolean;
*
*/
@JSProperty("useHTML")
boolean getUseHTML();
/**
* (Highstock) Whether to use HTML to render the labels.
*
* @see https://api.highcharts.com/highstock/navigator.yAxis.labels.useHTML
*
* @implspec useHTML?: boolean;
*
*/
@JSProperty("useHTML")
void setUseHTML(boolean value);
/**
* (Highstock) The x position offset of the label relative to the tick
* position on the axis. Defaults to -15 for left axis, 15 for right axis.
*
* @see https://api.highcharts.com/highstock/navigator.yAxis.labels.x
*
* @implspec x?: number;
*
*/
@JSProperty("x")
double getX();
/**
* (Highstock) The x position offset of the label relative to the tick
* position on the axis. Defaults to -15 for left axis, 15 for right axis.
*
* @see https://api.highcharts.com/highstock/navigator.yAxis.labels.x
*
* @implspec x?: number;
*
*/
@JSProperty("x")
void setX(double value);
/**
* (Highstock) The y position offset of the label relative to the tick
* position on the axis.
*
* @see https://api.highcharts.com/highstock/navigator.yAxis.labels.y
*
* @implspec y?: number;
*
*/
@JSProperty("y")
double getY();
/**
* (Highstock) The y position offset of the label relative to the tick
* position on the axis.
*
* @see https://api.highcharts.com/highstock/navigator.yAxis.labels.y
*
* @implspec y?: number;
*
*/
@JSProperty("y")
void setY(double value);
/**
* (Highstock) The Z index for the axis labels.
*
* @see https://api.highcharts.com/highstock/navigator.yAxis.labels.zIndex
*
* @implspec zIndex?: number;
*
*/
@JSProperty("zIndex")
double getZIndex();
/**
* (Highstock) The Z index for the axis labels.
*
* @see https://api.highcharts.com/highstock/navigator.yAxis.labels.zIndex
*
* @implspec zIndex?: number;
*
*/
@JSProperty("zIndex")
void setZIndex(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 Overflow extends JsEnum {
public static final Overflow ALLOW = JsEnum.of("allow");
public static final Overflow JUSTIFY = JsEnum.of("justify");
}
/**
*/
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");
}
}