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