Package com.storedobject.chart

Class VisualMap

java.lang.Object

com.storedobject.chart.VisualMap

All Implemented Interfaces:

Component, ComponentPart, ComponentProperty, HasPosition

public class VisualMap
extends Object
implements Component, HasPosition

Define features to visually highlight portions of the chart. Note: Beta version, not fully tested and the API is not yet finalized.

Author:

Syam

Constructor Summary

Constructors

Constructor	Description
VisualMap()	Constructor.
VisualMap(Chart chart)	Constructor.

Method Summary

Modifier and Type	Method	Description
void	encodeJSON(StringBuilder sb)	Encode the JSON string with the properties of this.
final Chart	getChart()	Get the chart for which this visual map is used.
long	getId()	Each part should have a unique Id.
final Number	getMax()	Get the maximum value to be used by this map.
final Number	getMin()	Get the minimum value to be used by this map.
final Position	getPosition(boolean create)	Get the position of this on the chart display area.
int	getSerial()	Get the current serial number (Serial number used internal purposes only).
final boolean	isCalculable()	Is the values calculable?
final boolean	isContinuous()	Is the rendering continuous?
boolean	isVertical()	Is the orientation vertical?
void	setCalculable(boolean calculable)	Set that the value is calculable or not.
void	setChart(Chart chart)	Set the chart for which this visual map is used.
void	setContinuous(boolean continuous)	Set the rendering continuous.
void	setMax(Number max)	Set the maximum value to be used by this map when rendering.
void	setMin(Number min)	Set the minimum value to be used by this map when rendering.
void	setPosition(Position position)	Set the position of this.
void	setSerial(int serial)	Set a serial number (Serial number used internal purposes only).
void	setVertical(boolean vertical)	Set vertical orientation for the visual map.
void	validate()	This method is invoked by SOChart to check if the component or part is valid or not.

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.storedobject.chart.Component

addParts, getEvents

Methods inherited from interface com.storedobject.chart.ComponentPart

className, getName, getRenderingIndex, setName, setRenderingIndex

Constructor Details

VisualMap

public VisualMap()

Constructor.

VisualMap

public VisualMap(Chart chart)

Constructor.

Parameters:

chart - Chart for which this map will be used.

Method Details

getId

public long getId()

Description copied from interface: ComponentPart

Each part should have a unique Id. (It can be a final variable and can be set by calling ID.newID().

Specified by:

getId in interface ComponentPart

Returns:

Unique Id.

setSerial

public void setSerial(int serial)

Description copied from interface: ComponentPart

Set a serial number (Serial number used internal purposes only). The implementation of this method must be in such a way that the serial number set here must be returned by the ComponentPart.getSerial() method.

Specified by:

setSerial in interface ComponentPart

Parameters:

serial - Serial number to set.

getSerial

public int getSerial()

Description copied from interface: ComponentPart

Get the current serial number (Serial number used internal purposes only). The serial number set by the ComponentPart.setSerial(int) method should be returned by this method.

Specified by:

getSerial in interface ComponentPart

Returns:

Current serial number.

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.

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

Parameters:

sb - Encoded JSON string to be appended to this.

isContinuous

public final boolean isContinuous()

Is the rendering continuous?

Returns:

True/false.

setContinuous

public void setContinuous(boolean continuous)

Set the rendering continuous. (By default, it is continuous).

Parameters:

continuous - True/false.

isCalculable

public final boolean isCalculable()

Is the values calculable?

Returns:

True/false.

setCalculable

public void setCalculable(boolean calculable)

Set that the value is calculable or not.

Parameters:

calculable - True/false.

getChart

public final Chart getChart()

Get the chart for which this visual map is used. (It could be null and in that case, it will be used for all the charts).

Returns:

Chart.

setChart

public void setChart(Chart chart)

Set the chart for which this visual map is used. (If it is null, it will be used for all the charts).

Parameters:

chart - Chart.

isVertical

public boolean isVertical()

Is the orientation vertical?

Returns:

True/false.

setVertical

public void setVertical(boolean vertical)

Set vertical orientation for the visual map. (By default, it is horizontal).

Parameters:

vertical - True/false.

getPosition

public final Position getPosition(boolean create)

Description copied from interface: HasPosition

Get the position of this on the chart display area. (If true is passed as the parameter, a new position will be created if not already exists).

Specified by:

getPosition in interface HasPosition

Parameters:

create - Whether to create it or not.

Returns:

Position.

setPosition

public void setPosition(Position position)

Description copied from interface: HasPosition

Set the position of this.

Specified by:

setPosition in interface HasPosition

Parameters:

position - Position to set.

getMin

public final Number getMin()

Get the minimum value to be used by this map.

Note: This will return whatever value set via setMin(Number). If not set, it will try to determine this value from the associated chart if possible when rendering occurs.

Returns:

Minimum value.

setMin

public void setMin(Number min)

Set the minimum value to be used by this map when rendering. If a non-null value is set via this method, it will be used while rendering and no attempt is made to determine it from the associated chart if any.

Parameters:

min - Value to set.

getMax

public final Number getMax()

Get the maximum value to be used by this map.

Note: This will return whatever value set via setMax(Number). If not set, it will try to determine this value from the associated chart if possible when rendering occurs.

Returns:

Maximum value.

setMax

public void setMax(Number max)

Set the maximum value to be used by this map when rendering. If a non-null value is set via this method, it will be used while rendering and no attempt is made to determine it from the associated chart if any.

Parameters:

max - Value to set.