excel.charttrendlinelabel.yml

### YamlMime:TSType
name: Excel.ChartTrendlineLabel
uid: 'excel!Excel.ChartTrendlineLabel:class'
package: excel!
fullName: Excel.ChartTrendlineLabel
summary: This object represents the attributes for a chart trendline label object.
remarks: '\[ [API set: ExcelApi 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
isPreview: false
isDeprecated: false
type: class
properties:
  - name: autoText
    uid: 'excel!Excel.ChartTrendlineLabel#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: context
    uid: 'excel!Excel.ChartTrendlineLabel#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.ChartTrendlineLabel#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: 'readonly format: Excel.ChartTrendlineLabelFormat;'
      return:
        type: '<xref uid="excel!Excel.ChartTrendlineLabelFormat:class" />'
  - name: formula
    uid: 'excel!Excel.ChartTrendlineLabel#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.ChartTrendlineLabel#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: 'readonly height: number;'
      return:
        type: number
  - name: horizontalAlignment
    uid: 'excel!Excel.ChartTrendlineLabel#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.ChartTrendlineLabel#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.ChartTrendlineLabel#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.ChartTrendlineLabel#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.ChartTrendlineLabel#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.ChartTrendlineLabel#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.ChartTrendlineLabel#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.ChartTrendlineLabel#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.ChartTrendlineLabel#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: 'readonly width: number;'
      return:
        type: number
methods:
  - name: load(options)
    uid: 'excel!Excel.ChartTrendlineLabel#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.ChartTrendlineLabelLoadOptions): Excel.ChartTrendlineLabel;'
      parameters:
        - id: options
          description: Provides options for which properties of the object to load.
          type: '<xref uid="excel!Excel.Interfaces.ChartTrendlineLabelLoadOptions:interface" />'
      return:
        type: '<xref uid="excel!Excel.ChartTrendlineLabel:class" />'
        description: ''
  - name: load(propertyNames)
    uid: 'excel!Excel.ChartTrendlineLabel#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.ChartTrendlineLabel;'
      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.ChartTrendlineLabel:class" />'
        description: ''
  - name: load(propertyNamesAndPaths)
    uid: 'excel!Excel.ChartTrendlineLabel#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.ChartTrendlineLabel;
      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.ChartTrendlineLabel:class" />'
        description: ''
  - name: 'set(properties, options)'
    uid: 'excel!Excel.ChartTrendlineLabel#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.ChartTrendlineLabelUpdateData, 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.ChartTrendlineLabelUpdateData: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.ChartTrendlineLabel#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.ChartTrendlineLabel): void;'
      parameters:
        - id: properties
          description: ''
          type: '<xref uid="excel!Excel.ChartTrendlineLabel:class" />'
      return:
        type: void
        description: ''
  - name: toJSON()
    uid: 'excel!Excel.ChartTrendlineLabel#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.ChartTrendlineLabel object is an API object, the `toJSON` method returns
      a plain JavaScript object (typed as `Excel.Interfaces.ChartTrendlineLabelData`<!-- -->) that contains shallow
      copies of any loaded child properties from the original object.
    remarks: ''
    isPreview: false
    isDeprecated: false
    syntax:
      content: 'toJSON(): Excel.Interfaces.ChartTrendlineLabelData;'
      return:
        type: '<xref uid="excel!Excel.Interfaces.ChartTrendlineLabelData:interface" />'
        description: ''
extends: '<xref uid="office!OfficeExtension.ClientObject:class" />'