Excel.Interfaces.RangeData interface
An interface describing the data returned by calling range.toJSON().
Properties
| address | Specifies the range reference in A1-style. Address value contains the sheet reference (e.g., "Sheet1!A1:B4"). |
| address |
Represents the range reference for the specified range in the language of the user. |
| cell |
Specifies the number of cells in the range. This API will return -1 if the cell count exceeds 2^31-1 (2,147,483,647). |
| column |
Specifies the total number of columns in the range. |
| column |
Represents if all columns in the current range are hidden. Value is |
| column |
Specifies the column number of the first cell in the range. Zero-indexed. |
| conditional |
The collection of |
| data |
Returns a data validation object. |
| format | Returns a format object, encapsulating the range's font, fill, borders, alignment, and other properties. |
| formulas | Represents the formula in A1-style notation. If a cell has no formula, its value is returned instead. |
| formulas |
Represents the formula in A1-style notation, in the user's language and number-formatting locale. For example, the English "=SUM(A1, 1.5)" formula would become "=SUMME(A1; 1,5)" in German. If a cell has no formula, its value is returned instead. |
| formulasR1C1 | Represents the formula in R1C1-style notation. If a cell has no formula, its value is returned instead. |
| has |
Represents if all cells have a spill border. Returns |
| height | Returns the distance in points, for 100% zoom, from the top edge of the range to the bottom edge of the range. |
| hidden | Represents if all cells in the current range are hidden. Value is |
| hyperlink | Represents the hyperlink for the current range. |
| is |
Represents if the current range is an entire column. |
| is |
Represents if the current range is an entire row. |
| left | Returns the distance in points, for 100% zoom, from the left edge of the worksheet to the left edge of the range. |
| linked |
Represents the data type state of each cell. |
| number |
Represents Excel's number format code for the given range. For more information about Excel number formatting, see Number format codes. |
| number |
Represents the category of number format of each cell. |
| number |
Represents Excel's number format code for the given range, based on the language settings of the user. Excel does not perform any language or format coercion when getting or setting the |
| row |
Returns the total number of rows in the range. |
| row |
Represents if all rows in the current range are hidden. Value is |
| row |
Returns the row number of the first cell in the range. Zero-indexed. |
| saved |
Represents if all the cells would be saved as an array formula. Returns |
| style | Represents the style of the current range. If the styles of the cells are inconsistent, |
| text | Text values of the specified range. The text value will not depend on the cell width. The number sign (#) substitution that happens in the Excel UI will not affect the text value returned by the API. |
| top | Returns the distance in points, for 100% zoom, from the top edge of the worksheet to the top edge of the range. |
| values | Represents the raw values of the specified range. The data returned could be a string, number, or boolean. Cells that contain an error will return the error string. If the returned value starts with a plus ("+"), minus ("-"), or equal sign ("="), Excel interprets this value as a formula. |
| values |
A JSON representation of the values in the cells in this range. Unlike |
| values |
A JSON representation of the values in the cells in this range. Unlike |
| value |
Specifies the type of data in each cell. |
| width | Returns the distance in points, for 100% zoom, from the left edge of the range to the right edge of the range. |
Property Details
address
Specifies the range reference in A1-style. Address value contains the sheet reference (e.g., "Sheet1!A1:B4").
address?: string;Property Value
string
Remarks
addressLocal
Represents the range reference for the specified range in the language of the user.
addressLocal?: string;Property Value
string
Remarks
cellCount
Specifies the number of cells in the range. This API will return -1 if the cell count exceeds 2^31-1 (2,147,483,647).
cellCount?: number;Property Value
number
Remarks
columnCount
Specifies the total number of columns in the range.
columnCount?: number;Property Value
number
Remarks
columnHidden
Represents if all columns in the current range are hidden. Value is true when all columns in a range are hidden. Value is false when no columns in the range are hidden. Value is null when some columns in a range are hidden and other columns in the same range are not hidden.
columnHidden?: boolean;Property Value
boolean
Remarks
columnIndex
Specifies the column number of the first cell in the range. Zero-indexed.
columnIndex?: number;Property Value
number
Remarks
conditionalFormats
The collection of ConditionalFormats that intersect the range.
conditionalFormats?: Excel.Interfaces.ConditionalFormatData[];Property Value
Remarks
dataValidation
Returns a data validation object.
dataValidation?: Excel.Interfaces.DataValidationData;Property Value
Remarks
format
Returns a format object, encapsulating the range's font, fill, borders, alignment, and other properties.
format?: Excel.Interfaces.RangeFormatData;Property Value
Remarks
formulas
Represents the formula in A1-style notation. If a cell has no formula, its value is returned instead.
formulas?: any[][];Property Value
any[][]
Remarks
formulasLocal
Represents the formula in A1-style notation, in the user's language and number-formatting locale. For example, the English "=SUM(A1, 1.5)" formula would become "=SUMME(A1; 1,5)" in German. If a cell has no formula, its value is returned instead.
formulasLocal?: any[][];Property Value
any[][]
Remarks
formulasR1C1
Represents the formula in R1C1-style notation. If a cell has no formula, its value is returned instead.
formulasR1C1?: any[][];Property Value
any[][]
Remarks
hasSpill
Represents if all cells have a spill border. Returns true if all cells have a spill border, or false if all cells do not have a spill border. Returns null if there are cells both with and without spill borders within the range.
hasSpill?: boolean;Property Value
boolean
Remarks
height
Returns the distance in points, for 100% zoom, from the top edge of the range to the bottom edge of the range.
height?: number;Property Value
number
Remarks
hidden
Represents if all cells in the current range are hidden. Value is true when all cells in a range are hidden. Value is false when no cells in the range are hidden. Value is null when some cells in a range are hidden and other cells in the same range are not hidden.
hidden?: boolean;Property Value
boolean
Remarks
hyperlink
Represents the hyperlink for the current range.
hyperlink?: Excel.RangeHyperlink;Property Value
Remarks
isEntireColumn
Represents if the current range is an entire column.
isEntireColumn?: boolean;Property Value
boolean
Remarks
isEntireRow
Represents if the current range is an entire row.
isEntireRow?: boolean;Property Value
boolean
Remarks
left
Returns the distance in points, for 100% zoom, from the left edge of the worksheet to the left edge of the range.
left?: number;Property Value
number
Remarks
linkedDataTypeState
Represents the data type state of each cell.
linkedDataTypeState?: Excel.LinkedDataTypeState[][];Property Value
Remarks
numberFormat
Represents Excel's number format code for the given range. For more information about Excel number formatting, see Number format codes.
numberFormat?: any[][];Property Value
any[][]
Remarks
numberFormatCategories
Represents the category of number format of each cell.
numberFormatCategories?: Excel.NumberFormatCategory[][];Property Value
Remarks
numberFormatLocal
Represents Excel's number format code for the given range, based on the language settings of the user. Excel does not perform any language or format coercion when getting or setting the numberFormatLocal property. Any returned text uses the locally-formatted strings based on the language specified in the system settings.
numberFormatLocal?: any[][];Property Value
any[][]
Remarks
rowCount
Returns the total number of rows in the range.
rowCount?: number;Property Value
number
Remarks
rowHidden
Represents if all rows in the current range are hidden. Value is true when all rows in a range are hidden. Value is false when no rows in the range are hidden. Value is null when some rows in a range are hidden and other rows in the same range are not hidden.
rowHidden?: boolean;Property Value
boolean
Remarks
rowIndex
Returns the row number of the first cell in the range. Zero-indexed.
rowIndex?: number;Property Value
number
Remarks
savedAsArray
Represents if all the cells would be saved as an array formula. Returns true if all cells would be saved as an array formula, or false if all cells would not be saved as an array formula. Returns null if some cells would be saved as an array formula and some would not be.
savedAsArray?: boolean;Property Value
boolean
Remarks
style
Represents the style of the current range. If the styles of the cells are inconsistent, null will be returned. For custom styles, the style name will be returned. For built-in styles, a string representing a value in the BuiltInStyle enum will be returned.
style?: string;Property Value
string
Remarks
text
Text values of the specified range. The text value will not depend on the cell width. The number sign (#) substitution that happens in the Excel UI will not affect the text value returned by the API.
text?: string[][];Property Value
string[][]
Remarks
top
Returns the distance in points, for 100% zoom, from the top edge of the worksheet to the top edge of the range.
top?: number;Property Value
number
Remarks
values
Represents the raw values of the specified range. The data returned could be a string, number, or boolean. Cells that contain an error will return the error string. If the returned value starts with a plus ("+"), minus ("-"), or equal sign ("="), Excel interprets this value as a formula.
values?: any[][];Property Value
any[][]
Remarks
valuesAsJson
A JSON representation of the values in the cells in this range. Unlike Range.values, Range.valuesAsJson supports all data types which can be in a cell. Examples include formatted number values and web images, in addition to the standard boolean, number, and string values. Data returned from this API always aligns with the en-US locale. To retrieve data in the user's display locale, use Range.valuesAsJsonLocal.
valuesAsJson?: CellValue[][];Property Value
Excel.CellValue[][]
Remarks
valuesAsJsonLocal
A JSON representation of the values in the cells in this range. Unlike Range.values, Range.valuesAsJsonLocal supports all data types which can be in a cell. Examples include formatted number values and web images, in addition to the standard boolean, number, and string values. Data returned from this API always aligns with the user's display locale. To retrieve data independent of locale, use Range.valuesAsJson.
valuesAsJsonLocal?: CellValue[][];Property Value
Excel.CellValue[][]
Remarks
valueTypes
Specifies the type of data in each cell.
valueTypes?: Excel.RangeValueType[][];Property Value
Remarks
width
Returns the distance in points, for 100% zoom, from the left edge of the range to the right edge of the range.
width?: number;Property Value
number
Remarks
Office Add-ins