SortingBar class
Extends
Section titled “Extends”- addColumn
- addNewColumn
- belongsToGroup
- destroy
- getContext
- getWidgetType
- init
- onProcessEnd
- onProcessStart
- refresh
- showEntitiesMenu
Constructors
Section titled “Constructors”constructor
Section titled “constructor”⊕ new SortingBar(slot: HTMLElement): SortingBar
Parameters:
Section titled “Parameters:”- slot:
HTMLElement
Public Properties
Section titled “Public Properties”● id: string
sortMenu
Section titled “sortMenu”● sortMenu: PopupMenu
Protected Properties
Section titled “Protected Properties”context
Section titled “context”● context: EqContext
● group: WidgetGroup
● slot: HTMLElement
Protected Accessors
Section titled “Protected Accessors”cssPrefix
Section titled “cssPrefix”⇄ get cssPrefix(): string
Returns string
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
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
getWidgetType
Section titled “getWidgetType”▸ getWidgetType(): string
Returns string
▸ init(context: EqContext,options?: SortingBarOptions): void
Parameters:
Section titled “Parameters:”- context: EqContext
- options: SortingBarOptions, Optional
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
showEntitiesMenu
Section titled “showEntitiesMenu”▸ showEntitiesMenu(menuOptions: any): void
Parameters:
Section titled “Parameters:”- menuOptions:
any
Returns void
Protected Methods
Section titled “Protected Methods”destroyCore
Section titled “destroyCore”▸ destroyCore(): void
Returns void
getQuery
Section titled “getQuery”▸ getQuery(): Query
Returns Query
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