Skip to main content

FilterBuilder properties overview

fieldsRequired. An array of objects with fields data
optionsRequired. An object with field options or a function that receives field id and returns options
typeOptional. Defines the type of the FilterBuilder presentation
valueOptional. An object with filtering rules

FilterBuilder actions overview

add-groupFires when adding a nested group with a filtering rule in it
add-ruleFires when adding a filtering rule
changeFires when changes are made and applied via the user interface
change-ruleFires when changing a filtering rule
delete-ruleFires when deleting a filtering rule
edit-ruleFires when opening the filter editor form
toggle-glueFires when toggling the filtering logic
update-ruleFires when finalizing changes made to a filtering rule

FilterBuilder methods overview

api.on()Allows attaching a handler to the inner events
api.exec()Allows triggering the FilterBuilder actions
api.getReactiveState()Gets the state object that stores current values of most FilterBuilder properties
api.getState()Gets the state object that stores current values of most FilterBuilder properties
api.getValue()Gets the filter configuration object
api.intercept()Allows intercepting and blocking/modifying actions
api.setNext()Allows adding some action into the Event Bus order