excel.interfaces.charttrendlinelabeldata.yml

### YamlMime:TSType
name: Excel.Interfaces.ChartTrendlineLabelData
uid: 'excel!Excel.Interfaces.ChartTrendlineLabelData:interface'
package: excel!
fullName: Excel.Interfaces.ChartTrendlineLabelData
summary: An interface describing the data returned by calling `chartTrendlineLabel.toJSON()`<!-- -->.
remarks: ''
isPreview: false
isDeprecated: false
type: interface
properties:
  - name: autoText
    uid: 'excel!Excel.Interfaces.ChartTrendlineLabelData#autoText:member'
    package: excel!
    fullName: autoText
    summary: Specifies if the trendline 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.ChartTrendlineLabelData#format:member'
    package: excel!
    fullName: format
    summary: The format of the chart trendline 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.ChartTrendlineLabelFormatData;'
      return:
        type: '<xref uid="excel!Excel.Interfaces.ChartTrendlineLabelFormatData:interface" />'
  - name: formula
    uid: 'excel!Excel.Interfaces.ChartTrendlineLabelData#formula:member'
    package: excel!
    fullName: formula
    summary: String value that represents the formula of the chart trendline 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.ChartTrendlineLabelData#height:member'
    package: excel!
    fullName: height
    summary: >-
      Returns the height, in points, of the chart trendline label. Value is `null` if the chart trendline 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.ChartTrendlineLabelData#horizontalAlignment:member'
    package: excel!
    fullName: horizontalAlignment
    summary: >-
      Represents the horizontal alignment of the chart trendline label. See `Excel.ChartTextHorizontalAlignment` for
      details. This property is valid only when `TextOrientation` of a trendline 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.ChartTrendlineLabelData#left:member'
    package: excel!
    fullName: left
    summary: >-
      Represents the distance, in points, from the left edge of the chart trendline label to the left edge of the chart
      area. Value is `null` if the chart trendline 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.ChartTrendlineLabelData#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.ChartTrendlineLabelData#numberFormat:member'
    package: excel!
    fullName: numberFormat
    summary: String value that represents the format code for the trendline 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: text
    uid: 'excel!Excel.Interfaces.ChartTrendlineLabelData#text:member'
    package: excel!
    fullName: text
    summary: String representing the text of the trendline 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.ChartTrendlineLabelData#textOrientation:member'
    package: excel!
    fullName: textOrientation
    summary: >-
      Represents the angle to which the text is oriented for the chart trendline 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.ChartTrendlineLabelData#top:member'
    package: excel!
    fullName: top
    summary: >-
      Represents the distance, in points, from the top edge of the chart trendline label to the top of the chart area.
      Value is `null` if the chart trendline 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.ChartTrendlineLabelData#verticalAlignment:member'
    package: excel!
    fullName: verticalAlignment
    summary: >-
      Represents the vertical alignment of the chart trendline label. See `Excel.ChartTextVerticalAlignment` for
      details. This property is valid only when `TextOrientation` of a trendline 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.ChartTrendlineLabelData#width:member'
    package: excel!
    fullName: width
    summary: >-
      Returns the width, in points, of the chart trendline label. Value is `null` if the chart trendline 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