Skip to content

grafit-charts


Type Alias: GroupLabelOptions

GroupLabelOptions = Switchable & FontOptions & object

The rows of group names: their own font and colour over the tick labels', and their own format for the level value. enabled: false drops the rows altogether — the item labels stay, the axis stops reserving room for groups.

Type Declaration

format?

optional format?: string

Serializable format string (',.2f', '%b %Y') applied to the level value.

formatter?

optional formatter?: (params) => string

Parameters

params

GroupLabelFormatterParams

Returns

string

maxWidth?

optional maxWidth?: Pixels

Widest a group name may be, px. Without it, label.overflow: 'ellipsis' gives a name the run it stands over — enough to keep it clear of the separators on either side. Cutting uses label.ellipsis for its mark.