org.autoplot.dom

Class Axis

java.lang.Object

org.autoplot.dom.DomNode

org.autoplot.dom.Axis

All Implemented Interfaces:

java.lang.Cloneable

public class Axis
extends DomNode

The state of an axis, X, Y, or a Z axis colorbar, such as range and the scale type.

Field Summary

Fields

Modifier and Type	Field and Description
protected boolean	autoLabel
protected boolean	autoRange
static DatumRange	DEFAULT_RANGE
protected boolean	drawTickLabels
protected java.lang.String	label
protected boolean	log
static java.lang.String	PROP_AUTOLABEL true indicates the axis label hasn't been changed by a human and may/should be autoranged.
static java.lang.String	PROP_AUTORANGE true indicates the axis hasn't been changed and may/should be autoranged.
static java.lang.String	PROP_AUTORANGEHINTS
static java.lang.String	PROP_DRAWTICKLABELS
static java.lang.String	PROP_FLIPPED
static java.lang.String	PROP_FONTSIZE
static java.lang.String	PROP_LABEL concise label for the axis.
static java.lang.String	PROP_LOG
static java.lang.String	PROP_OPPOSITE
static java.lang.String	PROP_RANGE
static java.lang.String	PROP_REFERENCE
static java.lang.String	PROP_SCALE
static java.lang.String	PROP_TICKVALUES
static java.lang.String	PROP_VISIBLE false indicates the component will not be drawn.
protected DatumRange	range
protected boolean	visible

Fields inherited from class org.autoplot.dom.DomNode

id, logger, PROP_ID, propertyChangeSupport

Constructor Summary

Constructors

Constructor and Description
Axis()

Method Summary

Modifier and Type	Method and Description
DomNode	copy() returns a deep copy of the node.
java.util.List<Diff>	diffs(DomNode node) return a list of the differences between this and another node.
java.lang.String	getAutoRangeHints()
AxisController	getController()
java.lang.String	getFontSize()
java.lang.String	getLabel() concise label for the axis.
DatumRange	getRange()
java.lang.String	getReference()
Datum	getScale()
java.lang.String	getTickValues()
boolean	isAutoLabel()
boolean	isAutoRange()
boolean	isDrawTickLabels()
boolean	isFlipped()
boolean	isLog()
boolean	isOpposite()
boolean	isVisible()
void	setAutoLabel(boolean autolabel)
void	setAutoRange(boolean autorange)
void	setAutoRangeHints(java.lang.String autoRangeHints)
void	setDrawTickLabels(boolean drawTickLabels)
void	setFlipped(boolean flipped)
void	setFontSize(java.lang.String fontSize) set the font size relative to the canvas font size.
void	setLabel(java.lang.String label) concise label for the axis.
void	setLog(boolean log) set the log property.
void	setOpposite(boolean opposite)
void	setRange(DatumRange range) set the range property.
void	setReference(java.lang.String reference) draw an optional reference line at the location.
void	setScale(Datum scale)
void	setTickValues(java.lang.String ticks) manually set the tick positions or spacing.
void	setVisible(boolean visible)
void	syncTo(DomNode n) bulk assignment of properties.
void	syncTo(DomNode n, java.util.List<java.lang.String> exclude) Bulk assignment of properties, but allow specification of properties to exclude.

Methods inherited from class org.autoplot.dom.DomNode

addPropertyChangeListener, addPropertyChangeListener, boundCount, childNodes, getId, removePropertyChangeListener, removePropertyChangeListener, setId, toString

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_RANGE

public static final DatumRange DEFAULT_RANGE

range

protected DatumRange range

PROP_RANGE

public static final java.lang.String PROP_RANGE

See Also:

Constant Field Values

PROP_SCALE

public static final java.lang.String PROP_SCALE

See Also:

Constant Field Values

log

protected boolean log

PROP_LOG

public static final java.lang.String PROP_LOG

See Also:

Constant Field Values

PROP_REFERENCE

public static final java.lang.String PROP_REFERENCE

See Also:

Constant Field Values

label

protected java.lang.String label

PROP_LABEL

public static final java.lang.String PROP_LABEL

concise label for the axis.

See Also:

Constant Field Values

PROP_FONTSIZE

public static final java.lang.String PROP_FONTSIZE

See Also:

Constant Field Values

drawTickLabels

protected boolean drawTickLabels

PROP_DRAWTICKLABELS

public static final java.lang.String PROP_DRAWTICKLABELS

See Also:

Constant Field Values

PROP_OPPOSITE

public static final java.lang.String PROP_OPPOSITE

See Also:

Constant Field Values

PROP_VISIBLE

public static final java.lang.String PROP_VISIBLE

false indicates the component will not be drawn. Note the x and y axes are only drawn if the plot is drawn, and the colorbar may be drawn if the plot is not drawn.

See Also:

Constant Field Values

visible

protected boolean visible

PROP_AUTORANGE

public static final java.lang.String PROP_AUTORANGE

true indicates the axis hasn't been changed and may/should be autoranged.

See Also:

Constant Field Values

autoRange

protected boolean autoRange

PROP_AUTORANGEHINTS

public static final java.lang.String PROP_AUTORANGEHINTS

See Also:

Constant Field Values

PROP_AUTOLABEL

public static final java.lang.String PROP_AUTOLABEL

true indicates the axis label hasn't been changed by a human and may/should be autoranged.

See Also:

Constant Field Values

autoLabel

protected boolean autoLabel

PROP_FLIPPED

public static final java.lang.String PROP_FLIPPED

See Also:

Constant Field Values

PROP_TICKVALUES

public static final java.lang.String PROP_TICKVALUES

See Also:

Constant Field Values

Constructor Detail

Axis

public Axis()

Method Detail

getRange

public DatumRange getRange()

setRange

public void setRange(DatumRange range)

set the range property. Right now, if the axis is log, and the range contains negative values, then the axis will be in an invalid state. We cannot change the range setting automatically because the next setting may be the log property, then the order of property setter calls would matter. TODO: consider mutatorLock... TODO: consider making the axis linear...

Parameters:

range -

getScale

public Datum getScale()

setScale

public void setScale(Datum scale)

isLog

public boolean isLog()

setLog

public void setLog(boolean log)

set the log property. If the value makes the range invalid (log and zero), then the range is adjusted to make it valid. This works because the order of property setters doesn't matter.

Parameters:

log -

getReference

public java.lang.String getReference()

setReference

public void setReference(java.lang.String reference)

draw an optional reference line at the location. Valid entries can be parsed into a Datum, using the units of the axis.

Parameters:

reference -

getLabel

public java.lang.String getLabel()

concise label for the axis.

Returns:

the label

setLabel

public void setLabel(java.lang.String label)

concise label for the axis.

Parameters:

label - the label

getFontSize

public java.lang.String getFontSize()

setFontSize

public void setFontSize(java.lang.String fontSize)

set the font size relative to the canvas font size. For example "2em" will be twice the size. "" is an alias for 1em.

Parameters:

fontSize -

isDrawTickLabels

public boolean isDrawTickLabels()

setDrawTickLabels

public void setDrawTickLabels(boolean drawTickLabels)

isOpposite

public boolean isOpposite()

setOpposite

public void setOpposite(boolean opposite)

isVisible

public boolean isVisible()

setVisible

public void setVisible(boolean visible)

isAutoRange

public boolean isAutoRange()

setAutoRange

public void setAutoRange(boolean autorange)

getAutoRangeHints

public java.lang.String getAutoRangeHints()

setAutoRangeHints

public void setAutoRangeHints(java.lang.String autoRangeHints)

isAutoLabel

public boolean isAutoLabel()

setAutoLabel

public void setAutoLabel(boolean autolabel)

isFlipped

public boolean isFlipped()

setFlipped

public void setFlipped(boolean flipped)

getTickValues

public java.lang.String getTickValues()

setTickValues

public void setTickValues(java.lang.String ticks)

manually set the tick positions or spacing. The following are examples of accepted settings:

	empty string is legacy behavior
0,45,90,135,180	explicit tick positions, in axis units
+45	spacing between tickValues, parsed with the axis offset units.
+30s	30 seconds spacing between tickValues

Parameters:

ticks -

getController

public AxisController getController()

syncTo

public void syncTo(DomNode n)

Description copied from class: DomNode

bulk assignment of properties. When the node's children differ, then a controller should be used to implement the sync. Syncing should include the node's ID.

Overrides:

syncTo in class DomNode

syncTo

public void syncTo(DomNode n,
                   java.util.List<java.lang.String> exclude)

Description copied from class: DomNode

Bulk assignment of properties, but allow specification of properties to exclude. Note exclude should be passed to children when this is overriden, normally to exclude id property.

Overrides:

syncTo in class DomNode

copy

public DomNode copy()

Description copied from class: DomNode

returns a deep copy of the node.

Overrides:

copy in class DomNode

Returns:

diffs

public java.util.List<Diff> diffs(DomNode node)

Description copied from class: DomNode

return a list of the differences between this and another node. The differences describe how to mutate that node to make it like this node.

Overrides:

diffs in class DomNode

Returns: