FacetContainer class
Extends
Section titled “Extends”- belongsToGroup
- clear
- destroy
- getContext
- getQuery
- getWidgetType
- init
- onProcessEnd
- onProcessStart
- refresh
Constructors
Section titled “Constructors”constructor
Section titled “constructor”⊕ new FacetContainer(slot: HTMLElement): FacetContainer
Parameters:
Section titled “Parameters:”- slot:
HTMLElement
Public Properties
Section titled “Public Properties”● id: string
options
Section titled “options”● options: any
Protected Properties
Section titled “Protected Properties”context
Section titled “context”● context: EqContext
facets
Section titled “facets”● facets: ResultFacet[] = []
● group: WidgetGroup
● slot: HTMLElement
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
▸ clear(): any
Returns any
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
getQuery
Section titled “getQuery”▸ getQuery(): Query
Returns Query
getWidgetType
Section titled “getWidgetType”▸ getWidgetType(): string
Returns string
Initializes the widget and assign it to some context
▸ init(context: EqContext,options?: any): void
Parameters:
Section titled “Parameters:”- context: EqContext
- options:
any, 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
Protected Methods
Section titled “Protected Methods”createFacetTab
Section titled “createFacetTab”▸ createFacetTab(type: FacetType): ResultFacet
Parameters:
Section titled “Parameters:”- type: FacetType
Returns ResultFacet
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”This function is called from refresh 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
▸ refreshCore(): void
Returns void