DataGridXL — API

Classes

CellSelector

Class

Overview

This is an overview of the class.

Used by:

DataGridXLEditor
instance.cellSelector

Options

javascript
undefined

Methods

javascript
undefined

Items

addCellRangeToSelection

(cellRange)

Adds cell range to selection

addColRangeToSelection

(colRange)

Adds column range to selection

addRowRangeToSelection

(rowRange)

Adds row range to selection

bindToSheet

(sheet)

Binds cell selector to sheet instance

clear

()

Clear selection

disable

()

Disable CellSelector

getActiveSelectionRange

()

Get active selection range

getCellCursorPosition

()

Get cell cursor position

getColTypeSelectionRanges

([colCoord])

Get selection ranges of type "col" Pass a column coordinate to only return selection ranges that span the given column

getRowTypeSelectionRanges

([rowCoord])

Get selection ranges of type "row" Pass a row coordinate to only return selection ranges that span the given row

getSelectedColRanges

()

Get all column ranges

getSelectedRowRanges

()

Get all row ranges

getSelection

()

Get selection

getState

()

Get object with { selection, cellCursorPosition, activeRangeIndex }

isCellSelected

(cellCoords)

Check if cell is selected

isColSelected

(colCoord)

Check if column is selected

isRowSelected

(rowCoord)

Check if row is selected

isSet

()

Checks if selector is set

modifyActiveSelectionRange

(direction)

Modifies (expands or shrinks) active selection range in given direction

moveCellCursor

(mutationCoords)

Moves cell cursor by {x,y} mutation

moveCellCursorAroundSelection

(mutationCoords)

Moves cell cursor by {x,y} mutation

moveCellCursorToColEnd

()

Move cell cursor to column end

moveCellCursorToColStart

()

Move cell cursor to column start

moveCellCursorToRowEnd

()

Move cell cursor to row end

moveCellCursorToRowStart

()

Move cell cursor to row start

moveCellCursorToSheetEnd

()

Move cell cursor to sheet end

moveCellCursorToSheetStart

()

Move cell cursor to sheet start

selectAll

([cellCursorPosition])

Select all cells

selectCol

(colCoord)

Select a single column

selectRow

(rowCoord)

Select a single row

setCellCursorPosition

(cellCoords)

Move cell cursor to given position

setCellRangeExtreme

(cellCoords,[keepMultiSelection])

Set extreme of cell range to given cell coords

setColRangeExtreme

(colCoord,[keepMultiSelection])

Set extreme of column range to given column coordinate

setRowRangeExtreme

(rowCoord,[keepMultiSelection])

Set extreme of row range to given row coordinate

setState

(state)

Set object with { selection, cellCursorPosition, activeRangeIndex }

Events

javascript
undefined

Items

beforechange

change