org.fujion.highcharts

Class AxisTitleOptions

java.lang.Object

org.fujion.ancillary.Options

org.fujion.highcharts.AxisTitleOptions

All Implemented Interfaces:

OptionMap.IOptionMapConverter, IClientTransform

public class AxisTitleOptions
extends Options

Options for an axis title.

Field Summary

Fields

Modifier and Type	Field and Description
String	align Alignment of the title relative to the axis values.
Integer	margin The pixel distance between the axis labels or line and the title.
Integer	offset The distance of the axis title from the axis line.
Integer	rotation The rotation of the text in degrees.
StyleOptions	style CSS styles for the title.
String	text The actual text of the axis title.

Constructor Summary

Constructors

Constructor and Description
AxisTitleOptions()

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 String align

Alignment of the title relative to the axis values. Possible values are "low", "middle" or "high". Defaults to "middle".

margin

@Option
public Integer margin

The pixel distance between the axis labels or line and the title. Defaults to 0 for horizontal axes, 10 for vertical.

offset

@Option
public Integer offset

The distance of the axis title from the axis line. By default, this distance is computed from the offset width of the labels, the labels' distance from the axis and the title's margin. However when the offset option is set, it overrides all this. Defaults to undefined.

rotation

@Option
public Integer rotation

The rotation of the text in degrees. 0 is horizontal, 270 is vertical reading from bottom to top. Defaults to 0.

style

@Option
public final StyleOptions style

CSS styles for the title. When titles are rotated they are rendered using vector graphic techniques and not all styles are applicable. Most noteworthy, a bug in IE8 renders all rotated strings bold and italic. Defaults to:

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

text

@Option
public String text

The actual text of the axis title. It can contain basic HTML text markup like <b>, <i> and spans with style. Defaults to null.

Constructor Detail

AxisTitleOptions

public AxisTitleOptions()