Package com.storedobject.chart

Class HeatmapChart

java.lang.Object

com.storedobject.chart.AbstractPart

com.storedobject.chart.Chart

com.storedobject.chart.HeatmapChart

All Implemented Interfaces:

Component, ComponentPart, ComponentProperty, HasAnimation, HasData, HasEmphasis

public class HeatmapChart
extends Chart

Heatmap chart. A heatmap chart is plotted on a RectangularCoordinate system.

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
HeatmapChart(CategoryData xData, CategoryData yData)	Constructor.

Method Summary

Modifier and Type	Method	Description
void	addData(int xIndex, int yIndex, Number value)	Add heatmap data point.
void	addData(int xIndex, String yValue, Number value)	Add heatmap data point.
void	addData(String xValue, int yIndex, Number value)	Add heatmap data point.
void	addData(String xValue, String yValue, Number value)	Add heatmap 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.
final VisualMap	getVisualMap()	Get the VisualMap associated with this chart.
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, encodeJSON, 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

HeatmapChart

public HeatmapChart(CategoryData xData,
 CategoryData yData)

Constructor.

Parameters:

xData - Labels on the X-axis.

yData - Labels on the 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.

addData

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

Add heatmap 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 heatmap 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 heatmap 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 heatmap 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.