DataGridXL — API

Classes

Sheet

Class

Overview

This is an overview of the class.

Used by:

DataGridXLEditor
instance.sheet

Options

javascript
undefined

Methods

javascript
undefined

Items

deleteCols

(ids)

Delete columns by their IDs

deleteRows

(ids)

Delete rows by their IDs

getCellRangeData

(cellRange)

Get cell range data as 2D array

getCellRangeText

(cellRange)

Get cell range data as TSV

getColCoordById

(colId)

Get column coordinate by column ID

getColCoordList

()

Get list of IDs according to coordinates

getColHeaderText

()

getColIdByCoord

()

Get column ID by column coordinate

getColIdByIndex

()

Get column ID by column index

getColIdFromCellRange

()

[todo] Get column IDs from cell range

getColIdsFromState

()

Get column ids from state

getColIndexByCoord

(coord)

Get column index by column coordinate

getColIndexById

(colId)

Get column index by column ID

getCoordBounds

()

Get coordinate bounds {top, right, bottom, left}

getFilterState

()

getIdsFromCols

(cols)

Get column IDs from cols

getIdsFromRows

(rows)

Get column IDs from rows

getLastColCoord

()

Get last column coordinate

getLastColIndex

()

Get last column index

getLastRowCoord

()

Get last row coordinate

getLastRowIndex

()

Get last row index

getRowCoordById

(rowId)

Get row coordinate by row ID

getRowCoordList

()

Get list of IDs according to coordinates

getRowHeaderText

()

getRowIdByCoord

(rowCoord)

Get row ID by row coordinate

getRowIdByIndex

()

Get row ID by row index

getRowIdsFromCellRange

()

[todo] Get row IDs from cell range

getRowIndexByCoord

(coord)

Get row index by row coordinate

getRowIndexById

(rowId)

Get row index by row ID

getSortState

()

hideCols

(ids)

Hide columns by their IDs

hideRows

(ids)

Hide rows by their IDs

insertCols

(ids,index)

insertColsUsingInstructions

(insertInstructions)

insertRows

(ids,index)

insertRowsUsingInstructions

(insertInstructions)

isFilterStateActive

()

WIPis filter state active

isSortStateActive

()

WIPis sort state active

isViewStateActive

()

WIPis view state active

moveColsUsingInstructions

(moveInstructions)

moveRowsUsingInstructions

(moveInstructions)

setFilterState

(filterState)

setSectionDividerX

(id)

Sets section divider X

setSectionDividerY

(id)

Sets section divider Y

setSortState

(sortState)

showCols

()

showCols

showRows

()

showRows

sortUsingInstructions

()

Sort using instructions

update

()

Call to trigger changedocument event

Events

javascript
undefined

Items

changedocument

WIPchangefilterstate

changesortstate