Skip to main content

LegendSpec

@elastic/chartsExports


@elastic/charts / LegendSpec

Interface: LegendSpec

The legend configuration

Contents

Extended By

Properties

customLegend?

customLegend?: CustomLegend

Override the legend with a custom component.

Source

packages/charts/src/specs/settings.tsx:420


flatLegend?

flatLegend?: boolean

Display the legend as a flat list.

Default Value

false

Source

packages/charts/src/specs/settings.tsx:397


legendAction?

legendAction?: LegendAction

Render slot to render action for legend

Source

packages/charts/src/specs/settings.tsx:411


legendColorPicker?

legendColorPicker?: LegendColorPicker

Source

packages/charts/src/specs/settings.tsx:412


legendMaxDepth

legendMaxDepth: number

Limit the legend to the specified maximal depth when showing a hierarchical legend

Remarks

This is not the max depth, but the number of level shown: 0 none, 1 first, 2 up to the second etc. See https://github.com/elastic/elastic-charts/issues/1981 for details

Source

packages/charts/src/specs/settings.tsx:385


legendPosition

legendPosition: Position | LegendPositionConfig

Set legend position

Default Value

Position.Right

Source

packages/charts/src/specs/settings.tsx:372


legendSize

legendSize: number

Sets the exact legend width (vertical) or height (horizontal)

Limited to max of 70% of the chart container dimension Vertical legends limited to min of 30% of computed width

Source

packages/charts/src/specs/settings.tsx:392


legendSort?

legendSort?: SeriesCompareFn

A SeriesSortFn to sort the legend values (top-bottom)

Source

packages/charts/src/specs/settings.tsx:416


legendStrategy?

legendStrategy?: LegendStrategy

Choose a partition highlighting strategy for hovering over legend items.

Default Value

LegendStrategy.Path

Source

packages/charts/src/specs/settings.tsx:402


legendTitle?

legendTitle?: string

a title for the table legend

Source

packages/charts/src/specs/settings.tsx:424


legendValues

legendValues: LegendValue[]

Add one or more computed statistics to each legend item. The available statistics depends by chart type.

Source

packages/charts/src/specs/settings.tsx:377


onLegendItemClick?

onLegendItemClick?: LegendItemListener

Source

packages/charts/src/specs/settings.tsx:405


onLegendItemMinusClick?

onLegendItemMinusClick?: LegendItemListener

Source

packages/charts/src/specs/settings.tsx:407


onLegendItemOut?

onLegendItemOut?: BasicListener

Source

packages/charts/src/specs/settings.tsx:404


onLegendItemOver?

onLegendItemOver?: LegendItemListener

Source

packages/charts/src/specs/settings.tsx:403


onLegendItemPlusClick?

onLegendItemPlusClick?: LegendItemListener

Source

packages/charts/src/specs/settings.tsx:406


showLegend

showLegend: boolean

Show the legend

Default Value

false

Source

packages/charts/src/specs/settings.tsx:367


Generated using typedoc-plugin-markdown and TypeDoc