Ignite UI for Angular

All
  • Public
  • Public/Protected
  • All

Class Trendline

Represents a Series trendline.

See

Series.trendlineCollection

Hierarchy

Hierarchy

Constructors

Properties

Accessors

Methods

Constructors

constructor

Properties

$type

$type: Type

Static $t

$t: Type

Static nextHashCode

nextHashCode: number

Accessors

backward

  • get backward(): number

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

    Returns number

  • set backward(a: number): void

  • Parameters

    • a: number

    Returns void

chart

  • get chart(): WorksheetChart

  • Returns the owning chart (read-only)

    See

    owner

    Returns WorksheetChart

forward

  • get forward(): number

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

    Returns number

  • set forward(a: number): void

  • Parameters

    • a: number

    Returns void

intercept

  • get intercept(): null | number

  • Specifies the value axis intercept for the trendline.

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

    Returns null | number

  • set intercept(a: null | number): void

  • Parameters

    • a: null | number

    Returns void

label

  • get label(): TrendlineLabel

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

    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.

    See

    TrendlineLabel

    Returns TrendlineLabel

  • set label(a: TrendlineLabel): void

  • Parameters

    Returns void

legendEntry

line

  • get line(): TrendlineLine

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

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

    Returns TrendlineLine

  • set line(a: TrendlineLine): void

  • Parameters

    Returns void

name

  • get name(): string

  • Specifies the name of the trendline.

    Returns string

  • set name(a: string): void

  • Parameters

    • a: string

    Returns void

order

  • get order(): TrendlinePolynomialOrder

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

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

    Trendlines support second-degree through sixth-degree polynomials.

    Returns TrendlinePolynomialOrder

  • set order(a: TrendlinePolynomialOrder): void

  • Parameters

    Returns void

owner

  • get owner(): ChartObject

  • returns this object's owner. (read-only) The owner or null if this object is owned directly by the Chart

    See

    chart

    Returns ChartObject

period

  • get period(): number

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

    Returns number

  • set period(a: number): void

  • Parameters

    • a: number

    Returns void

sheet

  • get sheet(): Sheet

  • The owning sheet (read-only)

    Returns Sheet

trendlineType

  • get trendlineType(): TrendlineType

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

    Returns TrendlineType

  • set trendlineType(a: TrendlineType): void

  • Parameters

    Returns void

workbook

  • get workbook(): Workbook

  • The owning workbook (read-only)

    Returns Workbook

worksheet

  • get worksheet(): Worksheet

  • The owning worksheet (read-only)

    Returns Worksheet

Methods

equals

  • Parameters

    • other: any

    Returns boolean

getHashCode

  • Returns number

memberwiseClone

Static compare

  • Parameters

    • item1: any
    • item2: any

    Returns number

Static compareSimple

  • Parameters

    • item1: any
    • item2: any

    Returns number

Static equalsSimple

  • Parameters

    • item1: any
    • item2: any

    Returns boolean

Static equalsStatic

  • Parameters

    • a: any
    • b: any

    Returns boolean

Static getArrayOfProperties

  • Parameters

    • obj: any

    Returns any[]

Static getArrayOfValues

  • Parameters

    • obj: any

    Returns any[]

Static getHashCodeStatic

  • Parameters

    • obj: any

    Returns number

Static referenceEquals

  • Parameters

    • a: any
    • b: any

    Returns boolean