API Reference › components-react › PropertyFilterBuilder › PropertyFilterBuilderActions

PropertyFilterBuilderActions Class

Actions for controlling PropertyFilterBuilder component state.

Methods

Name Description
constructor(setState: (setter: (prevState: PropertyFilterBuilderState) => PropertyFilterBuilderState) => void): PropertyFilterBuilderActions    
addItem(path: string[], itemType: "RULE_GROUP" | "RULE"): void Adds new rule or group of rules to the group specified by path.  
removeAllItems(): void Removes all items from root group.  
removeItem(path: string[]): void Removes item specified by path.  
setRuleErrorMessages(ruleIdsAndErrorMessages: Map<string, string>): void Sets error messages of the rules specified by id.  
setRuleGroupOperator(path: string[], operator: "and" | "or"): void Sets operator of rule group specified by the path.  
setRuleOperator(path: string[], operator: PropertyFilterBuilderRuleOperator): void Sets operator of rule specified by the path.  
setRuleProperty(path: string[], property?: PropertyDescription): void Sets property of rule specified by the path.  
setRuleValue(path: string[], value: PropertyValue): void Sets value of rule specified by the path.  

Defined in

Last Updated: 05 April, 2024