beforeColumnDrag

fires before dragging of a column has started

beforeColumnDrag: (data: object, event: MouseEvent) => void | boolean;

Parameters:

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

• data: object - data object. It contains the following properties:
  • start: string | number - the id of a column, from which the dragging process has started
  • source: array - an array with ids of dragged columns
  • target: string | number - the id of a potential target column
• event: MouseEvent - a native HTML event object

Returns:

Return false to prevent dragging of a column; otherwise, true.

Example

treegrid.events.on("beforeColumnDrag", (data, event) => {
    // your logic here
    return false;
});

Change log:

• Before v7.0, the event took one parameter - the column id.
• Starting from v7.0, the event takes two parameters: data and event.
• The event was added in v6.5