excel.chartdatalabels.yml

### YamlMime:TSType
name: Excel.ChartDataLabels
uid: 'excel!Excel.ChartDataLabels:class'
package: excel!
fullName: Excel.ChartDataLabels
summary: Represents a collection of all the data labels on a chart point.
remarks: '\[ [API set: ExcelApi 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
isPreview: false
isDeprecated: false
type: class
properties:
  - name: autoText
    uid: 'excel!Excel.ChartDataLabels#autoText:member'
    package: excel!
    fullName: autoText
    summary: Specifies if data labels automatically generate 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: context
    uid: 'excel!Excel.ChartDataLabels#context:member'
    package: excel!
    fullName: context
    summary: >-
      The request context associated with the object. This connects the add-in's process to the Office host
      application's process.
    remarks: ''
    isPreview: false
    isDeprecated: false
    syntax:
      content: 'context: RequestContext;'
      return:
        type: '<xref uid="excel!Excel.RequestContext:class" />'
  - name: format
    uid: 'excel!Excel.ChartDataLabels#format:member'
    package: excel!
    fullName: format
    summary: 'Specifies the format of chart data labels, which includes fill and font formatting.'
    remarks: '\[ [API set: ExcelApi 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
    isPreview: false
    isDeprecated: false
    syntax:
      content: 'readonly format: Excel.ChartDataLabelFormat;'
      return:
        type: '<xref uid="excel!Excel.ChartDataLabelFormat:class" />'
  - name: horizontalAlignment
    uid: 'excel!Excel.ChartDataLabels#horizontalAlignment:member'
    package: excel!
    fullName: horizontalAlignment
    summary: >-
      Specifies the horizontal alignment for chart data label. See `Excel.ChartTextHorizontalAlignment` for details.
      This property is valid only when the `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: >-
        horizontalAlignment: Excel.ChartTextHorizontalAlignment | "Center" | "Left" | "Right" | "Justify" |
        "Distributed";
      return:
        type: >-
          <xref uid="excel!Excel.ChartTextHorizontalAlignment:enum" /> | "Center" | "Left" | "Right" | "Justify" |
          "Distributed"
  - name: linkNumberFormat
    uid: 'excel!Excel.ChartDataLabels#linkNumberFormat:member'
    package: excel!
    fullName: linkNumberFormat
    summary: >-
      Specifies if the number format is linked to the cells. If `true`<!-- -->, the number format will change 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.ChartDataLabels#numberFormat:member'
    package: excel!
    fullName: numberFormat
    summary: Specifies the format code for data labels.
    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.ChartDataLabels#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.1](/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.ChartDataLabels#separator:member'
    package: excel!
    fullName: separator
    summary: String representing the separator used for the data labels on a chart.
    remarks: '\[ [API set: ExcelApi 1.1](/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.ChartDataLabels#showBubbleSize:member'
    package: excel!
    fullName: showBubbleSize
    summary: Specifies if the data label bubble size is visible.
    remarks: '\[ [API set: ExcelApi 1.1](/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.ChartDataLabels#showCategoryName:member'
    package: excel!
    fullName: showCategoryName
    summary: Specifies if the data label category name is visible.
    remarks: '\[ [API set: ExcelApi 1.1](/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.ChartDataLabels#showLegendKey:member'
    package: excel!
    fullName: showLegendKey
    summary: Specifies if the data label legend key is visible.
    remarks: '\[ [API set: ExcelApi 1.1](/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.ChartDataLabels#showPercentage:member'
    package: excel!
    fullName: showPercentage
    summary: Specifies if the data label percentage is visible.
    remarks: '\[ [API set: ExcelApi 1.1](/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.ChartDataLabels#showSeriesName:member'
    package: excel!
    fullName: showSeriesName
    summary: Specifies if the data label series name is visible.
    remarks: '\[ [API set: ExcelApi 1.1](/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.ChartDataLabels#showValue:member'
    package: excel!
    fullName: showValue
    summary: Specifies if the data label value is visible.
    remarks: '\[ [API set: ExcelApi 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
    isPreview: false
    isDeprecated: false
    syntax:
      content: 'showValue: boolean;'
      return:
        type: boolean
  - name: textOrientation
    uid: 'excel!Excel.ChartDataLabels#textOrientation:member'
    package: excel!
    fullName: textOrientation
    summary: >-
      Represents the angle to which the text is oriented for data labels. 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: verticalAlignment
    uid: 'excel!Excel.ChartDataLabels#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 the 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: 'verticalAlignment: Excel.ChartTextVerticalAlignment | "Center" | "Bottom" | "Top" | "Justify" | "Distributed";'
      return:
        type: >-
          <xref uid="excel!Excel.ChartTextVerticalAlignment:enum" /> | "Center" | "Bottom" | "Top" | "Justify" |
          "Distributed"
methods:
  - name: load(options)
    uid: 'excel!Excel.ChartDataLabels#load:member(1)'
    package: excel!
    fullName: load(options)
    summary: >-
      Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading
      the properties.
    remarks: ''
    isPreview: false
    isDeprecated: false
    syntax:
      content: 'load(options?: Excel.Interfaces.ChartDataLabelsLoadOptions): Excel.ChartDataLabels;'
      parameters:
        - id: options
          description: Provides options for which properties of the object to load.
          type: '<xref uid="excel!Excel.Interfaces.ChartDataLabelsLoadOptions:interface" />'
      return:
        type: '<xref uid="excel!Excel.ChartDataLabels:class" />'
        description: ''
  - name: load(propertyNames)
    uid: 'excel!Excel.ChartDataLabels#load:member(2)'
    package: excel!
    fullName: load(propertyNames)
    summary: >-
      Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading
      the properties.
    remarks: ''
    isPreview: false
    isDeprecated: false
    syntax:
      content: 'load(propertyNames?: string | string[]): Excel.ChartDataLabels;'
      parameters:
        - id: propertyNames
          description: A comma-delimited string or an array of strings that specify the properties to load.
          type: 'string | string[]'
      return:
        type: '<xref uid="excel!Excel.ChartDataLabels:class" />'
        description: |-


          #### Examples

          ```TypeScript
          // Show the series name in data labels and set the position of the data labels to "top".
          await Excel.run(async (context) => {
              const chart = context.workbook.worksheets.getItem("Sheet1").charts.getItem("Chart1");
              chart.dataLabels.showValue = true;
              chart.dataLabels.position = Excel.ChartDataLabelPosition.top;
              chart.dataLabels.showSeriesName = true;
              await context.sync();

              console.log("Data labels shown");
          });
          ```
  - name: load(propertyNamesAndPaths)
    uid: 'excel!Excel.ChartDataLabels#load:member(3)'
    package: excel!
    fullName: load(propertyNamesAndPaths)
    summary: >-
      Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading
      the properties.
    remarks: ''
    isPreview: false
    isDeprecated: false
    syntax:
      content: |-
        load(propertyNamesAndPaths?: {
                    select?: string;
                    expand?: string;
                }): Excel.ChartDataLabels;
      parameters:
        - id: propertyNamesAndPaths
          description: >-
            `propertyNamesAndPaths.select` is a comma-delimited string that specifies the properties to load, and
            `propertyNamesAndPaths.expand` is a comma-delimited string that specifies the navigation properties to load.
          type: |-
            {
                        select?: string;
                        expand?: string;
                    }
      return:
        type: '<xref uid="excel!Excel.ChartDataLabels:class" />'
        description: ''
  - name: 'set(properties, options)'
    uid: 'excel!Excel.ChartDataLabels#set:member(1)'
    package: excel!
    fullName: 'set(properties, options)'
    summary: >-
      Sets multiple properties of an object at the same time. You can pass either a plain object with the appropriate
      properties, or another API object of the same type.
    remarks: ''
    isPreview: false
    isDeprecated: false
    syntax:
      content: 'set(properties: Interfaces.ChartDataLabelsUpdateData, options?: OfficeExtension.UpdateOptions): void;'
      parameters:
        - id: properties
          description: >-
            A JavaScript object with properties that are structured isomorphically to the properties of the object on
            which the method is called.
          type: '<xref uid="excel!Excel.Interfaces.ChartDataLabelsUpdateData:interface" />'
        - id: options
          description: Provides an option to suppress errors if the properties object tries to set any read-only properties.
          type: '<xref uid="office!OfficeExtension.UpdateOptions:interface" />'
      return:
        type: void
        description: ''
  - name: set(properties)
    uid: 'excel!Excel.ChartDataLabels#set:member(2)'
    package: excel!
    fullName: set(properties)
    summary: 'Sets multiple properties on the object at the same time, based on an existing loaded object.'
    remarks: ''
    isPreview: false
    isDeprecated: false
    syntax:
      content: 'set(properties: Excel.ChartDataLabels): void;'
      parameters:
        - id: properties
          description: ''
          type: '<xref uid="excel!Excel.ChartDataLabels:class" />'
      return:
        type: void
        description: ''
  - name: toJSON()
    uid: 'excel!Excel.ChartDataLabels#toJSON:member(1)'
    package: excel!
    fullName: toJSON()
    summary: >-
      Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to
      `JSON.stringify()`<!-- -->. (`JSON.stringify`<!-- -->, in turn, calls the `toJSON` method of the object that is
      passed to it.) Whereas the original Excel.ChartDataLabels object is an API object, the `toJSON` method returns a
      plain JavaScript object (typed as `Excel.Interfaces.ChartDataLabelsData`<!-- -->) that contains shallow copies of
      any loaded child properties from the original object.
    remarks: ''
    isPreview: false
    isDeprecated: false
    syntax:
      content: 'toJSON(): Excel.Interfaces.ChartDataLabelsData;'
      return:
        type: '<xref uid="excel!Excel.Interfaces.ChartDataLabelsData:interface" />'
        description: ''
extends: '<xref uid="office!OfficeExtension.ClientObject:class" />'