com.github.fluorumlabs.disconnect.highcharts.AnnotationsLabelOptions 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.lang.Unknown;
import org.teavm.jso.JSProperty;
/**
* (Highcharts, Highstock, Highmaps) Options for annotation's labels. Each label
* inherits options from the labelOptions object. An option from the
* labelOptions can be overwritten by config for a specific label.
*
* @see https://api.highcharts.com/highcharts/annotations.labelOptions
* @see https://api.highcharts.com/highstock/annotations.labelOptions
* @see https://api.highcharts.com/highmaps/annotations.labelOptions
*
*/
public interface AnnotationsLabelOptions extends Any {
/**
* (Highcharts, Highstock, Highmaps) The alignment of the annotation's
* label. If right, the right side of the label should be touching the
* point.
*
* @see https://api.highcharts.com/highcharts/annotations.labelOptions.align
* @see https://api.highcharts.com/highstock/annotations.labelOptions.align
* @see https://api.highcharts.com/highmaps/annotations.labelOptions.align
*
* @implspec align?: ("center"|"left"|"right");
*
*/
@JSProperty("align")
@Nullable
Align getAlign();
/**
* (Highcharts, Highstock, Highmaps) The alignment of the annotation's
* label. If right, the right side of the label should be touching the
* point.
*
* @see https://api.highcharts.com/highcharts/annotations.labelOptions.align
* @see https://api.highcharts.com/highstock/annotations.labelOptions.align
* @see https://api.highcharts.com/highmaps/annotations.labelOptions.align
*
* @implspec align?: ("center"|"left"|"right");
*
*/
@JSProperty("align")
void setAlign(Align value);
/**
* (Highcharts, Highstock, Highmaps) Whether to allow the annotation's
* labels to overlap. To make the labels less sensitive for overlapping, the
* can be set to 0.
*
* @see https://api.highcharts.com/highcharts/annotations.labelOptions.allowOverlap
* @see https://api.highcharts.com/highstock/annotations.labelOptions.allowOverlap
* @see https://api.highcharts.com/highmaps/annotations.labelOptions.allowOverlap
*
* @implspec allowOverlap?: boolean;
*
*/
@JSProperty("allowOverlap")
boolean getAllowOverlap();
/**
* (Highcharts, Highstock, Highmaps) Whether to allow the annotation's
* labels to overlap. To make the labels less sensitive for overlapping, the
* can be set to 0.
*
* @see https://api.highcharts.com/highcharts/annotations.labelOptions.allowOverlap
* @see https://api.highcharts.com/highstock/annotations.labelOptions.allowOverlap
* @see https://api.highcharts.com/highmaps/annotations.labelOptions.allowOverlap
*
* @implspec allowOverlap?: boolean;
*
*/
@JSProperty("allowOverlap")
void setAllowOverlap(boolean value);
/**
* (Highcharts, Highstock, Highmaps) The background color or gradient for
* the annotation's label.
*
* @see https://api.highcharts.com/highcharts/annotations.labelOptions.backgroundColor
* @see https://api.highcharts.com/highstock/annotations.labelOptions.backgroundColor
* @see https://api.highcharts.com/highmaps/annotations.labelOptions.backgroundColor
*
* @implspec backgroundColor?: (ColorString|GradientColorObject);
*
*/
@JSProperty("backgroundColor")
@Nullable
Unknown getBackgroundColor();
/**
* (Highcharts, Highstock, Highmaps) The background color or gradient for
* the annotation's label.
*
* @see https://api.highcharts.com/highcharts/annotations.labelOptions.backgroundColor
* @see https://api.highcharts.com/highstock/annotations.labelOptions.backgroundColor
* @see https://api.highcharts.com/highmaps/annotations.labelOptions.backgroundColor
*
* @implspec backgroundColor?: (ColorString|GradientColorObject);
*
*/
@JSProperty("backgroundColor")
void setBackgroundColor(GradientColorObject value);
/**
* (Highcharts, Highstock, Highmaps) The background color or gradient for
* the annotation's label.
*
* @see https://api.highcharts.com/highcharts/annotations.labelOptions.backgroundColor
* @see https://api.highcharts.com/highstock/annotations.labelOptions.backgroundColor
* @see https://api.highcharts.com/highmaps/annotations.labelOptions.backgroundColor
*
* @implspec backgroundColor?: (ColorString|GradientColorObject);
*
*/
@JSProperty("backgroundColor")
void setBackgroundColor(String value);
/**
* (Highcharts, Highstock, Highmaps) The border color for the annotation's
* label.
*
* @see https://api.highcharts.com/highcharts/annotations.labelOptions.borderColor
* @see https://api.highcharts.com/highstock/annotations.labelOptions.borderColor
* @see https://api.highcharts.com/highmaps/annotations.labelOptions.borderColor
*
* @implspec borderColor?: ColorString;
*
*/
@JSProperty("borderColor")
@Nullable
String getBorderColor();
/**
* (Highcharts, Highstock, Highmaps) The border color for the annotation's
* label.
*
* @see https://api.highcharts.com/highcharts/annotations.labelOptions.borderColor
* @see https://api.highcharts.com/highstock/annotations.labelOptions.borderColor
* @see https://api.highcharts.com/highmaps/annotations.labelOptions.borderColor
*
* @implspec borderColor?: ColorString;
*
*/
@JSProperty("borderColor")
void setBorderColor(String value);
/**
* (Highcharts, Highstock, Highmaps) The border radius in pixels for the
* annotaiton's label.
*
* @see https://api.highcharts.com/highcharts/annotations.labelOptions.borderRadius
* @see https://api.highcharts.com/highstock/annotations.labelOptions.borderRadius
* @see https://api.highcharts.com/highmaps/annotations.labelOptions.borderRadius
*
* @implspec borderRadius?: number;
*
*/
@JSProperty("borderRadius")
double getBorderRadius();
/**
* (Highcharts, Highstock, Highmaps) The border radius in pixels for the
* annotaiton's label.
*
* @see https://api.highcharts.com/highcharts/annotations.labelOptions.borderRadius
* @see https://api.highcharts.com/highstock/annotations.labelOptions.borderRadius
* @see https://api.highcharts.com/highmaps/annotations.labelOptions.borderRadius
*
* @implspec borderRadius?: number;
*
*/
@JSProperty("borderRadius")
void setBorderRadius(double value);
/**
* (Highcharts, Highstock, Highmaps) The border width in pixels for the
* annotation's label
*
* @see https://api.highcharts.com/highcharts/annotations.labelOptions.borderWidth
* @see https://api.highcharts.com/highstock/annotations.labelOptions.borderWidth
* @see https://api.highcharts.com/highmaps/annotations.labelOptions.borderWidth
*
* @implspec borderWidth?: number;
*
*/
@JSProperty("borderWidth")
double getBorderWidth();
/**
* (Highcharts, Highstock, Highmaps) The border width in pixels for the
* annotation's label
*
* @see https://api.highcharts.com/highcharts/annotations.labelOptions.borderWidth
* @see https://api.highcharts.com/highstock/annotations.labelOptions.borderWidth
* @see https://api.highcharts.com/highmaps/annotations.labelOptions.borderWidth
*
* @implspec borderWidth?: number;
*
*/
@JSProperty("borderWidth")
void setBorderWidth(double value);
/**
* (Highcharts, Highstock, Highmaps) A class name for styling by CSS.
*
* @see https://api.highcharts.com/highcharts/annotations.labelOptions.className
* @see https://api.highcharts.com/highstock/annotations.labelOptions.className
* @see https://api.highcharts.com/highmaps/annotations.labelOptions.className
*
* @implspec className?: string;
*
*/
@JSProperty("className")
@Nullable
String getClassName();
/**
* (Highcharts, Highstock, Highmaps) A class name for styling by CSS.
*
* @see https://api.highcharts.com/highcharts/annotations.labelOptions.className
* @see https://api.highcharts.com/highstock/annotations.labelOptions.className
* @see https://api.highcharts.com/highmaps/annotations.labelOptions.className
*
* @implspec className?: string;
*
*/
@JSProperty("className")
void setClassName(String value);
/**
* (Highcharts, Highstock, Highmaps) Whether to hide the annotation's label
* that is outside the plot area.
*
* @see https://api.highcharts.com/highcharts/annotations.labelOptions.crop
* @see https://api.highcharts.com/highstock/annotations.labelOptions.crop
* @see https://api.highcharts.com/highmaps/annotations.labelOptions.crop
*
* @implspec crop?: boolean;
*
*/
@JSProperty("crop")
boolean getCrop();
/**
* (Highcharts, Highstock, Highmaps) Whether to hide the annotation's label
* that is outside the plot area.
*
* @see https://api.highcharts.com/highcharts/annotations.labelOptions.crop
* @see https://api.highcharts.com/highstock/annotations.labelOptions.crop
* @see https://api.highcharts.com/highmaps/annotations.labelOptions.crop
*
* @implspec crop?: boolean;
*
*/
@JSProperty("crop")
void setCrop(boolean value);
/**
* (Highcharts, Highstock, Highmaps) The label's pixel distance from the
* point.
*
* @see https://api.highcharts.com/highcharts/annotations.labelOptions.distance
* @see https://api.highcharts.com/highstock/annotations.labelOptions.distance
* @see https://api.highcharts.com/highmaps/annotations.labelOptions.distance
*
* @implspec distance?: number;
*
*/
@JSProperty("distance")
double getDistance();
/**
* (Highcharts, Highstock, Highmaps) The label's pixel distance from the
* point.
*
* @see https://api.highcharts.com/highcharts/annotations.labelOptions.distance
* @see https://api.highcharts.com/highstock/annotations.labelOptions.distance
* @see https://api.highcharts.com/highmaps/annotations.labelOptions.distance
*
* @implspec distance?: number;
*
*/
@JSProperty("distance")
void setDistance(double value);
/**
* (Highcharts, Highstock, Highmaps) A format string for the data label.
*
* @see https://api.highcharts.com/highcharts/annotations.labelOptions.format
* @see https://api.highcharts.com/highstock/annotations.labelOptions.format
* @see https://api.highcharts.com/highmaps/annotations.labelOptions.format
*
* @implspec format?: string;
*
*/
@JSProperty("format")
@Nullable
String getFormat();
/**
* (Highcharts, Highstock, Highmaps) A format string for the data label.
*
* @see https://api.highcharts.com/highcharts/annotations.labelOptions.format
* @see https://api.highcharts.com/highstock/annotations.labelOptions.format
* @see https://api.highcharts.com/highmaps/annotations.labelOptions.format
*
* @implspec format?: string;
*
*/
@JSProperty("format")
void setFormat(String value);
/**
* (Highcharts, Highstock, Highmaps) Callback JavaScript function to format
* the annotation's label. Note that if a format or text are defined,
* the format or text take precedence and the formatter is ignored. This
* refers to a point object.
*
* @see https://api.highcharts.com/highcharts/annotations.labelOptions.formatter
* @see https://api.highcharts.com/highstock/annotations.labelOptions.formatter
* @see https://api.highcharts.com/highmaps/annotations.labelOptions.formatter
*
* @implspec formatter?: FormatterCallbackFunction;
*
*/
@JSProperty("formatter")
@Nullable
FormatterCallbackFunction getFormatter();
/**
* (Highcharts, Highstock, Highmaps) Callback JavaScript function to format
* the annotation's label. Note that if a format or text are defined,
* the format or text take precedence and the formatter is ignored. This
* refers to a point object.
*
* @see https://api.highcharts.com/highcharts/annotations.labelOptions.formatter
* @see https://api.highcharts.com/highstock/annotations.labelOptions.formatter
* @see https://api.highcharts.com/highmaps/annotations.labelOptions.formatter
*
* @implspec formatter?: FormatterCallbackFunction;
*
*/
@JSProperty("formatter")
void setFormatter(FormatterCallbackFunction value);
/**
* (Highcharts, Highstock, Highmaps) How to handle the annotation's label
* that flow outside the plot area. The justify option aligns the label
* inside the plot area.
*
* @see https://api.highcharts.com/highcharts/annotations.labelOptions.overflow
* @see https://api.highcharts.com/highstock/annotations.labelOptions.overflow
* @see https://api.highcharts.com/highmaps/annotations.labelOptions.overflow
*
* @implspec overflow?: ("allow"|"justify");
*
*/
@JSProperty("overflow")
@Nullable
Overflow getOverflow();
/**
* (Highcharts, Highstock, Highmaps) How to handle the annotation's label
* that flow outside the plot area. The justify option aligns the label
* inside the plot area.
*
* @see https://api.highcharts.com/highcharts/annotations.labelOptions.overflow
* @see https://api.highcharts.com/highstock/annotations.labelOptions.overflow
* @see https://api.highcharts.com/highmaps/annotations.labelOptions.overflow
*
* @implspec overflow?: ("allow"|"justify");
*
*/
@JSProperty("overflow")
void setOverflow(Overflow value);
/**
* (Highcharts, Highstock, Highmaps) When either the borderWidth or the
* backgroundColor is set, this is the padding within the box.
*
* @see https://api.highcharts.com/highcharts/annotations.labelOptions.padding
* @see https://api.highcharts.com/highstock/annotations.labelOptions.padding
* @see https://api.highcharts.com/highmaps/annotations.labelOptions.padding
*
* @implspec padding?: number;
*
*/
@JSProperty("padding")
double getPadding();
/**
* (Highcharts, Highstock, Highmaps) When either the borderWidth or the
* backgroundColor is set, this is the padding within the box.
*
* @see https://api.highcharts.com/highcharts/annotations.labelOptions.padding
* @see https://api.highcharts.com/highstock/annotations.labelOptions.padding
* @see https://api.highcharts.com/highmaps/annotations.labelOptions.padding
*
* @implspec padding?: number;
*
*/
@JSProperty("padding")
void setPadding(double value);
/**
* (Highcharts, Highstock, Highmaps) The shadow of the box. The shadow can
* be an object configuration containing color, offsetX, offsetY,
* opacity and width.
*
* @see https://api.highcharts.com/highcharts/annotations.labelOptions.shadow
* @see https://api.highcharts.com/highstock/annotations.labelOptions.shadow
* @see https://api.highcharts.com/highmaps/annotations.labelOptions.shadow
*
* @implspec shadow?: (boolean|ShadowOptionsObject);
*
*/
@JSProperty("shadow")
@Nullable
Unknown getShadow();
/**
* (Highcharts, Highstock, Highmaps) The shadow of the box. The shadow can
* be an object configuration containing color, offsetX, offsetY,
* opacity and width.
*
* @see https://api.highcharts.com/highcharts/annotations.labelOptions.shadow
* @see https://api.highcharts.com/highstock/annotations.labelOptions.shadow
* @see https://api.highcharts.com/highmaps/annotations.labelOptions.shadow
*
* @implspec shadow?: (boolean|ShadowOptionsObject);
*
*/
@JSProperty("shadow")
void setShadow(ShadowOptionsObject value);
/**
* (Highcharts, Highstock, Highmaps) The shadow of the box. The shadow can
* be an object configuration containing color, offsetX, offsetY,
* opacity and width.
*
* @see https://api.highcharts.com/highcharts/annotations.labelOptions.shadow
* @see https://api.highcharts.com/highstock/annotations.labelOptions.shadow
* @see https://api.highcharts.com/highmaps/annotations.labelOptions.shadow
*
* @implspec shadow?: (boolean|ShadowOptionsObject);
*
*/
@JSProperty("shadow")
void setShadow(boolean value);
/**
* (Highcharts, Highstock, Highmaps) The name of a symbol to use for the
* border around the label. Symbols are predefined functions on the Renderer
* object.
*
* @see https://api.highcharts.com/highcharts/annotations.labelOptions.shape
* @see https://api.highcharts.com/highstock/annotations.labelOptions.shape
* @see https://api.highcharts.com/highmaps/annotations.labelOptions.shape
*
* @implspec shape?: string;
*
*/
@JSProperty("shape")
@Nullable
String getShape();
/**
* (Highcharts, Highstock, Highmaps) The name of a symbol to use for the
* border around the label. Symbols are predefined functions on the Renderer
* object.
*
* @see https://api.highcharts.com/highcharts/annotations.labelOptions.shape
* @see https://api.highcharts.com/highstock/annotations.labelOptions.shape
* @see https://api.highcharts.com/highmaps/annotations.labelOptions.shape
*
* @implspec shape?: string;
*
*/
@JSProperty("shape")
void setShape(String value);
/**
* (Highcharts, Highstock, Highmaps) Styles for the annotation's label.
*
* @see https://api.highcharts.com/highcharts/annotations.labelOptions.style
* @see https://api.highcharts.com/highstock/annotations.labelOptions.style
* @see https://api.highcharts.com/highmaps/annotations.labelOptions.style
*
* @implspec style?: CSSObject;
*
*/
@JSProperty("style")
@Nullable
CSSObject getStyle();
/**
* (Highcharts, Highstock, Highmaps) Styles for the annotation's label.
*
* @see https://api.highcharts.com/highcharts/annotations.labelOptions.style
* @see https://api.highcharts.com/highstock/annotations.labelOptions.style
* @see https://api.highcharts.com/highmaps/annotations.labelOptions.style
*
* @implspec style?: CSSObject;
*
*/
@JSProperty("style")
void setStyle(CSSObject value);
/**
* (Highcharts, Highstock, Highmaps) Alias for the format option.
*
* @see https://api.highcharts.com/highcharts/annotations.labelOptions.text
* @see https://api.highcharts.com/highstock/annotations.labelOptions.text
* @see https://api.highcharts.com/highmaps/annotations.labelOptions.text
*
* @implspec text?: string;
*
*/
@JSProperty("text")
@Nullable
String getText();
/**
* (Highcharts, Highstock, Highmaps) Alias for the format option.
*
* @see https://api.highcharts.com/highcharts/annotations.labelOptions.text
* @see https://api.highcharts.com/highstock/annotations.labelOptions.text
* @see https://api.highcharts.com/highmaps/annotations.labelOptions.text
*
* @implspec text?: string;
*
*/
@JSProperty("text")
void setText(String value);
/**
* (Highcharts, Highstock, Highmaps) Whether to use HTML to render the
* annotation's label.
*
* @see https://api.highcharts.com/highcharts/annotations.labelOptions.useHTML
* @see https://api.highcharts.com/highstock/annotations.labelOptions.useHTML
* @see https://api.highcharts.com/highmaps/annotations.labelOptions.useHTML
*
* @implspec useHTML?: boolean;
*
*/
@JSProperty("useHTML")
boolean getUseHTML();
/**
* (Highcharts, Highstock, Highmaps) Whether to use HTML to render the
* annotation's label.
*
* @see https://api.highcharts.com/highcharts/annotations.labelOptions.useHTML
* @see https://api.highcharts.com/highstock/annotations.labelOptions.useHTML
* @see https://api.highcharts.com/highmaps/annotations.labelOptions.useHTML
*
* @implspec useHTML?: boolean;
*
*/
@JSProperty("useHTML")
void setUseHTML(boolean value);
/**
* (Highcharts, Highstock, Highmaps) The vertical alignment of the
* annotation's label.
*
* @see https://api.highcharts.com/highcharts/annotations.labelOptions.verticalAlign
* @see https://api.highcharts.com/highstock/annotations.labelOptions.verticalAlign
* @see https://api.highcharts.com/highmaps/annotations.labelOptions.verticalAlign
*
* @implspec verticalAlign?: ("bottom"|"middle"|"top");
*
*/
@JSProperty("verticalAlign")
@Nullable
VerticalAlign getVerticalAlign();
/**
* (Highcharts, Highstock, Highmaps) The vertical alignment of the
* annotation's label.
*
* @see https://api.highcharts.com/highcharts/annotations.labelOptions.verticalAlign
* @see https://api.highcharts.com/highstock/annotations.labelOptions.verticalAlign
* @see https://api.highcharts.com/highmaps/annotations.labelOptions.verticalAlign
*
* @implspec verticalAlign?: ("bottom"|"middle"|"top");
*
*/
@JSProperty("verticalAlign")
void setVerticalAlign(VerticalAlign value);
/**
* (Highcharts, Highstock, Highmaps) The x position offset of the label
* relative to the point. Note that if a distance is defined, the distance
* takes precedence over x and y options.
*
* @see https://api.highcharts.com/highcharts/annotations.labelOptions.x
* @see https://api.highcharts.com/highstock/annotations.labelOptions.x
* @see https://api.highcharts.com/highmaps/annotations.labelOptions.x
*
* @implspec x?: number;
*
*/
@JSProperty("x")
double getX();
/**
* (Highcharts, Highstock, Highmaps) The x position offset of the label
* relative to the point. Note that if a distance is defined, the distance
* takes precedence over x and y options.
*
* @see https://api.highcharts.com/highcharts/annotations.labelOptions.x
* @see https://api.highcharts.com/highstock/annotations.labelOptions.x
* @see https://api.highcharts.com/highmaps/annotations.labelOptions.x
*
* @implspec x?: number;
*
*/
@JSProperty("x")
void setX(double value);
/**
* (Highcharts, Highstock, Highmaps) The y position offset of the label
* relative to the point. Note that if a distance is defined, the distance
* takes precedence over x and y options.
*
* @see https://api.highcharts.com/highcharts/annotations.labelOptions.y
* @see https://api.highcharts.com/highstock/annotations.labelOptions.y
* @see https://api.highcharts.com/highmaps/annotations.labelOptions.y
*
* @implspec y?: number;
*
*/
@JSProperty("y")
double getY();
/**
* (Highcharts, Highstock, Highmaps) The y position offset of the label
* relative to the point. Note that if a distance is defined, the distance
* takes precedence over x and y options.
*
* @see https://api.highcharts.com/highcharts/annotations.labelOptions.y
* @see https://api.highcharts.com/highstock/annotations.labelOptions.y
* @see https://api.highcharts.com/highmaps/annotations.labelOptions.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 Overflow extends JsEnum {
public static final Overflow ALLOW = JsEnum.of("allow");
public static final Overflow JUSTIFY = JsEnum.of("justify");
}
/**
*/
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");
}
}