org.fujion.highcharts

Class DataLabelOptions

java.lang.Object

org.fujion.ancillary.Options

org.fujion.highcharts.DataLabelOptions

All Implemented Interfaces:

OptionMap.IOptionMapConverter

public class DataLabelOptions
extends Options

Options for data labels.

Field Summary

Fields

Modifier and Type	Field and Description
AlignHorizontal	align The alignment of the data label compared to the point.
String	backgroundColor The background color or gradient for the data label.
String	borderColor The border color for the data label.
Integer	borderRadius The border radius in pixels for the data label.
Integer	borderWidth The border width in pixels for the data label.
String	color The text color for the data labels.
Boolean	enabled Enable or disable the data labels.
String	formatter Callback JavaScript function to format the data label.
String	overflow How to handle overflowing labels on horizontal axis.
Integer	padding When either the borderWidth or the backgroundColor is set, this is the padding within the box.
Integer	rotation Rotation of the labels in degrees.
Object	shadow The shadow of the box.
StyleOptions	style CSS styles for the label.
Integer	x The x position offset of the label relative to the point.
Integer	y The y position offset of the label relative to the point.

Constructor Summary

Constructors

Constructor and Description
DataLabelOptions()

Method Summary

Methods inherited from class org.fujion.ancillary.Options

copyTo, toMap

Methods inherited from class java.lang.Object

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

Field Detail

align

public AlignHorizontal align

The alignment of the data label compared to the point. Can be one of "left", "center" or "right". Defaults to "center".

backgroundColor

public String backgroundColor

The background color or gradient for the data label. Defaults to undefined.

borderColor

public String borderColor

The border color for the data label. Defaults to undefined.

borderRadius

public Integer borderRadius

The border radius in pixels for the data label. Defaults to 0.

borderWidth

public Integer borderWidth

The border width in pixels for the data label. Defaults to 0.

color

public String color

The text color for the data labels. Defaults to null.

enabled

public Boolean enabled

Enable or disable the data labels. Defaults to false.

formatter

@JavaScript
public String formatter

Callback JavaScript function to format the data label.

overflow

public String overflow

How to handle overflowing labels on horizontal axis. Can be undefined or "justify". If "justify", labels will not render outside the plot area. If there is room to move it, it will be aligned to the edge, else it will be removed. Defaults to undefined.

padding

public Integer padding

When either the borderWidth or the backgroundColor is set, this is the padding within the box. Defaults to 2. Defaults to 2.

rotation

public Integer rotation

Rotation of the labels in degrees. Defaults to 0.

shadow

public Object shadow

The shadow of the box. Works best with borderWidth or backgroundColor. The shadow can be an object configuration containing color, offsetX, offsetY, opacity and width. Defaults to false.

style

public final StyleOptions style

CSS styles for the label.

x

public Integer x

The x position offset of the label relative to the point. Defaults to 0.

y

public Integer y

The y position offset of the label relative to the point. Defaults to -6.

Constructor Detail

DataLabelOptions

public DataLabelOptions()