com.aspose.cells

Class ChartCollection

java.lang.Object

com.aspose.cells.CollectionBase

com.aspose.cells.ChartCollection

All Implemented Interfaces:

java.lang.Iterable

public class ChartCollection
extends CollectionBase

Encapsulates a collection of Chart objects.

Example

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

Method Summary

Methods

Modifier and Type	Method and Description
int	add(byte[] data, java.lang.String dataRange, boolean isVertical, int topRow, int leftColumn, int rightRow, int bottomColumn) Adds a chart with preset template.
int	add(int type, int upperLeftRow, int upperLeftColumn, int lowerRightRow, int lowerRightColumn) Adds a chart to the collection.
int	add(int type, java.lang.String dataRange, boolean isVertical, int topRow, int leftColumn, int rightRow, int bottomColumn) Adds a chart to the collection.
int	add(int type, java.lang.String dataRange, int topRow, int leftColumn, int rightRow, int bottomColumn) Deprecated. Use ChartCollection.Add(ChartType, string, bool ,int , int, int, int ) instead.
int	addFloatingChart(int type, int left, int top, int width, int height) Adds a chart to the collection.
void	clear() Clear all charts.
Chart	get(int index) Gets the Chart element at the specified index.
Chart	get(java.lang.String name) Gets the chart by the name.
void	remove(Chart chart) Remove the specific chart.
void	removeAt(int index) Remove a chart at the specific index.

Methods inherited from class com.aspose.cells.CollectionBase

add, contains, getCount, indexOf, iterator

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

addFloatingChart

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

Adds a chart to the collection.

Parameters:

type - ChartType. Chart type

left - The x offset to corner

top - The y offset to corner

width - The chart width

height - The chart height

Returns:

Chart object index.

add

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

Adds a chart to the collection.

Parameters:

type - ChartType. Chart type

upperLeftRow - Upper left row index.

upperLeftColumn - Upper left column index.

lowerRightRow - Lower right row index

lowerRightColumn - Lower right column index

Returns:

Chart object index.

add

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

Deprecated. Use ChartCollection.Add(ChartType, string, bool ,int , int, int, int ) instead.

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:

type - ChartType. Chart type

dataRange - Specifies the data range of the chart

topRow - Upper left row index.

leftColumn - Upper left column index.

rightRow - Lower right row index

bottomColumn - Lower right column index

Returns:

Chart object index.

add

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

Adds a chart with preset template.

Parameters:

data - The data of chart template file(.crtx).

dataRange - Specifies the data range of the chart

isVertical - Specifies whether to plot the series from a range of cell values by row or by column.

topRow - Upper left row index.

leftColumn - Upper left column index.

rightRow - Lower right row index

bottomColumn - Lower right column index

Returns:

Chart object index.

add

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

Adds a chart to the collection.

Parameters:

type - ChartType. Chart type

dataRange - Specifies the data range of the chart

isVertical - Specifies whether to plot the series from a range of cell values by row or by column.

topRow - Upper left row index.

leftColumn - Upper left column index.

rightRow - Lower right row index

bottomColumn - Lower right column index

Returns:

Chart object index.

get

public Chart get(int index)

Gets the Chart element at the specified index.

Overrides:

get in class CollectionBase

Parameters:

index - The zero based index of the element.

Returns:

The element at the specified index.

get

public Chart get(java.lang.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:

name - The chart name.

Returns:

The chart.

remove

public void remove(Chart chart)

Remove the specific chart.

Parameters:

chart -

removeAt

public void removeAt(int index)

Remove a chart at the specific index.

Overrides:

removeAt in class CollectionBase

Parameters:

index - The chart index.

clear

public void clear()

Clear all charts.

Overrides:

clear in class CollectionBase