org.das2.graph.DasPlot

DasPlot is the 2D plot containing a horizontal X axis and vertical Y axis, and a stack of Renderers that paint data onto the plot. It coordinates calls to each Renderer's updatePlotImage and render methods, and manages the rendered stack image to provide previews of new axis settings.

DasPlot( org.das2.graph.DasAxis xAxis, org.das2.graph.DasAxis yAxis )

create a new plot with the x and y axes.

PROP_LEGEND_WIDTH_LIMIT_PX

PROP_TITLE

title for the plot

PROP_FOCUSRENDERER

property name for the current renderer that the operator has selected.

PROP_MULTILINETEXTALIGNMENT

property name for multiline labels, the horizontal alignment, where 0 is left, 0.5 is center, and 1.0 is right.

DUMP_TO_FILE_ACTION

Action to dump the first (0th) renderer's data to a file.

INFO

These levels are now taken from java.util.logging.Level. Generally INFO messages are displayed.

WARNING

mark the log message as a warning where the operator should be aware.

SEVERE

mark the log message as severe, where an error condition has occurred.

PROP_DISPLAYTITLE

turns the plot title off or on.

PROP_BOTTOMDECORATOR

PROP_TOPDECORATOR

PROP_CONTEXT

property where the plot context can be stored.

PROP_DISPLAY_CONTEXT

necessary place to put the range of the data actually displayed. The context is the controller, and the displayContext closes the loop. This is mostly here to provide legacy support to Autoplot which abused the context property as both a write and read, and note there's a small problem that displayed items may have different display contexts. So this property should be used carefully, and generally when just one thing is visible.

PROP_RENDERERS

PROP_LEGENDPOSITION

the location of the legend position, which can be one of the four corners, or outside and to the right of the plot.

PROP_LEGENDRELATIVESIZESIZE

relative font size for the legend. For example, -2 will use sans-8 when the plot font is sans-10.

PROP_LEGENDFONTSIZE

PROP_FONTSIZE

PROP_DISPLAYLEGEND

true if the legend should be displayed

PROP_DRAWBACKGROUND

the background should be drawn, if alpha is >0.

PROP_DRAWGRIDCOLOR

if not transparent, draw the grid in this color. Otherwise the grid is drawn with the tick color.

PROP_DRAWGRID

If true, faint grey lines continue the axis major ticks across the plot.

PROP_DRAWMINORGRID

If true, faint grey lines continue the axis minor ticks across the plot.

PROP_DRAWGRIDOVER

if true, then the grid is on top of the data.

PROP_LINETHICKNESS

PROP_PLOTVISIBLE

PROP_OVERSIZE

boolean property indicating that the data outside the axis bounds is rendered, to smooth animation when the axis is panned.

PROP_LONGTITLES

PROP_LOG_LEVEL

the log level for the messages on the screen.

PROP_PRINTINGLOGLEVEL

the log level to indicate the log level when printing.

PROP_LOG_TIMEOUT_SEC

number of seconds to show the log messages. If Integer.MAX_VALUE/100 or greater then there is no timeout.

PROP_ISOTROPIC

true if the x and y scaling (pixel:data) ratio is locked together.

PROP_DRAWDEBUGMESSAGES

draw a purple box in the lower right corner indicating the number of times each renderer has updated, rendered, and the plot itself has painted.

addCustomizer

Add a new customizer to the collection of customizers being used when creating new plots. The new customizer will be invoked last.

Parameters

Returns:

addRenderer

add the renderer to the stack of renderers. It will be the last element drawn. This fires off an PropertyChangeEvent with the old and new arrays of renderers.

Parameters

Returns:

addToLegend

Add the message to the messages in the legend.

Parameters

Returns:

contains

since the plotVisible property can be false and the plot having no renderers, we want the mouse events to pass on to elements below them.

Parameters

Returns:

containsRenderer

return true if the plot contains the renderer.

Parameters

Returns:

createDummyPlot

provide convenient method for creating a plot. For example:

DasCanvas c= new DasCanvas(400,400);
DasPlot p= DasPlot.createDummyPlot( );
c.add(p,DasRow.create(c,0,1),DasColumn.create(c,0,1));
JOptionPane.showConfirmDialog(None,c)

Returns:

createPlot

provide convenient method for creating a plot. For example:

 
DasCanvas c= new DasCanvas(400,400);
DasPlot p= DasPlot.createPlot( DatumRangeUtil.parseTimeRange('2001'),DatumRange.newDatumRange(0,10,Units.dimensionless) );
c.add(p,DasRow.create(c,0,1),DasColumn.create(c,0,1));
JOptionPane.showConfirmDialog(None,c)

Parameters

Returns:

findRendererAt

return the index of the renderer at canvas location (x,y), or -1 if no renderer is found at the position.

Parameters

Returns:

getActiveRegion

return a Shape containing the plot.

Returns:

getAxisClip

return the Rectangle where data is drawn, useful for clipping.

Returns:

See Also:

getBottomDecorator

Returns:

getContext

convenient place to put the plot context. The context is used to store the timerange when there is no axis for it, for example, to show the state of data during a range. This may change to a QDataSet to provide several context dimensions.

Returns:

See Also:

getCustomizer

Parameters

Returns:

getCustomizerKeys

Return a list of keys of all current customizing objects in the order they would be invoked.

Returns:

getDasColorBar

return the colorbar associated with this DasPlot. This loops through the renderers, from the top most to the bottom most, looking for the first with a non-null colorBar property.

Returns:

getDisplayContext

Returns:

See Also:

getDrawBackground

return the background color, where alpha=0 (transparent) means don't draw the background.

Returns:

getDrawGridColor

Returns:

See Also:

getFocusRenderer

get the current renderer that the operator has selected.

Returns:

getFontSize

Returns:

getLegendFontSize

Returns:

getLegendPosition

Returns:

See Also:

getLegendRelativeFontSize

Returns:

See Also:

getLegendWidthLimitPx

width of plot required to show the legend labels.

Returns:

getLineThickness

Returns:

getLogLevel

Returns:

See Also:

getLogTimeoutSec

Returns:

See Also:

getMultiLineTextAlignment

get the horizontal alignment for multiline labels, where 0 is left, 0.5 is center, and 1.0 is right.

Returns:

getPaintCount

get the diagnostic for the number of times the component was asked to paint itself since the last reset.

Returns:

getPrintingLogLevel

Returns:

See Also:

getRenderer

return one of the renderers, which paint the data on to the plot.

Parameters

Returns:

getRenderers

return a list of the renderers, which paint the data on to the plot. This makes a copy of the renderer array.

Returns:

getTitle

Returns the title of this plot.

Returns:

See Also:

getTopDecorator

Returns:

getXAxis

return the x (horizontal) axis.

Returns:

getYAxis

return the y (vertical) axis

Returns:

invalidateCacheImage

mark the dasPlot's cache image as invalid, forcing it to repaint.

Returns:

invalidateCacheImageNoUpdate

mark the dasPlot's cache image as invalid, but from the update method, so we don't need to update. (Updating results in a loop.)

Returns:

isCacheImageValid

introduced to debug Autoplot test018. This should not be used otherwise.

Returns:

isDisplayLegend

true if the legend should be displayed

Returns:

isDisplayTitle

return the state of enable/disable display of the title.

Returns:

See Also:

isDrawDebugMessages

Returns:

See Also:

isDrawGrid

Getter for property drawGrid. If true, faint grey lines continue the axis major ticks across the plot.

Returns:

isDrawGridOver

Returns:

See Also:

isDrawMinorGrid

Get the value of drawMinorGrid

Returns:

See Also:

isIsotropic

Returns:

See Also:

isLongTitles

long titles means it won't clip at the axis bounds, at the risk of affecting codes which expect the old boundaries.

Returns:

isOverSize

Returns:

See Also:

isPlotVisible

Returns:

isPreviewEnabled

true if the data rendering will be scaled immediately to indicate axis state changes.

Returns:

postException

notify user of an exception, in the context of the plot. This is similar to postMessage(renderer, exception.getMessage(), DasPlot.SEVERE, null, null ) except that it does catch CancelledOperationExceptions and reduced the severity since the user probably initiated the condition.

Parameters

Returns:

postMessage

Notify user of an exception, in the context of the plot. A position in the data space may be specified to locate the text within the data context. Note either or both x or y may be null. Messages must only be posted while the Renderer's render method is called, not during updatePlotImage. All messages are cleared before the render step. (TODO:check on this)

Parameters

Returns:

releaseAll

In Autoplot, we need a way to get help releasing all resources. This clears out all the mouse modules, axis references, etc. Basically anything that could have a reference to other parts of the system that we know we don't need here, explicitly remove the reference.

Returns:

removeCustomizer

Remove the customizer that is associated with the given key.

Parameters

Returns:

removeRenderer

remove the renderer from the stack of renderers. A warning is logged if the renderer is not present. This fires off an PropertyChangeEvent with the old and new arrays of renderers.

Parameters

Returns:

removeRenderers

remove all the renderers from the dasPlot.

Returns:

repaint

request that the plot be repainted. This contains commented code that counts the number of repaints.

Returns:

resetPaintCount

reset the paint counter.

Returns:

resize

recalculate the bounds of the component. TODO: this is used a lot and needs to be explained in more detail.

Returns:

setAxisPlotVisible

set the visibility of both the plot and its x and y axes. Recently, setVisible(v) would do this, but it incorrectly couples the visible properties of the separate components.

Parameters

Returns:

setBottomDecorator

add additional painting code to the renderer, which is called after the renderer is called.

Parameters

Returns:

setContext

convenient place to put the plot context. The context is used to store the timerange when there is no axis for it, for example, to show the state of data during a range. This may change to a QDataSet to provide several context dimensions. Note this may be null to support no context.

Parameters

Returns:

See Also:

setDisplayContext

set the property

Parameters

Returns:

See Also:

setDisplayLegend

true if the legend should be displayed

Parameters

Returns:

See Also:

setDisplayTitle

enable/disable display of the title. Often the title contains useful information describing the plot content that we want to know during interactive use but not when the plot is printed.

Parameters

Returns:

See Also:

setDrawBackground

if not transparent, draw this background first.

Parameters

Returns:

setDrawDebugMessages

Parameters

Returns:

See Also:

setDrawGrid

Setter for property drawGrid. If true, faint grey lines continue the axis major ticks across the plot.

Parameters

Returns:

setDrawGridColor

if not transparent, draw the grid in this color. Otherwise the grid is drawn with the tick color.

Parameters

Returns:

setDrawGridOver

Parameters

Returns:

See Also:

setDrawMinorGrid

Set the value of drawMinorGrid

Parameters

Returns:

setEnableRenderPropertiesAction

add or remove the menu item to get at the renderer properties. Das2 applications generally allow this so that applications don't have to bother handling this. Others like Autoplot have their own systems and uses for the click.

Parameters

Returns:

setFocusRenderer

set the current renderer that the operator has selected.

Parameters

Returns:

setFontSize

set the font size, with respect to the canvas font.

Parameters

Returns:

setIsotropic

set the property value

Parameters

Returns:

See Also:

setLegendFontSize

set the font size for the legend, using the conventions where 1em is the parent's font size:

• 1em same as plot font.
• 2em twice plot font.
• 1em+2pt two points bigger than plot font.

Parameters

Returns:

See Also:

setLegendPosition

Parameters

Returns:

See Also:

setLegendRelativeFontSize

set the relative size of the legend element text.

Parameters

Returns:

See Also:

setLegendWidthLimitPx

width of plot required to show the legend labels.

Parameters

Returns:

setLineThickness

set the thickness of the lines drawn.

Parameters

Returns:

setLogLevel

Parameters

Returns:

See Also:

setLogTimeoutSec

Parameters

Returns:

See Also:

setLongTitles

long titles means it won't clip at the axis bounds, at the risk of affecting codes which expect the old boundaries.

Parameters

Returns:

setMultiLineTextAlignment

set the horizontal alignment for multiline labels, where 0 is left, 0.5 is center, and 1.0 is right.

Parameters

Returns:

setOverSize

Parameters

Returns:

See Also:

setPlotVisible

Parameters

Returns:

setPreviewEnabled

if true then the data rendering will be scaled immediately to indicate axis state changes.

Parameters

Returns:

setPrintingLogLevel

Parameters

Returns:

See Also:

setReduceOutsideLegendTopMargin

Used at APL for layout. This is off by default. This appears to shift the Y position.

Parameters

Returns:

setTitle

Sets the title which will be displayed above this plot. null or empty string may be used to turn off the title.

Parameters

Returns:

See Also:

setTopDecorator

add additional painting code to the renderer, which is called after the renderer is called.

Parameters

Returns:

setXAxis

set the x axis. This removes property change listeners to the old axis and adds PCLs to the new axis.

Parameters

Returns:

setYAxis

Attaches a new axis to the plot. The old axis is disconnected, and the plot will listen to the new axis. Also, the row and column for the axis is set, but this might change in the future. null appears to be a valid input as well. TODO: plot does not seem to be responding to changes in the axis. (goes grey because updatePlotImage is never done.

Parameters

Returns: