JMSLTM Numerical Library 3.0

com.imsl.chart
Class AxisTheta

java.lang.Object
  extended bycom.imsl.chart.ChartNode
      extended bycom.imsl.chart.AxisTheta
All Implemented Interfaces:
Cloneable, Serializable

public class AxisTheta
extends ChartNode

The angular axis in a polar plot.

AxisTheta is created by Polar as its child. It can be retrieved using the method Polar.getAxisTheta().

The angles are labeled using the TextFormat attribute, which is set to "0.##\\u00b0", where \\u00b0 is the Unicode character for degrees. This labels the angles in degrees. More generally, TextFormat can be set to a NumberFormat object to format the angles in degrees.

TextFormat can also be set to a MessageFormat object. In this case, field {0} is the value in degrees, field {1} is the value in radians and field {2} is the value in radians/pi. So, for labels like 1.5\\u03c0, where \\u03c0 is the Unicode character for pi, set TextFormat to new MessageFormat("{2,number,0.##\\u03c0}").

The number of tick marks ("Number" attribute) is set to 9, but autoscaling can change this value.

See Also:
Polar, NumberFormat, DecimalFormat, MessageFormat, Serialized Form

Field Summary
 
Fields inherited from class com.imsl.chart.ChartNode
AUTOSCALE_DATA, AUTOSCALE_DENSITY, AUTOSCALE_NUMBER, AUTOSCALE_OFF, AUTOSCALE_WINDOW, AXIS_X, AXIS_X_TOP, AXIS_Y, AXIS_Y_RIGHT, BAR_TYPE_HORIZONTAL, BAR_TYPE_VERTICAL, DASH_PATTERN_DASH, DASH_PATTERN_DASH_DOT, DASH_PATTERN_DOT, DASH_PATTERN_SOLID, DATA_TYPE_FILL, DATA_TYPE_LINE, DATA_TYPE_MARKER, DATA_TYPE_PICTURE, FILL_TYPE_GRADIENT, FILL_TYPE_NONE, FILL_TYPE_PAINT, FILL_TYPE_SOLID, LABEL_TYPE_NONE, LABEL_TYPE_PERCENT, LABEL_TYPE_TITLE, LABEL_TYPE_X, LABEL_TYPE_Y, MARKER_TYPE_ASTERISK, MARKER_TYPE_CIRCLE_CIRCLE, MARKER_TYPE_CIRCLE_PLUS, MARKER_TYPE_CIRCLE_X, MARKER_TYPE_DIAMOND_PLUS, MARKER_TYPE_FILLED_CIRCLE, MARKER_TYPE_FILLED_DIAMOND, MARKER_TYPE_FILLED_SQUARE, MARKER_TYPE_FILLED_TRIANGLE, MARKER_TYPE_HOLLOW_CIRCLE, MARKER_TYPE_HOLLOW_DIAMOND, MARKER_TYPE_HOLLOW_SQUARE, MARKER_TYPE_HOLLOW_TRIANGLE, MARKER_TYPE_OCTAGON_PLUS, MARKER_TYPE_OCTAGON_X, MARKER_TYPE_PLUS, MARKER_TYPE_SQUARE_PLUS, MARKER_TYPE_SQUARE_X, MARKER_TYPE_X, TEXT_X_CENTER, TEXT_X_LEFT, TEXT_X_RIGHT, TEXT_Y_BOTTOM, TEXT_Y_CENTER, TEXT_Y_TOP, TRANSFORM_CUSTOM, TRANSFORM_LINEAR, TRANSFORM_LOG
 
Method Summary
 double[] getTicks()
          Returns the value of the "Ticks" attribute, if set.
 double[] getWindow()
          Returns the window for an AxisTheta.
 void paint(Draw draw)
          Paints this node and all of its children.
 void setWindow(double[] window)
          Sets the window for an AxisTheta.
 void setWindow(double min, double max)
          Sets the window for an AxisTheta.
 
Methods inherited from class com.imsl.chart.ChartNode
addPickListener, clone, clone, clone, clone, firePickListeners, getALT, getAttribute, getAutoscaleInput, getAutoscaleMinimumTimeInterval, getAutoscaleOutput, getAxis, getBackground, getBarGap, getBarType, getBarWidth, getBooleanAttribute, getChart, getChartTitle, getChildren, getClipData, getColorAttribute, getComponent, getConcatenatedViewport, getCustomTransform, getDataType, getDensity, getDoubleAttribute, getDoubleBuffering, getExplode, getFillColor, getFillOutlineColor, getFillOutlineType, getFillPaint, getFillType, getFont, getFontName, getFontSize, getFontStyle, getGradient, getHREF, getImage, getIntegerAttribute, getLabelType, getLegend, getLineColor, getLineDashPattern, getLineWidth, getLocale, getMarkerColor, getMarkerDashPattern, getMarkerSize, getMarkerThickness, getMarkerType, getName, getNumber, getPaint, getParent, getReference, getScreenAxis, getScreenSize, getScreenViewport, getSize, getSkipWeekends, getStringAttribute, getTextAngle, getTextColor, getTextFormat, getTickLength, getTitle, getToolTip, getTransform, getViewport, getX, getY, isAncestorOf, isAttributeSet, isAttributeSetAtThisNode, isBitSet, parseColor, remove, removePickListener, setALT, setAttribute, setAutoscaleInput, setAutoscaleMinimumTimeInterval, setAutoscaleOutput, setBarGap, setBarType, setBarWidth, setChartTitle, setClipData, setCustomTransform, setDataType, setDensity, setDoubleBuffering, setExplode, setFillColor, setFillColor, setFillOutlineColor, setFillOutlineColor, setFillOutlineType, setFillPaint, setFillPaint, setFillPaint, setFillType, setFont, setFontName, setFontSize, setFontStyle, setGradient, setGradient, setGradient, setHREF, setImage, setImage, setLabelType, setLineColor, setLineColor, setLineDashPattern, setLineWidth, setLocale, setMarkerColor, setMarkerColor, setMarkerDashPattern, setMarkerSize, setMarkerThickness, setMarkerType, setName, setNumber, setPaint, setReference, setScreenSize, setSize, setSkipWeekends, setTextAngle, setTextColor, setTextColor, setTextFormat, setTextFormat, setTickLength, setTitle, setTitle, setToolTip, setTransform, setViewport, setViewport, setX, setY, toString
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Method Detail

paint

public void paint(Draw draw)
Paints this node and all of its children.

Specified by:
paint in class ChartNode
Parameters:
draw - the Draw object to be painted

getTicks

public double[] getTicks()
Returns the value of the "Ticks" attribute, if set. If not set then computed tick values are returned. These are the positions at which the angles are labeled.

Returns:
the double value of the "Ticks" attribute, if defined. Otherwise, computed tick values are returned. The ticks are in radians, not degrees.

setWindow

public void setWindow(double min,
                      double max)
Sets the window for an AxisTheta. The default Window is [0,2pi].

Parameters:
min - a double which specifies the initial angular value, in radians.
max - a double which specifies the final angular value, in radians.

setWindow

public void setWindow(double[] window)
Sets the window for an AxisTheta.

Parameters:
window - a double array of length two containing the angular range.

getWindow

public double[] getWindow()
Returns the window for an AxisTheta.

Returns:
a double array of length two containing the angular range of the window.

JMSLTM Numerical Library 3.0

Copyright 1970-2004 Visual Numerics, Inc.
Built November 5 2004.