com.aspose.slides

Interface IChartCategoryCollection

All Superinterfaces:

com.aspose.ms.System.Collections.ICollection<IChartCategory>, com.aspose.ms.System.Collections.IEnumerable<IChartCategory>, IGenericCollection<IChartCategory>, com.aspose.ms.System.Collections.Generic.IGenericEnumerable<IChartCategory>, java.lang.Iterable<IChartCategory>

All Known Implementing Classes:

ChartCategoryCollection

public interface IChartCategoryCollection
extends IGenericCollection<IChartCategory>

Represents collection of IChartCategory

Method Summary

Modifier and Type	Method and Description
IChartCategory	add(IChartDataCell chartDataCell) If category exists in collection, return it.
IChartCategory	add(java.lang.Object value) Creates new IChartCategory from value and adds it to the collection.
void	clear() Removes all elements from the collection.
IChartCategory	get_Item(int index) Gets the element at the specified index.
int	getGroupingLevelCount() Returns count of category grouping levels used.
boolean	getUseCells() If true then worksheet is used for storing categories (this case supports a multi-level categories).
int	indexOf(IChartCategory value) Searches for the specified IChartCategory and returns the zero-based index of the first occurrence within the entire Collection
void	remove(IChartCategory value) Removes the specified value.
void	removeAt(int index) Removes the element at the given index.
void	setUseCells(boolean value) If true then worksheet is used for storing categories (this case supports a multi-level categories).

Methods inherited from interface com.aspose.slides.IGenericCollection

iteratorJava

Methods inherited from interface com.aspose.ms.System.Collections.Generic.IGenericEnumerable

iterator

Methods inherited from interface com.aspose.ms.System.Collections.ICollection

copyTo, getSyncRoot, isSynchronized, size

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Method Detail

get_Item

IChartCategory get_Item(int index)

Gets the element at the specified index.

Returns:

The element at the specified index.

Throws:

com.aspose.ms.System.ArgumentOutOfRangeException - index is not a valid index in the IList.

getUseCells

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

setUseCells

void setUseCells(boolean value)

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.

getGroupingLevelCount

int getGroupingLevelCount()

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

add

IChartCategory add(IChartDataCell chartDataCell)

If category exists in collection, return it. Else creates new chart category from IChartDataCell and adds it to the collection.

Parameters:

chartDataCell - Cell used to create chart category.

Returns:

Added or existing category.

add

IChartCategory add(java.lang.Object value)

Creates new IChartCategory from value and adds it to the collection.

Parameters:

value - The value.

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

Returns:

Added IChartCategory.

Throws:

com.aspose.ms.System.InvalidOperationException - if limit exceeded

indexOf

int indexOf(IChartCategory value)

Searches for the specified IChartCategory and returns the zero-based index of the first occurrence within the entire Collection

Parameters:

value - Chart category.

Returns:

The zero-based index of the first occurrence of value within the entire CollectionBase, if found; otherwise, -1.

remove

void remove(IChartCategory value)

Removes the specified value.

Parameters:

value - The value.

Throws:

com.aspose.ms.System.ArgumentException - The value parameter was not found in the collection.

removeAt

void removeAt(int index)

Removes the element at the given index.

Parameters:

index - Index of a category to remove.

clear

void clear()

Removes all elements from the collection.