FilteringExpressionsTree

new FilteringExpressionsTree(operator: FilteringLogic, fieldName: string, entity: string, returnFields: string[]): FilteringExpressionsTree

Defined in projects/igniteui-angular/core/src/data-operations/filtering-expressions-tree.ts:132

Returns FilteringExpressionsTree

Sets/gets the entity.

gridExpressionsTree.entity = 'Entity A';
let entity = gridExpressionsTree.entity;
entity: string

Defined in projects/igniteui-angular/core/src/data-operations/filtering-expressions-tree.ts:117

Optional fieldName

Section titled "fieldName"

Sets/gets the field name of the column where the filtering expression is placed.

gridExpressionTree.fieldName = 'Column Field';
let columnField = expressionTree.fieldName;
fieldName: string

Defined in projects/igniteui-angular/core/src/data-operations/filtering-expressions-tree.ts:90

Sets/gets the filtering operands.

const gridExpressionsTree = new FilteringExpressionsTree(FilteringLogic.And);
const expression = [
{
  condition: IgxStringFilteringOperand.instance().condition('contains'),
  fieldName: 'Column Field',
  searchVal: 'Value',
  ignoreCase: false
}];
gridExpressionsTree.filteringOperands.push(expression);
this.grid.filteringExpressionsTree = gridExpressionsTree;
let filteringOperands = gridExpressionsTree.filteringOperands;
filteringOperands: IFilteringExpression | IFilteringExpressionsTree[] = []

Defined in projects/igniteui-angular/core/src/data-operations/filtering-expressions-tree.ts:64

Sets/gets the operator.

gridExpressionsTree.operator = FilteringLogic.And;
let operator = gridExpressionsTree.operator;
operator: FilteringLogic

Defined in projects/igniteui-angular/core/src/data-operations/filtering-expressions-tree.ts:77

Optional returnFields

Section titled "returnFields"

Sets/gets the return fields.

gridExpressionsTree.returnFields = ['Column Field 1', 'Column Field 2'];
let returnFields = gridExpressionsTree.returnFields;
returnFields: string[]

Defined in projects/igniteui-angular/core/src/data-operations/filtering-expressions-tree.ts:130

Sets/gets the type of the filtering expressions tree.

gridExpressionTree.type = FilteringExpressionsTree.Advanced;
let type = expressionTree.type;
type: FilteringExpressionsTreeType

Defined in projects/igniteui-angular/core/src/data-operations/filtering-expressions-tree.ts:104

Returns the filtering expression for a column with the provided fieldName.

let filteringExpression = gridExpressionTree.find('Column Field');
find(fieldName: string): IFilteringExpression | IFilteringExpressionsTree

Defined in projects/igniteui-angular/core/src/data-operations/filtering-expressions-tree.ts:158

Parameters

  • fieldName: string

Returns IFilteringExpression | IFilteringExpressionsTree

Returns the index of the filtering expression for a column with the provided fieldName.

let filteringExpressionIndex = gridExpressionTree.findIndex('Column Field');
findIndex(fieldName: string): number

Defined in projects/igniteui-angular/core/src/data-operations/filtering-expressions-tree.ts:172

Parameters

  • fieldName: string

Returns number

Checks if filtering expressions tree is empty.

empty(expressionTree: IFilteringExpressionsTree): boolean

Defined in projects/igniteui-angular/core/src/data-operations/filtering-expressions-tree.ts:144

Parameters

Returns boolean