API REFERENCE
getCanonicalRanges
Reads current selection as normalized ranges including stable row and column IDs.
What does this API do?
Reads current selection as normalized ranges including stable row and column IDs.
API for Pro features: Cell range selection
Exact input and result types
getCanonicalRanges(): Promise<SyGridCanonicalRange[]>| Arguments | Required | Type |
|---|
The return type is Promise<SyGridCanonicalRange[]>.
Usage flow
After registering and initializing the Grid element, call grid.getCanonicalRanges(…). Read the return value with await. For methods returning a boolean or report, inspect the result before continuing.
Read related types
Feature explanations and examples
- Cell range selection
A cell range is a rectangle spanning rows and columns. It defines the scope for copying, pasting, filling, and chart creation; selecting it does not change values.