Excel.Interfaces.RangeViewData interface
An interface describing the data returned by calling rangeView.toJSON()
.
Properties
cell |
Represents the cell addresses of the |
column |
The number of visible columns. |
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. |
index | Returns a value that represents the index of the |
number |
Represents Excel's number format code for the given cell. |
row |
The number of visible rows. |
rows | Represents a collection of range views associated with the range. |
text | Text values of the specified range. The text value will not depend on the cell width. The # sign substitution that happens in Excel UI will not affect the text value returned by the API. |
values | Represents the raw values of the specified range view. The data returned could be of type string, number, or a boolean. Cells that contain an error will return the error string. |
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 |
Represents the type of data of each cell. |
Property Details
cellAddresses
Represents the cell addresses of the RangeView
.
cellAddresses?: any[][];
Property Value
any[][]
Remarks
columnCount
The number of visible columns.
columnCount?: number;
Property Value
number
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
index
Returns a value that represents the index of the RangeView
.
index?: number;
Property Value
number
Remarks
numberFormat
Represents Excel's number format code for the given cell.
numberFormat?: any[][];
Property Value
any[][]
Remarks
rowCount
The number of visible rows.
rowCount?: number;
Property Value
number
Remarks
rows
Represents a collection of range views associated with the range.
rows?: Excel.Interfaces.RangeViewData[];
Property Value
Remarks
text
Text values of the specified range. The text value will not depend on the cell width. The # sign substitution that happens in Excel UI will not affect the text value returned by the API.
text?: string[][];
Property Value
string[][]
Remarks
values
Represents the raw values of the specified range view. The data returned could be of type string, number, or a boolean. Cells that contain an error will return the error string.
values?: any[][];
Property Value
any[][]
Remarks
valuesAsJson
A JSON representation of the values in the cells in this range. Unlike RangeView.values
, RangeView.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 RangeView.valuesAsJsonLocal
.
valuesAsJson?: CellValue[][];
Property Value
Excel.CellValue[][]
Remarks
valuesAsJsonLocal
A JSON representation of the values in the cells in this range. Unlike RangeView.values
, RangeView.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 RangeView.valuesAsJson
.
valuesAsJsonLocal?: CellValue[][];
Property Value
Excel.CellValue[][]
Remarks
valueTypes
Represents the type of data of each cell.
valueTypes?: Excel.RangeValueType[][];
Property Value
Remarks
Office Add-ins