# Interface: LegendItem

# Properties

# borderRadius

• Optional borderRadius: number | BorderRadius

Border radius of the legend box

Since

3.1.0

# Defined in

types/index.d.ts:2274 (opens new window)


# datasetIndex

• Optional datasetIndex: number

Index of the associated dataset

# Defined in

types/index.d.ts:2279 (opens new window)


# fillStyle

• Optional fillStyle: Color

Fill style of the legend box

# Defined in

types/index.d.ts:2289 (opens new window)


# fontColor

• Optional fontColor: Color

Font color for the text Defaults to LegendOptions.labels.color

# Defined in

types/index.d.ts:2295 (opens new window)


# hidden

• Optional hidden: boolean

If true, this item represents a hidden dataset. Label will be rendered with a strike-through effect

# Defined in

types/index.d.ts:2300 (opens new window)


# index

• Optional index: number

Index the associated label in the labels array

# Defined in

types/index.d.ts:2284 (opens new window)


# lineCap

• Optional lineCap: CanvasLineCap

For box border.

See

https://developer.mozilla.org/en/docs/Web/API/CanvasRenderingContext2D/lineCap

# Defined in

types/index.d.ts:2306 (opens new window)


# lineDash

• Optional lineDash: number[]

For box border.

See

https://developer.mozilla.org/en-US/docs/Web/API/CanvasRenderingContext2D/setLineDash

# Defined in

types/index.d.ts:2312 (opens new window)


# lineDashOffset

• Optional lineDashOffset: number

For box border.

See

https://developer.mozilla.org/en-US/docs/Web/API/CanvasRenderingContext2D/lineDashOffset

# Defined in

types/index.d.ts:2318 (opens new window)


# lineJoin

• Optional lineJoin: CanvasLineJoin

For box border.

See

https://developer.mozilla.org/en-US/docs/Web/API/CanvasRenderingContext2D/lineJoin

# Defined in

types/index.d.ts:2324 (opens new window)


# lineWidth

• Optional lineWidth: number

Width of box border

# Defined in

types/index.d.ts:2329 (opens new window)


# pointStyle

• Optional pointStyle: PointStyle

Point style of the legend box (only used if usePointStyle is true)

# Defined in

types/index.d.ts:2339 (opens new window)


# rotation

• Optional rotation: number

Rotation of the point in degrees (only used if usePointStyle is true)

# Defined in

types/index.d.ts:2344 (opens new window)


# strokeStyle

• Optional strokeStyle: Color

Stroke style of the legend box

# Defined in

types/index.d.ts:2334 (opens new window)


# text

• text: string

Label that will be displayed

# Defined in

types/index.d.ts:2268 (opens new window)


# textAlign

• Optional textAlign: TextAlign

Text alignment

# Defined in

types/index.d.ts:2349 (opens new window)