excel.interfaces.worksheetdata.yml

### YamlMime:TSType
name: Excel.Interfaces.WorksheetData
uid: 'excel!Excel.Interfaces.WorksheetData:interface'
package: excel!
fullName: Excel.Interfaces.WorksheetData
summary: An interface describing the data returned by calling `worksheet.toJSON()`<!-- -->.
remarks: ''
isPreview: false
isDeprecated: false
type: interface
properties:
  - name: autoFilter
    uid: 'excel!Excel.Interfaces.WorksheetData#autoFilter:member'
    package: excel!
    fullName: autoFilter
    summary: Represents the `AutoFilter` object of the worksheet.
    remarks: '\[ [API set: ExcelApi 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
    isPreview: false
    isDeprecated: false
    syntax:
      content: 'autoFilter?: Excel.Interfaces.AutoFilterData;'
      return:
        type: '<xref uid="excel!Excel.Interfaces.AutoFilterData:interface" />'
  - name: charts
    uid: 'excel!Excel.Interfaces.WorksheetData#charts:member'
    package: excel!
    fullName: charts
    summary: Returns a collection of charts that are part of the worksheet.
    remarks: '\[ [API set: ExcelApi 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
    isPreview: false
    isDeprecated: false
    syntax:
      content: 'charts?: Excel.Interfaces.ChartData[];'
      return:
        type: '<xref uid="excel!Excel.Interfaces.ChartData:interface" />[]'
  - name: comments
    uid: 'excel!Excel.Interfaces.WorksheetData#comments:member'
    package: excel!
    fullName: comments
    summary: Returns a collection of all the Comments objects on the worksheet.
    remarks: '\[ [API set: ExcelApi 1.10](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
    isPreview: false
    isDeprecated: false
    syntax:
      content: 'comments?: Excel.Interfaces.CommentData[];'
      return:
        type: '<xref uid="excel!Excel.Interfaces.CommentData:interface" />[]'
  - name: customProperties
    uid: 'excel!Excel.Interfaces.WorksheetData#customProperties:member'
    package: excel!
    fullName: customProperties
    summary: Gets a collection of worksheet-level custom properties.
    remarks: '\[ [API set: ExcelApi 1.12](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
    isPreview: false
    isDeprecated: false
    syntax:
      content: 'customProperties?: Excel.Interfaces.WorksheetCustomPropertyData[];'
      return:
        type: '<xref uid="excel!Excel.Interfaces.WorksheetCustomPropertyData:interface" />[]'
  - name: enableCalculation
    uid: 'excel!Excel.Interfaces.WorksheetData#enableCalculation:member'
    package: excel!
    fullName: enableCalculation
    summary: >-
      Determines if Excel should recalculate the worksheet when necessary. True if Excel recalculates the worksheet when
      necessary. False if Excel doesn't recalculate the sheet.
    remarks: '\[ [API set: ExcelApi 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
    isPreview: false
    isDeprecated: false
    syntax:
      content: 'enableCalculation?: boolean;'
      return:
        type: boolean
  - name: horizontalPageBreaks
    uid: 'excel!Excel.Interfaces.WorksheetData#horizontalPageBreaks:member'
    package: excel!
    fullName: horizontalPageBreaks
    summary: Gets the horizontal page break collection for the worksheet. This collection only contains manual page breaks.
    remarks: '\[ [API set: ExcelApi 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
    isPreview: false
    isDeprecated: false
    syntax:
      content: 'horizontalPageBreaks?: Excel.Interfaces.PageBreakData[];'
      return:
        type: '<xref uid="excel!Excel.Interfaces.PageBreakData:interface" />[]'
  - name: id
    uid: 'excel!Excel.Interfaces.WorksheetData#id:member'
    package: excel!
    fullName: id
    summary: >-
      Returns a value that uniquely identifies the worksheet in a given workbook. The value of the identifier remains
      the same even when the worksheet is renamed or moved.
    remarks: '\[ [API set: ExcelApi 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
    isPreview: false
    isDeprecated: false
    syntax:
      content: 'id?: string;'
      return:
        type: string
  - name: name
    uid: 'excel!Excel.Interfaces.WorksheetData#name:member'
    package: excel!
    fullName: name
    summary: The display name of the worksheet. The name must be fewer than 32 characters.
    remarks: '\[ [API set: ExcelApi 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
    isPreview: false
    isDeprecated: false
    syntax:
      content: 'name?: string;'
      return:
        type: string
  - name: names
    uid: 'excel!Excel.Interfaces.WorksheetData#names:member'
    package: excel!
    fullName: names
    summary: Collection of names scoped to the current worksheet.
    remarks: '\[ [API set: ExcelApi 1.4](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
    isPreview: false
    isDeprecated: false
    syntax:
      content: 'names?: Excel.Interfaces.NamedItemData[];'
      return:
        type: '<xref uid="excel!Excel.Interfaces.NamedItemData:interface" />[]'
  - name: pageLayout
    uid: 'excel!Excel.Interfaces.WorksheetData#pageLayout:member'
    package: excel!
    fullName: pageLayout
    summary: Gets the `PageLayout` object of the worksheet.
    remarks: '\[ [API set: ExcelApi 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
    isPreview: false
    isDeprecated: false
    syntax:
      content: 'pageLayout?: Excel.Interfaces.PageLayoutData;'
      return:
        type: '<xref uid="excel!Excel.Interfaces.PageLayoutData:interface" />'
  - name: pivotTables
    uid: 'excel!Excel.Interfaces.WorksheetData#pivotTables:member'
    package: excel!
    fullName: pivotTables
    summary: Collection of PivotTables that are part of the worksheet.
    remarks: '\[ [API set: ExcelApi 1.3](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
    isPreview: false
    isDeprecated: false
    syntax:
      content: 'pivotTables?: Excel.Interfaces.PivotTableData[];'
      return:
        type: '<xref uid="excel!Excel.Interfaces.PivotTableData:interface" />[]'
  - name: position
    uid: 'excel!Excel.Interfaces.WorksheetData#position:member'
    package: excel!
    fullName: position
    summary: The zero-based position of the worksheet within the workbook.
    remarks: '\[ [API set: ExcelApi 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
    isPreview: false
    isDeprecated: false
    syntax:
      content: 'position?: number;'
      return:
        type: number
  - name: protection
    uid: 'excel!Excel.Interfaces.WorksheetData#protection:member'
    package: excel!
    fullName: protection
    summary: Returns the sheet protection object for a worksheet.
    remarks: '\[ [API set: ExcelApi 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
    isPreview: false
    isDeprecated: false
    syntax:
      content: 'protection?: Excel.Interfaces.WorksheetProtectionData;'
      return:
        type: '<xref uid="excel!Excel.Interfaces.WorksheetProtectionData:interface" />'
  - name: shapes
    uid: 'excel!Excel.Interfaces.WorksheetData#shapes:member'
    package: excel!
    fullName: shapes
    summary: Returns the collection of all the Shape objects on the worksheet.
    remarks: '\[ [API set: ExcelApi 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
    isPreview: false
    isDeprecated: false
    syntax:
      content: 'shapes?: Excel.Interfaces.ShapeData[];'
      return:
        type: '<xref uid="excel!Excel.Interfaces.ShapeData:interface" />[]'
  - name: showGridlines
    uid: 'excel!Excel.Interfaces.WorksheetData#showGridlines:member'
    package: excel!
    fullName: showGridlines
    summary: Specifies if gridlines are visible to the user.
    remarks: '\[ [API set: ExcelApi 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
    isPreview: false
    isDeprecated: false
    syntax:
      content: 'showGridlines?: boolean;'
      return:
        type: boolean
  - name: showHeadings
    uid: 'excel!Excel.Interfaces.WorksheetData#showHeadings:member'
    package: excel!
    fullName: showHeadings
    summary: Specifies if headings are visible to the user.
    remarks: '\[ [API set: ExcelApi 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
    isPreview: false
    isDeprecated: false
    syntax:
      content: 'showHeadings?: boolean;'
      return:
        type: boolean
  - name: slicers
    uid: 'excel!Excel.Interfaces.WorksheetData#slicers:member'
    package: excel!
    fullName: slicers
    summary: Returns a collection of slicers that are part of the worksheet.
    remarks: '\[ [API set: ExcelApi 1.10](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
    isPreview: false
    isDeprecated: false
    syntax:
      content: 'slicers?: Excel.Interfaces.SlicerData[];'
      return:
        type: '<xref uid="excel!Excel.Interfaces.SlicerData:interface" />[]'
  - name: standardHeight
    uid: 'excel!Excel.Interfaces.WorksheetData#standardHeight:member'
    package: excel!
    fullName: standardHeight
    summary: 'Returns the standard (default) height of all the rows in the worksheet, in points.'
    remarks: '\[ [API set: ExcelApi 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
    isPreview: false
    isDeprecated: false
    syntax:
      content: 'standardHeight?: number;'
      return:
        type: number
  - name: standardWidth
    uid: 'excel!Excel.Interfaces.WorksheetData#standardWidth:member'
    package: excel!
    fullName: standardWidth
    summary: >-
      Specifies the standard (default) width of all the columns in the worksheet. One unit of column width is equal to
      the width of one character in the Normal style. For proportional fonts, the width of the character 0 (zero) is
      used.
    remarks: '\[ [API set: ExcelApi 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
    isPreview: false
    isDeprecated: false
    syntax:
      content: 'standardWidth?: number;'
      return:
        type: number
  - name: tabColor
    uid: 'excel!Excel.Interfaces.WorksheetData#tabColor:member'
    package: excel!
    fullName: tabColor
    summary: >-
      The tab color of the worksheet. When retrieving the tab color, if the worksheet is invisible, the value will be
      `null`<!-- -->. If the worksheet is visible but the tab color is set to auto, an empty string will be returned.
      Otherwise, the property will be set to a color, in the form \#RRGGBB (e.g., "FFA500"). When setting the color, use
      an empty-string to set an "auto" color, or a real color otherwise.
    remarks: '\[ [API set: ExcelApi 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
    isPreview: false
    isDeprecated: false
    syntax:
      content: 'tabColor?: string;'
      return:
        type: string
  - name: tables
    uid: 'excel!Excel.Interfaces.WorksheetData#tables:member'
    package: excel!
    fullName: tables
    summary: Collection of tables that are part of the worksheet.
    remarks: '\[ [API set: ExcelApi 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
    isPreview: false
    isDeprecated: false
    syntax:
      content: 'tables?: Excel.Interfaces.TableData[];'
      return:
        type: '<xref uid="excel!Excel.Interfaces.TableData:interface" />[]'
  - name: verticalPageBreaks
    uid: 'excel!Excel.Interfaces.WorksheetData#verticalPageBreaks:member'
    package: excel!
    fullName: verticalPageBreaks
    summary: Gets the vertical page break collection for the worksheet. This collection only contains manual page breaks.
    remarks: '\[ [API set: ExcelApi 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
    isPreview: false
    isDeprecated: false
    syntax:
      content: 'verticalPageBreaks?: Excel.Interfaces.PageBreakData[];'
      return:
        type: '<xref uid="excel!Excel.Interfaces.PageBreakData:interface" />[]'
  - name: visibility
    uid: 'excel!Excel.Interfaces.WorksheetData#visibility:member'
    package: excel!
    fullName: visibility
    summary: The visibility of the worksheet.
    remarks: >-
      \[ [API set: ExcelApi 1.1 for reading visibility; 1.2 for setting
      it.](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]
    isPreview: false
    isDeprecated: false
    syntax:
      content: 'visibility?: Excel.SheetVisibility | "Visible" | "Hidden" | "VeryHidden";'
      return:
        type: '<xref uid="excel!Excel.SheetVisibility:enum" /> | "Visible" | "Hidden" | "VeryHidden"'