ChartCollection

Inheritance: java.lang.Object, com.aspose.cells.CollectionBase

public class ChartCollection extends CollectionBase

Encapsulates a collection of Chart objects.

Example

         Workbook workbook = new Workbook();
 
         ChartCollection charts = workbook.getWorksheets().get(0).getCharts();

Methods

MethodDescription
add(byte[] data, String dataRange, boolean isVertical, int topRow, int leftColumn, int rightRow, int bottomColumn)Adds a chart with preset template.
add(int type, int upperLeftRow, int upperLeftColumn, int lowerRightRow, int lowerRightColumn)Adds a chart to the collection.
add(int type, String dataRange, boolean isVertical, int topRow, int leftColumn, int rightRow, int bottomColumn)Adds a chart to the collection.
add(int type, String dataRange, int topRow, int leftColumn, int rightRow, int bottomColumn)Adds a chart to the collection.
add(Object o)Adds an item to the CollectionBase instance.
addFloatingChart(int type, int left, int top, int width, int height)Adds a chart to the collection.
clear()Clear all charts.
contains(Object o)Return whether instance contains this object
equals(Object arg0)
get(int index)Gets the Chart element at the specified index.
get(String name)Gets the chart by the name.
getClass()
getCount()Gets the number of elements contained in the CollectionBase instance.
hashCode()
indexOf(Object o)Determines the index of a specific item in the CollectionBase instance.
iterator()Returns an enumerator that iterates through the CollectionBase instance.
notify()
notifyAll()
remove(Chart chart)Remove the specific chart.
removeAt(int index)Remove a chart at the specific index.
toString()
wait()
wait(long arg0)
wait(long arg0, int arg1)

add(byte[] data, String dataRange, boolean isVertical, int topRow, int leftColumn, int rightRow, int bottomColumn)

public int add(byte[] data, String dataRange, boolean isVertical, int topRow, int leftColumn, int rightRow, int bottomColumn)

Adds a chart with preset template.

Parameters:

ParameterTypeDescription
databyte[]The data of chart template file(.crtx).
dataRangejava.lang.StringSpecifies the data range of the chart
isVerticalbooleanSpecifies whether to plot the series from a range of cell values by row or by column.
topRowintUpper left row index.
leftColumnintUpper left column index.
rightRowintLower right row index
bottomColumnintLower right column index

Returns: int - Chart object index.

add(int type, int upperLeftRow, int upperLeftColumn, int lowerRightRow, int lowerRightColumn)

public int add(int type, int upperLeftRow, int upperLeftColumn, int lowerRightRow, int lowerRightColumn)

Adds a chart to the collection.

Parameters:

ParameterTypeDescription
typeintChartType. Chart type
upperLeftRowintUpper left row index.
upperLeftColumnintUpper left column index.
lowerRightRowintLower right row index
lowerRightColumnintLower right column index

Returns: int - Chart object index.

add(int type, String dataRange, boolean isVertical, int topRow, int leftColumn, int rightRow, int bottomColumn)

public int add(int type, String dataRange, boolean isVertical, int topRow, int leftColumn, int rightRow, int bottomColumn)

Adds a chart to the collection.

Parameters:

ParameterTypeDescription
typeintChartType. Chart type
dataRangejava.lang.StringSpecifies the data range of the chart
isVerticalbooleanSpecifies whether to plot the series from a range of cell values by row or by column.
topRowintUpper left row index.
leftColumnintUpper left column index.
rightRowintLower right row index
bottomColumnintLower right column index

Returns: int - Chart object index.

add(int type, String dataRange, int topRow, int leftColumn, int rightRow, int bottomColumn)

public int add(int type, String dataRange, int topRow, int leftColumn, int rightRow, int bottomColumn)

Adds a chart to the collection.

Remarks

NOTE: This member is now obsolete. Instead, please use add(int,String,boolean,int,int,int,int) property. This property will be removed 12 months later since May 2022. Aspose apologizes for any inconvenience you may have experienced.

Parameters:

ParameterTypeDescription
typeintChartType. Chart type
dataRangejava.lang.StringSpecifies the data range of the chart
topRowintUpper left row index.
leftColumnintUpper left column index.
rightRowintLower right row index
bottomColumnintLower right column index

Returns: int - Chart object index.

add(Object o)

public int add(Object o)

Adds an item to the CollectionBase instance.

Parameters:

ParameterTypeDescription
ojava.lang.ObjectThe Object to add to the CollectionBase instance.

Returns: int - The position into which the new element was inserted.

addFloatingChart(int type, int left, int top, int width, int height)

public int addFloatingChart(int type, int left, int top, int width, int height)

Adds a chart to the collection.

Parameters:

ParameterTypeDescription
typeintChartType. Chart type
leftintThe x offset to corner
topintThe y offset to corner
widthintThe chart width
heightintThe chart height

Returns: int - Chart object index.

clear()

public void clear()

Clear all charts.

contains(Object o)

public boolean contains(Object o)

Return whether instance contains this object

Parameters:

ParameterTypeDescription
ojava.lang.Objecttest object

Returns: boolean - Whether instance contains this object

equals(Object arg0)

public boolean equals(Object arg0)

Parameters:

ParameterTypeDescription
arg0java.lang.Object

Returns: boolean

get(int index)

public Chart get(int index)

Gets the Chart element at the specified index.

Parameters:

ParameterTypeDescription
indexintThe zero based index of the element.

Returns: Chart - The element at the specified index.

get(String name)

public Chart get(String name)

Gets the chart by the name.

Remarks

The default chart name is null. So you have to explicitly set the name of the chart.

Parameters:

ParameterTypeDescription
namejava.lang.StringThe chart name.

Returns: Chart - The chart.

getClass()

public final native Class<?> getClass()

Returns: java.lang.Class

getCount()

public int getCount()

Gets the number of elements contained in the CollectionBase instance.

Returns: int - The number of elements contained in the CollectionBase instance.

hashCode()

public native int hashCode()

Returns: int

indexOf(Object o)

public int indexOf(Object o)

Determines the index of a specific item in the CollectionBase instance.

Parameters:

ParameterTypeDescription
ojava.lang.ObjectDetermines the index of a specific item in the CollectionBase instance.

Returns: int - The index of value if found in the list; otherwise, -1.

iterator()

public Iterator iterator()

Returns an enumerator that iterates through the CollectionBase instance.

Returns: java.util.Iterator - An iterator for the CollectionBase instance.

notify()

public final native void notify()

notifyAll()

public final native void notifyAll()

remove(Chart chart)

public void remove(Chart chart)

Remove the specific chart.

Parameters:

ParameterTypeDescription
chartChart

removeAt(int index)

public void removeAt(int index)

Remove a chart at the specific index.

Parameters:

ParameterTypeDescription
indexintThe chart index.

toString()

public String toString()

Returns: java.lang.String

wait()

public final void wait()

wait(long arg0)

public final native void wait(long arg0)

Parameters:

ParameterTypeDescription
arg0long

wait(long arg0, int arg1)

public final void wait(long arg0, int arg1)

Parameters:

ParameterTypeDescription
arg0long
arg1int