Skip to main content

blockSelectionEnd

pro version only

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

triggered when the selection has been completed

Usage​

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

Parameters:

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

startCell(object) an object that contains the initial cell of the selection, includes the following properties:
  • row - (object) the row configuration object
  • column - (object) the column configuration object
endCell(object) an object that contains the end cell at the time of selection completion, includes the following properties:
  • row - (object) the row configuration object
  • column - (object) the column configuration object
handle(boolean) indicates whether the handle was used (true) or a regular selection (false)
event(Event) the browser event: MouseEvent or TouchEvent

Example

grid.block.events.on("blockSelectionEnd", (startCell, endCell) => {
    console.log("Selection completed:", startCell.column.id, endCell.column.id);
});

Related API: blockSelectionStart

Change log:

added in v9.2