Methods

Methods

static

toImageStream(chart, stream, options)

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.

Example

var aspose = aspose || {};
aspose.cells = require("aspose.cells");
var fs = require("fs");
var workbook = new aspose.cells.Workbook("Book2.xlsx");
var imgOptions = new aspose.cells.ImageOrPrintOptions();
imgOptions.setHorizontalResolution(200);
imgOptions.setVerticalResolution(300);
imgOptions.setImageFormat(aspose.cells.ImageFormat.getJpeg());
imgWriteStream = fs.createWriteStream("chart.jpeg");
var chart = workbook.getWorksheets().get("Chart").getCharts().get(0);
aspose.cells.Chart.toImageStream(chart, imgWriteStream, imgOptions);

Parameters

Name Type Optional Description

chart

Chart

 

The Chart object

stream

WritableStream

 

The stream of the output image

options

ImageOrPrintOptions

 

Addtional image creation options

static

toPdfStream(chart, stream)

Creates the chart pdf and saves it to a stream.

Example

var aspose = aspose || {};
aspose.cells = require("aspose.cells");
var fs = require("fs");
var workbook = new aspose.cells.Workbook("Book2.xlsx");
var chart = workbook.getWorksheets().get("Chart").getCharts().get(0);
var imgWriteStream = fs.createWriteStream("chart.pdf");
aspose.cells.Chart.toPdfStream(chart, imgWriteStream);

Parameters

Name Type Optional Description

chart

Chart

 

The Chart object

stream

WritableStream

 

The output stream

calculate()

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

getActualChartSize()

Gets actual size of chart

getAutoScaling()

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.

getBackWall()

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

getCategoryAxis()

Gets the chart's X axis.

getChartArea()

Gets the chart area in the worksheet

getChartDataRange() → String

Gets the data source range of the chart . Only supports range.

Returns

String The data source.

getChartDataTable()

Represents the chart data table.

getChartObject()

Represents the 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.

getDepthPercent()

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

getDisplayNaAsBlank()

Indicates whether displaying #N/A as blank value.

getElevation()

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.

getFirstSliceAngle()

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.

getFloor()

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

getGapDepth()

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.

getGapWidth()

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.

getHeightPercent()

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

getHidePivotFieldButtons()

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

getIs3D()

Indicates whether the chart is a 3d chart.

getLegend()

Gets the chart legend.

getLine()

Gets the line.

getName()

Gets and sets the name of the chart.

getNSeries()

Gets a SeriesCollection collection representing the data series in the chart.

getPageSetup()

Represents the page setup description in this chart.

getPerspective()

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.

getPivotOptions()

Specifies the pivot controls that appear on the chart

getPivotSource()

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.

getPlacement()

Represents the way the chart is attached to the cells below it. The value of the property is PlacementType integer constant.

getPlotArea()

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

getPlotBy()

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

getPlotEmptyCellsType()

Gets and sets how to plot the empty cells. The value of the property is PlotEmptyCellsType integer constant.

getPlotVisibleCells()

Indicates whether only plot visible cells.

getPrintSize()

Gets and sets the printed chart size. The value of the property is PrintSizeType integer constant.

getRightAngleAxes()

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.

getRotationAngle()

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.

getSecondCategoryAxis()

Gets the chart's second X axis.

getSecondValueAxis()

Gets the chart's second Y axis.

getSeriesAxis()

Gets the chart's series axis.

getShapes()

Returns all drawing shapes in this chart.

getShowDataTable()

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

getShowLegend()

Gets or sets a value indicating whether the chart legend will be displayed. Default is true.

getSideWall()

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

getSizeWithWindow()

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

getStyle()

Gets and sets the builtin style. It should be between 1 and 48. Return -1 if it's not be set.

getSubTitle()

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

getTitle()

Gets the chart's title.

getType()

Gets or sets a chart's type. The value of the property is ChartType integer constant.

getValueAxis()

Gets the chart's Y axis.

getWalls()

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

getWallsAndGridlines2D()

True if gridlines are drawn two-dimensionally on a 3-D chart.

getWorksheet()

Gets the worksheet which contains this chart.

hasAxis()

Returns which axes exist on the chart. Normally, Pie, PieExploded, PiePie,PieBar, Pie3D, Pie3DExploded,Doughnut, DoughnutExploded is no axis.

isChartDataChanged() → boolean

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

boolean Returns true if the chart has changed otherwise returns false

isRectangularCornered()

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

move(upperLeftColumn, upperLeftRow, lowerRightColumn, lowerRightRow)

Moves the chart to a specified location.

Parameters

Name Type Optional Description

upperLeftColumn

Number

 

Upper left column index.

upperLeftRow

Number

 

Upper left row index.

lowerRightColumn

Number

 

Lower right column index

lowerRightRow

Number

 

Lower right row index

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.

setAutoScaling()

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.

setChartDataRange(area, isVertical)

Specifies data range for a chart.

Parameters

Name Type Optional Description

area

String

 

Specifies values from which to plot the data series

isVertical

boolean

 

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

setDepthPercent()

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

setDisplayNaAsBlank()

Indicates whether displaying #N/A as blank value.

setElevation()

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.

setFirstSliceAngle()

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.

setGapDepth()

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.

setGapWidth()

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.

setHeightPercent()

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

setHidePivotFieldButtons()

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

setName()

Gets and sets the name of the chart.

setPerspective()

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.

setPivotSource()

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.

setPlacement()

Represents the way the chart is attached to the cells below it. The value of the property is PlacementType integer constant.

setPlotEmptyCellsType()

Gets and sets how to plot the empty cells. The value of the property is PlotEmptyCellsType integer constant.

setPlotVisibleCells()

Indicates whether only plot visible cells.

setPrintSize()

Gets and sets the printed chart size. The value of the property is PrintSizeType integer constant.

setRectangularCornered()

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

setRightAngleAxes()

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.

setRotationAngle()

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.

setShowDataTable()

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

setShowLegend()

Gets or sets a value indicating whether the chart legend will be displayed. Default is true.

setSizeWithWindow()

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

setStyle()

Gets and sets the builtin style. It should be between 1 and 48. Return -1 if it's not be set.

setType()

Gets or sets a chart's type. The value of the property is ChartType integer constant.

setWallsAndGridlines2D()

True if gridlines are drawn two-dimensionally on a 3-D chart.

switchRowColumn() → boolean

Switches row/column.

Returns

boolean False means switching row/column fails.

toImage(imageFile)

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.

Parameter

Name Type Optional Description

imageFile

String

 

The image file name with full path.

toImage(imageFile, imageFormat)

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

Name Type Optional Description

imageFile

String

 

The image file name with full path.

imageFormat

ImageFormat

 

The format in which to save the image.

toImage(imageFile, jpegQuality)

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

Name Type Optional Description

imageFile

String

 

The image file name with full path.

jpegQuality

long

 

Jpeg quality.

toImage(imageFile, options)

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.

Example

var options = new aspose.cells.ImageOrPrintOptions();
options.setHorizontalResolution(300);
options.setVerticalResolution(300);
var book = new aspose.cells.Workbook("Book1.xls");
book.getWorksheets().get(0).getCharts().get(0).toImage("chart.png", options);

Parameters

Name Type Optional Description

imageFile

String

 

The image file name with full path.

options

ImageOrPrintOptions

 

Additional image creation options

toPdf(fileName)

Saves the chart to a pdf file.

Parameter

Name Type Optional Description

fileName

String

 

the pdf file name with full path

toPdf(fileName, desiredPageWidth, desiredPageHeight, hAlignmentType, vAlignmentType)

Saves the chart to a pdf file.

Parameters

Name Type Optional Description

fileName

String

 

the pdf file name with full path

desiredPageWidth

Number

 

The desired page width in inches.

desiredPageHeight

Number

 

The desired page height in inches.

hAlignmentType

Number

 

PageLayoutAlignmentType

vAlignmentType

Number

 

PageLayoutAlignmentType