![]() |
||
Home Products Purchase Downloads Demos Forums Blogs Ticket Wiki API Corporate |
|
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.aspose.cells.ASeries
public class ASeries
Encapsulates the object that represents a single data series in a chart.
Method Summary | |
---|---|
Area |
getArea()
Gets the background area of ASeries object. |
int |
getBarShape()
Get the shape used with the 3D bar or column chart |
Line |
getBorder()
Gets the line or border of ASeries object. |
short |
getBubbleScale()
Gets the scale factor for bubbles in the specified chart group. |
int |
getBubbleSizeRepresents()
Gets what the bubble size represents on a bubble chart. |
java.lang.String |
getBubbleSizes()
Gets the size data for the bubble chart. |
ChartPoints |
getChartPoints()
Gets the collection of points in a series in a chart. |
DataLabels |
getDataLabels()
Gets the DataLabels object for the specified Series. |
short |
getDoughnutHoleSize()
Gets the size of the hole in a doughnut chart group. |
DropBar |
getDownBar()
Get the DropBar object that represents the down bar on a line chart |
Line |
getDropLine()
Get the Line object that represents the drop line for a series on the line chart or area chart. |
int |
getExplosion()
Get the distance of an open pie slice from the center of the pie chart, expressed as a percentage of the pie diameter. |
int |
getFirstSliceAngle()
Get the angle of the first pie-chart or doughnut-chart slice, in degrees (clockwise from vertical). |
int |
getGapWidth()
Get the space between bar or column clusters, as a percentage of the bar or column width. |
Line |
getHiLoLine()
Gets the HiLoLines object that represents the high-low line for a series on a line chart. |
Line |
getLeaderLine()
Get the Leader Line object that represents the leader line for a chart. |
Marker |
getMarker()
Gets the Marker settings for line chart, scatter chart, or radar chart. |
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 |
getOverlap()
Specifies how bars and columns are positioned. |
int |
getSecondPlotSize()
Gets the size of the secondary section of either a pie of pie chart or a bar of pie chart, as a percentage of the size of the primary pie. |
Line |
getSeriesLine()
Get the Series Line object that represents the series line for a stacked bar chart or a stacked column chart. |
int |
getSeriesNumber()
Gets the series number (as shown in name box -- Sereies1, Sereies2, etc.). |
short |
getSplitType()
Gets the way the two sections of either a pie of pie chart or a bar of pie chart are split |
double |
getSplitValue()
Gets the threshold value separating the two sections of either a pie of pie chart or a bar of pie chart. |
Trendlines |
getTrendlines()
Gets Trendlines object represents a collection of all the trendlines for the series. |
int |
getType()
Gets a data series' type. |
DropBar |
getUpBar()
Get the DropBar object that represents the up bar on a line chart |
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 |
has3DEffect()
Indicates whether the series has 3D-effect. |
boolean |
hasDropLine()
Whether the chart has drop line. |
boolean |
hasHiLoLine()
Whether the line chart has high-low line. |
boolean |
hasLeaderLine()
Indicates whether the series has leader lines. |
boolean |
hasRadarAxisLabels()
Indicates if a radar chart has category axis labels. |
boolean |
hasSeriesLine()
Whether a stacked column chart or bar chart has series line or if a Pie of Pie chart or Bar of Pie chart has connector lines between the two sections. |
boolean |
hasUpDownBar()
Indicates if a line chart has up and down bars. |
boolean |
isColorVaried()
Indicates whether the color of points is varied. |
boolean |
isInvertIfNegative()
Indicates if Microsoft Excel inverts the pattern in the item when it corresponds to a negative number. |
boolean |
isPlotOnSecondAxis()
Indicates whether this series is plotted on second value axis. |
boolean |
isShadow()
Indicates whether the series has a shadow |
boolean |
isShowNegativeBubbles()
If negative bubbles are shown for the chart group. |
boolean |
isSmooth()
Indicates whether curve smoothing is turned on. |
void |
setBarShape(int bar3DShapeType)
Set the shape used with the 3D bar or column chart |
void |
setBubbleScale(short val)
Sets the scale factor for bubbles in the specified chart group. |
void |
setBubbleSizeRepresents(int sizePresents)
ets what the bubble size represents on a bubble chart. |
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 |
setDoughnutHoleSize(short val)
Sets the size of the hole in a doughnut chart group. |
void |
setExplosion(int value)
Set the distance of an open pie slice from the center of the pie chart, expressed as a percentage of the pie diameter. |
void |
setFirstSliceAngle(int angle)
Get the angle of the first pie-chart or doughnut-chart slice, in degrees (clockwise from vertical). |
void |
setGapWidth(int gapWidth)
Set the space between bar or column clusters, as a percentage of the bar or column width. |
void |
setHas3DEffect(boolean has3DEffect)
Sets whether the series has 3D-effect. |
void |
setHasDropLine(boolean hasDropLine)
Set the chart has drop line. |
void |
setHasHiLoLine(boolean hasHiLoLine)
Sets whether the line chart has high-low line. |
void |
setHasLeaderLine(boolean hasLeaderLine)
Sets whether the series has leader lines. |
void |
setHasRadarAxisLabels(boolean flag)
Sets if a radar chart has category axis labels. |
void |
setHasSeriesLine(boolean hasSeriesLine)
Set a stacked column chart or bar chart has series line or if a Pie of Pie chart or Bar of Pie chart has connector line between the two sections. |
void |
setInvertIfNegative(boolean invert)
Sets whether Microsoft Excel inverts the pattern in the item when it corresponds to a negative number. |
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 |
setOverlap(int overlap)
Specifies how bars and columns are positioned. |
void |
setPlotOnSecondAxis(boolean isPlotOnSecondAxis)
Sets whether this series is plotted on second value axis. |
void |
setSecondPlotSize(short size)
Sets the size of the secondary section of either a pie of pie chart or a bar of pie chart, as a percentage of the size of the primary pie. |
void |
setSeriesNumber(int seriesNumber)
Sets the series number(as shown in name box -- Sereies1, Sereies2, etc.). |
void |
setShadow(boolean isShadow)
Sets whether the series has a shadow |
void |
setShowNegativeBubbles(boolean show)
Sets if negative bubbles are shown for the chart group. |
void |
setSmooth(boolean isSmooth)
Sets whether curve smoothing is turned on. |
void |
setSplitType(short type)
Sets the way the two sections of either a pie of pie chart or a bar of pie chart are split |
void |
setSplitValue(double splitValue)
Sets the threshold value separating the two sections of either a pie of pie chart or a bar of pie chart. |
void |
setType(int type)
Sets a data series' type. |
void |
setUpDownBar(boolean hasUpDownBar)
Set a line chart has up and down bars. |
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 |
---|
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Method Detail |
---|
public int getType()
public void setType(int type)
type
- a data series' type.
CellsException
- if chart has been removed.public boolean hasHiLoLine()
public void setHasHiLoLine(boolean hasHiLoLine)
hasHiLoLine
- whether the line chart has high-low line.public Line getHiLoLine()
public boolean hasSeriesLine()
public void setHasSeriesLine(boolean hasSeriesLine)
hasSeriesLine
- public Line getSeriesLine()
public boolean hasDropLine()
public void setHasDropLine(boolean hasDropLine)
hasDropLine
- public Line getDropLine()
public boolean hasUpDownBar()
public void setUpDownBar(boolean hasUpDownBar)
hasUpDownBar
- whether the chart has up and down bars.public DropBar getUpBar()
public DropBar getDownBar()
public int getGapWidth()
public void setGapWidth(int gapWidth)
gapWidth
- the space between bar or column clusterspublic int getFirstSliceAngle()
public void setFirstSliceAngle(int angle)
angle
- the angle of the first pie-chart or doughnut-chart slicepublic int getOverlap()
public void setOverlap(int overlap)
overlap
- overlap of bars and columns are positionedpublic boolean hasLeaderLine()
public void setHasLeaderLine(boolean hasLeaderLine)
hasLeaderLine
- whether the series has leader lines.public Line getLeaderLine()
public boolean hasRadarAxisLabels()
public void setHasRadarAxisLabels(boolean flag)
flag
- if a radar chart has category axis labels.public short getDoughnutHoleSize()
public void setDoughnutHoleSize(short val)
val
- the size of the hole in a doughnut chart group.public boolean isColorVaried()
CellsException
- if chart has been removed.public void setColorVaried(boolean isColorVaried)
isColorVaried
- whether the color of points is varied.
CellsException
- if chart has been removed.public short getSplitType()
setSplitType(short)
public void setSplitType(short type)
type
- the way the two sections of either a pie of pie chart or a bar of pie chart are split.ChartSplitType
public double getSplitValue()
public void setSplitValue(double splitValue)
splitValue
- the threshold value separating the two sections of either a pie of pie chart or a bar of pie chart.public int getSecondPlotSize()
public void setSecondPlotSize(short size)
size
- the size of the secondary section of either a pie of pie chart or a bar of pie chartpublic Area getArea()
CellsException
- if series collection has been removed.public Line getBorder()
CellsException
- if series collection has been removed.public int getBarShape()
public void setBarShape(int bar3DShapeType)
bar3DShapeType
- the shape used with the 3D bar or column chart.Bar3DShapeType
public DataLabels getDataLabels()
CellsException
- if series collection has been removed.public boolean isInvertIfNegative()
public void setInvertIfNegative(boolean invert)
invert
- whether Microsoft Excel inverts the pattern in the item when it corresponds to a negative number.public int getExplosion()
public void setExplosion(int value)
value
- the distance of an open pie slice from the center of the pie chartpublic Trendlines getTrendlines()
CellsException
- if series collection has been removed.public java.lang.String getName()
CellsException
- if series collection has been removed.public void setName(java.lang.String name)
name
- the name of the data series.
CellsException
- if series collection has been removed.public java.lang.String getValues()
CellsException
- if series collection has been removed.public void setValues(java.lang.String values)
values
- the data of the chart series.
CellsException
- if series collection has been removed.public void setXValues(java.lang.String xValues)
xValues
- the range of x values.
java.lang.IllegalArgumentException
- if category data is invalid.
CellsException
- if chart has been removed.public java.lang.String getXValues()
CellsException
- if chart has been removed.setXValues(String)
public void setBubbleSizes(java.lang.String sizes)
sizes
- the size data for the bubble chart.
java.lang.IllegalArgumentException
- if category data is invalid.
CellsException
- if chart has been removed.public java.lang.String getBubbleSizes()
CellsException
- if chart has been removed.setBubbleSizes(String)
public int getBubbleSizeRepresents()
setBubbleSizeRepresents(int)
public void setBubbleSizeRepresents(int sizePresents)
sizePresents
- the bubble size represents on a bubble chart. It could be one of the following values: BubbleSizeRepresents.AREA |
BubbleSizeRepresents.WIDTH |
public boolean isShowNegativeBubbles()
public void setShowNegativeBubbles(boolean show)
show
- True if negative bubbles are shown for the chart group.public short getBubbleScale()
public void setBubbleScale(short val)
val
- the scale factor for bubbles in the specified chart group.public ChartPoints getChartPoints()
CellsException
- if chart has been removed.public Marker getMarker()
public Color getMarkerBackgroundColor()
CellsException
- if chart has been removed.Marker.getArea()
public void setMarkerBackgroundColor(Color markerBackgroundColor)
markerBackgroundColor
- the marker backgournd color.
CellsException
- if chart has been removed.Marker.getArea()
public Color getMarkerForegroundColor()
CellsException
- if chart has been removed.Marker.getLine()
public void setMarkerForegroundColor(Color markerForegroundColor)
markerForegroundColor
- the marker foregournd color.
CellsException
- if chart has been removed.public int getMarkerSize()
CellsException
- if chart has been removed.Marker.getSize()
public void setMarkerSize(int markerSize)
markerSize
- the marker size(between 2 and 72).
java.lang.IllegalArgumentException
- if marker size is not between 2 and 72;
CellsException
- if chart has been removed.Marker.setSize(int)
public short getMarkerStyle()
CellsException
- if chart has been removed.Marker.getStyle()
public void setMarkerStyle(short markerStyle)
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 |
java.lang.IllegalArgumentException
- if marker style is invalid.
CellsException
- if chart has been removed.Marker.setStyle(short)
public ErrorBars getYErroBars()
CellsException
- if chart has been removed.public ErrorBars getXErroBars()
CellsException
- if chart has been removed.public int getSeriesNumber()
public void setSeriesNumber(int seriesNumber)
seriesNumber
- series number.
CellsException
- if chart has been removed.getSeriesNumber()
public boolean isSmooth()
public void setSmooth(boolean isSmooth)
isSmooth
- whether curve smoothing is turned on.
CellsException
- if chart has been removed.public boolean isShadow()
public void setShadow(boolean isShadow)
isShadow
- whether the series has a shadowpublic boolean has3DEffect()
public void setHas3DEffect(boolean has3DEffect)
has3DEffect
- whether the series has 3D-effect.public boolean isPlotOnSecondAxis()
public void setPlotOnSecondAxis(boolean isPlotOnSecondAxis)
isPlotOnSecondAxis
- whether this series is plotted on second value axis.
CellsException
- if chart has been removed.
java.lang.IllegalArgumentException
- if no series is on the primary axis.
|
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |