excel.interfaces.chartdatalabeldata.yml

### YamlMime:TSType
name: Excel.Interfaces.ChartDataLabelData
uid: 'excel!Excel.Interfaces.ChartDataLabelData:interface'
package: excel!
fullName: Excel.Interfaces.ChartDataLabelData
summary: An interface describing the data returned by calling `chartDataLabel.toJSON()`<!-- -->.
remarks: ''
isPreview: false
isDeprecated: false
type: interface
properties:
  - name: autoText
    uid: 'excel!Excel.Interfaces.ChartDataLabelData#autoText:member'
    package: excel!
    fullName: autoText
    summary: Specifies if the data label automatically generates appropriate text based on context.
    remarks: '\[ [API set: ExcelApi 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
    isPreview: false
    isDeprecated: false
    syntax:
      content: 'autoText?: boolean;'
      return:
        type: boolean
  - name: format
    uid: 'excel!Excel.Interfaces.ChartDataLabelData#format:member'
    package: excel!
    fullName: format
    summary: Represents the format of chart data label.
    remarks: '\[ [API set: ExcelApi 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
    isPreview: false
    isDeprecated: false
    syntax:
      content: 'format?: Excel.Interfaces.ChartDataLabelFormatData;'
      return:
        type: '<xref uid="excel!Excel.Interfaces.ChartDataLabelFormatData:interface" />'
  - name: formula
    uid: 'excel!Excel.Interfaces.ChartDataLabelData#formula:member'
    package: excel!
    fullName: formula
    summary: String value that represents the formula of chart data label using A1-style notation.
    remarks: '\[ [API set: ExcelApi 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
    isPreview: false
    isDeprecated: false
    syntax:
      content: 'formula?: string;'
      return:
        type: string
  - name: height
    uid: 'excel!Excel.Interfaces.ChartDataLabelData#height:member'
    package: excel!
    fullName: height
    summary: 'Returns the height, in points, of the chart data label. Value is `null` if the chart data label is not visible.'
    remarks: '\[ [API set: ExcelApi 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
    isPreview: false
    isDeprecated: false
    syntax:
      content: 'height?: number;'
      return:
        type: number
  - name: horizontalAlignment
    uid: 'excel!Excel.Interfaces.ChartDataLabelData#horizontalAlignment:member'
    package: excel!
    fullName: horizontalAlignment
    summary: >-
      Represents the horizontal alignment for chart data label. See `Excel.ChartTextHorizontalAlignment` for details.
      This property is valid only when `TextOrientation` of data label is -90, 90, or 180.
    remarks: '\[ [API set: ExcelApi 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
    isPreview: false
    isDeprecated: false
    syntax:
      content: >-
        horizontalAlignment?: Excel.ChartTextHorizontalAlignment | "Center" | "Left" | "Right" | "Justify" |
        "Distributed";
      return:
        type: >-
          <xref uid="excel!Excel.ChartTextHorizontalAlignment:enum" /> | "Center" | "Left" | "Right" | "Justify" |
          "Distributed"
  - name: left
    uid: 'excel!Excel.Interfaces.ChartDataLabelData#left:member'
    package: excel!
    fullName: left
    summary: >-
      Represents the distance, in points, from the left edge of chart data label to the left edge of chart area. Value
      is `null` if the chart data label is not visible.
    remarks: '\[ [API set: ExcelApi 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
    isPreview: false
    isDeprecated: false
    syntax:
      content: 'left?: number;'
      return:
        type: number
  - name: linkNumberFormat
    uid: 'excel!Excel.Interfaces.ChartDataLabelData#linkNumberFormat:member'
    package: excel!
    fullName: linkNumberFormat
    summary: >-
      Specifies if the number format is linked to the cells (so that the number format changes in the labels when it
      changes in the cells).
    remarks: '\[ [API set: ExcelApi 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
    isPreview: false
    isDeprecated: false
    syntax:
      content: 'linkNumberFormat?: boolean;'
      return:
        type: boolean
  - name: numberFormat
    uid: 'excel!Excel.Interfaces.ChartDataLabelData#numberFormat:member'
    package: excel!
    fullName: numberFormat
    summary: String value that represents the format code for data label.
    remarks: '\[ [API set: ExcelApi 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
    isPreview: false
    isDeprecated: false
    syntax:
      content: 'numberFormat?: string;'
      return:
        type: string
  - name: position
    uid: 'excel!Excel.Interfaces.ChartDataLabelData#position:member'
    package: excel!
    fullName: position
    summary: Value that represents the position of the data label. See `Excel.ChartDataLabelPosition` for details.
    remarks: '\[ [API set: ExcelApi 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
    isPreview: false
    isDeprecated: false
    syntax:
      content: >-
        position?: Excel.ChartDataLabelPosition | "Invalid" | "None" | "Center" | "InsideEnd" | "InsideBase" |
        "OutsideEnd" | "Left" | "Right" | "Top" | "Bottom" | "BestFit" | "Callout";
      return:
        type: >-
          <xref uid="excel!Excel.ChartDataLabelPosition:enum" /> | "Invalid" | "None" | "Center" | "InsideEnd" |
          "InsideBase" | "OutsideEnd" | "Left" | "Right" | "Top" | "Bottom" | "BestFit" | "Callout"
  - name: separator
    uid: 'excel!Excel.Interfaces.ChartDataLabelData#separator:member'
    package: excel!
    fullName: separator
    summary: String representing the separator used for the data label on a chart.
    remarks: '\[ [API set: ExcelApi 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
    isPreview: false
    isDeprecated: false
    syntax:
      content: 'separator?: string;'
      return:
        type: string
  - name: showBubbleSize
    uid: 'excel!Excel.Interfaces.ChartDataLabelData#showBubbleSize:member'
    package: excel!
    fullName: showBubbleSize
    summary: Specifies if the data label bubble size is visible.
    remarks: '\[ [API set: ExcelApi 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
    isPreview: false
    isDeprecated: false
    syntax:
      content: 'showBubbleSize?: boolean;'
      return:
        type: boolean
  - name: showCategoryName
    uid: 'excel!Excel.Interfaces.ChartDataLabelData#showCategoryName:member'
    package: excel!
    fullName: showCategoryName
    summary: Specifies if the data label category name is visible.
    remarks: '\[ [API set: ExcelApi 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
    isPreview: false
    isDeprecated: false
    syntax:
      content: 'showCategoryName?: boolean;'
      return:
        type: boolean
  - name: showLegendKey
    uid: 'excel!Excel.Interfaces.ChartDataLabelData#showLegendKey:member'
    package: excel!
    fullName: showLegendKey
    summary: Specifies if the data label legend key is visible.
    remarks: '\[ [API set: ExcelApi 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
    isPreview: false
    isDeprecated: false
    syntax:
      content: 'showLegendKey?: boolean;'
      return:
        type: boolean
  - name: showPercentage
    uid: 'excel!Excel.Interfaces.ChartDataLabelData#showPercentage:member'
    package: excel!
    fullName: showPercentage
    summary: Specifies if the data label percentage is visible.
    remarks: '\[ [API set: ExcelApi 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
    isPreview: false
    isDeprecated: false
    syntax:
      content: 'showPercentage?: boolean;'
      return:
        type: boolean
  - name: showSeriesName
    uid: 'excel!Excel.Interfaces.ChartDataLabelData#showSeriesName:member'
    package: excel!
    fullName: showSeriesName
    summary: Specifies if the data label series name is visible.
    remarks: '\[ [API set: ExcelApi 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
    isPreview: false
    isDeprecated: false
    syntax:
      content: 'showSeriesName?: boolean;'
      return:
        type: boolean
  - name: showValue
    uid: 'excel!Excel.Interfaces.ChartDataLabelData#showValue:member'
    package: excel!
    fullName: showValue
    summary: Specifies if the data label value is visible.
    remarks: '\[ [API set: ExcelApi 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
    isPreview: false
    isDeprecated: false
    syntax:
      content: 'showValue?: boolean;'
      return:
        type: boolean
  - name: text
    uid: 'excel!Excel.Interfaces.ChartDataLabelData#text:member'
    package: excel!
    fullName: text
    summary: String representing the text of the data label on a chart.
    remarks: '\[ [API set: ExcelApi 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
    isPreview: false
    isDeprecated: false
    syntax:
      content: 'text?: string;'
      return:
        type: string
  - name: textOrientation
    uid: 'excel!Excel.Interfaces.ChartDataLabelData#textOrientation:member'
    package: excel!
    fullName: textOrientation
    summary: >-
      Represents the angle to which the text is oriented for the chart data label. The value should either be an integer
      from -90 to 90 or the integer 180 for vertically-oriented text.
    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: top
    uid: 'excel!Excel.Interfaces.ChartDataLabelData#top:member'
    package: excel!
    fullName: top
    summary: >-
      Represents the distance, in points, from the top edge of chart data label to the top of chart area. Value is
      `null` if the chart data label is not visible.
    remarks: '\[ [API set: ExcelApi 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
    isPreview: false
    isDeprecated: false
    syntax:
      content: 'top?: number;'
      return:
        type: number
  - name: verticalAlignment
    uid: 'excel!Excel.Interfaces.ChartDataLabelData#verticalAlignment:member'
    package: excel!
    fullName: verticalAlignment
    summary: >-
      Represents the vertical alignment of chart data label. See `Excel.ChartTextVerticalAlignment` for details. This
      property is valid only when `TextOrientation` of data label is 0.
    remarks: '\[ [API set: ExcelApi 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
    isPreview: false
    isDeprecated: false
    syntax:
      content: 'verticalAlignment?: Excel.ChartTextVerticalAlignment | "Center" | "Bottom" | "Top" | "Justify" | "Distributed";'
      return:
        type: >-
          <xref uid="excel!Excel.ChartTextVerticalAlignment:enum" /> | "Center" | "Bottom" | "Top" | "Justify" |
          "Distributed"
  - name: width
    uid: 'excel!Excel.Interfaces.ChartDataLabelData#width:member'
    package: excel!
    fullName: width
    summary: 'Returns the width, in points, of the chart data label. Value is `null` if the chart data label is not visible.'
    remarks: '\[ [API set: ExcelApi 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
    isPreview: false
    isDeprecated: false
    syntax:
      content: 'width?: number;'
      return:
        type: number