com.aspose.words

Class ChartSeries

java.lang.Object

com.aspose.words.ChartSeries

All Implemented Interfaces:

IChartDataPoint, java.lang.Cloneable

public class ChartSeries
extends java.lang.Object
implements IChartDataPoint, java.lang.Cloneable

Represents chart series properties.

To learn more, visit the Working with Charts documentation article.

Method Summary

Modifier and Type	Method and Description
boolean	getBubble3D() Specifies whether the bubbles in Bubble chart should have a 3-D effect applied to them.
ChartDataLabelCollection	getDataLabels() Specifies the settings for the data labels for the entire series.
ChartDataPointCollection	getDataPoints() Returns a collection of formatting objects for all data points in this series.
int	getExplosion() Specifies the amount the data point shall be moved from the center of the pie.
ChartFormat	getFormat() Provides access to fill and line formatting of the series.
boolean	getInvertIfNegative() Specifies whether the parent element shall inverts its colors if the value is negative.
ChartLegendEntry	getLegendEntry() Gets a legend entry for this chart series.
ChartMarker	getMarker() Specifies a data marker.
java.lang.String	getName() Gets the name of the series, if name is not set explicitly it is generated using index.
boolean	getSmooth() Allows to specify whether the line connecting the points on the chart shall be smoothed using Catmull-Rom splines.
boolean	hasDataLabels() Gets a flag indicating whether data labels are displayed for the series.
void	hasDataLabels(boolean value) Sets a flag indicating whether data labels are displayed for the series.
protected java.lang.Object	memberwiseClone()
void	setBubble3D(boolean value) Specifies whether the bubbles in Bubble chart should have a 3-D effect applied to them.
void	setExplosion(int value) Specifies the amount the data point shall be moved from the center of the pie.
void	setInvertIfNegative(boolean value) Specifies whether the parent element shall inverts its colors if the value is negative.
void	setName(java.lang.String value) Sets the name of the series, if name is not set explicitly it is generated using index.
void	setSmooth(boolean value) Allows to specify whether the line connecting the points on the chart shall be smoothed using Catmull-Rom splines.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

getExplosion

public int getExplosion()

Description copied from interface: IChartDataPoint

Specifies the amount the data point shall be moved from the center of the pie. Can be negative, negative means that property is not set and no explosion should be applied. Applies only to Pie charts.

Specified by:

getExplosion in interface IChartDataPoint

Returns:

The corresponding int value.

setExplosion

public void setExplosion(int value)

Description copied from interface: IChartDataPoint

Specifies the amount the data point shall be moved from the center of the pie. Can be negative, negative means that property is not set and no explosion should be applied. Applies only to Pie charts.

Specified by:

setExplosion in interface IChartDataPoint

Parameters:

value - The corresponding int value.

getInvertIfNegative

public boolean getInvertIfNegative()

Description copied from interface: IChartDataPoint

Specifies whether the parent element shall inverts its colors if the value is negative.

Specified by:

getInvertIfNegative in interface IChartDataPoint

Returns:

The corresponding boolean value.

setInvertIfNegative

public void setInvertIfNegative(boolean value)

Description copied from interface: IChartDataPoint

Specifies whether the parent element shall inverts its colors if the value is negative.

Specified by:

setInvertIfNegative in interface IChartDataPoint

Parameters:

value - The corresponding boolean value.

getMarker

public ChartMarker getMarker()

Description copied from interface: IChartDataPoint

Specifies a data marker. Marker is automatically created when requested.

Specified by:

getMarker in interface IChartDataPoint

Returns:

The corresponding ChartMarker value.

getBubble3D

public boolean getBubble3D()

Description copied from interface: IChartDataPoint

Specifies whether the bubbles in Bubble chart should have a 3-D effect applied to them.

Specified by:

getBubble3D in interface IChartDataPoint

Returns:

The corresponding boolean value.

setBubble3D

public void setBubble3D(boolean value)

Description copied from interface: IChartDataPoint

Specifies whether the bubbles in Bubble chart should have a 3-D effect applied to them.

Specified by:

setBubble3D in interface IChartDataPoint

Parameters:

value - The corresponding boolean value.

getDataPoints

public ChartDataPointCollection getDataPoints()

Returns a collection of formatting objects for all data points in this series.

Returns:

A collection of formatting objects for all data points in this series.

getName

public java.lang.String getName()

Gets the name of the series, if name is not set explicitly it is generated using index. By default returns Series plus one based index.

Returns:

The name of the series, if name is not set explicitly it is generated using index.

setName

public void setName(java.lang.String value)

Sets the name of the series, if name is not set explicitly it is generated using index. By default returns Series plus one based index.

Parameters:

value - The name of the series, if name is not set explicitly it is generated using index.

getSmooth

public boolean getSmooth()

Allows to specify whether the line connecting the points on the chart shall be smoothed using Catmull-Rom splines.

Returns:

The corresponding boolean value.

setSmooth

public void setSmooth(boolean value)

Allows to specify whether the line connecting the points on the chart shall be smoothed using Catmull-Rom splines.

Parameters:

value - The corresponding boolean value.

hasDataLabels

public boolean hasDataLabels()

Gets a flag indicating whether data labels are displayed for the series.

Returns:

A flag indicating whether data labels are displayed for the series.

hasDataLabels

public void hasDataLabels(boolean value)

Sets a flag indicating whether data labels are displayed for the series.

Parameters:

value - A flag indicating whether data labels are displayed for the series.

getDataLabels

public ChartDataLabelCollection getDataLabels()

Specifies the settings for the data labels for the entire series.

Returns:

The corresponding ChartDataLabelCollection value.

getFormat

public ChartFormat getFormat()

Provides access to fill and line formatting of the series.

Returns:

The corresponding ChartFormat value.

getLegendEntry

public ChartLegendEntry getLegendEntry()

Gets a legend entry for this chart series.

Returns:

A legend entry for this chart series.

memberwiseClone

protected java.lang.Object memberwiseClone()