ui.filter

Since 7.1

A widget for filtering data.

The Filter widget allows you to filter data based on multiple criteria and visualize the result.

Check Filter documentation for more details.

Constructor

var data = new webix.DataCollection({
  data:grid_data
});
 
webix.ui({
  view:"filter",
  mode:"text",
  field:"title",
  data: data,
  on:{
    onChange(){
      const filter = this.getFilterFunction();
      data.filter(obj => filter(obj));
      console.log(data.data.order);
    }
  }
});

Where to start

• Overview of the Filter Widget
• Samples

adjust	adjusts the component to the size of the parent HTML container
applyFilter	triggers global filtering for custom inputs
attachEvent	attaches the handler to an inner event of the component
bind	binds components
blockEvent	temporarily blocks triggering of ALL events of the calling object
callEvent	calls an inner event
define	redefines a single configuration property (or a object with properties)
destructor	destructs the calling object
detachEvent	detaches a handler from an event (which was attached before by the attachEvent method)
disable	disables the calling view (makes it dimmed and unclickable)
enable	enables the calling view that was disabled by the 'disable' method
getChildViews	returns child views of the calling component
getFilterFunction	returns the function that checks the passed item against the filter criteria
getFormView	returns master form for the input
getNode	returns the main HTML container for the calling object
getParentView	returns the parent view of the component
getTopParentView	returns the top parent view
getValue	returns the value set for the filter
hasEvent	checks whether the component has the specified event handler
hide	hides the view
isEnabled	checks whether the view is enabled
isVisible	checks whether the view is visible
load	loads data from an external data source
mapEvent	routes events from one object to another
parse	loads data to the component from an inline data source
queryView	returns inner element/elements of a widget that correspond(s) to the defined parameters
resize	adjusts the view to a new size
setValue	sets a value for Filter (fields and rules for filtering)
show	makes the component visible
unbind	breaks "bind" link
unblockEvent	cancels events blocking that was enabled by the 'blockEvent' command

onAfterLoad	fires after data loading is complete
onBeforeLoad	fires immediately before data loading has started
onBindRequest	fires when the component is ready to receive data from the master component
onChange	fires when any change occurs
onDestruct	occurs when component destroyed
onLoadError	fires when an error occurs during data loading (invalid server side response)
onViewShow	fires when any hidden view is shown

animate	defines the type of animation, with which the view is shown, if it is a Multiview cell
borderless	used to hide the component borders
conditions	defines a custom set of filtering rules
container	an HTML container (or its ID) where the component should be initialized
css	the name of the CSS class or the object with styles that will be applied to the view container
data	JavaScript array containing data for the component
datatype	the type of loaded data
disabled	indicates whether an item is enabled
field	defines the data field for filtering
gravity	sets the view gravity
height	sets the height of the component
hidden	defines whether the view will be hidden initially
id	the ID of a widget
inputs	array of inputs for the filter
maxHeight	sets the maximum height for the view
maxWidth	sets the maximum width for the view
minHeight	sets the minimal height for the view
minWidth	sets the minimal width for the view
mode	defines the type of data to which the filter will be applied to
on	allows attaching custom handlers to inner events of the component
padding	defines the space between the element borders and content (applies the specified value to all sides).
paddingX	sets the right and left padding (applies the specified value to both sides)
paddingY	sets the top and bottom padding (applies the specified value to both sides)
template	defines the look of items inside the multiselect list of the Filter
type	defines the layout borders
url	the URL which the component will use to load data after its initialization
value	sets the initial value for a filter
width	sets the width of a widget

$compareValue	compares the old value of the filter with the one that is going to be set
$getSize	returns the current size of the component
$height	the current height of the view
$onLoad	sets the default action on data loading
$prepareValue	adjusts the value to the format expected by the control
$setNode	defines HTML element for the component
$setSize	sets the component size
$setValue	called each time when a component needs to set a value in a related html input
$skin	the method which will be called when skin is defined
$view	reference to the top HTML element of the view
$width	the current width of the view
config	all options from the initial component configuration
name	indicates the name of the component (a read-only property)

Back to top