public interface IChart
| Modifier and Type | Method and Description |
|---|---|
IShape |
addChart(ChartType chartType,
double left,
double top,
double width,
double height)
Creates a chart at the specified location on the chart.
|
IShape |
addChartInPixel(ChartType chartType,
double left,
double top,
double width,
double height)
Creates a chart at the specified location on the chart.
|
IShape |
addConnector(ConnectorType type,
double beginX,
double beginY,
double endX,
double endY)
Creates a connector.
|
IShape |
addConnectorInPixel(ConnectorType type,
double beginX,
double beginY,
double endX,
double endY)
Creates a connector.
|
IShape |
addPicture(java.io.InputStream stream,
ImageType type,
double left,
double top,
double width,
double height)
Creates a picture from an existing stream.
|
IShape |
addPicture(java.lang.String filename,
double left,
double top,
double width,
double height)
Creates a picture from an existing file.
|
IShape |
addPictureInPixel(java.io.InputStream stream,
ImageType type,
double left,
double top,
double width,
double height)
Creates a picture from an existing stream.
|
IShape |
addPictureInPixel(java.lang.String filename,
double left,
double top,
double width,
double height)
Creates a picture from an existing file.
|
IShape |
addShape(AutoShapeType type,
double left,
double top,
double width,
double height)
Returns the
IShape object that represents the new AutoShape in the chart. |
IShape |
addShapeInPixel(AutoShapeType type,
double left,
double top,
double width,
double height)
Returns the
IShape object that represents the new AutoShape in the chart. |
void |
delete()
Deletes the object.
|
IChartGroup |
getArea3DGroup()
Returns the
IChartGroup object that represents the area chart group
on a 3-D chart. |
IChartGroups |
getAreaGroups()
Returns an object that represents a collection of the area chart groups
IChartGroups, on a 2D chart. |
boolean |
getAutoScaling()
Gets the scaling (True to scale a 3-D chart so that it's closer in size to
the equivalent 2-D chart.
|
IAxes |
getAxes()
Returns an object that represents a collection of the axes on the chart.
|
IWall |
getBackWall()
Returns the
IWall object that allows the user to individually format
the back wall of a 3-D chart. |
IChartGroup |
getBar3DGroup()
Returns the
IChartGroup object that represents the bar chart group on
a 3-D chart. |
IChartGroups |
getBarGroups()
Returns an object that represents a collection of the bar chart groups
IChartGroups, on a 2D chart. |
BarShape |
getBarShape()
Returns the shape used with the 3-D bar or column chart.
|
IChartArea |
getChartArea()
Returns the
IChartArea object that represents the complete chart area
for the chart. |
IChartGroups |
getChartGroups()
Returns an object that represents a collection of all the chart groups in the
chart
IChartGroups. |
IChartTitle |
getChartTitle()
Returns the
IChartTitle object that represents the title of the
specified chart. |
ChartType |
getChartType()
Returns the chart type.
|
IChartGroup |
getColumn3DGroup()
Returns the
IChartGroup object that represents the column chart group
on a 3-D chart. |
IChartGroups |
getColumnGroups()
Returns an object that represents a collection of the column chart groups
IChartGroups, on a 2D chart. |
IDataTable |
getDataTable()
Returns the
IDataTable object that represents the chart data table. |
int |
getDepthPercent()
Returns the depth of a 3-D chart as a percentage of the chart width (between
20 and 2000 percent).
|
DisplayBlanksAs |
getDisplayBlanksAs()
Returns the way that blank cells are plotted on a chart.
|
boolean |
getDisplayNaAsBlank()
Gets whether show #N/A as empty cell.
|
IChartGroups |
getDoughnutGroups()
Returns an object that represents a collection of the doughnut chart groups
IChartGroups, on a 2D chart. |
double |
getElevation()
Returns the elevation of the 3-D chart view in degrees.
|
IFloor |
getFloor()
Returns the
IFloor object that represents the floor of the 3-D chart. |
int |
getGapDepth()
Returns the distance between the data series in a 3-D chart as a percentage
of the marker width.
|
boolean |
getHasDataTable()
Gets a value indicating whether the chart displays a data table.
|
boolean |
getHasLegend()
Gets whether the chart has a legend.
|
boolean |
getHasTitle()
Gets whether the axis or chart has a visible title.
|
int |
getHeightPercent()
Returns the height of a 3-D chart as a percentage of the chart width (between
5 and 500 percent).
|
ILegend |
getLegend()
Returns the
ILegend object that represents the legend for the chart. |
IChartGroup |
getLine3DGroup()
Returns the
IChartGroup object that represents the line chart group
on a 3-D chart. |
IChartGroups |
getLineGroups()
Returns an object that represents a collection of the line chart groups
IChartGroups, on a 2D chart. |
java.lang.String |
getName()
Returns the name of the object.
|
IShape |
getParent()
Returns the parent
IShape of the chart. |
int |
getPerspective()
Returns the perspective for the 3-D chart view.
|
IChartGroup |
getPie3DGroup()
Returns the
IChartGroup object that represents the pie chart group on
a 3-D chart. |
IChartGroups |
getPieGroups()
Returns an object that represents a collection of the pie chart groups
IChartGroups, on a 2D chart. |
IPivotOptions |
getPivotOptions()
Returns the
IPivotOptions object that represents the
options whether to display pivot chart buttons. |
IPivotTable |
getPivotTable()
Returns the
IPivotTable object that represents the the
PivotTable report containing the upper-left corner of the specified range, or
the PivotTable report associated with the PivotChart report. |
IPlotArea |
getPlotArea()
Returns the
IPlotArea object that represents the plot area of a
chart. |
boolean |
getPlotVisibleOnly()
Gets whether visible cells are plotted.
|
IChartGroups |
getRadarGroups()
Returns an object that represents a collection of the radar chart groups
IChartGroups, on a 2D chart. |
boolean |
getRightAngleAxes()
Gets whether the chart axes are at right angles, independent of chart
rotation or elevation.
|
double |
getRotation()
Returns the rotation of the 3-D chart view (the rotation of the plot area
around the z-axis in degrees).
|
ISeriesCollection |
getSeriesCollection()
Returns an object that represents a collection of all the series in the
chart.
|
java.util.List<IShape> |
getShapes()
Returns all drawing shapes in this chart.
|
boolean |
getShowDataLabelsOverMaximum()
Gets whether to show the data labels when the value is greater than the
maximum value on the value axis.
|
IWall |
getSideWall()
Returns the
IWall object that allows the user to individually format
the side wall of a 3-D chart. |
IChartGroup |
getSurfaceGroup()
Returns the
IChartGroup object that represents the surface chart
group of a 3-D chart. |
IWall |
getWalls()
Returns the
IWall object that represents the walls of the 3-D chart. |
IChartGroups |
getXYGroups()
Returns an object that represents a collection of the scatter chart groups
IChartGroups, on a 2D chart. |
void |
setAutoScaling(boolean value)
Sets the scaling (True to scale a 3-D chart so that it's closer in size to
the equivalent 2-D chart.
|
void |
setBarShape(BarShape value)
Sets the shape used with the 3-D bar or column chart.
|
void |
setChartType(ChartType value)
Sets the chart type.
|
void |
setDepthPercent(int value)
Sets the depth of a 3-D chart as a percentage of the chart width (between 20
and 2000 percent).
|
void |
setDisplayBlanksAs(DisplayBlanksAs value)
Sets the way that blank cells are plotted on a chart.
|
void |
setDisplayNaAsBlank(boolean value)
Sets whether show #N/A as empty cell.
|
void |
setElevation(double value)
Sets the elevation of the 3-D chart view in degrees.
|
void |
setGapDepth(int value)
Sets the distance between the data series in a 3-D chart as a percentage of
the marker width.
|
void |
setHasDataTable(boolean value)
Sets a value indicating whether the chart displays a data table.
|
void |
setHasLegend(boolean value)
Sets whether the chart has a legend.
|
void |
setHasTitle(boolean value)
Sets whether the axis or chart has a visible title.
|
void |
setHeightPercent(int value)
Sets the height of a 3-D chart as a percentage of the chart width (between 5
and 500 percent).
|
void |
setPerspective(int value)
Sets the perspective for the 3-D chart view.
|
void |
setPlotVisibleOnly(boolean value)
Sets whether visible cells are plotted.
|
void |
setRightAngleAxes(boolean value)
Sets whether the chart axes are at right angles, independent of chart
rotation or elevation.
|
void |
setRotation(double value)
Sets the rotation of the 3-D chart view (the rotation of the plot area around
the z-axis in degrees).
|
void |
setShowDataLabelsOverMaximum(boolean value)
Sets whether to show the data labels when the value is greater than the
maximum value on the value axis.
|
void |
setSourceData(IRange source)
Sets the source data range for the chart.
|
void |
setSourceData(IRange source,
RowCol plotBy)
Sets the source data range for the chart.
|
java.lang.String getName()
ChartType getChartType()
void setChartType(ChartType value)
ISeriesCollection getSeriesCollection()
IAxes getAxes()
IChartArea getChartArea()
IChartArea object that represents the complete chart area
for the chart.IChartTitle getChartTitle()
IChartTitle object that represents the title of the
specified chart.IPlotArea getPlotArea()
IPlotArea object that represents the plot area of a
chart.IDataTable getDataTable()
IDataTable object that represents the chart data table.IWall getSideWall()
IWall object that allows the user to individually format
the side wall of a 3-D chart.IWall getBackWall()
IWall object that allows the user to individually format
the back wall of a 3-D chart.boolean getAutoScaling()
void setAutoScaling(boolean value)
BarShape getBarShape()
void setBarShape(BarShape value)
boolean getPlotVisibleOnly()
void setPlotVisibleOnly(boolean value)
boolean getDisplayNaAsBlank()
void setDisplayNaAsBlank(boolean value)
int getDepthPercent()
void setDepthPercent(int value)
DisplayBlanksAs getDisplayBlanksAs()
DisplayBlanksAs constants: NotPlotted, Interpolated, or
Zero.void setDisplayBlanksAs(DisplayBlanksAs value)
DisplayBlanksAs constants: NotPlotted, Interpolated, or
Zero.double getElevation()
void setElevation(double value)
int getGapDepth()
void setGapDepth(int value)
boolean getHasLegend()
void setHasLegend(boolean value)
boolean getHasDataTable()
void setHasDataTable(boolean value)
boolean getHasTitle()
void setHasTitle(boolean value)
int getHeightPercent()
void setHeightPercent(int value)
int getPerspective()
void setPerspective(int value)
boolean getRightAngleAxes()
void setRightAngleAxes(boolean value)
double getRotation()
void setRotation(double value)
boolean getShowDataLabelsOverMaximum()
void setShowDataLabelsOverMaximum(boolean value)
java.util.List<IShape> getShapes()
IPivotTable getPivotTable()
IPivotTable object that represents the the
PivotTable report containing the upper-left corner of the specified range, or
the PivotTable report associated with the PivotChart report.IPivotOptions getPivotOptions()
IPivotOptions object that represents the
options whether to display pivot chart buttons.IChartGroup getArea3DGroup()
IChartGroup object that represents the area chart group
on a 3-D chart.IChartGroup getBar3DGroup()
IChartGroup object that represents the bar chart group on
a 3-D chart.IChartGroup getColumn3DGroup()
IChartGroup object that represents the column chart group
on a 3-D chart.IChartGroup getLine3DGroup()
IChartGroup object that represents the line chart group
on a 3-D chart.IChartGroup getPie3DGroup()
IChartGroup object that represents the pie chart group on
a 3-D chart.IChartGroup getSurfaceGroup()
IChartGroup object that represents the surface chart
group of a 3-D chart.IChartGroups getAreaGroups()
IChartGroups, on a 2D chart.IChartGroups getBarGroups()
IChartGroups, on a 2D chart.IChartGroups getColumnGroups()
IChartGroups, on a 2D chart.IChartGroups getDoughnutGroups()
IChartGroups, on a 2D chart.IChartGroups getLineGroups()
IChartGroups, on a 2D chart.IChartGroups getPieGroups()
IChartGroups, on a 2D chart.IChartGroups getRadarGroups()
IChartGroups, on a 2D chart.IChartGroups getXYGroups()
IChartGroups, on a 2D chart.IChartGroups getChartGroups()
IChartGroups. The returned collection includes every type of
group.IShape addShape(AutoShapeType type, double left, double top, double width, double height)
IShape object that represents the new AutoShape in the chart.type - Specifies the type of AutoShape to create.left - The distance from the left edge of the AutoShape's boundary box to the left edge of the chart area, in points.top - The distance from the top edge of the AutoShape's boundary box to the top edge of the chart area, in points.width - The width of the AutoShape's boundary box, in points.height - The height of the AutoShape's boundary box, in points.IShapeThe object.IShape addChart(ChartType chartType, double left, double top, double width, double height)
chartType - The chart typeleft - The distance from the left edge of the chart to the left edge of the chart area, in points.top - The distance from the top edge of the chart to the top edge of the chart area, in points.width - The width, in points, of the objectheight - The height, in points, of the objectIShapeThe object.IShape addConnector(ConnectorType type, double beginX, double beginY, double endX, double endY)
IShape object that represents the new connector.type - The connector type to add.beginX - The horizontal position of the connector's starting point relative to the upper-left corner of the chart area, in points.beginY - The vertical position of the connector's starting point relative to the upper-left corner of the chart area, in points.endX - The horizontal position of the connector's end point relative to the upper-left corner of the chart area, in points.endY - The veritcal position of the connector's end point relative to the upper-left corner of the chart area, in points.IShape object.IShape addPicture(java.lang.String filename, double left, double top, double width, double height) throws java.io.IOException
IShape object that represents the new picture.filename - The file from which the object is to be created.left - The distance from the left edge of the picture to the left edge of the chart area, in points.top - The distance from the top edge of the picture to the top edge of the chart area, in points.width - The width of the picture, in points.height - The height of the picture, in points.IShapeThe object.java.io.IOExceptionIShape addPicture(java.io.InputStream stream, ImageType type, double left, double top, double width, double height) throws java.io.IOException
IShape object that represents the new picture.stream - The stream from which the object is to be created.type - Specifies the type of picture to create.left - The distance from the left edge of the picture to the left edge of the chart area, in points.top - The distance from the top edge of the picture to the top edge of the chart area, in points.width - The width of the picture, in points.height - The height of the picture, in points.IShapeThe object.java.io.IOExceptionIShape addShapeInPixel(AutoShapeType type, double left, double top, double width, double height)
IShape object that represents the new AutoShape in the chart.type - Specifies the type of AutoShape to create.left - The distance from the left edge of the AutoShape's boundary box to the left edge of the chart area, in pixels.top - The distance from the top edge of the AutoShape's boundary box to the top edge of the chart area, in pixels.width - The width of the AutoShape's boundary box, in pixels.height - The height of the AutoShape's boundary box, in pixels.IShapeThe object.IShape addChartInPixel(ChartType chartType, double left, double top, double width, double height)
chartType - The chart typeleft - The distance from the left edge of the chart to the left edge of the chart area, in pixels.top - The distance from the top edge of the chart to the top edge of the chart area, in pixels.width - The width, in pixels, of the objectheight - The height, in pixels, of the objectIShapeThe object.IShape addConnectorInPixel(ConnectorType type, double beginX, double beginY, double endX, double endY)
IShape object that represents the new connector.type - The connector type to add.beginX - The horizontal position of the connector's starting point relative to the upper-left corner of the chart area, in pixels.beginY - The vertical position of the connector's starting point relative to the upper-left corner of the chart area, in pixels.endX - The horizontal position of the connector's end point relative to the upper-left corner of the chart area, in pixels.endY - The veritcal position of the connector's end point relative to the upper-left corner of the chart area, in pixels.IShape object.IShape addPictureInPixel(java.lang.String filename, double left, double top, double width, double height) throws java.io.IOException
IShape object that represents the new picture.filename - The file from which the object is to be created.left - The distance from the left edge of the picture to the left edge of the chart area, in pixels.top - The distance from the top edge of the picture to the top edge of the chart area, in pixels.width - The width of the picture, in pixels.height - The height of the picture, in pixels.IShapeThe object.java.io.IOExceptionIShape addPictureInPixel(java.io.InputStream stream, ImageType type, double left, double top, double width, double height) throws java.io.IOException
IShape object that represents the new picture.stream - The stream from which the object is to be created.type - Specifies the type of picture to create.left - The distance from the left edge of the picture to the left edge of the chart area, in pixels.top - The distance from the top edge of the picture to the top edge of the chart area, in pixels.width - The width of the picture, in pixels.height - The height of the picture, in pixels.IShapeThe object.java.io.IOExceptionvoid setSourceData(IRange source, RowCol plotBy)
source - The range that contains the source data.plotBy - Specifies the way the data is to be plotted. Can be either of the
following RowCol constants: Columns or Rows.void setSourceData(IRange source)
source - The range that contains the source data.void delete()