Package com.storedobject.chart

Class RadarCoordinate

java.lang.Object

com.storedobject.chart.AbstractPart

com.storedobject.chart.VisiblePart

com.storedobject.chart.CoordinateSystem

com.storedobject.chart.RadarCoordinate

All Implemented Interfaces:

Component, ComponentPart, ComponentProperty, HasData, HasPolarProperty, HasPosition, VisibleProperty

public class RadarCoordinate
extends CoordinateSystem
implements HasPolarProperty

Radar coordinate is used by RadarChart. Each of its leg (radial axis) can be labelled (indicators) by CategoryData.

Author:

Syam

Constructor Summary

Constructors

Constructor	Description
RadarCoordinate()	Constructor.
RadarCoordinate(CategoryDataProvider axisIndicators)	Construct with the given set of axis indicators.
RadarCoordinate(RadarAxis axis)	Constructor.
RadarCoordinate(RadarAxis axis, CategoryDataProvider axisIndicators)	Construct with the given set of axis indicators.

Method Summary

Modifier and Type	Method	Description
void	addAxis(Axis... axes)	Add axes.
void	encodeJSON(StringBuilder sb)	Encode the JSON string with the properties of this.
RadarAxis	getAxis()
CategoryDataProvider	getAxisIndicators()	Get the current axis indicators.
final AbstractColor	getColor()	Get the color of the indicator.
final PolarProperty	getPolarProperty(boolean create)	Get the polar property.
int	getStartingAngle()	Get the starting angle.
final boolean	isCircular()	Is the shape circular?
void	setAxis(RadarAxis axis)
void	setAxisIndicators(CategoryDataProvider axisIndicators)	Set axis indicators.
void	setCircular(boolean circular)	Set the shape as circular.
void	setColor(AbstractColor color)	Set color of the indicator.
final void	setPolarProperty(PolarProperty polarProperty)	Set the polar property.
void	setStartingAngle(int startingAngle)	Set the starting angle.
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.CoordinateSystem

add, addParts, declareData, getAxis, getPosition, remove, removeAxis, setPosition

Methods inherited from class com.storedobject.chart.VisiblePart

isVisible, setVisible

Methods inherited from class com.storedobject.chart.AbstractPart

equals, getId, getLabelTag, getName, 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, getName, getRenderingIndex, getSerial, setName, setRenderingIndex, setSerial

Methods inherited from interface com.storedobject.chart.HasPolarProperty

setHoleRadius, setRadius

Methods inherited from interface com.storedobject.chart.VisibleProperty

hide, show

Constructor Details

RadarCoordinate

public RadarCoordinate()

Constructor. Axis indicators can be set later. A default RadarAxis will be created.

RadarCoordinate

public RadarCoordinate(CategoryDataProvider axisIndicators)

Construct with the given set of axis indicators. A default RadarAxis will be created.

Parameters:

axisIndicators - Axis indicators to set.

RadarCoordinate

public RadarCoordinate(RadarAxis axis)

Constructor. Axis indicators can be set later.

Parameters:

axis - Radar axis.

RadarCoordinate

public RadarCoordinate(RadarAxis axis,
 CategoryDataProvider axisIndicators)

Construct with the given set of axis indicators.

Parameters:

axis - Radar axis.

axisIndicators - Axis indicators to set.

Method Details

addAxis

public void addAxis(Axis... axes)

Description copied from class: CoordinateSystem

Add axes.

Overrides:

addAxis in class CoordinateSystem

Parameters:

axes - Axes to add.

setAxis

public void setAxis(RadarAxis axis)

getAxis

public RadarAxis getAxis()

setAxisIndicators

public void setAxisIndicators(CategoryDataProvider axisIndicators)

Set axis indicators.

Parameters:

axisIndicators - Axis indicators to set.

getAxisIndicators

public CategoryDataProvider getAxisIndicators()

Get the current axis indicators.

Returns:

Axis indicators.

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 CoordinateSystem

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 AbstractPart

Parameters:

sb - Encoded JSON string to be appended to this.

getPolarProperty

public final PolarProperty getPolarProperty(boolean create)

Description copied from interface: HasPolarProperty

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

Specified by:

getPolarProperty in interface HasPolarProperty

Parameters:

create - Whether to create it or not.

Returns:

Polar property.

setPolarProperty

public final void setPolarProperty(PolarProperty polarProperty)

Description copied from interface: HasPolarProperty

Set the polar property.

Specified by:

setPolarProperty in interface HasPolarProperty

Parameters:

polarProperty - Polar property to set. It could be null.

getStartingAngle

public int getStartingAngle()

Get the starting angle.

Returns:

Angle in degrees.

setStartingAngle

public void setStartingAngle(int startingAngle)

Set the starting angle.

Parameters:

startingAngle - Angle in degrees.

getColor

public final AbstractColor getColor()

Get the color of the indicator.

Returns:

Color.

setColor

public void setColor(AbstractColor color)

Set color of the indicator.

Parameters:

color - Color.

setCircular

public void setCircular(boolean circular)

Set the shape as circular.

Parameters:

circular - True/false.

isCircular

public final boolean isCircular()

Is the shape circular?

Returns:

True/false.