org.fujion.highcharts

Class PlotLabelOptions

java.lang.Object

org.fujion.ancillary.Options

org.fujion.highcharts.PlotLabelOptions

All Implemented Interfaces:

OptionMap.IOptionMapConverter, IClientTransform

public class PlotLabelOptions
extends Options

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.

Field Summary

Fields

Modifier and Type	Field and Description
List<Box>	boxesToAvoid An array of boxes to avoid when laying out the labels.
Boolean	connectorAllowed Allow labels to be placed distant to the graph if necessary, and draw a connector line to the graph.
Integer	connectorNeighbourDistance If the label is closer than this to a neighbour graph, draw a connector.
Boolean	enabled Enable the series label per series.
Integer	maxFontSize For area-like series, allow the font size to vary so that small areas get a smaller font size.
Integer	minFontSize For area-like series, allow the font size to vary so that small areas get a smaller font size.
Boolean	onArea Draw the label on the area of an area series.
StyleOptions	style Styles for the series label.

Constructor Summary

Constructors

Constructor and Description
PlotLabelOptions()

Method Summary

Methods inherited from class org.fujion.ancillary.Options

toMap

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.fujion.ancillary.OptionMap.IOptionMapConverter

transformForClient

Field Detail

boxesToAvoid

@Option
public final List<Box> boxesToAvoid

An array of boxes to avoid when laying out the labels. Defaults to undefined.

connectorAllowed

@Option
public Boolean connectorAllowed

Allow labels to be placed distant to the graph if necessary, and draw a connector line to the graph. Defaults to true.

connectorNeighbourDistance

@Option
public Integer connectorNeighbourDistance

If the label is closer than this to a neighbour graph, draw a connector. Defaults to 24.

enabled

@Option
public Boolean enabled

Enable the series label per series. Defaults to true.

maxFontSize

@Option
public Integer maxFontSize

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. Defaults to null.

minFontSize

@Option
public Integer minFontSize

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. Defaults to null.

onArea

@Option
public Boolean onArea

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. Defaults to null.

style

@Option
public final StyleOptions style

Styles for the series label. The color defaults to the series color, or a contrast color if onArea.

Constructor Detail

PlotLabelOptions

public PlotLabelOptions()