org.fujion.highcharts

Class LegendNavigationOptions

java.lang.Object

org.fujion.ancillary.Options

org.fujion.highcharts.LegendNavigationOptions

All Implemented Interfaces:

OptionMap.IOptionMapConverter, IClientTransform

public class LegendNavigationOptions
extends Options

Options for the paging or navigation appearing when the legend overflows.

Field Summary

Fields

Modifier and Type	Field and Description
String	activeColor The color for the active up or down arrow in the legend page navigation.
AnimationOptions	animation How to animate the pages when navigating up or down.
Integer	arrowSize The pixel size of the up and down arrows in the legend paging navigation.
Boolean	enabled Whether to enable the legend navigation.
String	inactiveColor The color of the inactive up or down arrow in the legend page navigation.
StyleOptions	style Text styles for the legend page navigation.

Constructor Summary

Constructors

Constructor and Description
LegendNavigationOptions()

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

activeColor

@Option
public String activeColor

The color for the active up or down arrow in the legend page navigation. Defaults to #003399.

animation

@Option
public AnimationOptions animation

How to animate the pages when navigating up or down. A value of true applies the default navigation given in the chart.animation option.

arrowSize

@Option
public Integer arrowSize

The pixel size of the up and down arrows in the legend paging navigation. Defaults to 12.

enabled

@Option
public Boolean enabled

Whether to enable the legend navigation. In most cases, disabling the navigation results in an unwanted overflow. See also the adapt chart to legend plugin for a solution to extend the chart height to make room for the legend, optionally in exported charts only. Defaults to true.

inactiveColor

@Option
public String inactiveColor

The color of the inactive up or down arrow in the legend page navigation. Defaults to #cccccc.

style

@Option
public final StyleOptions style

Text styles for the legend page navigation.

Constructor Detail

LegendNavigationOptions

public LegendNavigationOptions()