Inherits BaseObject.
|
| LegendAccessibility | Accessibility [get, set] |
| | Accessibility options for the legend. Requires the Accessibilitymodule. More...
|
| |
| LegendAlign | Align [get, set] |
| | The horizontal alignment of the legend box within the chart area.Valid values are left, center and right.In the case that the legend is aligned in a corner position, thelayout option will determine whether to place it above/belowor on the side of the plot area. More...
|
| |
| bool | AlignColumns [get, set] |
| | If the layout is horizontal and the legend itemsspan over two lines or more, whether to align the items into verticalcolumns. Setting this to false makes room for more items, but willlook more messy. More...
|
| |
| string | BackgroundColor [get, set] |
| | The background color of the legend. More...
|
| |
| string | BorderColor [get, set] |
| | The color of the drawn border around the legend. More...
|
| |
| double | BorderRadius [get, set] |
| | The border corner radius of the legend. More...
|
| |
| double | BorderWidth [get, set] |
| | The width of the drawn border around the legend. More...
|
| |
| LegendBubbleLegend | BubbleLegend [get, set] |
| | The bubble legend is an additional element in legend whichpresents the scale of the bubble series. Individual bubble rangescan be defined by user or calculated from series. In the case ofautomatically calculated ranges, a 1px margin of error ispermitted. More...
|
| |
| string | ClassName [get, set] |
| | A CSS class name to apply to the legend group. More...
|
| |
| bool | Enabled [get, set] |
| | Enable or disable the legend. There is also a series-specific option,showInLegend, that can hide theseries from the legend. In some series types this is false bydefault, so it must set to true in order to show the legend for theseries. More...
|
| |
| bool | Floating [get, set] |
| | When the legend is floating, the plot area ignores it and is allowedto be placed below it. More...
|
| |
| Hashtable | ItemCheckboxStyle [get, set] |
| | Default styling for the checkbox next to a legend item whenshowCheckbox is true. More...
|
| |
| double | ItemDistance [get, set] |
| | In a legend with horizontal layout, the itemDistance defines thepixel distance between each item. More...
|
| |
| Hashtable | ItemHiddenStyle [get, set] |
| | CSS styles for each legend item when the corresponding series orpoint is hidden. Only a subset of CSS is supported, notably thoseoptions related to text. Properties are inherited from styleunless overridden here. More...
|
| |
| Hashtable | ItemHoverStyle [get, set] |
| | CSS styles for each legend item in hover mode. Only a subset ofCSS is supported, notably those options related to text. Propertiesare inherited from style unless overridden here. More...
|
| |
| double | ItemMarginBottom [get, set] |
| | The pixel bottom margin for each legend item. More...
|
| |
| double | ItemMarginTop [get, set] |
| | The pixel top margin for each legend item. More...
|
| |
| Hashtable | ItemStyle [get, set] |
| | CSS styles for each legend item. Only a subset of CSS is supported,notably those options related to text. The default textOverflowproperty makes long texts truncate. Set it to undefined to wraptext instead. A width property can be added to control the textwidth. More...
|
| |
| double | ItemWidth [get, set] |
| | The width for each legend item. By default the items are laid outsuccessively. In a horizontal layout, if the itemsare laid out across two rows or more, they will be vertically aligneddepending on the legend.alignColumns option. More...
|
| |
| string | LabelFormat [get, set] |
| | A format stringfor each legend label. Available variables relates to properties onthe series, or the point in case of pies. More...
|
| |
| bool | LabelFormatter [get, set] |
| | Callback function to format each of the series' labels. The thiskeyword refers to the series object, or the point object in case ofpie charts. By default the series or point name is printed. More...
|
| |
| LegendLayout | Layout [get, set] |
| | The layout of the legend items. Can be one of horizontal orvertical or proximate. When proximate, the legend items will beplaced as close as possible to the graphs they're representing,except in inverted charts or when the legend position doesn't allowit. More...
|
| |
| double | LineHeight [get, set] |
| | Line height for the legend items. Deprecated as of 2.1. Instead,the line height for each item can be set usingitemStyle.lineHeight, and the padding between items usingitemMarginTop and itemMarginBottom. More...
|
| |
| double | Margin [get, set] |
| | If the plot area sized is calculated automatically and the legend isnot floating, the legend margin is the space between the legend andthe axis labels or plot area. More...
|
| |
| double | MaxHeight [get, set] |
| | Maximum pixel height for the legend. When the maximum height isextended, navigation will show. More...
|
| |
| LegendNavigation | Navigation [get, set] |
| | Options for the paging or navigation appearing when the legend isoverflown. Navigation works well on screen, but not in staticexported images. One way of working around that is toincrease the chart height inexport. More...
|
| |
| double | Padding [get, set] |
| | The inner padding of the legend box. More...
|
| |
| bool | Reversed [get, set] |
| | Whether to reverse the order of the legend items compared to theorder of the series or points as defined in the configuration object. More...
|
| |
| bool | Rtl [get, set] |
| | Whether to show the symbol on the right side of the text rather thanthe left side. This is common in Arabic and Hebrew. More...
|
| |
| Shadow | Shadow [get, set] |
| | Whether to apply a drop shadow to the legend. A backgroundColoralso needs to be applied for this to take effect. The shadow can bean object configuration containing color, offsetX, offsetY,opacity and width. More...
|
| |
| bool | SquareSymbol [get, set] |
| | When this is true, the legend symbol width will be the same asthe symbol height, which in turn defaults to the font size of thelegend items. More...
|
| |
| Hashtable | Style [get, set] |
| | CSS styles for the legend area. In the 1.x versions the positionof the legend area was determined by CSS. In 2.x, the position isdetermined by properties like align, verticalAlign, x and y,but the styles are still parsed for backwards compatibility. More...
|
| |
| double | SymbolHeight [get, set] |
| | The pixel height of the symbol for series types that use a rectanglein the legend. Defaults to the font size of legend items.Note: This option is a default source of color axis height, if thecolorAxis.heightoption is not set. More...
|
| |
| double | SymbolPadding [get, set] |
| | The pixel padding between the legend item symbol and the legenditem text. More...
|
| |
| double | SymbolRadius [get, set] |
| | The border radius of the symbol for series types that use a rectanglein the legend. Defaults to half the symbolHeight, effectivelycreating a circle.For color axis scales, it defaults to 3. More...
|
| |
| double | SymbolWidth [get, set] |
| | The pixel width of the legend item symbol. When the squareSymboloption is set, this defaults to the symbolHeight, otherwise 16.Note: This option is a default source of color axis width, if thecolorAxis.widthoption is not set. More...
|
| |
| LegendTitle | Title [get, set] |
| | A title to be added on top of the legend. More...
|
| |
| bool | UseHTML [get, set] |
| | Whether to use HTMLto render the legend item texts.Prior to 4.1.7, when using HTML, legend.navigation was disabled. More...
|
| |
| double | ValueDecimals [get, set] |
| | For a color axis with data classes, how many decimals to render inthe legend. The default preserves the decimals of the range numbers. More...
|
| |
| string | ValueSuffix [get, set] |
| | For a color axis with data classes, a suffix for the range numbers inthe legend. More...
|
| |
| LegendVerticalAlign | VerticalAlign [get, set] |
| | The vertical alignment of the legend box. Can be one of top,middle or bottom. Vertical position can be further determinedby the y option.In the case that the legend is aligned in a corner position, thelayout option will determine whether to place it above/belowor on the side of the plot area.When the layout option is proximate, theverticalAlign option doesn't apply. More...
|
| |
| string | Width [get, set] |
| | The width of the legend box. If a number is set, it translates topixels. Since v7.0.2 it allows setting a percent string of the fullchart width, for example 40%.Defaults to the full chart width for legends below or above thechart, half the chart width for legends to the left and right. More...
|
| |
| double | WidthNumber [get, set] |
| | The width of the legend box. If a number is set, it translates topixels. Since v7.0.2 it allows setting a percent string of the fullchart width, for example 40%.Defaults to the full chart width for legends below or above thechart, half the chart width for legends to the left and right. More...
|
| |
| double | X [get, set] |
| | The x offset of the legend relative to its horizontal alignmentalign within chart.spacingLeft and chart.spacingRight. Negativex moves it to the left, positive x moves it to the right. More...
|
| |
| double | Y [get, set] |
| | The vertical offset of the legend relative to it's vertical alignmentverticalAlign within chart.spacingTop and chart.spacingBottom. Negative y moves it up, positive y moves it down. More...
|
| |
|
Hashtable | CustomFields [get, set] |
| |
1.8.14