excel.interfaces.styledata.yml

### YamlMime:TSType
name: Excel.Interfaces.StyleData
uid: 'excel!Excel.Interfaces.StyleData:interface'
package: excel!
fullName: Excel.Interfaces.StyleData
summary: An interface describing the data returned by calling `style.toJSON()`<!-- -->.
remarks: ''
isPreview: false
isDeprecated: false
type: interface
properties:
  - name: autoIndent
    uid: 'excel!Excel.Interfaces.StyleData#autoIndent:member'
    package: excel!
    fullName: autoIndent
    summary: Specifies if text is automatically indented when the text alignment in a cell is set to equal distribution.
    remarks: '\[ [API set: ExcelApi 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
    isPreview: false
    isDeprecated: false
    syntax:
      content: 'autoIndent?: boolean;'
      return:
        type: boolean
  - name: borders
    uid: 'excel!Excel.Interfaces.StyleData#borders:member'
    package: excel!
    fullName: borders
    summary: A collection of four border objects that represent the style of the four borders.
    remarks: '\[ [API set: ExcelApi 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
    isPreview: false
    isDeprecated: false
    syntax:
      content: 'borders?: Excel.Interfaces.RangeBorderData[];'
      return:
        type: '<xref uid="excel!Excel.Interfaces.RangeBorderData:interface" />[]'
  - name: builtIn
    uid: 'excel!Excel.Interfaces.StyleData#builtIn:member'
    package: excel!
    fullName: builtIn
    summary: Specifies if the style is a built-in style.
    remarks: '\[ [API set: ExcelApi 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
    isPreview: false
    isDeprecated: false
    syntax:
      content: 'builtIn?: boolean;'
      return:
        type: boolean
  - name: fill
    uid: 'excel!Excel.Interfaces.StyleData#fill:member'
    package: excel!
    fullName: fill
    summary: The fill of the style.
    remarks: '\[ [API set: ExcelApi 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
    isPreview: false
    isDeprecated: false
    syntax:
      content: 'fill?: Excel.Interfaces.RangeFillData;'
      return:
        type: '<xref uid="excel!Excel.Interfaces.RangeFillData:interface" />'
  - name: font
    uid: 'excel!Excel.Interfaces.StyleData#font:member'
    package: excel!
    fullName: font
    summary: A `Font` object that represents the font of the style.
    remarks: '\[ [API set: ExcelApi 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
    isPreview: false
    isDeprecated: false
    syntax:
      content: 'font?: Excel.Interfaces.RangeFontData;'
      return:
        type: '<xref uid="excel!Excel.Interfaces.RangeFontData:interface" />'
  - name: formulaHidden
    uid: 'excel!Excel.Interfaces.StyleData#formulaHidden:member'
    package: excel!
    fullName: formulaHidden
    summary: Specifies if the formula will be hidden when the worksheet is protected.
    remarks: '\[ [API set: ExcelApi 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
    isPreview: false
    isDeprecated: false
    syntax:
      content: 'formulaHidden?: boolean;'
      return:
        type: boolean
  - name: horizontalAlignment
    uid: 'excel!Excel.Interfaces.StyleData#horizontalAlignment:member'
    package: excel!
    fullName: horizontalAlignment
    summary: Represents the horizontal alignment for the style. See `Excel.HorizontalAlignment` for details.
    remarks: '\[ [API set: ExcelApi 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
    isPreview: false
    isDeprecated: false
    syntax:
      content: >-
        horizontalAlignment?: Excel.HorizontalAlignment | "General" | "Left" | "Center" | "Right" | "Fill" | "Justify" |
        "CenterAcrossSelection" | "Distributed";
      return:
        type: >-
          <xref uid="excel!Excel.HorizontalAlignment:enum" /> | "General" | "Left" | "Center" | "Right" | "Fill" |
          "Justify" | "CenterAcrossSelection" | "Distributed"
  - name: includeAlignment
    uid: 'excel!Excel.Interfaces.StyleData#includeAlignment:member'
    package: excel!
    fullName: includeAlignment
    summary: >-
      Specifies if the style includes the auto indent, horizontal alignment, vertical alignment, wrap text, indent
      level, and text orientation properties.
    remarks: '\[ [API set: ExcelApi 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
    isPreview: false
    isDeprecated: false
    syntax:
      content: 'includeAlignment?: boolean;'
      return:
        type: boolean
  - name: includeBorder
    uid: 'excel!Excel.Interfaces.StyleData#includeBorder:member'
    package: excel!
    fullName: includeBorder
    summary: 'Specifies if the style includes the color, color index, line style, and weight border properties.'
    remarks: '\[ [API set: ExcelApi 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
    isPreview: false
    isDeprecated: false
    syntax:
      content: 'includeBorder?: boolean;'
      return:
        type: boolean
  - name: includeFont
    uid: 'excel!Excel.Interfaces.StyleData#includeFont:member'
    package: excel!
    fullName: includeFont
    summary: >-
      Specifies if the style includes the background, bold, color, color index, font style, italic, name, size,
      strikethrough, subscript, superscript, and underline font properties.
    remarks: '\[ [API set: ExcelApi 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
    isPreview: false
    isDeprecated: false
    syntax:
      content: 'includeFont?: boolean;'
      return:
        type: boolean
  - name: includeNumber
    uid: 'excel!Excel.Interfaces.StyleData#includeNumber:member'
    package: excel!
    fullName: includeNumber
    summary: Specifies if the style includes the number format property.
    remarks: '\[ [API set: ExcelApi 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
    isPreview: false
    isDeprecated: false
    syntax:
      content: 'includeNumber?: boolean;'
      return:
        type: boolean
  - name: includePatterns
    uid: 'excel!Excel.Interfaces.StyleData#includePatterns:member'
    package: excel!
    fullName: includePatterns
    summary: >-
      Specifies if the style includes the color, color index, invert if negative, pattern, pattern color, and pattern
      color index interior properties.
    remarks: '\[ [API set: ExcelApi 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
    isPreview: false
    isDeprecated: false
    syntax:
      content: 'includePatterns?: boolean;'
      return:
        type: boolean
  - name: includeProtection
    uid: 'excel!Excel.Interfaces.StyleData#includeProtection:member'
    package: excel!
    fullName: includeProtection
    summary: Specifies if the style includes the formula hidden and locked protection properties.
    remarks: '\[ [API set: ExcelApi 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
    isPreview: false
    isDeprecated: false
    syntax:
      content: 'includeProtection?: boolean;'
      return:
        type: boolean
  - name: indentLevel
    uid: 'excel!Excel.Interfaces.StyleData#indentLevel:member'
    package: excel!
    fullName: indentLevel
    summary: An integer from 0 to 250 that indicates the indent level for the style.
    remarks: '\[ [API set: ExcelApi 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
    isPreview: false
    isDeprecated: false
    syntax:
      content: 'indentLevel?: number;'
      return:
        type: number
  - name: locked
    uid: 'excel!Excel.Interfaces.StyleData#locked:member'
    package: excel!
    fullName: locked
    summary: Specifies if the object is locked when the worksheet is protected.
    remarks: '\[ [API set: ExcelApi 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
    isPreview: false
    isDeprecated: false
    syntax:
      content: 'locked?: boolean;'
      return:
        type: boolean
  - name: name
    uid: 'excel!Excel.Interfaces.StyleData#name:member'
    package: excel!
    fullName: name
    summary: The name of the style.
    remarks: '\[ [API set: ExcelApi 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
    isPreview: false
    isDeprecated: false
    syntax:
      content: 'name?: string;'
      return:
        type: string
  - name: numberFormat
    uid: 'excel!Excel.Interfaces.StyleData#numberFormat:member'
    package: excel!
    fullName: numberFormat
    summary: The format code of the number format for the style.
    remarks: '\[ [API set: ExcelApi 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
    isPreview: false
    isDeprecated: false
    syntax:
      content: 'numberFormat?: string;'
      return:
        type: string
  - name: numberFormatLocal
    uid: 'excel!Excel.Interfaces.StyleData#numberFormatLocal:member'
    package: excel!
    fullName: numberFormatLocal
    summary: The localized format code of the number format for the style.
    remarks: '\[ [API set: ExcelApi 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
    isPreview: false
    isDeprecated: false
    syntax:
      content: 'numberFormatLocal?: string;'
      return:
        type: string
  - name: readingOrder
    uid: 'excel!Excel.Interfaces.StyleData#readingOrder:member'
    package: excel!
    fullName: readingOrder
    summary: The reading order for the style.
    remarks: '\[ [API set: ExcelApi 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
    isPreview: false
    isDeprecated: false
    syntax:
      content: 'readingOrder?: Excel.ReadingOrder | "Context" | "LeftToRight" | "RightToLeft";'
      return:
        type: '<xref uid="excel!Excel.ReadingOrder:enum" /> | "Context" | "LeftToRight" | "RightToLeft"'
  - name: shrinkToFit
    uid: 'excel!Excel.Interfaces.StyleData#shrinkToFit:member'
    package: excel!
    fullName: shrinkToFit
    summary: Specifies if text automatically shrinks to fit in the available column width.
    remarks: '\[ [API set: ExcelApi 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
    isPreview: false
    isDeprecated: false
    syntax:
      content: 'shrinkToFit?: boolean;'
      return:
        type: boolean
  - name: textOrientation
    uid: 'excel!Excel.Interfaces.StyleData#textOrientation:member'
    package: excel!
    fullName: textOrientation
    summary: The text orientation for the style.
    remarks: '\[ [API set: ExcelApi 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
    isPreview: false
    isDeprecated: false
    syntax:
      content: 'textOrientation?: number;'
      return:
        type: number
  - name: verticalAlignment
    uid: 'excel!Excel.Interfaces.StyleData#verticalAlignment:member'
    package: excel!
    fullName: verticalAlignment
    summary: Specifies the vertical alignment for the style. See `Excel.VerticalAlignment` for details.
    remarks: '\[ [API set: ExcelApi 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
    isPreview: false
    isDeprecated: false
    syntax:
      content: 'verticalAlignment?: Excel.VerticalAlignment | "Top" | "Center" | "Bottom" | "Justify" | "Distributed";'
      return:
        type: '<xref uid="excel!Excel.VerticalAlignment:enum" /> | "Top" | "Center" | "Bottom" | "Justify" | "Distributed"'
  - name: wrapText
    uid: 'excel!Excel.Interfaces.StyleData#wrapText:member'
    package: excel!
    fullName: wrapText
    summary: Specifies if Excel wraps the text in the object.
    remarks: '\[ [API set: ExcelApi 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
    isPreview: false
    isDeprecated: false
    syntax:
      content: 'wrapText?: boolean;'
      return:
        type: boolean