IChartSeries

All Implemented Interfaces: com.aspose.slides.IChartComponent

public interface IChartSeries extends IChartComponent

Represents a chart series.

Methods

Method Description
getExplosion() The distance of an open pie slice from the center of the pie chart is expressed as a percentage of the pie diameter.
setExplosion(int value) The distance of an open pie slice from the center of the pie chart is expressed as a percentage of the pie diameter.
getSmooth() Represents curve smoothing.
setSmooth(boolean value) Represents curve smoothing.
getMarker() Return series marker.
getBar3DShape() Specifies the shape of a series of a 3-D bar chart.
setBar3DShape(int value) Specifies the shape of a series of a 3-D bar chart.
getName() Return series name.
getDataPoints() Returns collection of data points of this series.
getType() Returns a type of this series.
setType(int value) Returns a type of this series.
getParentSeriesGroup() Returns parent series group.
getFormat() Returns the format of a series.
getOrder() Returns the order of a series.
setOrder(int value) Returns the order of a series.
getLabels() Returns the Labels of a series.
getTrendLines() Collection of series trend lines Read-only ITrendlineCollection.
getErrorBarsXFormat() Represents ErrorBars of series with derection X.
getErrorBarsYFormat() Represents ErrorBars of series with derection Y.
getPlotOnSecondAxis() Indicates if this series is plotted on second value axis.
setPlotOnSecondAxis(boolean value) Indicates if this series is plotted on second value axis.
getNumberFormatOfValues() Returns or sets the number format for series values.
setNumberFormatOfValues(String value) Returns or sets the number format for series values.
getNumberFormatOfXValues() Returns or sets the number format for series x values.
setNumberFormatOfXValues(String value) Returns or sets the number format for series x values.
getNumberFormatOfYValues() Returns or sets the number format for series y values.
setNumberFormatOfYValues(String value) Returns or sets the number format for series y values.
getNumberFormatOfBubbleSizes() Returns or sets the number format for series bubble sizes.
setNumberFormatOfBubbleSizes(String value) Returns or sets the number format for series bubble sizes.
getInvertIfNegative() Specifies the bar, column or bubble series shall invert its colors if the value is negative.
setInvertIfNegative(boolean value) Specifies the bar, column or bubble series shall invert its colors if the value is negative.
getInvertedSolidFillColor() Specifies invert solid color for series.
getRelatedLegendEntry() Represents legend entry related with this series Read-only ILegendEntryProperties.
getAutomaticSeriesColor() Returns an automatic color of series based on series index and chart style.
getShowInnerPoints() Represents inner points.
setShowInnerPoints(boolean value) Represents inner points.
getShowOutlierPoints() Represents outlier points.
setShowOutlierPoints(boolean value) Represents outlier points.
getShowMeanMarkers() Represents mean markers.
setShowMeanMarkers(boolean value) Represents mean markers.
getShowMeanLine() Represents mean markers.
setShowMeanLine(boolean value) Represents mean markers.
getQuartileMethod() Represents quartile method.
setQuartileMethod(int value) Represents quartile method.
getShowConnectorLines() Represents connector lines.
setShowConnectorLines(boolean value) Represents connector lines.
getParentLabelLayout() Represents layout of parent category labels.
setParentLabelLayout(int value) Represents layout of parent category labels.
getBubbleSizeScale() Specifies the scale factor for the bubble chart (can be between 0 and 300 percents of the default size).
hasUpDownBars() Determines whether Line- or Stock-chart has a up/down bars.
getGapWidth() Specifies the space between bar or column clusters, as a percentage of the bar or column width.
getGapDepth() Returns or sets the distance, as a percentage of the marker width, between the data series in a 3D chart.
isColorVaried() Specifies that each data marker in the series has a different color.
hasSeriesLines() Determines whether there are series lines for this series and kindred series.
getOverlap() Specifies how much bars and columns shall overlap on 2-D charts (from -100 to 100).
getSecondPieSize() Specifies the size of the second pie or bar of a pie-of-pie chart or a bar-of-pie chart, as a percentage of the size of the first pie (can be between 5 and 200 percents).
getPieSplitPosition() Specifies a value that shall be used to determine which data points are in the second pie or bar on a pie-of-pie or bar-of-pie chart.
getPieSplitBy() Specifies how to determine which data points are in the second pie or bar on a pie-of-pie or bar-of-pie chart.
getDoughnutHoleSize() Specifies the size of the hole in a doughnut chart (can be between 10 and 90 percents of the size of the plot area.).
getFirstSliceAngle() Specifies the angle of the first pie or doughnut chart slice, in degrees (clockwise from up, from 0 to 360 degrees).
getPieSplitCustomPoints() The custom split information for a pie-of-pie or bar-of-pie chart with a custom split.
getBubbleSizeRepresentation() Specifies how the bubble size values are represented on the bubble chart.

getExplosion()

public abstract int getExplosion()

The distance of an open pie slice from the center of the pie chart is expressed as a percentage of the pie diameter. Read/write int.

Returns: int

setExplosion(int value)

public abstract void setExplosion(int value)

The distance of an open pie slice from the center of the pie chart is expressed as a percentage of the pie diameter. Read/write int.

Parameters:

Parameter Type Description
value int

getSmooth()

public abstract boolean getSmooth()

Represents curve smoothing. True if curve smoothing is turned on for the line chart or scatter chart. Applies only to line and scatter connected by lines charts. Read/write boolean.

Returns: boolean

setSmooth(boolean value)

public abstract void setSmooth(boolean value)

Represents curve smoothing. True if curve smoothing is turned on for the line chart or scatter chart. Applies only to line and scatter connected by lines charts. Read/write boolean.

Parameters:

Parameter Type Description
value boolean

getMarker()

public abstract IMarker getMarker()

Return series marker. Read-only IMarker.

Returns: IMarker

getBar3DShape()

public abstract int getBar3DShape()

Specifies the shape of a series of a 3-D bar chart. Changing of value of this property can cause to automatically changing Type of series. Read/write ChartShapeType.

Returns: int

setBar3DShape(int value)

public abstract void setBar3DShape(int value)

Specifies the shape of a series of a 3-D bar chart. Changing of value of this property can cause to automatically changing Type of series. Read/write ChartShapeType.

Parameters:

Parameter Type Description
value int

getName()

public abstract IStringChartValue getName()

Return series name. Read-only IStringChartValue.

Returns: IStringChartValue

getDataPoints()

public abstract IChartDataPointCollection getDataPoints()

Returns collection of data points of this series. Read-only IChartDataPointCollection.

Returns: IChartDataPointCollection

getType()

public abstract int getType()

Returns a type of this series. Read/write ChartType.

Returns: int

setType(int value)

public abstract void setType(int value)

Returns a type of this series. Read/write ChartType.

Parameters:

Parameter Type Description
value int

getParentSeriesGroup()

public abstract IChartSeriesGroup getParentSeriesGroup()

Returns parent series group. Read-only IChartSeriesGroup.

Returns: IChartSeriesGroup

getFormat()

public abstract IFormat getFormat()

Returns the format of a series. Read-only IFormat.

Returns: IFormat

getOrder()

public abstract int getOrder()

Returns the order of a series. Read/write int.

Returns: int

setOrder(int value)

public abstract void setOrder(int value)

Returns the order of a series. Read/write int.

Parameters:

Parameter Type Description
value int

getLabels()

public abstract IDataLabelCollection getLabels()

Returns the Labels of a series. Read-only IDataLabelCollection.

Returns: IDataLabelCollection

getTrendLines()

public abstract ITrendlineCollection getTrendLines()

Collection of series trend lines Read-only ITrendlineCollection.

Returns: ITrendlineCollection

getErrorBarsXFormat()

public abstract IErrorBarsFormat getErrorBarsXFormat()

Represents ErrorBars of series with derection X. Read-only IErrorBarsFormat.


ErrorBars with X direction are avalible for series of type area, bar, scatter and bubble. For any other types of chart this property returns null (including 3D charts). In case of custom values use DataPoints collection to specify value (with (IChartDataPoint#getErrorBarsCustomValues) property).

Returns: IErrorBarsFormat

getErrorBarsYFormat()

public abstract IErrorBarsFormat getErrorBarsYFormat()

Represents ErrorBars of series with derection Y. Read-only IErrorBarsFormat.


ErrorBars with Y direction are avalible for series of type area, bar, line, scatter and bubble. For any other types of chart this property returns null (including 3D charts). In case of custom values use DataPoints collection to specify value (with (IChartDataPoint#getErrorBarsCustomValues) property).

Returns: IErrorBarsFormat

getPlotOnSecondAxis()

public abstract boolean getPlotOnSecondAxis()

Indicates if this series is plotted on second value axis. Read/write boolean.

Returns: boolean

setPlotOnSecondAxis(boolean value)

public abstract void setPlotOnSecondAxis(boolean value)

Indicates if this series is plotted on second value axis. Read/write boolean.

Parameters:

Parameter Type Description
value boolean

getNumberFormatOfValues()

public abstract String getNumberFormatOfValues()

Returns or sets the number format for series values. Read/write String.

Returns: java.lang.String

setNumberFormatOfValues(String value)

public abstract void setNumberFormatOfValues(String value)

Returns or sets the number format for series values. Read/write String.

Parameters:

Parameter Type Description
value java.lang.String

getNumberFormatOfXValues()

public abstract String getNumberFormatOfXValues()

Returns or sets the number format for series x values. Read/write String.

Returns: java.lang.String

setNumberFormatOfXValues(String value)

public abstract void setNumberFormatOfXValues(String value)

Returns or sets the number format for series x values. Read/write String.

Parameters:

Parameter Type Description
value java.lang.String

getNumberFormatOfYValues()

public abstract String getNumberFormatOfYValues()

Returns or sets the number format for series y values. Read/write String.

Returns: java.lang.String

setNumberFormatOfYValues(String value)

public abstract void setNumberFormatOfYValues(String value)

Returns or sets the number format for series y values. Read/write String.

Parameters:

Parameter Type Description
value java.lang.String

getNumberFormatOfBubbleSizes()

public abstract String getNumberFormatOfBubbleSizes()

Returns or sets the number format for series bubble sizes. Read/write String.

Returns: java.lang.String

setNumberFormatOfBubbleSizes(String value)

public abstract void setNumberFormatOfBubbleSizes(String value)

Returns or sets the number format for series bubble sizes. Read/write String.

Parameters:

Parameter Type Description
value java.lang.String

getInvertIfNegative()

public abstract boolean getInvertIfNegative()

Specifies the bar, column or bubble series shall invert its colors if the value is negative. Read/write boolean.

Returns: boolean

setInvertIfNegative(boolean value)

public abstract void setInvertIfNegative(boolean value)

Specifies the bar, column or bubble series shall invert its colors if the value is negative. Read/write boolean.

Parameters:

Parameter Type Description
value boolean

getInvertedSolidFillColor()

public abstract IColorFormat getInvertedSolidFillColor()

Specifies invert solid color for series. To apply color setting set series format FillType to FillType.Solid. Read/write IColorFormat.

Returns: IColorFormat

getRelatedLegendEntry()

public abstract ILegendEntryProperties getRelatedLegendEntry()

Represents legend entry related with this series Read-only ILegendEntryProperties.

Returns: ILegendEntryProperties

getAutomaticSeriesColor()

public abstract Color getAutomaticSeriesColor()

Returns an automatic color of series based on series index and chart style. This color is used by default if FillType equals NotDefined.

Returns: java.awt.Color - Automatic color of series java.awt.Color

getShowInnerPoints()

public abstract boolean getShowInnerPoints()

Represents inner points. True if inner points are shown on the BoxAndWhisker chart. Applies only to BoxAndWhisker charts. Read/write boolean.

Returns: boolean

setShowInnerPoints(boolean value)

public abstract void setShowInnerPoints(boolean value)

Represents inner points. True if inner points are shown on the BoxAndWhisker chart. Applies only to BoxAndWhisker charts. Read/write boolean.

Parameters:

Parameter Type Description
value boolean

getShowOutlierPoints()

public abstract boolean getShowOutlierPoints()

Represents outlier points. True if outlier points are shown on the BoxAndWhisker chart. Applies only to BoxAndWhisker charts. Read/write boolean.

Returns: boolean

setShowOutlierPoints(boolean value)

public abstract void setShowOutlierPoints(boolean value)

Represents outlier points. True if outlier points are shown on the BoxAndWhisker chart. Applies only to BoxAndWhisker charts. Read/write boolean.

Parameters:

Parameter Type Description
value boolean

getShowMeanMarkers()

public abstract boolean getShowMeanMarkers()

Represents mean markers. True if mean markers are shown on the BoxAndWhisker chart. Applies only to BoxAndWhisker charts. Read/write boolean.

Returns: boolean

setShowMeanMarkers(boolean value)

public abstract void setShowMeanMarkers(boolean value)

Represents mean markers. True if mean markers are shown on the BoxAndWhisker chart. Applies only to BoxAndWhisker charts. Read/write boolean.

Parameters:

Parameter Type Description
value boolean

getShowMeanLine()

public abstract boolean getShowMeanLine()

Represents mean markers. True if mean line are shown on the BoxAndWhisker chart. Applies only to BoxAndWhisker charts. Read/write boolean.

Returns: boolean

setShowMeanLine(boolean value)

public abstract void setShowMeanLine(boolean value)

Represents mean markers. True if mean line are shown on the BoxAndWhisker chart. Applies only to BoxAndWhisker charts. Read/write boolean.

Parameters:

Parameter Type Description
value boolean

getQuartileMethod()

public abstract int getQuartileMethod()

Represents quartile method. Applies only to BoxAndWhisker charts.

Returns: int

setQuartileMethod(int value)

public abstract void setQuartileMethod(int value)

Represents quartile method. Applies only to BoxAndWhisker charts.

Parameters:

Parameter Type Description
value int

getShowConnectorLines()

public abstract boolean getShowConnectorLines()

Represents connector lines. Applies only to Waterfall charts.

Returns: boolean

setShowConnectorLines(boolean value)

public abstract void setShowConnectorLines(boolean value)

Represents connector lines. Applies only to Waterfall charts.

Parameters:

Parameter Type Description
value boolean

getParentLabelLayout()

public abstract int getParentLabelLayout()

Represents layout of parent category labels. Applies only to Treemap charts.

Returns: int

setParentLabelLayout(int value)

public abstract void setParentLabelLayout(int value)

Represents layout of parent category labels. Applies only to Treemap charts.

Parameters:

Parameter Type Description
value int

getBubbleSizeScale()

public abstract int getBubbleSizeScale()

Specifies the scale factor for the bubble chart (can be between 0 and 300 percents of the default size). This is the property not only of this series but of all series of parent series group - this is projection of appropriate group property. And so this property is read-only. Use ParentSeriesGroup property for access to parent series group. Use ParentSeriesGroup.BubbleSizeScale read/write property for change value.


This is the projection of the property ParentSeriesGroup.BubbleSizeScale.

Returns: int

hasUpDownBars()

public abstract boolean hasUpDownBars()

Determines whether Line- or Stock-chart has a up/down bars. This is the property not only of this series but of all series of parent series group - this is projection of appropriate group property. And so this property is read-only. Use ParentSeriesGroup property for access to parent series group. Use ParentSeriesGroup.UpDownBars.HasUpDownBars read/write property for change value. Use ParentSeriesGroup.UpDownBars property for format up/down bars. Read-only boolean.


This is the projection of the property ParentSeriesGroup.UpDownBars.HasUpDownBars.

Returns: boolean

getGapWidth()

public abstract int getGapWidth()

Specifies the space between bar or column clusters, as a percentage of the bar or column width. This is the property not only of this series but of all series of parent series group - this is projection of appropriate group property. And so this property is read-only. Use ParentSeriesGroup property for access to parent series group. Use ParentSeriesGroup.GapWidth read/write property for change value. Read-only int.


This is the projection of the property ParentSeriesGroup.GapWidth.

Returns: int

getGapDepth()

public abstract int getGapDepth()

Returns or sets the distance, as a percentage of the marker width, between the data series in a 3D chart. This is the property not only of this series but of all series of parent series group - this is projection of appropriate group property. And so this property is read-only. Use ParentSeriesGroup property for access to parent series group. Use ParentSeriesGroup.GapDepth read/write property for change value. Read-only int.


This is the projection of the property ParentSeriesGroup.GapDepth.

Returns: int

isColorVaried()

public abstract boolean isColorVaried()

Specifies that each data marker in the series has a different color. This is the property not only of this series but of all series of parent series group - this is projection of appropriate group property. And so this property is read-only. Use ParentSeriesGroup property for access to parent series group. Use ParentSeriesGroup.IsColorVaried read/write property for change value. Read-only boolean.


This is the projection of the property ParentSeriesGroup.IsColorVaried.

Returns: boolean

hasSeriesLines()

public abstract boolean hasSeriesLines()

Determines whether there are series lines for this series and kindred series. This is the property not only of this series but of all series of parent series group - this is projection of appropriate group property. And so this property is read-only. Use ParentSeriesGroup property for access to parent series group. Use ParentSeriesGroup.HasSeriesLines read/write property for change value. Use ParentSeriesGroup.SeriesLinesFormat property for format series lines. Read-only boolean.


This is the projection of the property ParentSeriesGroup.HasSeriesLines.

Returns: boolean

getOverlap()

public abstract byte getOverlap()

Specifies how much bars and columns shall overlap on 2-D charts (from -100 to 100). This is the property not only of this series but of all series of parent series group - this is projection of appropriate group property. And so this property is read-only. Use ParentSeriesGroup property for access to parent series group. Use ParentSeriesGroup.Overlap read/write property for change value. Read-only byte.


This is the projection of the property ParentSeriesGroup.Overlap.

Returns: byte

getSecondPieSize()

public abstract int getSecondPieSize()

Specifies the size of the second pie or bar of a pie-of-pie chart or a bar-of-pie chart, as a percentage of the size of the first pie (can be between 5 and 200 percents). This is the property not only of this series but of all series of parent series group - this is projection of appropriate group property. And so this property is read-only. Use ParentSeriesGroup property for access to parent series group. Use ParentSeriesGroup.SecondPieSize read/write property for change value. Read-only int.


This is the projection of the property ParentSeriesGroup.SecondPieSize.

Returns: int

getPieSplitPosition()

public abstract double getPieSplitPosition()

Specifies a value that shall be used to determine which data points are in the second pie or bar on a pie-of-pie or bar-of-pie chart. Is used together with PieSplitBy property. This is the property not only of this series but of all series of parent series group - this is projection of appropriate group property. And so this property is read-only. Use ParentSeriesGroup property for access to parent series group. Use ParentSeriesGroup.PieSplitPosition read/write property for change value. Read-only double.


This is the projection of the property ParentSeriesGroup.PieSplitPosition.

Returns: double

getPieSplitBy()

public abstract int getPieSplitBy()

Specifies how to determine which data points are in the second pie or bar on a pie-of-pie or bar-of-pie chart. This is the property not only of this series but of all series of parent series group - this is projection of appropriate group property. And so this property is read-only. Use ParentSeriesGroup property for access to parent series group. Use ParentSeriesGroup.PieSplitBy read/write property for change value. Read-only PieSplitType.


  1. This is the projection of the property ParentSeriesGroup.PieSplitBy. 2) If property value is PieSplitType.Custom then you can define custom split information with ParentSeriesGroup.PieSplitCustomPoints property.

Returns: int

getDoughnutHoleSize()

public abstract byte getDoughnutHoleSize()

Specifies the size of the hole in a doughnut chart (can be between 10 and 90 percents of the size of the plot area.). This is the property not only of this series but of all series of parent series group - this is projection of appropriate group property. And so this property is read-only. Use ParentSeriesGroup property for access to parent series group. Use ParentSeriesGroup.DoughnutHoleSize read/write property for change value. Read-only byte.


This is the projection of the property ParentSeriesGroup.DoughnutHoleSize.

Returns: byte

getFirstSliceAngle()

public abstract int getFirstSliceAngle()

Specifies the angle of the first pie or doughnut chart slice, in degrees (clockwise from up, from 0 to 360 degrees). This is the property not only of this series but of all series of parent series group - this is projection of appropriate group property. And so this property is read-only. Use ParentSeriesGroup property for access to parent series group. Use ParentSeriesGroup.FirstSliceAngle read/write property for change value. Read-only int.


This is the projection of the property ParentSeriesGroup.FirstSliceAngle.

Returns: int

getPieSplitCustomPoints()

public abstract IPieSplitCustomPointCollection getPieSplitCustomPoints()

The custom split information for a pie-of-pie or bar-of-pie chart with a custom split. Contains data points that shall be drawn in the second pie or bar in a pie-of-pie or bar-of-pie chart. This is the property not only of this series but of all series of parent series group - this is projection of appropriate group property Read-only IPieSplitCustomPointCollection.


This is the projection of the property ParentSeriesGroup.PieSplitCustomPoints.

Returns: IPieSplitCustomPointCollection

getBubbleSizeRepresentation()

public abstract int getBubbleSizeRepresentation()

Specifies how the bubble size values are represented on the bubble chart. This is the property not only of this series but of all series of parent series group - this is projection of appropriate group property. And so this property is read-only. Use ParentSeriesGroup property for access to parent series group. Use ParentSeriesGroup.BubbleSizeRepresentation read/write property for change value.


This is the projection of the property ParentSeriesGroup.BubbleSizeRepresentation.

Returns: int