LegendOptions (Fujion Wrapper for HighCharts 1.1.8 API)

java.lang.Object
- org.fujion.ancillary.Options
- - org.fujion.highcharts.LegendOptions

All Implemented Interfaces:

OptionMap.IOptionMapConverter
```
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.
`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.
`Object`	`shadow` Whether to apply a drop shadow to the legend.
`Integer`	`symbolPadding` The pixel padding between the legend item symbol and the legend item text.
`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 it's 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()

Constructors
Constructor and Description
`LegendOptions()`

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
```
    The horizontal alignment of the legend box within the chart area. Defaults to "center".
  - backgroundColor
```
public String backgroundColor
```
    The background color of the legend, filling the rounded corner border. Defaults to null.
  - borderColor
```
public String borderColor
```
    The color of the drawn border around the legend. Defaults to #909090.
  - borderRadius
```
public Integer borderRadius
```
    The border corner radius of the legend. Defaults to 5.
  - borderWidth
```
public Integer borderWidth
```
    The width of the drawn border around the legend. Defaults to 1.
  - enabled
```
public Boolean enabled
```
    Enable or disable the legend. Defaults to true.
  - floating
```
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
```
public Integer itemDistance
```
    In a legend with horizontal layout, the itemDistance defines the pixel distance between each item. Defaults to 8.
  - itemHiddenStyle
```
public final StyleOptions itemHiddenStyle
```
    CSS styles for each legend item when the corresponding series or point is hidden. Properties are inherited from style unless overridden here. Defaults to:
```
     color: '#CCC'
 
```
  - itemHoverStyle
```
public final StyleOptions itemHoverStyle
```
    CSS styles for each legend item in hover mode. Properties are inherited from style unless overridden here. Defaults to:
```
     color: '#000'
 
```
  - itemMarginBottom
```
public Integer itemMarginBottom
```
    The pixel bottom margin for each legend item. Defaults to 0.
  - itemMarginTop
```
public Integer itemMarginTop
```
    The pixel top margin for each legend item. Defaults to 0.
  - itemStyle
```
public final StyleOptions itemStyle
```
    CSS styles for each legend item. Defaults to:
```
     cursor: 'pointer'
     color: '#3E576F'
 
```
  - itemWidth
```
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.
  - labelFormatter
```
@JavaScript
public String labelFormatter
```
    Callback function to format each of the series' labels.
  - layout
```
public Orientation layout
```
    The layout of the legend items. Can be one of "horizontal" or "vertical". Defaults to "horizontal".
  - margin
```
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 15.
  - maxHeight
```
public Integer maxHeight
```
    Maximum pixel height for the legend. When the maximum height is extended, navigation will show. Defaults to undefined.
  - navigation
```
public final LegendNavigationOptions navigation
```
    Options for the paging or navigation appearing when the legend has overflowed.
  - padding
```
public Integer padding
```
    The inner padding of the legend box. Defaults to 8.
  - reversed
```
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
```
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
```
public Object shadow
```
    Whether to apply a drop shadow to the legend. A backgroundColor also needs to be applied for this to take effect. Since 2.3 the shadow can be an object configuration containing color, offsetX, offsetY, opacity and width. Defaults to false.
  - symbolPadding
```
public Integer symbolPadding
```
    The pixel padding between the legend item symbol and the legend item text. Defaults to 5.
  - symbolWidth
```
public Integer symbolWidth
```
    The pixel width of the legend item symbol. Defaults to 30.
  - title
```
public LegendTitleOptions title
```
    A title to be added on top of the legend.
  - useHTML
```
public Boolean useHTML
```
    Whether to use HTML to render the legend item texts. When using HTML, legend.navigation is disabled.
  - verticalAlign
```
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
```
public Integer width
```
    The width of the legend box, not including style.padding. . Defaults to null.
  - x
```
public Integer x
```
    The x offset of the legend relative to it's horizontal alignment align within chart.spacingLeft and chart.spacingRight. Negative x moves it to the left, positive x moves it to the right. The default value of 15 together with align: "center" puts it in the center of the plot area. Defaults to 0.
  - y
```
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()
```

Class LegendOptions

Field Summary

Constructor Summary

Method Summary

Methods inherited from class org.fujion.ancillary.Options

Methods inherited from class java.lang.Object

Field Detail

align

backgroundColor

borderColor

borderRadius

borderWidth

enabled

floating

itemDistance

itemHiddenStyle

itemHoverStyle

itemMarginBottom

itemMarginTop

itemStyle

itemWidth

labelFormatter

layout

margin

maxHeight

navigation

padding

reversed

rtl

shadow

symbolPadding

symbolWidth

title

useHTML

verticalAlign

width

x

y

Constructor Detail

LegendOptions