@kanunilabs/datagrid-react / RangeApi
Interface: RangeApi
Range API that keeps React in sync (see the wrapper in the hook).
Methods
add()
add(
row,column):void
Begin another range and keep the selected ones (Ctrl/Cmd+click or drag, G-SEL-01).
Parameters
row
number
column
number
Returns
void
clear()
clear():
void
Returns
void
contains()
contains(
row,column):boolean
Parameters
row
number
column
number
Returns
boolean
extend()
extend(
row,column):void
Parameters
row
number
column
number
Returns
void
finish()
finish():
void
Returns
void
fullColumns()
fullColumns(
rowCount):Set<number>
The column indexes some range covers from the first row to the last.
Parameters
rowCount
number
Returns
Set<number>
getBounds()
getBounds():
RangeBounds|null
Returns
RangeBounds | null
getRange()
getRange():
CellRange|null
Returns
CellRange | null
isAnchor()
isAnchor(
row,column):boolean
Parameters
row
number
column
number
Returns
boolean
selectColumn()
selectColumn(
column,rowCount,mode):boolean
Select a whole column (G-SEL-02); false when there are no rows.
Parameters
column
number
rowCount
number
mode
ColumnSelectMode
Returns
boolean
start()
start(
row,column):void
Parameters
row
number
column
number
Returns
void
toTsv()
toTsv(
textAt):string
TSV for the selected rectangle; textAt supplies each cell's text.
Parameters
textAt
(row, column) => string
Returns
string