com.aspose.slides

Interfaces

Classes

Exceptions

Skip navigation links
com.aspose.slides

Class ChartCategoryCollection

  • java.lang.Object
    • com.aspose.slides.ChartCategoryCollection

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      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 ChartCategory from value and adds it to the collection.
      void clear()
      Removes all elements from the collection.
      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.
      com.aspose.slides.IDOMObject getParent_Immediate()
      Returns Parent_Immediate object.
      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 List 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 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).
      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

      • Methods inherited from interface java.lang.Iterable

        forEach, spliterator

    • Method Detail

      • get_Item

        public final 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:
        com.aspose.ms.System.ArgumentOutOfRangeException - index is not a valid index in the IList.

      • getUseCells

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

        Specified by:
        getUseCells in interface IChartCategoryCollection

      • setUseCells

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

        Specified by:
        setUseCells in interface IChartCategoryCollection

      • getGroupingLevelCount

        public final int getGroupingLevelCount()

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

        Specified by:
        getGroupingLevelCount in interface IChartCategoryCollection

      • add

        public final 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 final 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 final 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 final void remove(IChartCategory value)

        Removes the specified value.

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

      • removeAt

        public final void removeAt(int index)

        Removes the element at the given index.

        Specified by:
        removeAt in interface IChartCategoryCollection
        Parameters:
        index - Index of a category to remove.

      • iterator

        public final 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 System.Collections.Generic.IEnumerator`1 that can be used to iterate through the collection.

      • size

        public final int size()

        Returns a number of elements int the collection. Read-only int.

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

      • copyTo

        public final 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 final boolean isSynchronized()

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

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

      • getSyncRoot

        public final java.lang.Object getSyncRoot()

        Returns an object that can be used to synchronize access to the collection. Read-only Object.

        Returns a synchronization root. Read-only Object.

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

      • getParent_Immediate

        public final com.aspose.slides.IDOMObject getParent_Immediate()

        Returns Parent_Immediate object. Read-only IDOMObject.