Ignite UI for Angular

All
  • Public
  • Public/Protected
  • All

Class SparklineCollection

A collection of Sparklines 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]

add

  • Adds a new SparklineGroup with no sparklines

    Returns

    The added sparkine

    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

  • Clears all items from the collection

    Returns void

contains

  • Returns true if the collection contains the item

    Parameters

    • sparkline: Sparkline

      The sparkline to check

    Returns boolean

equals

  • Parameters

    • other: any

    Returns boolean

getEnumerator

  • Returns any

getEnumeratorObject

  • Returns any

getHashCode

  • Returns number

indexOf

  • Gets the index of the item in the collection

    Returns

    The index or -1 if the item is not in the collection

    Parameters

    Returns number

item

  • Indexer

    Returns

    The item at the specified index

    Throws

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

    Parameters

    Returns Sparkline

memberwiseClone

remove

  • Removes a sparkline from the collection

    Returns

    true if successful, otherwise false

    Parameters

    • sparkline: Sparkline

      The sparkline to remove.

    Returns boolean

removeAt

  • 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

  • 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

Static staticInit

  • Returns void