Skip to content

Legend Entry

Draws a single legend item — a coloured shape with a label — outside of a chart.

Chart components · element type legend-entry · binds through text templates in the label

Related: Pie Chart · Generic Chart

Options

Configure the component with these options:

Option Default Description
Name Empty The series name this entry represents. Also the text shown, unless overridden
ShowText On Whether the label is drawn next to the shape
Display Text Override Empty Text to show instead of Name, when the label should read differently from the series
Color Map From theme The colour scheme the shape draws from, so entries match their chart

Appearance options live in the Style section:

Option Default Description
Shape Default Marker shape: Circle, Square, Triangle, or Default
Shape Size From theme Size of the marker. Accepts any CSS unit
Gap From theme Space between the shape and its label
Shape Alignment From theme Vertical position of the shape relative to the text

Label text uses the standard styling options — Font Size, Text Color, Font Weight, Margin and Padding.

Notes

  • Keep Color Map the same as the chart's, or the markers will not match the series they describe
  • Turn ShowText off for a shape-only marker, for example inside a narrow table column
  • Use Display Text Override when the series name is a database value rather than something a reader should see