EqResultGrid class
The widget responsed for rendering GRID.
Extends
Section titled “Extends”- beforeTableRendering
- context
- formatColumnHeader
- formatGridCell
- group
- maxButtonCount
- pageItemCssClass
- slot
- tableClass
Constructors
Section titled “Constructors”constructor
Section titled “constructor”The default constructor.
⊕ new EqResultGrid(slot: HTMLElement): EqResultGrid
Parameters:
Section titled “Parameters:”- slot:
HTMLElement- The html element.
Public Properties
Section titled “Public Properties”widgetType
Section titled “widgetType”● widgetType: string
Protected Properties
Section titled “Protected Properties”beforeTableRendering
Section titled “beforeTableRendering”Function called before rendering
● beforeTableRendering: (dataTable: EqDataTable) => void
context
Section titled “context”● context: EqContext
formatColumnHeader
Section titled “formatColumnHeader”Function thart formats column header
● formatColumnHeader: (dataTable: EqDataTable, index: number, colLabel: string) => string
formatGridCell
Section titled “formatGridCell”Function thart formats cell
● formatGridCell: (dataTable: EqDataTable, i: number, j: number, value: string) => string
● group: WidgetGroup
maxButtonCount
Section titled “maxButtonCount”Max count of buttons
● maxButtonCount?: number
pageItemCssClass
Section titled “pageItemCssClass”pageItem css class
● pageItemCssClass: string
The html element.
● slot: HTMLElement
tableClass
Section titled “tableClass”table class
● tableClass?: string
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
getContext
Section titled “getContext”Returns current context (the one this widget belongs to)
▸ getContext(): EqContext
Returns EqContext
Initialize widget.
▸ init(context: EqContext,options?: GridOptions): void
Parameters:
Section titled “Parameters:”- context: EqContext - The context.
- options: GridOptions, Optional - The options.
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
refresh
Section titled “refresh”Refreshes the widget’s content
▸ refresh(): void
Returns void
Protected Methods
Section titled “Protected Methods”Clears GRID.
▸ clear(): 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
render
Section titled “render”Renders widget
▸ render(): void
Returns void
renderPageNavigator
Section titled “renderPageNavigator”Renders page navidator
▸ renderPageNavigator(): void
Returns void