Hierarchy

  • Legend

Properties

backgroundColor: string

The color of the legend background.

borderColor: string

The border color of the legend.

maxSize: string

Defines the maximum size of the legend in pixels (e.g. '50px') or percent (e.g. '15%').

position: string

The position of the legend within the chart. By default, the legend will be placed on the side or bottom, based on the size of the chart and the legend contents.

referenceObjectSection: LegendReferenceObjectSection

An object defining the reference object section in the legend.

rendered: string

Defines whether the legend is displayed. If set to auto, the legend will be hidden for charts with a large number of series. See the Help documentation for more information.

scrolling: string

Defines whether scrolling is enabled for the legend.

sectionTitleHalign: string

The horizontal alignment of the section titles.

sectionTitleStyle: object

The CSS style object defining the style of the section titles' text. The following style properties are supported: color, fontFamily, fontSize, fontStyle, fontWeight and textDecoration.

sections: LegendSections[]

An array of objects defining the additional legend sections, other than the default series and reference object sections.

seriesSection: LegendSeriesSection

An object defining the series section in the legend.

size: string

Defines the size of the legend in pixels (e.g. '50px') or percent (e.g. '15%').

symbolHeight: number

The height of the legend symbol (line or marker) in pixels.

symbolWidth: number

The width of the legend symbol (line or marker) in pixels.

textStyle: object

The CSS style object defining the style of the legend text.

title: string

The legend title.

titleHalign: string

The horizontal alignment of the title.

titleStyle: object

The CSS style object defining the style of the title.

Generated using TypeDoc