Namespace EasyXLS.Charts

Class ExcelSeries

System.Object

EasyXLS.Drawings.DrawingObject

EasyXLS.Drawings.LineDrawingObject

EasyXLS.Drawings.FillDrawingObject

EasyXLS.Drawings.EffectDrawingObject

EasyXLS.Charts.ExcelSeries

All Implemented Interfaces:

IEffectDrawingObject

public class ExcelSeries
extends EffectDrawingObject

This class stores the series information like values, name, fill settings, line settings, shadow settings, data labels type, legend key visibility next to label, marker type. A chart can have multiple series.

Constructor Summary

Constructors

Constructor	Description
ExcelSeries()	Defines an instance of the excel series.
ExcelSeries(System.String seriesName, System.String seriesValues)	Defines an instance of the excel series that has the name and the values defined.

Method Summary

Modifier and Type	Method	Description
ExcelSeries	Clone()	Creates and returns a copy of this object.
System.Drawing.Color	getBackground()	Deprecated. As of version 8.3, replaced by FillFormat.getBackground()
ExcelDataLabels	getDataLabels()	Returns the data labels settings of the chart series.
System.Drawing.Color	getLineColor()	Deprecated. As of version 8.3, replaced by LineColorFormat.getLineColor()
int	getLineStyle()	Deprecated. As of version 8.3, replaced by LineStyleFormat.getDashType()
int	getLineWeight()	Deprecated. As of version 8.3, replaced by LineStyleFormat.getWidth()
FillFormat	getMarkerFillFormat()	Returns the fill formatting of the marker.
LineColorFormat	getMarkerLineColorFormat()	Returns the line color formatting of the marker.
LineStyleFormat	getMarkerLineStyleFormat()	Returns the line style formatting of the marker.
int	getMarkerSize()	Returns the marker size of the chart series.
int	getMarkerType()	Returns the marker type of the chart series.
System.String	getName()	Returns the name of the chart series.
bool	getShowLegendKeyNextToLabel()	Deprecated. As of version 8.5, replaced by ExcelDataLabels.getShowLegendKeyNextToLabel()
float	getStackScale()	Returns the scale for the stack option.
System.String	getValues()	Returns the values of the chart series.
bool	IsInvertIfNegative()	Returns true if the color is inverted for negative values of the chart series, false otherwise.
bool	IsShadow()	Deprecated. As of version 8.3, replaced by ShadowFormat.HasShadow()
bool	IsSmoothedLine()	Returns true if the line is smoothed, false otherwise.
void	setBackground(System.Drawing.Color background)	Deprecated. As of version 8.3, replaced by FillFormat.setBackground(Color)
void	setDataLabels(int dataLabels)	Deprecated. As of version 8.5, replaced by setDataLabels(ExcelDataLabels)
void	setDataLabels(ExcelDataLabels xlsDataLabels)	Sets the data labels settings of the chart series. This method is overridden as setDataLabels_2 in COM+ version of EasyXLS.
void	setInvertIfNegative(bool invertIfNegative)	Sets the "invert if negative" option for the chart series.
void	setLineColor(System.Drawing.Color lineColor)	Deprecated. As of version 8.3, replaced by LineColorFormat.setLineColor(Color)
void	setLineStyle(int lineStyle)	Deprecated. As of version 8.3, replaced by LineStyleFormat.setDashType(String)
void	setLineWeight(int lineWeight)	Deprecated. As of version 8.3, replaced by LineStyleFormat.setWidth(float)
void	setMarkerFillFormat(FillFormat fillFormat)	Sets the fill formatting of the marker.
void	setMarkerLineColorFormat(LineColorFormat lineColorFormat)	Sets the line color formatting of the marker.
void	setMarkerLineStyleFormat(LineStyleFormat lineStyleFormat)	Sets the line style formatting of the marker.
void	setMarkerSize(int markerSize)	Sets the marker size of the chart series.
void	setMarkerType(int markerType)	Sets the marker type of the chart series.
void	setName(System.String seriesName)	Returns the name of the chart series.
void	setShadow(bool isShadow)	Deprecated. As of version 8.3, replaced by ShadowFormat.setShadow(int)
void	setShowDataLabels(bool show)	Sets the data labels visible or not visible.
void	setShowLegendKeyNextToLabel(bool value)	Deprecated. As of version 8.5, replaced by ExcelDataLabels.setShowLegendKeyNextToLabel(bool)
void	setSmoothedLine(bool isSmoothedLine)	Sets the smoothed line for line based charts.
void	setStackScale(float scale)	Sets the stack option and scale.
void	setValues(System.String seriesValues)	Sets the values of the chart series.
bool	ShowDataLabels()	Returns true if data labels are attached to the series, false otherwise.

Methods inherited from class EasyXLS.Drawings.EffectDrawingObject

get3DFormat, set3DFormat

Methods inherited from class EasyXLS.Drawings.FillDrawingObject

getFillFormat, setFillFormat

Methods inherited from class EasyXLS.Drawings.LineDrawingObject

getLineColorFormat, getLineStyleFormat, getShadowFormat, setLineColorFormat, setLineStyleFormat, setShadowFormat

Methods inherited from class EasyXLS.Drawings.DrawingObject

getHeight, getHorizontalOffset, getRelativeHeight, getRelativeHorizontalOffset, getRelativeVerticalOffset, getRelativeWidth, getVerticalOffset, getWidth, setLeftUpperOffset, setRelativeLeftUpperOffset, setRelativeSize, setSize

Methods inherited from class System.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

ExcelSeries

public ExcelSeries()

Defines an instance of the excel series.

ExcelSeries

public ExcelSeries(System.String seriesName,
 System.String seriesValues)

Defines an instance of the excel series that has the name and the values defined.

Parameters:

seriesName - the series name

seriesValues - the series values

Method Details

getName

public System.String getName()

Returns the name of the chart series. It can be a string or a formula.

Returns:

the name of the chart series

See Also:

setName(System.String)

setName

public void setName(System.String seriesName)

Returns the name of the chart series. It can be a string or a formula.

Parameters:

seriesName - the new name of the chart series

See Also:

getName()

getValues

public System.String getValues()

Returns the values of the chart series. It must be a formula.

Returns:

the values of the chart series

See Also:

setValues(System.String)

setValues

public void setValues(System.String seriesValues)

Sets the values of the chart series. It must be a formula.

Parameters:

seriesValues - the new values of the chart series

See Also:

getValues()

getLineStyle

public int getLineStyle()

Deprecated.

As of version 8.3, replaced by LineStyleFormat.getDashType()

Returns the line style of the chart series. Possible values are available in Chart class.

Returns:

the line style of the chart series

See Also:

setLineStyle(int)

setLineStyle

public void setLineStyle(int lineStyle)

Deprecated.

As of version 8.3, replaced by LineStyleFormat.setDashType(String)

Returns the line style of the chart series. Possible values are available in Chart class.

Parameters:

lineStyle - the new style of the chart series line

See Also:

getLineStyle()

getLineWeight

public int getLineWeight()

Deprecated.

As of version 8.3, replaced by LineStyleFormat.getWidth()

Returns the line weight of the chart series. Possible values are available in Chart class.

Returns:

the line weight of the chart series

See Also:

setLineWeight(int)

setLineWeight

public void setLineWeight(int lineWeight)

Deprecated.

As of version 8.3, replaced by LineStyleFormat.setWidth(float)

Sets the line weight of the chart series. Possible values are available in Chart class.

Parameters:

lineWeight - the new weight of the chart series line

See Also:

getLineWeight()

getLineColor

public System.Drawing.Color getLineColor()

Deprecated.

As of version 8.3, replaced by LineColorFormat.getLineColor()

Returns the line color of the chart series.

Returns:

the line color of the chart series

See Also:

setLineColor(Color)

setLineColor

public void setLineColor(System.Drawing.Color lineColor)

Deprecated.

As of version 8.3, replaced by LineColorFormat.setLineColor(Color)

Sets the line color of the chart series.

Parameters:

lineColor - the new color of the chart series line

See Also:

getLineColor()

IsShadow

public bool IsShadow()

Deprecated.

As of version 8.3, replaced by ShadowFormat.HasShadow()

Returns the shadow setting of the chart series.

Returns:

the shadow setting of the chart series

See Also:

setShadow(bool)

setShadow

public void setShadow(bool isShadow)

Deprecated.

As of version 8.3, replaced by ShadowFormat.setShadow(int)

Sets the shadow setting of the chart series.

Parameters:

isShadow - the new value of the chart series shadow setting

See Also:

IsShadow()

getBackground

public System.Drawing.Color getBackground()

Deprecated.

As of version 8.3, replaced by FillFormat.getBackground()

Returns the chart series background color.

Returns:

the chart series background color

See Also:

setBackground(Color)

setBackground

public void setBackground(System.Drawing.Color background)

Deprecated.

As of version 8.3, replaced by FillFormat.setBackground(Color)

Sets the background color of the chart series.

Parameters:

background - the new background color of the chart series

See Also:

getBackground()

setDataLabels

public void setDataLabels(int dataLabels)

Deprecated.

As of version 8.5, replaced by setDataLabels(ExcelDataLabels)

Sets the data labels type of the chart series. Possible values are available in Chart class.

Parameters:

dataLabels - the new value of the chart series data labels

getDataLabels

public ExcelDataLabels getDataLabels()

Returns the data labels settings of the chart series.

Returns:

the data labels settings of the chart series

See Also:

setDataLabels(ExcelDataLabels)

setDataLabels

public void setDataLabels(ExcelDataLabels xlsDataLabels)

Sets the data labels settings of the chart series.
This method is overridden as setDataLabels_2 in COM+ version of EasyXLS.

Parameters:

xlsDataLabels - the data labels settings of the chart series

See Also:

getDataLabels()

ShowDataLabels

public bool ShowDataLabels()

Returns true if data labels are attached to the series, false otherwise.

Returns:

true if data labels are attached to the series, false otherwise

See Also:

setShowDataLabels(bool), getDataLabels()

setShowDataLabels

public void setShowDataLabels(bool show)

Sets the data labels visible or not visible.

Parameters:

show - true if the data labels are visible, false otherwise

See Also:

ShowDataLabels(), getDataLabels()

getShowLegendKeyNextToLabel

public bool getShowLegendKeyNextToLabel()

Deprecated.

As of version 8.5, replaced by ExcelDataLabels.getShowLegendKeyNextToLabel()

Returns a value representing the visibility of the legend key.

Returns:

the visibility of the legend key

See Also:

setShowLegendKeyNextToLabel(bool)

setShowLegendKeyNextToLabel

public void setShowLegendKeyNextToLabel(bool value)

Deprecated.

As of version 8.5, replaced by ExcelDataLabels.setShowLegendKeyNextToLabel(bool)

Sets the visibility of the legend key next to label of the series.

Parameters:

value - the new value of the legend key visibility

See Also:

getShowLegendKeyNextToLabel()

getMarkerType

public int getMarkerType()

Returns the marker type of the chart series. Possible values are available in Chart class.

Returns:

the marker type of the chart series

See Also:

setMarkerType(int), getMarkerSize(), getMarkerFillFormat(), getMarkerLineColorFormat(), getMarkerLineStyleFormat()

setMarkerType

public void setMarkerType(int markerType)

Sets the marker type of the chart series. Possible values are available in Chart class.

Parameters:

markerType - the new marker type of the chart series

See Also:

getMarkerType(), setMarkerSize(int), getMarkerFillFormat(), getMarkerLineColorFormat(), getMarkerLineStyleFormat()

getMarkerSize

public int getMarkerSize()

Returns the marker size of the chart series.

Returns:

the marker size of the chart series

See Also:

setMarkerSize(int), getMarkerType(), getMarkerFillFormat(), getMarkerLineColorFormat(), getMarkerLineStyleFormat()

setMarkerSize

public void setMarkerSize(int markerSize)

Sets the marker size of the chart series.

Parameters:

markerSize - the marker size of the chart series

See Also:

getMarkerSize(), setMarkerType(int), getMarkerFillFormat(), getMarkerLineColorFormat(), getMarkerLineStyleFormat()

getMarkerFillFormat

public FillFormat getMarkerFillFormat()

Returns the fill formatting of the marker.

Returns:

the fill formatting of the marker

See Also:

setMarkerFillFormat(EasyXLS.Drawings.Formatting.FillFormat), getMarkerType(), getMarkerSize(), getMarkerLineColorFormat(), getMarkerLineStyleFormat()

setMarkerFillFormat

public void setMarkerFillFormat(FillFormat fillFormat)

Sets the fill formatting of the marker.

Parameters:

fillFormat - the fill formatting of the marker

See Also:

getMarkerFillFormat(), setMarkerType(int), setMarkerSize(int), getMarkerLineColorFormat(), getMarkerLineStyleFormat()

getMarkerLineColorFormat

public LineColorFormat getMarkerLineColorFormat()

Returns the line color formatting of the marker.

Returns:

the line color formatting of the marker

See Also:

setMarkerLineColorFormat(EasyXLS.Drawings.Formatting.LineColorFormat), getMarkerType(), getMarkerSize(), getMarkerFillFormat(), getMarkerLineStyleFormat()

setMarkerLineColorFormat

public void setMarkerLineColorFormat(LineColorFormat lineColorFormat)

Sets the line color formatting of the marker.

Parameters:

lineColorFormat - the line color formatting of the marker

See Also:

getMarkerLineColorFormat(), getMarkerType(), getMarkerSize(), getMarkerFillFormat(), getMarkerLineStyleFormat()

getMarkerLineStyleFormat

public LineStyleFormat getMarkerLineStyleFormat()

Returns the line style formatting of the marker.

Returns:

the line style formatting of the marker

See Also:

setMarkerLineStyleFormat(EasyXLS.Drawings.Formatting.LineStyleFormat), getMarkerType(), getMarkerSize(), getMarkerFillFormat(), getMarkerLineColorFormat()

setMarkerLineStyleFormat

public void setMarkerLineStyleFormat(LineStyleFormat lineStyleFormat)

Sets the line style formatting of the marker.

Parameters:

lineStyleFormat - the line style formatting of the marker

See Also:

setMarkerLineStyleFormat(EasyXLS.Drawings.Formatting.LineStyleFormat), setMarkerType(int), setMarkerSize(int), getMarkerFillFormat(), getMarkerLineColorFormat()

IsInvertIfNegative

public bool IsInvertIfNegative()

Returns true if the color is inverted for negative values of the chart series, false otherwise.

Returns:

true if the color is inverted for negative values of the chart series, false otherwise

See Also:

setInvertIfNegative(bool)

setInvertIfNegative

public void setInvertIfNegative(bool invertIfNegative)

Sets the "invert if negative" option for the chart series.

Parameters:

invertIfNegative - true if the color is inverted for negative values of the chart series, false otherwise

See Also:

IsInvertIfNegative()

getStackScale

public float getStackScale()

Returns the scale for the stack option.

Returns:

the scale for the stack option

See Also:

setStackScale(float)

setStackScale

public void setStackScale(float scale)

Sets the stack option and scale. If 0, no stack option is set.

Parameters:

scale - the scale

See Also:

getStackScale()

IsSmoothedLine

public bool IsSmoothedLine()

Returns true if the line is smoothed, false otherwise. Valid only for line base charts.

Returns:

true if the line is smoothed, false otherwise

See Also:

setSmoothedLine(bool)

setSmoothedLine

public void setSmoothedLine(bool isSmoothedLine)

Sets the smoothed line for line based charts.

Parameters:

isSmoothedLine - true if the line is smoothed, false otherwise

See Also:

IsSmoothedLine()

Clone

public ExcelSeries Clone()

Creates and returns a copy of this object.

Returns:

a clone of this instance.