excel.interfaces.worksheetupdatedata.yml

### YamlMime:TSType
name: Excel.Interfaces.WorksheetUpdateData
uid: 'excel!Excel.Interfaces.WorksheetUpdateData:interface'
package: excel!
fullName: Excel.Interfaces.WorksheetUpdateData
summary: 'An interface for updating data on the Worksheet object, for use in `worksheet.set({ ... })`<!-- -->.'
remarks: ''
isPreview: false
isDeprecated: false
type: interface
properties:
  - name: enableCalculation
    uid: 'excel!Excel.Interfaces.WorksheetUpdateData#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: name
    uid: 'excel!Excel.Interfaces.WorksheetUpdateData#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: pageLayout
    uid: 'excel!Excel.Interfaces.WorksheetUpdateData#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.PageLayoutUpdateData;'
      return:
        type: '<xref uid="excel!Excel.Interfaces.PageLayoutUpdateData:interface" />'
  - name: position
    uid: 'excel!Excel.Interfaces.WorksheetUpdateData#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: showGridlines
    uid: 'excel!Excel.Interfaces.WorksheetUpdateData#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.WorksheetUpdateData#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: standardWidth
    uid: 'excel!Excel.Interfaces.WorksheetUpdateData#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.WorksheetUpdateData#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: visibility
    uid: 'excel!Excel.Interfaces.WorksheetUpdateData#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"'