API Reference › components-react› PropertyFilterBuilder

PropertyFilterBuilder

Classes and components for working with PropertyFilterBuilder.

Classes

Name Description  
PropertyFilterBuilderActions Actions for controlling PropertyFilterBuilder component state.  

Enumerations

Name Description  
PropertyFilterRuleGroupOperator Logical operator for joining rules.  
PropertyFilterRuleOperator Operators for comparing property value in PropertyFilterRule.  

Global Functions

Name Description  
defaultPropertyFilterBuilderRuleValidator Default rule validator. Deprecated
getPropertyFilterBuilderOperators Function that returns set of available operator based on property type.  
isPropertyFilterBuilderRuleGroup Function to check if supplied PropertyFilterBuilderRuleGroupItem is PropertyFilterBuilderRuleGroup.  
isPropertyFilterRuleGroup Function that checks if supplied filter is rule group.  
isUnaryPropertyFilterBuilderOperator Function that checks if supplied PropertyFilterBuilderRuleOperator operator is unary.  
isUnaryPropertyFilterOperator Function that checks if supplied PropertyFilterRuleOperator operator is unary.  
PropertyFilterBuilder Component for building complex filters.  
PropertyFilterBuilderLogicalOperator Component to render the operator inside of the filter builder  
PropertyFilterBuilderRenderer Renderer for PropertyFilterBuilder component.  
PropertyFilterBuilderRuleValue Component that renders PropertyFilterBuilderRuleRenderer value input.  
PropertyFilterBuilderToolbar Toolbar displaying the "add" and "delete" row buttons in the filter builder  
useDefaultPropertyFilterBuilderRuleValidator Creates default rule validator.  
usePropertyFilterBuilder Custom hook that creates state for PropertyFilterBuilder component.  

Interfaces

Name Description  
BuildFilterOptions Options for buildFilter.  
PropertyFilterBuilderLogicalOperatorProps Props for PropertyFilterBuilderLogicalOperator component.  
PropertyFilterBuilderProps Props for PropertyFilterBuilder component.  
PropertyFilterBuilderRendererProps Props for PropertyFilterBuilderRenderer component.  
PropertyFilterBuilderRule Data structure that describes PropertyFilterBuilder component single rule.  
PropertyFilterBuilderRuleGroup Data structure that describes PropertyFilterBuilder component rule group.  
PropertyFilterBuilderRuleOperatorProps Props for PropertyFilterBuilderRuleOperator component.  
PropertyFilterBuilderRuleRangeValue Data structure that describes range value.  
PropertyFilterBuilderRuleValueProps Props for PropertyFilterBuilderRuleValue component.  
PropertyFilterBuilderRuleValueRendererProps Props for custom PropertyFilterBuilderRuleValue renderer.  
PropertyFilterBuilderState Data structure that describes PropertyFilterBuilder component state.  
PropertyFilterRule Data structure that describes single filter rule.  
PropertyFilterRuleGroup Data structure that describes group of filter rules.  
UsePropertyFilterBuilderProps Props for usePropertyFilterBuilder  
UsePropertyFilterBuilderResult Type for usePropertyFilterBuilder return object.  

Namespaces

Name Description  
PropertyFilterBuilderRuleRangeValue  

Type Aliases

Name Description  
PropertyFilter Type that describes property filter.  
PropertyFilterBuilderRuleGroupItem Type that describes PropertyFilterBuilder component group item.  
PropertyFilterBuilderRuleOperator Operators supported by usePropertyFilterBuilder when building filter rules.  

Last Updated: 06 November, 2024