Skip to content

[update] docs related to export with json2excel library #108

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
mafanya23 wants to merge 3 commits into
base: next
Choose a base branch
from
+16 −10
Open

[update] docs related to export with json2excel library #108

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
063d9f4
[update] docs related to export with json2excel library
mafanya23 May 25, 2026
64c9140
[update] clarify Json2Excel export URL options in Grid docs
mafanya23 Jun 5, 2026
096d38e
[fix] align url option descriptions across Grid export docs
mafanya23 Jun 5, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 4 additions & 2 deletions docs/grid/api/export/grid_xlsx_method.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,9 @@ DHTMLX Grid uses the WebAssembly-based library [Json2Excel](https://github.com/d

@params:
- `config` - (optional) an object with export settings. You can specify the following settings for export to Excel:
- `url?: string` - (optional) the path to the **worker.js** file of the [Json2Excel](https://github.com/dhtmlx/json2excel) library (where export will be processed) set as `"../libs/json2excel/1.3/worker.js?vx"`, if the local export server is used. The path to the public export server is used by default
- `url?: string` - (optional) the path to the **worker.js** file of the [Json2Excel](https://github.com/dhtmlx/json2excel) library (where export will be processed). By default, `https://cdn.dhtmlx.com/libs/json2excel/next/worker.js?vx` is used. For a local export server, set the path to the **worker.js** file relative to your server:
- use `"../libs/json2excel/next/worker.js?vx"` for the latest version
- use `"../libs/json2excel/x.x/worker.js?vx"` for a specific version (replace `x.x` with the actual version from the [GitHub repository](https://github.com/dhtmlx/json2excel))
Comment on lines +19 to +21
Copy link
Copy Markdown

@SergMitMin SergMitMin Jun 6, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Для локального экспорта юзеры сами устанавливают путь к воркеру, и наверное логично тут оставить только опцию с х.х:
И чуть ее поправить
- use "../libs/json2excel/x.x/worker.js?vx" for a specific version (replace x.x the version deployed on your server)

актуально для всех подобных мест

- `name?: string` - (optional) "grid" by default. The name of a ready Excel file
- `tableName?: string` - (optional) "data" by default. The name of a sheet with grid data in the Excel file
- `dateFormatMask?: string` - (optional) "dd/mm/yy" by default. The mask used for [dates formatting in Excel](https://support.microsoft.com/en-us/office/format-a-date-the-way-you-want-in-excel-8e10019e-d5d8-47a1-ba95-db95123d273e)
Expand All @@ -37,7 +39,7 @@ grid.export.xlsx()

// export with config settings
grid.export.xlsx({
url: "../libs/json2excel/1.3/worker.js?vx", // a local path to the `worker.js` file of the export module
url: "../libs/json2excel/next/worker.js?vx", // latest version; use x.x instead of next for a specific version
Copy link
Copy Markdown

@SergMitMin SergMitMin Jun 6, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

можно оставить старый коммент

name: "my_file", // the name of a ready Excel file
tableName: "grid", // the name of a sheet with grid data in the Excel file
dateFormatMask: "mm.dd.yy" // the date format mask for Excel
Expand Down
12 changes: 6 additions & 6 deletions docs/grid/usage.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -477,18 +477,20 @@ You can easily export data of Grid into the Excel, CSV, PDF, or PNG format. Besi

#### Exporting data to Excel

Since v9.2 DHTMLX Grid uses the WebAssembly-based library [Json2Excel](https://github.com/dhtmlx/json2excel) to enable the export to Excel functionality and the [`xlsx()`](grid/api/export/grid_xlsx_method.md) method of the `Export` module to export data from Grid into an Excel file. You can use either the public export server or a local export server.
Since v9.2 DHTMLX Grid uses the WebAssembly-based library [**Json2Excel**](https://github.com/dhtmlx/json2excel) to enable the export to Excel functionality and the [`xlsx()`](grid/api/export/grid_xlsx_method.md) method of the `Export` module to export data from Grid into an Excel file. Export is processed at the **worker.js** file of the **Json2Excel** library (the default link is `https://cdn.dhtmlx.com/libs/json2excel/next/worker.js?vx`). You can use either the public export server or a local export server.

Thus, to have the possibility of exporting files you need to:

- call the [`xlsx()`](grid/api/export/grid_xlsx_method.md) method of the `Export` module. The method takes an [object with export settings](grid/api/export/grid_xlsx_method.md) as a parameter (all settings are optional) and returns a promise of data export.
- if you use the public export server, you don't need to specify the link to it, since it is used by default
- if you use your own export server, you need to:
- install the [Json2Excel](https://github.com/dhtmlx/json2excel) library
- provide a local path to the export module on your computer by setting the path to the **worker.js** file as `"../libs/json2excel/1.3/worker.js?vx"`, as a value of the `url` option in the configuration object of the [`xlsx()`](grid/api/export/grid_xlsx_method.md) method
- install the [**Json2Excel**](https://github.com/dhtmlx/json2excel) library
- provide a local path to the **worker.js** file as the `url` option:
- use `"../libs/json2excel/next/worker.js?vx"` for the latest version
- use `"../libs/json2excel/x.x/worker.js?vx"` for a specific version (replace `x.x` with the actual version from the [GitHub repository](https://github.com/dhtmlx/json2excel))
Comment on lines +488 to +490
Copy link
Copy Markdown

@SergMitMin SergMitMin Jun 6, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Для локального экспорта юзеры сами устанавливают путь к воркеру, и наверное логично тут оставить только опцию с х.х:
И чуть ее поправить

use "../libs/json2excel/x.x/worker.js?vx" for a specific version (replace x.x the version deployed on your server)
актуально для всех подобных мест

~~~jsx
grid.export.xlsx({
url: "../libs/json2excel/1.3/worker.js?vx", // a local path to the export module
url: "../libs/json2excel/next/worker.js?vx", // latest version; use x.x instead of next for a specific version
Copy link
Copy Markdown

@SergMitMin SergMitMin Jun 6, 2026 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

// the path to the export module, if a local export server is used
(можно и х.x поставить или оставить next)

name: "my_file", // the name of a ready Excel file, "grid" by default
tableName: "grid", // the name of a sheet with grid data in the Excel file, "data" by default
dateFormatMask: "mm.dd.yy" // the date format mask for Excel, "dd/mm/yy" by default
Expand All @@ -498,8 +500,6 @@ grid.export.xlsx({
.finally(() => console.log("finished"));
~~~

You can check the latest version of the Json2Excel library at the [github repository](https://github.com/dhtmlx/json2excel).

Read the details on dates formatting in Excel in the [related Excel documentation](https://support.microsoft.com/en-us/office/format-a-date-the-way-you-want-in-excel-8e10019e-d5d8-47a1-ba95-db95123d273e).

**Related sample**: [Grid. Export to xlsx and csv](https://snippet.dhtmlx.com/58oqij47)
Expand Down
8 changes: 6 additions & 2 deletions docs/migration.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,11 +21,15 @@ Since v9.2 the Grid component uses the WebAssembly-based library [Json2Excel](ht

##### From v9.2

The link to the public export server is used by default, so you don't need to specify it. If you use your own export server, you need to install the **Json2Excel** library and provide the local path to the export module on your computer by setting the path to the **worker.js** file as `"../libs/json2excel/1.3/worker.js?vx"`:
The link to the public export server is used by default (`https://cdn.dhtmlx.com/libs/json2excel/next/worker.js?vx`), so you don't need to specify it.

If you use your own export server, you need to install the **Json2Excel** library and set the path to the **worker.js** file as the `url` option:
- use `"../libs/json2excel/next/worker.js?vx"` for the latest version
- use `"../libs/json2excel/x.x/worker.js?vx"` for a specific version (replace `x.x` with the actual version from the [GitHub repository](https://github.com/dhtmlx/json2excel))
Comment on lines +26 to +28
Copy link
Copy Markdown

@SergMitMin SergMitMin Jun 6, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Для локального экспорта юзеры сами устанавливают путь к воркеру, и наверное логично тут оставить только опцию с х.х:
И чуть ее поправить

use "../libs/json2excel/x.x/worker.js?vx" for a specific version (replace x.x the version deployed on your server)
актуально для всех подобных мест


~~~jsx
grid.export.xlsx({
url: "../libs/json2excel/1.3/worker.js?vx", // the path to the export module, if a local export server is used
url: "../libs/json2excel/next/worker.js?vx", // latest version; use x.x instead of next for a specific version
Copy link
Copy Markdown

@SergMitMin SergMitMin Jun 6, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

оставить старый коммент(можно и х.x поставить или оставить next)

// more export settings
});
~~~
Expand Down