API
api/

Types

NOTE This is the API for DataGridXL3 (coming soon). For current version 2, visit V2 API
object
Cell Coordinates
object
Range of Cells
{
  from CellCoordsA,
  to CellCoordsB
}
array (CellRange)
Collection of Cell Ranges
string|number|boolean
Cell Value
number
Column Coordinate
number
Column Id
number
Column Index
object
Range of Columns
{
  from ColCoordA,
  to ColCoordB
}
array (ColRange)
Collection of Column Ranges
[ColRange1, ColRange2, ...]
object
Item inside of context menu
{
  label string,
  method function,
  shortcutLabel string,
  shortcutLabelMac string
}
Array
Range of Cell Values
number
Row Coordinate
number
Row Id
number
Row Index
object
Range of Rows
{
  from RowCoordA,
  to RowCoordB
}
array (RowRange)
Collection of Row Ranges
[RowRange1, RowRange2, ...]
object
Selection Range
{
  range CellRange,
  type ('cell'|'col'|'row')
}
object
DataGridXL Theme. Use full HEX strings like "#ffffff" for optimal performance.
{
  fontSize number,
  barHeight number,
  header string,
  header_text string,
  selector string,
  bar string,
  bar_text string,
  viewport string,
  sheet string,
  sheet_text string,
  gridline string,
  gridline_opacity string,
  search string
}
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!