Filter API overview

FilterBuilder API overview

FilterBuilder properties overview

fields	Required. An array of objects with fields data
options	Required. An object with field options or a function that receives field id and returns options
type	Optional. Defines the type of the FilterBuilder presentation
value	Optional. An object with filtering rules

FilterBuilder actions overview

add-group	Fires when adding a nested group with a filtering rule in it
add-rule	Fires when adding a filtering rule
onchange	Fires when changes are made and applied via the user interface
change-rule	Fires when changing a filtering rule
delete-rule	Fires when deleting a filtering rule
edit-rule	Fires when opening the filter editor form
toggle-glue	Fires when toggling the filtering logic
update-rule	Fires 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

FilterEditor API overview

FilterEditor properties overview

buttons	Optional. Defines whether to display buttons
field	Optional. Defines the field a filter should be applied to
fields	Required. An array with fields settings for FilterEditor
fieldsSelector	Optional. Specifies whether to display the dropdown with the list of fields to select from
filter	Optional. Defines the input UI and available comparison operators
format	Optional. Defines how to format values for FilterEditor
includes	Optional. Defines selected options in the filter editor
options	Optional. An array of options or a function that receives field id and returns options
predicate	Optional. A date part extractor for date fields in FilterEditor
type	Optional. Defines the type of filter
value	Optional. Current input value

FilterEditor events overview

onapply	Fires when filter changes are applied by clicking the Apply button
oncancel	A function that is called on click of the Cancel button
onchange	Fires when changes are made and applied via the user interface

FilterBar API overview

FilterBar properties overview

debounce	Optional. A delay time of filtering set before the onchange event
fields	Required. An array with fields settings for FilterBar

FilterBar events overview

onchange	Fires when changes are made and applied via the user interface