com.aspose.slides
Class ChartSeries

java.lang.Object
  extended by com.aspose.slides.ChartSeries
All Implemented Interfaces:
IChartComponent, IChartSeries, IPresentationComponent, ISlideComponent

public class ChartSeries
extends java.lang.Object
implements IChartSeries

Represents a chart series.


Method Summary
 java.awt.Color getAutomaticSeriesColor()
           Returns an automatic color of series based on series index and chart style.
 int getBar3DShape()
           Specifies the shape of a series of a 3-D bar chart.
 IChart getChart()
           Returns the parent chart.
 IChartDataPointCollection getDataPoints()
           Returns collection of data points of this series.
 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.).
 IErrorBarsFormat getErrorBarsXFormat()
           Represents ErrorBars of series with derection X.
 IErrorBarsFormat getErrorBarsYFormat()
           Represents ErrorBars of series with derection Y.
 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.
 int getFirstSliceAngle()
           Specifies the angle of the first pie or doughnut chart slice, in degrees (clockwise from up, from 0 to 360 degrees).
 IFormat getFormat()
           Returns the format of a series.
 int getGapDepth()
           Returns or sets the distance, as a percentage of the marker width, between the data series in a 3D chart.
 int getGapWidth()
           Specifies the space between bar or column clusters, as a percentage of the bar or column width.
 boolean getInvertIfNegative()
           Specifies the bar, column or bubble series shall invert its colors if the value is negative.
 IDataLabelCollection getLabels()
           Returns the Labels of a series.
 IMarker getMarker()
           Marker.
 IFormat getMarkerFill()
          Deprecated. 
 int getMarkerSize()
          Deprecated. 
 int getMarkerSymbol()
          Deprecated. 
 IStringChartValue getName()
           Return series name.
 IChartCellCollection getNameCells()
          Deprecated. 
 java.lang.String getNumberFormatOfBubbleSizes()
           NumberFormatOfBubbleSizes.
 java.lang.String getNumberFormatOfValues()
           NumberFormatOfValues.
 java.lang.String getNumberFormatOfXValues()
           NumberFormatOfXValues.
 java.lang.String getNumberFormatOfYValues()
           NumberFormatOfYValues.
 int getOrder()
           Returns the order of a series.
 byte getOverlap()
           Specifies how much bars and columns shall overlap on 2-D charts (from -100 to 100).
 com.aspose.slides.IDOMObject getParent_Immediate()
           Returns Parent_Immediate object.
 IChartSeriesGroup getParentSeriesGroup()
           ParentSeriesGroup.
 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.
 IPieSplitCustomPointCollection getPieSplitCustomPoints()
           The custom split information for a pie-of-pie or bar-of-pie chart with a custom split.
 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.
 boolean getPlotOnSecondAxis()
           Indicates if this series is plotted on secondary axis.
 IPresentation getPresentation()
           Returns the parent presentation of a FillFormat.
 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).
 IBaseSlide getSlide()
           Returns the parent slide of a FillFormat.
 boolean getSmooth()
           Represents curve smoothing.
 ITrendlineCollection getTrendLines()
           Collection of series trend lines.
 int getType()
           Returns a type of this series.
 boolean hasSeriesLines()
           Determines whether there are series lines for this series and kindred series.
 boolean hasUpDownBars()
           Determines whether Line- or Stock-chart has a up/down bars.
 boolean isColorVaried()
           Specifies that each data marker in the series has a different color.
 void setBar3DShape(int value)
           Specifies the shape of a series of a 3-D bar chart.
 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.
 void setInvertIfNegative(boolean value)
           Specifies the bar, column or bubble series shall invert its colors if the value is negative.
 void setMarkerSize(int value)
          Deprecated. 
 void setMarkerSymbol(int value)
          Deprecated. 
 void setNumberFormatOfBubbleSizes(java.lang.String value)
           NumberFormatOfBubbleSizes.
 void setNumberFormatOfValues(java.lang.String value)
           NumberFormatOfValues.
 void setNumberFormatOfXValues(java.lang.String value)
           NumberFormatOfXValues.
 void setNumberFormatOfYValues(java.lang.String value)
           NumberFormatOfYValues.
 void setOrder(int value)
           Returns the order of a series.
 void setPlotOnSecondAxis(boolean value)
           Indicates if this series is plotted on secondary axis.
 void setSmooth(boolean value)
           Represents curve smoothing.
 void setType(int value)
           Returns a type of this series.
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Method Detail

getParent_Immediate

public com.aspose.slides.IDOMObject getParent_Immediate()

Returns Parent_Immediate object. Read-only IDOMObject.


getChart

public IChart getChart()

Returns the parent chart. Read-only IChart.

Specified by:
getChart in interface IChartComponent

getMarkerFill

@Deprecated
public IFormat getMarkerFill()
Deprecated. 

Gets or sets the marker fill. Read-only IFormat.


getExplosion

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

Specified by:
getExplosion in interface IChartSeries

setExplosion

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

Specified by:
setExplosion in interface IChartSeries

getSmooth

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

Specified by:
getSmooth in interface IChartSeries

setSmooth

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

Specified by:
setSmooth in interface IChartSeries

getMarkerSize

@Deprecated
public int getMarkerSize()
Deprecated. 

Represents the marker size in a line chart, scatter chart, or radar chart. Read/write int.


setMarkerSize

@Deprecated
public void setMarkerSize(int value)
Deprecated. 

Represents the marker size in a line chart, scatter chart, or radar chart. Read/write int.


getMarkerSymbol

@Deprecated
public int getMarkerSymbol()
Deprecated. 

Represents the marker style in a line chart, scatter chart, or radar chart. Read/write MarkerStyleType.


setMarkerSymbol

@Deprecated
public void setMarkerSymbol(int value)
Deprecated. 

Represents the marker style in a line chart, scatter chart, or radar chart. Read/write MarkerStyleType.


getNameCells

@Deprecated
public IChartCellCollection getNameCells()
Deprecated. 

Returns collection of cells with series names. Read-only IChartCellCollection.


getName

public IStringChartValue getName()

Return series name. Read-only IStringChartValue.

Specified by:
getName in interface IChartSeries

getDataPoints

public IChartDataPointCollection getDataPoints()

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

Specified by:
getDataPoints in interface IChartSeries

getType

public int getType()

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

Specified by:
getType in interface IChartSeries

setType

public void setType(int value)

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

Specified by:
setType in interface IChartSeries

getPlotOnSecondAxis

public boolean getPlotOnSecondAxis()

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

Specified by:
getPlotOnSecondAxis in interface IChartSeries

setPlotOnSecondAxis

public void setPlotOnSecondAxis(boolean value)

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

Specified by:
setPlotOnSecondAxis in interface IChartSeries

getParentSeriesGroup

public IChartSeriesGroup getParentSeriesGroup()

ParentSeriesGroup. Read-only IChartSeriesGroup.

Specified by:
getParentSeriesGroup in interface IChartSeries

getFormat

public IFormat getFormat()

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

Specified by:
getFormat in interface IChartSeries

getOrder

public int getOrder()

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

Specified by:
getOrder in interface IChartSeries

setOrder

public void setOrder(int value)

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

Specified by:
setOrder in interface IChartSeries

getLabels

public IDataLabelCollection getLabels()

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

Specified by:
getLabels in interface IChartSeries

getTrendLines

public ITrendlineCollection getTrendLines()

Collection of series trend lines. Read-only ITrendlineCollection.


TrendLines are available (not null) for data series in unstacked 2-D area, bar, column, line, stock, xy (scatter), and bubble charts. A trendline are not available for data series in any chart type that is stacked or 3-D. Trendlines are also not available for radar, pie, surface, or doughnut charts.

Specified by:
getTrendLines in interface IChartSeries

getErrorBarsXFormat

public 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.ErrorBarsCustomValues property).

Specified by:
getErrorBarsXFormat in interface IChartSeries

getErrorBarsYFormat

public 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.ErrorBarsCustomValues property).

Specified by:
getErrorBarsYFormat in interface IChartSeries

getNumberFormatOfValues

public java.lang.String getNumberFormatOfValues()

NumberFormatOfValues. Read/write String.

Specified by:
getNumberFormatOfValues in interface IChartSeries

setNumberFormatOfValues

public void setNumberFormatOfValues(java.lang.String value)

NumberFormatOfValues. Read/write String.

Specified by:
setNumberFormatOfValues in interface IChartSeries

getNumberFormatOfXValues

public java.lang.String getNumberFormatOfXValues()

NumberFormatOfXValues. Read/write String.

Specified by:
getNumberFormatOfXValues in interface IChartSeries

setNumberFormatOfXValues

public void setNumberFormatOfXValues(java.lang.String value)

NumberFormatOfXValues. Read/write String.

Specified by:
setNumberFormatOfXValues in interface IChartSeries

getNumberFormatOfYValues

public java.lang.String getNumberFormatOfYValues()

NumberFormatOfYValues. Read/write String.

Specified by:
getNumberFormatOfYValues in interface IChartSeries

setNumberFormatOfYValues

public void setNumberFormatOfYValues(java.lang.String value)

NumberFormatOfYValues. Read/write String.

Specified by:
setNumberFormatOfYValues in interface IChartSeries

getNumberFormatOfBubbleSizes

public java.lang.String getNumberFormatOfBubbleSizes()

NumberFormatOfBubbleSizes. Read/write String.

Specified by:
getNumberFormatOfBubbleSizes in interface IChartSeries

setNumberFormatOfBubbleSizes

public void setNumberFormatOfBubbleSizes(java.lang.String value)

NumberFormatOfBubbleSizes. Read/write String.

Specified by:
setNumberFormatOfBubbleSizes in interface IChartSeries

getMarker

public IMarker getMarker()

Marker. Read-only IMarker.

Specified by:
getMarker in interface IChartSeries

getBar3DShape

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

Specified by:
getBar3DShape in interface IChartSeries

setBar3DShape

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

Specified by:
setBar3DShape in interface IChartSeries

getInvertIfNegative

public boolean getInvertIfNegative()

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

Specified by:
getInvertIfNegative in interface IChartSeries

setInvertIfNegative

public void setInvertIfNegative(boolean value)

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

Specified by:
setInvertIfNegative in interface IChartSeries

getAutomaticSeriesColor

public java.awt.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.

Specified by:
getAutomaticSeriesColor in interface IChartSeries
Returns:

hasUpDownBars

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

Specified by:
hasUpDownBars in interface IChartSeries

getGapWidth

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

Specified by:
getGapWidth in interface IChartSeries

getGapDepth

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

Specified by:
getGapDepth in interface IChartSeries

getFirstSliceAngle

public final 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.

Specified by:
getFirstSliceAngle in interface IChartSeries

getDoughnutHoleSize

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

Specified by:
getDoughnutHoleSize in interface IChartSeries

getOverlap

public 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 sbyte.


This is the projection of the property ParentSeriesGroup.Overlap.

Specified by:
getOverlap in interface IChartSeries

getSecondPieSize

public final 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.

Specified by:
getSecondPieSize in interface IChartSeries

hasSeriesLines

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

Specified by:
hasSeriesLines in interface IChartSeries

getPieSplitPosition

public final 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.

Specified by:
getPieSplitPosition in interface IChartSeries

getPieSplitBy

public final 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 PieSplitBy.Custom then you can define custom split information with ParentSeriesGroup.PieSplitCustomPoints property.

Specified by:
getPieSplitBy in interface IChartSeries

getPieSplitCustomPoints

public final 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 PieSplitCustomPointCollection.


This is the projection of the property ParentSeriesGroup.PieSplitCustomPoints.

Specified by:
getPieSplitCustomPoints in interface IChartSeries

isColorVaried

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

Specified by:
isColorVaried in interface IChartSeries

getSlide

public IBaseSlide getSlide()

Returns the parent slide of a FillFormat. Read-only BaseSlide.

Specified by:
getSlide in interface ISlideComponent

getPresentation

public IPresentation getPresentation()

Returns the parent presentation of a FillFormat. Read-only IPresentation.

Specified by:
getPresentation in interface IPresentationComponent


Copyright © Copyright 2004-2016 Aspose Pty Ltd. All Rights Reserved.