IChartCategoryCollection

All Implemented Interfaces: com.aspose.slides.IGenericCollection

public interface IChartCategoryCollection extends IGenericCollection<IChartCategory>

Represents collection of IChartCategory

Methods

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

get_Item(int index)

public abstract IChartCategory get_Item(int index)

Gets the element at the specified index.

Parameters:

Parameter Type Description
index int

Returns: IChartCategory - The element at the specified index.

getUseCells()

public abstract 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.

Returns: boolean

setUseCells(boolean value)

public abstract 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.

Parameters:

Parameter Type Description
value boolean

getGroupingLevelCount()

public abstract int getGroupingLevelCount()

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

Returns: int

add(IChartDataCell chartDataCell)

public abstract 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:

Parameter Type Description
chartDataCell IChartDataCell Cell used to create chart category.

Returns: IChartCategory - Added or existing category.

add(Object value)

public abstract IChartCategory add(Object value)

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

Parameters:

Parameter Type Description
value java.lang.Object 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: IChartCategory - Added IChartCategory.

indexOf(IChartCategory value)

public abstract int indexOf(IChartCategory value)

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

Parameters:

Parameter Type Description
value IChartCategory Chart category.

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

remove(IChartCategory value)

public abstract void remove(IChartCategory value)

Removes the specified value.

Parameters:

Parameter Type Description
value IChartCategory The value.

removeAt(int index)

public abstract void removeAt(int index)

Removes the element at the given index.

Parameters:

Parameter Type Description
index int Index of a category to remove.

clear()

public abstract void clear()

Removes all elements from the collection.