DataGridXL — API

Integration

Types

NOTE: DataGridXL is written in JavaScript. We are aiming to offer full type coverage across our entire API to better support our TypeScript users.

CellCoords

object

Cell Coordinates

{
  x ColCoord,
  y RowCoord
}

CellRange

object

Range of Cells

{
  from CellCoords,
  to CellCoords
}

CellRangeCollection

array

(CellRange)

Collection of Cell Ranges

[CellRange, ...]

CellValue

string|number|boolean

Cell Value

ColCoord

number

Column Coordinate

ColId

number

Column Id

ColIndex

number

Column Index

ColRange

object

Range of Columns

{
  from ColCoord,
  to ColCoord
}

ColRangeCollection

array

(ColRange)

Collection of Column Ranges

[ColRange, ...]

ContextMenuItem

object

Item inside of context menu

{
  label string,
  method function,
  shortcutLabel string,
  shortcutLabelMac string
}

RangeOfCellValues

Array

Range of Cell Values

RowCoord

number

Row Coordinate

RowId

number

Row Id

RowIndex

number

Row Index

RowRange

object

Range of Rows

{
  from RowCoord,
  to RowCoord
}

RowRangeCollection

array

(RowRange)

Collection of Row Ranges

[RowRange, ...]

SelectionRange

object

Selection Range

{
  range CellRange,
  type ('cell'|'col'|'row')
}

Theme

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
}