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.

Example

<igx-query-builder [entities]="this.entities">
</igx-query-builder>

Constructors

Section titled "Constructors"

IgxQueryBuilderComponent

new IgxQueryBuilderComponent(): IgxQueryBuilderComponent

Defined in projects/igniteui-angular/query-builder/src/query-builder/query-builder.component.ts:251

Returns IgxQueryBuilderComponent

Properties

Section titled "Properties"

disableEntityChange

Section titled "disableEntityChange"

Disables subsequent entity changes at the root level after the initial selection.

 
disableEntityChange: boolean = false

Defined in projects/igniteui-angular/query-builder/src/query-builder/query-builder.component.ts:188

disableReturnFieldsChange

Section titled "disableReturnFieldsChange"

Disables return fields changes at the root level.

 
disableReturnFieldsChange: boolean = false

Defined in projects/igniteui-angular/query-builder/src/query-builder/query-builder.component.ts:206

expressionTreeChange

Section titled "expressionTreeChange"

Event fired as the expression tree is changed.

<igx-query-builder (expressionTreeChange)='onExpressionTreeChange()'></igx-query-builder>
expressionTreeChange: EventEmitter<IExpressionTree>

Defined in projects/igniteui-angular/query-builder/src/query-builder/query-builder.component.ts:216

locale

Section titled "locale"

Gets the locale of the query builder. If not set, defaults to application's locale.

 
locale: string

Defined in projects/igniteui-angular/query-builder/src/query-builder/query-builder.component.ts:166

showEntityChangeDialog

Section titled "showEntityChangeDialog"

Gets/sets whether the confirmation dialog should be shown when changing entity. Default value is true.

 
showEntityChangeDialog: boolean = true

Defined in projects/igniteui-angular/query-builder/src/query-builder/query-builder.component.ts:61

entities

Section titled "entities" 
entities: EntityType[]

Defined in projects/igniteui-angular/query-builder/src/query-builder/query-builder.component.ts:71, projects/igniteui-angular/query-builder/src/query-builder/query-builder.component.ts:100

expressionTree

Section titled "expressionTree" 
expressionTree: IExpressionTree

Defined in projects/igniteui-angular/query-builder/src/query-builder/query-builder.component.ts:143, projects/igniteui-angular/query-builder/src/query-builder/query-builder.component.ts:151

resourceStrings

Section titled "resourceStrings" 
resourceStrings: IQueryBuilderResourceStrings

Defined in projects/igniteui-angular/query-builder/src/query-builder/query-builder.component.ts:173, projects/igniteui-angular/query-builder/src/query-builder/query-builder.component.ts:180

searchValueTemplate

Section titled "searchValueTemplate" 
searchValueTemplate: TemplateRef<IgxQueryBuilderSearchValueContext>

Defined in projects/igniteui-angular/query-builder/src/query-builder/query-builder.component.ts:194, projects/igniteui-angular/query-builder/src/query-builder/query-builder.component.ts:198

Methods

Section titled "Methods"

canCommit

Section titled "canCommit"

Returns whether the expression tree can be committed in the current state.

canCommit(): boolean

Defined in projects/igniteui-angular/query-builder/src/query-builder/query-builder.component.ts:261

Returns boolean

commit

Section titled "commit"

Commits the expression tree in the current state if it is valid. If not throws an exception.

commit(): void

Defined in projects/igniteui-angular/query-builder/src/query-builder/query-builder.component.ts:268

Returns void

discard

Section titled "discard"

Discards all unsaved changes to the expression tree.

discard(): void

Defined in projects/igniteui-angular/query-builder/src/query-builder/query-builder.component.ts:281

Returns void