ActiveXLS.Charts
Class ExcelSeries

System.Object
  ActiveXLS.Charts.ExcelSeries

public class ExcelSeries

extends System.Object

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

Constructor Summary

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

ExcelSeries	Clone() Creates and returns a copy of this object.
System.Drawing.Color	getBackground() Returns the chart series background color.
int	getDataLabels() Returns the chart series data label type.
System.Drawing.Color	getLineColor() Returns the line color of the chart series.
int	getLineStyle() Returns the line style of the chart series.
int	getLineWeight() Returns the line weight 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() Returns a value representing the visibility of the legend key.
System.String	getValues() Returns the values of the chart series.
bool	IsShadow() Returns the shadow setting of the chart series.
void	setBackground(System.Drawing.Color background) Sets the background color of the chart series.
void	setDataLabels(int dataLabels) Sets the data labels type of the chart series.
void	setLineColor(System.Drawing.Color lineColor) Sets the line color of the chart series.
void	setLineStyle(int lineStyle) Returns the line style of the chart series.
void	setLineWeight(int lineWeight) Sets the line weight 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) Sets the shadow setting of the chart series.
void	setShowLegendKeyNextToLabel(bool value) Sets the visibility of the legend key next to label of the series.
void	setValues(System.String seriesValues) Sets the values of the chart series.

Constructor Detail

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 Detail

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()

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)

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()

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)

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()

Returns the line color of the chart series.

Returns:

the line color of the chart series

See Also:

setLineColor(System.Drawing.Color)

setLineColor

public void setLineColor(System.Drawing.Color lineColor)

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()

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)

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()

Returns the chart series background color.

Returns:

the chart series background color

See Also:

setBackground(System.Drawing.Color)

setBackground

public void setBackground(System.Drawing.Color background)

Sets the background color of the chart series.

Parameters:

background - the new background color of the chart series

See Also:

getBackground()

getDataLabels

public int getDataLabels()

Returns the chart series data label type. Possible values are available in Chart class.

Returns:

the chart series data label color

See Also:

setDataLabels(int)

setDataLabels

public void setDataLabels(int dataLabels)

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

See Also:

getDataLabels()

getShowLegendKeyNextToLabel

public bool 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)

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)

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()

Clone

public ExcelSeries Clone()

Creates and returns a copy of this object.

Returns:

a clone of this instance.