Skip to content

Commit 5adfe0d

Browse files
committed
[update] what's new for v9.2 and docs for new grid modules
1 parent 0c05efb commit 5adfe0d

29 files changed

+146
-128
lines changed

docs/grid/api/grid_blockselection_config.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ description: You can explore the blockSelection config of Grid in the documentat
1010
This functionality requires PRO version of the DHTMLX Grid (or DHTMLX Suite) package.
1111
:::
1212

13-
@short: Optional. Enables/disables block selection management within a grid
13+
@short: Optional. Enables/disables the BlockSelection module during the Grid initialization
1414

1515
### Usage
1616

docs/grid/api/grid_clipboard_config.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ description: You can explore the clipboard config of Grid in the documentation o
1010
This functionality requires PRO version of the DHTMLX Grid (or DHTMLX Suite) package.
1111
:::
1212

13-
@short: Optional. Enables/disables the [`Clipboard`](grid/usage_clipboard.md) module within a grid
13+
@short: Optional. Enables/disables the Clipboard module during the Grid initialization
1414

1515
:::note
1616
The module requires the [`RangeSelection`](grid/usage_rangeselection.md) module to be enabled and is best used in conjunction with the [`BlockSelection`](grid/usage_blockselection.md) module in the `"range"` mode (enabled on initialization of the `Clipboard` module) for convenient range selection via the UI.
@@ -74,8 +74,8 @@ const grid = new dhx.Grid("grid_container", {
7474
});
7575
~~~
7676

77-
**Related article:** [Clipboard](grid/configuration.md/#clipboard)
78-
7977
**Related sample**: [Grid. Clipboard. Financial data with formatted copy/paste](https://snippet.dhtmlx.com/1fnkhwm0)
8078

79+
**Related article:** [Clipboard](grid/configuration.md/#clipboard)
80+
8181
@changelog: added in v9.2

docs/grid/api/grid_dragpanel_config.md

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ description: You can explore the dragPanel config of Grid in the documentation o
1010
This functionality requires PRO version of the DHTMLX Grid (or DHTMLX Suite) package.
1111
:::
1212

13-
@short: Optional. Enables/disables the [`dragPanel`](grid/usage_dragpanel.md) module within a grid
13+
@short: Optional. Enables/disables the DragPanel module during the Grid initialization
1414

1515
### Usage
1616

@@ -27,7 +27,7 @@ dragPanel?:
2727
@default: false
2828

2929
:::note
30-
The module is automatically enabled, if the row Drag-and-Drop is active (e.g., `dragItem: "row"` or `dragItem: "both"`), and either the [`BlockSelection`](grid/usage_blockselection.md) or [`Clipboard`](grid/usage_clipboard.md) modules are enabled.
30+
The module is automatically enabled, if the [row Drag-and-Drop](grid/configuration.md/#drag-n-drop) functionality is active (e.g. via the `dragItem: "row"` or `dragItem: "both"` properties), and either the [`BlockSelection`](grid/usage_blockselection.md) or [`Clipboard`](grid/usage_clipboard.md) modules are enabled.
3131
:::
3232

3333
@example:
@@ -85,8 +85,9 @@ const grid = new dhx.Grid("grid_container", {
8585
</script>
8686
~~~
8787

88+
**Related sample:** [Grid. DragPanel. Initialization](https://snippet.dhtmlx.com/oyk02cr6)
89+
8890
**Related article:** [Using the DragPanel module](grid/configuration.md/#using-the-dragpanel-module)
8991

90-
**Related sample:** [Grid. DragPanel. Initialization](https://snippet.dhtmlx.com/oyk02cr6)
9192

9293
@changelog: added in v9.2

docs/grid/api/grid_history_config.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ description: You can explore the history config of Grid in the documentation of
1010
This functionality requires PRO version of the DHTMLX Grid (or DHTMLX Suite) package.
1111
:::
1212

13-
@short: Optional. Enables/disables the `History` module during the Grid initialization
13+
@short: Optional. Enables/disables the History module during the Grid initialization
1414

1515
### Usage
1616

@@ -66,6 +66,8 @@ const grid = new dhx.Grid("grid_container", {
6666
grid.history.enable(); // enabling the module
6767
~~~
6868

69+
**Related sample:** [Grid. History. Configuration](https://snippet.dhtmlx.com/m88562wf)
70+
6971
**Related article:** [History of Grid actions](grid/configuration.md/#history-of-grid-actions)
7072

7173
@changelog: added in v9.2

docs/grid/api/grid_rangeselection_config.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ description: You can explore the rangeSelection config of Grid in the documentat
1010
This functionality requires PRO version of the DHTMLX Grid (or DHTMLX Suite) package.
1111
:::
1212

13-
@short: Optional. Enables/disables range selection management within a grid
13+
@short: Optional. Enables/disables the RangeSelection module during the Grid initialization
1414

1515
### Usage
1616

docs/grid/api/history/add_method.md

Lines changed: 4 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ description: You can explore the add method of Grid history in the documentation
66

77
# add()
88

9-
@short: adds a new action to the history
9+
@short: adds a new action into the history of actions within the Grid
1010

1111
### Usage
1212

@@ -17,7 +17,6 @@ interface IAction {
1717
type: ActionType;
1818
batch: IRow[];
1919
inverse?: IAction;
20-
timestamp?: number;
2120
}
2221

2322
add(action: IAction): void;
@@ -29,14 +28,13 @@ add(action: IAction): void;
2928
- `type: ActionType` - the type of action: "add", "remove", "removeAll", or "change"
3029
- `batch: IRow[]` - an array of rows representing the data affected by the action (e.g., added, removed, or modified rows)
3130
- `inverse?: IAction` - the inverse action required for undoing (mandatory for the "change" and "removeAll" types, not required for other types)
32-
- `timestamp?: number` - the timestamp of the action in milliseconds (set automatically, if not provided)
3331

3432
:::note
35-
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 a `change` action, the [`error`](grid/api/history/error_event.md) event is triggered. The `timestamp` field is automatically added if not specified.
33+
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.
3634
:::
3735

3836
@example:
39-
// The example shows adding a new row via `DataCollection` with an explicitly specified timestamp
37+
// The example shows adding a new row via `DataCollection`
4038
const grid = new dhx.Grid("grid_container", {
4139
columns: [
4240
{ id: "name", header: [{ text: "Name" }] },
@@ -52,7 +50,7 @@ const grid = new dhx.Grid("grid_container", {
5250
const newItem = { id: "2", name: "New Item", value: 20 };
5351
grid.data.add(newItem);
5452

55-
// recording the action in the history with a timestamp
53+
// recording the action in the history
5654
grid.history.add({
5755
type: "add",
5856
batch: [{ ...newItem }],

docs/grid/api/history/afteradd_event.md

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ description: You can explore the afterAdd event of Grid history in the documenta
66

77
# afterAdd
88

9-
@short: triggered before adding an action to the history
9+
@short: triggered after successfully adding an action to the history
1010

1111
@signature: {'afterAdd: (action: IAction) => void;'}
1212

@@ -15,8 +15,7 @@ The callback of the event is called with the following parameters:
1515
- `action: IAction` - the object of the added action containing:
1616
- `type: ActionType` - the type of action: "add", "remove", "removeAll", or "change"
1717
- `batch: IRow[]` - an array of rows representing the data affected by the action (e.g., added, removed, or modified rows)
18-
- `inverse?: IAction` - the inverse action required for undoing (mandatory for the "change" and "removeAll" types, not required for other types)
19-
- `timestamp?: number` - the timestamp of the action in milliseconds (set automatically, if not provided)
18+
- `inverse?: IAction` - the inverse action required for undoing (for the "change" and "removeAll" types)
2019

2120
@example:
2221
const grid = new dhx.Grid("grid_container", {
@@ -36,6 +35,8 @@ grid.history.events.on("afterAdd", (action) => {
3635

3736
@descr:
3837

38+
**Related sample:** [Grid. History. Configuration](https://snippet.dhtmlx.com/m88562wf)
39+
3940
**Related article**: [Adding/removing Grid history actions](grid/usage_history.md/#addingremoving-grid-history-actions)
4041

4142
**Related API**: [`add()`](grid/api/history/add_method.md), [`beforeAdd()`](grid/api/history/beforeadd_event.md)

docs/grid/api/history/afterredo_event.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -15,8 +15,7 @@ The callback of the event is called with the following parameters:
1515
- `action: IAction` - the object of the executed action containing:
1616
- `type: ActionType` - the type of action: "add", "remove", "removeAll", or "change"
1717
- `batch: IRow[]` - an array of rows representing the data affected by the action (e.g., added, removed, or modified rows)
18-
- `inverse?: IAction` - the inverse action required for undoing (mandatory for the "change" and "removeAll" types, not required for other types)
19-
- `timestamp?: number` - the timestamp of the action in milliseconds (set automatically, if not provided)
18+
- `inverse?: IAction` - the inverse action required for undoing (for the "change" and "removeAll" types)
2019

2120
@example:
2221
const grid = new dhx.Grid("grid_container", {
@@ -36,6 +35,8 @@ grid.history.events.on("afterRedo", (action) => {
3635

3736
@descr:
3837

38+
**Related sample:** [Grid. History. Configuration](https://snippet.dhtmlx.com/m88562wf)
39+
3940
**Related article**: [Applying undo/redo operations to Grid history actions](grid/usage_history.md/#applying-undoredo-operations-to-grid-history-actions)
4041

4142
**Related API**: [`redo()`](grid/api/history/redo_method.md), [`beforeRedo()`](grid/api/history/beforeredo_event.md)

docs/grid/api/history/afterundo_event.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -15,8 +15,7 @@ The callback of the event is called with the following parameters:
1515
- `action: IAction` - the object of the executed action containing:
1616
- `type: ActionType` - the type of action: "add", "remove", "removeAll", or "change"
1717
- `batch: IRow[]` - an array of rows representing the data affected by the action (e.g., added, removed, or modified rows)
18-
- `inverse?: IAction` - the inverse action required for undoing (mandatory for the "change" and "removeAll" types, not required for other types)
19-
- `timestamp?: number` - the timestamp of the action in milliseconds (set automatically, if not provided)
18+
- `inverse?: IAction` - the inverse action required for undoing (for the "change" and "removeAll" types)
2019

2120
@example:
2221
const grid = new dhx.Grid("grid_container", {
@@ -36,6 +35,8 @@ grid.history.events.on("afterUndo", (action) => {
3635

3736
@descr:
3837

38+
**Related sample:** [Grid. History. Configuration](https://snippet.dhtmlx.com/m88562wf)
39+
3940
**Related article**: [Applying undo/redo operations to Grid history actions](grid/usage_history.md/#applying-undoredo-operations-to-grid-history-actions)
4041

4142
**Related API**: [`undo()`](grid/api/history/undo_method.md), [`beforeUndo()`](grid/api/history/beforeundo_event.md)

docs/grid/api/history/beforeadd_event.md

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -15,11 +15,10 @@ The callback of the event is called with the following parameters:
1515
- `action: IAction` - the action object to be added containing:
1616
- `type: ActionType` - the type of action: "add", "remove", "removeAll", or "change"
1717
- `batch: IRow[]` - an array of rows representing the data affected by the action (e.g., added, removed, or modified rows)
18-
- `inverse?: IAction` - the inverse action required for undoing (mandatory for the "change" and "removeAll" types, not required for other types)
19-
- `timestamp?: number` - the timestamp of the action in milliseconds (set automatically, if not provided)
18+
- `inverse?: IAction` - the inverse action required for undoing (for the "change" and "removeAll" types)
2019

2120
@returns:
22-
Returning `false` cancels the addition.
21+
Returning `false` cancels the operation.
2322

2423
@example:
2524
const grid = new dhx.Grid("grid_container", {

0 commit comments

Comments
 (0)