ig.excel.Trendline

Represents a Series trendline.

Dependencies

jquery-1.4.4.js
infragistics.util.js
infragistics.ext_core.js
infragistics.ext_collections.js
infragistics.ext_collectionsExtended.js
infragistics.ext_io.js
infragistics.ext_text.js
infragistics.documents.core_core.js
infragistics.ext_ui.js
The current widget has no options.
The current widget has no events.
  • backward

    .backward( );

    Specifies the number of periods or units by which the trendline extends backward.

  • backward

    .backward( value:number );

    Specifies the number of periods or units by which the trendline extends backward.

    • value
    • Type:number
  • chart
    Inherited

    .chart( );
    Return Type:
    ig.excel.WorksheetChart
    Return Type Description:
    Returns a WorksheetChart.

    Returns the owning chart (read-only)

  • forward

    .forward( );

    Specifies the number of periods or units by which the trendline extends forward.

  • forward

    .forward( value:number );

    Specifies the number of periods or units by which the trendline extends forward.

    • value
    • Type:number
  • intercept

    .intercept( );

    Specifies the value axis intercept for the trendline.

    Remarks

    If this property is left unset, or assigned a value of null, the intercept is automatically determined by Excel.

  • intercept

    .intercept( value:number );

    Specifies the value axis intercept for the trendline.

    • value
    • Type:number

    Remarks

    If this property is left unset, or assigned a value of null, the intercept is automatically determined by Excel.

  • label

    .label( );
    Return Type:
    ig.excel.TrendlineLabel
    Return Type Description:
    Returns a TrendlineLabel.

    Returns a TrendlineLabel instance which determines the text and appearance of the trendline label.

    Remarks

    This property is null by default, which prevents a label from appearing.

    To display a label for the trendline, assign a TrendlineLabel instance to this property.

  • label

    .label( value:ig.excel.TrendlineLabel );
    Return Type:
    ig.excel.TrendlineLabel
    Return Type Description:
    Returns a TrendlineLabel.

    Sets a TrendlineLabel instance which determines the text and appearance of the trendline label.

    • value
    • Type:ig.excel.TrendlineLabel

    Remarks

    This property is null by default, which prevents a label from appearing.

    To display a label for the trendline, assign a TrendlineLabel instance to this property.

  • legendEntry

    .legendEntry( );
    Return Type:
    ig.excel.LegendEntry
    Return Type Description:
    Returns a LegendEntry.

    Returns a Trendline.legendEntry instance which determines the appearance of this trendline's appearance in the WorksheetChart.legend.

  • line

    .line( );
    Return Type:
    ig.excel.TrendlineLine
    Return Type Description:
    Returns a TrendlineLine.

    Returns a TrendlineLine instance which controls the color and width of the trendline.

    Remarks

    To prevent the trendline from appearing in the chart, set this property to null.

  • line

    .line( value:ig.excel.TrendlineLine );
    Return Type:
    ig.excel.TrendlineLine
    Return Type Description:
    Returns a TrendlineLine.

    Sets a TrendlineLine instance which controls the color and width of the trendline.

    • value
    • Type:ig.excel.TrendlineLine

    Remarks

    To prevent the trendline from appearing in the chart, set this property to null.

  • name

    .name( );

    Specifies the name of the trendline.

  • name

    .name( value:string );

    Specifies the name of the trendline.

    • value
    • Type:string
  • order

    .order( );
    Return Type:
    ig.excel.TrendlinePolynomialOrder
    Return Type Description:
    Returns a TrendlinePolynomialOrder.

    Specifies the order/degree of the polynomial function which defines the trendline. Applicable only when the Trendline.trendlineType property is set to Polynomial.

    Remarks

    This property is only applicable when the Trendline.trendlineType property is set to Polynomial.

    Trendlines support second-degree through sixth-degree polynomials.

  • order

    .order( value:ig.excel.TrendlinePolynomialOrder );
    Return Type:
    ig.excel.TrendlinePolynomialOrder
    Return Type Description:
    Returns a TrendlinePolynomialOrder.

    Specifies the order/degree of the polynomial function which defines the trendline. Applicable only when the Trendline.trendlineType property is set to Polynomial.

    • value
    • Type:ig.excel.TrendlinePolynomialOrder

    Remarks

    This property is only applicable when the Trendline.trendlineType property is set to Polynomial.

    Trendlines support second-degree through sixth-degree polynomials.

  • owner
    Inherited

    .owner( );
    Return Type:
    ig.excel.ChartObject
    Return Type Description:
    The owner or null if this object is owned directly by the Chart

    returns this object's owner. (read-only)

  • period

    .period( );

    Specifies the period for a moving-average trendline. Applicable only when the Trendline.trendlineType property is set to MovingAverage.

  • period

    .period( value:number );

    Specifies the period for a moving-average trendline. Applicable only when the Trendline.trendlineType property is set to MovingAverage.

    • value
    • Type:number
  • sheet
    Inherited

    .sheet( );
    Return Type:
    ig.excel.Sheet
    Return Type Description:
    Returns a Sheet.

    Gets the owning sheet (read-only)

    See Also

  • trendlineType

    .trendlineType( );
    Return Type:
    ig.excel.TrendlineType
    Return Type Description:
    Returns a TrendlineType.

    Specifies the type of trendline, i.e., linear, exponential, polynomial, etc.

  • trendlineType

    .trendlineType( value:ig.excel.TrendlineType );
    Return Type:
    ig.excel.TrendlineType
    Return Type Description:
    Returns a TrendlineType.

    Specifies the type of trendline, i.e., linear, exponential, polynomial, etc.

    • value
    • Type:ig.excel.TrendlineType
  • workbook
    Inherited

    .workbook( );
    Return Type:
    ig.excel.Workbook
    Return Type Description:
    Returns a Workbook.

    Gets the owning workbook (read-only)

  • worksheet
    Inherited

    .worksheet( );
    Return Type:
    ig.excel.Worksheet
    Return Type Description:
    Returns a Worksheet.

    Gets the owning worksheet (read-only)

Copyright © 1996 - 2024 Infragistics, Inc. All rights reserved.