API
api/

Events

NOTE This is the API for DataGridXL3 (coming soon). For current version 2, visit V2 API
function handleMoveRows(gridEvent){ ... }

grid.events.on('moverows', handleMoveRows);
grid.events.off('moverows', handleMoveRows);

actions: cell

setcellvaluesbatch
Cell Values have been affected

actions: column

beforedeletecols
BEFORE Column(s) have been deleted
deletecols
Column(s) have been deleted.
beforefreezecols
Before column(s) have been frozen
freezecols
Column(s) have been frozen
beforehidecols
Before column(s) have been hidden
hidecols
Column(s) have been hidden
beforeinsertemptycols
BEFORE Empty Column(s) have been inserted.
insertemptycols
Empty Column(s) have been inserted.
beforemovecols
BEFORE Column(s) have been moved
movecols
Column(s) have been moved
beforeresizecols
BEFORE Column(s) have been moved
resizecols
Column(s) have been resized
beforeshowcols
Before column(s) have been made visible
showcols
Column(s) have been made visible

actions: row

beforedeleterows
BEFORE Row(s) have been deleted
deleterows
Row(s) have been deleted.
beforefreezerows
Before row(s) have been frozen
freezerows
Row(s) have been frozen
beforehiderows
Before row(s) have been hidden
hiderows
Row(s) have been hidden
beforeinsertemptyrows
BEFORE Empty Row(s) have been inserted.
insertemptyrows
Empty Row(s) have been inserted.
beforemoverows
BEFORE Row(s) have been moved
moverows
Rows(s) have been moved
beforeshowrows
Before row(s) have been made visible
showrows
Row(s) have been made visible

actions: sort

beforesort
Before sort action
sort
Sort action

context-menu

contextmenuclose
Context Menu has been closed.
contextmenuopen
Context Menu has been opened.

fullscreen

fullscreenenter
Leaving fullscreen
fullscreenleave
Leaving fullscreen

instance

interactionmodechange
ids
Required
Only argument of deleteRowsById method
• Array.rowid
Playground

Coming Soon

DataGridXL Playground

Try out the full DataGridXL API right here on this page!