EasyChartWidget class
The widget responsed for rendering EasyChart
Extends
Section titled “Extends”- belongsToGroup
- clear
- destroy
- drawChart
- getContext
- hasColumnsForChart
- hasData
- init
- initSettingsDiv
- onProcessEnd
- onProcessStart
- prepareChartData
- refresh
- setChartProvider
- toggleSettings
Constructors
Section titled “Constructors”constructor
Section titled “constructor”The default constructor.
⊕ new EasyChartWidget(slot: HTMLElement,provider?: ChartProvider): EasyChartWidget
Parameters:
Section titled “Parameters:”- slot:
HTMLElement- The html element. - provider: ChartProvider, Optional - The provider.
Public Properties
Section titled “Public Properties”widgetType
Section titled “widgetType”● widgetType: string
Protected Properties
Section titled “Protected Properties”context
Section titled “context”● context: EqContext
● group: WidgetGroup
● slot: HTMLElement
Public Methods
Section titled “Public Methods”belongsToGroup
Section titled “belongsToGroup”Returns true if the widget belongs to one of the groups specified in the parameter
▸ belongsToGroup(groups?: WidgetGroup): boolean
Parameters:
Section titled “Parameters:”- groups: WidgetGroup, Optional -
Returns boolean
Clears chart.
▸ clear(): void
Returns void
destroy
Section titled “destroy”▸ destroy(): void
Returns void
drawChart
Section titled “drawChart”Draws chart with delay.
▸ drawChart(delay: number): void
Parameters:
Section titled “Parameters:”- delay:
number- The delay.
Returns void
getContext
Section titled “getContext”Returns current context (the one this widget belongs to)
▸ getContext(): EqContext
Returns EqContext
hasColumnsForChart
Section titled “hasColumnsForChart”Checks, if there ara colums for chart
▸ hasColumnsForChart(): boolean
Returns boolean - true if there are columns, otherwise - false.
hasData
Section titled “hasData”Checks, if widget has data.
▸ hasData(): boolean
Returns boolean - true if has data, otherwise - false.
Initialize widget.
▸ init(context: EqContext,options?: ChartPanelOptions): void
Parameters:
Section titled “Parameters:”- context: EqContext - The context.
- options: ChartPanelOptions, Optional - The options.
Returns void
initSettingsDiv
Section titled “initSettingsDiv”Inititialize settings div.
▸ initSettingsDiv(): void
Returns void
onProcessEnd
Section titled “onProcessEnd”This function is called on the end of some process this widget participates in. For example, some widgets should be updated on model loading or after the execution of the current query
▸ onProcessEnd(): void
Returns void
onProcessStart
Section titled “onProcessStart”This function is called on the start of some process this widget participates in. For example, some widgets can show a spinner or a progress bar at the beginning of some long process (e.g. model loading).
▸ onProcessStart(): void
Returns void
prepareChartData
Section titled “prepareChartData”Prepares data for chart.
▸ prepareChartData(): void
Returns void
refresh
Section titled “refresh”Refreshes the widget’s content
▸ refresh(): void
Returns void
setChartProvider
Section titled “setChartProvider”Sets chart provider.
▸ setChartProvider(provider: ChartProvider): void
Parameters:
Section titled “Parameters:”- provider: ChartProvider - The provider.
Returns void
toggleSettings
Section titled “toggleSettings”Toggles settings.
▸ toggleSettings(callback?: () => void): void
Parameters:
Section titled “Parameters:”- callback: () =>
void, Optional - The callback.
Returns void
Protected Methods
Section titled “Protected Methods”destroyCore
Section titled “destroyCore”▸ destroyCore(): void
Returns void
onProcessEndCore
Section titled “onProcessEndCore”This function is called from onProcessEnd function.
It does nothing in the base Widget class
but can be overridden in derived classes
to implement the functionality specific for a particular widget.
▸ onProcessEndCore(): void
Returns void
onProcessStartCore
Section titled “onProcessStartCore”This function is called from onProcessStart function.
It does nothing in the base Widget class
but can be overridden in derived classes
to implement the functionality specific for a particular widget.
▸ onProcessStartCore(): void
Returns void
refreshCore
Section titled “refreshCore”Refresh widget implementation
▸ refreshCore(): void
Returns void