org.jplot2d.axtype

Class AxisType

java.lang.Object

org.jplot2d.axtype.AxisType

Direct Known Subclasses:

DateAxisType, DeclinationAxisType, NumberAxisType, RightAscensionAxisType, TAIMicrosAxisType

public abstract class AxisType
extends java.lang.Object

An axis type defines a viewport axis transform type(LINEAR/LOGARITHMIC) and a preferred tick algorithm.

Field Summary

Fields

Modifier and Type	Field and Description
static AxisType	DATE
static AxisType	DATE_UTC_US
static AxisType	DECLINATION
static AxisType	NUMBER
static AxisType	RIGHT_ASCENSION
static AxisType	TAI_MICROS_UTC_US

Constructor Summary

Constructors

Constructor and Description
AxisType(java.lang.String name)

Method Summary

Modifier and Type	Method and Description
abstract boolean	canSupport(TransformType txfType)
abstract Range	getBoundary(TransformType txfType) The boundary of the axis nature.
Range	getCircularRange() Some axis has a circular nature, such as angle.
abstract TransformType	getDefaultTransformType()
abstract Range	getDefaultWorldRange(TransformType txfType)
java.lang.String	getName()
abstract TickAlgorithm	getTickAlgorithm(TransformType txfType, AxisTickTransform tickTransform) Returns a TickAlgorithm by the given transform type and tick transform, or null if the given tick transform is not allowed.
java.lang.String	toString()
static AxisType	valueOf(java.lang.String name)
static AxisType[]	values() Returns all axis types in a array.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

NUMBER

public static final AxisType NUMBER

DATE

public static final AxisType DATE

DATE_UTC_US

public static final AxisType DATE_UTC_US

TAI_MICROS_UTC_US

public static final AxisType TAI_MICROS_UTC_US

RIGHT_ASCENSION

public static final AxisType RIGHT_ASCENSION

DECLINATION

public static final AxisType DECLINATION

Constructor Detail

AxisType

public AxisType(java.lang.String name)

Method Detail

getName

public java.lang.String getName()

canSupport

public abstract boolean canSupport(TransformType txfType)

getDefaultTransformType

public abstract TransformType getDefaultTransformType()

getBoundary

public abstract Range getBoundary(TransformType txfType)

The boundary of the axis nature. The returned boundary is never inverted. For circular axis, this boundary is valid limit for data values, not for displayed label values.

Returns:

getDefaultWorldRange

public abstract Range getDefaultWorldRange(TransformType txfType)

Returns:

the default world range when the axis contains no valid data

getTickAlgorithm

public abstract TickAlgorithm getTickAlgorithm(TransformType txfType,
                                               AxisTickTransform tickTransform)

Returns a TickAlgorithm by the given transform type and tick transform, or null if the given tick transform is not allowed.

Parameters:

txfType - the transform type

tickTransform - the tick transform, can be null

Returns:

a TickAlgorithm

getCircularRange

public Range getCircularRange()

Some axis has a circular nature, such as angle. This range is a canonical range that all values should displayed in the range.

Returns:

a range to represent this axis' circular nature, or null if this axis is not circular

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

valueOf

public static AxisType valueOf(java.lang.String name)

values

public static AxisType[] values()

Returns all axis types in a array.

Returns:

all axis types