com.github.fluorumlabs.disconnect.highcharts.PlotBarDataLabelsOptions 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) Options for the series data labels, appearing next to each data
* point.
*
* Since v6.2.0, multiple data labels can be applied to each single point by
* defining them as an array of configs.
*
* In styled mode, the data labels can be styled with the
* .highcharts-data-label-box and .highcharts-data-label class names (see
* example).
*
* @see https://api.highcharts.com/highcharts/plotOptions.bar.dataLabels
*
*/
public interface PlotBarDataLabelsOptions extends Any {
/**
* (Highcharts) Alignment of the data label relative to the data point.
*
* @see https://api.highcharts.com/highcharts/plotOptions.bar.dataLabels.align
*
* @implspec align?: ("center"|"left"|"right");
*
*/
@JSProperty("align")
@Nullable
Align getAlign();
/**
* (Highcharts) Alignment of the data label relative to the data point.
*
* @see https://api.highcharts.com/highcharts/plotOptions.bar.dataLabels.align
*
* @implspec align?: ("center"|"left"|"right");
*
*/
@JSProperty("align")
void setAlign(Align value);
/**
* (Highcharts) Whether to allow data labels to overlap. To make the labels
* less sensitive for overlapping, the dataLabels.padding can be set to 0.
*
* @see https://api.highcharts.com/highcharts/plotOptions.bar.dataLabels.allowOverlap
*
* @implspec allowOverlap?: boolean;
*
*/
@JSProperty("allowOverlap")
boolean getAllowOverlap();
/**
* (Highcharts) Whether to allow data labels to overlap. To make the labels
* less sensitive for overlapping, the dataLabels.padding can be set to 0.
*
* @see https://api.highcharts.com/highcharts/plotOptions.bar.dataLabels.allowOverlap
*
* @implspec allowOverlap?: boolean;
*
*/
@JSProperty("allowOverlap")
void setAllowOverlap(boolean value);
/**
* (Highcharts) The background color or gradient for the data label.
*
* @see https://api.highcharts.com/highcharts/plotOptions.bar.dataLabels.backgroundColor
*
* @implspec backgroundColor?: (ColorString|GradientColorObject|object);
*
*/
@JSProperty("backgroundColor")
@Nullable
Unknown getBackgroundColor();
/**
* (Highcharts) The background color or gradient for the data label.
*
* @see https://api.highcharts.com/highcharts/plotOptions.bar.dataLabels.backgroundColor
*
* @implspec backgroundColor?: (ColorString|GradientColorObject|object);
*
*/
@JSProperty("backgroundColor")
void setBackgroundColor(GradientColorObject value);
/**
* (Highcharts) The background color or gradient for the data label.
*
* @see https://api.highcharts.com/highcharts/plotOptions.bar.dataLabels.backgroundColor
*
* @implspec backgroundColor?: (ColorString|GradientColorObject|object);
*
*/
@JSProperty("backgroundColor")
void setBackgroundColor(String value);
/**
* (Highcharts) The background color or gradient for the data label.
*
* @see https://api.highcharts.com/highcharts/plotOptions.bar.dataLabels.backgroundColor
*
* @implspec backgroundColor?: (ColorString|GradientColorObject|object);
*
*/
@JSProperty("backgroundColor")
void setBackgroundColor(Any value);
/**
* (Highcharts) The border color for the data label. Defaults to
* undefined.
*
* @see https://api.highcharts.com/highcharts/plotOptions.bar.dataLabels.borderColor
*
* @implspec borderColor?: ColorString;
*
*/
@JSProperty("borderColor")
@Nullable
String getBorderColor();
/**
* (Highcharts) The border color for the data label. Defaults to
* undefined.
*
* @see https://api.highcharts.com/highcharts/plotOptions.bar.dataLabels.borderColor
*
* @implspec borderColor?: ColorString;
*
*/
@JSProperty("borderColor")
void setBorderColor(String value);
/**
* (Highcharts) The border radius in pixels for the data label.
*
* @see https://api.highcharts.com/highcharts/plotOptions.bar.dataLabels.borderRadius
*
* @implspec borderRadius?: number;
*
*/
@JSProperty("borderRadius")
double getBorderRadius();
/**
* (Highcharts) The border radius in pixels for the data label.
*
* @see https://api.highcharts.com/highcharts/plotOptions.bar.dataLabels.borderRadius
*
* @implspec borderRadius?: number;
*
*/
@JSProperty("borderRadius")
void setBorderRadius(double value);
/**
* (Highcharts) The border width in pixels for the data label.
*
* @see https://api.highcharts.com/highcharts/plotOptions.bar.dataLabels.borderWidth
*
* @implspec borderWidth?: number;
*
*/
@JSProperty("borderWidth")
double getBorderWidth();
/**
* (Highcharts) The border width in pixels for the data label.
*
* @see https://api.highcharts.com/highcharts/plotOptions.bar.dataLabels.borderWidth
*
* @implspec borderWidth?: number;
*
*/
@JSProperty("borderWidth")
void setBorderWidth(double value);
/**
* (Highcharts) A class name for the data label. Particularly in styled
* mode, this can be used to give each series' or point's data label unique
* styling. In addition to this option, a default color class name is added
* so that we can give the labels a contrast text shadow.
*
* @see https://api.highcharts.com/highcharts/plotOptions.bar.dataLabels.className
*
* @implspec className?: string;
*
*/
@JSProperty("className")
@Nullable
String getClassName();
/**
* (Highcharts) A class name for the data label. Particularly in styled
* mode, this can be used to give each series' or point's data label unique
* styling. In addition to this option, a default color class name is added
* so that we can give the labels a contrast text shadow.
*
* @see https://api.highcharts.com/highcharts/plotOptions.bar.dataLabels.className
*
* @implspec className?: string;
*
*/
@JSProperty("className")
void setClassName(String value);
/**
* (Highcharts) The text color for the data labels. Defaults to undefined.
* For certain series types, like column or map, the data labels can be
* drawn inside the points. In this case the data label will be drawn with
* maximum contrast by default. Additionally, it will be given a
* text-outline style with the opposite color, to further increase the
* contrast. This can be overridden by setting the text-outline style to
* none in the dataLabels.style option.
*
* @see https://api.highcharts.com/highcharts/plotOptions.bar.dataLabels.color
*
* @implspec color?: (ColorString|GradientColorObject|object);
*
*/
@JSProperty("color")
@Nullable
Unknown getColor();
/**
* (Highcharts) The text color for the data labels. Defaults to undefined.
* For certain series types, like column or map, the data labels can be
* drawn inside the points. In this case the data label will be drawn with
* maximum contrast by default. Additionally, it will be given a
* text-outline style with the opposite color, to further increase the
* contrast. This can be overridden by setting the text-outline style to
* none in the dataLabels.style option.
*
* @see https://api.highcharts.com/highcharts/plotOptions.bar.dataLabels.color
*
* @implspec color?: (ColorString|GradientColorObject|object);
*
*/
@JSProperty("color")
void setColor(GradientColorObject value);
/**
* (Highcharts) The text color for the data labels. Defaults to undefined.
* For certain series types, like column or map, the data labels can be
* drawn inside the points. In this case the data label will be drawn with
* maximum contrast by default. Additionally, it will be given a
* text-outline style with the opposite color, to further increase the
* contrast. This can be overridden by setting the text-outline style to
* none in the dataLabels.style option.
*
* @see https://api.highcharts.com/highcharts/plotOptions.bar.dataLabels.color
*
* @implspec color?: (ColorString|GradientColorObject|object);
*
*/
@JSProperty("color")
void setColor(String value);
/**
* (Highcharts) The text color for the data labels. Defaults to undefined.
* For certain series types, like column or map, the data labels can be
* drawn inside the points. In this case the data label will be drawn with
* maximum contrast by default. Additionally, it will be given a
* text-outline style with the opposite color, to further increase the
* contrast. This can be overridden by setting the text-outline style to
* none in the dataLabels.style option.
*
* @see https://api.highcharts.com/highcharts/plotOptions.bar.dataLabels.color
*
* @implspec color?: (ColorString|GradientColorObject|object);
*
*/
@JSProperty("color")
void setColor(Any value);
/**
* (Highcharts) Whether to hide data labels that are outside the plot area.
* By default, the data label is moved inside the plot area according to the
* overflow option.
*
* @see https://api.highcharts.com/highcharts/plotOptions.bar.dataLabels.crop
*
* @implspec crop?: boolean;
*
*/
@JSProperty("crop")
boolean getCrop();
/**
* (Highcharts) Whether to hide data labels that are outside the plot area.
* By default, the data label is moved inside the plot area according to the
* overflow option.
*
* @see https://api.highcharts.com/highcharts/plotOptions.bar.dataLabels.crop
*
* @implspec crop?: boolean;
*
*/
@JSProperty("crop")
void setCrop(boolean value);
/**
* (Highcharts, Highstock, Gantt) Whether to defer displaying the data
* labels until the initial series animation has finished.
*
* @see https://api.highcharts.com/highcharts/plotOptions.bar.dataLabels.defer
* @see https://api.highcharts.com/highstock/plotOptions.bar.dataLabels.defer
* @see https://api.highcharts.com/gantt/plotOptions.bar.dataLabels.defer
*
* @implspec defer?: boolean;
*
*/
@JSProperty("defer")
boolean getDefer();
/**
* (Highcharts, Highstock, Gantt) Whether to defer displaying the data
* labels until the initial series animation has finished.
*
* @see https://api.highcharts.com/highcharts/plotOptions.bar.dataLabels.defer
* @see https://api.highcharts.com/highstock/plotOptions.bar.dataLabels.defer
* @see https://api.highcharts.com/gantt/plotOptions.bar.dataLabels.defer
*
* @implspec defer?: boolean;
*
*/
@JSProperty("defer")
void setDefer(boolean value);
/**
* (Highcharts) Enable or disable the data labels.
*
* @see https://api.highcharts.com/highcharts/plotOptions.bar.dataLabels.enabled
*
* @implspec enabled?: boolean;
*
*/
@JSProperty("enabled")
boolean getEnabled();
/**
* (Highcharts) Enable or disable the data labels.
*
* @see https://api.highcharts.com/highcharts/plotOptions.bar.dataLabels.enabled
*
* @implspec enabled?: boolean;
*
*/
@JSProperty("enabled")
void setEnabled(boolean value);
/**
* (Highcharts) A declarative filter for which data labels to display. The
* declarative filter is designed for use when callback functions are not
* available, like when the chart options require a pure JSON structure or
* for use with graphical editors. For programmatic control, use the
* formatter instead, and return undefined to disable a single data
* label.
*
* @see https://api.highcharts.com/highcharts/plotOptions.bar.dataLabels.filter
*
* @implspec filter?: PlotBarDataLabelsFilterOptions;
*
*/
@JSProperty("filter")
@Nullable
PlotBarDataLabelsFilterOptions getFilter();
/**
* (Highcharts) A declarative filter for which data labels to display. The
* declarative filter is designed for use when callback functions are not
* available, like when the chart options require a pure JSON structure or
* for use with graphical editors. For programmatic control, use the
* formatter instead, and return undefined to disable a single data
* label.
*
* @see https://api.highcharts.com/highcharts/plotOptions.bar.dataLabels.filter
*
* @implspec filter?: PlotBarDataLabelsFilterOptions;
*
*/
@JSProperty("filter")
void setFilter(PlotBarDataLabelsFilterOptions value);
/**
* (Highcharts) A format string for the data label. Available variables are
* the same as for formatter.
*
* @see https://api.highcharts.com/highcharts/plotOptions.bar.dataLabels.format
*
* @implspec format?: string;
*
*/
@JSProperty("format")
@Nullable
String getFormat();
/**
* (Highcharts) A format string for the data label. Available variables are
* the same as for formatter.
*
* @see https://api.highcharts.com/highcharts/plotOptions.bar.dataLabels.format
*
* @implspec format?: string;
*
*/
@JSProperty("format")
void setFormat(String value);
/**
* (Highcharts) Callback JavaScript function to format the data label. Note
* that if a format is defined, the format takes precedence and the
* formatter is ignored. Available data are:
*
* (see online documentation for example)
*
* @see https://api.highcharts.com/highcharts/plotOptions.bar.dataLabels.formatter
*
* @implspec formatter?: FormatterCallbackFunction;
*
*/
@JSProperty("formatter")
@Nullable
FormatterCallbackFunction getFormatter();
/**
* (Highcharts) Callback JavaScript function to format the data label. Note
* that if a format is defined, the format takes precedence and the
* formatter is ignored. Available data are:
*
* (see online documentation for example)
*
* @see https://api.highcharts.com/highcharts/plotOptions.bar.dataLabels.formatter
*
* @implspec formatter?: FormatterCallbackFunction;
*
*/
@JSProperty("formatter")
void setFormatter(FormatterCallbackFunction value);
/**
* (Highcharts) For points with an extent, like columns or map areas,
* whether to align the data label inside the box or to the actual value
* point. Defaults to false in most cases, true in stacked columns.
*
* @see https://api.highcharts.com/highcharts/plotOptions.bar.dataLabels.inside
*
* @implspec inside?: boolean;
*
*/
@JSProperty("inside")
boolean getInside();
/**
* (Highcharts) For points with an extent, like columns or map areas,
* whether to align the data label inside the box or to the actual value
* point. Defaults to false in most cases, true in stacked columns.
*
* @see https://api.highcharts.com/highcharts/plotOptions.bar.dataLabels.inside
*
* @implspec inside?: boolean;
*
*/
@JSProperty("inside")
void setInside(boolean value);
/**
* (Highcharts) How to handle data labels that flow outside the plot area.
* The default is "justify", which aligns them inside the plot area. For
* columns and bars, this means it will be moved inside the bar. To display
* data labels outside the plot area, set crop to false and overflow
* to "allow".
*
* @see https://api.highcharts.com/highcharts/plotOptions.bar.dataLabels.overflow
*
* @implspec overflow?: ("allow"|"justify");
*
*/
@JSProperty("overflow")
@Nullable
Overflow getOverflow();
/**
* (Highcharts) How to handle data labels that flow outside the plot area.
* The default is "justify", which aligns them inside the plot area. For
* columns and bars, this means it will be moved inside the bar. To display
* data labels outside the plot area, set crop to false and overflow
* to "allow".
*
* @see https://api.highcharts.com/highcharts/plotOptions.bar.dataLabels.overflow
*
* @implspec overflow?: ("allow"|"justify");
*
*/
@JSProperty("overflow")
void setOverflow(Overflow value);
/**
* (Highcharts) When either the borderWidth or the backgroundColor is
* set, this is the padding within the box.
*
* @see https://api.highcharts.com/highcharts/plotOptions.bar.dataLabels.padding
*
* @implspec padding?: number;
*
*/
@JSProperty("padding")
double getPadding();
/**
* (Highcharts) When either the borderWidth or the backgroundColor is
* set, this is the padding within the box.
*
* @see https://api.highcharts.com/highcharts/plotOptions.bar.dataLabels.padding
*
* @implspec padding?: number;
*
*/
@JSProperty("padding")
void setPadding(double value);
/**
* (Highcharts) Text rotation in degrees. Note that due to a more complex
* structure, backgrounds, borders and padding will be lost on a rotated
* data label.
*
* @see https://api.highcharts.com/highcharts/plotOptions.bar.dataLabels.rotation
*
* @implspec rotation?: number;
*
*/
@JSProperty("rotation")
double getRotation();
/**
* (Highcharts) Text rotation in degrees. Note that due to a more complex
* structure, backgrounds, borders and padding will be lost on a rotated
* data label.
*
* @see https://api.highcharts.com/highcharts/plotOptions.bar.dataLabels.rotation
*
* @implspec rotation?: number;
*
*/
@JSProperty("rotation")
void setRotation(double value);
/**
* (Highcharts) The shadow of the box. Works best with borderWidth or
* backgroundColor. Since 2.3 the shadow can be an object configuration
* containing color, offsetX, offsetY, opacity and width.
*
* @see https://api.highcharts.com/highcharts/plotOptions.bar.dataLabels.shadow
*
* @implspec shadow?: (boolean|ShadowOptionsObject);
*
*/
@JSProperty("shadow")
@Nullable
Unknown getShadow();
/**
* (Highcharts) The shadow of the box. Works best with borderWidth or
* backgroundColor. Since 2.3 the shadow can be an object configuration
* containing color, offsetX, offsetY, opacity and width.
*
* @see https://api.highcharts.com/highcharts/plotOptions.bar.dataLabels.shadow
*
* @implspec shadow?: (boolean|ShadowOptionsObject);
*
*/
@JSProperty("shadow")
void setShadow(ShadowOptionsObject value);
/**
* (Highcharts) The shadow of the box. Works best with borderWidth or
* backgroundColor. Since 2.3 the shadow can be an object configuration
* containing color, offsetX, offsetY, opacity and width.
*
* @see https://api.highcharts.com/highcharts/plotOptions.bar.dataLabels.shadow
*
* @implspec shadow?: (boolean|ShadowOptionsObject);
*
*/
@JSProperty("shadow")
void setShadow(boolean value);
/**
* (Highcharts) 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/plotOptions.bar.dataLabels.shape
*
* @implspec shape?: string;
*
*/
@JSProperty("shape")
@Nullable
String getShape();
/**
* (Highcharts) 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/plotOptions.bar.dataLabels.shape
*
* @implspec shape?: string;
*
*/
@JSProperty("shape")
void setShape(String value);
/**
* (Highcharts) Styles for the label. The default color setting is
* "contrast", which is a pseudo color that Highcharts picks up and
* applies the maximum contrast to the underlying point item, for example
* the bar in a bar chart.
*
* The textOutline is a pseudo property that applies an outline of the
* given width with the given color, which by default is the maximum
* contrast to the text. So a bright text color will result in a black text
* outline for maximum readability on a mixed background. In some cases,
* especially with grayscale text, the text outline doesn't work well, in
* which cases it can be disabled by setting it to "none". When useHTML
* is true, the textOutline will not be picked up. In this, case, the same
* effect can be acheived through the text-shadow CSS property.
*
* For some series types, where each point has an extent, like for example
* tree maps, the data label may overflow the point. There are two
* strategies for handling overflow. By default, the text will wrap to
* multiple lines. The other strategy is to set style.textOverflow to
* ellipsis, which will keep the text on one line plus it will break
* inside long words.
*
* @see https://api.highcharts.com/highcharts/plotOptions.bar.dataLabels.style
*
* @implspec style?: CSSObject;
*
*/
@JSProperty("style")
@Nullable
CSSObject getStyle();
/**
* (Highcharts) Styles for the label. The default color setting is
* "contrast", which is a pseudo color that Highcharts picks up and
* applies the maximum contrast to the underlying point item, for example
* the bar in a bar chart.
*
* The textOutline is a pseudo property that applies an outline of the
* given width with the given color, which by default is the maximum
* contrast to the text. So a bright text color will result in a black text
* outline for maximum readability on a mixed background. In some cases,
* especially with grayscale text, the text outline doesn't work well, in
* which cases it can be disabled by setting it to "none". When useHTML
* is true, the textOutline will not be picked up. In this, case, the same
* effect can be acheived through the text-shadow CSS property.
*
* For some series types, where each point has an extent, like for example
* tree maps, the data label may overflow the point. There are two
* strategies for handling overflow. By default, the text will wrap to
* multiple lines. The other strategy is to set style.textOverflow to
* ellipsis, which will keep the text on one line plus it will break
* inside long words.
*
* @see https://api.highcharts.com/highcharts/plotOptions.bar.dataLabels.style
*
* @implspec style?: CSSObject;
*
*/
@JSProperty("style")
void setStyle(CSSObject value);
/**
* (Highcharts) Whether to use HTML to render the labels.
*
* @see https://api.highcharts.com/highcharts/plotOptions.bar.dataLabels.useHTML
*
* @implspec useHTML?: boolean;
*
*/
@JSProperty("useHTML")
boolean getUseHTML();
/**
* (Highcharts) Whether to use HTML to render the labels.
*
* @see https://api.highcharts.com/highcharts/plotOptions.bar.dataLabels.useHTML
*
* @implspec useHTML?: boolean;
*
*/
@JSProperty("useHTML")
void setUseHTML(boolean value);
/**
* (Highcharts) The vertical alignment of a data label. Can be one of top,
* middle or bottom. The default value depends on the data, for instance
* in a column chart, the label is above positive values and below negative
* values.
*
* @see https://api.highcharts.com/highcharts/plotOptions.bar.dataLabels.verticalAlign
*
* @implspec verticalAlign?: ("bottom"|"middle"|"top");
*
*/
@JSProperty("verticalAlign")
@Nullable
VerticalAlign getVerticalAlign();
/**
* (Highcharts) The vertical alignment of a data label. Can be one of top,
* middle or bottom. The default value depends on the data, for instance
* in a column chart, the label is above positive values and below negative
* values.
*
* @see https://api.highcharts.com/highcharts/plotOptions.bar.dataLabels.verticalAlign
*
* @implspec verticalAlign?: ("bottom"|"middle"|"top");
*
*/
@JSProperty("verticalAlign")
void setVerticalAlign(VerticalAlign value);
/**
* (Highcharts) The x position of the data label relative to the data point.
*
* @see https://api.highcharts.com/highcharts/plotOptions.bar.dataLabels.x
*
* @implspec x?: number;
*
*/
@JSProperty("x")
double getX();
/**
* (Highcharts) The x position of the data label relative to the data point.
*
* @see https://api.highcharts.com/highcharts/plotOptions.bar.dataLabels.x
*
* @implspec x?: number;
*
*/
@JSProperty("x")
void setX(double value);
/**
* (Highcharts) The y position offset of the label relative to the point in
* pixels.
*
* @see https://api.highcharts.com/highcharts/plotOptions.bar.dataLabels.y
*
* @implspec y?: (number|null);
*
*/
@JSProperty("y")
double getY();
/**
* (Highcharts) The y position offset of the label relative to the point in
* pixels.
*
* @see https://api.highcharts.com/highcharts/plotOptions.bar.dataLabels.y
*
* @implspec y?: (number|null);
*
*/
@JSProperty("y")
void setY(double value);
/**
* (Highcharts) The Z index of the data labels. The default Z index puts it
* above the series. Use a Z index of 2 to display it behind the series.
*
* @see https://api.highcharts.com/highcharts/plotOptions.bar.dataLabels.zIndex
*
* @implspec zIndex?: number;
*
*/
@JSProperty("zIndex")
double getZIndex();
/**
* (Highcharts) The Z index of the data labels. The default Z index puts it
* above the series. Use a Z index of 2 to display it behind the series.
*
* @see https://api.highcharts.com/highcharts/plotOptions.bar.dataLabels.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 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");
}
}