Skip to content

Commit a8a127e

Browse files
committed
[update] updates in the new docs, corrections in the current ones
1 parent 91abcbe commit a8a127e

35 files changed

+662
-310
lines changed

data/api/_print.md

-3
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,6 @@
11
print
22
=============
33

4-
5-
@todo:
6-
check and complete
74
@short:
85
prints a view according to the specified settings
96

data/api/customprint_$customprint_other.md

-2
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,6 @@
11
$customPrint
22
=============
33

4-
@todo: check
5-
64
@short:
75
generates custom HTML to print instead of the widget's HTML and invokes printing
86

data/api/env_printmargin_other.md

-2
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,6 @@
11
printMargin
22
=============
33

4-
@todo: check links
5-
64
@short:
75
sets the margin for printed pages in pixels
86

data/api/env_printppi_other.md

-2
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,6 @@
11
printPPI
22
=============
33

4-
@todo: check links
5-
64
@short:
75
sets default pixel per inch (ppi) ratio for printing
86

data/api/i18n_querybuilder_other.md

+2-5
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,8 @@
11
querybuilder
22
=============
33

4-
@todo:
5-
complete
6-
7-
84
@short:
9-
default locales for Query Buidler labels and rules
5+
default locales for Query Builder labels and rules
106

117
@type:object
128

@@ -45,6 +41,7 @@ webix.i18n.setLocale();
4541

4642
@related:
4743
desktop/localization.md
44+
querybuilder/localization.md
4845

4946
@relatedapi:
5047
api/i18n_setlocale.md

data/api/obj/ui.querybuilder.md

+1-3
Original file line numberDiff line numberDiff line change
@@ -3,10 +3,8 @@
33

44
{{todo check link to samples}}
55

6-
Webix Query Builder widget inherits from desktop/layout.md and allows setting extended rules for data filtering, grouping several
6+
Webix Query Builder widget inherits from [Layout](desktop/layout.md) and allows setting extended rules for data filtering, grouping several
77
rules and define the logic of rules' usage.
8-
You can use it as a standalone solution or combine with data widgets, such as DataTable and Pivot. Query Builder can also be used
9-
as a built-in filter of DataTable.
108

119
Check desktop/query_builder.md documentation for more details.
1210

data/api/refs/customprint.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@ CustomPrint
22
=============
33

44

5-
Creates custom HTML during printing for widgets that are not fully rendered in the workflow
5+
{{memo Creates custom HTML during printing for widgets that are not fully rendered in the workflow. }}
66

77

88

data/api/refs/ui.querybuilder.md

+32-5
Original file line numberDiff line numberDiff line change
@@ -2,9 +2,36 @@ ui.querybuilder
22
=============
33

44

5-
dummy stub
5+
{{memo A handy tool for creating complex filters. }}
66

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)
835

936
<div class='webixdoc_parents'><span>Based on: </span>
1037
<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
2653
- api/link/ui.querybuilder_enable.md - enables the calling view that was disabled by the 'disable' method
2754
- api/ui.querybuilder_focus.md - sets focus to the active (blue-colored) state of the toggle button of QueryBuilder
2855
- 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
3158
- api/link/ui.querybuilder_getformview.md - returns master form for the input
3259
- api/link/ui.querybuilder_getnode.md - returns the main HTML container for the calling object
3360
- api/link/ui.querybuilder_getparentview.md - returns the parent view of the component
@@ -43,7 +70,7 @@ dummy stub
4370
- api/link/ui.querybuilder_removeview.md - removes the specified view of a layout-like component
4471
- api/link/ui.querybuilder_resize.md - adjusts the view to a new size
4572
- 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
4774
- api/ui.querybuilder_setvalue.md - sets a value for Query Builder as an array of rules and fields for filtering. Please, see the details
4875
- api/link/ui.querybuilder_show.md - makes the component visible
4976
- api/link/ui.querybuilder_showbatch.md - makes visible those elements which parameter 'batch' is set to the specified name

data/api/refs/ui.querybuilder_methods.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -15,8 +15,8 @@ Methods
1515
- api/link/ui.querybuilder_enable.md - enables the calling view that was disabled by the 'disable' method
1616
- api/ui.querybuilder_focus.md - sets focus to the active (blue-colored) state of the toggle button of QueryBuilder
1717
- api/link/ui.querybuilder_getchildviews.md - returns child views of the calling component
18-
- api/ui.querybuilder_getfilterhelper.md - returns the function that filters data based on the specified filters
19-
- api/ui.querybuilder_getfilters.md -
18+
- api/ui.querybuilder_getfilterhelper.md - returns the function that implies the filtering logic
19+
- api/ui.querybuilder_getfilters.md - returns all available filter objects
2020
- api/link/ui.querybuilder_getformview.md - returns master form for the input
2121
- api/link/ui.querybuilder_getnode.md - returns the main HTML container for the calling object
2222
- api/link/ui.querybuilder_getparentview.md - returns the parent view of the component
@@ -32,7 +32,7 @@ Methods
3232
- api/link/ui.querybuilder_removeview.md - removes the specified view of a layout-like component
3333
- api/link/ui.querybuilder_resize.md - adjusts the view to a new size
3434
- api/link/ui.querybuilder_resizechildren.md - resizes all children of the called component
35-
- api/ui.querybuilder_setfilters.md -
35+
- api/ui.querybuilder_setfilters.md - sets an array of filtering objects
3636
- api/ui.querybuilder_setvalue.md - sets a value for Query Builder as an array of rules and fields for filtering. Please, see the details
3737
- api/link/ui.querybuilder_show.md - makes the component visible
3838
- api/link/ui.querybuilder_showbatch.md - makes visible those elements which parameter 'batch' is set to the specified name

data/api/toc/ui_mixins.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ Mixins
1515
- api/refs/collectionbind.md - binding rules for collections of objects
1616
- api/refs/contexthelper.md - Allows viewing subviews by right mouse click
1717
- api/refs/copypaste.md - provides support for copy-paste operations (integration with clipboard)
18-
- api/refs/customprint.md -
18+
- api/refs/customprint.md - Creates custom HTML during printing for widgets that are not fully rendered in the workflow
1919
- api/refs/customscroll.md - Renders custom scrollbars to Webix views
2020
- api/refs/datacollection.md - View-less component that stores a collection of non-hierarchical data
2121
- api/refs/datadriver.md - data parsing for different format

data/api/ui.querybuilder_focus.md

-4
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,5 @@
11
focus
22
=============
3-
4-
5-
@todo:
6-
check
73

84
@short:
95
sets focus to the active (blue-colored) state of the toggle button of QueryBuilder

data/api/ui.querybuilder_getfilterhelper.md

+8-4
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,7 @@
11
getFilterHelper
22
=============
33

4-
5-
@todo:
6-
check
4+
@todo: check the link to sample
75

86
@short:
97
returns the function that implies the filtering logic
@@ -26,4 +24,10 @@ $$("$datatable1").filter(helper);
2624
The returned "helper" function iterates through the dataset items and checks whether they correspond to
2725
the filter rules. The "helper" function returns *true* if the item complies with the rule and *false*, if it doesn't.
2826

29-
After you've received the helper function, you can pass it to the Webix api/link/ui.proto_filter.md method to enable filtering of data components with Query Builder.
27+
After you've received the helper function, you can pass it to the Webix api/link/ui.proto_filter.md method to enable filtering of data components with Query Builder.
28+
29+
@related:
30+
querybuilder/usage.md
31+
32+
@relatedsample:
33+
66_querybuilder/01_initialization/02_basic.html
+19-13
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,8 @@
11
getFilters
22
=============
33

4-
5-
@todo:
6-
check!
7-
84
@short:
9-
returns all available filter objects
5+
returns an array of all available filter objects
106

117
@params:
128

@@ -25,15 +21,23 @@ var filters = $$("querybuilder").getFilters();
2521
A returned array with filters looks like this:
2622

2723
~~~js
28-
[{
29-
"fn":function (a, b)
30-
id:"less or equal"
31-
name:"less or equal"
32-
type:"number"
33-
}]
24+
[
25+
{
26+
"fn":function (a, b)
27+
id:"less or equal"
28+
name:"less or equal"
29+
type:"number"
30+
},
31+
{
32+
function (a)
33+
id:"is null"
34+
name:"is null"
35+
type:"any"
36+
}
37+
]
3438
~~~
3539

36-
and has the following properties:
40+
Each object in the array has the following properties:
3741

3842
- **id** - (*string*) the filter id
3943
- **name** - (*string*) the filter name (will be rendered in the list of options for filtering)
@@ -43,8 +47,10 @@ and has the following properties:
4347
- *string*
4448
- *any*
4549

46-
50+
The full list of predefined filters is given in the [related article](querybuilder/list_of_filters.md).
4751

4852
@relatedapi:
4953
api/ui.querybuilder_setfilters.md
5054

55+
@related:
56+
querybuilder/filters.md

data/api/ui.querybuilder_getvalue.md

+7-6
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,7 @@
11
getValue
22
=============
33

4-
5-
@todo:
6-
check
4+
@todo: check the link to sample
75

86
@short:
97
returns the value set for Query Builder (an array of rules and fields for filtering)
@@ -47,9 +45,12 @@ The returned array with rules and fields looks as in:
4745
]
4846
~~~
4947

50-
@relatedsample:
51-
52-
66_querybuilder/01_initialization/01_init.html
5348

5449
@relatedapi:
5550
api/ui.querybuilder_setvalue.md
51+
52+
@related:
53+
querybuilder/setting_value.md#gettingvalue
54+
55+
@relatedsample:
56+
66_querybuilder/01_initialization/01_init.html

data/api/ui.querybuilder_setfilters.md

+7-10
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,12 @@
11
setFilters
22
=============
33

4-
5-
@todo:
6-
check
7-
84
@short:
9-
sets an array of filtering objects
5+
sets an array of filter objects
106

117
@params:
128

13-
- filters array an array with filters objects
14-
15-
9+
- filters array an array with filter objects
1610

1711
@example:
1812
$$("querybuilder").setFilters([
@@ -43,7 +37,10 @@ Each filter object should have the following properties:
4337
- *string*
4438
- *any*
4539
46-
See the full list of available filters in the related section of the Query Builder documenatation.
40+
See the full list of available filters in the [related article of the Query Builder documentation](querybuilder/list_of_filters.md).
4741
4842
@relatedapi:
49-
api/ui.querybuilder_getfilters.md
43+
api/ui.querybuilder_getfilters.md
44+
45+
@related:
46+
querybuilder/filters.md

data/api/ui.querybuilder_setvalue.md

+6-5
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,10 @@
11
setValue
22
=============
33

4-
5-
@todo:
6-
check
4+
@todo: check the link to sample
75

86
@short:
9-
sets a value for Query Builder as an array of rules and fields for filtering. Please, see the details
7+
sets a value for Query Builder as an array of rules and fields for filtering
108

119
@params:
1210

@@ -99,4 +97,7 @@ $$("querybuilder").setValue(
9997
66_querybuilder/01_initialization/01_init.html
10098
10199
@relatedapi:
102-
api/ui.querybuilder_getvalue.md
100+
api/ui.querybuilder_getvalue.md
101+
102+
@related:
103+
querybuilder/setting_value.md#settingvalue

data/desktop/data_scheme.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -199,7 +199,7 @@ var mylist = webix.ui({
199199

200200
var items = mylist.data.serialize();
201201
// serialize() is the method of the DataStore component
202-
// that's we use the api/atomdataloader_data_config.md property to access it
202+
// that's why we use the api/atomdataloader_data_config.md property to access it
203203
~~~
204204

205205
{{note

0 commit comments

Comments
 (0)