ui.query

Since 7.3

A powerful widget for filtering large datasets.

Query is a better version of Query Builder designed to extend the variety of the Webix widgets. The widget contains a built-in Filter for creating and combining filters of any complexity. It can be used standalone or in company with data widgets.

Check Query documentation for more information.

Constructor

webix.ui({
  view:"query",
  data: data,
  fields: [ /*fields for filtering*/ ],
  value: { /*filtering rules and fields combinations*/ }
});

Where to start

• Overview of the Query Widget
• Samples

adjust	adjusts the component to the size of the parent HTML container
app	sets the Jet App class for the widget
attachEvent	attaches the handler to an inner event of the component
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 a helper-function that checks if the items pass the filtering rules
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
getService	returns a service available for Query
getState	returns the reactive state object of Query
getTopParentView	returns the top parent view
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
mapEvent	routes events from one object to another
queryView	returns inner element/elements of a widget that correspond(s) to the defined parameters
resize	adjusts the view to a new size
show	makes the component visible
unblockEvent	cancels events blocking that was enabled by the 'blockEvent' command

onChange	fires when the value changes in the widget
onDestruct	occurs when component destroyed
onInit	fires on view initialization
onLongTouch	fires on holding finger in some position for a certain period of time
onSwipeX	occurs on a horizontal swipe movement
onSwipeY	occurs on a vertical swipe movement
onTouchEnd	occurs when the touch event is ended
onTouchMove	occurs during touch movement
onTouchStart	fires when some webix view has been touched
onViewResize	fires when the size of a view has been changed by resizer
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
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	sets the data source for inner multiselect list
disabled	indicates whether an item is enabled
fields	sets field objects participating in 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
locale	sets object with locale structure
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
on	allows attaching custom handlers to inner events of the component
override	used to override default classes with new ones
simple	toggles the simple mode of Query
type	defines the display mode of the filtering fields
value	sets filtering rules and fields combinations
width	sets the width of a widget

$app	returns Jet App instance of the widget
$getSize	returns the current size of the component
$height	the current height of the view
$scope	scope for resolving event and method names
$setNode	defines HTML element for the component
$setSize	sets the component size
$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