Skip to content

[add] docs for v9.2 #67

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.

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
wants to merge 40 commits into
base: next
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
40 commits
Select commit Hold shift + click to select a range
f5f6cc0
[add] initial api and guides for grid range manager module
mafanya23 Apr 26, 2025
07a3102
[update] complete api and guides for grid range manager module
mafanya23 May 2, 2025
fc2f0fd
[add] guides and api pages for the blockselection module
mafanya23 May 29, 2025
edb762a
[update] description of the blockselection config properties
mafanya23 May 30, 2025
9aed7b1
Merge branch 'grid-blockselection-manager-4880' into 9.2
mafanya23 May 30, 2025
cdcea11
[update] guides and api for rangeselection and blockselection modules
mafanya23 May 30, 2025
8dec094
[add] a draft for what's new v9.2
mafanya23 Jun 2, 2025
cedf4c2
[add] drafts for grid clipboard module api and guides
mafanya23 Jun 3, 2025
052395f
[update] guides for the clipboard module
mafanya23 Jun 4, 2025
eb30db8
[update] what's new for v9.2
mafanya23 Jun 4, 2025
8347ca3
[add] initial docs for grid drag panel module
mafanya23 Jun 5, 2025
b6b1371
[update] grid drag panel guides
mafanya23 Jun 5, 2025
a66b6dd
[update] grid drag panel guides
mafanya23 Jun 6, 2025
a9c49da
[add] drafts for grid history module api pages
mafanya23 Jun 9, 2025
bb70435
[add] grid history module guides, update related api
mafanya23 Jun 11, 2025
b73d21a
Merge branch 'grid-history-module-4703' into 9.2
mafanya23 Jun 11, 2025
0272e3f
[add] the isSelectedCell() method page, update related docs
mafanya23 Jun 12, 2025
9aa69e9
[update] what's new and docs for new Grid modules
mafanya23 Jun 13, 2025
0d32fe6
[update] what's new for v9.2 and the dragpanel module guides
mafanya23 Jun 13, 2025
e91bb3b
[update] grid clipboard module guides
mafanya23 Jun 13, 2025
0c05efb
[update] guides and api of the grid modules
mafanya23 Jun 17, 2025
5adfe0d
[update] what's new for v9.2 and docs for new grid modules
mafanya23 Jun 19, 2025
f9641ab
[update] grid export to excel docs
mafanya23 Jun 20, 2025
883aa82
[add] the delete shortcut key description for grid
mafanya23 Jun 20, 2025
c082765
[update] the context menu docs
mafanya23 Jun 23, 2025
0645b4c
[update] complete grid docs for v9.2
mafanya23 Jun 24, 2025
15fd92b
Merge branch 'next' into 9.2
mafanya23 Jun 24, 2025
36eb5b5
[update] what's new for v9.2
mafanya23 Jun 24, 2025
54bcb2f
[update] docs for grid range selection module
mafanya23 Jun 24, 2025
8cf46e9
[update] grid blockselection module events' pages
mafanya23 Jun 24, 2025
4a6de11
[update] grid clipboard module guide
mafanya23 Jun 24, 2025
5b2778c
[update] grid configuration and features guides
mafanya23 Jun 24, 2025
db81949
[update] grid modules configs and related guides
mafanya23 Jun 25, 2025
6f97d7a
[update] grid configuration and usage guides
mafanya23 Jun 25, 2025
733a2dc
[update] what's new for v9.2, complete grid index page
mafanya23 Jun 26, 2025
aa9c344
[update] the keyboard navigation section for grid
mafanya23 Jun 27, 2025
a8887e9
[update] what's new for v9.2
mafanya23 Jun 30, 2025
b48253a
[update] links to new snippets in the docs for v9.2
mafanya23 Jul 1, 2025
22d4f04
[update] what's new and migration guide for v9.2
mafanya23 Jul 2, 2025
489e8f7
[update] grid data export guides
mafanya23 Jul 2, 2025
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/blockselection_module.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/dnd_treegrid_mode.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/dragpanel_module.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
149 changes: 136 additions & 13 deletions docs/grid/api/api_overview.md

Large diffs are not rendered by default.

56 changes: 56 additions & 0 deletions docs/grid/api/blockselection/afterblockhandleapply_event.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,56 @@
---
sidebar_label: afterBlockHandleApply
title: JavaScript Grid - afterBlockHandleApply Event
description: You can explore the afterBlockHandleApply event of Grid block selection 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.
---

# afterBlockHandleApply

@short: triggered after applying the handle action

### Usage

~~~jsx
afterBlockHandleApply: (
startCell: { row: object; column: object },
endCell: { row: object; column: object },
dragDirection: "up" | "down" | "left" | "right" | null,
event: MouseEvent | TouchEvent
) => void;
~~~

@params:
The callback of the event is called with the following parameters:

<table>
<tbody>
<tr>
<td><b>startCell</b></td>
<td>(<i>object</i>) an object that contains the initial cell of the selection, includes the following properties:<ul><li><b>`row`</b> - (<i>object</i>) the row configuration object </li><li><b>`column`</b> - (<i>object</i>) the column configuration object</li></ul></td>
</tr>
<tr>
<td><b>endCell</b></td>
<td>(<i>object</i>) an object that contains the end cell of the selection, includes the following properties:<ul><li><b>`row`</b> - (<i>object</i>) the row configuration object </li><li><b>`column`</b> - (<i>object</i>) the column configuration object</li></ul></td>
</tr>
<tr>
<td><b>dragDirection</b></td>
<td>(<i>string</i>) determines the direction of movement of the focused cell: `"up"` | `"down"` | `"left"` | `"right"` | `null`</td>
</tr>
<tr>
<td><b>event</b></td>
<td>(<i>Event</i>) the browser event: `MouseEvent` or `TouchEvent`</td>
</tr>
</tbody>
</table>

@example:
grid.block.events.on("afterBlockHandleApply", (startCell, endCell, dir) => {
console.log("Handle applied:");
});

@descr:

**Related API**: [`beforeBlockHandleApply`](grid/api/blockselection/beforeblockhandleapply_event.md)

@changelog:
added in v9.2
56 changes: 56 additions & 0 deletions docs/grid/api/blockselection/afterblockselectionapply_event.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,56 @@
---
sidebar_label: afterBlockSelectionApply
title: JavaScript Grid - afterBlockSelectionApply Event
description: You can explore the afterBlockSelectionApply event of Grid block selection 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.
---

# afterBlockSelectionApply

@short: triggered after applying the selection

### Usage

~~~jsx
afterBlockSelectionApply: (
startCell: { row: object; column: object },
endCell: { row: object; column: object },
handle: boolean,
event: MouseEvent | TouchEvent
) => void;
~~~

@params:
The callback of the event is called with the following parameters:

<table>
<tbody>
<tr>
<td><b>startCell</b></td>
<td>(<i>object</i>) an object that contains the initial cell of the selection, includes the following properties:<ul><li><b>`row`</b> - (<i>object</i>) the row configuration object </li><li><b>`column`</b> - (<i>object</i>) the column configuration object</li></ul></td>
</tr>
<tr>
<td><b>endCell</b></td>
<td>(<i>object</i>) an object that contains the end cell of the selection, includes the following properties:<ul><li><b>`row`</b> - (<i>object</i>) the row configuration object </li><li><b>`column`</b> - (<i>object</i>) the column configuration object</li></ul></td>
</tr>
<tr>
<td><b>handle</b></td>
<td>(<i>boolean</i>) indicates whether the handle was used (`true`) or a regular selection (`false`)</td>
</tr>
<tr>
<td><b>event</b></td>
<td>(<i>Event</i>) the browser event: `MouseEvent` or `TouchEvent`</td>
</tr>
</tbody>
</table>

@example:
grid.block.events.on("afterBlockSelectionApply", (startCell, endCell) => {
console.log("Selection applied:", startCell.column.id, endCell.column.id);
});

@descr:

**Related API**: [`beforeBlockSelectionApply`](grid/api/blockselection/beforeblockselectionapply_event.md)

@changelog:
added in v9.2
61 changes: 61 additions & 0 deletions docs/grid/api/blockselection/afterblockselectionmove_event.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,61 @@
---
sidebar_label: afterBlockSelectionMove
title: JavaScript Grid - afterBlockSelectionMove Event
description: You can explore the afterBlockSelectionMove event of Grid block selection 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.
---

# afterBlockSelectionMove

@short: triggered after moving the selection boundary

### Usage

~~~jsx
afterBlockSelectionMove: (
startCell: { row: object; column: object },
endCell: { row: object; column: object },
focusCell: { row: object; column: object } | null,
dragDirection: "up" | "down" | "left" | "right" | null,
event: MouseEvent | TouchEvent
) => void;
~~~

@params:
The callback of the event is called with the following parameters:

<table>
<tbody>
<tr>
<td><b>startCell</b></td>
<td>(<i>object</i>) an object that contains the initial cell of the selection, includes the following properties:<ul><li><b>`row`</b> - (<i>object</i>) the row configuration object </li><li><b>`column`</b> - (<i>object</i>) the column configuration object</li></ul></td>
</tr>
<tr>
<td><b>endCell</b></td>
<td>(<i>object</i>) an object that contains the current end cell of the selection, includes the following properties:<ul><li><b>`row`</b> - (<i>object</i>) the row configuration object </li><li><b>`column`</b> - (<i>object</i>) the column configuration object</li></ul></td>
</tr>
<tr>
<td><b>focusCell</b></td>
<td>(<i>object</i>) an object that contains the focus cell (if the handle is used) or `null`, includes the following properties: <ul><li><b>`row`</b> - (<i>object</i>) the row configuration object </li><li><b>`column`</b> - (<i>object</i>) the column configuration object</li></ul></td>
</tr>
<tr>
<td><b>dragDirection</b></td>
<td>(<i>string</i>) determines the direction of movement of the focused cell: `"up"` | `"down"` | `"left"` | `"right"` | `null`</td>
</tr>
<tr>
<td><b>event</b></td>
<td>(<i>Event</i>) the browser event: `MouseEvent` or `TouchEvent`</td>
</tr>
</tbody>
</table>

@example:
grid.block.events.on("afterBlockSelectionMove", (startCell, endCell) => {
console.log("Selection updated to:", endCell.column.id, endCell.row.id);
});

@descr:

**Related API**: [`beforeBlockSelectionMove`](grid/api/blockselection/beforeblockselectionmove_event.md)

@changelog:
added in v9.2
62 changes: 62 additions & 0 deletions docs/grid/api/blockselection/beforeblockhandleapply_event.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,62 @@
---
sidebar_label: beforeBlockHandleApply
title: JavaScript Grid - beforeBlockHandleApply Event
description: You can explore the beforeBlockHandleApply event of Grid block selection 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.
---

# beforeBlockHandleApply

@short: triggered before applying the handle action

### Usage

~~~jsx
beforeBlockHandleApply: (
startCell: { row: object; column: object },
endCell: { row: object; column: object },
dragDirection: "up" | "down" | "left" | "right" | null,
event: MouseEvent | TouchEvent
) => boolean | void;
~~~

@params:
The callback of the event is called with the following parameters:

<table>
<tbody>
<tr>
<td><b>startCell</b></td>
<td>(<i>object</i>) an object that contains the initial cell of the selection, includes the following properties:<ul><li><b>`row`</b> - (<i>object</i>) the row configuration object </li><li><b>`column`</b> - (<i>object</i>) the column configuration object</li></ul></td>
</tr>
<tr>
<td><b>endCell</b></td>
<td>(<i>object</i>) an object that contains the end cell of the selection, includes the following properties:<ul><li><b>`row`</b> - (<i>object</i>) the row configuration object </li><li><b>`column`</b> - (<i>object</i>) the column configuration object</li></ul></td>
</tr>
<tr>
<td><b>dragDirection</b></td>
<td>(<i>string</i>) determines the direction of movement of the focused cell: `"up"` | `"down"` | `"left"` | `"right"` | `null`</td>
</tr>
<tr>
<td><b>event</b></td>
<td>(<i>Event</i>) the browser event: `MouseEvent` or `TouchEvent`</td>
</tr>
</tbody>
</table>

@returns:
Return `false` to cancel the action; otherwise, `true`.

@example:
grid.block.events.on("beforeBlockHandleApply", (startCell, endCell, dir) => {
if (dir === "right" | dir === "left") {
console.log("Horizontal change canceled");
return false;
}
});

@descr:

**Related API**: [`afterBlockHandleApply`](grid/api/blockselection/afterblockhandleapply_event.md)

@changelog:
added in v9.2
62 changes: 62 additions & 0 deletions docs/grid/api/blockselection/beforeblockselectionapply_event.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,62 @@
---
sidebar_label: beforeBlockSelectionApply
title: JavaScript Grid - beforeBlockSelectionApply Event
description: You can explore the beforeBlockSelectionApply event of Grid block selection 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.
---

# beforeBlockSelectionApply

@short: triggered before applying the selection (e.g., to a range)

### Usage

~~~jsx
beforeBlockSelectionApply: (
startCell: { row: object; column: object },
endCell: { row: object; column: object },
handle: boolean,
event: MouseEvent | TouchEvent
) => boolean | void;
~~~

@params:
The callback of the event is called with the following parameters:

<table>
<tbody>
<tr>
<td><b>startCell</b></td>
<td>(<i>object</i>) an object that contains the initial cell of the selection, includes the following properties:<ul><li><b>`row`</b> - (<i>object</i>) the row configuration object </li><li><b>`column`</b> - (<i>object</i>) the column configuration object</li></ul></td>
</tr>
<tr>
<td><b>endCell</b></td>
<td>(<i>object</i>) an object that contains the end cell of the selection, includes the following properties:<ul><li><b>`row`</b> - (<i>object</i>) the row configuration object </li><li><b>`column`</b> - (<i>object</i>) the column configuration object</li></ul></td>
</tr>
<tr>
<td><b>handle</b></td>
<td>(<i>boolean</i>) indicates whether the handle was used (`true`) or a regular selection (`false`)</td>
</tr>
<tr>
<td><b>event</b></td>
<td>(<i>Event</i>) the browser event: `MouseEvent` or `TouchEvent`</td>
</tr>
</tbody>
</table>

@returns:
Return `false` to cancel the action; otherwise, `true`.

@example:
grid.block.events.on("beforeBlockSelectionApply", (startCell, endCell) => {
if (endCell.row.id === "2") {
console.log("Application canceled if the range ends with row 2");
return false;
}
});

@descr:

**Related API**: [`afterBlockSelectionApply`](grid/api/blockselection/afterblockselectionapply_event.md)

@changelog:
added in v9.2
65 changes: 65 additions & 0 deletions docs/grid/api/blockselection/beforeblockselectionmove_event.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,65 @@
---
sidebar_label: beforeBlockSelectionMove
title: JavaScript Grid - beforeBlockSelectionMove Event
description: You can explore the beforeBlockSelectionMove event of Grid block selection 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.
---

# beforeBlockSelectionMove

@short: triggered before moving the selection boundary

### Usage

~~~jsx
beforeBlockSelectionMove: (
startCell: { row: object; column: object },
nextCell: { row: object; column: object },
focusCell: { row: object; column: object } | null,
dragDirection: "up" | "down" | "left" | "right" | null,
event: MouseEvent | TouchEvent
) => void;
~~~

@params:
The callback of the event is called with the following parameters:


<table>
<tbody>
<tr>
<td><b>startCell</b></td>
<td>(<i>object</i>) an object that contains the initial cell of the selection, includes the following properties:<ul><li><b>`row`</b> - (<i>object</i>) the row configuration object </li><li><b>`column`</b> - (<i>object</i>) the column configuration object</li></ul></td>
</tr>
<tr>
<td><b>nextCell</b></td>
<td>(<i>object</i>) an object that contains the next cell to which the boundary is moving or the end cell of the previously selected boundary during the handle movement, includes the following properties: <ul><li><b>`row`</b> - (<i>object</i>) the row configuration object </li><li><b>`column`</b> - (<i>object</i>) the column configuration object</li></ul></td>
</tr>
<tr>
<td><b>focusCell</b></td>
<td>(<i>object</i>) an object that contains the last focus cell (if the handle is used) or `null`, includes the following properties: <ul><li><b>`row`</b> - (<i>object</i>) the row configuration object </li><li><b>`column`</b> - (<i>object</i>) the column configuration object</li></ul></td>
</tr>
<tr>
<td><b>dragDirection</b></td>
<td>(<i>string</i>) determines the direction of movement of the focused cell: `"up"` | `"down"` | `"left"` | `"right"` | `null`</td>
</tr>
<tr>
<td><b>event</b></td>
<td>(<i>Event</i>) the browser event: `MouseEvent` or `TouchEvent`</td>
</tr>
</tbody>
</table>

@returns:
Return `false` to cancel the action; otherwise, `true`.

@example:
grid.block.events.on("beforeBlockSelectionMove", (startCell, nextCell) => {
console.log("Moving to:", nextCell.column.id, nextCell.row.id);
});

@descr:

**Related API**: [`afterBlockSelectionMove`](grid/api/blockselection/afterblockselectionmove_event.md)

@changelog:
added in v9.2
Loading