ig.excel.SparklineGroupCollection
A collection of SparklineGroups exposed from a SparklineGroupCollection.worksheet
Dependencies
jquery-1.4.4.js
infragistics.util.js
infragistics.ext_core.js
infragistics.ext_collections.js
infragistics.ext_collectionsExtended.js
infragistics.ext_io.js
infragistics.ext_text.js
infragistics.documents.core_core.js
infragistics.ext_ui.js
The current widget has no options.
The current widget has no events.
-
add
- .add( type:ig.excel.SparklineType, locationRange:string, dataRange:string, [groupInitializer:function], [cellReferenceMode:ig.excel.CellReferenceMode] );
- Return Type:
- ig.excel.SparklineGroup
- Return Type Description:
- The added group
Adds a new SparklineGroup
- type
- Type:ig.excel.SparklineType
- The type of the group.
- locationRange
- Type:string
- The aggregated location for the sparklines in the group.
- dataRange
- Type:string
- The aggreagated data range for all the sparklines in the group.
- groupInitializer
- Type:function
- Optional
- cellReferenceMode
- Type:ig.excel.CellReferenceMode
- Optional
- An optional CellReferenceMode to use to parse the location and data ranges. If null it defaults to the workbook's mode.
-
clear
- .clear( );
Clears all items from the collection
-
contains
- .contains( group:ig.excel.SparklineGroup );
Returns true if the collection contains the item
- group
- Type:ig.excel.SparklineGroup
- The group to check
See Also
-
count
- .count( );
Returns the total number of items in the collection.
-
generateGuidsForGroups
- .generateGuidsForGroups( );
Determines if guids will be generated for groups.
Exceptions
Exception Description ig.ArgumentException Can't set GenerateGuidsForGroups to false if the collection contains groups that already have guids generated. Remarks
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. See Also
-
generateGuidsForGroups
- .generateGuidsForGroups( value:boolean );
Determines if guids will be generated for groups.
- value
- Type:boolean
Exceptions
Exception Description ig.ArgumentException Can't set GenerateGuidsForGroups to false if the collection contains groups that already have guids generated. Remarks
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. See Also
-
getEnumerator
- .getEnumerator( );
Returns an enumerator for the SparklineGroups in the collection.
-
indexOf
- .indexOf( group:ig.excel.SparklineGroup );
- Return Type:
- number
- Return Type Description:
- The index or -1 if the item is not in the collection
Gets the index of the item in the collection
- group
- Type:ig.excel.SparklineGroup
See Also
-
item
- .item( index:number );
- Return Type:
- ig.excel.SparklineGroup
- Return Type Description:
- The item at the specified index
Indexer
- index
- Type:number
- The zer-based index of an item
Exceptions
Exception Description ig.IndexOutOfRangeException If the index is negative or greater than or equal to SparklineGroupCollection.count See Also
-
remove
- .remove( group:ig.excel.SparklineGroup );
- Return Type:
- boolean
- Return Type Description:
- true if successful, otherwise false
Removes a group from the collection
- group
- Type:ig.excel.SparklineGroup
- The group to remove.
See Also
-
removeAt
- .removeAt( index:number );
Removes a group from the collection
- index
- Type:number
- The zero-based index of the group to remove.
Exceptions
Exception Description ig.IndexOutOfRangeException if the index is less than 0 or not less than the count.