org.fujion.highcharts

Class DataLabelOptions

java.lang.Object

org.fujion.ancillary.Options

org.fujion.highcharts.DataLabelOptions

All Implemented Interfaces:

OptionMap.IOptionMapConverter, IClientTransform

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.
Boolean	allowOverlap Whether to allow data labels to overlap.
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	className A class name for the data label.
String	color The text color for the data labels.
Boolean	crop Whether to hide data labels that are outside the plot area.
Boolean	defer Whether to defer displaying the data labels until the initial series animation has finished.
Boolean	enabled Enable or disable the data labels.
String	format A format string for the data label.
String	formatter Callback JavaScript function to format the data label.
Boolean	inside 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.
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.
String	shape The name of a symbol to use for the border around the label.
StyleOptions	style CSS styles for the label.
Boolean	useHTML Whether to use HTML to render the labels.
AlignVertical	verticalAlign The vertical alignment of a data 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.
Integer	zIndex The Z index of the data labels.

Constructor Summary

Constructors

Constructor and Description
DataLabelOptions()

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

align

@Option
public AlignHorizontal align

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

allowOverlap

@Option
public Boolean allowOverlap

Whether to allow data labels to overlap. To make the labels less sensitive for overlapping, the dataLabels.padding can be set to 0. Defaults to false.

backgroundColor

@Option
public String backgroundColor

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

borderColor

@Option
public String borderColor

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

borderRadius

@Option
public Integer borderRadius

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

borderWidth

@Option
public Integer borderWidth

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

className

@Option
public String className

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

color

@Option
public String color

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

crop

@Option
public Boolean crop

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

defer

@Option
public Boolean defer

Whether to defer displaying the data labels until the initial series animation has finished. Defaults to true.

enabled

@Option
public Boolean enabled

Enable or disable the data labels. Defaults to false.

format

@Option
public String format

A format string for the data label. Available variables are the same as for formatter. Defaults to {y}.

formatter

@Option(convertTo=org.fujion.ancillary.JavaScript.class)
public String formatter

Callback JavaScript function to format the data label.

inside

@Option
public Boolean inside

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

overflow

@Option
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

@Option
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

@Option
public Integer rotation

Rotation of the labels in degrees. Defaults to 0.

shadow

@Option
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.

shape

@Option
public String shape

The name of a symbol to use for the border around the label. Symbols are predefined functions on the Renderer object. Defaults to square.

style

@Option
public final StyleOptions style

CSS styles for the label.

useHTML

@Option
public Boolean useHTML

Whether to use HTML to render the labels. Defaults to false.

verticalAlign

@Option
public AlignVertical verticalAlign

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

x

@Option
public Integer x

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

y

@Option
public Integer y

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

zIndex

@Option
public Integer zIndex

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

Constructor Detail

DataLabelOptions

public DataLabelOptions()