org.fujion.highcharts

Class TitleOptions

java.lang.Object

org.fujion.ancillary.Options

org.fujion.highcharts.TitleOptions

All Implemented Interfaces:

OptionMap.IOptionMapConverter, IClientTransform

public class TitleOptions
extends Options

Display options for a chart title.

Field Summary

Fields

Modifier and Type	Field and Description
AlignHorizontal	align The horizontal alignment of the title or subtitle.
Boolean	floating When the title or subtitle is floating, the plot area will not move to make space for it.
Integer	margin The margin between the title and the plot area, or if a subtitle is present, the margin between the subtitle and the plot area.
StyleOptions	style CSS styles for the title or subtitle.
String	text The title or subtitle of the chart.
AlignVertical	verticalAlign The vertical alignment of the title or subtitle.
Integer	x The x position of the title or subtitle relative to the alignment within chart.spacingLeft and chart.spacingRight.
Integer	y The y position of the subtitle relative to the alignment within chart.spacingTop and chart.spacingBottom.

Constructor Summary

Constructors

Constructor and Description
TitleOptions()

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 horizontal alignment of the title or subtitle. Can be one of "left", "center" and "right". Defaults to "center".

floating

@Option
public Boolean floating

When the title or subtitle is floating, the plot area will not move to make space for it. Defaults to false.

margin

@Option
public Integer margin

The margin between the title and the plot area, or if a subtitle is present, the margin between the subtitle and the plot area. Defaults to 15. Ignored for subtitles.

style

@Option
public final StyleOptions style

CSS styles for the title or subtitle. Use this for font styling, but use align, x and y for text alignment. Defaults to:

     color: '#3E576F'
     fontSize: '16px' (title only)
 

text

@Option
public String text

The title or subtitle of the chart. To disable, set the text to null. Defaults to "Chart title" for title and "" for subtitle.

verticalAlign

@Option
public AlignVertical verticalAlign

The vertical alignment of the title or subtitle. Can be one of "top", "middle" and "bottom". Defaults to "top".

x

@Option
public Integer x

The x position of the title or subtitle relative to the alignment within chart.spacingLeft and chart.spacingRight. Defaults to 0.

y

@Option
public Integer y

The y position of the subtitle relative to the alignment within chart.spacingTop and chart.spacingBottom. Defaults to 15 for title and 30 for subtitle.

Constructor Detail

TitleOptions

public TitleOptions()