Interface: LegendOptions<TType>

Alignment of the legend.

default ‘center’

Defined in

display

• display: boolean

Is the legend shown?

default true

Defined in

index.esm.d.ts:2195 (opens new window)

fullSize

• fullSize: boolean

Marks that this box should take the full width/height of the canvas (moving other boxes). This is unlikely to need to be changed in day-to-day use.

default true

Defined in

labels

• labels: Object

Type declaration

Name	Type	Description
`boxHeight`	`number`	Height of the coloured box. `default` fontSize
`boxPadding`	`number`	Padding between the color box and the text `default` 1
`boxWidth`	`number`	Width of colored box. `default` 40
`color`	Color	Color of label `see` Defaults.color
`font`		Font of label `see` Defaults.font
`padding`	`number`	Padding between rows of colored boxes. `default` 10
`pointStyle`	PointStyle	Override point style for the legend. Only applies if usePointStyle is true
`textAlign?`		Text alignment
`usePointStyle`	`boolean`	Label style will match corresponding point style (size is based on the minimum value between boxWidth and font.size). `default` false
`filter`	(: LegendItem, `data`: <keyof ChartTypeRegistry, (`number` \| \| BubbleDataPoint)[], `unknown`>) => `boolean`	-
`generateLabels`	(`chart`: <keyof ChartTypeRegistry, (`number` \| \| BubbleDataPoint)[], `unknown`>) => []	-
`sort`	(`a`: LegendItem, `b`: , `data`: ChartData<keyof , (`number` \| ScatterDataPoint \| )[], `unknown`>) => `number`	-

Defined in

• maxHeight: number

Maximum height of the legend, in pixels

Defined in

maxWidth

• maxWidth: number

Maximum width of the legend, in pixels

Defined in

position

• position:

Position of the legend.

default ‘top’

Defined in

reverse

• reverse: boolean

Legend will show datasets in reverse order.

default false

Defined in

index.esm.d.ts:2223 (opens new window)

• rtl: boolean

true for rendering the legends from right to left.

Defined in

index.esm.d.ts:2302 (opens new window)

textDirection

• textDirection: string

default canvas’ default

Defined in

title

• title: Object

Type declaration

Defined in

onClick

▸ onClick(e, legendItem, legend): void

A callback that is called when a click event is registered on a label item.

Parameters

Name	Type
`e`	ChartEvent
`legendItem`
`legend`	LegendElement<`TType`>

Returns

void

Defined in

▸ onHover(e, legendItem, legend): void

A callback that is called when a ‘mousemove’ event is registered on top of a label item

Parameters

Returns

void

Defined in

onLeave

▸ onLeave(e, legendItem, legend): void

A callback that is called when a ‘mousemove’ event is registered outside of a previously hovered label item.

Parameters

Name	Type
`e`	ChartEvent
`legendItem`
`legend`	LegendElement<>

Returns

void