com.aspose.slides

Interface IChartSeriesGroup

All Superinterfaces:

IChartComponent, IPresentationComponent, ISlideComponent

All Known Implementing Classes:

ChartSeriesGroup

public interface IChartSeriesGroup
extends IChartComponent

Represents group of series.

1) See summary and remarks for ChartSeriesGroupCollection class and CombinableSeriesTypesGroup enum. 2) Group of series contains some series properies whitch is common for each series in group ("series group properties"). "Series group properties" in ChartSeriesGroup class is read/write. Each of "series group properties" can have a read-only projection in ChartSeries class.

Method Summary

Modifier and Type	Method and Description
IChartSeries	get_Item(int index) Gets the element at the specified index.
int	getBubbleSizeRepresentation() Specifies how the bubble size values are represented on the bubble chart.
int	getBubbleSizeScale() Specifies the scale factor for the bubble chart (can be between 0 and 300 percents of the default size).
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.).
int	getFirstSliceAngle() Gets or sets the angle of the first pie or doughnut chart slice, in degrees (clockwise from up, from 0 to 360 degrees).
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.
IChartLinesFormat	getHiLowLinesFormat() Specifies HiLowLines format.
byte	getOverlap() Specifies how much bars and columns shall overlap on 2-D charts, as a percentage (from -100% to 100%).
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 series of this group is plotted on secondary axis.
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).
IChartSeriesReadonlyCollection	getSeries() Returns a readonly collection of chart series.
int	getType() Returns a type of this series group.
IUpDownBarsManager	getUpDownBars() Provede access to up/down bars of Line- or Stock-chart.
boolean	hasSeriesLines() True if chart has series lines.
boolean	isColorVaried() Specifies that each data marker in the series has a different color.
void	setBubbleSizeRepresentation(int value) Specifies how the bubble size values are represented on the bubble chart.
void	setBubbleSizeScale(int value) Specifies the scale factor for the bubble chart (can be between 0 and 300 percents of the default size).
void	setColorVaried(boolean value) Specifies that each data marker in the series has a different color.
void	setDoughnutHoleSize(byte value) Specifies the size of the hole in a doughnut chart (can be between 10 and 90 percents of the size of the plot area.).
void	setFirstSliceAngle(int value) Gets or sets the angle of the first pie or doughnut chart slice, in degrees (clockwise from up, from 0 to 360 degrees).
void	setGapDepth(int value) Returns or sets the distance, as a percentage of the marker width, between the data series in a 3D chart.
void	setGapWidth(int value) Specifies the space between bar or column clusters, as a percentage of the bar or column width.
void	setOverlap(byte value) Specifies how much bars and columns shall overlap on 2-D charts, as a percentage (from -100% to 100%).
void	setPieSplitBy(int value) Specifies how to determine which data points are in the second pie or bar on a pie-of-pie or bar-of-pie chart.
void	setPieSplitPosition(double value) 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.
void	setSecondPieSize(int value) 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).
void	setSeriesLines(boolean value) True if chart has series lines.

Methods inherited from interface com.aspose.slides.IChartComponent

getChart

Methods inherited from interface com.aspose.slides.ISlideComponent

getSlide

Methods inherited from interface com.aspose.slides.IPresentationComponent

getPresentation

Method Detail

getType

int getType()

Returns a type of this series group. Read-only CombinableSeriesTypesGroup.

getPlotOnSecondAxis

boolean getPlotOnSecondAxis()

Indicates if series of this group is plotted on secondary axis. Read-only boolean.

getSeries

IChartSeriesReadonlyCollection getSeries()

Returns a readonly collection of chart series. Read-only IChartSeriesReadonlyCollection.

get_Item

IChartSeries get_Item(int index)

Gets the element at the specified index.

getUpDownBars

IUpDownBarsManager getUpDownBars()

Provede access to up/down bars of Line- or Stock-chart. Read-only IUpDownBarsManager.

getGapWidth

int getGapWidth()

Specifies the space between bar or column clusters, as a percentage of the bar or column width. Read/write int.

setGapWidth

void setGapWidth(int value)

Specifies the space between bar or column clusters, as a percentage of the bar or column width. Read/write int.

getGapDepth

int getGapDepth()

Returns or sets the distance, as a percentage of the marker width, between the data series in a 3D chart. Read/write int.

setGapDepth

void setGapDepth(int value)

Returns or sets the distance, as a percentage of the marker width, between the data series in a 3D chart. Read/write int.

getFirstSliceAngle

int getFirstSliceAngle()

Gets or sets the angle of the first pie or doughnut chart slice, in degrees (clockwise from up, from 0 to 360 degrees). Read/write int.

setFirstSliceAngle

void setFirstSliceAngle(int value)

Gets or sets the angle of the first pie or doughnut chart slice, in degrees (clockwise from up, from 0 to 360 degrees). Read/write int.

isColorVaried

boolean isColorVaried()

Specifies that each data marker in the series has a different color. Read/write boolean.

setColorVaried

void setColorVaried(boolean value)

Specifies that each data marker in the series has a different color. Read/write boolean.

hasSeriesLines

boolean hasSeriesLines()

True if chart has series lines. Applied to stacked bar and OfPie charts. Read/write boolean.

setSeriesLines

void setSeriesLines(boolean value)

True if chart has series lines. Applied to stacked bar and OfPie charts. Read/write boolean.

getOverlap

byte getOverlap()

Specifies how much bars and columns shall overlap on 2-D charts, as a percentage (from -100% to 100%). - -100%: Maximum spacing (bars are completely separated). - 0%: Bars are placed side by side without overlap or spacing. - 100%: Maximum overlap (bars completely overlap each other). This property is read/write byte.

  The following example demonstrates how to set the overlap for a chart series group 
  and render the resulting chart on a form:
  
 Presentation pres = new Presentation();
 try {
     IChart chart = pres.getSlides().get_Item(0).getShapes().addChart(ChartType.ClusteredColumn, 10, 10, 600, 300);
     IChartSeriesCollection series = chart.getChartData().getSeries();
     series.get_Item(0).getParentSeriesGroup().setOverlap((byte)55); // Set overlap to 55%
     pres.getSlides().get_Item(0).getImage(1, 1).save("chart.png");
 } finally {
     if (pres != null) pres.dispose();
 }
  
  

Throws:

com.aspose.ms.System.ArgumentOutOfRangeException - Thrown when the value is set outside the valid range of -100 to 100.

setOverlap

void setOverlap(byte value)

Specifies how much bars and columns shall overlap on 2-D charts, as a percentage (from -100% to 100%). - -100%: Maximum spacing (bars are completely separated). - 0%: Bars are placed side by side without overlap or spacing. - 100%: Maximum overlap (bars completely overlap each other). This property is read/write byte.

  The following example demonstrates how to set the overlap for a chart series group 
  and render the resulting chart on a form:
  
 Presentation pres = new Presentation();
 try {
     IChart chart = pres.getSlides().get_Item(0).getShapes().addChart(ChartType.ClusteredColumn, 10, 10, 600, 300);
     IChartSeriesCollection series = chart.getChartData().getSeries();
     series.get_Item(0).getParentSeriesGroup().setOverlap((byte)55); // Set overlap to 55%
     pres.getSlides().get_Item(0).getImage(1, 1).save("chart.png", ImageFormat.Png);
 } finally {
     if (pres != null) pres.dispose();
 }
  
  

Throws:

com.aspose.ms.System.ArgumentOutOfRangeException - Thrown when the value is set outside the valid range of -100 to 100.

getSecondPieSize

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). Read/write int.

setSecondPieSize

void setSecondPieSize(int value)

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). Read/write int.

getPieSplitPosition

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. Read/write double.

setPieSplitPosition

void setPieSplitPosition(double value)

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. Read/write double.

getPieSplitBy

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. Read/write PieSplitType.

setPieSplitBy

void setPieSplitBy(int value)

Specifies how to determine which data points are in the second pie or bar on a pie-of-pie or bar-of-pie chart. Read/write PieSplitType.

getPieSplitCustomPoints

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. Read-only IPieSplitCustomPointCollection.

getDoughnutHoleSize

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.). Read/write byte.

setDoughnutHoleSize

void setDoughnutHoleSize(byte value)

Specifies the size of the hole in a doughnut chart (can be between 10 and 90 percents of the size of the plot area.). Read/write byte.

getBubbleSizeScale

int getBubbleSizeScale()

Specifies the scale factor for the bubble chart (can be between 0 and 300 percents of the default size). Read/write int.

setBubbleSizeScale

void setBubbleSizeScale(int value)

Specifies the scale factor for the bubble chart (can be between 0 and 300 percents of the default size). Read/write int.

getHiLowLinesFormat

IChartLinesFormat getHiLowLinesFormat()

Specifies HiLowLines format. HiLowLines applied with HiLowClose, OpenHiLowClose, VolumeHiLowClose and VolumeOpenHiLowClose chart types.

getBubbleSizeRepresentation

int getBubbleSizeRepresentation()

Specifies how the bubble size values are represented on the bubble chart. Read/write BubbleSizeRepresentationType.

setBubbleSizeRepresentation

void setBubbleSizeRepresentation(int value)

Specifies how the bubble size values are represented on the bubble chart. Read/write BubbleSizeRepresentationType.