ChartLegendEntry | React Json Chart Builder

The ChartLegendEntry defines a single entry in the legend.

Hierarchy

ChartLegendEntry

Indexable

[key: string]: string | number

The rest prop is used to pass any other props to the legend entry. This prop will not overwrite the custom functionality added by the library.

Index

Properties

childName
name
tooltipText

Properties

Optional childName

childName?: string

The childName prop defines the name of the connected serie. This is used in the interactive legend to reference the correct series when the legend is clicked.

see: ChartLegendProps
see: ChartDataSerie

name

name: string

The name prop defines the displayed name for the entry.

Optional tooltipText

tooltipText?: string

The tooltipText prop defines the tooltip when hoverin over the legend entry. If not defined the default tootilp is the name.

It is advised to add the name to the tooltip when not wrapping the legend. Otherwise the name could be too long to display and the users will have no way to read it in the whole length.