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