com.spire.xls.core
Interface IChart

All Known Subinterfaces:

IChartShape

All Known Implementing Classes:

Chart, ChartSheet, XlsChart, XlsChartShape

public interface IChart

Method Summary

boolean	getAutoScaling() True if Microsoft Excel scales a 3-D chart so that it's closer in size to the equivalent 2-D chart.
IChartFrameFormat	getChartArea() Returns an object that represents the complete chart area for the chart.
ExcelChartType	getChartType() Type of the chart.
IXLSRange	getDataRange() DataRange for the chart series.
IChartDataTable	getDataTable() Represents charts dataTable object.
int	getDepthPercent() Returns or sets the depth of a 3-D chart as a percentage of the chart width (between 20 and 2000 percent).
boolean	getDisplayAxisFieldButtons() Gets or sets a value indicating whether [show axis field buttons].
ChartPlotEmptyType	getDisplayBlanksAs() Represents the way that blank cells are plotted on a chart.
boolean	getDisplayEntireFieldButtons() Gets or sets a value indicating whether [show all field buttons].
boolean	getDisplayLegendFieldButtons() Gets or sets a value indicating whether [show legend field buttons].
boolean	getDisplayValueFieldButtons() Gets or sets a value indicating whether [show value field buttons].
int	getElevation() Returns or sets the elevation of the 3-D chart view, in degrees (?0 to +90 degrees).
IChartWallOrFloor	getFloor() Represents chart floor.
int	getGapDepth() Returns or sets the distance between the data series in a 3-D chart, as a percentage of the marker width.( 0 - 500 )
double	getHeightForDouble() Height of the chart in points (1/72 inch).
int	getHeightPercent() Returns or sets the height of a 3-D chart as a percentage of the chart width (between 5 and 500 percent).
IChartLegend	getLegend() Represents chart legend.
java.lang.String	getName() Name of the chart's worksheet.
IChartPageSetup	getPageSetup() Page setup for the chart.
int	getPerspective() Returns or sets the perspective for the 3-D chart view (0 to 100).
ExcelChartType	getPivotChartType() Gets or sets the type of the pivot chart.
PivotTable	getPivotTable() Gets or sets the pivot source.
IChartFrameFormat	getPlotArea() Returns plot area frame format.
boolean	getPlotVisibleOnly() True if only visible cells are plotted.
IChartCategoryAxis	getPrimaryCategoryAxis() Primary category axis.
IChartSeriesAxis	getPrimarySerieAxis() Primary serie axis.
IChartValueAxis	getPrimaryValueAxis() Primary value axis.
boolean	getRightAngleAxes() True if the chart axes are at right angles, independent of chart rotation or elevation.
int	getRotation() Returns or sets the rotation of the 3-D chart view (the rotation of the plot area around the z-axis, in degrees).(0 to 360 degrees).
IChartCategoryAxis	getSecondaryCategoryAxis() Secondary category axis.
IChartValueAxis	getSecondaryValueAxis() Secondary value axis.
boolean	getSeriesDataFromRange() True if series are in rows in DataRange; False otherwise.
boolean	getShowReportFilterFieldButtons() Gets or sets a value indicating whether [show report filter field buttons].
boolean	getSizeWithWindow() True if Microsoft Excel resizes the chart to match the size of the chart sheet window.
IChartWallOrFloor	getWalls() Represents chart walls.
boolean	getWallsAndGridlines2D() True if gridlines are drawn two-dimensionally on a 3-D chart.
double	getWidthForDouble() Width of the chart in points (1/72 inch).
double	getXPos() X coordinate of the upper-left corner of the chart in points (1/72 inch).
double	getYPos() Y coordinate of the upper-left corner of the chart in points (1/72 inch).
boolean	hasDataTable() True if the chart has a data table.
void	hasDataTable(boolean value) True if the chart has a data table.
boolean	hasLegend() True if the chart has a legend object.
void	hasLegend(boolean value) True if the chart has a legend object.
boolean	hasPlotArea() Indicates whether chart has plot area.
void	hasPlotArea(boolean value) Indicates whether chart has plot area.
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.
void	setChartType(ExcelChartType value) Type of the chart.
void	setDataRange(IXLSRange value) DataRange for the chart series.
void	setDepthPercent(int value) Returns or sets the depth of a 3-D chart as a percentage of the chart width (between 20 and 2000 percent).
void	setDisplayAxisFieldButtons(boolean value) Gets or sets a value indicating whether [show axis field buttons].
void	setDisplayBlanksAs(ChartPlotEmptyType value) Represents the way that blank cells are plotted on a chart.
void	setDisplayEntireFieldButtons(boolean value) Gets or sets a value indicating whether [show all field buttons].
void	setDisplayLegendFieldButtons(boolean value) Gets or sets a value indicating whether [show legend field buttons].
void	setDisplayValueFieldButtons(boolean value) Gets or sets a value indicating whether [show value field buttons].
void	setElevation(int value) Returns or sets the elevation of the 3-D chart view, in degrees (?0 to +90 degrees).
void	setGapDepth(int value) Returns or sets the distance between the data series in a 3-D chart, as a percentage of the marker width.( 0 - 500 )
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).
void	setPerspective(int value) Returns or sets the perspective for the 3-D chart view (0 to 100).
void	setPivotChartType(ExcelChartType value) Gets or sets the type of the pivot chart.
void	setPivotTable(PivotTable value) Gets or sets the pivot source.
void	setPlotVisibleOnly(boolean value) True if only visible cells are plotted.
void	setRightAngleAxes(boolean value) True if the chart axes are at right angles, independent of chart rotation or elevation.
void	setRotation(int value) Returns or sets the rotation of the 3-D chart view (the rotation of the plot area around the z-axis, in degrees).(0 to 360 degrees).
void	setSeriesDataFromRange(boolean value) True if series are in rows in DataRange; False otherwise.
void	setShowReportFilterFieldButtons(boolean value) Gets or sets a value indicating whether [show report filter field buttons].
void	setSizeWithWindow(boolean value) True if Microsoft Excel resizes the chart to match the size of the chart sheet window.
void	setWallsAndGridlines2D(boolean value) True if gridlines are drawn two-dimensionally on a 3-D chart.

Method Detail

getChartType

ExcelChartType getChartType()

Type of the chart.

setChartType

void setChartType(ExcelChartType value)

Type of the chart.

getDataRange

IXLSRange getDataRange()

DataRange for the chart series.

setDataRange

void setDataRange(IXLSRange value)

DataRange for the chart series.

getSeriesDataFromRange

boolean getSeriesDataFromRange()

True if series are in rows in DataRange; False otherwise.

setSeriesDataFromRange

void setSeriesDataFromRange(boolean value)

True if series are in rows in DataRange; False otherwise.

getPageSetup

IChartPageSetup getPageSetup()

Page setup for the chart. Read-only.

getXPos

double getXPos()

X coordinate of the upper-left corner of the chart in points (1/72 inch).

getYPos

double getYPos()

Y coordinate of the upper-left corner of the chart in points (1/72 inch).

getWidthForDouble

double getWidthForDouble()

Width of the chart in points (1/72 inch).

getHeightForDouble

double getHeightForDouble()

Height of the chart in points (1/72 inch).

getName

java.lang.String getName()

Name of the chart's worksheet.

getPrimaryCategoryAxis

IChartCategoryAxis getPrimaryCategoryAxis()

Primary category axis. Read-only.

getPrimaryValueAxis

IChartValueAxis getPrimaryValueAxis()

Primary value axis. Read-only.

getPrimarySerieAxis

IChartSeriesAxis getPrimarySerieAxis()

Primary serie axis. Read-only.

getSecondaryCategoryAxis

IChartCategoryAxis getSecondaryCategoryAxis()

Secondary category axis. Read-only.

getSecondaryValueAxis

IChartValueAxis getSecondaryValueAxis()

Secondary value axis. Read-only.

getChartArea

IChartFrameFormat getChartArea()

Returns an object that represents the complete chart area for the chart. Read-only.

getPlotArea

IChartFrameFormat getPlotArea()

Returns plot area frame format. Read-only.

getWalls

IChartWallOrFloor getWalls()

Represents chart walls. Read-only.

getFloor

IChartWallOrFloor getFloor()

Represents chart floor. Read-only.

getDataTable

IChartDataTable getDataTable()

Represents charts dataTable object.

hasDataTable

boolean hasDataTable()

True if the chart has a data table.

hasDataTable

void hasDataTable(boolean value)

True if the chart has a data table.

getLegend

IChartLegend getLegend()

Represents chart legend.

hasLegend

boolean hasLegend()

True if the chart has a legend object.

hasLegend

void hasLegend(boolean value)

True if the chart has a legend object.

getRotation

int getRotation()

Returns or sets the rotation of the 3-D chart view (the rotation of the plot area around the z-axis, in degrees).(0 to 360 degrees).

setRotation

void setRotation(int value)

Returns or sets the rotation of the 3-D chart view (the rotation of the plot area around the z-axis, in degrees).(0 to 360 degrees).

getElevation

int getElevation()

Returns or sets the elevation of the 3-D chart view, in degrees (?0 to +90 degrees).

setElevation

void setElevation(int value)

Returns or sets the elevation of the 3-D chart view, in degrees (?0 to +90 degrees).

getPerspective

int getPerspective()

Returns or sets the perspective for the 3-D chart view (0 to 100).

setPerspective

void setPerspective(int value)

Returns or sets the perspective for the 3-D chart view (0 to 100).

getHeightPercent

int getHeightPercent()

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

setHeightPercent

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

getDepthPercent

int getDepthPercent()

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

setDepthPercent

void setDepthPercent(int value)

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

getGapDepth

int getGapDepth()

Returns or sets the distance between the data series in a 3-D chart, as a percentage of the marker width.( 0 - 500 )

setGapDepth

void setGapDepth(int value)

Returns or sets the distance between the data series in a 3-D chart, as a percentage of the marker width.( 0 - 500 )

getRightAngleAxes

boolean getRightAngleAxes()

True if the chart axes are at right angles, independent of chart rotation or elevation.

setRightAngleAxes

void setRightAngleAxes(boolean value)

True if the chart axes are at right angles, independent of chart rotation or elevation.

getAutoScaling

boolean getAutoScaling()

True if Microsoft Excel scales a 3-D chart so that it's closer in size to the equivalent 2-D chart.

setAutoScaling

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.

getWallsAndGridlines2D

boolean getWallsAndGridlines2D()

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

setWallsAndGridlines2D

void setWallsAndGridlines2D(boolean value)

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

hasPlotArea

boolean hasPlotArea()

Indicates whether chart has plot area.

hasPlotArea

void hasPlotArea(boolean value)

Indicates whether chart has plot area.

getDisplayBlanksAs

ChartPlotEmptyType getDisplayBlanksAs()

Represents the way that blank cells are plotted on a chart.

setDisplayBlanksAs

void setDisplayBlanksAs(ChartPlotEmptyType value)

Represents the way that blank cells are plotted on a chart.

getPlotVisibleOnly

boolean getPlotVisibleOnly()

True if only visible cells are plotted. False if both visible and hidden cells are plotted.

setPlotVisibleOnly

void setPlotVisibleOnly(boolean value)

True if only visible cells are plotted. False if both visible and hidden cells are plotted.

getSizeWithWindow

boolean getSizeWithWindow()

True if Microsoft Excel resizes the chart to match the size of the chart sheet window. False if the chart size isn't attached to the window size. Applies only to chart sheets.

setSizeWithWindow

void setSizeWithWindow(boolean value)

True if Microsoft Excel resizes the chart to match the size of the chart sheet window. False if the chart size isn't attached to the window size. Applies only to chart sheets.

getPivotTable

PivotTable getPivotTable()

Gets or sets the pivot source.

setPivotTable

void setPivotTable(PivotTable value)

Gets or sets the pivot source.

getPivotChartType

ExcelChartType getPivotChartType()

Gets or sets the type of the pivot chart.

setPivotChartType

void setPivotChartType(ExcelChartType value)

Gets or sets the type of the pivot chart.

getDisplayEntireFieldButtons

boolean getDisplayEntireFieldButtons()

Gets or sets a value indicating whether [show all field buttons].

setDisplayEntireFieldButtons

void setDisplayEntireFieldButtons(boolean value)

Gets or sets a value indicating whether [show all field buttons].

getDisplayValueFieldButtons

boolean getDisplayValueFieldButtons()

Gets or sets a value indicating whether [show value field buttons].

setDisplayValueFieldButtons

void setDisplayValueFieldButtons(boolean value)

Gets or sets a value indicating whether [show value field buttons].

getDisplayAxisFieldButtons

boolean getDisplayAxisFieldButtons()

Gets or sets a value indicating whether [show axis field buttons].

setDisplayAxisFieldButtons

void setDisplayAxisFieldButtons(boolean value)

Gets or sets a value indicating whether [show axis field buttons].

getDisplayLegendFieldButtons

boolean getDisplayLegendFieldButtons()

Gets or sets a value indicating whether [show legend field buttons].

setDisplayLegendFieldButtons

void setDisplayLegendFieldButtons(boolean value)

Gets or sets a value indicating whether [show legend field buttons].

getShowReportFilterFieldButtons

boolean getShowReportFilterFieldButtons()

Gets or sets a value indicating whether [show report filter field buttons].

setShowReportFilterFieldButtons

void setShowReportFilterFieldButtons(boolean value)

Gets or sets a value indicating whether [show report filter field buttons].