Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface LegendItem

Hierarchy

  • LegendItem

Index

Properties

Optional borderRadius

borderRadius?: number | BorderRadius

Border radius of the legend box

since

3.1.0

Optional datasetIndex

datasetIndex?: number

Index of the associated dataset

Optional fillStyle

fillStyle?: CHARTJS.Color

Fill style of the legend box

Optional fontColor

fontColor?: CHARTJS.Color

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

Optional hidden

hidden?: boolean

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

Optional lineCap

lineCap?: CanvasLineCap

Optional lineDash

lineDash?: number[]

Optional lineDashOffset

lineDashOffset?: number

Optional lineJoin

lineJoin?: CanvasLineJoin

Optional lineWidth

lineWidth?: number

Width of box border

Optional pointStyle

pointStyle?: PointStyle

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

Optional rotation

rotation?: number

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

Optional strokeStyle

strokeStyle?: CHARTJS.Color

Stroke style of the legend box

Optional text

text?: string

Label that will be displayed

Optional textAlign

textAlign?: TextAlign

Text alignment

Generated using TypeDoc