QueryPanel class
The query panel wiget, implemented without JQuery.
Extends
Section titled “Extends”- belongsToGroup
- destroy
- getAddRowRenderer
- getConditionGroupMenu
- getConditionMenu
- getConditionRenderer
- getContext
- getEntitiesMenu
- getExpressionRenderer
- getLinkTypeMenu
- getOperatorRenderer
- getQuery
- getWidgetType
- init
- onProcessEnd
- onProcessStart
- refresh
- showEntitiesMenu
- toggleConditionPicked
Constructors
Section titled “Constructors”constructor
Section titled “constructor”The default constructor.
⊕ new QueryPanel(slot: HTMLElement,customQuery?: Query): QueryPanel
Parameters:
Section titled “Parameters:”-
slot:
HTMLElement- The html element. -
customQuery: Query, Optional
Public Properties
Section titled “Public Properties”● id: string
Protected Properties
Section titled “Protected Properties”context
Section titled “context”● context: EqContext
● 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
destroy
Section titled “destroy”▸ destroy(): void
Returns void
getAddRowRenderer
Section titled “getAddRowRenderer”▸ getAddRowRenderer(slot?: HTMLDivElement): BaseElementRenderer | null
Parameters:
Section titled “Parameters:”- slot:
HTMLDivElement, Optional
Returns BaseElementRenderer | null
getConditionGroupMenu
Section titled “getConditionGroupMenu”▸ getConditionGroupMenu(isRoot?: boolean): PopupMenu
Parameters:
Section titled “Parameters:”- isRoot:
boolean, Default value =false
Returns PopupMenu
getConditionMenu
Section titled “getConditionMenu”▸ getConditionMenu(): PopupMenu
Returns PopupMenu
getConditionRenderer
Section titled “getConditionRenderer”▸ getConditionRenderer(condition: Condition,slot?: HTMLDivElement): ConditionRenderer | null
Parameters:
Section titled “Parameters:”- condition: Condition
- slot:
HTMLDivElement, Optional
Returns ConditionRenderer | null
getContext
Section titled “getContext”Returns current context (the one this widget belongs to)
▸ getContext(): EqContext
Returns EqContext
getEntitiesMenu
Section titled “getEntitiesMenu”▸ getEntitiesMenu(): PopupMenu
Returns PopupMenu
getExpressionRenderer
Section titled “getExpressionRenderer”▸ getExpressionRenderer(expression: Expression,slot?: HTMLDivElement): ExpressionRenderer | null
Parameters:
Section titled “Parameters:”- expression: Expression
- slot:
HTMLDivElement, Optional
Returns ExpressionRenderer | null
getLinkTypeMenu
Section titled “getLinkTypeMenu”▸ getLinkTypeMenu(): PopupMenu
Returns PopupMenu
getOperatorRenderer
Section titled “getOperatorRenderer”▸ getOperatorRenderer(condition: Condition,text: string,slot?: HTMLDivElement): BaseElementRenderer | null
Parameters:
Section titled “Parameters:”- condition: Condition
- text:
string - slot:
HTMLDivElement, Optional
Returns BaseElementRenderer | null
getQuery
Section titled “getQuery”▸ getQuery(): Query
Returns Query
getWidgetType
Section titled “getWidgetType”▸ getWidgetType(): string
Returns string
Initialize widget.
▸ init(context: EqContext,options?: QueryPanelOptions): void
Parameters:
Section titled “Parameters:”- context: EqContext - The context.
- options: QueryPanelOptions, 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
showEntitiesMenu
Section titled “showEntitiesMenu”▸ showEntitiesMenu(options: PopupMenuOptions): void
Parameters:
Section titled “Parameters:”- options: PopupMenuOptions
Returns void
toggleConditionPicked
Section titled “toggleConditionPicked”▸ toggleConditionPicked(condition: Condition,force?: boolean): void
Parameters:
Section titled “Parameters:”- condition: Condition
- force:
boolean, Default value =undefined
Returns void
Protected Methods
Section titled “Protected Methods”▸ clear(): void
Returns void
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”▸ refreshCore(): void
Returns void
render
Section titled “render”▸ render(): void
Returns void
setOptions
Section titled “setOptions”▸ setOptions(options?: QueryPanelOptions): void
Parameters:
Section titled “Parameters:”- options: QueryPanelOptions, Optional
Returns void