com.github.miachm.sods

Class ChartSeries

java.lang.Object

com.github.miachm.sods.ChartSeries

public class ChartSeries
extends Object

Represents a series within a Chart. A series is a single dataset plotted in the chart. It can be defined by explicit values/labels or by range addresses that point to sheet cells.

Constructor Summary

Constructors

Constructor and Description
ChartSeries()

Method Summary

Modifier and Type	Method and Description
void	addLabel(Object label) Adds a label to the series.
void	addValue(Object value) Adds a value to the series.
String	getLabelRangeAddress() Returns the A1 range address for labels.
List<Object>	getLabels() Returns the series labels.
ChartStyle	getStyle() Returns the series style.
List<Object>	getValues() Returns the series values.
String	getValuesRangeAddress() Returns the A1 range address for values.
Range	getValuesRangeObject() Resolves the values range address into a Range.
void	setLabelRangeAddress(String labelRangeAddress) Sets the A1 range address for labels.
void	setStyle(ChartStyle style) Sets the series style.
void	setValuesRangeAddress(String valuesRangeAddress) Sets the A1 range address for values.

Methods inherited from class java.lang.Object

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

Constructor Detail

ChartSeries

public ChartSeries()

Method Detail

getValuesRangeAddress

public String getValuesRangeAddress()

Returns the A1 range address for values. This address points to the cells that provide the numeric values for the series.

Returns:

The values range address.

getLabelRangeAddress

public String getLabelRangeAddress()

Returns the A1 range address for labels. This address points to the cells that provide labels for the series.

Returns:

The label range address.

getValues

public List<Object> getValues()

Returns the series values. This list represents the values explicitly associated with the series, which may be used when no range address is provided.

Returns:

An unmodifiable list of values.

getLabels

public List<Object> getLabels()

Returns the series labels. This list represents the labels explicitly associated with the series, which may be used when no range address is provided.

Returns:

An unmodifiable list of labels.

getStyle

public ChartStyle getStyle()

Returns the series style. The style controls how this series is rendered (colors, markers, text). It's safe to manipulate the returned style since it is a copy. Call setStyle(ChartStyle) to apply changes.

Returns:

A copy of the series style.

setStyle

public void setStyle(ChartStyle style)

Sets the series style. The provided style is copied, so subsequent changes to the input object do not affect the series.

Parameters:

style - The series style.

getValuesRangeObject

public Range getValuesRangeObject()

Resolves the values range address into a Range. This is a convenience method that uses the parent chart's sheet to resolve the range.

Returns:

The values range, or null if it cannot be resolved.

setValuesRangeAddress

public void setValuesRangeAddress(String valuesRangeAddress)

Sets the A1 range address for values. The address should reference the cells that contain the series values.

Parameters:

valuesRangeAddress - The values range address.

setLabelRangeAddress

public void setLabelRangeAddress(String labelRangeAddress)

Sets the A1 range address for labels. The address should reference the cells that contain series labels.

Parameters:

labelRangeAddress - The label range address.

addValue

public void addValue(Object value)

Adds a value to the series. Values added here are used when no values range is provided.

Parameters:

value - The value to add.

addLabel

public void addLabel(Object label)

Adds a label to the series. Labels added here are used when no label range is provided.

Parameters:

label - The label to add.