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 rule.  

Global Functions

Name Description  
defaultPropertyFilterBuilderRuleValidator Default rule validator.  
getPropertyFilterOperatorLabel Function that returns display label for rule operator.  
getPropertyFilterOperators 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.  
isUnaryPropertyFilterOperator Function that checks if supplied operator is unary.  
PropertyFilterBuilder Component for building complex filters.  
PropertyFilterBuilderRenderer Renderer for PropertyFilterBuilder component.  
PropertyFilterBuilderRuleValue Component that renders PropertyFilterBuilderRuleRenderer value input.  
usePropertyFilterBuilder Custom hook that creates state for PropertyFilterBuilder component.  

Interfaces

Name Description  
BuildFilterOptions Options for UsePropertyFilterBuilderResult.buildFilter.  
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.  
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.  

Type Aliases

Name Description  
PropertyFilter Type that describes property filter.  
PropertyFilterBuilderRuleGroupItem Type that describes PropertyFilterBuilder component group item.  

Last Updated: 08 December, 2023