ChartCategoryCollection

ChartCategoryCollection class

Represents collection of ChartCategory

add

NameDescription
add (ChartDataCell)If category exists in collection, return it. Else creates new chart category from IChartDataCell and adds it to the collection.

Parameters:

NameTypeDescription
chartDataCellChartDataCellCell used to create chart category.

Returns: ChartCategory


add

NameDescription
add (Object)Creates new ChartCategory from value and adds it to the collection.

Parameters:

NameTypeDescription
valueObjectThe value. This function adds worksheet with name AUTO_DATA and adds all values there. If you use ChartDataWorkbook to add or edit cell values, be sure that you do not use this worksheet Maximum number of values added using this function must not exceed 16711680

Returns: ChartCategory

Error

ErrorCondition
InvalidOperationExceptionif limit exceeded

clear

NameDescription
clear ()Removes all elements from the collection.

getGroupingLevelCount

NameDescription
getGroupingLevelCount ()Returns count of category grouping levels used. Is more then one for multilevel categories. Read-only int.

Returns: int


getSyncRoot

NameDescription
getSyncRoot ()Returns an object that can be used to synchronize access to the collection. Read-only Object. Returns a synchronization root. Read-only Object.

Returns: Object


getUseCells

NameDescription
getUseCells ()If true then worksheet is used for storing categories (this case supports a multi-level categories). If false then worksheet is NOT used for storing values (and this case doesn’t support a multi-level categories). Read/write boolean.

Returns: boolean


get_Item

NameDescription
get_Item (int)Gets the element at the specified index.

Returns: ChartCategory

Error

ErrorCondition
ArgumentOutOfRangeExceptionindex is not a valid index in the IList.

indexOf

NameDescription
indexOf (ChartCategory)Searches for the specified ChartCategory and returns the zero-based index of the first occurrence within the entire Collection.

Parameters:

NameTypeDescription
valueChartCategoryChart category.

Returns: int


isSynchronized

NameDescription
isSynchronized ()Returns a value indicating whether access to the List is synchronized (thread safe). Read-only boolean.

Returns: boolean


iterator

NameDescription
iterator ()Returns an enumerator that iterates through the collection.

Returns:


iteratorJava

NameDescription
iteratorJava ()Returns a java iterator for the entire collection.

Returns:


remove

NameDescription
remove (ChartCategory)Removes the specified value.

Parameters:

NameTypeDescription
valueChartCategoryThe value.

Error

ErrorCondition
ArgumentExceptionThe value parameter was not found in the collection.

removeAt

NameDescription
removeAt (int)Removes the element at the given index.

Parameters:

NameTypeDescription
indexintIndex of a category to remove.

setUseCells

NameDescription
setUseCells (boolean)If true then worksheet is used for storing categories (this case supports a multi-level categories). If false then worksheet is NOT used for storing values (and this case doesn’t support a multi-level categories). Read/write boolean.

size

NameDescription
size ()Returns a number of elements int the collection. Read-only int.

Returns: int