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: stringdisableEntityChange
Section titled "disableEntityChange"disableEntityChange: booleandisableReturnFieldsChange
Section titled "disableReturnFieldsChange"disableReturnFieldsChange: booleanentities
Section titled "entities"entities: IgcEntityType[]expressionTree
Section titled "expressionTree"expressionTree: IgcExpressionTreelocale
Section titled "locale"locale: stringresourceStrings
Section titled "resourceStrings"resourceStrings: IgcQueryBuilderResourceStringssearchValueTemplate
Section titled "searchValueTemplate"searchValueTemplate: IgcRenderFunction<IgcQueryBuilderSearchValueContext>showEntityChangeDialog
Section titled "showEntityChangeDialog"showEntityChangeDialog: booleanAccessors
Section titled "Accessors"queryBuilderHeaderCollection
Section titled "queryBuilderHeaderCollection"get queryBuilderHeaderCollection(): IgcQueryBuilderHeaderComponent[]Returns IgcQueryBuilderHeaderComponent[]
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.
<igx-query-builder (expressionTreeChange)='onExpressionTreeChange()'></igx-query-builder>expressionTreeChange: CustomEvent<IgcExpressionTree>Example
<igx-query-builder [entities]="this.entities">
</igx-query-builder>