Home  Products  Purchase  Downloads  Demos  Forums  Blogs  Ticket  Wiki  API  Corporate

com.aspose.cells
Class ASeries

java.lang.Object
  extended by com.aspose.cells.ASeries

public class ASeries
extends java.lang.Object

Encapsulates the object that represents a single data series in a chart.


Method Summary
 Area getArea()
          Gets the background area of ASeries object.
 Line getBorder()
          Gets the line or border of ASeries object.
 java.lang.String getBubbleSizes()
          Gets the size data for the bubble chart.
 com.aspose.cells.ChartPoints getChartPoints()
          Gets the collection of points in a series in a chart.
 DataLabels getDataLabels()
          Gets the DataLabels object for the specified Series.
 Color getMarkerBackgroundColor()
          Gets the marker backgournd color in a line chart, scatter chart, or radar chart.
 Color getMarkerForegroundColor()
          Gets the marker foregournd color in a line chart, scatter chart, or radar chart.
 int getMarkerSize()
          Gets the marker size in a line chart, scatter chart, or radar chart.
 short getMarkerStyle()
          Gets the marker style in a line chart, scatter chart, or radar chart.
 java.lang.String getName()
          Gets the name of the data series.
 int getSeriesNumber()
          Gets the series number (as shown in name box -- Sereies1, Sereies2, etc.).
 Trendlines getTrendlines()
          Gets Trendlines object represents a collection of all the trendlines for the series.
 int getType()
          Gets a data series' type.
 java.lang.String getValues()
          Gets the data of the chart series.
 ErrorBars getXErroBars()
          Gets x error bars of the series
 java.lang.String getXValues()
          Gets the range of x values.
 ErrorBars getYErroBars()
          Gets y error bars of the series
 boolean isColorVaried()
          Indicates whether the color of points is varied.
 boolean isPlotOnSecondAxis()
          Indicates whether this series is plotted on second value axis.
 boolean isSmooth()
          Indicates whether curve smoothing is turned on.
 void setBubbleSizes(java.lang.String sizes)
          Sets the size data for the bubble chart.
 void setColorVaried(boolean isColorVaried)
          Sets whether the color of points is varied.
 void setMarkerBackgroundColor(Color markerBackgroundColor)
          Sets the marker backgournd color in a line chart, scatter chart, or radar chart.
 void setMarkerForegroundColor(Color markerForegroundColor)
          Represents the marker foregournd color in a line chart, scatter chart, or radar chart.
 void setMarkerSize(int markerSize)
          Sets the marker size in a line chart, scatter chart, or radar chart.
 void setMarkerStyle(short markerStyle)
          Sets the marker style in a line chart, scatter chart, or radar chart.
 void setName(java.lang.String name)
          Sets the name of the data series.
 void setPlotOnSecondAxis(boolean isPlotOnSecondAxis)
          Sets whether this series is plotted on second value axis.
 void setSeriesNumber(int seriesNumber)
          Sets the series number(as shown in name box -- Sereies1, Sereies2, etc.).
 void setSmooth(boolean isSmooth)
          Sets whether curve smoothing is turned on.
 void setType(int type)
          Sets a data series' type.
 void setValues(java.lang.String values)
          Sets the data of the chart series.
 void setXValues(java.lang.String xValues)
          Sets the range of x values.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Method Detail

getType

public int getType()
Gets a data series' type.

Returns:
a data series' type.

setType

public void setType(int type)
Sets a data series' type.

Parameters:
type - a data series' type.
Throws:
CellsException - if chart has been removed.

isColorVaried

public boolean isColorVaried()
Indicates whether the color of points is varied.

Returns:
whether the color of points is varied.
Throws:
CellsException - if chart has been removed.

setColorVaried

public void setColorVaried(boolean isColorVaried)
Sets whether the color of points is varied.

Parameters:
isColorVaried - whether the color of points is varied.
Throws:
CellsException - if chart has been removed.

getArea

public Area getArea()
Gets the background area of ASeries object.

Returns:
the background area of ASeries object.
Throws:
CellsException - if series collection has been removed.

getBorder

public Line getBorder()
Gets the line or border of ASeries object.

Returns:
the line or border of ASeries object.
Throws:
CellsException - if series collection has been removed.

getDataLabels

public DataLabels getDataLabels()
Gets the DataLabels object for the specified Series.

Returns:
the DataLabels object for the specified Series.
Throws:
CellsException - if series collection has been removed.

getTrendlines

public Trendlines getTrendlines()
Gets Trendlines object represents a collection of all the trendlines for the series.

Returns:
Trendlines object
Throws:
CellsException - if series collection has been removed.

getName

public java.lang.String getName()
Gets the name of the data series.

Returns:
the name of the data series.
Throws:
CellsException - if series collection has been removed.

setName

public void setName(java.lang.String name)
Sets the name of the data series.

Parameters:
name - the name of the data series.
Throws:
CellsException - if series collection has been removed.

getValues

public java.lang.String getValues()
Gets the data of the chart series.

Returns:
the data of the chart series.
Throws:
CellsException - if series collection has been removed.

setValues

public void setValues(java.lang.String values)
Sets the data of the chart series.

Parameters:
values - the data of the chart series.
Throws:
CellsException - if series collection has been removed.

setXValues

public void setXValues(java.lang.String xValues)
Sets the range of x values. It can be a range of cells (such as, "d1:e10"), or a sequence of values (such as,"{2,6,8,10}").

Parameters:
xValues - the range of x values.
Throws:
java.lang.IllegalArgumentException - if category data is invalid.
CellsException - if chart has been removed.

getXValues

public java.lang.String getXValues()
Gets the range of x values.

Returns:
the range of x values.
Throws:
CellsException - if chart has been removed.
See Also:
setXValues(String)

setBubbleSizes

public void setBubbleSizes(java.lang.String sizes)
Sets the size data for the bubble chart. It can be a range of cells (such as, "d1:e10"), or a sequence of values (such as,"{2,6,8,10}").

Parameters:
sizes - the size data for the bubble chart.
Throws:
java.lang.IllegalArgumentException - if category data is invalid.
CellsException - if chart has been removed.

getBubbleSizes

public java.lang.String getBubbleSizes()
Gets the size data for the bubble chart.

Returns:
the size data for the bubble chart.
Throws:
CellsException - if chart has been removed.
See Also:
setBubbleSizes(String)

getChartPoints

public com.aspose.cells.ChartPoints getChartPoints()
Gets the collection of points in a series in a chart.

Returns:
the collection of points in a series in a chart.
Throws:
CellsException - if chart has been removed.

getMarkerBackgroundColor

public Color getMarkerBackgroundColor()
Gets the marker backgournd color in a line chart, scatter chart, or radar chart.

Returns:
the marker backgournd color
Throws:
CellsException - if chart has been removed.

setMarkerBackgroundColor

public void setMarkerBackgroundColor(Color markerBackgroundColor)
Sets the marker backgournd color in a line chart, scatter chart, or radar chart.

Parameters:
markerBackgroundColor - the marker backgournd color.
Throws:
CellsException - if chart has been removed.

getMarkerForegroundColor

public Color getMarkerForegroundColor()
Gets the marker foregournd color in a line chart, scatter chart, or radar chart.

Returns:
the marker foregournd color.
Throws:
CellsException - if chart has been removed.

setMarkerForegroundColor

public void setMarkerForegroundColor(Color markerForegroundColor)
Represents the marker foregournd color in a line chart, scatter chart, or radar chart.

Parameters:
markerForegroundColor - the marker foregournd color.
Throws:
CellsException - if chart has been removed.

getMarkerSize

public int getMarkerSize()
Gets the marker size in a line chart, scatter chart, or radar chart.

Returns:
the marker size.
Throws:
CellsException - if chart has been removed.

setMarkerSize

public void setMarkerSize(int markerSize)
Sets the marker size in a line chart, scatter chart, or radar chart.

Parameters:
markerSize - the marker size(between 2 and 72).
Throws:
java.lang.IllegalArgumentException - if marker size is not between 2 and 72;
CellsException - if chart has been removed.

getMarkerStyle

public short getMarkerStyle()
Gets the marker style in a line chart, scatter chart, or radar chart.

Returns:
the marker style.
Throws:
CellsException - if chart has been removed.
See Also:
setMarkerStyle(short)

setMarkerStyle

public void setMarkerStyle(short markerStyle)
Sets the marker style in a line chart, scatter chart, or radar chart.

Parameters:
markerStyle - the marker style. It could be one of the following values:
ChartMarkerType.AUTOMATIC
ChartMarkerType.CIRCLE
ChartMarkerType.DASH
ChartMarkerType.DOT
ChartMarkerType.DIAMOND
ChartMarkerType.NONE
ChartMarkerType.SQUARE_PLUS
ChartMarkerType.SQUARE
ChartMarkerType.SQUARE_STAR
ChartMarkerType.TRIANGLE
ChartMarkerType.SQUARE_X
Throws:
java.lang.IllegalArgumentException - if marker style is invalid.
CellsException - if chart has been removed.

getYErroBars

public ErrorBars getYErroBars()
Gets y error bars of the series

Returns:
Errorbars Object.
Throws:
CellsException - if chart has been removed.

getXErroBars

public ErrorBars getXErroBars()
Gets x error bars of the series

Returns:
Errorbars Object.
Throws:
CellsException - if chart has been removed.

getSeriesNumber

public int getSeriesNumber()
Gets the series number (as shown in name box -- Sereies1, Sereies2, etc.). Only effects when series name is auto assigned.

Returns:
the series number.

setSeriesNumber

public void setSeriesNumber(int seriesNumber)
Sets the series number(as shown in name box -- Sereies1, Sereies2, etc.). Only effects when series name is auto assigned.

Parameters:
seriesNumber - series number.
Throws:
CellsException - if chart has been removed.
See Also:
getSeriesNumber()

isSmooth

public boolean isSmooth()
Indicates whether curve smoothing is turned on. True if curve smoothing is turned on for the line chart or scatter chart. Applies only to line and scatter charts.

Returns:
whether curve smoothing is turned on.

setSmooth

public void setSmooth(boolean isSmooth)
Sets whether curve smoothing is turned on. True if curve smoothing is turned on for the line chart or scatter chart. Applies only to line and scatter charts.

Parameters:
isSmooth - whether curve smoothing is turned on.
Throws:
CellsException - if chart has been removed.

isPlotOnSecondAxis

public boolean isPlotOnSecondAxis()
Indicates whether this series is plotted on second value axis.

Returns:
whether this series is plotted on second value axis.

setPlotOnSecondAxis

public void setPlotOnSecondAxis(boolean isPlotOnSecondAxis)
Sets whether this series is plotted on second value axis.

Parameters:
isPlotOnSecondAxis - whether this series is plotted on second value axis.
Throws:
CellsException - if chart has been removed.
java.lang.IllegalArgumentException - if no series is on the primary axis.