API Reference > components-react > Table > FieldFilterDescriptor

FieldFilterDescriptor Interface

Deprecated  in 3.5. Use the Table component in @itwin/itwinui-react instead, which does not use this interface.

Represents the field filter descriptor of a column filter descriptor.

Extends

Methods

Name Description
addFieldValue(fieldValue: any, operator: FilterOperator, isCaseSensitive?: boolean): void Adds the field value.  
removeFieldValue(fieldValue: any, operator: FilterOperator): boolean Removes the field value.  
tryFindDescriptor(fieldValue: any, operator: FilterOperator): undefined | FilterDescriptor Tries to find descriptor.  

Inherited methods

Name Inherited from Description
clear(): void FilterDescriptor Clears the filter descriptor and sets it to inactive.
evaluateRow(row: RowItem): boolean FilterDescriptor Evaluates a row for filtering.
getFilterExpression(): string FilterDescriptor Returns filter as ECExpression.
isFilterForColumn(columnKey: string): boolean FilterDescriptor Determines if this filter is for a particular column.

Properties

Name Type Description
filterDescriptorCollection OperatorValueFilterDescriptorCollection Gets the filter descriptors.  
logicalOperator FilterCompositionLogicalOperator Gets or sets the logical operator.  

Inherited properties

Name Type Inherited from Description
isActive boolean FilterDescriptor Gets a value indicating whether this filter is active.

Defined in

Last Updated: 30 November, 2023