com.aspose.slides
Class ChartCategoryCollection

java.lang.Object
  extended by com.aspose.slides.ChartCategoryCollection
All Implemented Interfaces:
com.aspose.ms.System.Collections.Generic.IGenericEnumerable<IChartCategory>, com.aspose.ms.System.Collections.ICollection<IChartCategory>, com.aspose.ms.System.Collections.IEnumerable<IChartCategory>, IChartCategoryCollection, java.lang.Iterable<IChartCategory>

public class ChartCategoryCollection
extends java.lang.Object
implements IChartCategoryCollection

Represents collection of ChartCategory


Method Summary
 IChartCategory add(IChartDataCell chartDataCell)
           If category exists in collection, return it.
 IChartCategory add(java.lang.Object value)
           Creates new ChartCategory from value and adds it to the collection.
 void clear()
           Removes all coomments from the slide.
 void copyTo(com.aspose.ms.System.Array array, int index)
           Copies all elements of the collection to the specified array.
 IChartCategory get_Item(int index)
           Gets the element at the specified index.
 int getGroupingLevelCount()
           Returns count of category grouping levels used.
 int getLevelCount()
          Deprecated. 
 java.lang.Object getSyncRoot()
           Returns an object that can be used to synchronize access to the collection.
 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 ChartCategory and returns the zero-based index of the first occurrence within the entire Collection
 boolean isSynchronized()
           Returns a value indicating whether access to the ArrayList is synchronized (thread safe).
 com.aspose.ms.System.Collections.Generic.IGenericEnumerator<IChartCategory> iterator()
           Returns an enumerator that iterates through the collection.
 void remove(IChartCategory value)
           Removes the specified value.
 void setUseCells(boolean value)
           
 int size()
           Returns a number of elements int the collection.
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Method Detail

get_Item

public IChartCategory get_Item(int index)

Gets the element at the specified index.

Specified by:
get_Item in interface IChartCategoryCollection
Returns:
The element at the specified index.
Throws:
T:System.ArgumentOutOfRangeException - index is not a valid index in the T:System.Collections.IList.

getUseCells

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

Specified by:
getUseCells in interface IChartCategoryCollection

setUseCells

public void setUseCells(boolean value)
Specified by:
setUseCells in interface IChartCategoryCollection

add

public IChartCategory add(IChartDataCell chartDataCell)

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

Specified by:
add in interface IChartCategoryCollection
Parameters:
chartDataCell - Cell used to create chart category.
Returns:
Added or existing category.

add

public IChartCategory add(java.lang.Object value)

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

Specified by:
add in interface IChartCategoryCollection
Parameters:
value - The value.


This method 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 method must not exceed 16711680

Returns:
Added IChartCategory.
Throws:
com.aspose.ms.System.InvalidOperationException - if limit exceeded

indexOf

public int indexOf(IChartCategory value)

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

Specified by:
indexOf in interface IChartCategoryCollection
Parameters:
value - Chart category.
Returns:
The zero-based index of the first occurrence of value within the entire CollectionBase, if found; otherwise, -1.

remove

public void remove(IChartCategory value)

Removes the specified value.

Specified by:
remove in interface IChartCategoryCollection
Parameters:
value - The value.
Throws:
System.ArgumentException - The value parameter was not found in the collection.

clear

public void clear()

Removes all coomments from the slide.

Specified by:
clear in interface IChartCategoryCollection

getLevelCount

@Deprecated
public int getLevelCount()
Deprecated. 

Returns count of category grouping levels used. Is more then one for multilevel categories.

Specified by:
getLevelCount in interface IChartCategoryCollection

getGroupingLevelCount

public int getGroupingLevelCount()

Returns count of category grouping levels used. Is more then one for multilevel categories.

Specified by:
getGroupingLevelCount in interface IChartCategoryCollection

iterator

public com.aspose.ms.System.Collections.Generic.IGenericEnumerator<IChartCategory> iterator()

Returns an enumerator that iterates through the collection.

Specified by:
iterator in interface com.aspose.ms.System.Collections.Generic.IGenericEnumerable<IChartCategory>
Specified by:
iterator in interface com.aspose.ms.System.Collections.IEnumerable<IChartCategory>
Specified by:
iterator in interface java.lang.Iterable<IChartCategory>
Returns:
A T:System.Collections.Generic.IEnumerator`1 that can be used to iterate through the collection.

size

public int size()

Returns a number of elements int the collection. Readonly int.

Specified by:
size in interface com.aspose.ms.System.Collections.ICollection<IChartCategory>

copyTo

public void copyTo(com.aspose.ms.System.Array array,
                   int index)

Copies all elements of the collection to the specified array.

Specified by:
copyTo in interface com.aspose.ms.System.Collections.ICollection<IChartCategory>
Parameters:
array - Target array.
index - Starting index in the array.

isSynchronized

public boolean isSynchronized()

Returns a value indicating whether access to the ArrayList is synchronized (thread safe). Readonly bool.

Specified by:
isSynchronized in interface com.aspose.ms.System.Collections.ICollection<IChartCategory>

getSyncRoot

public java.lang.Object getSyncRoot()

Returns an object that can be used to synchronize access to the collection. Readonly object.

Specified by:
getSyncRoot in interface com.aspose.ms.System.Collections.ICollection<IChartCategory>