Learn how to deal programmatically with worksheets. Click here to see a working example.


Available initialization properties.

tabsShow tabs and allow the user to create new worksheets. Default: false
worksheetNameWorksheet title. Default: Sheet {number}
allowDeleteWorksheetAdd a delete worksheet option to the contextMenu. Default: true
allowRenameWorksheetAdd a rename worksheet option to the contextMenu. Default: true
allowMoveWorksheetAllow worksheet drag and drop options. Default: true


Available methods to interact programmatically with the worksheets.

createWorksheet(object)Create a new table worksheet based on a given configuration.
createWorksheet(configuration: object)
getWorksheet(object)Get the worksheet position based on a table instance.
getWorksheet(instance: object) => number
openWorksheet(number)Set worksheet as active by worksheetNumber starting in zero.
openWorksheet(worksheetNumber: number)
renameWorksheet(number, string)Change a worksheet title.
renameWorksheet(worksheetNumber: number, worksheetName: string)
deleteWorksheet(number)Delete worksheet.
deleteWorksheet(worksheetNumber: number)

Available events

The worksheet available events.

onbeforecreateworksheetBefore create a new worksheet, should return the configuration of the new table
oncreateworksheetWhen a new worksheet is created
onrenameworksheetwhen a worksheet is renamed
ondeleteworksheetWhen a worksheet is deleted
onmoveworksheetWhen a worksheet position is changed