Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
21 commits
Select commit Hold shift + click to select a range
171c33b
[add] draft of what's new for v9.3
mafanya23 Jan 20, 2026
3fb8bba
[update] descriptions of chart and grid methods of export module
mafanya23 Jan 20, 2026
c55d56d
[add] drafts for dropbehavior option of grid (type tree) and related …
mafanya23 Jan 21, 2026
14e5200
[update] docs for grid column header filters, add description of the …
mafanya23 Jan 23, 2026
5e02a72
[add] description of the Grid footerPosition configuration option
mafanya23 Jan 26, 2026
8b9511a
[add] description of the setActive() method of window
mafanya23 Jan 26, 2026
18e60ac
[add] description of the tooltip property of tree
mafanya23 Jan 27, 2026
495664a
[add] description of the exportConfig property of grid, update what's…
mafanya23 Jan 29, 2026
e844fb1
Merge branch 'next' into 9.3
mafanya23 Jan 29, 2026
4fbd518
[update] what's new for v9.3
mafanya23 Jan 30, 2026
16f5533
[update] complete docs for v9.3
mafanya23 Feb 2, 2026
23b7000
[update] complete grid column header property's description
mafanya23 Feb 3, 2026
6672b00
[update] complete the treegrid section on drop behaviour
mafanya23 Feb 3, 2026
6c63c5b
[add] data export guide for chart, update grid data export docs
mafanya23 Feb 4, 2026
ebf8d50
[update] treegrid main image
mafanya23 Feb 4, 2026
383f321
Merge pull request #86 from DHTMLX/9.3
mafanya23 Feb 4, 2026
516646e
[update] images for treegrid dropbehaviour config
mafanya23 Feb 4, 2026
02a1034
[update] setValue() and getFilter() methods of the grid header filter
mafanya23 Feb 4, 2026
1613463
[fix] corrections in the grid footer position section
mafanya23 Feb 4, 2026
2c4a4a9
Merge pull request #88 from DHTMLX/9.3
mafanya23 Feb 4, 2026
5fd1362
[update] what's new for v9.3
mafanya23 Feb 17, 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
Binary file added docs/assets/grid/footer_bottom_position.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/assets/grid/footer_relative_position.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/assets/treegrid/dropbehaviour_child.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/assets/treegrid/dropbehaviour_sibling.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/assets/treegrid/treegrid_front.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
27 changes: 19 additions & 8 deletions docs/chart/api/export/chart_pdf_method.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,11 +8,14 @@ description: You can explore the pdf method of Chart in the documentation of the

@short: Exports a chart to a PDF file

@signature: {'pdf(config?: object): void;'}
@signature: {'pdf(config?: IPDFConfig): Promise<void>;'}

@returns:
A promise of data export

@params:
- `config` - (optional) an object with export settings. You can specify the following settings for export to PDF:
- `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`
- `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/9.3.0`
- `name?: string` - (optional) the name of the exported file
- `theme?: string` - (optional) the exported theme, "light" by default. For custom or overridden themes, enable the `exportStyles` option
- `exportStyles?: boolean | string[]` - (optional) defines the styles that will be sent to the export service when exporting Chart. Use *false* to prevent all styles from being sent to the export service
Expand Down Expand Up @@ -45,13 +48,19 @@ description: You can explore the pdf method of Chart in the documentation of the

@example:
// default export
chart.export.pdf();
chart.export.pdf()
.then(() => console.log("success"))
.catch(() => console.log("failure"))
.finally(() => console.log("finished"));

// export with config settings
chart.export.pdf({
url: "https://export.dhtmlx.com/chart/pdf/8.0.0",
name:"result.pdf"
});
url: "https://export.dhtmlx.com/chart/pdf/9.3.0",
name: "result.pdf"
})
.then(() => console.log("success"))
.catch(() => console.log("failure"))
.finally(() => console.log("finished"));

@descr:

Expand All @@ -75,11 +84,13 @@ It is necessary to set sufficient margin for correct display of `headerTemplate`
| "A5" | (5.83in x 8.27in) |
| "A6" | (4.13in x 5.83in) |

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

**Related API:** [exportStyles](chart/api/chart_exportstyles_config.md)
**Related API:** [`exportStyles`](chart/api/chart_exportstyles_config.md)

**Change log:**

- The method returns a promise of data export since v9.3
- The **header** and **footer** options of the export object were added in v8.4
- The **theme**, **exportStyles** options of the export object were added in v8.1
- The **pageRanges**, **displayHeaderFooter**, **footerTemplate**, **headerTemplate** options of the pdf object were added in v8.1
Expand Down
24 changes: 17 additions & 7 deletions docs/chart/api/export/chart_png_method.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,11 +8,14 @@ description: You can explore the png method of Chart in the documentation of the

@short: Exports a chart to a PNG file

@signature: {'png(config?: object): void;'}
@signature: {'png(config?: IPNGConfig): Promise<void>;'}

@returns:
A promise of data export

@params:
- `config` - (optional) an object with export settings. You can specify the following settings for export to PNG:
- `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`
- `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/9.3.0`
- `name?: string` - (optional) the name of the exported file
- `theme?: string` - (optional) the exported theme, "light" by default. For custom or overridden themes, enable the `exportStyles` option
- `exportStyles?: boolean | string[]` - (optional) defines the styles that will be sent to the export service when exporting Chart. Use *false* to prevent all styles from being sent to the export service
Expand All @@ -21,22 +24,29 @@ description: You can explore the png method of Chart in the documentation of the

@example:
// default export
chart.export.png();
chart.export.png()
.then(() => console.log("success"))
.catch(() => console.log("failure"))
.finally(() => console.log("finished"));

// export with config settings
chart.export.png({
url: "https://export.dhtmlx.com/chart/png/8.0.0",
url: "https://export.dhtmlx.com/chart/png/9.3.0",
name: "result.png"
});
})
.then(() => console.log("success"))
.catch(() => console.log("failure"))
.finally(() => console.log("finished"));

@descr:

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

**Related API:** [exportStyles](chart/api/chart_exportstyles_config.md)
**Related API:** [`exportStyles`](chart/api/chart_exportstyles_config.md)

**Change log:**

- The method returns a promise of data export since v9.3
- The **header** and **footer** options of the export object were added in 8.4
- The **theme** and **exportStyles** options of the export object were added in 8.1
- Added in v8.0
4 changes: 2 additions & 2 deletions docs/chart/features.md
Original file line number Diff line number Diff line change
Expand Up @@ -121,7 +121,7 @@ In this section you will know how to export Chart to different formats.

| Topic | Description |
| :----------------------------------------------------------------- | :----------------------------------------------------------------------------------------------- |
| [Exporting Chart to a PDF or PNG file](category/export-methods.md) | Learn how to export Chart to PDF or PNG formats ([Example](https://snippet.dhtmlx.com/4rybsjjq)) |
| [Exporting Chart to a PDF or PNG file](../usage/#exporting-data) | Learn how to export Chart to PDF or PNG formats ([Example](https://snippet.dhtmlx.com/4rybsjjq)) |

## How to work with Chart events

Expand Down Expand Up @@ -150,7 +150,7 @@ In this section you will learn about common functionality of the library which c
| ------------------------------------------------------------- | ------------------------------------------------------------- |
| [Touch support](../../common_features/touch_support/) | Learn how to work with touch support |
| [TypeScript support](../../common_features/using_typescript/) | Learn how to work with TypeScript |
| [AwaitRedraw](../../helpers/await_redraw/) | Learn how to perform the code after the components rendering |
| [AwaitRedraw](../../helpers/await_redraw/) | Learn how to perform the code after the component's rendering |

## Any questions left?

Expand Down
35 changes: 35 additions & 0 deletions docs/chart/usage.md
Original file line number Diff line number Diff line change
Expand Up @@ -174,3 +174,38 @@ The method takes as a parameter an object with two properties:
A new data item is added relative to the X-axis. In case of adding many items, you need to increase the value of each new data item position to add it correctly.

**Related sample**: [Chart. Adding data on the fly](https://snippet.dhtmlx.com/dpz4w5nr)

## Exporting data

You can export data of Chart into the PDF or PNG format via the corresponding methods of the `Export` module.

### Exporting data to PDF

The [`pdf()`](chart/api/export/chart_pdf_method.md) method of the Export module allows you to export Chart data into a PDF file. The method takes an [object with the export settings](chart/api/export/chart_pdf_method.md) as a parameter (all settings are optional) and returns a promise of data export.

~~~jsx
chart.export.pdf({
url: "https://export.dhtmlx.com/chart/pdf/9.3.0",
name: "result.pdf"
})
.then(() => console.log("success"))
.catch(() => console.log("failure"))
.finally(() => console.log("finished"));
~~~

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

### Exporting data to PNG

The [`png()`](chart/api/export/chart_png_method.md) method of the Export module allows you to export data from Chart into a PNG file. The method takes an [object with export settings](chart/api/export/chart_png_method.md) as a parameter (all settings are optional) and returns a promise of data export.

~~~jsx
chart.export.png({
theme: "dark" // the exported theme, "light" by default
})
.then(() => console.log("success"))
.catch(() => console.log("failure"))
.finally(() => console.log("finished"));
~~~

**Related sample**: [Chart. Export to PDF/PNG](https://snippet.dhtmlx.com/4rybsjjq)
3 changes: 3 additions & 0 deletions docs/grid/api/api_overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -198,10 +198,13 @@ description: You can explore the API of Grid in the documentation of the DHTMLX
| [](grid/api/grid_dragitem_config.md) | @getshort(grid/api/grid_dragitem_config.md) |
| [](grid/api/grid_dragmode_config.md) | @getshort(grid/api/grid_dragmode_config.md) |
| [](grid/api/grid_dragpanel_config.md) | @getshort(grid/api/grid_dragpanel_config.md) |
| [](grid/api/grid_dropbehaviour_config.md) | @getshort(grid/api/grid_dropbehaviour_config.md) |
| [](grid/api/grid_editable_config.md) | @getshort(grid/api/grid_editable_config.md) |
| [](grid/api/grid_eventhandlers_config.md) | @getshort(grid/api/grid_eventhandlers_config.md) |
| [](grid/api/grid_exportconfig_config.md) | @getshort(grid/api/grid_exportconfig_config.md) |
| [](grid/api/grid_exportstyles_config.md) | @getshort(grid/api/grid_exportstyles_config.md) |
| [](grid/api/grid_footerautoheight_config.md)| @getshort(grid/api/grid_footerautoheight_config.md)|
| [](grid/api/grid_footerposition_config.md) | @getshort(grid/api/grid_footerposition_config.md) |
| [](grid/api/grid_footerrowheight_config.md) | @getshort(grid/api/grid_footerrowheight_config.md) |
| [](grid/api/grid_footertooltip_config.md) | @getshort(grid/api/grid_footertooltip_config.md) |
| [](grid/api/grid_group_config.md) | @getshort(grid/api/grid_group_config.md) |
Expand Down
24 changes: 19 additions & 5 deletions docs/grid/api/export/grid_csv_method.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ description: You can explore the csv export method of Grid in the documentation

@short: Exports data from a grid into a CSV file

@signature: {'csv(config?: object): string;'}
@signature: {'csv(config?: ICsvExportConfig) => Promise<string>;'}

@params:
- `config` - (optional) an object with export settings. You can specify the following settings for export to CSV:
Expand All @@ -17,23 +17,37 @@ description: You can explore the csv export method of Grid in the documentation
- `rowDelimiter?: string` - (optional) a newline ("\n") by default. A separator between rows, can be a tab - "\t", or any other value
- `columnDelimiter?: string` - (optional) a comma (",") by default. A separator between columns, can be a semicolon - ";", or any other value

:::note
You can specify extended export configuration settings via the Grid [`exportConfig`](/grid/api/grid_exportconfig_config/) configuration property.
:::

@returns:
A CSV string with Grid data
A promise of data export as a CSV string

@example:
// default export
grid.export.csv();
grid.export.csv()
.then(() => console.log("success"))
.catch(() => console.log("failure"))
.finally(() => console.log("finished"));

// export with config settings
grid.export.csv({
name: "my_file", // the name of a ready CSV file
rowDelimiter: "\t", // the delimiter used to separate rows
columnDelimiter: ";" // the delimiter used to separate columns
});
})
.then(() => console.log("success"))
.catch(() => console.log("failure"))
.finally(() => console.log("finished"));


@descr:

**Related samples**: [Grid. Export to xlsx and csv](https://snippet.dhtmlx.com/58oqij47)

**Related article:** [Exporting Grid](grid/usage.md)
**Related article:** [Exporting Grid](grid/usage.md)

**Change log:**

- The method returns a promise of data export since v9.3
36 changes: 26 additions & 10 deletions docs/grid/api/export/grid_pdf_method.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,11 +8,14 @@ description: You can explore the pdf export method of Grid in the documentation

@short: Exports data from a grid to a PDF file

@signature: {'pdf(config?: object): void;'}
@signature: {'pdf(config?: IPDFConfig) => Promise<void>;'}

@returns:
A promise of data export

@params:
- `config` - (optional) an object with export settings. You can specify the following settings for export to PDF:
- `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/grid/pdf/8.1.0`
- `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/grid/pdf/9.3.0`
- `name?: string` - (optional) the name of the exported file
- `theme?: string` - (optional) the exported theme, "light" by default. For custom or overridden themes, enable the `exportStyles` option
- `exportStyles?: boolean | string[]` - (optional) defines the styles that will be sent to the export service when exporting Grid. Use *false* to prevent all styles from being sent to the export service
Expand Down Expand Up @@ -43,19 +46,30 @@ description: You can explore the pdf export method of Grid in the documentation
- `header?: string` - (optional) an HTML template for the header in the exported file
- `footer?: string` - (optional) an HTML template for the footer in the exported file

:::note
You can specify extended export configuration settings via the Grid [`exportConfig`](/grid/api/grid_exportconfig_config/) configuration property.
:::


@example:
// default export
grid.export.pdf();
grid.export.pdf()
.then(() => console.log("success"))
.catch(() => console.log("failure"))
.finally(() => console.log("finished"));

// export with config settings
grid.export.pdf({
format: "A4",
scale: 0.75,
displayHeaderFooter: true,
theme: "dark",
});

pdf: {
format: false, // the format of the output file, "A4" by default
scale: 0.75, // the scale of the grid rendering (between 0.1 and 2)
displayHeaderFooter: true // defines whether to display the header and footer, false by default
},
theme: "dark" // the exported theme, "light" by default
})
.then(() => console.log("success"))
.catch(() => console.log("failure"))
.finally(() => console.log("finished"));

@descr:

Expand Down Expand Up @@ -88,8 +102,10 @@ If you use Grid in conjunction with [Pagination](pagination.md), only the displa

**Related article:** [Exporting Grid](grid/usage.md)

**Related API:** [exportStyles](grid/api/grid_exportstyles_config.md)
**Related API:** [`exportStyles`](grid/api/grid_exportstyles_config.md)

**Change log:**

- The method returns a promise of data export since v9.3
- The **header** and **footer** options of the export object were added in v8.4
- Added in v8.1
26 changes: 20 additions & 6 deletions docs/grid/api/export/grid_png_method.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,25 +8,38 @@ description: You can explore the png export method of Grid in the documentation

@short: Exports data from a grid to a PNG file

@signature: {'png(config?: object): void;'}
@signature: {'png(config?: IPNGConfig) => Promise<void>;'}

@returns:
A promise of data export

@params:
- `config` - (optional) an object with export settings. You can specify the following settings for export to PNG:
- `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/grid/png/8.1.0`
- `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/grid/png/9.3.0`
- `name?: string` - (optional) the name of the exported file
- `theme?: string` - (optional) the exported theme, "light" by default. For custom or overridden themes, enable the `exportStyles` option
- `exportStyles?: boolean | string[]` - (optional) defines the styles that will be sent to the export service when exporting Grid. Use *false* to prevent all styles from being sent to the export service
- `header?: string` - (optional) an HTML template for the header in the exported file
- `footer?: string` - (optional) an HTML template for the footer in the exported file

:::note
You can specify extended export configuration settings via the Grid [`exportConfig`](/grid/api/grid_exportconfig_config/) configuration property.
:::

@example:
// default export
grid.export.png();
grid.export.png()
.then(() => console.log("success"))
.catch(() => console.log("failure"))
.finally(() => console.log("finished"));

// export with config settings
grid.export.png({
theme: "dark",
});
})
.then(() => console.log("success"))
.catch(() => console.log("failure"))
.finally(() => console.log("finished"));


@descr:
Expand All @@ -39,9 +52,10 @@ If you use Grid in conjunction with [Pagination](pagination.md), only the displa

**Related article:** [Exporting Grid](grid/usage.md)

**Related API:** [exportStyles](grid/api/grid_exportstyles_config.md)
**Related API:** [`exportStyles`](grid/api/grid_exportstyles_config.md)

**Change log:**

- The **header** and **footer** options of the export object were added in 8.4
- The method returns a promise of data export since v9.3
- The **header** and **footer** options of the export object were added in v8.4
- Added in v8.1
Loading
Loading