Skip to main content

LegendPositionConfig

@elastic/charts • Exports

@elastic/charts / LegendPositionConfig

Type alias: LegendPositionConfig

LegendPositionConfig: Object

The legend position configuration.

Type declaration​

direction​

direction: LayoutDirection

The direction of the legend items. horizontal shows all the items listed one a side the other horizontally, wrapping to new lines. vertical shows the items in a vertical list

floating​

floating: boolean

Remove the legend from the outside chart area, making it floating above the chart.

Default Value​

false

floatingColumns?​

floatingColumns?: number

The number of columns in floating configuration

Default Value​

1

hAlign​

hAlign: typeof HorizontalAlignment.Left | typeof HorizontalAlignment.Right

The horizontal alignment of the legend

vAlign​

vAlign: typeof VerticalAlignment.Top | typeof VerticalAlignment.Bottom

The vertical alignment of the legend

Source​

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

Generated using typedoc-plugin-markdown and TypeDoc