DistinctValuesFilterDescriptor Interface
Deprecated in 3.5. Use the Table component in @itwin/itwinui-react instead, which does not use this interface.
Represents the distinct filter descriptor of a column filter descriptor.
Extends
Methods
| Name | Description | |
|---|---|---|
| addDistinctValue(distinctValue: any): void | Adds the distinct value. | |
| removeDistinctValue(distinctValue: any): boolean | Removes the distinct value. | |
| tryFindDescriptor(distinctValue: any): 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 | |
|---|---|---|---|
| distinctValues | DistinctValueCollection | Gets the distinct values. | |
| distinctValuesComparisonOperator | FilterOperator | Gets or sets the FilterOperator used for comparing actual data values with checked distinct values. | |
| filterDescriptorCollection | OperatorValueFilterDescriptorCollection | Gets the filter descriptors. |
Inherited properties
| Name | Type | Inherited from | Description |
|---|---|---|---|
| isActive | boolean | FilterDescriptor | Gets a value indicating whether this filter is active. |
Defined in
Last Updated: 20 June, 2023