Ignite UI for Web Components

All
  • Public
  • Public/Protected
  • All

Class SparklineCollection

A collection of [[Sparkline]]s exposed from a [[SparklineGroup]]

Hierarchy

Hierarchy

  • Base
    • SparklineCollection

Implements

Constructors

Properties

Accessors

Methods

Constructors

constructor

Properties

$type

$type: Type

Static $t

$t: Type

Static nextHashCode

nextHashCode: number

Accessors

count

  • get count(): number

  • Returns the total number of items in the collection.

    Returns number

Methods

[iterator]

  • [iterator](): EnumeratorWrapper<Sparkline>

  • Returns EnumeratorWrapper<Sparkline>

add

  • add(row, column, dataRegion, cellReferenceMode?): Sparkline

  • Adds a new [[SparklineGroup]] with no sparklines

    Parameters

    • row: number

      The zero-based row of the sparkline cell.

    • column: number

      The zero-based column of the sparkline cell.

    • dataRegion: string

      A string describing the data region.

    • Optional cellReferenceMode: CellReferenceMode

      An optional [[CellReferenceMode]] to use to parse the dataRegion. If null it defaults to the workbook's mode.

    Returns Sparkline

clear

  • clear(): void

  • Clears all items from the collection

    Returns void

contains

  • contains(sparkline): boolean

  • Returns true if the collection contains the item

    Parameters

    Returns boolean

equals

  • equals(other): boolean

  • Parameters

    • other: any

    Returns boolean

getEnumerator

  • getEnumerator(): any

  • Returns any

getEnumeratorObject

  • getEnumeratorObject(): any

  • Returns any

getHashCode

  • getHashCode(): number

  • Returns number

indexOf

  • indexOf(sparkline): number

  • Gets the index of the item in the collection

    Parameters

    Returns number

item

  • item(a, b?): Sparkline

  • Indexer

    Throws

    [[IndexOutOfRangeException]] If the index is negative or greater than or equal to [[count]]

    Parameters

    Returns Sparkline

memberwiseClone

  • memberwiseClone(): Base

  • Returns Base

remove

  • remove(sparkline): boolean

  • Removes a sparkline from the collection

    Parameters

    • sparkline: Sparkline

      The sparkline to remove.

    Returns boolean

removeAt

  • removeAt(index): void

  • Removes a sparkline from the collection

    Throws

    [[IndexOutOfRangeException]] if the index is less than 0 or not less than the count.

    Parameters

    • index: number

      The zero-based index of the sparkline to remove.

    Returns void

Static compare

  • compare(item1, item2): number

  • Parameters

    • item1: any
    • item2: any

    Returns number

Static compareSimple

  • compareSimple(item1, item2): number

  • Parameters

    • item1: any
    • item2: any

    Returns number

Static equalsSimple

  • equalsSimple(item1, item2): boolean

  • Parameters

    • item1: any
    • item2: any

    Returns boolean

Static equalsStatic

  • equalsStatic(a, b): boolean

  • Parameters

    • a: any
    • b: any

    Returns boolean

Static getArrayOfProperties

  • getArrayOfProperties(obj): any[]

  • Parameters

    • obj: any

    Returns any[]

Static getArrayOfValues

  • getArrayOfValues(obj): any[]

  • Parameters

    • obj: any

    Returns any[]

Static getHashCodeStatic

  • getHashCodeStatic(obj): number

  • Parameters

    • obj: any

    Returns number

Static referenceEquals

  • referenceEquals(a, b): boolean

  • Parameters

    • a: any
    • b: any

    Returns boolean

Static staticInit

  • staticInit(): void

  • Returns void