Skip to main content

FilterEditor API overview

FilterEditor properties overview

buttonsOptional. Defines whether to display buttons
fieldOptional. Defines the field a filter should be applied to
fieldsRequired. An array with fields settings for FilterEditor
fieldsSelectorOptional. Specifies whether to display the dropdown with the list of fields to select from
filterOptional. Defines the input UI and available comparison operators
formatOptional. Defines how to format values for FilterEditor
includesOptional. Defines selected options in the filter editor
optionsOptional. An array of options or a function that receives field id and returns options
predicateOptional. A date part extractor for date fields in FilterEditor
typeOptional. Defines the type of filter
valueOptional. Current input value

FilterEditor events overview

onApplyFires when filter changes are applied by clicking the Apply button
onCancelA function that is called on click of the Cancel button
onChangeFires when changes are made and applied via the user interface