ig.excel.SparklineCollection
SparklineGroup から公開された のコレクション。
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( row:number, column:number, dataRegion:string, [cellReferenceMode:ig.excel.CellReferenceMode] );
- Return Type:
- ig.excel.Sparkline
- Return Type Description:
- The added sparkine
Adds a new SparklineGroup with no sparklines
- row
- Type:number
- The zero-based row of the sparkline cell.
- column
- Type:number
- The zero-based column of the sparkline cell.
- dataRegion
- Type:string
- A string describing the data region.
- cellReferenceMode
- Type:ig.excel.CellReferenceMode
- Optional
- An optional CellReferenceMode to use to parse the dataRegion. If null it defaults to the workbook's mode.
-
clear
- .clear( );
Clears all items from the collection
-
contains
- .contains( sparkline:ig.excel.Sparkline );
Returns true if the collection contains the item
- sparkline
- Type:ig.excel.Sparkline
- The sparkline to check
-
count
- .count( );
Returns the total number of items in the collection.
-
getEnumerator
- .getEnumerator( );
Returns an enumerator for the sparklines in the collection.
-
indexOf
- .indexOf( sparkline:ig.excel.Sparkline );
- 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
- sparkline
- Type:ig.excel.Sparkline
-
item
- .item( index:number );
- Return Type:
- ig.excel.Sparkline
- 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 SparklineCollection.count -
remove
- .remove( sparkline:ig.excel.Sparkline );
- Return Type:
- boolean
- Return Type Description:
- true if successful, otherwise false
Removes a sparkline from the collection
- sparkline
- Type:ig.excel.Sparkline
- The sparkline to remove.
-
removeAt
- .removeAt( index:number );
Removes a sparkline from the collection
- index
- Type:number
- The zero-based index of the sparkline to remove.
Exceptions
Exception Description ig.IndexOutOfRangeException if the index is less than 0 or not less than the count.