![]() |
||
Home Products Purchase Downloads Demos Forums Blogs Ticket Wiki API Corporate |
|
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.aspose.cells.Chart
public class Chart
Encapsulates the object that represents a single Workbook chart.
Method Summary | |
---|---|
CategoryAxis |
getCategoryAxis()
Gets the chart's category axis. |
ChartArea |
getChartArea()
Gets the chart area in the worksheet. |
ChartDataTable |
getChartDataTable()
Gets chart data table. |
ChartShape |
getChartShape()
Gets the Shape object of this Chart. |
short |
getDepthPercent()
Represents the depth of a 3-D chart as a percentage of the chart width (between 20 and 2000 percent). |
int |
getElevation()
Gets the elevation of the 3-D chart view, in degrees(between -90 and 90). |
int |
getFirstSliceAngle()
Gets the angle of the first pie-chart or doughnut-chart slice, in degrees (clockwise from vertical). |
Floor |
getFloor()
Gets a Floor object that represents the walls of a 3-D chart. |
short |
getGapDepth()
Gets the distance between the data series in a 3-D chart, as a percentage of the marker width. |
int |
getGapWidth()
Gets the space between bar or column clusters, as a percentage of the bar or column width. |
short |
getHeightPercent()
Gets the height of a 3-D chart as a percentage of the chart width(between 5 and 500 percent). |
Legend |
getLegend()
Gets the chart legend. |
NSeries |
getNSeries()
Gets a NSeries object representing the data series in the chart. |
int |
getOverlap()
Sets the space between bar or column in a cluster, as a percentage of the bar or column width. |
PageSetup |
getPageSetup()
Gets the page setup description in this chart. |
int |
getPerspective()
Gets the perspective for the 3-D chart view. |
java.lang.String |
getPivotSource()
Gets the pivot source. |
PlotArea |
getPlotArea()
Gets the chart's plot area. |
byte |
getPlotEmptyCellsType()
Gets the type to plot empty cells as. |
byte |
getPrintSize()
Gets the printed chart size. |
int |
getRotation()
Gets the rotation of the 3-D chart view (the rotation of the plot area around the series axis, in degrees)(between 0 and 360). |
CategoryAxis |
getSecondCategoryAxis()
Gets the chart's second category axis. |
ValueAxis |
getSecondValueAxis()
Gets the chart's second value axis. |
ValueAxis |
getSecondValueXAxis()
Gets the chart's second value x axis.Only applies for Scatter and Bubble chart. |
SeriesAxis |
getSeriesAxis()
Gets the chart's series axis. |
Shapes |
getShapes()
Gets the Shapes object which this Chart is in. |
TextBoxes |
getTextBoxes()
Gets the TextBoxes collection. |
Title |
getTitle()
Gets the chart's title. |
int |
getType()
Gets a chart's type. |
ValueAxis |
getValueAxis()
Gets the chart's value axis. |
ValueAxis |
getValueXAxis()
Gets the chart's value x axis.Only applies for Scatter and Bubble chart. |
Walls |
getWalls()
Gets a Walls object that represents the walls of a 3-D chart. |
void |
hidePivotFieldButton(boolean isHidden)
Indeicates whether the pivot field button is hidden. |
boolean |
isAutoScaling()
True if Microsoft Excel scales a 3-D chart so that it's closer in size to the equivalent 2-D chart. |
boolean |
isDataTableShown()
Indicates whether the chart displays a data table. |
boolean |
isHiddenPivotFieldButton()
Gets whether the pivot field button is hidden. |
boolean |
isLegendOverlay()
Check whether the Legend overlaps chart. |
boolean |
isLegendShown()
Indicates whether the chart legend will be displayed. |
boolean |
isPlotVisibleCells()
Indicates whether only plot visible cells. |
boolean |
isRightAngleAxes()
True if the chart axes are at right angles, independent of chart rotation or elevation. |
boolean |
isSizeWithWindow()
Indicates whether Microsoft Excel resizes the chart to match the size of the chart sheet window. |
boolean |
isTitleOverlay()
Checks whether the chart title overlaps chart. |
boolean |
isWallsAndGridlines2D()
Indicates if gridlines are drawn two-dimensionally on a 3-D chart. |
void |
setAutoScaling(boolean isAutoScaling)
True if Microsoft Excel scales a 3-D chart so that it's closer in size to the equivalent 2-D chart. |
void |
setDataTableShown(boolean isDataTableShown)
Indicates whether the chart displays a data table. |
void |
setDepthPercent(int depthPercent)
Represents the depth of a 3-D chart view as a percentage of the chart width (between 20 and 2000 percent). |
void |
setElevation(int elevation)
Sets the elevation of the 3-D chart view, in degrees(between -90 and 90). |
void |
setFirstSliceAngle(int firstSliceAngle)
Sets the angle of the first pie-chart or doughnut-chart slice, in degrees (clockwise from vertical). |
void |
setGapDepth(int gapDepth)
Sets the distance between the data series in a 3-D chart, as a percentage of the marker width. |
void |
setGapWidth(int gapWidth)
Sets the space between bar or column clusters, as a percentage of the bar or column width. |
void |
setHeightPercent(int heightPercent)
Sets the height of a 3-D chart as a percentage of the chart width (between 5 and 500 percent). |
void |
setLegendOverlay(boolean overlay)
Sets whether the Legend overlaps chart. |
void |
setLegendShown(boolean isLegendShown)
Sets whether the chart legend will be displayed.Default is true. |
void |
setOverlap(int overlap)
Sets the space between bar or column in a cluster, as a percentage of the bar or column width. |
void |
setPerspective(int perspective)
Gets the perspective for the 3-D chart view. |
void |
setPivotSource(java.lang.String pivotSource)
Sets the pivot source.It means this chart is a PivotChart. |
void |
setPlotEmptyCellsType(byte type)
Sets the type to plot empty cells as. |
void |
setPlotVisibleCells(boolean val)
Sets whether only plot visible cells. |
void |
setPrintSize(byte printSize)
Sets the printed chart size. |
void |
setRightAngleAxes(boolean isRightAngleAxes)
True if the chart axes are at right angles, independent of chart rotation or elevation. |
void |
setRotation(int rotation)
Sets the rotation of the 3-D chart view (the rotation of the plot area around the series axis, in degrees)(between 0 and 360). |
void |
setSizeWithWindow(boolean val)
Sets whether Microsoft Excel resizes the chart to match the size of the chart sheet window. |
void |
setTitleOverlay(boolean overlay)
Sets whether the chart title overlaps chart. |
void |
setType(int type)
Sets a chart's type. |
void |
setWallsAndGridlines2D(boolean val)
set whether gridlines are drawn two-dimensionally on a 3-D chart. |
void |
toImage(java.io.OutputStream stream,
ImageOptions options)
Converts this chart to image and save the image to given stream. |
void |
toImage(java.lang.String file,
ImageOptions options)
Converts this chart to image and save the image to given file. |
Methods inherited from class java.lang.Object |
---|
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Method Detail |
---|
public Shapes getShapes()
public ChartShape getChartShape()
public TextBoxes getTextBoxes()
public int getType()
public void setType(int type)
type
- a chart's type.
CellsException
- if charts has bean removed.public byte getPrintSize()
public void setPrintSize(byte printSize)
printSize
- the printed chart size. Must be one of following:
PrintSizeType.FULL
, PrintSizeType.FIT
, PrintSizeType.CUSTOM
public boolean isPlotVisibleCells()
public void setPlotVisibleCells(boolean val)
val
- whether only plot visible cells.public boolean isSizeWithWindow()
public void setSizeWithWindow(boolean val)
val
- True if Microsoft Excel resizes the chart to match the size of the chart sheet window.public byte getPlotEmptyCellsType()
setPlotEmptyCellsType(byte)
public void setPlotEmptyCellsType(byte type)
type
- type to plot empty cells.PlotEmptyCellsType
public ChartArea getChartArea()
CellsException
- if charts has bean removed.public PlotArea getPlotArea()
CellsException
- if charts has bean removed.public CategoryAxis getCategoryAxis()
CellsException
- if charts has bean removed.public ValueAxis getValueAxis()
CellsException
- if charts has bean removed.public ValueAxis getValueXAxis()
CellsException
- if charts has bean removed.public CategoryAxis getSecondCategoryAxis()
CellsException
- if charts has bean removed.public ValueAxis getSecondValueAxis()
CellsException
- if charts has bean removed.public ValueAxis getSecondValueXAxis()
CellsException
- if charts has bean removed.public SeriesAxis getSeriesAxis()
CellsException
- if charts has bean removed.public NSeries getNSeries()
CellsException
- if charts has bean removed.public Legend getLegend()
CellsException
- if charts has bean removed.public boolean isLegendShown()
CellsException
- if charts has bean removed.public void setLegendShown(boolean isLegendShown)
isLegendShown
- whether the chart legend will be displayed.
CellsException
- if charts has bean removed.public boolean isLegendOverlay()
public void setLegendOverlay(boolean overlay)
overlay
- whether the Legend overlaps chart.public boolean isWallsAndGridlines2D()
public void setWallsAndGridlines2D(boolean val)
val
- if gridlines are drawn two-dimensionally on a 3-D chartpublic Title getTitle()
CellsException
- if charts has bean removed.public boolean isTitleOverlay()
public void setTitleOverlay(boolean overlay)
overlay
- whether the chart title overlaps chart.public Floor getFloor()
CellsException
- if charts has bean removed.public Walls getWalls()
CellsException
- if charts has bean removed.public boolean isDataTableShown()
CellsException
- if charts has bean removed.public void setDataTableShown(boolean isDataTableShown)
isDataTableShown
- whether the chart displays a data table.
CellsException
- if charts has bean removed.public ChartDataTable getChartDataTable()
CellsException
- if charts has bean removed.public short getDepthPercent()
CellsException
- if charts has bean removed.public void setDepthPercent(int depthPercent)
depthPercent
- the depth of a 3-D chart as a percentage of the chart width.
java.lang.IllegalArgumentException
- if depthPercent is not between 20 and 2000.
CellsException
- if charts has bean removed.public short getHeightPercent()
CellsException
- if charts has bean removed.public void setHeightPercent(int heightPercent)
heightPercent
- the height of a 3-D chart as a percentage of the chart width.
java.lang.IllegalArgumentException
- if heightPercent is not between 5 and 500.
CellsException
- if charts has bean removed.public int getElevation()
CellsException
- if charts has bean removed.public void setElevation(int elevation)
elevation
- the elevation of the 3-D chart view.
java.lang.IllegalArgumentException
- if elevation is not between -90 and 90.
CellsException
- if charts has bean removed.public int getPerspective()
CellsException
- if charts has bean removed.public void setPerspective(int perspective)
perspective
- the perspective for the 3-D chart view
CellsException
- if charts has bean removed.
java.lang.IllegalArgumentException
- if perspective is not between 0 and 100.public int getRotation()
CellsException
- if charts has bean removed.public void setRotation(int rotation)
rotation
- the rotation of the 3-D chart view.
java.lang.IllegalArgumentException
- if rotation is not between 0 and 360.
CellsException
- if charts has bean removed.public boolean isRightAngleAxes()
CellsException
- if charts has bean removed.public void setRightAngleAxes(boolean isRightAngleAxes)
isRightAngleAxes
- whether the chart axes are at right angles.
CellsException
- if charts has bean removed.public boolean isAutoScaling()
CellsException
- if charts has bean removed.public void setAutoScaling(boolean isAutoScaling)
isAutoScaling
- whether the chart auto scales.
CellsException
- if charts has bean removed.public int getFirstSliceAngle()
CellsException
- if charts has bean removed.public void setFirstSliceAngle(int firstSliceAngle)
firstSliceAngle
- the angle of the first pie-chart or doughnut-chart slice.
java.lang.IllegalArgumentException
- if firstSliceAngle is not between 0 and 360;
CellsException
- if charts has bean removed.public PageSetup getPageSetup()
CellsException
- if charts has bean removed.public int getGapWidth()
public void setGapWidth(int gapWidth)
gapWidth
- the space between bar or column clusters
java.lang.IllegalArgumentException
- if gapWidth is not between 0 and 500;public short getGapDepth()
public void setGapDepth(int gapDepth)
gapDepth
- the distance between the data series in a 3-D chart.public int getOverlap()
public void setOverlap(int overlap)
overlap
- the space between bar or column in a cluster.public void setPivotSource(java.lang.String pivotSource)
pivotSource
- the pivot table name.
The format should be SheetName!PivotTableName.public java.lang.String getPivotSource()
public void hidePivotFieldButton(boolean isHidden)
isHidden
- whether the pivot field button is hidden.public boolean isHiddenPivotFieldButton()
public void toImage(java.lang.String file, ImageOptions options)
file
- the image file to be generated.options
- settings for generating image.public void toImage(java.io.OutputStream stream, ImageOptions options)
stream
- the stream to save the generated image.options
- settings for generating image.
|
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |