Package com.storedobject.svg.chart

Class Chart<C extends Chart<C>>

java.lang.Object

com.storedobject.svg.Node<C>

com.storedobject.svg.chart.Chart<C>

Type Parameters:

C - Type of the chart itself.

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

Bars, LinePlot, Pie, VerticalBars

public abstract class Chart<C extends Chart<C>>
extends Node<C>

Base class for all SVG charts.

Author:

Syam

See Also:

• Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
protected String	svg	SVG representation of the chart.
protected final Values	values	Data values of the chart.

Fields inherited from class com.storedobject.svg.Node

NUMERIC_PRECISION, x1, x2, y1, y2

Constructor Summary

Constructors

Constructor	Description
Chart(Values values)	Constructor.

Method Summary

Modifier and Type	Method	Description
Values.Value	addValue(Values.Value value)	Add a data value.
Values.Value	addValue(Object label, double value)	Add a data value with a label.
protected void	build()	Build the chart.
void	colorize()	Automatically assign colors to data points.
protected final void	compute()	This method is invoked to perform any necessary computations just before the SVG content is generated.
protected String	extraContent()	Provides additional content specific to the node.
Values	getValues()	Get the data values.
final boolean	isBuilt()	Check if the chart is built.
void	setLabelName(String labelName)	Set the label name (typically used as X-axis name).
void	setUnit(String unit)	Set the unit for values.
void	setValueName(String valueName)	Set the value name (typically used as Y-axis name).
protected String	tag()	Charts do not have a specific tag.

Methods inherited from class com.storedobject.svg.Node

attributes, copy, createDocument, equals, escapeXml, flipHorizontally, flipHorizontallyAroundOrigin, flipVertically, flipVerticallyAroundOrigin, getCoordinates, getId, getMargin, getSvg, hashCode, id, ID, IDValue, innerContent, moveTo, moveTo, rotate, rotateAround, rotateAround, rotateAroundCenter, scale, scale, scaleHeightTo, scaleTo, scaleWidthTo, styles, toString, toString, transform, translate, translate

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Details

values

protected final Values values

Data values of the chart.

svg

protected String svg

SVG representation of the chart.

Constructor Details

Chart

public Chart(Values values)

Constructor.

Parameters:

values - The data values to be plotted.

Method Details

getValues

public Values getValues()

Get the data values.

Returns:

The Values object.

addValue

public Values.Value addValue(Values.Value value)

Add a data value.

Parameters:

value - The value to add.

Returns:

The added value object for convenience. However, it could be different from the input value if it needs to be modified to adjust its properties.

addValue

public Values.Value addValue(Object label,
 double value)

Add a data value with a label.

Parameters:

label - The label for the value.

value - The value.

Returns:

The added value object for convenience.

setLabelName

public void setLabelName(String labelName)

Set the label name (typically used as X-axis name).

Parameters:

labelName - Label name.

setValueName

public void setValueName(String valueName)

Set the value name (typically used as Y-axis name).

Parameters:

valueName - Value name.

setUnit

public void setUnit(String unit)

Set the unit for values.

Parameters:

unit - Unit to be set.

colorize

public void colorize()

Automatically assign colors to data points.

tag

protected String tag()

Charts do not have a specific tag.

Overrides:

tag in class Node<C extends Chart<C>>

Returns:

Null.

extraContent

protected String extraContent()

Description copied from class: Node

Provides additional content specific to the node. This method is intended to be overridden by subclasses to define custom extra content specific to their implementation. By default, it returns null if no additional content is defined.

Note: The extra content should be formatted as per SVG standards with appropriate tags. No validation is performed on the extra content.

Overrides:

extraContent in class Node<C extends Chart<C>>

Returns:

A string representing the extra content of the node, or null if no extra content is defined.

compute

protected final void compute()

Description copied from class: Node

This method is invoked to perform any necessary computations just before the SVG content is generated.

Note: At least coordinates values should be set here properly.

Overrides:

compute in class Node<C extends Chart<C>>

build

protected void build()

Build the chart. This method is called from the compute() method before getting the SVG output. It ensures the underlying Values are also built.

isBuilt

public final boolean isBuilt()

Check if the chart is built.

Returns:

True if built.