ResultFacetsPanel class

Extends

FacetContainer

Index

Constructors

• constructor

Public Properties

• id

Protected Properties

• activeFacetIndex
• addMenu
• context
• facets
• group
• slot

Protected Accessors

• cssPrefix

Public Methods

• belongsToGroup
• clear
• destroy
• getContext
• getQuery
• getWidgetType
• init
• onProcessEnd
• onProcessStart
• refresh

Protected Methods

• 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

---

constructor

⊕ new ResultFacetsPanel(slot: HTMLElement): ResultFacetsPanel

Parameters:

• slot: HTMLElement

---

Public Properties

---

id

● id: string

---

Protected Properties

---

activeFacetIndex

● activeFacetIndex: number = -1

---

addMenu

● addMenu: PopupMenu

---

context

● context: EqContext

---

facets

● facets: ResultFacet[] = []

---

group

● group: WidgetGroup

---

slot

● slot: HTMLElement

---

Protected Accessors

---

cssPrefix

⇄ get cssPrefix(): string

Returns string

---

Public Methods

---

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

---

getQuery

▸ getQuery(): Query

Returns Query

---

getWidgetType

▸ getWidgetType(): string

Returns string

---

init

Initialize widget.

▸ init(context: EqContext,options?: ResultFacetsPanelOptions): void

Parameters:

• context: EqContext - The context.
• options: ResultFacetsPanelOptions, 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

---

attachQueryObserver

▸ attachQueryObserver(): void

Returns void

---

createAddMenu

▸ createAddMenu(): void

Returns void

---

createDefaultFacetIfNotExist

▸ createDefaultFacetIfNotExist(): void

Returns void

---

createFacetTab

▸ createFacetTab(type: FacetType): ResultFacet

Parameters:

• type: FacetType

Returns ResultFacet

---

destroyCore

▸ destroyCore(): void

Returns void

---

exportHandler

▸ exportHandler(): void

Returns void

---

getDialogService

▸ getDialogService(): DialogService

Returns DialogService

---

loadFacets

▸ loadFacets(): void

Returns void

---

maximizeHandler

▸ maximizeHandler(): void

Returns void

---

onProcessEndCore

▸ onProcessEndCore(): void

Returns void

---

onProcessStartCore

▸ onProcessStartCore(): void

Returns void

---

refreshCore

▸ refreshCore(force?: boolean): void

Parameters:

• force: boolean, Default value = false

Returns void

---

refreshHandler

▸ refreshHandler(): void

Returns void

---

removeFacet

▸ removeFacet(facet: ResultFacet): void

Parameters:

• facet: ResultFacet

Returns void

---

render

▸ render(): void

Returns void

---

renderActiveFacet

▸ renderActiveFacet(refresh?: boolean): void

Parameters:

• refresh: boolean, Default value = true

Returns void

---

renderFacet

▸ renderFacet(facet: ResultFacet): void

Parameters:

• facet: ResultFacet

Returns void

---

renderFacetBody

▸ renderFacetBody(facet: any): HTMLElement

Parameters:

• facet: any

Returns HTMLElement

---

renderFacetTab

▸ renderFacetTab(facet: ResultFacet): HTMLElement

Parameters:

• facet: ResultFacet

Returns HTMLElement

---

saveFacets

▸ saveFacets(isActivate?: boolean): void

Parameters:

• isActivate: boolean, Default value = false

Returns void

---

setActiveFacet

▸ setActiveFacet(index: number): void

Parameters:

• index: number

Returns void

---

setOptions

▸ setOptions(options?: ResultFacetsPanelOptions): void

Parameters:

• options: ResultFacetsPanelOptions, Optional

Returns void

---

updateTotalRecords

▸ updateTotalRecords(): void

Returns void

---

validateAddFacetButton

▸ validateAddFacetButton(): void

Returns void

---