# Interface: LegendItem

# Properties

# borderRadius

Optional borderRadius: number | BorderRadius

Border radius of the legend box

Since

3.1.0

# Defined in

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


# datasetIndex

Optional datasetIndex: number

Index of the associated dataset

# Defined in

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


# fillStyle

Optional fillStyle: Color

Fill style of the legend box

# Defined in

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


# fontColor

Optional fontColor: Color

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

# Defined in

types/index.d.ts:2142 (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:2147 (opens new window)


# index

Optional index: number

Index the associated label in the labels array

# Defined in

types/index.d.ts:2131 (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:2153 (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:2159 (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:2165 (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:2171 (opens new window)


# lineWidth

Optional lineWidth: number

Width of box border

# Defined in

types/index.d.ts:2176 (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:2186 (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:2191 (opens new window)


# strokeStyle

Optional strokeStyle: Color

Stroke style of the legend box

# Defined in

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


# text

text: string

Label that will be displayed

# Defined in

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


# textAlign

Optional textAlign: TextAlign

Text alignment

# Defined in

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