A component used for operating with complex filters by creating or editing conditions and grouping them using AND/OR logic. It is used internally in the Advanced Filtering of the Grid.
Constructors
Section titled "Constructors"IgcQueryBuilderComponent
new IgcQueryBuilderComponent(args: any[]): IgcQueryBuilderComponentReturns IgcQueryBuilderComponent
Properties
Section titled "Properties"tagName
Section titled "tagName"The tagName read-only property of the Element interface returns the tag name of the element on which it's called.
tagName: stringAccessors
Section titled "Accessors"disableEntityChange
Section titled "disableEntityChange"get disableEntityChange(): boolean
Returns boolean
Disables subsequent entity changes at the root level after the initial selection.
set disableEntityChange(value: boolean): voidParameters
- value:
boolean
Returns void
disableReturnFieldsChange
Section titled "disableReturnFieldsChange"get disableReturnFieldsChange(): boolean
Returns boolean
Disables return fields changes at the root level.
set disableReturnFieldsChange(value: boolean): voidParameters
- value:
boolean
Returns void
entities
Section titled "entities"get entities(): IgcEntityType[]
Returns IgcEntityType[]
Gets the list of entities available for the query builder. Each entity describes a logical group of fields that can be used in queries. An entity can optionally have child entities, allowing nested sub-queries.
set entities(value: IgcEntityType[]): voidParameters
- value:
IgcEntityType[]
Returns void
expressionTree
Section titled "expressionTree"get expressionTree(): IgcExpressionTree
Returns IgcExpressionTree
Returns the expression tree.
set expressionTree(value: IgcExpressionTree): voidParameters
- value:
IgcExpressionTree
Returns void
locale
Section titled "locale"get locale(): string
Returns string
Gets the locale of the query builder.
If not set, defaults to application's locale.
set locale(value: string): voidParameters
- value:
string
Returns void
queryBuilderHeaderCollection
Section titled "queryBuilderHeaderCollection"get queryBuilderHeaderCollection(): IgcQueryBuilderHeaderComponent[]
Returns IgcQueryBuilderHeaderComponent[]
resourceStrings
Section titled "resourceStrings"get resourceStrings(): IgcQueryBuilderResourceStrings
Returns IgcQueryBuilderResourceStrings
Sets the resource strings. By default it uses EN resources.
set resourceStrings(value: IgcQueryBuilderResourceStrings): voidParameters
Returns void
searchValueTemplate
Section titled "searchValueTemplate"get searchValueTemplate(): IgcRenderFunction<IgcQueryBuilderSearchValueContext>
Returns IgcRenderFunction<IgcQueryBuilderSearchValueContext>
Sets/gets the search value template.
set searchValueTemplate(value: IgcRenderFunction<IgcQueryBuilderSearchValueContext>): voidParameters
Returns void
showEntityChangeDialog
Section titled "showEntityChangeDialog"get showEntityChangeDialog(): boolean
Returns boolean
Gets/sets whether the confirmation dialog should be shown when changing entity.
Default value is true.
set showEntityChangeDialog(value: boolean): voidParameters
- value:
boolean
Returns void
Methods
Section titled "Methods"addEventListener
Section titled "addEventListener"Inherited from: EventEmitterMixin<IgcQueryBuilderComponentEventMap, Constructor<LitElement>>(LitElement)
addEventListener(type: K, listener: object, options: boolean | AddEventListenerOptions): voidParameters
- type:
K - listener:
object - options:
boolean | AddEventListenerOptions
Returns void
canCommit
Section titled "canCommit"Returns whether the expression tree can be committed in the current state.
canCommit(): booleanReturns boolean
commit
Section titled "commit"Commits the expression tree in the current state if it is valid. If not throws an exception.
commit(): voidReturns void
discard
Section titled "discard"Discards all unsaved changes to the expression tree.
discard(): voidReturns void
removeEventListener
Section titled "removeEventListener"Inherited from: EventEmitterMixin<IgcQueryBuilderComponentEventMap, Constructor<LitElement>>(LitElement)
removeEventListener(type: K, listener: object, options: boolean | EventListenerOptions): voidParameters
- type:
K - listener:
object - options:
boolean | EventListenerOptions
Returns void
register
Section titled "register"register(): voidReturns void
Events
Section titled "Events"expressionTreeChange
Section titled "expressionTreeChange"Event fired as the expression tree is changed.
expressionTreeChange: CustomEvent<IgcExpressionTree>