Skip to content

Commit 5584ddf

Browse files
committed
Merge branch 'next'
2 parents b36b30c + cdc1061 commit 5584ddf

File tree

13 files changed

+240
-139
lines changed

13 files changed

+240
-139
lines changed

docs/chart/api/api_overview.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -44,7 +44,7 @@ Use [DataCollection events](data_collection.md#events) to work with data.
4444
| [](chart/api/chart_series_config.md) | @getshort(chart/api/chart_series_config.md) |
4545
| [](chart/api/chart_type_config.md) | @getshort(chart/api/chart_type_config.md) |
4646

47-
## Export Methods
47+
## Export methods
4848

4949
| Name | Description |
5050
| ---------------------------------------- | ----------------------------------------------- |

docs/chart/api/export/chart_pdf_method.md

Lines changed: 7 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,23 +1,18 @@
11
---
2-
sidebar_label: export.pdf()
2+
sidebar_label: pdf()
33
title: JavaScript Chart - pdf Method
44
description: You can explore the pdf method of Chart in the documentation of the DHTMLX JavaScript UI library. Browse developer guides and API reference, try out code examples and live demos, and download a free 30-day evaluation version of DHTMLX Suite.
55
---
66

7-
# export.pdf()
7+
# pdf()
88

99
### Description
1010

1111
@short: Exports a chart to a PDF file
1212

13-
### Usage
14-
15-
~~~js
16-
export.pdf(config?: object): void;
17-
~~~
18-
19-
### Parameters
13+
@signature: {'pdf(config?: object): void;'}
2014

15+
@params:
2116
- `config` - (optional) an object with export settings. You can specify the following settings for export to PDF:
2217
- `url?: string` - (optional) the url of the service that executes export and returns an exported file. This setting is optional, you should use it only if you need to specify the path to your local export service. The default value is `https://export.dhtmlx.com/chart/pdf/8.0.0`
2318
- `name?: string` - (optional) the name of the exported file
@@ -33,9 +28,8 @@ export.pdf(config?: object): void;
3328
- `bottom?: string | number` - (optional) defines a bottom margin, accepts values labeled with units
3429
- `format?: string` - (optional) defines a paper format. If defined, takes priority over **width** or **height** options. The ***'Letter'*** is set by default. Read more about formatting <a href="https://github.com/puppeteer/puppeteer/blob/v16.0.0/docs/api/puppeteer.paperformat.md">here</a>
3530

36-
### Example
3731

38-
~~~js {2,5-8}
32+
@example:
3933
// default export
4034
chart.export.pdf();
4135

@@ -44,7 +38,8 @@ chart.export.pdf({
4438
url: "https://export.dhtmlx.com/chart/pdf/8.0.0",
4539
name:"result.pdf"
4640
});
47-
~~~
41+
42+
@descr:
4843

4944
**Related samples**: [Chart. Export. Export to PDF/PNG](https://snippet.dhtmlx.com/4rybsjjq)
5045

docs/chart/api/export/chart_png_method.md

Lines changed: 7 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1,30 +1,23 @@
11
---
2-
sidebar_label: export.png()
2+
sidebar_label: png()
33
title: JavaScript Chart - png Method
44
description: You can explore the png method of Chart in the documentation of the DHTMLX JavaScript UI library. Browse developer guides and API reference, try out code examples and live demos, and download a free 30-day evaluation version of DHTMLX Suite.
55
---
66

7-
# export.png()
7+
# png()
88

99
### Description
1010

1111
@short: Exports a chart to a PNG file
1212

13-
### Usage
14-
15-
~~~js
16-
export.png(config?: object): void;
17-
~~~
18-
19-
### Parameters
13+
@signature: {'png(config?: object): void;'}
2014

15+
@params:
2116
- `config` - (optional) an object with export settings. You can specify the following settings for export to PNG:
2217
- `url?: string` - (optional) the url of the service that executes export and returns an exported file. This setting is optional, you should use it only if you need to specify the path to your local export service. The default value is `https://export.dhtmlx.com/chart/png/8.0.0`
2318
- `name?: string` - (optional) the name of the exported file
2419

25-
### Example
26-
27-
~~~js {2,5-8}
20+
@example:
2821
// default export
2922
chart.export.png();
3023

@@ -33,7 +26,8 @@ chart.export.png({
3326
url: "https://export.dhtmlx.com/chart/png/8.0.0",
3427
name: "result.png"
3528
});
36-
~~~
29+
30+
@descr:
3731

3832
**Related samples**: [Chart. Export. Export to PDF/PNG](https://snippet.dhtmlx.com/4rybsjjq)
3933

docs/chart/features.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,7 @@ In this section you can find out how to initialize different types of Charts, an
3535
| [Pie 3D chart](../charts_overview/#pie-pie-3d-and-donut-chart) | Learn how to initialize Pie 3D chart ([Example](https://snippet.dhtmlx.com/xfce9pys)) |
3636
| [Radar chart](../charts_overview/#radar-chart) | Learn how to initialize Radar chart ([Example](https://snippet.dhtmlx.com/6otf4h0t)) |
3737
| [Treemap chart](../charts_overview/#treemap-chart) | Learn how to initialize Treemap chart ([Example 1](https://snippet.dhtmlx.com/p31wzm0b), [Example 2](https://snippet.dhtmlx.com/fmgnlue4)) |
38-
| [Calendar heatmap chart](../charts_overview/##calendar-heatmap-chart) | Learn how to initialize Calendar heatmap chart |
38+
| [Calendar heatmap chart](../charts_overview/#calendar-heatmap-chart) | Learn how to initialize Calendar heatmap chart |
3939
| [Grid and Chart](https://snippet.dhtmlx.com/gdeqtev4) | Learn how to bind Chart to Grid |
4040

4141
### Loading data into Chart

docs/grid/api/api_overview.md

Lines changed: 36 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -46,17 +46,17 @@ description: You can explore the API of Grid in the documentation of the DHTMLX
4646

4747
### Editing
4848

49-
| Name | Description |
50-
| ----------------------------------------------- | --------------------------------------------------- |
51-
| [](grid/api/grid_aftereditend_event.md) | @getshort(grid/api/grid_aftereditend_event.md) |
52-
| [](grid/api/grid_aftereditstart_event.md) | @getshort(grid/api/grid_aftereditstart_event.md) |
53-
| [](grid/api/grid_beforeeditend_event.md) | @getshort(grid/api/grid_beforeeditend_event.md) |
54-
| [](grid/api/grid_beforeeditstart_event.md) | @getshort(grid/api/grid_beforeeditstart_event.md) |
49+
| Name | Description |
50+
| ------------------------------------------ | ------------------------------------------------- |
51+
| [](grid/api/grid_aftereditend_event.md) | @getshort(grid/api/grid_aftereditend_event.md) |
52+
| [](grid/api/grid_aftereditstart_event.md) | @getshort(grid/api/grid_aftereditstart_event.md) |
53+
| [](grid/api/grid_beforeeditend_event.md) | @getshort(grid/api/grid_beforeeditend_event.md) |
54+
| [](grid/api/grid_beforeeditstart_event.md) | @getshort(grid/api/grid_beforeeditstart_event.md) |
5555

5656
### Mouse
5757

5858
| Name | Description |
59-
|-------------------------------------------------|--------------------------------------------------------|
59+
| ----------------------------------------------- | ------------------------------------------------------ |
6060
| [](grid/api/grid_cellclick_event.md) | @getshort(grid/api/grid_cellclick_event.md) |
6161
| [](grid/api/grid_celldblclick_event.md) | @getshort(grid/api/grid_celldblclick_event.md) |
6262
| [](grid/api/grid_cellmousedown_event.md) | @getshort(grid/api/grid_cellmousedown_event.md) |
@@ -76,15 +76,15 @@ description: You can explore the API of Grid in the documentation of the DHTMLX
7676
### Key Navigation and Scroll
7777

7878
| Name | Description |
79-
|------------------------------------------|-------------------------------------------------|
79+
| ---------------------------------------- | ----------------------------------------------- |
8080
| [](grid/api/grid_afterkeydown_event.md) | @getshort(grid/api/grid_afterkeydown_event.md) |
8181
| [](grid/api/grid_beforekeydown_event.md) | @getshort(grid/api/grid_beforekeydown_event.md) |
8282
| [](grid/api/grid_scroll_event.md) | @getshort(grid/api/grid_scroll_event.md) |
8383

8484
### Sort and Filter
8585

8686
| Name | Description |
87-
|-----------------------------------------|------------------------------------------------|
87+
| --------------------------------------- | ---------------------------------------------- |
8888
| [](grid/api/grid_aftersort_event.md) | @getshort(grid/api/grid_aftersort_event.md) |
8989
| [](grid/api/grid_beforefilter_event.md) | @getshort(grid/api/grid_beforefilter_event.md) |
9090
| [](grid/api/grid_beforesort_event.md) | @getshort(grid/api/grid_beforesort_event.md) |
@@ -93,7 +93,7 @@ description: You can explore the API of Grid in the documentation of the DHTMLX
9393
### Column Drag and Drop
9494

9595
| Name | Description |
96-
|---------------------------------------------|----------------------------------------------------|
96+
| ------------------------------------------- | -------------------------------------------------- |
9797
| [](grid/api/grid_aftercolumndrag_event.md) | @getshort(grid/api/grid_aftercolumndrag_event.md) |
9898
| [](grid/api/grid_aftercolumndrop_event.md) | @getshort(grid/api/grid_aftercolumndrop_event.md) |
9999
| [](grid/api/grid_beforecolumndrag_event.md) | @getshort(grid/api/grid_beforecolumndrag_event.md) |
@@ -102,12 +102,12 @@ description: You can explore the API of Grid in the documentation of the DHTMLX
102102
| [](grid/api/grid_cancolumndrop_event.md) | @getshort(grid/api/grid_cancolumndrop_event.md) |
103103
| [](grid/api/grid_dragcolumnin_event.md) | @getshort(grid/api/grid_dragcolumnin_event.md) |
104104
| [](grid/api/grid_dragcolumnout_event.md) | @getshort(grid/api/grid_dragcolumnout_event.md) |
105-
| [](grid/api/grid_dragcolumnstart_event.md) | @getshort(grid/api/grid_dragcolumnstart_event.md) |
105+
| [](grid/api/grid_dragcolumnstart_event.md) | @getshort(grid/api/grid_dragcolumnstart_event.md) |
106106

107107
### Column Hide and Show
108108

109109
| Name | Description |
110-
|---------------------------------------------|----------------------------------------------------|
110+
| ------------------------------------------- | -------------------------------------------------- |
111111
| [](grid/api/grid_aftercolumnhide_event.md) | @getshort(grid/api/grid_aftercolumnhide_event.md) |
112112
| [](grid/api/grid_aftercolumnshow_event.md) | @getshort(grid/api/grid_aftercolumnshow_event.md) |
113113
| [](grid/api/grid_beforecolumnhide_event.md) | @getshort(grid/api/grid_beforecolumnhide_event.md) |
@@ -116,29 +116,29 @@ description: You can explore the API of Grid in the documentation of the DHTMLX
116116
### Column Resize
117117

118118
| Name | Description |
119-
|----------------------------------------------|-----------------------------------------------------|
119+
| -------------------------------------------- | --------------------------------------------------- |
120120
| [](grid/api/grid_afterresizeend_event.md) | @getshort(grid/api/grid_afterresizeend_event.md) |
121121
| [](grid/api/grid_beforeresizestart_event.md) | @getshort(grid/api/grid_beforeresizestart_event.md) |
122122
| [](grid/api/grid_resize_event.md) | @getshort(grid/api/grid_resize_event.md) |
123123

124124
### Row Drag and Drop
125125

126-
| Name | Description |
127-
|------------------------------------------|---------------------------------------------------|
128-
| [](grid/api/grid_afterrowdrag_event.md) | @getshort(grid/api/grid_afterrowdrag_event) |
129-
| [](grid/api/grid_afterrowdrop_event.md) | @getshort(grid/api/grid_afterrowdrop_event) |
130-
| [](grid/api/grid_beforerowdrag_event.md) | @getshort(grid/api/grid_beforerowdrag_event.md) |
131-
| [](grid/api/grid_beforerowdrop_event.md) | @getshort(grid/api/grid_beforerowdrop_event.md) |
132-
| [](grid/api/grid_cancelrowdrop_event.md) | @getshort(grid/api/grid_cancelrowdrop_event.md) |
133-
| [](grid/api/grid_canrowdrop_event.md) | @getshort(grid/api/grid_canrowdrop_event.md) |
134-
| [](grid/api/grid_dragrowin_event.md) | @getshort(grid/api/grid_dragrowin_event.md) |
135-
| [](grid/api/grid_dragrowout_event.md) | @getshort(grid/api/grid_dragrowout_event.md) |
136-
| [](grid/api/grid_dragrowstart_event.md) | @getshort(grid/api/grid_dragrowstart_event.md) |
126+
| Name | Description |
127+
| ---------------------------------------- | ----------------------------------------------- |
128+
| [](grid/api/grid_afterrowdrag_event.md) | @getshort(grid/api/grid_afterrowdrag_event) |
129+
| [](grid/api/grid_afterrowdrop_event.md) | @getshort(grid/api/grid_afterrowdrop_event) |
130+
| [](grid/api/grid_beforerowdrag_event.md) | @getshort(grid/api/grid_beforerowdrag_event.md) |
131+
| [](grid/api/grid_beforerowdrop_event.md) | @getshort(grid/api/grid_beforerowdrop_event.md) |
132+
| [](grid/api/grid_cancelrowdrop_event.md) | @getshort(grid/api/grid_cancelrowdrop_event.md) |
133+
| [](grid/api/grid_canrowdrop_event.md) | @getshort(grid/api/grid_canrowdrop_event.md) |
134+
| [](grid/api/grid_dragrowin_event.md) | @getshort(grid/api/grid_dragrowin_event.md) |
135+
| [](grid/api/grid_dragrowout_event.md) | @getshort(grid/api/grid_dragrowout_event.md) |
136+
| [](grid/api/grid_dragrowstart_event.md) | @getshort(grid/api/grid_dragrowstart_event.md) |
137137

138138
### Row Hide and Show
139139

140140
| Name | Description |
141-
|------------------------------------------|-------------------------------------------------|
141+
| ---------------------------------------- | ----------------------------------------------- |
142142
| [](grid/api/grid_afterrowhide_event.md) | @getshort(grid/api/grid_afterrowhide_event.md) |
143143
| [](grid/api/grid_afterrowshow_event.md) | @getshort(grid/api/grid_afterrowshow_event.md) |
144144
| [](grid/api/grid_beforerowhide_event.md) | @getshort(grid/api/grid_beforerowhide_event.md) |
@@ -147,7 +147,7 @@ description: You can explore the API of Grid in the documentation of the DHTMLX
147147
### Row Resize
148148

149149
| Name | Description |
150-
|--------------------------------------------|---------------------------------------------------|
150+
| ------------------------------------------ | ------------------------------------------------- |
151151
| [](grid/api/grid_afterrowresize_event.md) | @getshort(grid/api/grid_afterrowresize_event.md) |
152152
| [](grid/api/grid_beforerowresize_event.md) | @getshort(grid/api/grid_beforerowresize_event.md) |
153153

@@ -159,7 +159,7 @@ description: You can explore the API of Grid in the documentation of the DHTMLX
159159
## Grid properties
160160

161161
| Name | Description |
162-
|---------------------------------------------|----------------------------------------------------|
162+
| ------------------------------------------- | -------------------------------------------------- |
163163
| [](grid/api/grid_adjust_config.md) | @getshort(grid/api/grid_adjust_config.md) |
164164
| [](grid/api/grid_autoemptyrow_config.md) | @getshort(grid/api/grid_autoemptyrow_config.md) |
165165
| [](grid/api/grid_autoheight_config.md) | @getshort(grid/api/grid_autoheight_config.md) |
@@ -200,7 +200,7 @@ You will find the list of all the available configuration properties of a Grid c
200200
### Selection methods
201201

202202
| Name | Description |
203-
|-------------------------------------------------------|--------------------------------------------------------------|
203+
| ----------------------------------------------------- | ------------------------------------------------------------ |
204204
| [](grid/api/selection/selection_disable_method.md) | @getshort(grid/api/selection/selection_disable_method.md) |
205205
| [](grid/api/selection/selection_enable_method.md) | @getshort(grid/api/selection/selection_enable_method.md) |
206206
| [](grid/api/selection/selection_getcell_method.md) | @getshort(grid/api/selection/selection_getcell_method.md) |
@@ -211,8 +211,15 @@ You will find the list of all the available configuration properties of a Grid c
211211
### Selection events
212212

213213
| Name | Description |
214-
|----------------------------------------------------------|-----------------------------------------------------------------|
214+
| -------------------------------------------------------- | --------------------------------------------------------------- |
215215
| [](grid/api/selection/selection_afterselect_event.md) | @getshort(grid/api/selection/selection_afterselect_event.md) |
216216
| [](grid/api/selection/selection_afterunselect_event.md) | @getshort(grid/api/selection/selection_afterunselect_event.md) |
217217
| [](grid/api/selection/selection_beforeselect_event.md) | @getshort(grid/api/selection/selection_beforeselect_event.md) |
218218
| [](grid/api/selection/selection_beforeunselect_event.md) | @getshort(grid/api/selection/selection_beforeunselect_event.md) |
219+
220+
## Export methods
221+
222+
| Name | Description |
223+
| --------------------------------------- | ---------------------------------------------- |
224+
| [](grid/api/export/grid_csv_method.md) | @getshort(grid/api/export/grid_csv_method.md) |
225+
| [](grid/api/export/grid_xlsx_method.md) | @getshort(grid/api/export/grid_xlsx_method.md) |
Lines changed: 39 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,39 @@
1+
---
2+
sidebar_label: csv()
3+
title: JavaScript Grid - csv Method
4+
description: You can explore the csv method of Grid in the documentation of the DHTMLX JavaScript UI library. Browse developer guides and API reference, try out code examples and live demos, and download a free 30-day evaluation version of DHTMLX Suite.
5+
---
6+
7+
# csv()
8+
9+
### Description
10+
11+
@short: Exports data from a grid into a CSV file
12+
13+
@signature: {'csv(config?: object): string;'}
14+
15+
@params:
16+
- `config` - (optional) an object with export settings. You can specify the following settings for export to CSV:
17+
- `asFile?: boolean` - (optional) defines whether Grid should be exported to a file, *true* by default. To export Grid only as a CSV string, you need to set *asFile:false*
18+
- `name?: string` - (optional) the name of the exported CSV file (if asFile is not set to *false*)
19+
- `rowDelimiter?: string` - (optional) a newline ("\n") by default. A separator between rows, can be a tab - "\t", or any other value
20+
- `columnDelimiter?: string` - (optional) a comma (",") by default. A separator between columns, can be a semicolon - ";", or any other value
21+
22+
@returns:
23+
A CSV string with Grid data
24+
25+
@example:
26+
// default export
27+
grid.export.csv();
28+
29+
// export with config settings
30+
grid.export.csv({
31+
name:"grid_data", // grid data will be exported to a CSV file named "grid_data"
32+
rowDelimiter: "\t", // the tab delimiter will be used to separate rows
33+
columnDelimiter: ";" // the semicolon delimiter will be used to separate columns
34+
});
35+
36+
37+
@descr:
38+
39+
**Related samples**: [Grid. Export to xlsx and csv](https://snippet.dhtmlx.com/58oqij47)
Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
---
2+
sidebar_label: xlsx()
3+
title: JavaScript Grid - xlsx Method
4+
description: You can explore the xlsx method of Grid in the documentation of the DHTMLX JavaScript UI library. Browse developer guides and API reference, try out code examples and live demos, and download a free 30-day evaluation version of DHTMLX Suite.
5+
---
6+
7+
# xlsx()
8+
9+
### Description
10+
11+
@short: Exports data from a grid to an Excel file
12+
13+
@signature: {'xlsx(config?: object): string;'}
14+
15+
@params:
16+
- `config` - (optional) an object with export settings. You can specify the following settings for export to EXCEL:
17+
- `url?: string` - (optional) the link to the server side where export will be processed. By default, it is **"//export.dhtmlx.com/excel"**
18+
- `name?: string` - (optional) the name of a ready Excel file
19+
20+
21+
@example:
22+
// default export
23+
grid.export.xlsx();
24+
25+
// export with config settings
26+
grid.export.xlsx({
27+
name:"grid_data",
28+
url: "//export.dhtmlx.com/excel"
29+
});
30+
31+
32+
@descr:
33+
34+
**Related samples**: [Grid. Export to xlsx and csv](https://snippet.dhtmlx.com/58oqij47)

0 commit comments

Comments
 (0)