excel.charttrendline.yml

### YamlMime:TSType
name: Excel.ChartTrendline
uid: 'excel!Excel.ChartTrendline:class'
package: excel!
fullName: Excel.ChartTrendline
summary: This object represents the attributes for a chart trendline object.
remarks: '\[ [API set: ExcelApi 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
isPreview: false
isDeprecated: false
type: class
properties:
  - name: backwardPeriod
    uid: 'excel!Excel.ChartTrendline#backwardPeriod:member'
    package: excel!
    fullName: backwardPeriod
    summary: Represents the number of periods that the trendline extends backward.
    remarks: '\[ [API set: ExcelApi 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
    isPreview: false
    isDeprecated: false
    syntax:
      content: 'backwardPeriod: number;'
      return:
        type: number
  - name: context
    uid: 'excel!Excel.ChartTrendline#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.ChartTrendline#format:member'
    package: excel!
    fullName: format
    summary: Represents the formatting of a chart trendline.
    remarks: '\[ [API set: ExcelApi 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
    isPreview: false
    isDeprecated: false
    syntax:
      content: 'readonly format: Excel.ChartTrendlineFormat;'
      return:
        type: '<xref uid="excel!Excel.ChartTrendlineFormat:class" />'
  - name: forwardPeriod
    uid: 'excel!Excel.ChartTrendline#forwardPeriod:member'
    package: excel!
    fullName: forwardPeriod
    summary: Represents the number of periods that the trendline extends forward.
    remarks: '\[ [API set: ExcelApi 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
    isPreview: false
    isDeprecated: false
    syntax:
      content: 'forwardPeriod: number;'
      return:
        type: number
  - name: intercept
    uid: 'excel!Excel.ChartTrendline#intercept:member'
    package: excel!
    fullName: intercept
    summary: >-
      Represents the intercept value of the trendline. Can be set to a numeric value or an empty string (for automatic
      values). The returned value is always a number.
    remarks: '\[ [API set: ExcelApi 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
    isPreview: false
    isDeprecated: false
    syntax:
      content: 'intercept: any;'
      return:
        type: any
  - name: label
    uid: 'excel!Excel.ChartTrendline#label:member'
    package: excel!
    fullName: label
    summary: Represents the label of a chart trendline.
    remarks: '\[ [API set: ExcelApi 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
    isPreview: false
    isDeprecated: false
    syntax:
      content: 'readonly label: Excel.ChartTrendlineLabel;'
      return:
        type: '<xref uid="excel!Excel.ChartTrendlineLabel:class" />'
  - name: movingAveragePeriod
    uid: 'excel!Excel.ChartTrendline#movingAveragePeriod:member'
    package: excel!
    fullName: movingAveragePeriod
    summary: Represents the period of a chart trendline. Only applicable to trendlines with the type `MovingAverage`<!-- -->.
    remarks: '\[ [API set: ExcelApi 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
    isPreview: false
    isDeprecated: false
    syntax:
      content: 'movingAveragePeriod: number;'
      return:
        type: number
  - name: name
    uid: 'excel!Excel.ChartTrendline#name:member'
    package: excel!
    fullName: name
    summary: >-
      Represents the name of the trendline. Can be set to a string value, a `null` value represents automatic values.
      The returned value is always a string
    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: polynomialOrder
    uid: 'excel!Excel.ChartTrendline#polynomialOrder:member'
    package: excel!
    fullName: polynomialOrder
    summary: Represents the order of a chart trendline. Only applicable to trendlines with the type `Polynomial`<!-- -->.
    remarks: '\[ [API set: ExcelApi 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
    isPreview: false
    isDeprecated: false
    syntax:
      content: 'polynomialOrder: number;'
      return:
        type: number
  - name: showEquation
    uid: 'excel!Excel.ChartTrendline#showEquation:member'
    package: excel!
    fullName: showEquation
    summary: True if the equation for the trendline is displayed on the chart.
    remarks: '\[ [API set: ExcelApi 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
    isPreview: false
    isDeprecated: false
    syntax:
      content: 'showEquation: boolean;'
      return:
        type: boolean
  - name: showRSquared
    uid: 'excel!Excel.ChartTrendline#showRSquared:member'
    package: excel!
    fullName: showRSquared
    summary: True if the r-squared value for the trendline is displayed on the chart.
    remarks: '\[ [API set: ExcelApi 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
    isPreview: false
    isDeprecated: false
    syntax:
      content: 'showRSquared: boolean;'
      return:
        type: boolean
  - name: type
    uid: 'excel!Excel.ChartTrendline#type:member'
    package: excel!
    fullName: type
    summary: Represents the type of a chart trendline.
    remarks: >-
      \[ [API set: ExcelApi 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]


      #### Examples


      ```TypeScript

      // Link to full sample:
      https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/10-chart/chart-trendlines.yaml


      await Excel.run(async (context) => {
          const sheet = context.workbook.worksheets.getItem("Sample");

          let seriesCollection = sheet.charts.getItemAt(0).series;

          // Get the trendline for series 1 and load its type property.  
          let trendline = seriesCollection.getItemAt(0).trendlines.getItem(0);
          trendline.load("type");

          await context.sync();

          console.log("The trendline type is:" + trendline.type);  
      });

      ```
    isPreview: false
    isDeprecated: false
    syntax:
      content: >-
        type: Excel.ChartTrendlineType | "Linear" | "Exponential" | "Logarithmic" | "MovingAverage" | "Polynomial" |
        "Power";
      return:
        type: >-
          <xref uid="excel!Excel.ChartTrendlineType:enum" /> | "Linear" | "Exponential" | "Logarithmic" |
          "MovingAverage" | "Polynomial" | "Power"
methods:
  - name: delete()
    uid: 'excel!Excel.ChartTrendline#delete:member(1)'
    package: excel!
    fullName: delete()
    summary: Delete the trendline object.
    remarks: '\[ [API set: ExcelApi 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
    isPreview: false
    isDeprecated: false
    syntax:
      content: 'delete(): void;'
      return:
        type: void
        description: ''
  - name: load(options)
    uid: 'excel!Excel.ChartTrendline#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.ChartTrendlineLoadOptions): Excel.ChartTrendline;'
      parameters:
        - id: options
          description: Provides options for which properties of the object to load.
          type: '<xref uid="excel!Excel.Interfaces.ChartTrendlineLoadOptions:interface" />'
      return:
        type: '<xref uid="excel!Excel.ChartTrendline:class" />'
        description: ''
  - name: load(propertyNames)
    uid: 'excel!Excel.ChartTrendline#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.ChartTrendline;'
      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.ChartTrendline:class" />'
        description: ''
  - name: load(propertyNamesAndPaths)
    uid: 'excel!Excel.ChartTrendline#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.ChartTrendline;
      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.ChartTrendline:class" />'
        description: ''
  - name: 'set(properties, options)'
    uid: 'excel!Excel.ChartTrendline#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.ChartTrendlineUpdateData, 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.ChartTrendlineUpdateData: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.ChartTrendline#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.ChartTrendline): void;'
      parameters:
        - id: properties
          description: ''
          type: '<xref uid="excel!Excel.ChartTrendline:class" />'
      return:
        type: void
        description: ''
  - name: toJSON()
    uid: 'excel!Excel.ChartTrendline#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.ChartTrendline object is an API object, the `toJSON` method returns a
      plain JavaScript object (typed as `Excel.Interfaces.ChartTrendlineData`<!-- -->) that contains shallow copies of
      any loaded child properties from the original object.
    remarks: ''
    isPreview: false
    isDeprecated: false
    syntax:
      content: 'toJSON(): Excel.Interfaces.ChartTrendlineData;'
      return:
        type: '<xref uid="excel!Excel.Interfaces.ChartTrendlineData:interface" />'
        description: ''
extends: '<xref uid="office!OfficeExtension.ClientObject:class" />'