excel.interfaces.rangedata.yml

### YamlMime:TSType
name: Excel.Interfaces.RangeData
uid: 'excel!Excel.Interfaces.RangeData:interface'
package: excel!
fullName: Excel.Interfaces.RangeData
summary: An interface describing the data returned by calling `range.toJSON()`<!-- -->.
remarks: ''
isPreview: false
isDeprecated: false
type: interface
properties:
  - name: address
    uid: 'excel!Excel.Interfaces.RangeData#address:member'
    package: excel!
    fullName: address
    summary: 'Specifies the range reference in A1-style. Address value contains the sheet reference (e.g., "Sheet1!A1:B4").'
    remarks: '\[ [API set: ExcelApi 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
    isPreview: false
    isDeprecated: false
    syntax:
      content: 'address?: string;'
      return:
        type: string
  - name: addressLocal
    uid: 'excel!Excel.Interfaces.RangeData#addressLocal:member'
    package: excel!
    fullName: addressLocal
    summary: Represents the range reference for the specified range in the language of the user.
    remarks: '\[ [API set: ExcelApi 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
    isPreview: false
    isDeprecated: false
    syntax:
      content: 'addressLocal?: string;'
      return:
        type: string
  - name: cellCount
    uid: 'excel!Excel.Interfaces.RangeData#cellCount:member'
    package: excel!
    fullName: cellCount
    summary: >-
      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).
    remarks: '\[ [API set: ExcelApi 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
    isPreview: false
    isDeprecated: false
    syntax:
      content: 'cellCount?: number;'
      return:
        type: number
  - name: columnCount
    uid: 'excel!Excel.Interfaces.RangeData#columnCount:member'
    package: excel!
    fullName: columnCount
    summary: Specifies the total number of columns in the range.
    remarks: '\[ [API set: ExcelApi 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
    isPreview: false
    isDeprecated: false
    syntax:
      content: 'columnCount?: number;'
      return:
        type: number
  - name: columnHidden
    uid: 'excel!Excel.Interfaces.RangeData#columnHidden:member'
    package: excel!
    fullName: columnHidden
    summary: >-
      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.
    remarks: '\[ [API set: ExcelApi 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
    isPreview: false
    isDeprecated: false
    syntax:
      content: 'columnHidden?: boolean;'
      return:
        type: boolean
  - name: columnIndex
    uid: 'excel!Excel.Interfaces.RangeData#columnIndex:member'
    package: excel!
    fullName: columnIndex
    summary: Specifies the column number of the first cell in the range. Zero-indexed.
    remarks: '\[ [API set: ExcelApi 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
    isPreview: false
    isDeprecated: false
    syntax:
      content: 'columnIndex?: number;'
      return:
        type: number
  - name: conditionalFormats
    uid: 'excel!Excel.Interfaces.RangeData#conditionalFormats:member'
    package: excel!
    fullName: conditionalFormats
    summary: The collection of `ConditionalFormats` that intersect the range.
    remarks: '\[ [API set: ExcelApi 1.6](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
    isPreview: false
    isDeprecated: false
    syntax:
      content: 'conditionalFormats?: Excel.Interfaces.ConditionalFormatData[];'
      return:
        type: '<xref uid="excel!Excel.Interfaces.ConditionalFormatData:interface" />[]'
  - name: format
    uid: 'excel!Excel.Interfaces.RangeData#format:member'
    package: excel!
    fullName: format
    summary: 'Returns a format object, encapsulating the range''s font, fill, borders, alignment, and other properties.'
    remarks: '\[ [API set: ExcelApi 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
    isPreview: false
    isDeprecated: false
    syntax:
      content: 'format?: Excel.Interfaces.RangeFormatData;'
      return:
        type: '<xref uid="excel!Excel.Interfaces.RangeFormatData:interface" />'
  - name: formulas
    uid: 'excel!Excel.Interfaces.RangeData#formulas:member'
    package: excel!
    fullName: formulas
    summary: 'Represents the formula in A1-style notation. If a cell has no formula, its value is returned instead.'
    remarks: '\[ [API set: ExcelApi 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
    isPreview: false
    isDeprecated: false
    syntax:
      content: 'formulas?: any[][];'
      return:
        type: 'any[][]'
  - name: formulasLocal
    uid: 'excel!Excel.Interfaces.RangeData#formulasLocal:member'
    package: excel!
    fullName: formulasLocal
    summary: >-
      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.
    remarks: '\[ [API set: ExcelApi 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
    isPreview: false
    isDeprecated: false
    syntax:
      content: 'formulasLocal?: any[][];'
      return:
        type: 'any[][]'
  - name: formulasR1C1
    uid: 'excel!Excel.Interfaces.RangeData#formulasR1C1:member'
    package: excel!
    fullName: formulasR1C1
    summary: 'Represents the formula in R1C1-style notation. If a cell has no formula, its value is returned instead.'
    remarks: '\[ [API set: ExcelApi 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
    isPreview: false
    isDeprecated: false
    syntax:
      content: 'formulasR1C1?: any[][];'
      return:
        type: 'any[][]'
  - name: hidden
    uid: 'excel!Excel.Interfaces.RangeData#hidden:member'
    package: excel!
    fullName: hidden
    summary: >-
      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.
    remarks: '\[ [API set: ExcelApi 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
    isPreview: false
    isDeprecated: false
    syntax:
      content: 'hidden?: boolean;'
      return:
        type: boolean
  - name: numberFormat
    uid: 'excel!Excel.Interfaces.RangeData#numberFormat:member'
    package: excel!
    fullName: numberFormat
    summary: >-
      Represents Excel's number format code for the given range. For more information about Excel number formatting, see
      [Number format
      codes](https://support.microsoft.com/office/number-format-codes-5026bbd6-04bc-48cd-bf33-80f18b4eae68)<!-- -->.
    remarks: '\[ [API set: ExcelApi 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
    isPreview: false
    isDeprecated: false
    syntax:
      content: 'numberFormat?: any[][];'
      return:
        type: 'any[][]'
  - name: rowCount
    uid: 'excel!Excel.Interfaces.RangeData#rowCount:member'
    package: excel!
    fullName: rowCount
    summary: Returns the total number of rows in the range.
    remarks: '\[ [API set: ExcelApi 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
    isPreview: false
    isDeprecated: false
    syntax:
      content: 'rowCount?: number;'
      return:
        type: number
  - name: rowHidden
    uid: 'excel!Excel.Interfaces.RangeData#rowHidden:member'
    package: excel!
    fullName: rowHidden
    summary: >-
      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.
    remarks: '\[ [API set: ExcelApi 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
    isPreview: false
    isDeprecated: false
    syntax:
      content: 'rowHidden?: boolean;'
      return:
        type: boolean
  - name: rowIndex
    uid: 'excel!Excel.Interfaces.RangeData#rowIndex:member'
    package: excel!
    fullName: rowIndex
    summary: Returns the row number of the first cell in the range. Zero-indexed.
    remarks: '\[ [API set: ExcelApi 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
    isPreview: false
    isDeprecated: false
    syntax:
      content: 'rowIndex?: number;'
      return:
        type: number
  - name: text
    uid: 'excel!Excel.Interfaces.RangeData#text:member'
    package: excel!
    fullName: text
    summary: >-
      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.
    remarks: '\[ [API set: ExcelApi 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
    isPreview: false
    isDeprecated: false
    syntax:
      content: 'text?: string[][];'
      return:
        type: 'string[][]'
  - name: values
    uid: 'excel!Excel.Interfaces.RangeData#values:member'
    package: excel!
    fullName: values
    summary: >-
      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.
    remarks: '\[ [API set: ExcelApi 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
    isPreview: false
    isDeprecated: false
    syntax:
      content: 'values?: any[][];'
      return:
        type: 'any[][]'
  - name: valueTypes
    uid: 'excel!Excel.Interfaces.RangeData#valueTypes:member'
    package: excel!
    fullName: valueTypes
    summary: Specifies the type of data in each cell.
    remarks: '\[ [API set: ExcelApi 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
    isPreview: false
    isDeprecated: false
    syntax:
      content: 'valueTypes?: Excel.RangeValueType[][];'
      return:
        type: '<xref uid="excel!Excel.RangeValueType:enum" />[][]'