Package com.storedobject.chart

Class BubbleChart

java.lang.Object

com.storedobject.chart.AbstractPart

com.storedobject.chart.Chart

com.storedobject.chart.BubbleChart

All Implemented Interfaces:

Component, ComponentPart, ComponentProperty, HasAnimation, HasData, HasEmphasis

public class BubbleChart
extends Chart

Bubble chart. A bubble chart is plotted on a RectangularCoordinate system and at each (x, y) point, there can be an associated "value". A "bubble" is drawn for each such data point and size of the "bubble" is proportional to the value. However, the size of the "bubble" can be controlled by setting a "multiplication factor" via setBubbleSize(double).

Internally, the "bubble" is an instance of the PointSymbol but, it may not be directly customized unless necessary.

A VisualMap is automatically created unless you set it explicitly to null via setVisualMap(VisualMap).

Author:

Syam

Nested Class Summary

Nested classes/interfaces inherited from class com.storedobject.chart.Chart

Chart.Emphasis, Chart.Label, Chart.LabelPosition

Constructor Summary

Constructors

Constructor	Description
BubbleChart(AbstractDataProvider<?> xData, AbstractDataProvider<?> yData)	Constructor.

Method Summary

Modifier and Type	Method	Description
void	addData(int xIndex, int yIndex, Number value)	Add bubble data point.
void	addData(int xIndex, String yValue, Number value)	Add bubble data point.
void	addData(String xValue, int yIndex, Number value)	Add bubble data point.
void	addData(String xValue, String yValue, Number value)	Add bubble data point.
void	addParts(SOChart soChart)	Add parts of this component to the chart.
protected AbstractDataProvider<?>	dataToEmbed()	Get the data to embed.
protected int	dataValueIndex()	Get the index to get the real data value of this chart.
void	encodeJSON(StringBuilder sb)	Encode the JSON string with the properties of this.
PointSymbol	getPointSymbol(boolean create)	Get the PointSymbol that represents the "bubble".
final VisualMap	getVisualMap()	Get the VisualMap associated with this chart.
void	setBubbleSize(double multiplicationFactor)	Set the bubble size.
void	setPointSymbol(PointSymbol pointSymbol)	Set a different point-symbol that represents the "bubble".
void	setValuePrefix(String valuePrefix)	Set a prefix text to the value when tooltip is displayed for the bubble.
void	setValueSuffix(String valueSuffix)	Set a suffix text to the value when tooltip is displayed for the bubble.
void	setVisualMap(VisualMap visualMap)	Set a VisualMap for this 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.Chart

addEvent, dataValue, declareData, getAnimation, getCoordinateSystem, getData, getEmphasis, getEvents, getItemStyle, getLabel, getLabelName, getMarkArea, getMax, getMin, getName, getTooltip, getType, plotOn, plotOn, setAnimation, setColors, setCustomRenderer, setData, setEmphasis, setItemStyle, setLabel, setMarkArea, setName, setTooltip, setType, typeValue

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

BubbleChart

public BubbleChart(AbstractDataProvider<?> xData,
 AbstractDataProvider<?> yData)

Constructor.

Parameters:

xData - Data for X axis.

yData - Data for Y axis.

Method Details

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

Overrides:

validate in class Chart

Throws:

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

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 Chart

Parameters:

sb - Encoded JSON string to be appended to this.

addData

public void addData(int xIndex,
 int yIndex,
 Number value)

Add bubble data point.

Parameters:

xIndex - X-index at which data needs to added.

yIndex - Y-index at which data needs to added.

value - Value to be added.

addData

public void addData(String xValue,
 int yIndex,
 Number value)

Add bubble data point.

Parameters:

xValue - X-value at which data needs to added.

yIndex - Y-index at which data needs to added.

value - Value to be added.

addData

public void addData(int xIndex,
 String yValue,
 Number value)

Add bubble data point.

Parameters:

xIndex - X-index at which data needs to added.

yValue - Y-value at which data needs to added.

value - Value to be added.

addData

public void addData(String xValue,
 String yValue,
 Number value)

Add bubble data point.

Parameters:

xValue - X-value at which data needs to added.

yValue - Y-value at which data needs to added.

value - Value to be added.

dataToEmbed

protected AbstractDataProvider<?> dataToEmbed()

Description copied from class: Chart

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.

Overrides:

dataToEmbed in class Chart

Returns:

Data to embed.

dataValueIndex

protected int dataValueIndex()

Description copied from class: Chart

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

Overrides:

dataValueIndex in class Chart

Returns:

Data value index.

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

Overrides:

addParts in class Chart

Parameters:

soChart - Chart to which components to be added.

getVisualMap

public final VisualMap getVisualMap()

Get the VisualMap associated with this chart.

Returns:

The VisualMap instance.

setVisualMap

public void setVisualMap(VisualMap visualMap)

Set a VisualMap for this chart. Set null if you don't want any VisualMap.

Parameters:

visualMap - VisualMap to set.

setBubbleSize

public void setBubbleSize(double multiplicationFactor)

Set the bubble size.

Parameters:

multiplicationFactor - Value at each data point will be multiplied by this factor to determine the size of the bubble.

setValuePrefix

public void setValuePrefix(String valuePrefix)

Set a prefix text to the value when tooltip is displayed for the bubble.

Parameters:

valuePrefix - Prefix text.

setValueSuffix

public void setValueSuffix(String valueSuffix)

Set a suffix text to the value when tooltip is displayed for the bubble.

Parameters:

valueSuffix - Suffix text.

getPointSymbol

public PointSymbol getPointSymbol(boolean create)

Get the PointSymbol that represents the "bubble".

Parameters:

create - Whether to create it if not exists or not.

Returns:

The instance of the current PointSymbol or newly created instance if requested.

setPointSymbol

public void setPointSymbol(PointSymbol pointSymbol)

Set a different point-symbol that represents the "bubble". If set via this method, "bubble size" will no more be controlled automatically unless set it again via the setBubbleSize(double) method.

Parameters:

pointSymbol - An instance of the PointSymbol.