@@ -2,9 +2,36 @@ ui.querybuilder
2
2
=============
3
3
4
4
5
- dummy stub
5
+ {{memo A handy tool for creating complex filters. }}
6
6
7
- {{todo replace with real description. }}
7
+ {{todo check link to samples. }}
8
+
9
+ Webix Query Builder widget inherits from desktop/layout.md and allows setting extended rules for data filtering, grouping several
10
+ rules and define the logic of rules' usage.
11
+ You can use it as a standalone solution or combine with data widgets, such as DataTable and Pivot. Query Builder can also be used
12
+ as a built-in filter of DataTable.
13
+
14
+ Check desktop/query_builder.md documentation for more details.
15
+
16
+ ###Constructor
17
+
18
+ ~~~ js
19
+ var querybuilder = webix .ui ({
20
+ view: " querybuilder" ,
21
+ id: " querybuilder" ,
22
+ fields: [
23
+ { id: " fname" , value: " First Name" , type: " string" },
24
+ { id: " lname" , value: " Last Name" , type: " string" },
25
+ { id: " age" , value: " Age" , type: " number" },
26
+ { id: " bdate" , value: " Birth Date" , type: " date" }
27
+ ]
28
+ });
29
+ ~~~
30
+
31
+ ### Where to start
32
+
33
+ - [ Overview of the Query Builder Widget] ( desktop/query_builder.md )
34
+ - [ Samples] ( http://docs.webix.com/samples/66_querybuilder/index.html )
8
35
9
36
<div class =' webixdoc_parents ' ><span >Based on: </span >
10
37
<a href =" api/refs/ui.layout.md " >ui.layout</a >, <a href =" api/refs/ui.baselayout.md " >ui.baselayout</a >, <a href =" api/refs/eventsystem.md " >EventSystem</a >, <a href =" api/refs/ui.baseview.md " >ui.baseview</a >, <a href =" api/refs/settings.md " >Settings</a >, <a href =" api/refs/destruction.md " >Destruction</a >, <a href =" api/refs/basebind.md " >BaseBind</a >, <a href =" api/refs/uiextension.md " >UIExtension</a ></div >
@@ -26,8 +53,8 @@ dummy stub
26
53
- api/link/ui.querybuilder_enable.md - enables the calling view that was disabled by the 'disable' method
27
54
- api/ui.querybuilder_focus.md - sets focus to the active (blue-colored) state of the toggle button of QueryBuilder
28
55
- api/link/ui.querybuilder_getchildviews.md - returns child views of the calling component
29
- - api/ui.querybuilder_getfilterhelper.md - returns the function that filters data based on the specified filters
30
- - api/ui.querybuilder_getfilters.md -
56
+ - api/ui.querybuilder_getfilterhelper.md - returns the function that implies the filtering logic
57
+ - api/ui.querybuilder_getfilters.md - returns all available filter objects
31
58
- api/link/ui.querybuilder_getformview.md - returns master form for the input
32
59
- api/link/ui.querybuilder_getnode.md - returns the main HTML container for the calling object
33
60
- api/link/ui.querybuilder_getparentview.md - returns the parent view of the component
@@ -43,7 +70,7 @@ dummy stub
43
70
- api/link/ui.querybuilder_removeview.md - removes the specified view of a layout-like component
44
71
- api/link/ui.querybuilder_resize.md - adjusts the view to a new size
45
72
- api/link/ui.querybuilder_resizechildren.md - resizes all children of the called component
46
- - api/ui.querybuilder_setfilters.md -
73
+ - api/ui.querybuilder_setfilters.md - sets an array of filtering objects
47
74
- api/ui.querybuilder_setvalue.md - sets a value for Query Builder as an array of rules and fields for filtering. Please, see the details
48
75
- api/link/ui.querybuilder_show.md - makes the component visible
49
76
- api/link/ui.querybuilder_showbatch.md - makes visible those elements which parameter 'batch' is set to the specified name
0 commit comments