org.das2.graph.DasAxis

One dimensional axis component that transforms data to device space and back, and provides controls for navigating the 1-D data space.

DasAxis( Datum min, Datum max, int orientation )

Create an axis object, relating data and canvas pixel coordinates.

DasAxis( DatumRange range, int orientation )

Create an axis object, relating data and canvas pixel coordinates.

DasAxis( Datum min, Datum max, int orientation, boolean log )

Create an axis object, relating data and canvas pixel coordinates.

PROP_LABEL

PROP_LOG

PROP_OPPOSITE_AXIS_VISIBLE

PROP_BOUNDS

PROP_SCAN_RANGE

PROP_UNITS

PROPERTY_TICKS

MAX_TCA_LINES

TOP

This value indicates that the axis should be located at the top of its cell

BOTTOM

This value indicates that the axis should be located at the bottom of its cell

LEFT

This value indicates that the axis should be located to the left of its cell

RIGHT

This value indicates that the axis should be located to the right of its cell

HORIZONTAL

This value indicates that the axis should be oriented horizontally

VERTICAL

This value indicates that the axis should be oriented vertically

PROPERTY_DATUMRANGE

PROP_ENABLEHISTORY

true if the axis built-in history is enabled.

PROP_REFERENCE

PROP_TCAROWS

PROP_TCALABELS

PROP_TICKVALUES

PROP_AXISOFFSET

PROP_FONTSIZE

PROP_LINETHICKNESS

PROP_FLIPPED

PROP_FORMATSTRING

PROP_FLIPLABEL

PROP_DIVIDERDATUMFORMATTER

PROP_MINORTICKSDOMAINDIVIDER

PROP_MAJORTICKSDOMAINDIVIDER

PROP_USEDOMAINDIVIDER

PROP_LOCKDOMAINDIVIDER

addMouseListener

add mouse wheel listener.

Parameters

Returns:

See Also:

addMouseMotionListener

add mouse motion listener.

Parameters

Returns:

See Also:

addMouseWheelListener

Adds a MouseWheelListener to the DasAxis. Special care must be taken with the DasAxis, because it is composed of two sub panels, and their parent panel (this), must not recieve the events. (This is because the DasPlot between them should get the events, and the DasPlot does not have a simple rectangular boundary.

Parameters

Returns:

addTickV

add the tick to the current set of major ticks. If the ticks were automatic, they will now be manual. Note this copies the ticks into a new array, presuming this is done at most a few tens of times.

Parameters

Returns:

See Also:

addTimeRangeSelectionListener

Registers TimeRangeSelectionListener to receive events.

Parameters

Returns:

addToFavorites

add the range to the favorites list, which is accessible from the popup-menu.

Parameters

Returns:

attachTo

attach the axis to another axis, so they will both show the same range, as with a stack of time axes or with a slice.

Parameters

Returns:

clearHistory

clear the internal history.

Returns:

clone

Returns:

createAttachedAxis

create another axis that follows this axis. It will have the same range and orientation.

Returns:

dataRangeSelected

target event handlers to reset the axis bounds.

Parameters

Returns:

detach

disconnect this from the common DataRange object that ties this to other axes, and create a new DataRange.

Returns:

findTick

getActiveRegion

get the region containing the axis.

Returns:

getAffineTransform

return the AffineTransform, or null. The transform will be applied after the input transform is applied. So to just get the transform, pass in identity.

Parameters

Returns:

getAxisBounds

Calculate the rectangle that bounds the axis including its labels. When the axis is drawn on both sides of the plot, this rectangle will extend across the plot.

Returns:

getAxisOffset

Returns:

getDLength

return the length of the axis in pixels.

Returns:

getDataMaximum

return the maximum value

Returns:

getDataMinimum

return the minimum value

Returns:

getDataPath

return the path for the TCA dataset. This will be a das2server data set address, such as http://www-pw.physics.uiowa.edu/das/das2Server?voyager/tca/earth

Returns:

getDataRange

return the mutable DataRange object. This is used to bind axes together by sharing an internal model.

Returns:

getDatumFormatter

return the formatter which converts Datum tick positions to a string.

Returns:

getDatumRange

return the current range

Returns:

getDevicePosition

getDividerDatumFormatter

Returns:

getDrawTca

getFontSize

Returns:

getFormat

return the format string for each tick.

Returns:

getLabel

get the label for the axis.

Returns:

getLabelFont

get the font for labels. If the component currently has null for the font, then Font.decode("sans-12") is used.

Returns:

getLabelOffset

Returns:

getLineSpacing

calculate the spacing (whitespace) between the TCA items.

Returns:

getLineThickness

Returns:

getMajorTicksDomainDivider

return the domain divider for major ticks, or null.

Returns:

getMasterAxis

return the axis this is attached to.

Returns:

getMemento

get the memento object which identifies the state of the axis transformation.

Returns:

getMinorTicksDomainDivider

return the domain divider for minor ticks, or null.

Returns:

getOrientation

returns the orientation of the axis, which is one of BOTTOM,TOP,LEFT or RIGHT.

Returns:

getRange

getReference

Returns:

getScanRange

get the limit the scan buttons, which may be null.

Returns:

getTcaLabels

Returns:

getTcaRows

the explicit number of TCA rows used to allocate space (not including time location). If negative, this is ignored.

Returns:

getTickDirection

return the tick direction, 1=down or left, -1=up or right

Returns:

getTickLabelFont

get the font for tick labels. If the component currently has null for the font, then Font.decode("sans-12") is used and a warning logged.

Returns:

getTickLength

get the tick length string, for example "0.66em"

Returns:

getTickLines

return the number of lines that the ticks use, considering the ephemeris (TCAs) loaded.

Returns:

getTickV

return the current set of ticks.

Returns:

getTickValues

Returns:

getUnits

return the units of the axis.

Returns:

getUserDatumFormatter

get the userDatumFormatter, which converts Datums into Strings. This can be null if none should be used.

Returns:

invTransform

get the range covered by the two points. This allows clients to get a range without having to worry about the flipped property.

Parameters

Returns:

isAnimated

true if the axis is animated. Transitions in axis position are drawn rapidly to animate the transition.

Returns:

isAttached

return true if this is attached to another axis.

Returns:

isDrawTca

true if additional tick labels are drawn using the TCA function.

Returns:

See Also:

isEnableHistory

true if the axis built-in history is enabled.

Returns:

isFlipLabel

true if the right vertical label should be flipped.

Returns:

isFlipped

return true if the axis is flipped.

Returns:

isHorizontal

test if the axis is horizontal.

Returns:

isLockDomainDivider

Returns:

isLog

return true if the axis is log.

Returns:

isOppositeAxisVisible

return true if the opposite side is also drawn.

Returns:

isTcaLoaded

true if the TCA data has been loaded and the axis bounds reflect TCA data present.

Returns:

isTickLabelsVisible

true if the tick labels should be drawn.

Returns:

isUseDomainDivider

true if the domain divider should be used. This is a new object that locates ticks.

Returns:

mutatorLock

get an object to lock the axis for multiple operations.

Returns:

removeFromFavorites

remove the range from the favorites list, which is accessible from the popup-menu.

Parameters

Returns:

removeMouseListener

remove mouse motion listener.

Parameters

Returns:

See Also:

removeMouseMotionListener

remove mouse motion listener.

Parameters

Returns:

See Also:

removeMouseWheelListener

remove mouse wheel listener.

Parameters

Returns:

See Also:

removeTimeRangeSelectionListener

Removes TimeRangeSelectionListener from the list of listeners.

Parameters

Returns:

repaint

Returns:

resetRange

set the axis to the new range, allowing the units to change.

Parameters

Returns:

resize

reset bounds (and unused transform), invalidate the tickV, etc.

Returns:

scanNext

scan to the next interval. If we were looking at a day with fuzz, then scan to the next day.

Returns:

scanPrevious

scan to the previous interval. If we were looking at a day with fuzz, then scan to the previous day.

Returns:

setAnimated

if true then the axis will be animated.

Parameters

Returns:

setAxisOffset

set the offset of the axis from the plot.

Parameters

Returns:

setDataMaximum

set the bigger extent of the range of this axis.

Parameters

Returns:

setDataMinimum

set the smaller extent of the range of this axis.

Parameters

Returns:

setDataPath

Parameters

Returns:

See Also:

setDataRange

Set the data range. minimum must be less than maximum, but for nominal data they can be equal.

Parameters

Returns:

setDataRangeForward

set the range to the next interval.

Returns:

setDataRangePrev

set the range to the previous interval.

Returns:

setDataRangeZoomOut

set the range to min-width to max+width.

Returns:

setDatumRange

Set the range for the axis. Note this is allowed to change the units as well.

Parameters

Returns:

setDividerDatumFormatter

Parameters

Returns:

setDrawTca

if true then turn on additional tick labels using the TCA function.

Parameters

Returns:

See Also:

setEnableHistory

true if the axis built-in history is enabled.

Parameters

Returns:

setFlipLabel

true if the right vertical label should be flipped.

Parameters

Returns:

setFlipped

flip over the axis.

Parameters

Returns:

setFontSize

Parameters

Returns:

setFormat

set a hint at the format string. Examples include:

• 0.000
• %H:%M!c%Y-%j
• 0

Parameters

Returns:

setLabel

set the label for the axis. The label for this axis is displayed below the ticks for horizontal axes or to left of the ticks for vertical axes.

Parameters

Returns:

setLabelOffset

explicitly set the position of the label from the axis. For example, "4em" will position the y-axis label 4ems away from the axis. Empty string is default automatic behavior.

Parameters

Returns:

setLeftXLabelOverride

setLineThickness

set the thickness of the lines drawn.

Parameters

Returns:

setLockDomainDivider

don't allow the domain divider to adjust.

Parameters

Returns:

setLog

Set the axis to be log or linear. If necessary, axis range will be adjusted to make the range valid.

Parameters

Returns:

setMajorTicksDomainDivider

Parameters

Returns:

setMinorTicksDomainDivider

Parameters

Returns:

setNextAction

set the action for the next button

Parameters

Returns:

setNextActionLabel

set the label for the popup button

Parameters

Returns:

setOppositeAxisVisible

if true, then the axis and its ticks on the opposite side will also be drawn.

Parameters

Returns:

setOrientation

Set the axis orientation. One of: DasAxis.TOP, DasAxis.BOTTOM, DasAxis.LEFT, DasAxis.RIGHT

Parameters

Returns:

See Also:

setPlot

set the plot that will get updates

Parameters

Returns:

setPreviousAction

set the action for the prev button

Parameters

Returns:

setPreviousActionLabel

set the label for the popup button

Parameters

Returns:

setReference

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

Parameters

Returns:

setScanRange

limit the scan buttons to operate within this range. Setting this to null will remove the limit. http://sourceforge.net/p/autoplot/bugs/473/

Parameters

Returns:

setTcaFunction

Add auxiliary data to an axis (usually OrbitAttitude data for a time axis). This function does the same thing as setDataPath, but with a different interface. The QFunction must have one input parameter which will be positions on this axis (e.g. times from a time axis).

Parameters

Returns:

See Also:

setTcaLabels

set the TCA data labels explicitly, using a semi-colon delimited list of labels.

Parameters

Returns:

setTcaRows

the explicit number of additional TCA rows used to allocate space (not including time location). If negative, this is ignored.

Parameters

Returns:

setTickLabelsVisible

set true if the tick labels should be drawn.

Parameters

Returns:

setTickLength

set the tick length string, for example "0.33em" "5px" "-0.33em"

Parameters

Returns:

setTickV

convenience method for manually setting the ticks so the user needn't understand TickVDescriptor. setTickV(null) can be used to reset the ticks as well as setTickV(null,null).

Parameters

Returns:

See Also:

setTickValues

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

	empty string is automatic behavior
0,45,90,135,180	explicit tick positions, in axis units
+45	spacing between ticks, parsed with the axis offset units.
+20s/4	every 20 seconds, with four minor divisions.
+30s	30 seconds spacing between ticks
*10/2,3,4,5,6,7,8,9	normal log axis.
*1e2/5,10,50	log major ticks should be every two cycles
*5/2,3,4	log major ticks at 1,5,25/
none	no ticks

Parameters

Returns:

See Also:

setUnits

set the units of the axis, which must be convertible from the old units.

Parameters

Returns:

See Also:

setUseDomainDivider

true if the domain divider should be used. This is a new object that locates ticks.

Parameters

Returns:

setUserDatumFormatter

set the userDatumFormatter, which converts Datums into Strings. This can be null if none should be used.

Parameters

Returns:

setVisible

set the component visible or invisible. The axis bounds are updated. So in addition to the JComponent visibility, this also makes a useful property to completely hide the axis. drawTickLabels hides the labels but still draws the ticks, this completely hides the axis. Note too that even though it is not visible, tick positions are still updated to support drawing a grid on the plot.

Parameters

Returns:

timeRangeSelected

call back for time range selection event.

Parameters

Returns:

toString

Returns:

transform

Transforms a Datum in data coordinates to a horizontal or vertical position on the parent canvas.

Parameters

Returns:

valueIsAdjusting

true if a lock is out and an object is rapidly mutating the object. clients listening for property changes can safely ignore property changes while valueIsAdjusting is true, as they should receive a final propertyChangeEvent after the lock is released. (note it's not clear who is responsible for this. See http://das2.org/wiki/index.php/Das2.valueIsAdjusting)

Returns: