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.
Properties
Section titled "Properties"disableEntityChange
Section titled "disableEntityChange"Disables subsequent entity changes at the root level after the initial selection.
disableEntityChange: booleandisableReturnFieldsChange
Section titled "disableReturnFieldsChange"Disables return fields changes at the root level.
disableReturnFieldsChange: booleanentities
Section titled "entities"Gets the list of entities available for the QueryBuilderComponent.
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.
entities: IgrEntityType[]expressionTree
Section titled "expressionTree"Returns the expression tree.
expressionTree: IgrExpressionTreelocale
Section titled "locale"Gets the locale of the query builder.
If not set, defaults to application's locale.
locale: stringqueryBuilderHeaderCollection
Section titled "queryBuilderHeaderCollection"queryBuilderHeaderCollection: IgrQueryBuilderHeaderComponent[]resourceStrings
Section titled "resourceStrings"Sets the resource strings. By default it uses EN resources.
resourceStrings: IgrQueryBuilderResourceStringssearchValueTemplate
Section titled "searchValueTemplate"Sets/gets the search value template.
searchValueTemplate: (ctx: IgrQueryBuilderSearchValueContext) => React.ReactNodeshowEntityChangeDialog
Section titled "showEntityChangeDialog"Gets/sets whether the confirmation dialog should be shown when changing entity.
Default value is true.
showEntityChangeDialog: booleanMethods
Section titled "Methods"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
Events
Section titled "Events"onExpressionTreeChange
Section titled "onExpressionTreeChange"onExpressionTreeChange(args: CustomEvent<IgrExpressionTree>): voidParameters
- args:
CustomEvent<IgrExpressionTree>