Interface: LegendOptions<TType>

Type parameters

NameType
TTypeextends ChartType

Properties

align

align: Align

Alignment of the legend.

default ‘center’

Defined in

index.esm.d.ts:2227LegendOptions - 图1 (opens new window)


display

display: boolean

Is the legend shown?

default true

Defined in

index.esm.d.ts:2217LegendOptions - 图2 (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

index.esm.d.ts:2240LegendOptions - 图3 (opens new window)


labels

labels: Object

Type declaration

NameTypeDescription
boxHeightnumberHeight of the coloured box. default fontSize
boxPaddingnumberPadding between the color box and the text default 1
boxWidthnumberWidth of colored box. default 40
colorColorColor of label see Defaults.color
fontFontSpecFont of label see Defaults.font
paddingnumberPadding between rows of colored boxes. default 10
pointStylePointStyleOverride point style for the legend. Only applies if usePointStyle is true
textAlign?TextAlignText alignment
usePointStylebooleanLabel style will match corresponding point style (size is based on the minimum value between boxWidth and font.size). default false
filter(item: LegendItem, data: ChartData<keyof ChartTypeRegistry, (number | ScatterDataPoint | BubbleDataPoint)[], unknown>) => boolean-
generateLabels(chart: Chart<keyof ChartTypeRegistry, (number | ScatterDataPoint | BubbleDataPoint)[], unknown>) => LegendItem[]-
sort(a: LegendItem, b: LegendItem, data: ChartData<keyof ChartTypeRegistry, (number | ScatterDataPoint | BubbleDataPoint)[], unknown>) => number-

Defined in

index.esm.d.ts:2259LegendOptions - 图4 (opens new window)


maxHeight

maxHeight: number

Maximum height of the legend, in pixels

Defined in

index.esm.d.ts:2231LegendOptions - 图5 (opens new window)


maxWidth

maxWidth: number

Maximum width of the legend, in pixels

Defined in

index.esm.d.ts:2235LegendOptions - 图6 (opens new window)


position

position: LayoutPosition

Position of the legend.

default ‘top’

Defined in

index.esm.d.ts:2222LegendOptions - 图7 (opens new window)


reverse

reverse: boolean

Legend will show datasets in reverse order.

default false

Defined in

index.esm.d.ts:2245LegendOptions - 图8 (opens new window)


rtl

rtl: boolean

true for rendering the legends from right to left.

Defined in

index.esm.d.ts:2324LegendOptions - 图9 (opens new window)


textDirection

textDirection: string

This will force the text direction ‘rtl’ or ‘ltr’ on the canvas for rendering the legend, regardless of the css specified on the canvas

default canvas’ default

Defined in

index.esm.d.ts:2329LegendOptions - 图10 (opens new window)


title

title: Object

Type declaration

NameTypeDescription
colorColorColor of title see Defaults.color
displaybooleanIs the legend title displayed. default false
fontFontSpecsee Fonts
padding?number | ChartArea-
position“start” | “end” | “center”-
textstringThe string title.

Defined in

index.esm.d.ts:2331LegendOptions - 图11 (opens new window)

Methods

onClick

onClick(e, legendItem, legend): void

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

Parameters

NameType
eChartEvent
legendItemLegendItem
legendLegendElement<TType>

Returns

void

Defined in

index.esm.d.ts:2249LegendOptions - 图12 (opens new window)


onHover

onHover(e, legendItem, legend): void

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

Parameters

NameType
eChartEvent
legendItemLegendItem
legendLegendElement<TType>

Returns

void

Defined in

index.esm.d.ts:2253LegendOptions - 图13 (opens new window)


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

NameType
eChartEvent
legendItemLegendItem
legendLegendElement<TType>

Returns

void

Defined in

index.esm.d.ts:2257LegendOptions - 图14 (opens new window)