Documentation

@kanunilabs/pivotgrid-enterprise


@kanunilabs/pivotgrid-enterprise / ChartRenderContext

Interface: ChartRenderContext

Properties

blankLabel

blankLabel: string

What an empty category value is called, in the reader's language.


countLabel?

optional countLabel?: string

A histogram's value axis title when the format names none ("Count"), in the reader's language.


format?

optional format?: ChartFormat

Axis titles and data labels (the panel draws the title and the legend).


formatSeriesValue?

optional formatSeriesValue?: (seriesIndex, value) => string

Series i's value as its data field prints it. Defaults to the locale's number format.

Parameters

seriesIndex

number

value

number

Returns

string


hidden

hidden: Set<number>

Series indices the legend has switched off.


histogramBins?

optional histogramBins?: number

About how many bars a histogram cuts its values into. Default 10.


locale

locale: string


palette?

optional palette?: readonly string[]

Colours for what is coloured by CATEGORY — pie slices, treemap cells — when the panel derives them (the theme's ramp, or the app's list). Series colours travel on the model. Default: the packaged eight.


percentAxis?

optional percentAxis?: boolean

Every measure is in a percent display mode (% of total…): the value axis reads in %.


rtl

rtl: boolean


size

size: object

height

height: number

width

width: number


stacking?

optional stacking?: ChartStacking

Grouped (default), stacked, or 100% stacked — honoured by column, bar, line and area. A stack keeps every series on one axis.


totalLabel?

optional totalLabel?: string

Caption of the waterfall's closing bar, in the reader's language.