com.aspose.cells
Class Chart

java.lang.Object
    extended by com.aspose.cells.Chart

public class Chart 
extends java.lang.Object

Encapsulates the object that represents a single Excel chart.

Example:

Workbook workbook = new Workbook();
Worksheet sheet = workbook.getWorksheets().get(0);

Cells cells = sheet.getCells();
cells.get(0, 1).putValue("Income");
cells.get(1, 0).putValue("Company A");
cells.get(2, 0).putValue("Company B");
cells.get(3, 0).putValue("Company C");
cells.get(1, 1).putValue(10000);
cells.get(2, 1).putValue(20000);
cells.get(3, 1).putValue(30000);

int chartIndex = sheet.getCharts().add(ChartType.COLUMN, 9, 9, 21, 15);

Chart chart = sheet.getCharts().get(chartIndex);
chart.getNSeries().add("B2:B4", true);
chart.getNSeries().setCategoryData("A2:A4");

Series aSeries = chart.getNSeries().get(0);
aSeries.setName("=B1");
chart.setLegendShown(true);
chart.getTitle().setText("Income Analysis");

Property Getters/Setters Summary
booleangetAutoScaling()
voidsetAutoScaling(boolean value)
           True if Microsoft Excel scales a 3-D chart so that it's closer in size to the equivalent 2-D chart. The RightAngleAxes property must be True.
WallsgetBackWall()
           Returns a Walls object that represents the back wall of a 3-D chart.
AxisgetCategoryAxis()
           Gets the chart's X axis.
ChartAreagetChartArea()
           Gets the chart area in the worksheet
ChartDataTablegetChartDataTable()
           Represents the chart data table.
ChartShapegetChartObject()
           Represents the chartShape;
ChartShapegetChartShape()
           Represents the chartShape;
intgetDepthPercent()
voidsetDepthPercent(int value)
           Represents the depth of a 3-D chart as a percentage of the chart width (between 20 and 2000 percent).
intgetElevation()
voidsetElevation(int value)
           Represents the elevation of the 3-D chart view, in degrees.
intgetFirstSliceAngle()
voidsetFirstSliceAngle(int value)
           Gets or sets the angle of the first pie-chart or doughnut-chart slice, in degrees (clockwise from vertical). Applies only to pie, 3-D pie, and doughnut charts, 0 to 360.
FloorgetFloor()
           Returns a Floor object that represents the walls of a 3-D chart.
intgetGapDepth()
voidsetGapDepth(int value)
           Gets or sets the distance between the data series in a 3-D chart, as a percentage of the marker width. The value of this property must be between 0 and 500.
intgetGapWidth()
voidsetGapWidth(int value)
           Returns or sets the space between bar or column clusters, as a percentage of the bar or column width. The value of this property must be between 0 and 500.
shortgetHeightPercent()
voidsetHeightPercent(short value)
           Returns or sets the height of a 3-D chart as a percentage of the chart width (between 5 and 500 percent).
booleangetHidePivotFieldButtons()
voidsetHidePivotFieldButtons(boolean value)
           Indicates whether hide the pivot chart field buttons only when the chart is PivotChart
booleangetIs3D()
           Indicates whether the chart is a 3d chart.
booleanisDataTableShown()
voidsetDataTableShown(boolean value)
           Gets or sets a value indicating whether the chart displays a data table.
booleanisLegendShown()
voidsetLegendShown(boolean value)
           Gets or sets a value indicating whether the chart legend will be displayed. Default is true.
booleanisRectangularCornered()
voidsetRectangularCornered(boolean value)
           Gets or sets a value indicating whether the chart area is rectangular cornered. Default is true.
LegendgetLegend()
           Gets the chart legend.
java.lang.StringgetName()
voidsetName(java.lang.String value)
           Gets and sets the name of the chart.
SeriesCollectiongetNSeries()
           Gets a SeriesCollection collection representing the data series in the chart.
PageSetupgetPageSetup()
           Represents the page setup description in this chart.
shortgetPerspective()
voidsetPerspective(short value)
           Returns or sets the perspective for the 3-D chart view. Must be between 0 and 100. This property is ignored if the RightAngleAxes property is True.
java.lang.StringgetPivotSource()
voidsetPivotSource(java.lang.String value)
           The source is the data of the pivotTable. If PivotSource is not empty ,the chart is PivotChart.
intgetPlacement()
voidsetPlacement(int value)
           Represents the way the chart is attached to the cells below it. The value of the property is PlacementType integer constant.
PlotAreagetPlotArea()
           Gets the chart's plot area which includes axis tick lables.
ChartFramegetPlotAreaWithoutTickLabels()
           Gets the chart's plot area which does not inculde axis tick lables.
intgetPlotEmptyCellsType()
voidsetPlotEmptyCellsType(int value)
           Gets and sets how to plot the empty cells. The value of the property is PlotEmptyCellsType integer constant.
booleangetPlotVisibleCells()
voidsetPlotVisibleCells(boolean value)
           Indicates whether only plot visible cells.
intgetPrintSize()
voidsetPrintSize(int value)
           Gets and sets the printed chart size. The value of the property is PrintSizeType integer constant.
booleangetRightAngleAxes()
voidsetRightAngleAxes(boolean value)
           True if the chart axes are at right angles.Applies only for 3-D charts(except Column3D and 3-D Pie Charts).
intgetRotation()
voidsetRotation(int value)
           Represents the rotation of the 3-D chart view (the rotation of the plot area around the z-axis, in degrees).
intgetRotationAngle()
voidsetRotationAngle(int value)
           Represents the rotation of the 3-D chart view (the rotation of the plot area around the z-axis, in degrees).
AxisgetSecondCategoryAxis()
           Gets the chart's second X axis.
AxisgetSecondValueAxis()
           Gets the chart's second Y axis.
AxisgetSeriesAxis()
           Gets the chart's series axis.
ShapeCollectiongetShapes()
           Returns all drawing shapes in this chart.
booleangetShowDataTable()
voidsetShowDataTable(boolean value)
           Gets or sets a value indicating whether the chart displays a data table.
booleangetShowLegend()
voidsetShowLegend(boolean value)
           Gets or sets a value indicating whether the chart legend will be displayed. Default is true.
WallsgetSideWall()
           Returns a Walls object that represents the side wall of a 3-D chart.
booleangetSizeWithWindow()
voidsetSizeWithWindow(boolean value)
           True if Microsoft Excel resizes the chart to match the size of the chart sheet window.
intgetStyle()
voidsetStyle(int value)
           Gets and sets the builtin style.
TitlegetTitle()
           Gets the chart's title.
intgetType()
voidsetType(int value)
           Gets or sets a chart's type. The value of the property is ChartType integer constant.
AxisgetValueAxis()
           Gets the chart's Y axis.
WallsgetWalls()
           Returns a Walls object that represents the walls of a 3-D chart.
booleangetWallsAndGridlines2D()
voidsetWallsAndGridlines2D(boolean value)
           True if gridlines are drawn two-dimensionally on a 3-D chart.
 
Method Summary
voidcalculate()
           Calcuate the custom postion of plot area, axises if the postion of them are auto assigned.
voidmove(int upperLeftRow, int upperLeftColumn, int lowerRightRow, int lowerRightColumn)
           Moves the chart to a specified location.
voidrefreshPivotData()
           Refreshes pivot chart's data from it's pivot data source.
voidtoImage(java.io.OutputStream stream, ImageOrPrintOptions options)
           Creates the chart image and saves it to a stream in the specified format.
voidtoImage(java.lang.String imageFile)
           Creates the chart image and saves it to a file. The extension of the file name determines the format of the image.
voidtoImage(java.lang.String imageFile, ImageFormat imageFormat)
           Creates the chart image and saves it to a file in the specified format.
voidtoImage(java.lang.String imageFile, ImageOrPrintOptions options)
           Creates the chart image and saves it to a file. The extension of the file name determines the format of the image.
voidtoImage(java.lang.String imageFile, long jpegQuality)
           Creates the chart image and saves it to a file in the Jpeg format.
 

Property Getters/Setters Detail

getStyle/setStyle

public int getStyle() / public void setStyle(int value)
Gets and sets the builtin style. It should be between 1 and 48. Return -1 if it's not be set.

getChartObject

public ChartShape getChartObject()
Represents the chartShape;

getHidePivotFieldButtons/setHidePivotFieldButtons

public boolean getHidePivotFieldButtons() / public void setHidePivotFieldButtons(boolean value)
Indicates whether hide the pivot chart field buttons only when the chart is PivotChart

getPivotSource/setPivotSource

public java.lang.String getPivotSource() / public void setPivotSource(java.lang.String value)
The source is the data of the pivotTable. If PivotSource is not empty ,the chart is PivotChart. If the pivot table "PivotTable1" in the Worksheet "Sheet1" in the file "Book1.xls". The pivotSource could be "[Book1.xls]Sheet1!PivotTable1" if the chart and the PivotTable is not in the same workbook. If you set this property ,the previous data source setting will be lost.

getPlotEmptyCellsType/setPlotEmptyCellsType

public int getPlotEmptyCellsType() / public void setPlotEmptyCellsType(int value)
Gets and sets how to plot the empty cells. The value of the property is PlotEmptyCellsType integer constant.

getPlotVisibleCells/setPlotVisibleCells

public boolean getPlotVisibleCells() / public void setPlotVisibleCells(boolean value)
Indicates whether only plot visible cells.

getName/setName

public java.lang.String getName() / public void setName(java.lang.String value)
Gets and sets the name of the chart.

getSizeWithWindow/setSizeWithWindow

public boolean getSizeWithWindow() / public void setSizeWithWindow(boolean value)
True if Microsoft Excel resizes the chart to match the size of the chart sheet window.

getShapes

public ShapeCollection getShapes()
Returns all drawing shapes in this chart.

getPrintSize/setPrintSize

public int getPrintSize() / public void setPrintSize(int value)
Gets and sets the printed chart size. The value of the property is PrintSizeType integer constant.

getType/setType

public int getType() / public void setType(int value)
Gets or sets a chart's type. The value of the property is ChartType integer constant.

getNSeries

public SeriesCollection getNSeries()
Gets a SeriesCollection collection representing the data series in the chart.

getTitle

public Title getTitle()
Gets the chart's title.

getPlotAreaWithoutTickLabels

public ChartFrame getPlotAreaWithoutTickLabels()
Gets the chart's plot area which does not inculde axis tick lables. NOTE: This member is now obsolete. Instead, please use ChartPlotArea.InnerX,ChartPlotArea.InnerY,ChartPlotArea.InnerWidth and ChartPlotArea.InnerHeight property. This property will be removed 12 months later since March 2012. Aspose apologizes for any inconvenience you may have experienced.

getPlotArea

public PlotArea getPlotArea()
Gets the chart's plot area which includes axis tick lables.

getChartArea

public ChartArea getChartArea()
Gets the chart area in the worksheet

getCategoryAxis

public Axis getCategoryAxis()
Gets the chart's X axis.

getValueAxis

public Axis getValueAxis()
Gets the chart's Y axis.

getSecondValueAxis

public Axis getSecondValueAxis()
Gets the chart's second Y axis.

getSecondCategoryAxis

public Axis getSecondCategoryAxis()
Gets the chart's second X axis.

getSeriesAxis

public Axis getSeriesAxis()
Gets the chart's series axis.

getLegend

public Legend getLegend()
Gets the chart legend.

getChartDataTable

public ChartDataTable getChartDataTable()
Represents the chart data table.

isLegendShown/setLegendShown

public boolean isLegendShown() / public void setLegendShown(boolean value)
Gets or sets a value indicating whether the chart legend will be displayed. Default is true. NOTE: This member is now obsolete. Instead, please use Chart.ShowLegend property. This property will be removed 12 months later since June 2010. Aspose apologizes for any inconvenience you may have experienced.

getShowLegend/setShowLegend

public boolean getShowLegend() / public void setShowLegend(boolean value)
Gets or sets a value indicating whether the chart legend will be displayed. Default is true.

isRectangularCornered/setRectangularCornered

public boolean isRectangularCornered() / public void setRectangularCornered(boolean value)
Gets or sets a value indicating whether the chart area is rectangular cornered. Default is true.

isDataTableShown/setDataTableShown

public boolean isDataTableShown() / public void setDataTableShown(boolean value)
Gets or sets a value indicating whether the chart displays a data table. NOTE: This member is now obsolete. Instead, please use Chart.ShowDataTable property. This property will be removed 12 months later since June 2010. Aspose apologizes for any inconvenience you may have experienced.

getShowDataTable/setShowDataTable

public boolean getShowDataTable() / public void setShowDataTable(boolean value)
Gets or sets a value indicating whether the chart displays a data table.

getFirstSliceAngle/setFirstSliceAngle

public int getFirstSliceAngle() / public void setFirstSliceAngle(int value)
Gets or sets the angle of the first pie-chart or doughnut-chart slice, in degrees (clockwise from vertical). Applies only to pie, 3-D pie, and doughnut charts, 0 to 360.

getGapWidth/setGapWidth

public int getGapWidth() / public void setGapWidth(int value)
Returns or sets the space between bar or column clusters, as a percentage of the bar or column width. The value of this property must be between 0 and 500.

getGapDepth/setGapDepth

public int getGapDepth() / public void setGapDepth(int value)
Gets or sets the distance between the data series in a 3-D chart, as a percentage of the marker width. The value of this property must be between 0 and 500.

getFloor

public Floor getFloor()
Returns a Floor object that represents the walls of a 3-D chart. This property doesn't apply to 3-D pie charts.

getWalls

public Walls getWalls()
Returns a Walls object that represents the walls of a 3-D chart. This property doesn't apply to 3-D pie charts.

getBackWall

public Walls getBackWall()
Returns a Walls object that represents the back wall of a 3-D chart.

getSideWall

public Walls getSideWall()
Returns a Walls object that represents the side wall of a 3-D chart.

getWallsAndGridlines2D/setWallsAndGridlines2D

public boolean getWallsAndGridlines2D() / public void setWallsAndGridlines2D(boolean value)
True if gridlines are drawn two-dimensionally on a 3-D chart.

getRotationAngle/setRotationAngle

public int getRotationAngle() / public void setRotationAngle(int value)
Represents the rotation of the 3-D chart view (the rotation of the plot area around the z-axis, in degrees). The value of this property must be from 0 to 360, except for 3-D bar charts, where the value must be from 0 to 44. The default value is 20. Applies only to 3-D charts.

getRotation/setRotation

public int getRotation() / public void setRotation(int value)
Represents the rotation of the 3-D chart view (the rotation of the plot area around the z-axis, in degrees). The value of this property must be from 0 to 360, except for 3-D bar charts, where the value must be from 0 to 44. The default value is 20. Applies only to 3-D charts. NOTE: This member is now obsolete. Instead, please use Chart.RotationAngle property. This property will be removed 12 months later since June 2010. Aspose apologizes for any inconvenience you may have experienced.

getElevation/setElevation

public int getElevation() / public void setElevation(int value)
Represents the elevation of the 3-D chart view, in degrees. The chart elevation is the height at which you view the chart, in degrees. The default is 15 for most chart types. The value of this property must be between -90 and 90, except for 3-D bar charts, where it must be between 0 and 44.

getRightAngleAxes/setRightAngleAxes

public boolean getRightAngleAxes() / public void setRightAngleAxes(boolean value)
True if the chart axes are at right angles.Applies only for 3-D charts(except Column3D and 3-D Pie Charts). If this property is True, the Perspective property is ignored.

getAutoScaling/setAutoScaling

public boolean getAutoScaling() / public void setAutoScaling(boolean value)
True if Microsoft Excel scales a 3-D chart so that it's closer in size to the equivalent 2-D chart. The RightAngleAxes property must be True.

getHeightPercent/setHeightPercent

public short getHeightPercent() / public void setHeightPercent(short value)
Returns or sets the height of a 3-D chart as a percentage of the chart width (between 5 and 500 percent).

getPerspective/setPerspective

public short getPerspective() / public void setPerspective(short value)
Returns or sets the perspective for the 3-D chart view. Must be between 0 and 100. This property is ignored if the RightAngleAxes property is True.

getIs3D

public boolean getIs3D()
Indicates whether the chart is a 3d chart.

getDepthPercent/setDepthPercent

public int getDepthPercent() / public void setDepthPercent(int value)
Represents the depth of a 3-D chart as a percentage of the chart width (between 20 and 2000 percent).

getPlacement/setPlacement

public int getPlacement() / public void setPlacement(int value)
Represents the way the chart is attached to the cells below it. The value of the property is PlacementType integer constant.

getPageSetup

public PageSetup getPageSetup()
Represents the page setup description in this chart.

getChartShape

public ChartShape getChartShape()
Represents the chartShape; NOTE: This member is now obsolete. Instead, please use Aspose.Cells.Charts.Chart.ChartObject property. This property will be removed 12 months later since JANUARY 2012. Aspose apologizes for any inconvenience you may have experienced.

Method Detail

toImage

public void toImage(java.lang.String imageFile, ImageOrPrintOptions options)
            throws java.lang.Exception
Creates the chart image and saves it to a file. The extension of the file name determines the format of the image.

The format of the image is specified by using the extension of the file name. For example, if you specify "myfile.png", then the image will be saved in the PNG format. The following file extensions are recognized: .bmp, .gif, .png, .jpg, .jpeg, .tiff, .tif, .emf.

If the width or height is zero or the chart is not supported according to Supported Charts List, this method will do nothing. Please refer to Supported Charts List for more details.
Parameters:
imageFile - The image file name with full path.
options - Addtional image creation options

Example:

ImageOrPrintOptions options = new ImageOrPrintOptions();
options.setHorizontalResolution(300);
options.setVerticalResolution(300);

Workbook book = new Workbook("c:\\test.xls");
book.getWorksheets().get(0).getCharts().get(0).toImage("c:\\chart.png", options);

toImage

public void toImage(java.io.OutputStream stream, ImageOrPrintOptions options)
            throws java.lang.Exception
Creates the chart image and saves it to a stream in the specified format.

The format of the image is specified by using options.ImageFormat. The following formats are supported: ImageFormat.Bmp, ImageFormat.Gif, ImageFormat.Png, ImageFormat.Jpeg, ImageFormat.Tiff, ImageFormat.Emf.

If the width or height is zero or the chart is not supported according to Supported Charts List, this method will do nothing. Please refer to Supported Charts List for more details.
Parameters:
stream - The output stream.
options - Addtional image creation options

refreshPivotData

public void refreshPivotData()
Refreshes pivot chart's data from it's pivot data source. We will gather data from pivot data source to the pivot chart cache. This method is only used to gather all data to a pivot chart.

move

public void move(int upperLeftRow, int upperLeftColumn, int lowerRightRow, int lowerRightColumn)
Moves the chart to a specified location.
Parameters:
upperLeftColumn - Upper left column index.
upperLeftRow - Upper left row index.
lowerRightColumn - Lower right column index
lowerRightRow - Lower right row index

calculate

public void calculate()
              throws java.lang.Exception
Calcuate the custom postion of plot area, axises if the postion of them are auto assigned.

toImage

public void toImage(java.lang.String imageFile)
            throws java.lang.Exception
Creates the chart image and saves it to a file. The extension of the file name determines the format of the image.

The format of the image is specified by using the extension of the file name. For example, if you specify "myfile.png", then the image will be saved in the PNG format. The following file extensions are recognized: .bmp, .gif, .png, .jpg, .jpeg, .tiff, .tif, .emf.

If the width or height is zero or the chart is not supported according to Supported Charts List, this method will do nothing. Please refer to Supported Charts List for more details.
Parameters:
imageFile - The image file name with full path.

toImage

public void toImage(java.lang.String imageFile, ImageFormat imageFormat)
            throws java.lang.Exception
Creates the chart image and saves it to a file in the specified format.

The format of the image is specified by using imageFormat. The following formats are supported: ImageFormat.Bmp, ImageFormat.Gif, ImageFormat.Png, ImageFormat.Jpeg, ImageFormat.Tiff, ImageFormat.Emf.

If the width or height is zero or the chart is not supported according to Supported Charts List, this method will do nothing. Please refer to Supported Charts List for more details.
Parameters:
imageFile - The image file name with full path.
imageFormat - The format in which to save the image.

toImage

public void toImage(java.lang.String imageFile, long jpegQuality)
            throws java.lang.Exception
Creates the chart image and saves it to a file in the Jpeg format. If the width or height is zero or the chart is not supported according to Supported Charts List, this method will do nothing. Please refer to Supported Charts List for more details.
Parameters:
imageFile - The image file name with full path.
jpegQuality - Jpeg quality.

See Also:
          Aspose.Cells Documentation - the home page for the Aspose.Cellss Product Documentation.
          Aspose.Cells Support Forum - our preferred method of support.