com.aspose.cells.Chart.html Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of aspose-cells Show documentation

Aspose.Cells for Java

There is a newer version: 23.1






Chart





com.aspose.cells

Class Chart
java.lang.Object
    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.setShowLegend(true);
chart.getTitle().setText("Income Analysis");












Property Getters/Setters Summary



java.awt.Dimension getActualChartSize() 
          
            Gets actual size of chart
            



boolean getAutoScaling() 
void setAutoScaling(boolean) 
          
            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.
            



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



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



ChartArea getChartArea() 
          
            Gets the chart area in the worksheet
            



ChartDataTable getChartDataTable() 
          
            Represents the chart data table.
            



ChartShape getChartObject() 
          
            Represents the chartShape;
            



ChartShape getChartShape() 
          
            Represents the chartShape;
            



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



boolean getDisplayNaAsBlank() 
void setDisplayNaAsBlank(boolean) 
          
            Indicates whether displaying #N/A as blank value.
            



int getElevation() 
void setElevation(int) 
          
            Represents the elevation of the 3-D chart view, in degrees.
            



int getFirstSliceAngle() 
void setFirstSliceAngle(int) 
          
            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. 
            



Floor getFloor() 
          
             Returns a Floor object that represents the walls of a 3-D chart.
            



int getGapDepth() 
void setGapDepth(int) 
          
            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.
            



int getGapWidth() 
void setGapWidth(int) 
          
            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.
            



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



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



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



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



Legend getLegend() 
          
            Gets the chart legend.
            



Line getLine() 
          
            Gets the line.
            



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



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



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



short getPerspective() 
void setPerspective(short) 
          
            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. 
            



PivotOptions getPivotOptions() 
          
            Specifies the pivot controls that appear on the chart
            



java.lang.String getPivotSource() 
void setPivotSource(java.lang.String) 
          
            The source is the data of the pivotTable.
            If PivotSource is not empty ,the chart is PivotChart.
            



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



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



int getPlotBy() 
          
            Gets and sets whether plot by row or column.
            The value of the property is PlotDataByType integer constant.



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



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



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



boolean getRightAngleAxes() 
void setRightAngleAxes(boolean) 
          
            True if the chart axes are at right angles. Applies only for 3-D charts(except Column3D and 3-D Pie Charts).
            



int getRotationAngle() 
void setRotationAngle(int) 
          
            Represents the rotation of the 3-D chart view (the rotation of the plot area around the z-axis, in degrees).
            



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



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



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



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



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



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



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



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



int getStyle() 
void setStyle(int) 
          
            Gets and sets the builtin style.
            



Title getSubTitle() 
          
            Gets the chart's sub-title.
            Only for ODS format file.
            



Title getTitle() 
          
            Gets the chart's title.
            



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



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



Walls getWalls() 
          
            Returns a Walls object that represents the walls of a 3-D chart.
            



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



Worksheet getWorksheet() 
          
            Gets the worksheet which contains this chart.
            

 







Method Summary




void calculate() 
          
            Calculates the custom position of plot area, axes if the position of them are auto assigned.
            




java.lang.String getChartDataRange() 
          
            Gets the data source range of the chart .
            




boolean hasAxis(int aixsType, boolean isPrimary) 
          
            Returns which axes exist on the chart.
            




boolean isChartDataChanged() 
          
            Detects if a chart's data source has changed.
            




void move(int upperLeftRow, int upperLeftColumn, int lowerRightRow, int lowerRightColumn) 
          
            Moves the chart to a specified location.
            




void refreshPivotData() 
          
            Refreshes pivot chart's data  from it's pivot data source.
            




void setChartDataRange(java.lang.String area, boolean isVertical) 
          
            Specifies data range for a chart.
            




boolean switchRowColumn() 
          
            Switches row/column.
            




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




void toImage(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.
            




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




void toImage(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.
             




void toImage(java.lang.String imageFile, long jpegQuality) 
          
            Creates the chart image and saves it to a file in the Jpeg format.
            




void toPdf(java.io.OutputStream stream) 
          
            Creates the chart pdf and saves it to a stream.
            




void toPdf(java.io.OutputStream stream, float desiredPageWidth, float desiredPageHeight, int hAlignmentType, int vAlignmentType) 
          
            Creates the chart pdf and saves it to a stream.
            




void toPdf(java.lang.String fileName) 
          
            Saves the chart to a pdf file.
            




void toPdf(java.lang.String fileName, float desiredPageWidth, float desiredPageHeight, int hAlignmentType, int vAlignmentType) 
          
            Saves the chart to a pdf file.
            

 








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.
            



setStyle 
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
            



setHidePivotFieldButtons 
public void setHidePivotFieldButtons(boolean value)


            Indicates whether hide the pivot chart field buttons only when the chart is PivotChart
            




getPivotOptions 
public PivotOptions getPivotOptions()


            Specifies the pivot controls that appear on the chart
            



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.
            



setPivotSource 
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.
            




getPlotBy 
public int getPlotBy()


            Gets and sets whether plot by row or column.
            The value of the property is PlotDataByType integer constant.



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.



setPlotEmptyCellsType 
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.
            



setPlotVisibleCells 
public void setPlotVisibleCells(boolean value)


            Indicates whether only plot visible cells.
            




getDisplayNaAsBlank/setDisplayNaAsBlank 
public boolean getDisplayNaAsBlank() / public void setDisplayNaAsBlank(boolean value)


            Indicates whether displaying #N/A as blank value.
            



setDisplayNaAsBlank 
public void setDisplayNaAsBlank(boolean value)


            Indicates whether displaying #N/A as blank value.
            




getName/setName 
public java.lang.String getName() / public void setName(java.lang.String value)


            Gets and sets the name of the chart.
            



setName 
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.
            



setSizeWithWindow 
public void setSizeWithWindow(boolean value)


            True if Microsoft Excel resizes the chart to match the size of the chart sheet window.
            




getWorksheet 
public Worksheet getWorksheet()


            Gets the worksheet which contains this chart.
            



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.



setPrintSize 
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.



setType 
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.
            



getSubTitle 
public Title getSubTitle()


            Gets the chart's sub-title.
            Only for ODS format file.
            



getPlotArea 
public PlotArea getPlotArea()


            Gets the chart's plot area which includes axis tick labels.
            




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.
            



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.
            



setShowLegend 
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.
            



setRectangularCornered 
public void setRectangularCornered(boolean value)


            Gets or sets a value indicating whether the chart area is rectangular cornered.
            Default is true.
            




getShowDataTable/setShowDataTable 
public boolean getShowDataTable() / public void setShowDataTable(boolean value)


            Gets or sets a value indicating whether the chart displays a data table. 
            



setShowDataTable 
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. 
            



setFirstSliceAngle 
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.
            



setGapWidth 
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.
            



setGapDepth 
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.
            



setWallsAndGridlines2D 
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. 
            



setRotationAngle 
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. 
            




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.
            



setElevation 
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.
            



setRightAngleAxes 
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.
            



setAutoScaling 
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 int getHeightPercent() / public void setHeightPercent(int value)


            Returns or sets the height of a 3-D chart as a percentage of the chart width (between 5 and 500 percent).
            



setHeightPercent 
public void setHeightPercent(int 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. 
            



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



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




getActualChartSize 
public java.awt.Dimension getActualChartSize()


            Gets actual size of chart
            



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.



setPlacement 
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.



getLine 
public Line getLine()


            Gets the line.
            







Method Detail



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.




toPdf 
public void toPdf(java.lang.String fileName)
          throws java.lang.Exception

            Saves the chart to a pdf file.
            
Parameters:
fileName - the pdf file name with full path




toPdf 
public void toPdf(java.lang.String fileName, float desiredPageWidth, float desiredPageHeight, int hAlignmentType, int vAlignmentType)
          throws java.lang.Exception

            Saves the chart to a pdf file.
            
Parameters:
fileName - the pdf file name with full path
desiredPageWidth - The desired page width in inches.
desiredPageHeight - The desired page height in inches.
hAlignmentType - A PageLayoutAlignmentType value. The chart horizontal alignment type in the output page.
vAlignmentType - A PageLayoutAlignmentType value. The chart vertical alignment type in the output page.




toPdf 
public void toPdf(java.io.OutputStream stream)
          throws java.lang.Exception

            Creates the chart pdf and saves it to a stream.
            
Parameters:
stream - The output stream.




toPdf 
public void toPdf(java.io.OutputStream stream, float desiredPageWidth, float desiredPageHeight, int hAlignmentType, int vAlignmentType)
          throws java.lang.Exception

            Creates the chart pdf and saves it to a stream.
            
Parameters:
stream - The output stream.
desiredPageWidth - The desired page width in inches.
desiredPageHeight - The desired page height in inches.
hAlignmentType - A PageLayoutAlignmentType value. The chart horizontal alignment type in the output page.
vAlignmentType - A PageLayoutAlignmentType value. The chart vertical alignment type in the output page.




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 - Additional 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 - Additional image creation options




hasAxis 
public boolean hasAxis(int aixsType, boolean isPrimary)

            Returns which axes exist on the chart.
            

            Normally, Pie, PieExploded, PiePie,PieBar, Pie3D, Pie3DExploded,Doughnut, DoughnutExploded is no axis.
            Parameters:
aixsType - A AxisType value.




switchRowColumn 
public boolean switchRowColumn()

            Switches row/column.
            
Returns:

            False means switching row/column fails.
            




getChartDataRange 
public java.lang.String getChartDataRange()

            Gets the data source range of the chart .
            

            Only supports range.
            Returns:
The data source.




setChartDataRange 
public void setChartDataRange(java.lang.String area, boolean isVertical)

            Specifies data range for a chart.
            
Parameters:
area - Specifies values from which to plot the data series
isVertical - Specifies whether to plot the series from a range of cell values by row or by column.




isChartDataChanged 
public boolean isChartDataChanged()
                          throws java.lang.Exception

            Detects if a chart's data source has changed.
            

            The method detects the changes in the chart's data source before rendering the chart to image format.
            At first Chart.toImage call, the chart source data (e.g. XValuesParseData, ValuesParseData) will be recorded.
            Before calling the Chart.toImage method again, call IsChartDataChanged method to check if Chart needs re-rendering.
            Returns:
Returns true if the chart has changed otherwise returns false




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

            Calculates the custom position of plot area, axes if the position of them are auto assigned.
            




See Also:


          Aspose.Cells Documentation - the home page for the Aspose.Cells Product Documentation.

          Aspose.Cells Support Forum - our preferred method of support.
We guarantee a prompt response to any inquiry!
© 2003-2022 Aspose Pty Ltd. All rights reserved.

Property Getters/Setters Summary
`java.awt.Dimension`	`getActualChartSize()`
	Gets actual size of chart
`boolean`	`getAutoScaling()`
`void`	`setAutoScaling(boolean)`
	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.
`Walls`	`getBackWall()`
	Returns a Walls object that represents the back wall of a 3-D chart.
`Axis`	`getCategoryAxis()`
	Gets the chart's X axis.
`ChartArea`	`getChartArea()`
	Gets the chart area in the worksheet
`ChartDataTable`	`getChartDataTable()`
	Represents the chart data table.
`ChartShape`	`getChartObject()`
	Represents the chartShape;
`ChartShape`	`getChartShape()`
	Represents the chartShape;
`int`	`getDepthPercent()`
`void`	`setDepthPercent(int)`
	Represents the depth of a 3-D chart as a percentage of the chart width (between 20 and 2000 percent).
`boolean`	`getDisplayNaAsBlank()`
`void`	`setDisplayNaAsBlank(boolean)`
	Indicates whether displaying #N/A as blank value.
`int`	`getElevation()`
`void`	`setElevation(int)`
	Represents the elevation of the 3-D chart view, in degrees.
`int`	`getFirstSliceAngle()`
`void`	`setFirstSliceAngle(int)`
	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.
`Floor`	`getFloor()`
	Returns a Floor object that represents the walls of a 3-D chart.
`int`	`getGapDepth()`
`void`	`setGapDepth(int)`
	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.
`int`	`getGapWidth()`
`void`	`setGapWidth(int)`
	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.
`int`	`getHeightPercent()`
`void`	`setHeightPercent(int)`
	Returns or sets the height of a 3-D chart as a percentage of the chart width (between 5 and 500 percent).
`boolean`	`getHidePivotFieldButtons()`
`void`	`setHidePivotFieldButtons(boolean)`
	Indicates whether hide the pivot chart field buttons only when the chart is PivotChart
`boolean`	`getIs3D()`
	Indicates whether the chart is a 3d chart.
`boolean`	`isRectangularCornered()`
`void`	`setRectangularCornered(boolean)`
	Gets or sets a value indicating whether the chart area is rectangular cornered. Default is true.
`Legend`	`getLegend()`
	Gets the chart legend.
`Line`	`getLine()`
	Gets the line.
`java.lang.String`	`getName()`
`void`	`setName(java.lang.String)`
	Gets and sets the name of the chart.
`SeriesCollection`	`getNSeries()`
	Gets a SeriesCollection collection representing the data series in the chart.
`PageSetup`	`getPageSetup()`
	Represents the page setup description in this chart.
`short`	`getPerspective()`
`void`	`setPerspective(short)`
	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.
`PivotOptions`	`getPivotOptions()`
	Specifies the pivot controls that appear on the chart
`java.lang.String`	`getPivotSource()`
`void`	`setPivotSource(java.lang.String)`
	The source is the data of the pivotTable. If PivotSource is not empty ,the chart is PivotChart.
`int`	`getPlacement()`
`void`	`setPlacement(int)`
	Represents the way the chart is attached to the cells below it. The value of the property is PlacementType integer constant.
`PlotArea`	`getPlotArea()`
	Gets the chart's plot area which includes axis tick labels.
`int`	`getPlotBy()`
	Gets and sets whether plot by row or column. The value of the property is PlotDataByType integer constant.
`int`	`getPlotEmptyCellsType()`
`void`	`setPlotEmptyCellsType(int)`
	Gets and sets how to plot the empty cells. The value of the property is PlotEmptyCellsType integer constant.
`boolean`	`getPlotVisibleCells()`
`void`	`setPlotVisibleCells(boolean)`
	Indicates whether only plot visible cells.
`int`	`getPrintSize()`
`void`	`setPrintSize(int)`
	Gets and sets the printed chart size. The value of the property is PrintSizeType integer constant.
`boolean`	`getRightAngleAxes()`
`void`	`setRightAngleAxes(boolean)`
	True if the chart axes are at right angles. Applies only for 3-D charts(except Column3D and 3-D Pie Charts).
`int`	`getRotationAngle()`
`void`	`setRotationAngle(int)`
	Represents the rotation of the 3-D chart view (the rotation of the plot area around the z-axis, in degrees).
`Axis`	`getSecondCategoryAxis()`
	Gets the chart's second X axis.
`Axis`	`getSecondValueAxis()`
	Gets the chart's second Y axis.
`Axis`	`getSeriesAxis()`
	Gets the chart's series axis.
`ShapeCollection`	`getShapes()`
	Returns all drawing shapes in this chart.
`boolean`	`getShowDataTable()`
`void`	`setShowDataTable(boolean)`
	Gets or sets a value indicating whether the chart displays a data table.
`boolean`	`getShowLegend()`
`void`	`setShowLegend(boolean)`
	Gets or sets a value indicating whether the chart legend will be displayed. Default is true.
`Walls`	`getSideWall()`
	Returns a Walls object that represents the side wall of a 3-D chart.
`boolean`	`getSizeWithWindow()`
`void`	`setSizeWithWindow(boolean)`
	True if Microsoft Excel resizes the chart to match the size of the chart sheet window.
`int`	`getStyle()`
`void`	`setStyle(int)`
	Gets and sets the builtin style.
`Title`	`getSubTitle()`
	Gets the chart's sub-title. Only for ODS format file.
`Title`	`getTitle()`
	Gets the chart's title.
`int`	`getType()`
`void`	`setType(int)`
	Gets or sets a chart's type. The value of the property is ChartType integer constant.
`Axis`	`getValueAxis()`
	Gets the chart's Y axis.
`Walls`	`getWalls()`
	Returns a Walls object that represents the walls of a 3-D chart.
`boolean`	`getWallsAndGridlines2D()`
`void`	`setWallsAndGridlines2D(boolean)`
	True if gridlines are drawn two-dimensionally on a 3-D chart.
`Worksheet`	`getWorksheet()`
	Gets the worksheet which contains this chart.

Method Summary
`void`	`calculate()`
`void`	Calculates the custom position of plot area, axes if the position of them are auto assigned.
`java.lang.String`	`getChartDataRange()`
`java.lang.String`	Gets the data source range of the chart .
`boolean`	`hasAxis(int aixsType, boolean isPrimary)`
`boolean`	Returns which axes exist on the chart.
`boolean`	`isChartDataChanged()`
`boolean`	Detects if a chart's data source has changed.
`void`	`move(int upperLeftRow, int upperLeftColumn, int lowerRightRow, int lowerRightColumn)`
`void`	Moves the chart to a specified location.
`void`	`refreshPivotData()`
`void`	Refreshes pivot chart's data from it's pivot data source.
`void`	`setChartDataRange(java.lang.String area, boolean isVertical)`
`void`	Specifies data range for a chart.
`boolean`	`switchRowColumn()`
`boolean`	Switches row/column.
`void`	`toImage(java.io.OutputStream stream, ImageOrPrintOptions options)`
`void`	Creates the chart image and saves it to a stream in the specified format.
`void`	`toImage(java.lang.String imageFile)`
`void`	Creates the chart image and saves it to a file. The extension of the file name determines the format of the image.
`void`	`toImage(java.lang.String imageFile, ImageFormat imageFormat)`
`void`	Creates the chart image and saves it to a file in the specified format.
`void`	`toImage(java.lang.String imageFile, ImageOrPrintOptions options)`
`void`	Creates the chart image and saves it to a file. The extension of the file name determines the format of the image.
`void`	`toImage(java.lang.String imageFile, long jpegQuality)`
`void`	Creates the chart image and saves it to a file in the Jpeg format.
`void`	`toPdf(java.io.OutputStream stream)`
`void`	Creates the chart pdf and saves it to a stream.
`void`	`toPdf(java.io.OutputStream stream, float desiredPageWidth, float desiredPageHeight, int hAlignmentType, int vAlignmentType)`
`void`	Creates the chart pdf and saves it to a stream.
`void`	`toPdf(java.lang.String fileName)`
`void`	Saves the chart to a pdf file.
`void`	`toPdf(java.lang.String fileName, float desiredPageWidth, float desiredPageHeight, int hAlignmentType, int vAlignmentType)`
`void`	Saves the chart to a pdf file.

getStyle/setStyle
public int getStyle() / public void setStyle(int value)

getHidePivotFieldButtons/setHidePivotFieldButtons
public boolean getHidePivotFieldButtons() / public void setHidePivotFieldButtons(boolean value)

setHidePivotFieldButtons
public void setHidePivotFieldButtons(boolean value)

getPivotSource/setPivotSource
public java.lang.String getPivotSource() / public void setPivotSource(java.lang.String value)

setPivotSource
public void setPivotSource(java.lang.String value)

getPlotEmptyCellsType/setPlotEmptyCellsType
public int getPlotEmptyCellsType() / public void setPlotEmptyCellsType(int value)

setPlotEmptyCellsType
public void setPlotEmptyCellsType(int value)

getPlotVisibleCells/setPlotVisibleCells
public boolean getPlotVisibleCells() / public void setPlotVisibleCells(boolean value)

setPlotVisibleCells
public void setPlotVisibleCells(boolean value)

getDisplayNaAsBlank/setDisplayNaAsBlank
public boolean getDisplayNaAsBlank() / public void setDisplayNaAsBlank(boolean value)

setDisplayNaAsBlank
public void setDisplayNaAsBlank(boolean value)

getName/setName
public java.lang.String getName() / public void setName(java.lang.String value)

getSizeWithWindow/setSizeWithWindow
public boolean getSizeWithWindow() / public void setSizeWithWindow(boolean value)

setSizeWithWindow
public void setSizeWithWindow(boolean value)

getPrintSize/setPrintSize
public int getPrintSize() / public void setPrintSize(int value)

getType/setType
public int getType() / public void setType(int value)

getSecondCategoryAxis
public Axis getSecondCategoryAxis()

getChartDataTable
public ChartDataTable getChartDataTable()

getShowLegend/setShowLegend
public boolean getShowLegend() / public void setShowLegend(boolean value)

isRectangularCornered/setRectangularCornered
public boolean isRectangularCornered() / public void setRectangularCornered(boolean value)

com.aspose.cells.Chart.html Maven / Gradle / Ivy

com.aspose.cells Class Chart

getStyle/setStyle

setStyle

getChartObject

getHidePivotFieldButtons/setHidePivotFieldButtons

setHidePivotFieldButtons

getPivotOptions

getPivotSource/setPivotSource

setPivotSource

getPlotBy

getPlotEmptyCellsType/setPlotEmptyCellsType

setPlotEmptyCellsType

getPlotVisibleCells/setPlotVisibleCells

setPlotVisibleCells

getDisplayNaAsBlank/setDisplayNaAsBlank

setDisplayNaAsBlank

getName/setName

setName

getSizeWithWindow/setSizeWithWindow

setSizeWithWindow

getWorksheet

getShapes

getPrintSize/setPrintSize

setPrintSize

getType/setType

setType

getNSeries

getTitle

getSubTitle

getPlotArea

getChartArea

getCategoryAxis

getValueAxis

getSecondValueAxis

getSecondCategoryAxis

getSeriesAxis

getLegend

getChartDataTable

getShowLegend/setShowLegend

setShowLegend

isRectangularCornered/setRectangularCornered

setRectangularCornered

getShowDataTable/setShowDataTable

setShowDataTable

getFirstSliceAngle/setFirstSliceAngle

setFirstSliceAngle

getGapWidth/setGapWidth

setGapWidth

getGapDepth/setGapDepth

setGapDepth

getFloor

getWalls

getBackWall

getSideWall

getWallsAndGridlines2D/setWallsAndGridlines2D

setWallsAndGridlines2D

getRotationAngle/setRotationAngle

setRotationAngle

getElevation/setElevation

setElevation

getRightAngleAxes/setRightAngleAxes

setRightAngleAxes

getAutoScaling/setAutoScaling

setAutoScaling

getHeightPercent/setHeightPercent

setHeightPercent

getPerspective/setPerspective

setPerspective

getIs3D

getDepthPercent/setDepthPercent

setDepthPercent

getActualChartSize

getPlacement/setPlacement

setPlacement

getPageSetup

getChartShape

getLine

toImage

toImage

com.aspose.cells
Class Chart

setRectangularCornered
public void setRectangularCornered(boolean value)

getShowDataTable/setShowDataTable
public boolean getShowDataTable() / public void setShowDataTable(boolean value)

setShowDataTable
public void setShowDataTable(boolean value)

getFirstSliceAngle/setFirstSliceAngle
public int getFirstSliceAngle() / public void setFirstSliceAngle(int value)

setFirstSliceAngle
public void setFirstSliceAngle(int value)

getGapWidth/setGapWidth
public int getGapWidth() / public void setGapWidth(int value)

getGapDepth/setGapDepth
public int getGapDepth() / public void setGapDepth(int value)

getWallsAndGridlines2D/setWallsAndGridlines2D
public boolean getWallsAndGridlines2D() / public void setWallsAndGridlines2D(boolean value)

setWallsAndGridlines2D
public void setWallsAndGridlines2D(boolean value)

getRotationAngle/setRotationAngle
public int getRotationAngle() / public void setRotationAngle(int value)