org.fujion.highcharts

Class LegendOptions

java.lang.Object

org.fujion.ancillary.Options

org.fujion.highcharts.LegendOptions

All Implemented Interfaces:

OptionMap.IOptionMapConverter, IClientTransform

public class LegendOptions
extends Options

The legend is a box containing a symbol and name for each series item or point item in the chart.

Field Summary

Fields

Modifier and Type	Field and Description
AlignHorizontal	align The horizontal alignment of the legend box within the chart area.
String	backgroundColor The background color of the legend, filling the rounded corner border.
String	borderColor The color of the drawn border around the legend.
Integer	borderRadius The border corner radius of the legend.
Integer	borderWidth The width of the drawn border around the legend.
Boolean	enabled Enable or disable the legend.
Boolean	floating When the legend is floating, the plot area ignores it and is allowed to be placed below it.
Integer	itemDistance In a legend with horizontal layout, the itemDistance defines the pixel distance between each item.
StyleOptions	itemHiddenStyle CSS styles for each legend item when the corresponding series or point is hidden.
StyleOptions	itemHoverStyle CSS styles for each legend item in hover mode.
Integer	itemMarginBottom The pixel bottom margin for each legend item.
Integer	itemMarginTop The pixel top margin for each legend item.
StyleOptions	itemStyle CSS styles for each legend item.
Integer	itemWidth The width for each legend item.
Boolean	keyboardNavigation_enabled Enable/disable keyboard navigation for the legend.
String	labelFormat A format string for each legend label.
String	labelFormatter Callback function to format each of the series' labels.
Orientation	layout The layout of the legend items.
Integer	margin If the plot area sized is calculated automatically and the legend is not floating, the legend margin is the space between the legend and the axis labels or plot area.
Integer	maxHeight Maximum pixel height for the legend.
LegendNavigationOptions	navigation Options for the paging or navigation appearing when the legend has overflowed.
Integer	padding The inner padding of the legend box.
Boolean	reversed Whether to reverse the order of the legend items compared to the order of the series or points as defined in the configuration object.
Boolean	rtl Whether to show the symbol on the right side of the text rather than the left side.
ShadowOptions	shadow Whether to apply a drop shadow to the legend.
Boolean	squareSymbol When this is true, the legend symbol width will be the same as the symbol height, which in turn defaults to the font size of the legend items.
StyleOptions	style CSS styles for the legend area.
Integer	symbolHeight The pixel height of the symbol for series types that use a rectangle in the legend.
Integer	symbolPadding The pixel padding between the legend item symbol and the legend item text.
Integer	symbolRadius The border radius of the symbol for series types that use a rectangle in the legend.
Integer	symbolWidth The pixel width of the legend item symbol.
LegendTitleOptions	title A title to be added on top of the legend.
Boolean	useHTML Whether to use HTML to render the legend item texts.
AlignVertical	verticalAlign The vertical alignment of the legend box.
Integer	width The width of the legend box, not including style.padding.
Integer	x The x offset of the legend relative to its horizontal alignment align within chart.spacingLeft and chart.spacingRight.
Integer	y The vertical offset of the legend relative to it's vertical alignment verticalAlign within chart.spacingTop and chart.spacingBottom.

Constructor Summary

Constructors

Constructor and Description
LegendOptions()

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 legend box within the chart area. Defaults to "center".

backgroundColor

@Option
public String backgroundColor

The background color of the legend, filling the rounded corner border. Defaults to null.

borderColor

@Option
public String borderColor

The color of the drawn border around the legend. Defaults to #999999.

borderRadius

@Option
public Integer borderRadius

The border corner radius of the legend. Defaults to 0.

borderWidth

@Option
public Integer borderWidth

The width of the drawn border around the legend. Defaults to 0.

enabled

@Option
public Boolean enabled

Enable or disable the legend. Defaults to true.

floating

@Option
public Boolean floating

When the legend is floating, the plot area ignores it and is allowed to be placed below it. Defaults to false.

itemDistance

@Option
public Integer itemDistance

In a legend with horizontal layout, the itemDistance defines the pixel distance between each item. Defaults to 20.

itemHiddenStyle

@Option
public final StyleOptions itemHiddenStyle

CSS styles for each legend item when the corresponding series or point is hidden.

itemHoverStyle

@Option
public final StyleOptions itemHoverStyle

CSS styles for each legend item in hover mode.

itemMarginBottom

@Option
public Integer itemMarginBottom

The pixel bottom margin for each legend item. Defaults to 0.

itemMarginTop

@Option
public Integer itemMarginTop

The pixel top margin for each legend item. Defaults to 0.

itemStyle

@Option
public final StyleOptions itemStyle

CSS styles for each legend item.

itemWidth

@Option
public Integer itemWidth

The width for each legend item. This is useful in a horizontal layout with many items when you want the items to align vertically. . Defaults to null.

keyboardNavigation_enabled

@Option(value="keyboardNavigation.enabled")
public Boolean keyboardNavigation_enabled

Enable/disable keyboard navigation for the legend. Requires the Accessibility module. Defaults to true.

labelFormat

@Option
public String labelFormat

A format string for each legend label. Available variables relates to properties on the series, or the point in case of pies. Defaults to {name}.

labelFormatter

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

Callback function to format each of the series' labels. The this keyword refers to the series object, or the point object in case of pie charts. By default the series or point name is printed. Defaults to undefined.

layout

@Option
public Orientation layout

The layout of the legend items. Can be one of "horizontal" or "vertical". Defaults to "horizontal".

margin

@Option
public Integer margin

If the plot area sized is calculated automatically and the legend is not floating, the legend margin is the space between the legend and the axis labels or plot area. Defaults to 12.

maxHeight

@Option
public Integer maxHeight

Maximum pixel height for the legend. When the maximum height is extended, navigation will show. Defaults to undefined.

navigation

@Option
public final LegendNavigationOptions navigation

Options for the paging or navigation appearing when the legend has overflowed.

padding

@Option
public Integer padding

The inner padding of the legend box. Defaults to 8.

reversed

@Option
public Boolean reversed

Whether to reverse the order of the legend items compared to the order of the series or points as defined in the configuration object. Defaults to false.

rtl

@Option
public Boolean rtl

Whether to show the symbol on the right side of the text rather than the left side. This is common in Arabic and Hebraic. Defaults to false.

shadow

@Option
public ShadowOptions shadow

Whether to apply a drop shadow to the legend. A backgroundColor also needs to be applied for this to take effect. Defaults to no shadow.

squareSymbol

@Option
public Boolean squareSymbol

When this is true, the legend symbol width will be the same as the symbol height, which in turn defaults to the font size of the legend items. Defaults to true.

style

@Option
public final StyleOptions style

CSS styles for the legend area. The position is determined by properties like align, verticalAlign, x and y, but the styles are still parsed for backwards compatibility. Defaults to undefined.

symbolHeight

@Option
public Integer symbolHeight

The pixel height of the symbol for series types that use a rectangle in the legend. Defaults to the font size of legend items. Defaults to undefined.

symbolPadding

@Option
public Integer symbolPadding

The pixel padding between the legend item symbol and the legend item text. Defaults to 5.

symbolRadius

@Option
public Integer symbolRadius

The border radius of the symbol for series types that use a rectangle in the legend. Defaults to half the symbolHeight. Defaults to undefined.

symbolWidth

@Option
public Integer symbolWidth

The pixel width of the legend item symbol. When the squareSymbol option is set, this defaults to the symbolHeight, otherwise 16. Defaults to undefined.

title

@Option
public final LegendTitleOptions title

A title to be added on top of the legend.

useHTML

@Option
public Boolean useHTML

Whether to use HTML to render the legend item texts. When using HTML, legend.navigation is disabled.

verticalAlign

@Option
public AlignVertical verticalAlign

The vertical alignment of the legend box. Can be one of "top", "middle" or "bottom". Vertical position can be further determined by the y option. Defaults to "bottom".

width

@Option
public Integer width

The width of the legend box, not including style.padding. . Defaults to null.

x

@Option
public Integer x

The x offset of the legend relative to its horizontal alignment align within chart.spacingLeft and chart.spacingRight. Negative x moves it to the left, positive x moves it to the right. Defaults to 0.

y

@Option
public Integer y

The vertical offset of the legend relative to it's vertical alignment verticalAlign within chart.spacingTop and chart.spacingBottom. Negative y moves it up, positive y moves it down. Defaults to 0.

Constructor Detail

LegendOptions

public LegendOptions()