@kanunilabs/pivotgrid-enterprise
@kanunilabs/pivotgrid-enterprise / ChartPanelHandle
Interface: ChartPanelHandle
Properties
element
element:
HTMLElement
Methods
applyReportPart()
applyReportPart(
value):void
Restore it — the windows it lists are what is open afterwards.
Parameters
value
unknown
Returns
void
close()
close():
void
Returns
void
destroy()
destroy():
void
Returns
void
download()
download(
request?):Promise<boolean>
Download the drawn chart; false while closed or empty.
Parameters
request?
ChartImageRequest
Returns
Promise<boolean>
getFormat()
getFormat():
ChartFormat
Returns
ChartFormat
getImageDataUrl()
getImageDataUrl(
request?):Promise<string|null>
The drawn chart as a data: URL (PNG unless asked); null while closed or empty.
Parameters
request?
ChartImageRequest
Returns
Promise<string | null>
getReportPart()
getReportPart():
PivotChartReportPart
The saved report's part: the panel's state and its windows.
Returns
PivotChartReportPart
getStacking()
getStacking():
ChartStacking
Returns
ChartStacking
getState()
getState():
PivotChartState
The panel as data: open, type, stacking, format, the series hidden in the legend.
Returns
PivotChartState
getType()
getType():
PivotChartType
Returns
getWindows()
getWindows():
PivotChartWindow[]
The extra windows open now, oldest first.
Returns
isOpen()
isOpen():
boolean
Returns
boolean
open()
open():
void
Returns
void
openWindow()
openWindow(
seed?):PivotChartWindow
Open a copy of the chart in a window of its own, with the seed applied
(a floating rectangle in the seed places it exactly).
Parameters
seed?
Partial<PivotChartState>
Returns
setCrossFilterLabel()
setCrossFilterLabel(
label):void
Show (a label) or hide (null) the note that the pivot is filtered by a chart click.
Parameters
label
string | null
Returns
void
setFormat()
setFormat(
format):void
Parameters
format
ChartFormat
Returns
void
setI18n()
setI18n(
i18n):void
Parameters
i18n
ResolvedI18n
Returns
void
setStacking()
setStacking(
stacking):void
Parameters
stacking
ChartStacking
Returns
void
setState()
setState(
state):void
Restore getState's snapshot (another version is ignored; an unknown type keeps the current one).
Parameters
state
PivotChartState
Returns
void
setType()
setType(
type):void
Parameters
type
Returns
void
toggle()
toggle():
void
Returns
void
update()
update(
result):void
Parameters
result
ChartTransformResult | null
Returns
void