org.autoplot.dom.Axis

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

Axis( )

DEFAULT_RANGE

PROP_RANGE

PROP_SCALE

PROP_LOG

PROP_REFERENCE

PROP_LABEL

concise label for the axis.

PROP_FONTSIZE

PROP_DRAWTICKLABELS

PROP_OPPOSITE

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.

PROP_AUTORANGE

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

PROP_AUTORANGEHINTS

PROP_AUTOLABEL

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

PROP_FLIPPED

PROP_TICKVALUES

PROP_AXISOFFSET

copy

copy( ) → org.autoplot.dom.DomNode

Returns:

org.autoplot.dom.DomNode

[search for examples] [view on GitHub] [view on old javadoc] [view source]

diffs

diffs( org.autoplot.dom.DomNode node ) → java.util.List

Parameters

node - a DomNode

Returns:

java.util.List

[search for examples] [view on GitHub] [view on old javadoc] [view source]

getAutoRangeHints

getAutoRangeHints( ) → String

Returns:

java.lang.String

[search for examples] [view on GitHub] [view on old javadoc] [view source]

getAxisOffset

getAxisOffset( ) → String

Returns:

java.lang.String

[search for examples] [view on GitHub] [view on old javadoc] [view source]

getController

getController( ) → org.autoplot.dom.AxisController

Returns:

org.autoplot.dom.AxisController

[search for examples] [view on GitHub] [view on old javadoc] [view source]

getFontSize

getFontSize( ) → String

Returns:

java.lang.String

[search for examples] [view on GitHub] [view on old javadoc] [view source]

getLabel

getLabel( ) → String

concise label for the axis.

Returns:

the label

[search for examples] [view on GitHub] [view on old javadoc] [view source]

getRange

getRange( ) → DatumRange

Returns:

org.das2.datum.DatumRange

[search for examples] [view on GitHub] [view on old javadoc] [view source]

getReference

getReference( ) → String

Returns:

java.lang.String

[search for examples] [view on GitHub] [view on old javadoc] [view source]

getScale

getScale( ) → Datum

Returns:

org.das2.datum.Datum

[search for examples] [view on GitHub] [view on old javadoc] [view source]

getTickValues

getTickValues( ) → String

Returns:

java.lang.String

[search for examples] [view on GitHub] [view on old javadoc] [view source]

isAutoLabel

isAutoLabel( ) → boolean

Returns:

boolean

[search for examples] [view on GitHub] [view on old javadoc] [view source]

isAutoRange

isAutoRange( ) → boolean

Returns:

boolean

[search for examples] [view on GitHub] [view on old javadoc] [view source]

isDrawTickLabels

isDrawTickLabels( ) → boolean

Returns:

boolean

[search for examples] [view on GitHub] [view on old javadoc] [view source]

isFlipped

isFlipped( ) → boolean

Returns:

boolean

[search for examples] [view on GitHub] [view on old javadoc] [view source]

isLog

isLog( ) → boolean

Returns:

boolean

[search for examples] [view on GitHub] [view on old javadoc] [view source]

isOpposite

isOpposite( ) → boolean

Returns:

boolean

[search for examples] [view on GitHub] [view on old javadoc] [view source]

isVisible

isVisible( ) → boolean

Returns:

boolean

[search for examples] [view on GitHub] [view on old javadoc] [view source]

setAutoLabel

setAutoLabel( boolean autolabel ) → void

Parameters

autolabel - a boolean

Returns:

void (returns nothing)

[search for examples] [view on GitHub] [view on old javadoc] [view source]

setAutoRange

setAutoRange( boolean autorange ) → void

Parameters

autorange - a boolean

Returns:

void (returns nothing)

[search for examples] [view on GitHub] [view on old javadoc] [view source]

setAutoRangeHints

setAutoRangeHints( String autoRangeHints ) → void

Parameters

autoRangeHints - a String

Returns:

void (returns nothing)

[search for examples] [view on GitHub] [view on old javadoc] [view source]

setAxisOffset

setAxisOffset( String axisOffset ) → void

extra amount to scoot out the axis.

Parameters

axisOffset - a String

Returns:

void (returns nothing)

[search for examples] [view on GitHub] [view on old javadoc] [view source]

setDrawTickLabels

setDrawTickLabels( boolean drawTickLabels ) → void

Parameters

drawTickLabels - a boolean

Returns:

void (returns nothing)

[search for examples] [view on GitHub] [view on old javadoc] [view source]

setFlipped

setFlipped( boolean flipped ) → void

Parameters

flipped - a boolean

Returns:

void (returns nothing)

[search for examples] [view on GitHub] [view on old javadoc] [view source]

setFontSize

setFontSize( String fontSize ) → void

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 - a String

Returns:

void (returns nothing)

[search for examples] [view on GitHub] [view on old javadoc] [view source]

setLabel

setLabel( String label ) → void

concise label for the axis.

Parameters

label - the label

Returns:

void (returns nothing)

[search for examples] [view on GitHub] [view on old javadoc] [view source]

setLog

setLog( boolean log ) → void

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 - a boolean

Returns:

void (returns nothing)

[search for examples] [view on GitHub] [view on old javadoc] [view source]

setOpposite

setOpposite( boolean opposite ) → void

Parameters

opposite - a boolean

Returns:

void (returns nothing)

[search for examples] [view on GitHub] [view on old javadoc] [view source]

setRange

setRange( DatumRange range ) → void

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 - a DatumRange

Returns:

void (returns nothing)

[search for examples] [view on GitHub] [view on old javadoc] [view source]

setReference

setReference( String reference ) → void

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

Parameters

reference - a String

Returns:

void (returns nothing)

[search for examples] [view on GitHub] [view on old javadoc] [view source]

setScale

setScale( Datum scale ) → void

Parameters

scale - a Datum

Returns:

void (returns nothing)

[search for examples] [view on GitHub] [view on old javadoc] [view source]

setTickValues

setTickValues( String ticks ) → void

manually set the tick positions or spacing. The following are examples of accepted settings:
empty string is legacy behavior
0,45,90,135,180explicit tick positions, in axis units
+45spacing between tickValues, parsed with the axis offset units.
+30s30 seconds spacing between tickValues

Parameters

ticks - a String

Returns:

void (returns nothing)

[search for examples] [view on GitHub] [view on old javadoc] [view source]

setVisible

setVisible( boolean visible ) → void

Parameters

visible - a boolean

Returns:

void (returns nothing)

[search for examples] [view on GitHub] [view on old javadoc] [view source]

syncTo

syncTo( org.autoplot.dom.DomNode n ) → void

Parameters

n - a DomNode

Returns:

void (returns nothing)

[search for examples] [view on GitHub] [view on old javadoc] [view source]

syncTo( org.autoplot.dom.DomNode n, java.util.List exclude ) → void