Legend Item

A Legend Item records the attributes of an item that should appear in a chart legend.

Legend item consist of:

  • Item shape (e.g. rectangle or star)
  • Item line those look usually matches the line used to render series data
  • Item label used to represent series name

Properties

Property

Name

Type

Description

Series Key

seriesKey

String

Key for the series that this legend item represents.

Label

label

String

Legend item label.

Label Font

labelFont

Data Table

Font used to draw the item label.

Label Paint

labelPaint

Data Table

Paint used to draw the item label.

Tool Tip Text

toolTipText

String

Tool tip text for the legend item.

Shape Visible

shapeVisible

Boolean

Flag that controls whether or not the legend item shape should be displayed.

Shape

shape

Data Table

Shape to display as the graphic for this legend item.

Shape Filled

shapeFilled

Boolean

Flag that controls whether or not the legend item shape should be filled.

Fill Paint

fillPaint

Data Table

Paint used to draw the marker.

Shape Outline Visible

shapeOutlineVisible

Boolean

Flag that controls whether or not the legend item shape should have its outline drawn.

Outline Paint

outlinePaint

Data Table

Paint used to draw the marker outline.

Outline Stroke

outlineStroke

Data Table

Stroke used to draw the marker outline.

Line Visible

lineVisible

Boolean

Flag that controls whether or not a line is drawn as part of the legend item graphic.

Line

line

Data Table

Line, if any, to be drawn for the legend item graphic. See Shape.

Line Stroke

lineStroke

Data Table

Stroke used to draw the line for the legend item graphic.

Line Paint

linePaint

Data Table

Paint used to draw the line for the legend item graphic.

Was this page helpful?