com.spire.presentation.charts
Interface IChart

All Superinterfaces:

IShape

public interface IChart
extends IShape

Represents a ichart.

Method Summary

void	dispose() Dispose object and free resources.
java.lang.String	getAlternativeText() Gets or sets the alternative text associated with a shape.
ChartWallsOrFloor	getBackWall() Gets the back wall of a 3D chart.
int	getBubbleScale() Gets or sets the BubbleScale.
ChartCategoryCollection	getCategories() Gets chart's Categories.
ChartData	getChartData() data associated with a chart.
ChartDataTable	getChartDataTable() Gets a data table of a chart.
ChartLegend	getChartLegend() Gets or sets a legend for a chart.
ChartStyle	getChartStyle() Gets or sets the chart style.
ChartTextArea	getChartTitle() Gets or sets a chart title
ClickHyperlink	getClick() Gets or sets the hyperlink defined for mouse click.
DisplayBlanksAsType	getDisplayBlanksAs() Gets or sets the way to plot blank cells on a chart.
EffectDag	getEffect() Gets effects used for a chart.
FormatThreeD	getEffect3D() Gets 3D format of a chart.
EffectDag	getEffectDag() Gets the EffectFormat object which contains pixel effects applied to a shape.
FillFormat	getFill() Gets the FillFormat object that contains fill formatting properties for a shape.
ChartWallsOrFloor	getFloor() Gets the floor of a 3D chart.
GraphicFrame	getFrame() Gets or sets the shape frame's properties.
int	getGapDepth() Gets or sets the distance, as a percentage of the marker width, between the data series in a 3D chart.
int	getGapWidth() Gets or sets the space between bar or column clusters, as a percentage of the bar or column width.
IChartGridLine	getGridLine() Gets line style properties of a chart.
float	getHeight() Gets or sets the height of the shape.
float	getLeft() Gets or sets the x-coordinate of the upper-left corner of the shape.
TextLineFormat	getLine() Gets the LineFormat object that contains line formatting properties for a shape.
ClickHyperlink	getMouseOver() Gets or sets the hyperlink defined for mouse over.
java.lang.String	getName() Gets or sets the name of a shape.
int	getOverLap() Gets or sets how much bars and columns shall overlap on 2-D charts, between -100 and 100.
ActiveSlide	getParent() Gets the parent slide of a shape.
PlaceholderEx	getPlaceholder() Gets the placeholder for a shape.
ChartPlotArea	getPlotArea() Represents the plot area of a chart.
float	getPlotAreaWidthOfCalculated() Gets the PlotAreaWidth of the chart after calculated.
boolean	getPlotVisibleCellsOnly() Indicates whether the only visible cells are plotted.
Presentation	getPresentation() Gets the parent slide of a shape.
IChartAxis	getPrimaryCategoryAxis() Gets the chart's Category axis
IChartAxis	getPrimaryValueAxis() Gets the chart's Value axis.
float	getRotation() Gets or sets the number of degrees the specified shape is rotated around the z-axis.
ChartRotationThreeD	getRotationThreeD() Gets a 3D rotation of a chart.
IChartAxis	getSecondaryCategoryAxis() Gets the chart's second Category axis.
IChartAxis	getSecondaryValueAxis() Gets the chart's second Value axis.
ChartSeriesFormatCollection	getSeries() Gets chart's Series.
GraphicalNodeLocking	getShapeLocking() Gets lock type of shape.
ChartWallsOrFloor	getSideWall() Gets the side wall of a 3D chart.
ActiveSlide	getSlide() Gets the parent slide of a shape.
TagCollection	getTagsList() Gets the shape's tags collection.
FormatThreeD	getThreeD() Gets the ThreeDFormat object that 3d effect properties for a shape.
float	getTop() Gets or sets the y-coordinate of the upper-left corner of the shape.
ChartType	getType() Gets or sets the chart type.
float	getWidth() Gets or sets the width of the shape.
int	getZOrderPosition() Gets the position of a shape in the z-order.
boolean	hasDataTable() Indicates whether a chart has a data table.
void	hasDataTable(boolean value) Sets whether a chart has a data table.
boolean	hasLegend() Indicates whether a chart has a legend.
void	hasLegend(boolean value) Sets whether a chart has a legend.
boolean	hasTitle() Indicates whether a chart has a visible title.
void	hasTitle(boolean value) Sets whether a chart has a visible title.
boolean	isDataProtect() Indicates whether data of chart is protected.
void	isDataProtect(boolean value) Indicates whether data of chart is protected.
boolean	isHidden() Indicates whether the shape is hidden.
void	isHidden(boolean value) Sets whether the shape is hidden.
boolean	isTextBox() Indicates whether the shape is TextHolder.
void	removePlaceholder() Removes placeholder from the shape.
void	setAlternativeText(java.lang.String value) Gets or sets the alternative text associated with a shape.
void	setBubbleScale(int value) Gets or sets the BubbleScale.
void	setChartLegend(ChartLegend value) Gets or sets a legend for a chart.
void	setChartStyle(ChartStyle value) Gets or sets the chart style.
void	setClick(ClickHyperlink value) Gets or sets the hyperlink defined for mouse click.
void	setDisplayBlanksAs(DisplayBlanksAsType value) Gets or sets the way to plot blank cells on a chart.
void	setFrame(GraphicFrame value) Sets the shape frame's properties.
void	setGapDepth(int value) Gets or sets the distance, as a percentage of the marker width, between the data series in a 3D chart.
void	setGapWidth(int value) Gets or sets the space between bar or column clusters, as a percentage of the bar or column width.
void	setHeight(float value) Gets or sets the height of the shape.
void	setLeft(double value) Gets or sets the x-coordinate of the upper-left corner of the shape.
void	setMouseOver(ClickHyperlink value) Gets or sets the hyperlink defined for mouse over.
void	setName(java.lang.String value) Gets or sets the name of a shape.
void	setOverLap(int value) Gets or sets how much bars and columns shall overlap on 2-D charts, between -100 and 100.
void	setPlotVisibleCellsOnly(boolean value) Sets whether the only visible cells are plotted.
void	setRotation(float value) Gets or sets the number of degrees the specified shape is rotated around the z-axis.
void	setTop(double value) Gets or sets the y-coordinate of the upper-left corner of the shape.
void	setType(ChartType value) Gets or sets the chart type.
void	setWidth(float value) Gets or sets the width of the shape.

Methods inherited from interface com.spire.presentation.IShape

getAlternativeTitle, insertChart, insertPicture, insertSmartArt, insertTable, insertVideo, setAlternativeTitle, setShapeAlignment, setShapeArrange

Method Detail

getPlotAreaWidthOfCalculated

float getPlotAreaWidthOfCalculated()

Gets the PlotAreaWidth of the chart after calculated. Read/write .

Returns:

getPlotVisibleCellsOnly

boolean getPlotVisibleCellsOnly()

Indicates whether the only visible cells are plotted. False to plot both visible and hidden cells.

Returns:

setPlotVisibleCellsOnly

void setPlotVisibleCellsOnly(boolean value)

Sets whether the only visible cells are plotted. False to plot both visible and hidden cells.

Parameters:

value -

getGapDepth

int getGapDepth()

Gets or sets the distance, as a percentage of the marker width, between the data series in a 3D chart.

Returns:

setGapDepth

void setGapDepth(int value)

Gets or sets the distance, as a percentage of the marker width, between the data series in a 3D chart.

Parameters:

value -

getGapWidth

int getGapWidth()

Gets or sets the space between bar or column clusters, as a percentage of the bar or column width.

Returns:

setGapWidth

void setGapWidth(int value)

Gets or sets the space between bar or column clusters, as a percentage of the bar or column width.

Parameters:

value -

getOverLap

int getOverLap()

Gets or sets how much bars and columns shall overlap on 2-D charts, between -100 and 100.

Returns:

setOverLap

void setOverLap(int value)

Gets or sets how much bars and columns shall overlap on 2-D charts, between -100 and 100.

Parameters:

value -

getGridLine

IChartGridLine getGridLine()

Gets line style properties of a chart.

Returns:

getEffect

EffectDag getEffect()

Gets effects used for a chart. Read-only .

Returns:

getEffect3D

FormatThreeD getEffect3D()

Gets 3D format of a chart. Read-only .

Returns:

getDisplayBlanksAs

DisplayBlanksAsType getDisplayBlanksAs()

Gets or sets the way to plot blank cells on a chart. Read/write .

Returns:

setDisplayBlanksAs

void setDisplayBlanksAs(DisplayBlanksAsType value)

Gets or sets the way to plot blank cells on a chart. Read/write .

Parameters:

value -

getSeries

ChartSeriesFormatCollection getSeries()

Gets chart's Series.

Returns:

Throws:

java.lang.Exception

getCategories

ChartCategoryCollection getCategories()

Gets chart's Categories.

Returns:

Throws:

java.lang.Exception

hasTitle

boolean hasTitle()

Indicates whether a chart has a visible title. Read/write .

Returns:

hasTitle

void hasTitle(boolean value)

Sets whether a chart has a visible title. Read/write .

Parameters:

value -

isDataProtect

boolean isDataProtect()

Indicates whether data of chart is protected. Read/write .

Returns:

Throws:

java.lang.Exception

isDataProtect

void isDataProtect(boolean value)

Indicates whether data of chart is protected. Read/write .

Parameters:

value -

Throws:

java.lang.Exception

getChartTitle

ChartTextArea getChartTitle()

Gets or sets a chart title

Returns:

getChartData

ChartData getChartData()

data associated with a chart.

Returns:

Throws:

java.lang.Exception

hasDataTable

boolean hasDataTable()

Indicates whether a chart has a data table. Read/write .

Returns:

hasDataTable

void hasDataTable(boolean value)

Sets whether a chart has a data table. Read/write .

Parameters:

value -

hasLegend

boolean hasLegend()

Indicates whether a chart has a legend. Read/write .

Returns:

hasLegend

void hasLegend(boolean value)

Sets whether a chart has a legend. Read/write .

Parameters:

value -

getBubbleScale

int getBubbleScale()

Gets or sets the BubbleScale. The Range of BubbleScale is 0 to 300. Read/write .

Returns:

setBubbleScale

void setBubbleScale(int value)

Gets or sets the BubbleScale. The Range of BubbleScale is 0 to 300. Read/write .

Parameters:

value -

getChartLegend

ChartLegend getChartLegend()

Gets or sets a legend for a chart. Read/write .

Returns:

setChartLegend

void setChartLegend(ChartLegend value)

Gets or sets a legend for a chart. Read/write .

Parameters:

value -

getChartDataTable

ChartDataTable getChartDataTable()

Gets a data table of a chart. Read-only .

Returns:

getChartStyle

ChartStyle getChartStyle()

Gets or sets the chart style. Read/write .

Returns:

setChartStyle

void setChartStyle(ChartStyle value)

Gets or sets the chart style. Read/write .

Parameters:

value -

getType

ChartType getType()

Gets or sets the chart type. Read/write .

Returns:

setType

void setType(ChartType value)

Gets or sets the chart type. Read/write .

Parameters:

value -

Throws:

java.lang.Exception

getPlotArea

ChartPlotArea getPlotArea()

Represents the plot area of a chart. Read-only .

Returns:

getRotationThreeD

ChartRotationThreeD getRotationThreeD()

Gets a 3D rotation of a chart. Read-only .

Returns:

getBackWall

ChartWallsOrFloor getBackWall()

Gets the back wall of a 3D chart. Read-only .

Returns:

getSideWall

ChartWallsOrFloor getSideWall()

Gets the side wall of a 3D chart. Read-only .

Returns:

getFloor

ChartWallsOrFloor getFloor()

Gets the floor of a 3D chart. Read-only .

Returns:

getPrimaryCategoryAxis

IChartAxis getPrimaryCategoryAxis()

Gets the chart's Category axis

Returns:

getSecondaryCategoryAxis

IChartAxis getSecondaryCategoryAxis()

Gets the chart's second Category axis.

Returns:

getPrimaryValueAxis

IChartAxis getPrimaryValueAxis()

Gets the chart's Value axis.

Returns:

getSecondaryValueAxis

IChartAxis getSecondaryValueAxis()

Gets the chart's second Value axis.

Returns:

getShapeLocking

GraphicalNodeLocking getShapeLocking()

Gets lock type of shape. Read-only .

Returns:

isTextBox

boolean isTextBox()

Indicates whether the shape is TextHolder. Read-only .

Specified by:

isTextBox in interface IShape

Returns:

getPlaceholder

PlaceholderEx getPlaceholder()

Gets the placeholder for a shape. Read-only .

Specified by:

getPlaceholder in interface IShape

Returns:

getTagsList

TagCollection getTagsList()

Gets the shape's tags collection. Read-only .

Specified by:

getTagsList in interface IShape

Returns:

getFrame

GraphicFrame getFrame()

Gets or sets the shape frame's properties. Read/write .

Specified by:

getFrame in interface IShape

Returns:

setFrame

void setFrame(GraphicFrame value)

Description copied from interface: IShape

Sets the shape frame's properties. Read/write .

Specified by:

setFrame in interface IShape

getLine

TextLineFormat getLine()

Gets the LineFormat object that contains line formatting properties for a shape. Read-only . Note: can return null for certain types of shapes which don't have line properties.

Specified by:

getLine in interface IShape

Returns:

getThreeD

FormatThreeD getThreeD()

Gets the ThreeDFormat object that 3d effect properties for a shape. Read-only . Note: can return null for certain types of shapes which don't have 3d properties.

Specified by:

getThreeD in interface IShape

Returns:

getEffectDag

EffectDag getEffectDag()

Gets the EffectFormat object which contains pixel effects applied to a shape. Read-only Note: can return null for certain types of shapes which don't have effect properties.

Specified by:

getEffectDag in interface IShape

Returns:

getFill

FillFormat getFill()

Gets the FillFormat object that contains fill formatting properties for a shape. Read-only . Note: can return null for certain types of shapes which don't have fill properties.

Specified by:

getFill in interface IShape

Returns:

getClick

ClickHyperlink getClick()

Gets or sets the hyperlink defined for mouse click. Read/write .

Specified by:

getClick in interface IShape

Returns:

setClick

void setClick(ClickHyperlink value)

Gets or sets the hyperlink defined for mouse click. Read/write .

Specified by:

setClick in interface IShape

Parameters:

value -

getMouseOver

ClickHyperlink getMouseOver()

Gets or sets the hyperlink defined for mouse over. Read/write .

Specified by:

getMouseOver in interface IShape

Returns:

setMouseOver

void setMouseOver(ClickHyperlink value)

Gets or sets the hyperlink defined for mouse over. Read/write .

Specified by:

setMouseOver in interface IShape

Parameters:

value -

isHidden

boolean isHidden()

Indicates whether the shape is hidden. Read/write .

Specified by:

isHidden in interface IShape

Returns:

isHidden

void isHidden(boolean value)

Sets whether the shape is hidden. Read/write .

Specified by:

isHidden in interface IShape

Parameters:

value -

getParent

ActiveSlide getParent()

Gets the parent slide of a shape. Read-only .

Specified by:

getParent in interface IShape

Returns:

getZOrderPosition

int getZOrderPosition()

Gets the position of a shape in the z-order. Shapes[0] returns the shape at the back of the z-order, and Shapes[Shapes.Count - 1] returns the shape at the front of the z-order. Read-only .

Specified by:

getZOrderPosition in interface IShape

Returns:

getRotation

float getRotation()

Gets or sets the number of degrees the specified shape is rotated around the z-axis. A positive value indicates clockwise rotation; a negative value indicates counterclockwise rotation. Read/write .

Specified by:

getRotation in interface IShape

Returns:

setRotation

void setRotation(float value)

Gets or sets the number of degrees the specified shape is rotated around the z-axis. A positive value indicates clockwise rotation; a negative value indicates counterclockwise rotation. Read/write .

Specified by:

setRotation in interface IShape

Parameters:

value -

getLeft

float getLeft()

Gets or sets the x-coordinate of the upper-left corner of the shape. Read/write .

Specified by:

getLeft in interface IShape

Returns:

setLeft

void setLeft(double value)

Gets or sets the x-coordinate of the upper-left corner of the shape. Read/write .

Specified by:

setLeft in interface IShape

Parameters:

value -

getTop

float getTop()

Gets or sets the y-coordinate of the upper-left corner of the shape. Read/write .

Specified by:

getTop in interface IShape

Returns:

setTop

void setTop(double value)

Gets or sets the y-coordinate of the upper-left corner of the shape. Read/write .

Specified by:

setTop in interface IShape

Parameters:

value -

getWidth

float getWidth()

Gets or sets the width of the shape. Read/write .

Specified by:

getWidth in interface IShape

Returns:

setWidth

void setWidth(float value)

Gets or sets the width of the shape. Read/write .

Specified by:

setWidth in interface IShape

Parameters:

value -

getHeight

float getHeight()

Gets or sets the height of the shape. Read/write .

Specified by:

getHeight in interface IShape

Returns:

setHeight

void setHeight(float value)

Gets or sets the height of the shape. Read/write .

Specified by:

setHeight in interface IShape

Parameters:

value -

getAlternativeText

java.lang.String getAlternativeText()

Gets or sets the alternative text associated with a shape. Read/write .

Specified by:

getAlternativeText in interface IShape

Returns:

setAlternativeText

void setAlternativeText(java.lang.String value)

Gets or sets the alternative text associated with a shape. Read/write .

Specified by:

setAlternativeText in interface IShape

Parameters:

value -

getName

java.lang.String getName()

Gets or sets the name of a shape. Read/write .

Specified by:

getName in interface IShape

Returns:

setName

void setName(java.lang.String value)

Gets or sets the name of a shape. Read/write .

Specified by:

setName in interface IShape

Parameters:

value -

getSlide

ActiveSlide getSlide()

Gets the parent slide of a shape. Read-only .

Specified by:

getSlide in interface IShape

Returns:

getPresentation

Presentation getPresentation()

Gets the parent slide of a shape. Read-only .

Specified by:

getPresentation in interface IShape

Returns:

removePlaceholder

void removePlaceholder()

Removes placeholder from the shape.

Specified by:

removePlaceholder in interface IShape

dispose

void dispose()

Dispose object and free resources.

Specified by:

dispose in interface IShape