DataGridXL - API

Events

Events ...

Example

js
grid.selectCell(3, 0);
grid.updateConfig({ allowEditCells: false });

Events

tscontextmenucloseobject

Payload

contextMenu
object
reference to ContextMenu instance
contextmenuopen
datainsertcompleteobject
datainsertstartobject
datastreamcomplete
datastreamstart
beforedeletecolsGridDeleteColsEvent

Fires before column(s) have been deleted

Payload

type
string
Always `"beforedeletecols"` or `"deletecols"`
target
DataGridXL
Instance that fired the event
payload
GridDeleteColsEventPayload
Structured event data
deletecolsGridDeleteColsEvent

Fires when column(s) have been deleted

Payload

type
string
Always `"beforedeletecols"` or `"deletecols"`
target
DataGridXL
Instance that fired the event
payload
GridDeleteColsEventPayload
Structured event data
beforedeleterowsobject

Payload

amount
number
amount of inserted rows
deleterowsobject

Payload

rowIds
array
ids of deleted rows
beforefreezecolsobject

Payload

colIds
array
ids of frozen columns
freezecolsobject

Payload

colIds
array
ids of frozen columns
beforefreezerowsobject

Payload

rowIds
array
ids of frozen rows
freezerowsobject

Payload

rowIds
array
ids of frozen rows
fullscreenenterobject
fullscreenleaveobject
beforehidecolsGridHideColsEvent

Fires before column(s) have been hidden

Payload

type
string
Name of the event
target
DataGridXL
Instance that fired the event
payload
GridHideColsEventPayload
Structured event data
hidecolsGridHideColsEvent

Fires when column(s) have been hidden

Payload

type
string
Name of the event
target
DataGridXL
Instance that fired the event
payload
GridHideColsEventPayload
Structured event data
beforehiderowsobject

Payload

ids
number
IDs of hidden rows
hiderowsobject

Payload

ids
number
IDs of hidden rows
beforeinsertemptycolsGridInsertEmptyColsEvent

Fires before empty column(s) have been inserted.

Payload

type
string
Name of the event
target
DataGridXL
Instance that fired the event
payload
GridInsertEmptyColsEventPayload
Structured event data
insertemptycolsGridInsertEmptyColsEvent

Fires when empty column(s) have been inserted.

Payload

type
string
Name of the event
target
DataGridXL
Instance that fired the event
payload
GridInsertEmptyColsEventPayload
Structured event data
beforeinsertemptyrowsobject

Payload

amount
number
amount of inserted rows
insertemptyrowsobject

Payload

amount
number
amount of inserted rows
interactionmodechange
beforemovecolsGridBeforeMoveColsEvent

Fires before column(s) have been moved

Payload

type
string
Name of the event
target
DataGridXL
Instance that fired the event
payload
GridMoveColsEventData
movecolsGridMoveColsEvent

Fires when column(s) have been moved

Payload

type
string
Name of the event
target
DataGridXL
Instance that fired the event
payload
GridMoveColsEventPayload
Structured event data
beforemoverowsobject

Payload

amount
number
amount of inserted rows
moverowsobject

Payload

amount
number
amount of inserted rows
beforeresizecolsobject

Payload

amount
number
amount of inserted columns
resizecolsobject

Payload

amount
number
amount of inserted columns
restorecols

Fires when column(s) have been restored.

restorerows

Fires when row(s) have been restored.

setcellvaluesbatchobject

Payload

amount
number
amount of inserted columns
beforeshowcolsobject

Payload

ids
number
IDs of columns
showcolsobject

Payload

ids
number
IDs of columns
beforeshowrowsobject

Payload

ids
number
IDs of rows
showrowsobject

Payload

ids
number
IDs of rows
beforesort
sort