excel.interfaces.charttrendlinecollectionloadoptions.yml

### YamlMime:TSType
name: Excel.Interfaces.ChartTrendlineCollectionLoadOptions
uid: 'excel!Excel.Interfaces.ChartTrendlineCollectionLoadOptions:interface'
package: excel!
fullName: Excel.Interfaces.ChartTrendlineCollectionLoadOptions
summary: Represents a collection of chart trendlines.
remarks: '\[ [API set: ExcelApi 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
isPreview: false
isDeprecated: false
type: interface
properties:
  - name: $all
    uid: 'excel!Excel.Interfaces.ChartTrendlineCollectionLoadOptions#$all:member'
    package: excel!
    fullName: $all
    summary: >-
      Specifying `$all` for the LoadOptions loads all the scalar properties (e.g.: `Range.address`<!-- -->) but not the
      navigational properties (e.g.: `Range.format.fill.color`<!-- -->).
    remarks: ''
    isPreview: false
    isDeprecated: false
    syntax:
      content: '$all?: boolean;'
      return:
        type: boolean
  - name: backwardPeriod
    uid: 'excel!Excel.Interfaces.ChartTrendlineCollectionLoadOptions#backwardPeriod:member'
    package: excel!
    fullName: backwardPeriod
    summary: 'For EACH ITEM in the collection: 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?: boolean;'
      return:
        type: boolean
  - name: format
    uid: 'excel!Excel.Interfaces.ChartTrendlineCollectionLoadOptions#format:member'
    package: excel!
    fullName: format
    summary: 'For EACH ITEM in the collection: 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: 'format?: Excel.Interfaces.ChartTrendlineFormatLoadOptions;'
      return:
        type: '<xref uid="excel!Excel.Interfaces.ChartTrendlineFormatLoadOptions:interface" />'
  - name: forwardPeriod
    uid: 'excel!Excel.Interfaces.ChartTrendlineCollectionLoadOptions#forwardPeriod:member'
    package: excel!
    fullName: forwardPeriod
    summary: 'For EACH ITEM in the collection: 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?: boolean;'
      return:
        type: boolean
  - name: intercept
    uid: 'excel!Excel.Interfaces.ChartTrendlineCollectionLoadOptions#intercept:member'
    package: excel!
    fullName: intercept
    summary: >-
      For EACH ITEM in the collection: 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?: boolean;'
      return:
        type: boolean
  - name: label
    uid: 'excel!Excel.Interfaces.ChartTrendlineCollectionLoadOptions#label:member'
    package: excel!
    fullName: label
    summary: 'For EACH ITEM in the collection: 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: 'label?: Excel.Interfaces.ChartTrendlineLabelLoadOptions;'
      return:
        type: '<xref uid="excel!Excel.Interfaces.ChartTrendlineLabelLoadOptions:interface" />'
  - name: movingAveragePeriod
    uid: 'excel!Excel.Interfaces.ChartTrendlineCollectionLoadOptions#movingAveragePeriod:member'
    package: excel!
    fullName: movingAveragePeriod
    summary: >-
      For EACH ITEM in the collection: 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?: boolean;'
      return:
        type: boolean
  - name: name
    uid: 'excel!Excel.Interfaces.ChartTrendlineCollectionLoadOptions#name:member'
    package: excel!
    fullName: name
    summary: >-
      For EACH ITEM in the collection: 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?: boolean;'
      return:
        type: boolean
  - name: polynomialOrder
    uid: 'excel!Excel.Interfaces.ChartTrendlineCollectionLoadOptions#polynomialOrder:member'
    package: excel!
    fullName: polynomialOrder
    summary: >-
      For EACH ITEM in the collection: 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?: boolean;'
      return:
        type: boolean
  - name: showEquation
    uid: 'excel!Excel.Interfaces.ChartTrendlineCollectionLoadOptions#showEquation:member'
    package: excel!
    fullName: showEquation
    summary: 'For EACH ITEM in the collection: 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.Interfaces.ChartTrendlineCollectionLoadOptions#showRSquared:member'
    package: excel!
    fullName: showRSquared
    summary: 'For EACH ITEM in the collection: 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.Interfaces.ChartTrendlineCollectionLoadOptions#type:member'
    package: excel!
    fullName: type
    summary: 'For EACH ITEM in the collection: Represents the type 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: 'type?: boolean;'
      return:
        type: boolean