Skip to content

Commit 77cc22f

Browse files
mkozhukhmkozhukh
committed
Merge branch '4.4'
Conflicts: data/api/link/ui.datatable_clipboard_config.md data/api/link/ui.excelviewer_getitemnode.md data/api/link/ui.excelviewer_onafterdroporder_event.md data/api/link/ui.excelviewer_onbeforedroporder_event.md data/api/link/ui.excelviewer_waitdata_other.md data/api/obj/ui.excelviewer.md data/api/ui.datatable_onbeforedroporder_event.md data/api/ui.datatable_opensub.md data/api/ui.excelviewer_excelheader_config.md data/api/ui.excelviewer_showsheet.md data/desktop/sidebar.md data/file_manager/whats_new.md
2 parents 065e264 + 5744aa9 commit 77cc22f

File tree

492 files changed

+4655
-704
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

492 files changed

+4655
-704
lines changed

‎data/api/_print.md

+73
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,73 @@
1+
print
2+
=============
3+
4+
@short:
5+
prints a view according to the specified settings
6+
7+
@params:
8+
9+
- view object, id the object or id of the view to print
10+
* options object a set of printing options, see the list below
11+
12+
13+
@example:
14+
//view obj or view id
15+
webix.print($$("datatable1"));
16+
webix.print("datatable1");
17+
18+
//with options
19+
webix.print($$("datatable1"), {mode:"landscape"});
20+
21+
22+
23+
@template: api_method
24+
@descr:
25+
26+
<h3>Common printing options</h3> (for all widgets)
27+
28+
- **paper** - (*string*) paper size. Possible values are "a3", "a4" (default), "letter"
29+
- **mode** - (*string*) page orientation. Possible values are "portrait" (default), "landscape"
30+
- **margin** - (*number*|*object*) margin for printed pages, can be of two types:
31+
- *number* - to set the same margin from all sides
32+
- *object* - with any of the properties: *top*, *right*, *bottom*, *left* containing number to set margins separately
33+
- **docHeader** - (*string*) document header on the first page before the printed view (independent of the browser print header)
34+
- **docFooter** - (*string*) document footer on the last page after the printed view (independent of the browser print header)
35+
36+
There are also additional properties that vary depending on the component.
37+
38+
<h3>For data components</h3>
39+
40+
- **scroll** - (*boolean*) if *true*, prints only a visible part of a scrolled component. False by default.
41+
42+
<h3>For datatable, dataview, spreadsheet, X-list</h3>
43+
44+
- **fit** - (*string*) adjusts printed component either to the page width ("page", default), or to the component width ("data").
45+
46+
<h3>For datatable and spreadsheet</h3>
47+
48+
- **header** - (*boolean*) renders header for datatable, if exists
49+
- *true* (default for datatable)
50+
- *false* (default for spreadsheet)
51+
- **skiprows** - (*boolean*) skips empty rows within the datatable. False by default
52+
- **borderless** - (*boolean*) removes borders for datatable cells. False by default
53+
- **trim** - (*boolean*) removes empty rows and columns on the edges of datatable.
54+
- *true* (default for spreadsheet),
55+
- *false* (default for datatable)
56+
57+
<h3>For datatable only</h3>
58+
59+
- **footer** - (*boolean*) renders footer for datatable, if exists. True by default
60+
61+
<h3>For spreadsheet only</h3>
62+
63+
- **data** - (*string*) defines which data to print
64+
- "all" - all data from all sheets
65+
- "current" - all data from the current sheet (default)
66+
- "selection" - selected data from the current sheet
67+
- **sheetnames** - (*boolean*) renders name of sheets for each table. True by default.
68+
69+
70+
@relatedsample: 35_print/11_wide_datatable.html
71+
72+
@related: desktop/printing.md
73+

‎data/api/copypaste_clipboard_config.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -27,6 +27,6 @@ tree = new webix.ui({
2727
@template: api_config
2828
@descr:
2929

30-
If cliboard is defined as *"custom"*, you need to specify [onPaste](api/copypaste_onpaste_event.md) behavior attached to the same-name event.
30+
If clipboard is defined as *"custom"*, you need to specify [onPaste](api/copypaste_onpaste_event.md) behavior attached to the same-name event.
3131

3232

‎data/api/copypaste_onpaste_event.md

+3-2
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,8 @@ onPaste
22
=============
33

44

5-
@short:fires when the user presses CTRL+V keys combination
5+
@short:
6+
fires when the <a href="api/copypaste_clipboard_config.md">clipboard</a> is enabled and the user presses CTRL+V keys combination
67

78

89
@params:
@@ -11,7 +12,7 @@ onPaste
1112
@example:
1213

1314
tree.attachEvent("onPaste", function(text) {
14-
webix.message("Node is pasted: " + text);
15+
webix.message("Node is pasted: " + text);
1516
});
1617

1718
@template: api_event

‎data/api/customprint_$customprint_other.md

+29
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
$customPrint
2+
=============
3+
4+
@short:
5+
generates custom HTML to print instead of the widget's HTML and invokes printing
6+
7+
@type:function
8+
9+
10+
@example:
11+
12+
var html = $$("$datatable1").$customPrint({
13+
mode:"portrait",
14+
size:{ width: 11.7, height: 16.5 }
15+
}, true);
16+
17+
@template: api_config
18+
@descr:
19+
20+
The method takes the following parameters:
21+
22+
- **options** - (*object*) print options to be applied. The full list is given [in the related article](desktop/printing.md#printingoptions)
23+
- **htmlOnly** - (*boolean*) if true, returns custom HTML and doesn't invoke printing. *False* by default
24+
25+
26+
Now Datatable, Dataview, X-List and Spreadsheet components use this method.
27+
We don't recommended to call it directly, but you can provide custom logic for printing your custom components with its help, if needed.
28+
29+

‎data/api/datastore_sort.md

+10-6
Original file line numberDiff line numberDiff line change
@@ -92,9 +92,13 @@ Possible values for the second parameter of the **sort** method is string which
9292

9393
### Sorting types
9494

95-
The third parameter of the **sort** method may be string which represents the data type:
96-
97-
- "int" - sorts as integer values
98-
- "date" - sorts as dates
99-
- "string" - sorts as strings
100-
- "string_strict" - sorts as strings, case-sensitive
95+
The third parameter of the **sort** method is a string which represents the desired sorting mode:
96+
97+
- int - compares numeric values;
98+
- [date](datatable/sorting.md#dates) - compares dates;
99+
- string - compares string values;
100+
- string_strict- case-sensitive "string";
101+
- [text](datatable/sorting.md#visible_text)- compares visible item text (including template);
102+
- server- issues a server side request for a sorted dataset;
103+
- raw - basic sorter with simple comparison (a>b and vice versa);
104+
- or, you can set a [custom sorting type](desktop/filter_sort.md#addingcustomsortingtype).

‎data/api/env_printmargin_other.md

+31
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
printMargin
2+
=============
3+
4+
@short:
5+
sets the margin for printed pages in pixels
6+
7+
@type:number
8+
9+
@default: 72
10+
11+
@example:
12+
webix.env.printMargin = 72;
13+
14+
@template:api_config
15+
@descr:
16+
The default value depends on the [pixel per inch (ppi) ratio](api/env_printppi_other.md) and is calculated as ppi * 0.75.
17+
The default ppi value is 96, so the margin value is 96*0.75=72.
18+
19+
Margins can also be set via the api/_print.md options. The priority is given to margins set via options.
20+
21+
@related:
22+
desktop/printing.md#configuringprintingenvironment
23+
24+
@relatedapi:
25+
api/_print.md
26+
api/env_printppi_other.md
27+
28+
29+
30+
31+

‎data/api/env_printppi_other.md

+23
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
printPPI
2+
=============
3+
4+
@short:
5+
sets default pixel per inch (ppi) ratio for printing
6+
7+
@type: number
8+
@default: 96
9+
10+
@example:
11+
webix.env.printPPI = 96;
12+
13+
@template: api_config
14+
@descr:
15+
16+
The option is used to define the default PPI used during [webix.print()](api/_print.md) call.
17+
18+
@related:
19+
desktop/printing.md#configuringprintingenvironment
20+
21+
@relatedapi:
22+
api/_print.md
23+
api/env_printmargin_other.md

‎data/api/history_track.md

+24-1
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ track
1111

1212
@example:
1313

14-
webix.history.track('tabbar');
14+
webix.history.track("tabbar");
1515

1616
@related:
1717
desktop/history_track.md
@@ -24,4 +24,27 @@ webix.history.track('tabbar');
2424
Each time you click the tab to switch for another cell, a **hashbang URL** is generated on the base of **cell ID**
2525
(under *http://current_url.html#!/cellID* pattern) and memorized. You'll see them in the address bar of your browser.
2626

27+
###Disabling history tracking
28+
29+
You can disable current history tracking process by calling the method again in some moment:
30+
31+
~~~js
32+
webix.history.track("tabbar");
33+
..
34+
//disables history tracking for tabbar
35+
webix.history.track();
36+
~~~
37+
38+
In addition, you can set another view as a history tracking master:
39+
40+
41+
~~~js
42+
webix.history.track("tabbar1");
43+
..
44+
//disables history tracking for tabbar1 and starts tracking tabbar2 tabs
45+
webix.history.track("tabbar2");
46+
~~~
47+
48+
49+
2750

‎data/api/htmlmap_addpoly.md

+3-2
Original file line numberDiff line numberDiff line change
@@ -2,12 +2,13 @@ addPoly
22
=============
33

44

5-
@short: renders html map tag
5+
@short: renders HTML area element with "poly" shape
66

77

88
@params:
9-
- id id id which will be assigned to related html section
9+
- id id id which will be assigned to related HTML section
1010
- points array array of points
11+
* userdata string extra data string (used by chart series)
1112

1213
@example:
1314

‎data/api/htmlmap_addrect.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -2,13 +2,13 @@ addRect
22
=============
33

44

5-
@short: renders html map tag
5+
@short: renders HTML area element with "rect" shape
66

77

88
@params:
9-
- id id id which will be assigned to related html section
9+
- id id id which will be assigned to related HTML section
1010
- points array array of points
11-
* userdata string extra data string ( used by series )
11+
* userdata string extra data string (used by chart series)
1212

1313
@example:
1414

‎data/api/htmlmap_addsector.md

+9-8
Original file line numberDiff line numberDiff line change
@@ -2,17 +2,18 @@ addSector
22
=============
33

44

5-
@short: renders html map tag
5+
@short: renders HTML area element with "poly" shape
66

77

88
@params:
9-
- id id id which will be assigned to related html section
10-
- aplha0 number starting angle
11-
- aplha1 number ending angle
12-
- x number x position of center
13-
- y number y position of center
14-
- R number radius
15-
- ky number y-scaling factor
9+
- id id id which will be assigned to related HTML section
10+
- aplha0 number starting angle
11+
- aplha1 number ending angle
12+
- x number x position of center
13+
- y number y position of center
14+
- R number radius
15+
- ky number y-scaling factor
16+
* userdata string extra data string (used by chart series)
1617

1718
@example:
1819

‎data/api/htmlmap_hide.md

+20
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
hide
2+
=============
3+
4+
@short:
5+
hides HTML area element within the specified node
6+
7+
@params:
8+
9+
- html HTMLElement HTML element in which map areas need to be hidden
10+
- userdata string value of 'userdata' attribute of the area element (used by chart series)
11+
- mode boolean true for hiding, false for showing
12+
13+
14+
@example:
15+
16+
map.hide(document.getElementById("mydiv"), "data", true);
17+
18+
@template: api_method
19+
@descr:
20+

‎data/api/htmlmap_render.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -2,11 +2,11 @@ render
22
=============
33

44

5-
@short: renders html map tag
5+
@short: renders HTML map element
66

77

88
@params:
9-
- html HTMLElement html element in which map need to be rendered
9+
- html HTMLElement HTML element in which map need to be rendered
1010

1111
@example:
1212

‎data/api/i18n_querybuilder_other.md

+50
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,50 @@
1+
querybuilder
2+
=============
3+
4+
@short:
5+
default locales for Query Builder labels and rules
6+
7+
@type:object
8+
9+
@example:
10+
webix.i18n.querybuilder ={
11+
or: "or",
12+
and: "and",
13+
delete_rule: "Delete rule",
14+
add_rule: "Add rule",
15+
add_group: "Add group",
16+
less: "less",
17+
less_or_equal: "less or equal",
18+
greater: "greater",
19+
greater_or_equal: "greater or equal",
20+
between: "between",
21+
not_between: "not between",
22+
begins_with: "begins with",
23+
not_begins_with: "not begins with",
24+
contains: "contains",
25+
not_contains: "not contains",
26+
ends_with: "ends with",
27+
not_ends_with: "not ends with",
28+
is_empty: "is empty",
29+
is_not_empty: "is not empty",
30+
equal: "equal",
31+
not_equal: "not equal",
32+
is_null: "is null",
33+
is_not_null: "is not null"
34+
};
35+
36+
webix.i18n.setLocale();
37+
38+
@template: api_config
39+
@descr:
40+
41+
42+
@related:
43+
desktop/localization.md
44+
querybuilder/localization.md
45+
46+
@relatedapi:
47+
api/i18n_setlocale.md
48+
49+
50+

0 commit comments

Comments
 (0)