Package com.storedobject.chart

Class Chart

java.lang.Object

com.storedobject.chart.AbstractPart

com.storedobject.chart.Chart

All Implemented Interfaces:

Component, ComponentPart, ComponentProperty, HasAnimation, HasData, HasEmphasis

Direct Known Subclasses:

AbstractChart, RadarChart, SelfPositioningSpecialChart, SunburstChart, XYDataChart

public class Chart
extends AbstractPart
implements Component, HasData, HasAnimation, HasEmphasis

Chart. Since this is a concrete class, this may be directly used for creating a chart of a particular ChartType. It has got the flexibility that the ChartType can be changed at any time using setType(ChartType) method. However, there are concrete derivatives of this class such as PieChart, NightingaleRoseChart etc. where more chart-specific methods are available and data for the chart is checked more accurately for errors. If the data set for the chart is of invalid type, a system tries to do its best to adapt that data, but the chart may not appear if the data conversion fails.

Custom Charts: Any chart may be converted to a custom chart by setting up an item renderer to render the data point. The item renderer can be specified via setCustomRenderer(String). However, please note that only a few custom renderers are currently available.

Positioning of charts within the display area of SOChart: Most charts need a CoordinateSystem to plot on and all CoordinateSystems support positioning (Please see CoordinateSystem.setPosition(Position)). Those which do not require a CoordinateSystem are called SelfPositioningChart and supports its own positioning mechanism (Please see SelfPositioningChart.setPosition(Position)).

Author:

Syam

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	Chart.Emphasis	Class to represent the Emphasis effect.
static class	Chart.Label	Value-label that can be customized for a chart.
static class	Chart.LabelPosition	Position indicator for labels used in charts.

Constructor Summary

Constructors

Constructor	Description
Chart()	Create a ChartType.Line chart.
Chart(AbstractDataProvider<?>... data)	Create a ChartType.Line chart with the given data.
Chart(ChartType type, AbstractDataProvider<?>... data)	Create a chart of a given type and data.

Method Summary

Modifier and Type	Method	Description
void	addParts(SOChart soChart)	Add parts of this component to the chart.
protected AbstractDataProvider<?>	dataToEmbed()	Get the data to embed.
protected AbstractDataProvider<?>	dataValue()	Get the data that represents the values of this chart.
protected int	dataValueIndex()	Get the index to get the real data value of this chart.
void	declareData(Set<AbstractDataProvider<?>> dataSet)	Declare the data set owned by this ComponentPart by adding it to the Set provided.
void	encodeJSON(StringBuilder sb)	Encode the JSON string with the properties of this.
Animation	getAnimation(boolean create)	Get the instance of this property.
CoordinateSystem	getCoordinateSystem()	Get the coordinate system of this chart.
final AbstractDataProvider<?>[]	getData()	Get the current set of data.
Chart.Emphasis	getEmphasis(boolean create)	Get the Emphasis effect of the chart.
final ItemStyle	getItemStyle(boolean create)	Get item style.
final Chart.Label	getLabel(boolean create)	Get the label for this chart value.
protected String	getLabelName()	Get the label name for encoding label if exists.
MarkArea	getMarkArea(boolean create)	Get the mark area for the chart.
Object	getMax()	Get the minimum value for this chart.
Object	getMin()	Get the minimum value for this chart.
String	getName()	Set the name of the chart.
Tooltip	getTooltip(boolean create)	Get the tooltip.
ChartType	getType()	Get the type of this chart.
protected AbstractDataProvider<?>	mainData()	Get the main data to be used for rendering.
Chart	plotOn(Axis... axes)	Plot the chart on a given set of axes.
Chart	plotOn(CoordinateSystem coordinateSystem, Axis... axes)	Plot the chart on a given coordinate system.
void	setAnimation(Animation animation)	Set it to this instance.
void	setColors(AbstractColor... colors)	Set colors for the charts.
void	setCustomRenderer(String renderer)	Set a custom renderer for this chart.
void	setData(AbstractDataProvider<?>... data)	Set data for the chart.
void	setEmphasis(Emphasis emphasis)	Set an Emphasis effect to this chart.
void	setItemStyle(ItemStyle itemStyle)	Set item style.
void	setLabel(Chart.Label label)	Set the label for this chart value.
void	setMarkArea(MarkArea markArea)	Set a customized MarkArea for this chart.
void	setName(String name)	Set the name for this chart.
void	setTooltip(Tooltip tooltip)	Set the tooltip.
void	setType(ChartType type)	Set the type of this chart.
protected String	typeValue()	Get the type-value of the chart.
void	validate()	This method is invoked by SOChart to check if the component or part is valid or not.

Methods inherited from class com.storedobject.chart.AbstractPart

equals, getId, getLabelTag, getSerial, getZ, hashCode, hasId, setSerial, setZ

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.storedobject.chart.ComponentPart

className, getId, getRenderingIndex, getSerial, setRenderingIndex, setSerial

Constructor Details

Chart

public Chart()

Create a ChartType.Line chart.

Chart

public Chart(AbstractDataProvider<?>... data)

Create a ChartType.Line chart with the given data.

Parameters:

data - Data to be used (multiples of them for charts that use multi-axis coordinate systems).

Chart

public Chart(ChartType type,
 AbstractDataProvider<?>... data)

Create a chart of a given type and data.

Parameters:

type - type of the chart.

data - Data to be used (multiples of them for charts that use multi-axis coordinate systems).

Method Details

setData

public void setData(AbstractDataProvider<?>... data)

Set data for the chart.

Parameters:

data - Data to be used (multiples of them for charts that use multi-axis coordinate systems).

getData

public final AbstractDataProvider<?>[] getData()

Get the current set of data.

Returns:

Data.

setCustomRenderer

public void setCustomRenderer(String renderer)

Set a custom renderer for this chart. Each renderer can be used on a certain type of charts only, may require special data requirements, and you may have to encode the rendering values. The following are the currently supported renderers:

 (1) "HBand": Horizontal bands. Applicable to XY charts.
 Data Point: [y-value, start, end, color], encode { x: 1, y: 0 }
 (2) "VLine": Single vertical line at a given value. Applicable to XY charts.
 Single Data Point: [line at (x-value), text label, color], encode { x: 0, y: -1 }
 (3) "HBar": Horizontal bars. Applicable yo XY charts.
 Data Point: [y-value, label, start, end, %age completed, bar color]
 (4) "VAxisLabel": Label bars for the vertical axis.
 Data Point: [y-value, group label, connected, label, sub-label, bar color], encode { x: -1, y: 0 }
 

Parameters:

renderer - Name of the renderer.

typeValue

protected String typeValue()

Get the type-value of the chart. (Example, type-value of the LineChart is "line"). You must override this and return the correct chart-type if you are creating your own chart-type that is not yet supported by this add-on.

Returns:

Chart-type value.

dataToEmbed

protected AbstractDataProvider<?> dataToEmbed()

Get the data to embed. This is useful only for those special charts that embed data in the chart itself rather than pointing to the dataset. Example: TreeChart, GaugeChart etc. If null is returned from this method, no data will be embedded.

Returns:

Data to embed.

dataValue

protected AbstractDataProvider<?> dataValue()

Get the data that represents the values of this chart. This is useful only for those special charts that embed data in the chart itself rather than pointing to the dataset. Example: TreeChart, GaugeChart etc. The default implementation returns the result of dataToEmbed() if it is not null. Otherwise, it tries to determine it from the axis data if possible.

Returns:

Data that represents value.

mainData

protected AbstractDataProvider<?> mainData()

Get the main data to be used for rendering.

Note: This is internally used to find out which one of the data set is used by the data-encoder while rendering the chart.

In most case, this will be determined automatically.

Returns:

Data that represents the main data of the chart.

dataValueIndex

protected int dataValueIndex()

Get the index to get the real data value of this chart. (In special charts, the actual data value at a data point may be at an index different from 0).

Returns:

Data value index.

encodeJSON

public void encodeJSON(StringBuilder sb)

Description copied from interface: ComponentProperty

Encode the JSON string with the properties of this.

Specified by:

encodeJSON in interface ComponentProperty

Overrides:

encodeJSON in class AbstractPart

Parameters:

sb - Encoded JSON string to be appended to this.

getLabelName

protected String getLabelName()

Get the label name for encoding label if exists.

Returns:

Label name. Default is "label".

validate

public void validate()
              throws ChartException

Description copied from interface: ComponentPart

This method is invoked by SOChart to check if the component or part is valid or not.

Specified by:

validate in interface ComponentPart

Throws:

ChartException - Raises exception if the component or part is not valid.

getCoordinateSystem

public CoordinateSystem getCoordinateSystem()

Get the coordinate system of this chart.

Note: Some charts like PieChart, RadarChart etc. do not have a coordinate system.

Returns:

Coordinate system.

addParts

public void addParts(SOChart soChart)

Description copied from interface: Component

Add parts of this component to the chart. This will be invoked if the component was already added to the chart, and it is about to be rendered.

Specified by:

addParts in interface Component

Parameters:

soChart - Chart to which components to be added.

declareData

public void declareData(Set<AbstractDataProvider<?>> dataSet)

Description copied from interface: HasData

Declare the data set owned by this ComponentPart by adding it to the Set provided.

Specified by:

declareData in interface HasData

Parameters:

dataSet - Set to which all the data owned by this ComponentPart needs to be added.

getType

public ChartType getType()

Get the type of this chart.

Returns:

Type.

setType

public void setType(ChartType type)

Set the type of this chart.

Parameters:

type - Type to be set.

plotOn

public Chart plotOn(CoordinateSystem coordinateSystem,
 Axis... axes)

Plot the chart on a given coordinate system. (Certain chart types such as ChartType.Pie, do not have a coordinate system and thus, this call is not required. Also, instead of using this method, you can use the CoordinateSystem.add(Chart...) method if you want to plot on the default set of axes.)

Parameters:

coordinateSystem - Coordinate system on which the chart will be plotted. (If it was plotted on another coordinate system, it will be removed from it).

axes - Axes to be used by the chart. This needs to be specified if the coordinate system has multiple axes of the required type.

Returns:

Self-reference.

plotOn

public Chart plotOn(Axis... axes)

Plot the chart on a given set of axes.

Parameters:

axes - Axes to be used by the chart.

Returns:

Self-reference.

getName

public String getName()

Set the name of the chart. (This will be used in displaying the legend if the legend is enabled in the SOChart or added separately).

Specified by:

getName in interface ComponentPart

Overrides:

getName in class AbstractPart

Returns:

Name.

setName

public void setName(String name)

Set the name for this chart.

Specified by:

setName in interface ComponentPart

Parameters:

name - Name.

setColors

public void setColors(AbstractColor... colors)

Set colors for the charts. Certain charts require more than one color, e.g., PieChart. (Colors are used sequentially and then, circularly).

Parameters:

colors - List of one or more colors.

getTooltip

public Tooltip getTooltip(boolean create)

Get the tooltip. (If true is passed as the parameter, a new tooltip will be created if not already exists).

Parameters:

create - Whether to create it or not.

Returns:

Tooltip.

setTooltip

public void setTooltip(Tooltip tooltip)

Set the tooltip.

Parameters:

tooltip - Tooltip.

getLabel

public final Chart.Label getLabel(boolean create)

Get the label for this chart value.

Parameters:

create - Whether to create if not exists or not.

Returns:

Label.

setLabel

public void setLabel(Chart.Label label)

Set the label for this chart value.

Parameters:

label - Label.

getMin

public Object getMin()

Get the minimum value for this chart. This is used to determine the minimum value to be used by some other components (such as VisualMap) when rendering occurs. The default implementation tries various ways to determine it automatically.

Returns:

The minimum value if it is possible to determine. Otherwise, null.

getMax

public Object getMax()

Get the minimum value for this chart. This is used to determine the minimum value to be used by some other components (such as VisualMap) when rendering occurs. The default implementation tries various ways to determine it automatically.

Returns:

The minimum value if it is possible to determine. Otherwise, null.

getItemStyle

public final ItemStyle getItemStyle(boolean create)

Get item style. (Not applicable to certain types of charts).

Parameters:

create - If passed true, a new style is created if not exists.

Returns:

Item style.

setItemStyle

public void setItemStyle(ItemStyle itemStyle)

Set item style.

Parameters:

itemStyle - Style to set.

getMarkArea

public MarkArea getMarkArea(boolean create)

Get the mark area for the chart. (Not applicable to certain types of charts).

Parameters:

create - If passed true, a new MarkArea is created if not exists.

Returns:

Mark area.

setMarkArea

public void setMarkArea(MarkArea markArea)

Set a customized MarkArea for this chart.

Parameters:

markArea - Mark the area to set.

getAnimation

public Animation getAnimation(boolean create)

Description copied from interface: HasAnimation

Get the instance of this property. (If true is passed as the parameter, a new instance will be created if not already exists).

Specified by:

getAnimation in interface HasAnimation

Parameters:

create - Whether to create it or not.

Returns:

Instance.

setAnimation

public void setAnimation(Animation animation)

Description copied from interface: HasAnimation

Set it to this instance.

Specified by:

setAnimation in interface HasAnimation

Parameters:

animation - Instance to set.

getEmphasis

public Chart.Emphasis getEmphasis(boolean create)

Get the Emphasis effect of the chart.

Specified by:

getEmphasis in interface HasEmphasis

Parameters:

create - If passed true, a new Chart.Emphasis effect is created if not exists.

Returns:

Emphasis.

setEmphasis

public void setEmphasis(Emphasis emphasis)

Set an Emphasis effect to this chart.

Specified by:

setEmphasis in interface HasEmphasis

Parameters:

emphasis - Emphasis effect to set.