ResultFacetsPanel class
Extends
Section titled “Extends”- belongsToGroup
- clear
- destroy
- getContext
- getQuery
- getWidgetType
- init
- onProcessEnd
- onProcessStart
- refresh
- attachQueryObserver
- createAddMenu
- createDefaultFacetIfNotExist
- createFacetTab
- destroyCore
- exportHandler
- getDialogService
- loadFacets
- maximizeHandler
- onProcessEndCore
- onProcessStartCore
- refreshCore
- refreshHandler
- removeFacet
- render
- renderActiveFacet
- renderFacet
- renderFacetBody
- renderFacetTab
- saveFacets
- setActiveFacet
- setOptions
- updateTotalRecords
- validateAddFacetButton
Constructors
Section titled “Constructors”constructor
Section titled “constructor”⊕ new ResultFacetsPanel(slot: HTMLElement): ResultFacetsPanel
Parameters:
Section titled “Parameters:”- slot:
HTMLElement
Public Properties
Section titled “Public Properties”● id: string
Protected Properties
Section titled “Protected Properties”activeFacetIndex
Section titled “activeFacetIndex”● activeFacetIndex: number = -1
addMenu
Section titled “addMenu”● addMenu: PopupMenu
context
Section titled “context”● context: EqContext
facets
Section titled “facets”● facets: ResultFacet[] = []
● 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”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
getQuery
Section titled “getQuery”▸ getQuery(): Query
Returns Query
getWidgetType
Section titled “getWidgetType”▸ getWidgetType(): string
Returns string
Initialize widget.
▸ init(context: EqContext,options?: ResultFacetsPanelOptions): void
Parameters:
Section titled “Parameters:”- context: EqContext - The context.
- options: ResultFacetsPanelOptions, 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”attachQueryObserver
Section titled “attachQueryObserver”▸ attachQueryObserver(): void
Returns void
createAddMenu
Section titled “createAddMenu”▸ createAddMenu(): void
Returns void
createDefaultFacetIfNotExist
Section titled “createDefaultFacetIfNotExist”▸ createDefaultFacetIfNotExist(): void
Returns void
createFacetTab
Section titled “createFacetTab”▸ createFacetTab(type: FacetType): ResultFacet
Parameters:
Section titled “Parameters:”- type: FacetType
Returns ResultFacet
destroyCore
Section titled “destroyCore”▸ destroyCore(): void
Returns void
exportHandler
Section titled “exportHandler”▸ exportHandler(): void
Returns void
getDialogService
Section titled “getDialogService”▸ getDialogService(): DialogService
Returns DialogService
loadFacets
Section titled “loadFacets”▸ loadFacets(): void
Returns void
maximizeHandler
Section titled “maximizeHandler”▸ maximizeHandler(): void
Returns void
onProcessEndCore
Section titled “onProcessEndCore”▸ onProcessEndCore(): void
Returns void
onProcessStartCore
Section titled “onProcessStartCore”▸ onProcessStartCore(): void
Returns void
refreshCore
Section titled “refreshCore”▸ refreshCore(force?: boolean): void
Parameters:
Section titled “Parameters:”- force:
boolean, Default value =false
Returns void
refreshHandler
Section titled “refreshHandler”▸ refreshHandler(): void
Returns void
removeFacet
Section titled “removeFacet”▸ removeFacet(facet: ResultFacet): void
Parameters:
Section titled “Parameters:”- facet: ResultFacet
Returns void
render
Section titled “render”▸ render(): void
Returns void
renderActiveFacet
Section titled “renderActiveFacet”▸ renderActiveFacet(refresh?: boolean): void
Parameters:
Section titled “Parameters:”- refresh:
boolean, Default value =true
Returns void
renderFacet
Section titled “renderFacet”▸ renderFacet(facet: ResultFacet): void
Parameters:
Section titled “Parameters:”- facet: ResultFacet
Returns void
renderFacetBody
Section titled “renderFacetBody”▸ renderFacetBody(facet: any): HTMLElement
Parameters:
Section titled “Parameters:”- facet:
any
Returns HTMLElement
renderFacetTab
Section titled “renderFacetTab”▸ renderFacetTab(facet: ResultFacet): HTMLElement
Parameters:
Section titled “Parameters:”- facet: ResultFacet
Returns HTMLElement
saveFacets
Section titled “saveFacets”▸ saveFacets(isActivate?: boolean): void
Parameters:
Section titled “Parameters:”- isActivate:
boolean, Default value =false
Returns void
setActiveFacet
Section titled “setActiveFacet”▸ setActiveFacet(index: number): void
Parameters:
Section titled “Parameters:”- index:
number
Returns void
setOptions
Section titled “setOptions”▸ setOptions(options?: ResultFacetsPanelOptions): void
Parameters:
Section titled “Parameters:”- options: ResultFacetsPanelOptions, Optional
Returns void
updateTotalRecords
Section titled “updateTotalRecords”▸ updateTotalRecords(): void
Returns void
validateAddFacetButton
Section titled “validateAddFacetButton”▸ validateAddFacetButton(): void
Returns void