org.fujion.highcharts

Class AxisLabelOptions

java.lang.Object

org.fujion.ancillary.Options

org.fujion.highcharts.AxisLabelOptions

All Implemented Interfaces:

OptionMap.IOptionMapConverter

public class AxisLabelOptions
extends Options

Options for axis labels.

Field Summary

Fields

Modifier and Type	Field and Description
AlignHorizontal	align What part of the string the given position is anchored to.
Boolean	enabled Enable or disable the axis labels.
String	formatter Callback JavaScript function to format the label.
String	overflow How to handle overflowing labels on horizontal axis.
Integer	rotation Rotation of the labels in degrees.
Integer	staggerLines Horizontal axes only.
Integer	step To show only every n'th label on the axis, set the step to n.
StyleOptions	style CSS styles for the label.
Integer	x The x position offset of the label relative to the tick position on the axis.
Integer	y The y position offset of the label relative to the tick position on the axis.

Constructor Summary

Constructors

Constructor and Description
AxisLabelOptions()

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

What part of the string the given position is anchored to. Can be one of "left", "center" or "right". In inverted charts, x axis label alignment and y axis alignment are swapped. Defaults to "center".

enabled

public Boolean enabled

Enable or disable the axis labels. Defaults to true.

formatter

@JavaScript
public String formatter

Callback JavaScript function to format the 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.

rotation

public Integer rotation

Rotation of the labels in degrees. Defaults to 0.

staggerLines

public Integer staggerLines

Horizontal axes only. The number of lines to spread the labels over to make room or tighter labels. . Defaults to null.

step

public Integer step

To show only every n'th label on the axis, set the step to n. Setting the step to 2 shows every other label. Defaults to null.

style

public final StyleOptions style

CSS styles for the label. Defaults to:

     color: '#6D869F',
     fontWeight: 'bold'
 

x

public Integer x

The x position offset of the label relative to the tick position on the axis. Defaults to 0.

y

public Integer y

The y position offset of the label relative to the tick position on the axis. Defaults to 0.

Constructor Detail

AxisLabelOptions

public AxisLabelOptions()