FilterDescriptorCollection Class

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

Collection of filter descriptors.

Extends

Methods

Name Description
constructor(): FilterDescriptorCollection    

Inherited methods

Name Inherited from Description
add(item: FilterDescriptor): void FilterDescriptorCollectionBase<FilterDescriptor> Adds an FilterDescriptor to the collection.
clear(): void FilterDescriptorCollectionBase<FilterDescriptor> Clears the collection.
remove(item: FilterDescriptor): boolean FilterDescriptorCollectionBase<FilterDescriptor> Removes a particular FilterDescriptor from the collection.

Inherited properties

Name Type Inherited from Description
count Accessor ReadOnly number FilterDescriptorCollectionBase<FilterDescriptor> Gets the count of items in the collection.
descriptors Accessor ReadOnly TDescriptor[] FilterDescriptorCollectionBase<FilterDescriptor>  
isActive Accessor ReadOnly boolean FilterDescriptorCollectionBase<FilterDescriptor> Determines if the collection is active.

Defined in

Last Updated: 20 June, 2023