Skip to main content

afterAdd

pro version only

This functionality requires PRO version of the DHTMLX Grid (or DHTMLX Suite) package.

triggered after successfully adding an action to the history

Usage​

type ActionType = "add" | "remove" | "removeAll" | "change";

interface IAction {
    type: ActionType; 
    batch: IRow[];
    inverse?: IAction; 
}

afterAdd: (action: IAction) => void;

Parameters:

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

action(object) the object of the added action that contains the following properties:
  • type - (string) the type of action: "add", "remove", "removeAll", or "change"
  • batch - (array) an array of rows representing the data affected by the action (e.g., added, removed, or modified rows)
  • inverse - (object) optional, the inverse action required for undoing (mandatory for the "change" and "removeAll" types, not required for other types)

Example

const grid = new dhx.Grid("grid_container", {
    columns: [
        { id: "name", header: [{ text: "Name" }] },
        { id: "value", header: [{ text: "Value" }] },
    ],
    data: [
        { id: "1", name: "Item 1", value: 10 },
    ],
    history: true
});

grid.history.events.on("afterAdd", (action) => {
    console.log("Action added to history:", action.type);
});

Change log:

added in v9.2