Ignite UI for Web Components

All
  • Public
  • Public/Protected
  • All

Class SparklineGroupCollection

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

Hierarchy

Hierarchy

  • Base
    • SparklineGroupCollection

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

generateGuidsForGroups

  • get generateGuidsForGroups(): boolean

  • Determines if guids will be generated for groups. Note: if any group has a guid then all of them must also have guids. Therefore, when this property is set to true all groups in the collection, including groups that are subsequently added, will have guids generated for them. Also note that this property can not be set to false if the collection contains any group with a guid.

    Throws

    [[ArgumentException]] Can't set GenerateGuidsForGroups to false if the collection contains groups that already have guids generated.

    See

    [[SparklineGroup.guid]]

    Returns boolean

  • set generateGuidsForGroups(a): void

  • Parameters

    • a: boolean

    Returns void

Methods

[iterator]

  • [iterator](): EnumeratorWrapper<SparklineGroup>

  • Returns EnumeratorWrapper<SparklineGroup>

add

  • add(type, locationRange, dataRange, groupInitializer?, cellReferenceMode?): SparklineGroup

  • Adds a new [[SparklineGroup]]

    Parameters

    • type: SparklineType

      The type of the group.

    • locationRange: string

      The aggregated location for the sparklines in the group.

    • dataRange: string

      The aggreagated data range for all the sparklines in the group.

    • Optional groupInitializer: ((arg1) => void)

      An optional callback for initializing the group before it is added to the collection.

    • Optional cellReferenceMode: CellReferenceMode

      An optional [[CellReferenceMode]] to use to parse the location and data ranges. If null it defaults to the workbook's mode.

    Returns SparklineGroup

clear

  • clear(): void

  • Clears all items from the collection

    Returns void

contains

  • contains(group): 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(group): number

  • Gets the index of the item in the collection

    Parameters

    Returns number

item

  • item(a): SparklineGroup

  • Indexer

    Throws

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

    Parameters

    • a: number

    Returns SparklineGroup

memberwiseClone

  • memberwiseClone(): Base

  • Returns Base

remove

  • remove(group): boolean

  • Removes a group from the collection

    Parameters

    Returns boolean

removeAt

  • removeAt(index): void

  • Removes a group 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 group 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