EasyGridWidget class
Extends
Section titled “Extends”- addColumn
- addNewColumn
- belongsToGroup
- clear
- destroy
- getContext
- getModel
- getQuery
- getWidgetType
- init
- onProcessEnd
- onProcessStart
- refresh
- addColumnClickHandler
- applyDisplayFormats
- attachQueryObserver
- columnMovedHandler
- createEntitiesMenu
- destroyCore
- onProcessEndCore
- onProcessStartCore
- refreshCore
- render
- updateTotalsSettings
Constructors
Section titled “Constructors”constructor
Section titled “constructor”The default constructor.
⊕ new EasyGridWidget(slot: HTMLElement): EasyGridWidget
Parameters:
Section titled “Parameters:”- slot:
HTMLElement- The html element.
Public Properties
Section titled “Public Properties”● id: string
Protected Properties
Section titled “Protected Properties”context
Section titled “context”● context: EqContext
● group: WidgetGroup
The html element.
● slot: HTMLElement
Public Methods
Section titled “Public Methods”addColumn
Section titled “addColumn”▸ addColumn(column: QueryColumn): QueryColumn
Parameters:
Section titled “Parameters:”- column: QueryColumn
Returns QueryColumn
addNewColumn
Section titled “addNewColumn”▸ addNewColumn(attrId: string): QueryColumn
Parameters:
Section titled “Parameters:”- attrId:
string
Returns QueryColumn
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
▸ clear(): void
Returns void
destroy
Section titled “destroy”▸ destroy(): void
Returns void
getContext
Section titled “getContext”Returns current context (the one this widget belongs to)
▸ getContext(): EqContext
Returns EqContext
getModel
Section titled “getModel”▸ getModel(): DataModel
Returns DataModel
getQuery
Section titled “getQuery”▸ getQuery(): Query
Returns Query
getWidgetType
Section titled “getWidgetType”▸ getWidgetType(): string
Returns string
Initialize widget.
▸ init(context: EqContext,options?: any): void
Parameters:
Section titled “Parameters:”- context: EqContext - The context.
- options:
any, 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”addColumnClickHandler
Section titled “addColumnClickHandler”▸ addColumnClickHandler(ev: AddColumnClickEvent): void
Parameters:
Section titled “Parameters:”- ev:
AddColumnClickEvent
Returns void
applyDisplayFormats
Section titled “applyDisplayFormats”▸ applyDisplayFormats(): void
Returns void
attachQueryObserver
Section titled “attachQueryObserver”▸ attachQueryObserver(): void
Returns void
columnMovedHandler
Section titled “columnMovedHandler”▸ columnMovedHandler(ev: ColumnMovedEvent): void
Parameters:
Section titled “Parameters:”- ev:
ColumnMovedEvent
Returns void
createEntitiesMenu
Section titled “createEntitiesMenu”▸ createEntitiesMenu(): void
Returns void
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”▸ refreshCore(): void
Returns void
render
Section titled “render”▸ render(): void
Returns void
updateTotalsSettings
Section titled “updateTotalsSettings”▸ updateTotalsSettings(): void
Returns void