com.github.fluorumlabs.disconnect.highcharts

Interface PlotArearangeDataLabelsOptions

All Superinterfaces:

Any, org.teavm.jso.JSObject

public interface PlotArearangeDataLabelsOptions
extends Any

(Highcharts, Highstock) Extended data labels for range series types. Range series data labels have no x and y options. Instead, they have xLow, xHigh, yLow and yHigh options to allow the higher and lower data label sets individually.

See Also:

https://api.highcharts.com/highcharts/plotOptions.arearange.dataLabels, https://api.highcharts.com/highstock/plotOptions.arearange.dataLabels

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	PlotArearangeDataLabelsOptions.Align
static class	PlotArearangeDataLabelsOptions.Overflow
static class	PlotArearangeDataLabelsOptions.VerticalAlign

Method Summary

Modifier and Type	Method and Description
PlotArearangeDataLabelsOptions.Align	getAlign() (Highcharts, Highstock) The alignment of the data label compared to the point.
boolean	getAllowOverlap() (Highcharts, Highstock) Whether to allow data labels to overlap.
Unknown	getBackgroundColor() (Highcharts, Highstock) The background color or gradient for the data label.
String	getBorderColor() (Highcharts, Highstock) The border color for the data label.
double	getBorderRadius() (Highcharts, Highstock) The border radius in pixels for the data label.
double	getBorderWidth() (Highcharts, Highstock) The border width in pixels for the data label.
String	getClassName() (Highcharts, Highstock) A class name for the data label.
Unknown	getColor() (Highcharts, Highstock) The text color for the data labels.
boolean	getCrop() (Highcharts, Highstock) Whether to hide data labels that are outside the plot area.
boolean	getDefer() (Highcharts, Highstock, Gantt) Whether to defer displaying the data labels until the initial series animation has finished.
boolean	getEnabled() (Highcharts, Highstock) Enable or disable the data labels.
PlotArearangeDataLabelsFilterOptions	getFilter() (Highcharts, Highstock) A declarative filter for which data labels to display.
String	getFormat() (Highcharts, Highstock) A format string for the data label.
FormatterCallbackFunction<SeriesDataLabelsFormatterContextObject>	getFormatter() (Highcharts, Highstock) Callback JavaScript function to format the data label.
boolean	getInside() (Highcharts, Highstock) 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.
PlotArearangeDataLabelsOptions.Overflow	getOverflow() (Highcharts, Highstock) How to handle data labels that flow outside the plot area.
double	getPadding() (Highcharts, Highstock) When either the borderWidth or the backgroundColor is set, this is the padding within the box.
double	getRotation() (Highcharts, Highstock) Text rotation in degrees.
Unknown	getShadow() (Highcharts, Highstock) The shadow of the box.
String	getShape() (Highcharts, Highstock) The name of a symbol to use for the border around the label.
CSSObject	getStyle() (Highcharts, Highstock) Styles for the label.
boolean	getUseHTML() (Highcharts, Highstock) Whether to use HTML to render the labels.
PlotArearangeDataLabelsOptions.VerticalAlign	getVerticalAlign() (Highcharts, Highstock) The vertical alignment of a data label.
double	getXHigh() (Highcharts, Highstock) X offset of the higher data labels relative to the point value.
double	getXLow() (Highcharts, Highstock) X offset of the lower data labels relative to the point value.
double	getYHigh() (Highcharts, Highstock) Y offset of the higher data labels relative to the point value.
double	getYLow() (Highcharts, Highstock) Y offset of the lower data labels relative to the point value.
double	getZIndex() (Highcharts, Highstock) The Z index of the data labels.
void	setAlign(PlotArearangeDataLabelsOptions.Align value) (Highcharts, Highstock) The alignment of the data label compared to the point.
void	setAllowOverlap(boolean value) (Highcharts, Highstock) Whether to allow data labels to overlap.
void	setBackgroundColor(Any value) (Highcharts, Highstock) The background color or gradient for the data label.
void	setBackgroundColor(GradientColorObject value) (Highcharts, Highstock) The background color or gradient for the data label.
void	setBackgroundColor(String value) (Highcharts, Highstock) The background color or gradient for the data label.
void	setBorderColor(String value) (Highcharts, Highstock) The border color for the data label.
void	setBorderRadius(double value) (Highcharts, Highstock) The border radius in pixels for the data label.
void	setBorderWidth(double value) (Highcharts, Highstock) The border width in pixels for the data label.
void	setClassName(String value) (Highcharts, Highstock) A class name for the data label.
void	setColor(Any value) (Highcharts, Highstock) The text color for the data labels.
void	setColor(GradientColorObject value) (Highcharts, Highstock) The text color for the data labels.
void	setColor(String value) (Highcharts, Highstock) The text color for the data labels.
void	setCrop(boolean value) (Highcharts, Highstock) Whether to hide data labels that are outside the plot area.
void	setDefer(boolean value) (Highcharts, Highstock, Gantt) Whether to defer displaying the data labels until the initial series animation has finished.
void	setEnabled(boolean value) (Highcharts, Highstock) Enable or disable the data labels.
void	setFilter(PlotArearangeDataLabelsFilterOptions value) (Highcharts, Highstock) A declarative filter for which data labels to display.
void	setFormat(String value) (Highcharts, Highstock) A format string for the data label.
void	setFormatter(FormatterCallbackFunction<SeriesDataLabelsFormatterContextObject> value) (Highcharts, Highstock) Callback JavaScript function to format the data label.
void	setInside(boolean value) (Highcharts, Highstock) 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.
void	setOverflow(PlotArearangeDataLabelsOptions.Overflow value) (Highcharts, Highstock) How to handle data labels that flow outside the plot area.
void	setPadding(double value) (Highcharts, Highstock) When either the borderWidth or the backgroundColor is set, this is the padding within the box.
void	setRotation(double value) (Highcharts, Highstock) Text rotation in degrees.
void	setShadow(boolean value) (Highcharts, Highstock) The shadow of the box.
void	setShadow(ShadowOptionsObject value) (Highcharts, Highstock) The shadow of the box.
void	setShape(String value) (Highcharts, Highstock) The name of a symbol to use for the border around the label.
void	setStyle(CSSObject value) (Highcharts, Highstock) Styles for the label.
void	setUseHTML(boolean value) (Highcharts, Highstock) Whether to use HTML to render the labels.
void	setVerticalAlign(PlotArearangeDataLabelsOptions.VerticalAlign value) (Highcharts, Highstock) The vertical alignment of a data label.
void	setXHigh(double value) (Highcharts, Highstock) X offset of the higher data labels relative to the point value.
void	setXLow(double value) (Highcharts, Highstock) X offset of the lower data labels relative to the point value.
void	setYHigh(double value) (Highcharts, Highstock) Y offset of the higher data labels relative to the point value.
void	setYLow(double value) (Highcharts, Highstock) Y offset of the lower data labels relative to the point value.
void	setZIndex(double value) (Highcharts, Highstock) The Z index of the data labels.

Methods inherited from interface js.lang.Any

empty

Methods inherited from interface org.teavm.jso.JSObject

cast

Method Detail

getAlign

@Nullable
PlotArearangeDataLabelsOptions.Align getAlign()

(Highcharts, Highstock) The alignment of the data label compared to the point. If right, the right side of the label should be touching the point. For points with an extent, like columns, the alignments also dictates how to align it inside the box, as given with the inside option. Can be one of left, center or right.

See Also:

https://api.highcharts.com/highcharts/plotOptions.arearange.dataLabels.align, https://api.highcharts.com/highstock/plotOptions.arearange.dataLabels.align

setAlign

void setAlign(PlotArearangeDataLabelsOptions.Align value)

(Highcharts, Highstock) The alignment of the data label compared to the point. If right, the right side of the label should be touching the point. For points with an extent, like columns, the alignments also dictates how to align it inside the box, as given with the inside option. Can be one of left, center or right.

See Also:

https://api.highcharts.com/highcharts/plotOptions.arearange.dataLabels.align, https://api.highcharts.com/highstock/plotOptions.arearange.dataLabels.align

getAllowOverlap

boolean getAllowOverlap()

(Highcharts, Highstock) Whether to allow data labels to overlap. To make the labels less sensitive for overlapping, the dataLabels.padding can be set to 0.

See Also:

https://api.highcharts.com/highcharts/plotOptions.arearange.dataLabels.allowOverlap, https://api.highcharts.com/highstock/plotOptions.arearange.dataLabels.allowOverlap

setAllowOverlap

void setAllowOverlap(boolean value)

(Highcharts, Highstock) Whether to allow data labels to overlap. To make the labels less sensitive for overlapping, the dataLabels.padding can be set to 0.

See Also:

https://api.highcharts.com/highcharts/plotOptions.arearange.dataLabels.allowOverlap, https://api.highcharts.com/highstock/plotOptions.arearange.dataLabels.allowOverlap

getBackgroundColor

@Nullable
Unknown getBackgroundColor()

(Highcharts, Highstock) The background color or gradient for the data label.

See Also:

https://api.highcharts.com/highcharts/plotOptions.arearange.dataLabels.backgroundColor, https://api.highcharts.com/highstock/plotOptions.arearange.dataLabels.backgroundColor

setBackgroundColor

void setBackgroundColor(GradientColorObject value)

(Highcharts, Highstock) The background color or gradient for the data label.

See Also:

https://api.highcharts.com/highcharts/plotOptions.arearange.dataLabels.backgroundColor, https://api.highcharts.com/highstock/plotOptions.arearange.dataLabels.backgroundColor

setBackgroundColor

void setBackgroundColor(String value)

(Highcharts, Highstock) The background color or gradient for the data label.

See Also:

https://api.highcharts.com/highcharts/plotOptions.arearange.dataLabels.backgroundColor, https://api.highcharts.com/highstock/plotOptions.arearange.dataLabels.backgroundColor

setBackgroundColor

void setBackgroundColor(Any value)

(Highcharts, Highstock) The background color or gradient for the data label.

See Also:

https://api.highcharts.com/highcharts/plotOptions.arearange.dataLabels.backgroundColor, https://api.highcharts.com/highstock/plotOptions.arearange.dataLabels.backgroundColor

getBorderColor

@Nullable
String getBorderColor()

(Highcharts, Highstock) The border color for the data label. Defaults to undefined.

See Also:

https://api.highcharts.com/highcharts/plotOptions.arearange.dataLabels.borderColor, https://api.highcharts.com/highstock/plotOptions.arearange.dataLabels.borderColor

setBorderColor

void setBorderColor(String value)

(Highcharts, Highstock) The border color for the data label. Defaults to undefined.

See Also:

https://api.highcharts.com/highcharts/plotOptions.arearange.dataLabels.borderColor, https://api.highcharts.com/highstock/plotOptions.arearange.dataLabels.borderColor

getBorderRadius

double getBorderRadius()

(Highcharts, Highstock) The border radius in pixels for the data label.

See Also:

https://api.highcharts.com/highcharts/plotOptions.arearange.dataLabels.borderRadius, https://api.highcharts.com/highstock/plotOptions.arearange.dataLabels.borderRadius

setBorderRadius

void setBorderRadius(double value)

(Highcharts, Highstock) The border radius in pixels for the data label.

See Also:

https://api.highcharts.com/highcharts/plotOptions.arearange.dataLabels.borderRadius, https://api.highcharts.com/highstock/plotOptions.arearange.dataLabels.borderRadius

getBorderWidth

double getBorderWidth()

(Highcharts, Highstock) The border width in pixels for the data label.

See Also:

https://api.highcharts.com/highcharts/plotOptions.arearange.dataLabels.borderWidth, https://api.highcharts.com/highstock/plotOptions.arearange.dataLabels.borderWidth

setBorderWidth

void setBorderWidth(double value)

(Highcharts, Highstock) The border width in pixels for the data label.

See Also:

https://api.highcharts.com/highcharts/plotOptions.arearange.dataLabels.borderWidth, https://api.highcharts.com/highstock/plotOptions.arearange.dataLabels.borderWidth

getClassName

@Nullable
String getClassName()

(Highcharts, Highstock) 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 Also:

https://api.highcharts.com/highcharts/plotOptions.arearange.dataLabels.className, https://api.highcharts.com/highstock/plotOptions.arearange.dataLabels.className

setClassName

void setClassName(String value)

(Highcharts, Highstock) 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 Also:

https://api.highcharts.com/highcharts/plotOptions.arearange.dataLabels.className, https://api.highcharts.com/highstock/plotOptions.arearange.dataLabels.className

getColor

@Nullable
Unknown getColor()

(Highcharts, Highstock) 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 Also:

https://api.highcharts.com/highcharts/plotOptions.arearange.dataLabels.color, https://api.highcharts.com/highstock/plotOptions.arearange.dataLabels.color

setColor

void setColor(GradientColorObject value)

(Highcharts, Highstock) 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 Also:

https://api.highcharts.com/highcharts/plotOptions.arearange.dataLabels.color, https://api.highcharts.com/highstock/plotOptions.arearange.dataLabels.color

setColor

void setColor(String value)

(Highcharts, Highstock) 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 Also:

https://api.highcharts.com/highcharts/plotOptions.arearange.dataLabels.color, https://api.highcharts.com/highstock/plotOptions.arearange.dataLabels.color

setColor

void setColor(Any value)

(Highcharts, Highstock) 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 Also:

https://api.highcharts.com/highcharts/plotOptions.arearange.dataLabels.color, https://api.highcharts.com/highstock/plotOptions.arearange.dataLabels.color

getCrop

boolean getCrop()

(Highcharts, Highstock) 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 Also:

https://api.highcharts.com/highcharts/plotOptions.arearange.dataLabels.crop, https://api.highcharts.com/highstock/plotOptions.arearange.dataLabels.crop

setCrop

void setCrop(boolean value)

(Highcharts, Highstock) 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 Also:

https://api.highcharts.com/highcharts/plotOptions.arearange.dataLabels.crop, https://api.highcharts.com/highstock/plotOptions.arearange.dataLabels.crop

getDefer

boolean getDefer()

(Highcharts, Highstock, Gantt) Whether to defer displaying the data labels until the initial series animation has finished.

See Also:

https://api.highcharts.com/highcharts/plotOptions.arearange.dataLabels.defer, https://api.highcharts.com/highstock/plotOptions.arearange.dataLabels.defer, https://api.highcharts.com/gantt/plotOptions.arearange.dataLabels.defer

setDefer

void setDefer(boolean value)

(Highcharts, Highstock, Gantt) Whether to defer displaying the data labels until the initial series animation has finished.

See Also:

https://api.highcharts.com/highcharts/plotOptions.arearange.dataLabels.defer, https://api.highcharts.com/highstock/plotOptions.arearange.dataLabels.defer, https://api.highcharts.com/gantt/plotOptions.arearange.dataLabels.defer

getEnabled

boolean getEnabled()

(Highcharts, Highstock) Enable or disable the data labels.

See Also:

https://api.highcharts.com/highcharts/plotOptions.arearange.dataLabels.enabled, https://api.highcharts.com/highstock/plotOptions.arearange.dataLabels.enabled

setEnabled

void setEnabled(boolean value)

(Highcharts, Highstock) Enable or disable the data labels.

See Also:

https://api.highcharts.com/highcharts/plotOptions.arearange.dataLabels.enabled, https://api.highcharts.com/highstock/plotOptions.arearange.dataLabels.enabled

getFilter

@Nullable
PlotArearangeDataLabelsFilterOptions getFilter()

(Highcharts, Highstock) 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 Also:

https://api.highcharts.com/highcharts/plotOptions.arearange.dataLabels.filter, https://api.highcharts.com/highstock/plotOptions.arearange.dataLabels.filter

setFilter

void setFilter(PlotArearangeDataLabelsFilterOptions value)

(Highcharts, Highstock) 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 Also:

https://api.highcharts.com/highcharts/plotOptions.arearange.dataLabels.filter, https://api.highcharts.com/highstock/plotOptions.arearange.dataLabels.filter

getFormat

@Nullable
String getFormat()

(Highcharts, Highstock) A format string for the data label. Available variables are the same as for formatter.

See Also:

https://api.highcharts.com/highcharts/plotOptions.arearange.dataLabels.format, https://api.highcharts.com/highstock/plotOptions.arearange.dataLabels.format

setFormat

void setFormat(String value)

(Highcharts, Highstock) A format string for the data label. Available variables are the same as for formatter.

See Also:

https://api.highcharts.com/highcharts/plotOptions.arearange.dataLabels.format, https://api.highcharts.com/highstock/plotOptions.arearange.dataLabels.format

getFormatter

@Nullable
FormatterCallbackFunction<SeriesDataLabelsFormatterContextObject> getFormatter()

(Highcharts, Highstock) 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 Also:

https://api.highcharts.com/highcharts/plotOptions.arearange.dataLabels.formatter, https://api.highcharts.com/highstock/plotOptions.arearange.dataLabels.formatter

setFormatter

void setFormatter(FormatterCallbackFunction<SeriesDataLabelsFormatterContextObject> value)

(Highcharts, Highstock) 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 Also:

https://api.highcharts.com/highcharts/plotOptions.arearange.dataLabels.formatter, https://api.highcharts.com/highstock/plotOptions.arearange.dataLabels.formatter

getInside

boolean getInside()

(Highcharts, Highstock) 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 Also:

https://api.highcharts.com/highcharts/plotOptions.arearange.dataLabels.inside, https://api.highcharts.com/highstock/plotOptions.arearange.dataLabels.inside

setInside

void setInside(boolean value)

(Highcharts, Highstock) 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 Also:

https://api.highcharts.com/highcharts/plotOptions.arearange.dataLabels.inside, https://api.highcharts.com/highstock/plotOptions.arearange.dataLabels.inside

getOverflow

@Nullable
PlotArearangeDataLabelsOptions.Overflow getOverflow()

(Highcharts, Highstock) 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 Also:

https://api.highcharts.com/highcharts/plotOptions.arearange.dataLabels.overflow, https://api.highcharts.com/highstock/plotOptions.arearange.dataLabels.overflow

setOverflow

void setOverflow(PlotArearangeDataLabelsOptions.Overflow value)

(Highcharts, Highstock) 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 Also:

https://api.highcharts.com/highcharts/plotOptions.arearange.dataLabels.overflow, https://api.highcharts.com/highstock/plotOptions.arearange.dataLabels.overflow

getPadding

double getPadding()

(Highcharts, Highstock) When either the borderWidth or the backgroundColor is set, this is the padding within the box.

See Also:

https://api.highcharts.com/highcharts/plotOptions.arearange.dataLabels.padding, https://api.highcharts.com/highstock/plotOptions.arearange.dataLabels.padding

setPadding

void setPadding(double value)

(Highcharts, Highstock) When either the borderWidth or the backgroundColor is set, this is the padding within the box.

See Also:

https://api.highcharts.com/highcharts/plotOptions.arearange.dataLabels.padding, https://api.highcharts.com/highstock/plotOptions.arearange.dataLabels.padding

getRotation

double getRotation()

(Highcharts, Highstock) 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 Also:

https://api.highcharts.com/highcharts/plotOptions.arearange.dataLabels.rotation, https://api.highcharts.com/highstock/plotOptions.arearange.dataLabels.rotation

setRotation

void setRotation(double value)

(Highcharts, Highstock) 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 Also:

https://api.highcharts.com/highcharts/plotOptions.arearange.dataLabels.rotation, https://api.highcharts.com/highstock/plotOptions.arearange.dataLabels.rotation

getShadow

@Nullable
Unknown getShadow()

(Highcharts, Highstock) 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 Also:

https://api.highcharts.com/highcharts/plotOptions.arearange.dataLabels.shadow, https://api.highcharts.com/highstock/plotOptions.arearange.dataLabels.shadow

setShadow

void setShadow(ShadowOptionsObject value)

(Highcharts, Highstock) 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 Also:

https://api.highcharts.com/highcharts/plotOptions.arearange.dataLabels.shadow, https://api.highcharts.com/highstock/plotOptions.arearange.dataLabels.shadow

setShadow

void setShadow(boolean value)

(Highcharts, Highstock) 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 Also:

https://api.highcharts.com/highcharts/plotOptions.arearange.dataLabels.shadow, https://api.highcharts.com/highstock/plotOptions.arearange.dataLabels.shadow

getShape

@Nullable
String getShape()

(Highcharts, Highstock) The name of a symbol to use for the border around the label. Symbols are predefined functions on the Renderer object.

See Also:

https://api.highcharts.com/highcharts/plotOptions.arearange.dataLabels.shape, https://api.highcharts.com/highstock/plotOptions.arearange.dataLabels.shape

setShape

void setShape(String value)

(Highcharts, Highstock) The name of a symbol to use for the border around the label. Symbols are predefined functions on the Renderer object.

See Also:

https://api.highcharts.com/highcharts/plotOptions.arearange.dataLabels.shape, https://api.highcharts.com/highstock/plotOptions.arearange.dataLabels.shape

getStyle

@Nullable
CSSObject getStyle()

(Highcharts, Highstock) 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 Also:

https://api.highcharts.com/highcharts/plotOptions.arearange.dataLabels.style, https://api.highcharts.com/highstock/plotOptions.arearange.dataLabels.style

setStyle

void setStyle(CSSObject value)

(Highcharts, Highstock) 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 Also:

https://api.highcharts.com/highcharts/plotOptions.arearange.dataLabels.style, https://api.highcharts.com/highstock/plotOptions.arearange.dataLabels.style

getUseHTML

boolean getUseHTML()

(Highcharts, Highstock) Whether to use HTML to render the labels.

See Also:

https://api.highcharts.com/highcharts/plotOptions.arearange.dataLabels.useHTML, https://api.highcharts.com/highstock/plotOptions.arearange.dataLabels.useHTML

setUseHTML

void setUseHTML(boolean value)

(Highcharts, Highstock) Whether to use HTML to render the labels.

See Also:

https://api.highcharts.com/highcharts/plotOptions.arearange.dataLabels.useHTML, https://api.highcharts.com/highstock/plotOptions.arearange.dataLabels.useHTML

getVerticalAlign

@Nullable
PlotArearangeDataLabelsOptions.VerticalAlign getVerticalAlign()

(Highcharts, Highstock) 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 Also:

https://api.highcharts.com/highcharts/plotOptions.arearange.dataLabels.verticalAlign, https://api.highcharts.com/highstock/plotOptions.arearange.dataLabels.verticalAlign

setVerticalAlign

void setVerticalAlign(PlotArearangeDataLabelsOptions.VerticalAlign value)

(Highcharts, Highstock) 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 Also:

https://api.highcharts.com/highcharts/plotOptions.arearange.dataLabels.verticalAlign, https://api.highcharts.com/highstock/plotOptions.arearange.dataLabels.verticalAlign

getXHigh

double getXHigh()

(Highcharts, Highstock) X offset of the higher data labels relative to the point value.

See Also:

https://api.highcharts.com/highcharts/plotOptions.arearange.dataLabels.xHigh, https://api.highcharts.com/highstock/plotOptions.arearange.dataLabels.xHigh

setXHigh

void setXHigh(double value)

(Highcharts, Highstock) X offset of the higher data labels relative to the point value.

See Also:

https://api.highcharts.com/highcharts/plotOptions.arearange.dataLabels.xHigh, https://api.highcharts.com/highstock/plotOptions.arearange.dataLabels.xHigh

getXLow

double getXLow()

(Highcharts, Highstock) X offset of the lower data labels relative to the point value.

See Also:

https://api.highcharts.com/highcharts/plotOptions.arearange.dataLabels.xLow, https://api.highcharts.com/highstock/plotOptions.arearange.dataLabels.xLow

setXLow

void setXLow(double value)

(Highcharts, Highstock) X offset of the lower data labels relative to the point value.

See Also:

https://api.highcharts.com/highcharts/plotOptions.arearange.dataLabels.xLow, https://api.highcharts.com/highstock/plotOptions.arearange.dataLabels.xLow

getYHigh

double getYHigh()

(Highcharts, Highstock) Y offset of the higher data labels relative to the point value.

See Also:

https://api.highcharts.com/highcharts/plotOptions.arearange.dataLabels.yHigh, https://api.highcharts.com/highstock/plotOptions.arearange.dataLabels.yHigh

setYHigh

void setYHigh(double value)

(Highcharts, Highstock) Y offset of the higher data labels relative to the point value.

See Also:

https://api.highcharts.com/highcharts/plotOptions.arearange.dataLabels.yHigh, https://api.highcharts.com/highstock/plotOptions.arearange.dataLabels.yHigh

getYLow

double getYLow()

(Highcharts, Highstock) Y offset of the lower data labels relative to the point value.

See Also:

https://api.highcharts.com/highcharts/plotOptions.arearange.dataLabels.yLow, https://api.highcharts.com/highstock/plotOptions.arearange.dataLabels.yLow

setYLow

void setYLow(double value)

(Highcharts, Highstock) Y offset of the lower data labels relative to the point value.

See Also:

https://api.highcharts.com/highcharts/plotOptions.arearange.dataLabels.yLow, https://api.highcharts.com/highstock/plotOptions.arearange.dataLabels.yLow

getZIndex

double getZIndex()

(Highcharts, Highstock) 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 Also:

https://api.highcharts.com/highcharts/plotOptions.arearange.dataLabels.zIndex, https://api.highcharts.com/highstock/plotOptions.arearange.dataLabels.zIndex

setZIndex

void setZIndex(double value)

(Highcharts, Highstock) 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 Also:

https://api.highcharts.com/highcharts/plotOptions.arearange.dataLabels.zIndex, https://api.highcharts.com/highstock/plotOptions.arearange.dataLabels.zIndex