QueryPanel class

The query panel wiget, implemented without JQuery.

Extends

Widget

Index

Constructors

• constructor

Public Properties

• id

Protected Properties

• context
• group
• slot

Protected Accessors

• cssPrefix

Public Methods

• belongsToGroup
• destroy
• getAddRowRenderer
• getConditionGroupMenu
• getConditionMenu
• getConditionRenderer
• getContext
• getEntitiesMenu
• getExpressionRenderer
• getLinkTypeMenu
• getOperatorRenderer
• getQuery
• getWidgetType
• init
• onProcessEnd
• onProcessStart
• refresh
• showEntitiesMenu
• toggleConditionPicked

Protected Methods

• clear
• destroyCore
• onProcessEndCore
• onProcessStartCore
• refreshCore
• render
• setOptions

Constructors

---

constructor

The default constructor. ⊕ new QueryPanel(slot: HTMLElement,customQuery?: Query): QueryPanel

Parameters:

• slot: HTMLElement - The html element.

• customQuery: Query, Optional

---

Public Properties

---

id

● id: string

---

Protected Properties

---

context

● context: EqContext

---

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

---

destroy

▸ destroy(): void

Returns void

---

getAddRowRenderer

▸ getAddRowRenderer(slot?: HTMLDivElement): BaseElementRenderer | null

Parameters:

• slot: HTMLDivElement, Optional

Returns BaseElementRenderer | null

---

getConditionGroupMenu

▸ getConditionGroupMenu(isRoot?: boolean): PopupMenu

Parameters:

• isRoot: boolean, Default value = false

Returns PopupMenu

---

getConditionMenu

▸ getConditionMenu(): PopupMenu

Returns PopupMenu

---

getConditionRenderer

▸ getConditionRenderer(condition: Condition,slot?: HTMLDivElement): ConditionRenderer | null

Parameters:

• condition: Condition
• slot: HTMLDivElement, Optional

Returns ConditionRenderer | null

---

getContext

Returns current context (the one this widget belongs to)

▸ getContext(): EqContext

Returns EqContext

---

getEntitiesMenu

▸ getEntitiesMenu(): PopupMenu

Returns PopupMenu

---

getExpressionRenderer

▸ getExpressionRenderer(expression: Expression,slot?: HTMLDivElement): ExpressionRenderer | null

Parameters:

• expression: Expression
• slot: HTMLDivElement, Optional

Returns ExpressionRenderer | null

---

getLinkTypeMenu

▸ getLinkTypeMenu(): PopupMenu

Returns PopupMenu

---

getOperatorRenderer

▸ getOperatorRenderer(condition: Condition,text: string,slot?: HTMLDivElement): BaseElementRenderer | null

Parameters:

• condition: Condition
• text: string
• slot: HTMLDivElement, Optional

Returns BaseElementRenderer | null

---

getQuery

▸ getQuery(): Query

Returns Query

---

getWidgetType

▸ getWidgetType(): string

Returns string

---

init

Initialize widget.

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

Parameters:

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

---

showEntitiesMenu

▸ showEntitiesMenu(options: PopupMenuOptions): void

Parameters:

• options: PopupMenuOptions

Returns void

---

toggleConditionPicked

▸ toggleConditionPicked(condition: Condition,force?: boolean): void

Parameters:

• condition: Condition
• force: boolean, Default value = undefined

Returns void

---

Protected Methods

---

clear

▸ clear(): void

Returns void

---

destroyCore

▸ destroyCore(): void

Returns void

---

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

---

render

▸ render(): void

Returns void

---

setOptions

▸ setOptions(options?: QueryPanelOptions): void

Parameters:

• options: QueryPanelOptions, Optional

Returns void

---