com.klg.jclass.chart
Class JCPolarRadarChartFormat

java.lang.Object
  |
  +--com.klg.jclass.chart.JCPolarRadarChartFormat

All Implemented Interfaces:

JCChartTypeFormat, Serializable

public class JCPolarRadarChartFormat

extends Object

implements JCChartTypeFormat, Serializable

An object that manages chart properties specific to POLAR, RADAR, or AREA_RADAR charts.

See Also:

Serialized Form

Field Summary

protected com.klg.jclass.chart.Changeable

parent

Constructor Summary

JCPolarRadarChartFormat()

JCPolarRadarChartFormat(com.klg.jclass.chart.Changeable p)

Method Summary

protected int	getCurrentAngleUnit()
double	getOriginBase() Gets the angle of the theta axis origin.
double	getOriginBase(int units) Gets the angle of the theta axis origin.
protected com.klg.jclass.chart.JCAxis	getThetaAxis()
protected com.klg.jclass.chart.JCAxis	getYAxis()
double	getYAxisAngle() Gets the angle of the y axis in a Polar or Radar chart.
double	getYAxisAngle(int units) Gets the angle of the y axis in a Polar or Radar chart.
boolean	isHalfRange() Gets the half range flag for Polar charts.
boolean	isRadarCircularGrid() Gets the state of the circular flag for Radar chart gridlines.
void	setHalfRange(boolean fHalfRange) Sets the half range flag for Polar charts.
void	setOriginBase(double angle) Sets the angle of the theta axis origin.
void	setOriginBase(int units, double angle) Sets the angle of the theta axis origin.
void	setParent(com.klg.jclass.chart.ChartDataView cdv)
void	setRadarCircularGrid(boolean fCircular) Makes the y gridlines of a Radar chart circular.
void	setYAxisAngle(double angle) Sets the angle of the y axis in a Polar or Radar chart.
void	setYAxisAngle(int units, double angle) Sets the angle of the y axis in a Polar or Radar chart.

Methods inherited from class java.lang.Object

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

Field Detail

parent

protected com.klg.jclass.chart.Changeable parent

Constructor Detail

JCPolarRadarChartFormat

public JCPolarRadarChartFormat()

JCPolarRadarChartFormat

public JCPolarRadarChartFormat(com.klg.jclass.chart.Changeable p)

Method Detail

setParent

public void setParent(com.klg.jclass.chart.ChartDataView cdv)

Specified by:

setParent in interface JCChartTypeFormat

getYAxis

protected com.klg.jclass.chart.JCAxis getYAxis()

getThetaAxis

protected com.klg.jclass.chart.JCAxis getThetaAxis()

getCurrentAngleUnit

protected int getCurrentAngleUnit()

setYAxisAngle

public void setYAxisAngle(double angle)

Sets the angle of the y axis in a Polar or Radar chart. Angles are relative to the current origin base. The angle units are assumed to be the current value of the chart area's angleUnit property.

Parameters:

angle - the desired angle for the y axis

setYAxisAngle

public void setYAxisAngle(int units,
                          double angle)

Sets the angle of the y axis in a Polar or Radar chart. Angles are relative to the current origin base.

Parameters:

units - The units of the specified angle. Valid values are JCChartUtil.DEGREES, JCChartUtil.GRADS, or JCChartUtil.RADIANS.

angle - the desired angle for the y axis

getYAxisAngle

public double getYAxisAngle()

Gets the angle of the y axis in a Polar or Radar chart. Angles are relative to the current origin base. The angle units are assumed to be the current value of the chart area's angleUnit property.

Returns:

the current y axis angle of a Polar or Radar chart

getYAxisAngle

public double getYAxisAngle(int units)

Gets the angle of the y axis in a Polar or Radar chart. Angles are relative to the current origin base.

Parameters:

units - The desired units of the returned angle. Valid values are JCChartUtil.DEGREES, JCChartUtil.GRADS, or JCChartUtil.RADIANS.

Returns:

The current y axis angle of a Polar or Radar chart based on the units specified. On error, returns the default value of 0.0.

setOriginBase

public void setOriginBase(double angle)

Sets the angle of the theta axis origin. Angles are based on zero degrees pointing east (the normal rectangular x axis direction) with positive angles going counter-clockwise. The angle units are assumed to be the current value of the chart area's angleUnit property.

Parameters:

angle - the desired angle for the theta axis origin

setOriginBase

public void setOriginBase(int units,
                          double angle)

Sets the angle of the theta axis origin. Angles are based on zero degrees pointing east (the normal rectangular x axis direction) with positive angles going counter-clockwise.

Parameters:

units - The units of the specified angle. Valid values are JCChartUtil.DEGREES, JCChartUtil.GRADS, or JCChartUtil.RADIANS.

angle - the desired angle for the theta axis origin

getOriginBase

public double getOriginBase()

Gets the angle of the theta axis origin. Angles are based on zero degrees pointing east (the normal rectangular x axis direction) with positive angles going counter-clockwise. The angle units are assumed to be the current value of the chart area's angleUnit property.

Returns:

the current theta axis origin

getOriginBase

public double getOriginBase(int units)

Gets the angle of the theta axis origin. Angles are based on zero degrees pointing east (the normal rectangular x axis direction) with positive angles going counter-clockwise.

Parameters:

units - The desired units of the returned angle. Valid values are JCChartUtil.DEGREES, JCChartUtil.GRADS, or JCChartUtil.RADIANS.

Returns:

The current theta axis origin based on the angle units specified. On error, returns the default value of 0.0.

setHalfRange

public void setHalfRange(boolean fHalfRange)

Sets the half range flag for Polar charts.

Parameters:

fHalfRange - if true, theta axis labels on a Polar chart will have a maximum value of 180 degrees

isHalfRange

public boolean isHalfRange()

Gets the half range flag for Polar charts.

Returns:

true if theta axis labels have a maximum value of 180 degrees; on error, return false (the default value)

setRadarCircularGrid

public void setRadarCircularGrid(boolean fCircular)

Makes the y gridlines of a Radar chart circular.

Parameters:

fCircular - true for circular gridlines; false for webbed gridlines

isRadarCircularGrid

public boolean isRadarCircularGrid()

Gets the state of the circular flag for Radar chart gridlines.

Returns:

true if the y gridlines are circular; false if the y gridlines are webbed. On error, return true (the default value).