com.github.fluorumlabs.disconnect.highcharts

Interface PlotAdLabelOptions

All Superinterfaces:

Any, org.teavm.jso.JSObject

public interface PlotAdLabelOptions
extends Any

(Highcharts, Highstock, Gantt) Series labels are placed as close to the series as possible in a natural way, seeking to avoid other series. The goal of this feature is to make the chart more easily readable, like if a human designer placed the labels in the optimal position. The series labels currently work with series types having a graph or an area. Requires the series-label.js module.

See Also:

https://api.highcharts.com/highcharts/plotOptions.ad.label, https://api.highcharts.com/highstock/plotOptions.ad.label, https://api.highcharts.com/gantt/plotOptions.ad.label

Method Summary

Modifier and Type	Method and Description
Array<LabelIntersectBoxObject>	getBoxesToAvoid() (Highcharts, Highstock, Gantt) An array of boxes to avoid when laying out the labels.
boolean	getConnectorAllowed() (Highcharts, Highstock, Gantt) Allow labels to be placed distant to the graph if necessary, and draw a connector line to the graph.
double	getConnectorNeighbourDistance() (Highcharts, Highstock, Gantt) If the label is closer than this to a neighbour graph, draw a connector.
boolean	getEnabled() (Highcharts, Highstock, Gantt) Enable the series label per series.
double	getMaxFontSize() (Highcharts, Highstock, Gantt) For area-like series, allow the font size to vary so that small areas get a smaller font size.
double	getMinFontSize() (Highcharts, Highstock, Gantt) For area-like series, allow the font size to vary so that small areas get a smaller font size.
boolean	getOnArea() (Highcharts, Highstock, Gantt) Draw the label on the area of an area series.
CSSObject	getStyle() (Highcharts, Highstock, Gantt) Styles for the series label.
void	setBoxesToAvoid(Array<LabelIntersectBoxObject> value) (Highcharts, Highstock, Gantt) An array of boxes to avoid when laying out the labels.
void	setConnectorAllowed(boolean value) (Highcharts, Highstock, Gantt) Allow labels to be placed distant to the graph if necessary, and draw a connector line to the graph.
void	setConnectorNeighbourDistance(double value) (Highcharts, Highstock, Gantt) If the label is closer than this to a neighbour graph, draw a connector.
void	setEnabled(boolean value) (Highcharts, Highstock, Gantt) Enable the series label per series.
void	setMaxFontSize(double value) (Highcharts, Highstock, Gantt) For area-like series, allow the font size to vary so that small areas get a smaller font size.
void	setMinFontSize(double value) (Highcharts, Highstock, Gantt) For area-like series, allow the font size to vary so that small areas get a smaller font size.
void	setOnArea(boolean value) (Highcharts, Highstock, Gantt) Draw the label on the area of an area series.
void	setStyle(CSSObject value) (Highcharts, Highstock, Gantt) Styles for the series label.

Methods inherited from interface js.lang.Any

empty

Methods inherited from interface org.teavm.jso.JSObject

cast

Method Detail

getBoxesToAvoid

@Nullable
Array<LabelIntersectBoxObject> getBoxesToAvoid()

(Highcharts, Highstock, Gantt) An array of boxes to avoid when laying out the labels. Each item has a left, right, top and bottom property.

See Also:

https://api.highcharts.com/highcharts/plotOptions.ad.label.boxesToAvoid, https://api.highcharts.com/highstock/plotOptions.ad.label.boxesToAvoid, https://api.highcharts.com/gantt/plotOptions.ad.label.boxesToAvoid

setBoxesToAvoid

void setBoxesToAvoid(Array<LabelIntersectBoxObject> value)

(Highcharts, Highstock, Gantt) An array of boxes to avoid when laying out the labels. Each item has a left, right, top and bottom property.

See Also:

https://api.highcharts.com/highcharts/plotOptions.ad.label.boxesToAvoid, https://api.highcharts.com/highstock/plotOptions.ad.label.boxesToAvoid, https://api.highcharts.com/gantt/plotOptions.ad.label.boxesToAvoid

getConnectorAllowed

boolean getConnectorAllowed()

(Highcharts, Highstock, Gantt) Allow labels to be placed distant to the graph if necessary, and draw a connector line to the graph. Setting this option to true may decrease the performance significantly, since the algorithm with systematically search for open spaces in the while plot area. Visually, it may also result in a more cluttered chart, though more of the series will be labeled.

See Also:

https://api.highcharts.com/highcharts/plotOptions.ad.label.connectorAllowed, https://api.highcharts.com/highstock/plotOptions.ad.label.connectorAllowed, https://api.highcharts.com/gantt/plotOptions.ad.label.connectorAllowed

setConnectorAllowed

void setConnectorAllowed(boolean value)

(Highcharts, Highstock, Gantt) Allow labels to be placed distant to the graph if necessary, and draw a connector line to the graph. Setting this option to true may decrease the performance significantly, since the algorithm with systematically search for open spaces in the while plot area. Visually, it may also result in a more cluttered chart, though more of the series will be labeled.

See Also:

https://api.highcharts.com/highcharts/plotOptions.ad.label.connectorAllowed, https://api.highcharts.com/highstock/plotOptions.ad.label.connectorAllowed, https://api.highcharts.com/gantt/plotOptions.ad.label.connectorAllowed

getConnectorNeighbourDistance

double getConnectorNeighbourDistance()

(Highcharts, Highstock, Gantt) If the label is closer than this to a neighbour graph, draw a connector.

See Also:

https://api.highcharts.com/highcharts/plotOptions.ad.label.connectorNeighbourDistance, https://api.highcharts.com/highstock/plotOptions.ad.label.connectorNeighbourDistance, https://api.highcharts.com/gantt/plotOptions.ad.label.connectorNeighbourDistance

setConnectorNeighbourDistance

void setConnectorNeighbourDistance(double value)

(Highcharts, Highstock, Gantt) If the label is closer than this to a neighbour graph, draw a connector.

See Also:

https://api.highcharts.com/highcharts/plotOptions.ad.label.connectorNeighbourDistance, https://api.highcharts.com/highstock/plotOptions.ad.label.connectorNeighbourDistance, https://api.highcharts.com/gantt/plotOptions.ad.label.connectorNeighbourDistance

getEnabled

boolean getEnabled()

(Highcharts, Highstock, Gantt) Enable the series label per series.

See Also:

https://api.highcharts.com/highcharts/plotOptions.ad.label.enabled, https://api.highcharts.com/highstock/plotOptions.ad.label.enabled, https://api.highcharts.com/gantt/plotOptions.ad.label.enabled

setEnabled

void setEnabled(boolean value)

(Highcharts, Highstock, Gantt) Enable the series label per series.

See Also:

https://api.highcharts.com/highcharts/plotOptions.ad.label.enabled, https://api.highcharts.com/highstock/plotOptions.ad.label.enabled, https://api.highcharts.com/gantt/plotOptions.ad.label.enabled

getMaxFontSize

double getMaxFontSize()

(Highcharts, Highstock, Gantt) For area-like series, allow the font size to vary so that small areas get a smaller font size. The default applies this effect to area-like series but not line-like series.

See Also:

https://api.highcharts.com/highcharts/plotOptions.ad.label.maxFontSize, https://api.highcharts.com/highstock/plotOptions.ad.label.maxFontSize, https://api.highcharts.com/gantt/plotOptions.ad.label.maxFontSize

setMaxFontSize

void setMaxFontSize(double value)

(Highcharts, Highstock, Gantt) For area-like series, allow the font size to vary so that small areas get a smaller font size. The default applies this effect to area-like series but not line-like series.

See Also:

https://api.highcharts.com/highcharts/plotOptions.ad.label.maxFontSize, https://api.highcharts.com/highstock/plotOptions.ad.label.maxFontSize, https://api.highcharts.com/gantt/plotOptions.ad.label.maxFontSize

getMinFontSize

double getMinFontSize()

(Highcharts, Highstock, Gantt) For area-like series, allow the font size to vary so that small areas get a smaller font size. The default applies this effect to area-like series but not line-like series.

See Also:

https://api.highcharts.com/highcharts/plotOptions.ad.label.minFontSize, https://api.highcharts.com/highstock/plotOptions.ad.label.minFontSize, https://api.highcharts.com/gantt/plotOptions.ad.label.minFontSize

setMinFontSize

void setMinFontSize(double value)

(Highcharts, Highstock, Gantt) For area-like series, allow the font size to vary so that small areas get a smaller font size. The default applies this effect to area-like series but not line-like series.

See Also:

https://api.highcharts.com/highcharts/plotOptions.ad.label.minFontSize, https://api.highcharts.com/highstock/plotOptions.ad.label.minFontSize, https://api.highcharts.com/gantt/plotOptions.ad.label.minFontSize

getOnArea

boolean getOnArea()

(Highcharts, Highstock, Gantt) Draw the label on the area of an area series. By default it is drawn on the area. Set it to false to draw it next to the graph instead.

See Also:

https://api.highcharts.com/highcharts/plotOptions.ad.label.onArea, https://api.highcharts.com/highstock/plotOptions.ad.label.onArea, https://api.highcharts.com/gantt/plotOptions.ad.label.onArea

setOnArea

void setOnArea(boolean value)

(Highcharts, Highstock, Gantt) Draw the label on the area of an area series. By default it is drawn on the area. Set it to false to draw it next to the graph instead.

See Also:

https://api.highcharts.com/highcharts/plotOptions.ad.label.onArea, https://api.highcharts.com/highstock/plotOptions.ad.label.onArea, https://api.highcharts.com/gantt/plotOptions.ad.label.onArea

getStyle

@Nullable
CSSObject getStyle()

(Highcharts, Highstock, Gantt) Styles for the series label. The color defaults to the series color, or a contrast color if onArea.

See Also:

https://api.highcharts.com/highcharts/plotOptions.ad.label.style, https://api.highcharts.com/highstock/plotOptions.ad.label.style, https://api.highcharts.com/gantt/plotOptions.ad.label.style

setStyle

void setStyle(CSSObject value)

(Highcharts, Highstock, Gantt) Styles for the series label. The color defaults to the series color, or a contrast color if onArea.

See Also:

https://api.highcharts.com/highcharts/plotOptions.ad.label.style, https://api.highcharts.com/highstock/plotOptions.ad.label.style, https://api.highcharts.com/gantt/plotOptions.ad.label.style