Skip to content

Commit f35d3be

Browse files
committed
[update] what's new for v 9.2
1 parent 84b42ed commit f35d3be

File tree

8 files changed

+65
-20
lines changed

8 files changed

+65
-20
lines changed
40.3 KB
Loading

docs/grid/api/history/add_method.md

Lines changed: 8 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -28,10 +28,14 @@ add(action: IAction): void;
2828

2929
@params:
3030

31-
- `action: IAction` - the action object containing:
32-
- `type: ActionType` - the type of action: "add", "remove", "removeAll", or "change"
33-
- `batch: IRow[]` - an array of rows representing the data affected by the action (e.g., added, removed, or modified rows)
34-
- `inverse?: IAction` - the inverse action required for undoing (mandatory for the "change" and "removeAll" types, not required for other types)
31+
<table>
32+
<tbody>
33+
<tr>
34+
<td><b>action</b></td>
35+
<td>(<i>object</i>) the action object that contains the following properties:<ul><li><b>`type`</b> - (<i>string</i>) the type of action: "add", "remove", "removeAll", or "change"</li><li><b>`batch`</b> - (<i>array</i>) an array of rows representing the data affected by the action (e.g., added, removed, or modified rows)</li><li><b>`inverse`</b> - (<i>object</i>) optional, the inverse action required for undoing (mandatory for the "change" and "removeAll" types, not required for other types)</li></ul></td>
36+
</tr>
37+
</tbody>
38+
</table>
3539

3640
:::note
3741
The `action` argument must conform to the `IAction` interface. If the module is disabled, the action type is invalid, or the `inverse` property is missing (for actions with the "change" and "removeAll" types), the [`error`](grid/api/history/error_event.md) event is triggered.

docs/grid/api/history/afteradd_event.md

Lines changed: 23 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -12,14 +12,32 @@ This functionality requires PRO version of the DHTMLX Grid (or DHTMLX Suite) pac
1212

1313
@short: triggered after successfully adding an action to the history
1414

15-
@signature: {'afterAdd: (action: IAction) => void;'}
15+
### Usage
16+
17+
~~~jsx
18+
type ActionType = "add" | "remove" | "removeAll" | "change";
19+
20+
interface IAction {
21+
type: ActionType;
22+
batch: IRow[];
23+
inverse?: IAction;
24+
}
25+
26+
afterAdd: (action: IAction) => void;
27+
~~~
1628

1729
@params:
1830
The callback of the event is called with the following parameters:
19-
- `action: IAction` - the object of the added action containing:
20-
- `type: ActionType` - the type of action: "add", "remove", "removeAll", or "change"
21-
- `batch: IRow[]` - an array of rows representing the data affected by the action (e.g., added, removed, or modified rows)
22-
- `inverse?: IAction` - the inverse action required for undoing (for the "change" and "removeAll" types)
31+
32+
<table>
33+
<tbody>
34+
<tr>
35+
<td><b>action</b></td>
36+
<td>(<i>object</i>) the object of the added action that contains the following properties:<ul><li><b>`type`</b> - (<i>string</i>) the type of action: "add", "remove", "removeAll", or "change"</li><li><b>`batch`</b> - (<i>array</i>) an array of rows representing the data affected by the action (e.g., added, removed, or modified rows)</li><li><b>`inverse`</b> - (<i>object</i>) optional, the inverse action required for undoing (mandatory for the "change" and "removeAll" types, not required for other types)</li></ul></td>
37+
</tr>
38+
</tbody>
39+
</table>
40+
2341

2442
@example:
2543
const grid = new dhx.Grid("grid_container", {

docs/grid/api/history/afterredo_event.md

Lines changed: 22 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -12,14 +12,31 @@ This functionality requires PRO version of the DHTMLX Grid (or DHTMLX Suite) pac
1212

1313
@short: triggered after successfully redoing an action
1414

15-
@signature: {'afterRedo: (action: IAction) => void;'}
15+
### Usage
16+
17+
~~~jsx
18+
type ActionType = "add" | "remove" | "removeAll" | "change";
19+
20+
interface IAction {
21+
type: ActionType;
22+
batch: IRow[];
23+
inverse?: IAction;
24+
}
25+
26+
afterRedo: (action: IAction) => void;
27+
~~~
1628

1729
@params:
1830
The callback of the event is called with the following parameters:
19-
- `action: IAction` - the object of the executed action containing:
20-
- `type: ActionType` - the type of action: "add", "remove", "removeAll", or "change"
21-
- `batch: IRow[]` - an array of rows representing the data affected by the action (e.g., added, removed, or modified rows)
22-
- `inverse?: IAction` - the inverse action required for undoing (for the "change" and "removeAll" types)
31+
32+
<table>
33+
<tbody>
34+
<tr>
35+
<td><b>action</b></td>
36+
<td>(<i>object</i>) the object of the executed action that contains the following properties:<ul><li><b>`type`</b> - (<i>string</i>) the type of action: "add", "remove", "removeAll", or "change"</li><li><b>`batch`</b> - (<i>array</i>) an array of rows representing the data affected by the action (e.g., added, removed, or modified rows)</li><li><b>`inverse`</b> - (<i>object</i>) optional, the inverse action required for undoing (mandatory for the "change" and "removeAll" types, not required for other types)</li></ul></td>
37+
</tr>
38+
</tbody>
39+
</table>
2340

2441
@example:
2542
const grid = new dhx.Grid("grid_container", {

docs/grid/api/history/afterundo_event.md

Lines changed: 9 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -16,10 +16,15 @@ This functionality requires PRO version of the DHTMLX Grid (or DHTMLX Suite) pac
1616

1717
@params:
1818
The callback of the event is called with the following parameters:
19-
- `action: IAction` - the object of the executed action containing:
20-
- `type: ActionType` - the type of action: "add", "remove", "removeAll", or "change"
21-
- `batch: IRow[]` - an array of rows representing the data affected by the action (e.g., added, removed, or modified rows)
22-
- `inverse?: IAction` - the inverse action required for undoing (for the "change" and "removeAll" types)
19+
20+
<table>
21+
<tbody>
22+
<tr>
23+
<td><b>action</b></td>
24+
<td>(<i>object</i>) the object of the executed action that contains the following properties:<ul><li><b>`type`</b> - (<i>string</i>) the type of action: "add", "remove", "removeAll", or "change"</li><li><b>`batch`</b> - (<i>array</i>) an array of rows representing the data affected by the action (e.g., added, removed, or modified rows)</li><li><b>`inverse`</b> - (<i>object</i>) optional, the inverse action required for undoing (mandatory for the "change" and "removeAll" types, not required for other types)</li></ul></td>
25+
</tr>
26+
</tbody>
27+
</table>
2328

2429
@example:
2530
const grid = new dhx.Grid("grid_container", {

docs/grid/configuration.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2580,7 +2580,7 @@ This functionality requires PRO version of the DHTMLX Grid (or DHTMLX Suite) pac
25802580
25812581
The [`DragPanel`](grid/usage_dragpanel.md) module allows configuring the drag-n-drop functionality in Grid. It provides settings for adjusting the look and feel of the drag panel that appears when the drag-n-drop functionality is activated. Check the details below.
25822582
2583-
![](../assets/grid/dragpanel_module.png)
2583+
![](../assets/grid/dragpanel_modulle4.png)
25842584
25852585
To initialize the `DragPanel` module, you should enable the [`dragPanel`](grid/api/grid_dragpanel_config.md) property in the Grid configuration together with the [row Drag-and-Drop](#drag-n-drop) functionality (e.g. via the `dragItem: "row"` or `dragItem: "both"` properties). For example:
25862586

docs/grid/usage_dragpanel.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ This functionality requires PRO version of the DHTMLX Grid (or DHTMLX Suite) pac
1212

1313
The `DragPanel` module provides auxiliary functionality for moving rows in the **dhx.Grid** component.
1414

15-
![](../assets/grid/dragpanel_module.png)
15+
![](../assets/grid/dragpanel_modulle4.png)
1616

1717
The module is automatically activated when the [Drag-and-Drop functionality](grid/configuration.md/#drag-n-drop) for rows is enabled and conflicting configurations, such as the [`BlockSelection`](grid/usage_blockselection.md) or [`Clipboard`](grid/usage_clipboard.md) modules, are used.
1818

docs/whatsnew.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -154,6 +154,7 @@ The following shortcut key is available when the [`editable` mode](grid/api/grid
154154
- Grid. Export. Double quotes in the cell value are escaped in the exported Excel
155155
- Grid. The issue with editor closing and saving the entered value on scrolling the grid
156156
- Grid. The `draggable:false` setting of a column affects the drag-n-drop of rows
157+
- Grid. The error that occurred when the value of the `parent` property was set as a number
157158

158159
### New samples
159160

0 commit comments

Comments
 (0)