com.spire.xls.core.spreadsheet.charts
Class XlsChartSerie

java.lang.Object
  com.spire.xls.core.spreadsheet.XlsObject
      com.spire.xls.core.spreadsheet.charts.XlsChartSerie

All Implemented Interfaces:

IChartSerie

Direct Known Subclasses:

ChartSerie

public class XlsChartSerie
extends XlsObject
implements IChartSerie

Constructor Summary

XlsChartSerie(java.lang.Object parent)

Method Summary

XlsChartSerie	deepClone(java.lang.Object parent, java.util.HashMap newNames, java.util.HashMap fontIndexes) Clone current instance.
IChartErrorBars	errorBar(boolean bIsY) Creates error bar object.
IChartErrorBars	errorBar(boolean bIsY, ErrorBarIncludeType include) Creates error bar object.
IChartErrorBars	errorBar(boolean bIsY, ErrorBarIncludeType include, ErrorBarType type) Creates error bar object.
IChartErrorBars	errorBar(boolean bIsY, ErrorBarIncludeType include, ErrorBarType type, double numberValue) Creates error bar object.
IChartErrorBars	errorBar(boolean bIsY, IXLSRange plusRange, IXLSRange minusRange) Sets custom error bar type.
IXLSRange	getBubbles() Bubble sizes for the series.
IXLSRange	getCategoryLabels() Category labels for the series.
int	getChartGroup() Index of the chart group.
XlsChartFormat	getCommonSerieFormat() Gets common serie format.
IChartDataPoints	getDataPoints() Returns collection of data points.
java.lang.Object[]	getEnteredDirectlyBubbles() Represents bubble values as entered directly.
java.lang.Object[]	getEnteredDirectlyCategoryLabels() Represents category values as entered directly.
java.lang.Object[]	getEnteredDirectlyValues() Represents value as entered directly.
IChartErrorBars	getErrorBarsX() Represents X error bars.
IChartErrorBars	getErrorBarsY() Represents Y error bars.
IChartSerieDataFormat	getFormat() Returns format of current serie.
int	getIndex() Represents index of the series.
java.lang.Boolean	getInvertNegaColor() Indicates wheter to invert its colors if the value is negative.
java.lang.String	getName() Gets name of the series.
CellRange	getNamedRange() Series Name range for the series.
java.lang.String	getNameOrFormula() Gets series name or formula value (not actual string value).
int	getNumber() Number of the series.
XlsChartSeries	getParentSeries() Gets parent serie collection.
int	getPointNumber() Returns number of points in the series.
int	getRealIndex() Synonym for Index property.
IXLSRange	getSerieNameRange() Gets serie name range.
ExcelChartType	getSerieType() Represents serie type.
java.lang.String	getStartType() Returns serie start type.
IChartTrendLines	getTrendLines() Represents serie trend lines collection.
boolean	getUsePrimaryAxis() Indicates whether to use primary axis for series drawing.
IXLSRange	getValues() Values range for the series.
boolean	hasErrorBarsX() Indicates if serie contains X error bars.
void	hasErrorBarsX(boolean value) Indicates if serie contains X error bars.
boolean	hasErrorBarsY() Indicates if serie contains Y error bars.
void	hasErrorBarsY(boolean value) Indicates if serie contains Y error bars.
void	setBubbles(IXLSRange value) Bubble sizes for the series.
void	setCategoryLabels(IXLSRange value) Category labels for the series.
void	setDefaultName(java.lang.String defaultName) Sets default serie name.
void	setEnteredDirectlyBubbles(java.lang.Object[] value) Represents bubble values as entered directly.
void	setEnteredDirectlyCategoryLabels(java.lang.Object[] value) Represents category values as entered directly.
void	setEnteredDirectlyValues(java.lang.Object[] value) Represents value as entered directly.
void	setInvertNegaColor(java.lang.Boolean value) Indicates wheter to invert its colors if the value is negative.
void	setName(java.lang.String name) Sets name of the series.
void	setSerieType(ExcelChartType serieType) Sets serie type.
void	setUsePrimaryAxis(boolean usePrimaryAxis) Indicates whether to use primary axis for series drawing.
void	setValues(IXLSRange value) Values range for the series.

Methods inherited from class com.spire.xls.core.spreadsheet.XlsObject

dispose

Constructor Detail

XlsChartSerie

public XlsChartSerie(java.lang.Object parent)

Method Detail

getChartGroup

public int getChartGroup()

Index of the chart group.

getValues

public IXLSRange getValues()

Values range for the series.

Specified by:

getValues in interface IChartSerie

setValues

public void setValues(IXLSRange value)

Values range for the series.

Specified by:

setValues in interface IChartSerie

getCategoryLabels

public IXLSRange getCategoryLabels()

Category labels for the series.

Specified by:

getCategoryLabels in interface IChartSerie

setCategoryLabels

public void setCategoryLabels(IXLSRange value)

Category labels for the series.

getBubbles

public IXLSRange getBubbles()

Bubble sizes for the series.

Specified by:

getBubbles in interface IChartSerie

setBubbles

public void setBubbles(IXLSRange value)

Bubble sizes for the series.

Specified by:

setBubbles in interface IChartSerie

getName

public java.lang.String getName()

Gets name of the series.

Specified by:

getName in interface IChartSerie

setName

public void setName(java.lang.String name)

Sets name of the series.

getNamedRange

public CellRange getNamedRange()

Series Name range for the series.

Specified by:

getNamedRange in interface IChartSerie

getNameOrFormula

public java.lang.String getNameOrFormula()

Gets series name or formula value (not actual string value).

getNumber

public int getNumber()

Number of the series.

getParentSeries

public XlsChartSeries getParentSeries()

Gets parent serie collection. Read - only.

getUsePrimaryAxis

public boolean getUsePrimaryAxis()

Indicates whether to use primary axis for series drawing.

Specified by:

getUsePrimaryAxis in interface IChartSerie

setUsePrimaryAxis

public void setUsePrimaryAxis(boolean usePrimaryAxis)

Indicates whether to use primary axis for series drawing.

Specified by:

setUsePrimaryAxis in interface IChartSerie

getDataPoints

public IChartDataPoints getDataPoints()

Returns collection of data points. Read-only.

Specified by:

getDataPoints in interface IChartSerie

getPointNumber

public int getPointNumber()

Returns number of points in the series. Read-only.

getRealIndex

public int getRealIndex()

Synonym for Index property.

getFormat

public IChartSerieDataFormat getFormat()

Returns format of current serie.

Specified by:

getFormat in interface IChartSerie

getSerieType

public ExcelChartType getSerieType()

Represents serie type.

Specified by:

getSerieType in interface IChartSerie

setSerieType

public void setSerieType(ExcelChartType serieType)

Sets serie type.

Specified by:

setSerieType in interface IChartSerie

getStartType

public java.lang.String getStartType()

Returns serie start type. Read-only.

getEnteredDirectlyValues

public java.lang.Object[] getEnteredDirectlyValues()

Represents value as entered directly.

Specified by:

getEnteredDirectlyValues in interface IChartSerie

setEnteredDirectlyValues

public void setEnteredDirectlyValues(java.lang.Object[] value)

Represents value as entered directly.

Specified by:

setEnteredDirectlyValues in interface IChartSerie

getEnteredDirectlyCategoryLabels

public java.lang.Object[] getEnteredDirectlyCategoryLabels()

Represents category values as entered directly.

Specified by:

getEnteredDirectlyCategoryLabels in interface IChartSerie

setEnteredDirectlyCategoryLabels

public void setEnteredDirectlyCategoryLabels(java.lang.Object[] value)

Represents category values as entered directly.

Specified by:

setEnteredDirectlyCategoryLabels in interface IChartSerie

getEnteredDirectlyBubbles

public java.lang.Object[] getEnteredDirectlyBubbles()

Represents bubble values as entered directly.

Specified by:

getEnteredDirectlyBubbles in interface IChartSerie

setEnteredDirectlyBubbles

public void setEnteredDirectlyBubbles(java.lang.Object[] value)

Represents bubble values as entered directly.

Specified by:

setEnteredDirectlyBubbles in interface IChartSerie

getErrorBarsY

public IChartErrorBars getErrorBarsY()

Represents Y error bars. Read only.

Specified by:

getErrorBarsY in interface IChartSerie

hasErrorBarsY

public boolean hasErrorBarsY()

Indicates if serie contains Y error bars.

Specified by:

hasErrorBarsY in interface IChartSerie

hasErrorBarsY

public void hasErrorBarsY(boolean value)

Indicates if serie contains Y error bars.

Specified by:

hasErrorBarsY in interface IChartSerie

getErrorBarsX

public IChartErrorBars getErrorBarsX()

Represents X error bars. Read only.

Specified by:

getErrorBarsX in interface IChartSerie

hasErrorBarsX

public boolean hasErrorBarsX()

Indicates if serie contains X error bars.

Specified by:

hasErrorBarsX in interface IChartSerie

hasErrorBarsX

public void hasErrorBarsX(boolean value)

Indicates if serie contains X error bars.

Specified by:

hasErrorBarsX in interface IChartSerie

getTrendLines

public IChartTrendLines getTrendLines()

Represents serie trend lines collection. Read only.

Specified by:

getTrendLines in interface IChartSerie

getInvertNegaColor

public java.lang.Boolean getInvertNegaColor()

Indicates wheter to invert its colors if the value is negative.

setInvertNegaColor

public void setInvertNegaColor(java.lang.Boolean value)

Indicates wheter to invert its colors if the value is negative.

getIndex

public int getIndex()

Represents index of the series.

deepClone

public XlsChartSerie deepClone(java.lang.Object parent,
                               java.util.HashMap newNames,
                               java.util.HashMap fontIndexes)

Clone current instance.

Parameters:

parent - Parent object.

newNames - Hash table with new worksheet names.

fontIndexes - Dictionary with new font indexes.

Returns:

errorBar

public IChartErrorBars errorBar(boolean bIsY)

Creates error bar object.

Specified by:

errorBar in interface IChartSerie

Parameters:

bIsY - If true - on Y axis; otherwise on X axis.

Returns:

Return error bar objcet.

errorBar

public IChartErrorBars errorBar(boolean bIsY,
                                ErrorBarIncludeType include)

Creates error bar object.

Specified by:

errorBar in interface IChartSerie

Parameters:

bIsY - If true - on Y axis; otherwise on X axis.

include - Represents include type.

Returns:

Return error bar objcet.

errorBar

public IChartErrorBars errorBar(boolean bIsY,
                                ErrorBarIncludeType include,
                                ErrorBarType type)

Creates error bar object.

Specified by:

errorBar in interface IChartSerie

Parameters:

bIsY - If true - on Y axis; otherwise on X axis.

include - Represents include type.

type - Represents error bar type.

Returns:

Return error bar objcet.

errorBar

public IChartErrorBars errorBar(boolean bIsY,
                                ErrorBarIncludeType include,
                                ErrorBarType type,
                                double numberValue)

Creates error bar object.

Specified by:

errorBar in interface IChartSerie

Parameters:

bIsY - If true - on Y axis; otherwise on X axis.

include - Represents include type.

type - Represents error bar type.

numberValue - Represents number value.

Returns:

Return error bar objcet.

errorBar

public IChartErrorBars errorBar(boolean bIsY,
                                IXLSRange plusRange,
                                IXLSRange minusRange)

Sets custom error bar type.

Specified by:

errorBar in interface IChartSerie

Parameters:

bIsY - If true - on Y axis; otherwise on X axis.

plusRange - Represents plus range.

minusRange - Represents minus range.

Returns:

Returns error bar object.

getCommonSerieFormat

public XlsChartFormat getCommonSerieFormat()

Gets common serie format.

Returns:

Returns common serie format.

getSerieNameRange

public IXLSRange getSerieNameRange()

Gets serie name range.

Returns:

Returns range, that represents serie name range. Can be null.

setDefaultName

public void setDefaultName(java.lang.String defaultName)

Sets default serie name.

Parameters:

defaultName - Represents serie name.