constructor

• new SparklineGroupCollection(a): SparklineGroupCollection

• Parameters

  • a: Worksheet

  Returns SparklineGroupCollection

Static $t

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

[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.

    • • (arg1): void

      • Parameters

        • arg1: SparklineGroup

        Returns void

  • 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

  • group: SparklineGroup

    The group to check

  Returns boolean

getEnumerator

• getEnumerator(): any

• Returns any

getEnumeratorObject

• getEnumeratorObject(): any

• Returns any

indexOf

• indexOf(group): number

• Gets the index of the item in the collection

  Parameters

  • group: SparklineGroup

  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

remove

• remove(group): boolean

• Removes a group from the collection

  Parameters

  • group: SparklineGroup

    The group to remove.

  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 staticInit

• staticInit(): void

• Returns void