Chart
Chart class
Encapsulates the object that represents a single Excel chart.
class Chart;
Methods
| Method | Description |
|---|---|
| getStyle() | Gets and sets the builtin style. |
| setStyle(number) | Gets and sets the builtin style. |
| getChartObject() | Represents the chartShape; |
| getHidePivotFieldButtons() | Indicates whether hide the pivot chart field buttons only when the chart is PivotChart. |
| setHidePivotFieldButtons(boolean) | Indicates whether hide the pivot chart field buttons only when the chart is PivotChart. |
| 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. |
| setPivotSource(string) | The source is the data of the pivotTable. If PivotSource is not empty ,the chart is PivotChart. |
| getPlotBy() | Gets and sets whether plot by row or column. |
| getPlotEmptyCellsType() | Gets and sets how to plot the empty cells. |
| setPlotEmptyCellsType(PlotEmptyCellsType) | Gets and sets how to plot the empty cells. |
| getPlotVisibleCellsOnly() | Indicates whether plot visible cells only. |
| setPlotVisibleCellsOnly(boolean) | Indicates whether plot visible cells only. |
| getDisplayNaAsBlank() | Indicates whether displaying #N/A as blank value. |
| setDisplayNaAsBlank(boolean) | Indicates whether displaying #N/A as blank value. |
| getName() | Gets and sets the name of the chart. |
| setName(string) | Gets and sets the name of the chart. |
| getSizeWithWindow() | True if Microsoft Excel resizes the chart to match the size of the chart sheet window. |
| setSizeWithWindow(boolean) | True if Microsoft Excel resizes the chart to match the size of the chart sheet window. |
| getWorksheet() | Gets the worksheet which contains this chart. |
| getShapes() | Returns all drawing shapes in this chart. |
| getPrintSize() | Gets and sets the printed chart size. |
| setPrintSize(PrintSizeType) | Gets and sets the printed chart size. |
| getType() | Gets or sets a chart’s type. |
| setType(ChartType) | Gets or sets a chart’s type. |
| getNSeries() | Gets a SeriesCollection collection representing the data series in the chart. |
| getFilteredNSeries() | Gets a SeriesCollection collection representing the data series that are filtered in the chart. |
| getTitle() | Gets the chart’s title. |
| getSubTitle() | Gets the chart’s sub-title. Only for ODS format file. |
| getPlotArea() | Gets the chart’s plot area which includes axis tick labels. |
| getChartArea() | Gets the chart area in the worksheet. |
| getCategoryAxis() | Gets the chart’s X axis. |
| getValueAxis() | Gets the chart’s Y axis. |
| getSecondValueAxis() | Gets the chart’s second Y axis. |
| getSecondCategoryAxis() | Gets the chart’s second X axis. |
| getSeriesAxis() | Gets the chart’s series axis. |
| getLegend() | Gets the chart legend. |
| getChartDataTable() | Represents the chart data table. |
| getShowLegend() | Gets or sets a value indicating whether the chart legend will be displayed. Default is true. |
| setShowLegend(boolean) | Gets or sets a value indicating whether the chart legend will be displayed. Default is true. |
| isRectangularCornered() | Gets or sets a value indicating whether the chart area is rectangular cornered. Default is true. |
| setIsRectangularCornered(boolean) | Gets or sets a value indicating whether the chart area is rectangular cornered. Default is true. |
| getShowDataTable() | Gets or sets a value indicating whether the chart displays a data table. |
| setShowDataTable(boolean) | Gets or sets a value indicating whether the chart displays a data table. |
| 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. |
| setFirstSliceAngle(number) | 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() | 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(number) | 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() | 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(number) | 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() | Returns a Floor object that represents the walls of a 3-D chart. |
| getWalls() | Returns a Walls object that represents the walls of a 3-D chart. |
| getBackWall() | Returns a Walls object that represents the back wall of a 3-D chart. |
| getSideWall() | Returns a Walls object that represents the side wall of a 3-D chart. |
| getWallsAndGridlines2D() | True if gridlines are drawn two-dimensionally on a 3-D chart. |
| setWallsAndGridlines2D(boolean) | True if gridlines are drawn two-dimensionally on a 3-D chart. |
| getRotationAngle() | Represents the rotation of the 3-D chart view (the rotation of the plot area around the z-axis, in degrees). |
| setRotationAngle(number) | Represents the rotation of the 3-D chart view (the rotation of the plot area around the z-axis, in degrees). |
| getElevation() | Represents the elevation of the 3-D chart view, in degrees. |
| setElevation(number) | Represents the elevation of the 3-D chart view, in degrees. |
| getRightAngleAxes() | True if the chart axes are at right angles. Applies only for 3-D charts(except Column3D and 3-D Pie Charts). |
| setRightAngleAxes(boolean) | True if the chart axes are at right angles. Applies only for 3-D charts(except Column3D and 3-D Pie Charts). |
| 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. |
| 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. |
| getHeightPercent() | Returns or sets the height of a 3-D chart as a percentage of the chart width (between 5 and 500 percent). |
| setHeightPercent(number) | Returns or sets the height of a 3-D chart as a percentage of the chart width (between 5 and 500 percent). |
| 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. |
| setPerspective(number) | 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() | Indicates whether the chart is a 3d chart. |
| getDepthPercent() | Represents the depth of a 3-D chart as a percentage of the chart width (between 20 and 2000 percent). |
| setDepthPercent(number) | Represents the depth of a 3-D chart as a percentage of the chart width (between 20 and 2000 percent). |
| getPlacement() | Represents the way the chart is attached to the cells below it. |
| setPlacement(PlacementType) | Represents the way the chart is attached to the cells below it. |
| getPageSetup() | Represents the page setup description in this chart. |
| getLine() | Gets the line. |
| isCellReferedByChart(number, number, number) | Returns whether the cell refered by the chart. |
| isChartDataChanged() | Detects if a chart’s data source has changed. |
| refreshPivotData() | Refreshes chart’s data from pivot table. |
| changeTemplate(number[]) | Change chart type with preset template. |
| move(number, number, number, number) | Moves the chart to a specified location. |
| calculate() | Calculates the custom position of plot area, axes if the position of them are auto assigned. |
| calculate(ChartCalculateOptions) | Calculates the custom position of plot area, axes if the position of them are auto assigned, with Chart Calculate Options. |
| toImage(string) | Creates the chart image and saves it to a file. The extension of the file name determines the format of the image. |
| toImage(string, ImageType) | Creates the chart image and saves it to a file in the specified image type. |
| toImage(string, number) | Creates the chart image and saves it to a file in the Jpeg format. |
| toImage(number) | Creates the chart image and saves it to a stream in the Jpeg format. |
| toImage(ImageType) | Creates the chart image and saves it to a stream in the specified format. |
| toImage(string, ImageOrPrintOptions) | Creates the chart image and saves it to a file. The extension of the file name determines the format of the image. |
| toImage(ImageOrPrintOptions) | Creates the chart image and saves it to a stream in the specified format. |
| toPdf(string) | Saves the chart to a pdf file. |
| toPdf(string, number, number, PageLayoutAlignmentType, PageLayoutAlignmentType) | Saves the chart to a pdf file. |
| toPdf() | Creates the chart pdf and saves it to a stream. |
| toPdf(number, number, PageLayoutAlignmentType, PageLayoutAlignmentType) | Creates the chart pdf and saves it to a stream. |
| getActualSize() | Gets actual size of chart in unit of pixels. |
| hasAxis(AxisType, boolean) | Returns which axes exist on the chart. |
| switchRowColumn() | Switches row/column. |
| getChartDataRange() | Gets the data source range of the chart. |
| setChartDataRange(string, boolean) | Specifies data range for a chart. |
getStyle()
Gets and sets the builtin style.
getStyle() : number;
Remarks
It should be between 1 and 48. Return -1 if it’s not be set.
setStyle(number)
Gets and sets the builtin style.
setStyle(value: number) : void;
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | number | The value to set. |
Remarks
It should be between 1 and 48. Return -1 if it’s not be set.
getChartObject()
Represents the chartShape;
getChartObject() : ChartShape;
Returns
getHidePivotFieldButtons()
Indicates whether hide the pivot chart field buttons only when the chart is PivotChart.
getHidePivotFieldButtons() : boolean;
setHidePivotFieldButtons(boolean)
Indicates whether hide the pivot chart field buttons only when the chart is PivotChart.
setHidePivotFieldButtons(value: boolean) : void;
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | boolean | The value to set. |
getPivotOptions()
Specifies the pivot controls that appear on the chart
getPivotOptions() : PivotOptions;
Returns
getPivotSource()
The source is the data of the pivotTable. If PivotSource is not empty ,the chart is PivotChart.
getPivotSource() : string;
Remarks
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(string)
The source is the data of the pivotTable. If PivotSource is not empty ,the chart is PivotChart.
setPivotSource(value: string) : void;
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | string | The value to set. |
Remarks
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()
Gets and sets whether plot by row or column.
getPlotBy() : PlotDataByType;
Returns
getPlotEmptyCellsType()
Gets and sets how to plot the empty cells.
getPlotEmptyCellsType() : PlotEmptyCellsType;
Returns
setPlotEmptyCellsType(PlotEmptyCellsType)
Gets and sets how to plot the empty cells.
setPlotEmptyCellsType(value: PlotEmptyCellsType) : void;
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | PlotEmptyCellsType | The value to set. |
getPlotVisibleCellsOnly()
Indicates whether plot visible cells only.
getPlotVisibleCellsOnly() : boolean;
setPlotVisibleCellsOnly(boolean)
Indicates whether plot visible cells only.
setPlotVisibleCellsOnly(value: boolean) : void;
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | boolean | The value to set. |
getDisplayNaAsBlank()
Indicates whether displaying #N/A as blank value.
getDisplayNaAsBlank() : boolean;
setDisplayNaAsBlank(boolean)
Indicates whether displaying #N/A as blank value.
setDisplayNaAsBlank(value: boolean) : void;
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | boolean | The value to set. |
getName()
Gets and sets the name of the chart.
getName() : string;
setName(string)
Gets and sets the name of the chart.
setName(value: string) : void;
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | string | The value to set. |
getSizeWithWindow()
True if Microsoft Excel resizes the chart to match the size of the chart sheet window.
getSizeWithWindow() : boolean;
setSizeWithWindow(boolean)
True if Microsoft Excel resizes the chart to match the size of the chart sheet window.
setSizeWithWindow(value: boolean) : void;
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | boolean | The value to set. |
getWorksheet()
Gets the worksheet which contains this chart.
getWorksheet() : Worksheet;
Returns
getShapes()
Returns all drawing shapes in this chart.
getShapes() : ShapeCollection;
Returns
getPrintSize()
Gets and sets the printed chart size.
getPrintSize() : PrintSizeType;
Returns
setPrintSize(PrintSizeType)
Gets and sets the printed chart size.
setPrintSize(value: PrintSizeType) : void;
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | PrintSizeType | The value to set. |
getType()
Gets or sets a chart’s type.
getType() : ChartType;
Returns
setType(ChartType)
Gets or sets a chart’s type.
setType(value: ChartType) : void;
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | ChartType | The value to set. |
getNSeries()
Gets a SeriesCollection collection representing the data series in the chart.
getNSeries() : SeriesCollection;
Returns
getFilteredNSeries()
Gets a SeriesCollection collection representing the data series that are filtered in the chart.
getFilteredNSeries() : SeriesCollection;
Returns
getTitle()
Gets the chart’s title.
getTitle() : Title;
Returns
getSubTitle()
Gets the chart’s sub-title. Only for ODS format file.
getSubTitle() : Title;
Returns
getPlotArea()
Gets the chart’s plot area which includes axis tick labels.
getPlotArea() : PlotArea;
Returns
getChartArea()
Gets the chart area in the worksheet.
getChartArea() : ChartArea;
Returns
getCategoryAxis()
Gets the chart’s X axis.
getCategoryAxis() : Axis;
Returns
getValueAxis()
Gets the chart’s Y axis.
getValueAxis() : Axis;
Returns
getSecondValueAxis()
Gets the chart’s second Y axis.
getSecondValueAxis() : Axis;
Returns
getSecondCategoryAxis()
Gets the chart’s second X axis.
getSecondCategoryAxis() : Axis;
Returns
getSeriesAxis()
Gets the chart’s series axis.
getSeriesAxis() : Axis;
Returns
getLegend()
Gets the chart legend.
getLegend() : Legend;
Returns
getChartDataTable()
Represents the chart data table.
getChartDataTable() : ChartDataTable;
Returns
getShowLegend()
Gets or sets a value indicating whether the chart legend will be displayed. Default is true.
getShowLegend() : boolean;
setShowLegend(boolean)
Gets or sets a value indicating whether the chart legend will be displayed. Default is true.
setShowLegend(value: boolean) : void;
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | boolean | The value to set. |
isRectangularCornered()
Gets or sets a value indicating whether the chart area is rectangular cornered. Default is true.
isRectangularCornered() : boolean;
setIsRectangularCornered(boolean)
Gets or sets a value indicating whether the chart area is rectangular cornered. Default is true.
setIsRectangularCornered(value: boolean) : void;
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | boolean | The value to set. |
getShowDataTable()
Gets or sets a value indicating whether the chart displays a data table.
getShowDataTable() : boolean;
setShowDataTable(boolean)
Gets or sets a value indicating whether the chart displays a data table.
setShowDataTable(value: boolean) : void;
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | boolean | The value to set. |
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.
getFirstSliceAngle() : number;
setFirstSliceAngle(number)
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(value: number) : void;
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | number | The value to set. |
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.
getGapWidth() : number;
setGapWidth(number)
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(value: number) : void;
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | number | The value to set. |
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.
getGapDepth() : number;
setGapDepth(number)
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(value: number) : void;
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | number | The value to set. |
getFloor()
Returns a Floor object that represents the walls of a 3-D chart.
getFloor() : Floor;
Returns
Remarks
This property doesn’t apply to 3-D pie charts.
getWalls()
Returns a Walls object that represents the walls of a 3-D chart.
getWalls() : Walls;
Returns
Remarks
This property doesn’t apply to 3-D pie charts.
getBackWall()
Returns a Walls object that represents the back wall of a 3-D chart.
getBackWall() : Walls;
Returns
getSideWall()
Returns a Walls object that represents the side wall of a 3-D chart.
getSideWall() : Walls;
Returns
getWallsAndGridlines2D()
True if gridlines are drawn two-dimensionally on a 3-D chart.
getWallsAndGridlines2D() : boolean;
setWallsAndGridlines2D(boolean)
True if gridlines are drawn two-dimensionally on a 3-D chart.
setWallsAndGridlines2D(value: boolean) : void;
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | boolean | The value to set. |
getRotationAngle()
Represents the rotation of the 3-D chart view (the rotation of the plot area around the z-axis, in degrees).
getRotationAngle() : number;
Remarks
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(number)
Represents the rotation of the 3-D chart view (the rotation of the plot area around the z-axis, in degrees).
setRotationAngle(value: number) : void;
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | number | The value to set. |
Remarks
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()
Represents the elevation of the 3-D chart view, in degrees.
getElevation() : number;
Remarks
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(number)
Represents the elevation of the 3-D chart view, in degrees.
setElevation(value: number) : void;
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | number | The value to set. |
Remarks
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()
True if the chart axes are at right angles. Applies only for 3-D charts(except Column3D and 3-D Pie Charts).
getRightAngleAxes() : boolean;
Remarks
If this property is True, the Perspective property is ignored.
setRightAngleAxes(boolean)
True if the chart axes are at right angles. Applies only for 3-D charts(except Column3D and 3-D Pie Charts).
setRightAngleAxes(value: boolean) : void;
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | boolean | The value to set. |
Remarks
If this property is True, the Perspective property is ignored.
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.
getAutoScaling() : boolean;
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.
setAutoScaling(value: boolean) : void;
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | boolean | The value to set. |
getHeightPercent()
Returns or sets the height of a 3-D chart as a percentage of the chart width (between 5 and 500 percent).
getHeightPercent() : number;
setHeightPercent(number)
Returns or sets the height of a 3-D chart as a percentage of the chart width (between 5 and 500 percent).
setHeightPercent(value: number) : void;
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | number | The value to set. |
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.
getPerspective() : number;
setPerspective(number)
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(value: number) : void;
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | number | The value to set. |
getIs3D()
Indicates whether the chart is a 3d chart.
getIs3D() : boolean;
getDepthPercent()
Represents the depth of a 3-D chart as a percentage of the chart width (between 20 and 2000 percent).
getDepthPercent() : number;
setDepthPercent(number)
Represents the depth of a 3-D chart as a percentage of the chart width (between 20 and 2000 percent).
setDepthPercent(value: number) : void;
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | number | The value to set. |
getPlacement()
Represents the way the chart is attached to the cells below it.
getPlacement() : PlacementType;
Returns
setPlacement(PlacementType)
Represents the way the chart is attached to the cells below it.
setPlacement(value: PlacementType) : void;
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | PlacementType | The value to set. |
getPageSetup()
Represents the page setup description in this chart.
getPageSetup() : PageSetup;
Returns
getLine()
Gets the line.
getLine() : Line;
Returns
isCellReferedByChart(number, number, number)
Returns whether the cell refered by the chart.
isCellReferedByChart(sheetIndex: number, rowIndex: number, columnIndex: number) : boolean;
Parameters:
| Parameter | Type | Description |
|---|---|---|
| sheetIndex | number | The sheet Index.-1 means the worksheet which contains current chart. |
| rowIndex | number | The row index |
| columnIndex | number | The column index |
isChartDataChanged()
Detects if a chart’s data source has changed.
isChartDataChanged() : boolean;
Returns
Returns true if the chart has changed otherwise returns false
Remarks
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.
refreshPivotData()
Refreshes chart’s data from pivot table.
refreshPivotData() : void;
Remarks
We will gather data from pivot data source to the pivot table report. This method is only used to gather all data to a pivot chart.
changeTemplate(number[])
Change chart type with preset template.
changeTemplate(data: number[]) : void;
Parameters:
| Parameter | Type | Description |
|---|---|---|
| data | number[] | The data of chart template file(.crtx). |
move(number, number, number, number)
Moves the chart to a specified location.
move(upperLeftRow: number, upperLeftColumn: number, lowerRightRow: number, lowerRightColumn: number) : void;
Parameters:
| Parameter | Type | Description |
|---|---|---|
| upperLeftRow | number | Upper left row index. |
| upperLeftColumn | number | Upper left column index. |
| lowerRightRow | number | Lower right row index |
| lowerRightColumn | number | Lower right column index |
calculate()
Calculates the custom position of plot area, axes if the position of them are auto assigned.
calculate() : void;
calculate(ChartCalculateOptions)
Calculates the custom position of plot area, axes if the position of them are auto assigned, with Chart Calculate Options.
calculate(calculateOptions: ChartCalculateOptions) : void;
Parameters:
| Parameter | Type | Description |
|---|---|---|
| calculateOptions | ChartCalculateOptions |
toImage(string)
Creates the chart image and saves it to a file. The extension of the file name determines the format of the image.
toImage(imageFile: string) : void;
Parameters:
| Parameter | Type | Description |
|---|---|---|
| imageFile | string | The image file name with full path. |
Remarks
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.toImage(string, ImageType)
Creates the chart image and saves it to a file in the specified image type.
toImage(imageFile: string, imageType: ImageType) : void;
Parameters:
| Parameter | Type | Description |
|---|---|---|
| imageFile | string | The image file name with full path. |
| imageType | ImageType | The image type in which to save the image. |
Remarks
The type of the image is specified by using
toImage(string, number)
Creates the chart image and saves it to a file in the Jpeg format.
toImage(imageFile: string, jpegQuality: number) : void;
Parameters:
| Parameter | Type | Description |
|---|---|---|
| imageFile | string | The image file name with full path. |
| jpegQuality | number | Jpeg quality. |
Remarks
If the width or height is zero or the chart is not supported according to Supported Charts List, this method will do nothing.
toImage(number)
Creates the chart image and saves it to a stream in the Jpeg format.
toImage(jpegQuality: number) : Uint8Array;
Parameters:
| Parameter | Type | Description |
|---|---|---|
| jpegQuality | number | Jpeg quality. |
Returns
The result stream
Remarks
If the width or height is zero or the chart is not supported according to Supported Charts List, this method will do nothing.
toImage(ImageType)
Creates the chart image and saves it to a stream in the specified format.
toImage(imageType: ImageType) : Uint8Array;
Parameters:
| Parameter | Type | Description |
|---|---|---|
| imageType | ImageType | The image type in which to save the image. |
Returns
The result stream
Remarks
The type of the image is specified by using
toImage(string, ImageOrPrintOptions)
Creates the chart image and saves it to a file. The extension of the file name determines the format of the image.
toImage(imageFile: string, options: ImageOrPrintOptions) : void;
Parameters:
| Parameter | Type | Description |
|---|---|---|
| imageFile | string | The image file name with full path. |
| options | ImageOrPrintOptions | Additional image creation options |
Remarks
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.toImage(ImageOrPrintOptions)
Creates the chart image and saves it to a stream in the specified format.
toImage(options: ImageOrPrintOptions) : Uint8Array;
Parameters:
| Parameter | Type | Description |
|---|---|---|
| options | ImageOrPrintOptions | Additional image creation options |
Returns
The result stream
Remarks
The type of the image is specified by using
toPdf(string)
Saves the chart to a pdf file.
toPdf(fileName: string) : void;
Parameters:
| Parameter | Type | Description |
|---|---|---|
| fileName | string | the pdf file name with full path |
toPdf(string, number, number, PageLayoutAlignmentType, PageLayoutAlignmentType)
Saves the chart to a pdf file.
toPdf(fileName: string, desiredPageWidth: number, desiredPageHeight: number, hAlignmentType: PageLayoutAlignmentType, vAlignmentType: PageLayoutAlignmentType) : void;
Parameters:
| Parameter | Type | 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 | PageLayoutAlignmentType | The chart horizontal alignment type in the output page. |
| vAlignmentType | PageLayoutAlignmentType | The chart vertical alignment type in the output page. |
toPdf()
Creates the chart pdf and saves it to a stream.
toPdf() : Uint8Array;
Returns
The result stream
toPdf(number, number, PageLayoutAlignmentType, PageLayoutAlignmentType)
Creates the chart pdf and saves it to a stream.
toPdf(desiredPageWidth: number, desiredPageHeight: number, hAlignmentType: PageLayoutAlignmentType, vAlignmentType: PageLayoutAlignmentType) : Uint8Array;
Parameters:
| Parameter | Type | Description |
|---|---|---|
| desiredPageWidth | number | The desired page width in inches. |
| desiredPageHeight | number | The desired page height in inches. |
| hAlignmentType | PageLayoutAlignmentType | The chart horizontal alignment type in the output page. |
| vAlignmentType | PageLayoutAlignmentType | The chart vertical alignment type in the output page. |
Returns
The result stream
getActualSize()
Gets actual size of chart in unit of pixels.
getActualSize() : number[];
Returns
Actual size in an array(width and height). [0] is width; [1] is height.
hasAxis(AxisType, boolean)
Returns which axes exist on the chart.
hasAxis(aixsType: AxisType, isPrimary: boolean) : boolean;
Parameters:
| Parameter | Type | Description |
|---|---|---|
| aixsType | AxisType | |
| isPrimary | boolean |
Remarks
Normally, Pie, PieExploded, PiePie,PieBar, Pie3D, Pie3DExploded,Doughnut, DoughnutExploded is no axis.
switchRowColumn()
Switches row/column.
switchRowColumn() : boolean;
Returns
False means switching row/column fails.
getChartDataRange()
Gets the data source range of the chart.
getChartDataRange() : string;
Returns
The data source.
Remarks
Only supports range.
setChartDataRange(string, boolean)
Specifies data range for a chart.
setChartDataRange(area: string, isVertical: boolean) : void;
Parameters:
| Parameter | Type | 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. |