org.das2.graph.Renderer

PROP_BOTTOMDECORATOR

PROP_TOPDECORATOR

CONTROL_KEY_COLOR

allocate a bunch of canonical properties. See http://autoplot.org/developer.guessRenderType#Proposed_extensions

CONTROL_KEY_FILL_COLOR

CONTROL_KEY_FILL_DIRECTION

CONTROL_KEY_COLOR_TABLE

CONTROL_KEY_LINE_THICK

CONTROL_KEY_LINE_STYLE

used in ContoursRenderer and EventsRenderer, values like DotDashes and Solid

CONTROL_KEY_SYMBOL

CONTROL_KEY_SYMBOL_SIZE

CONTROL_KEY_SPECIAL_COLORS

mapping from one double value to color, like:

• "0.0:white"

CONTROL_KEY_FILL_TEXTURE

when filling a region, use this texture (solid,hash,backhash,crosshash) to fill.

CONTROL_KEY_FONT_SIZE

font size relative to the parent, so "" or "1em" is the same size.

CONTROL_KEY_REFERENCE

CONTROL_KEY_DRAW_ERROR

CONTROL_KEY_MODULO_Y

modulo Y indicates that a difference in 23 hours is the same as -1 hours.

CONTROL_KEY_MODULO_X

PROP_CONTROL

PROP_ACTIVE

display the renderer. This is allows a renderer to be disabled without removing it from the application.

PROP_LEGENDLABEL

If non-null and non-zero-length, use this label to describe the renderer in the plot's legend.

PROP_DRAWLEGENDLABEL

true if the legend label should be drawn.

PROP_ID

PROP_COLORBAR

PROP_RECORDFILE

acceptContext

Returns true if the render will accept the context for a point. That is, the renderer affected that point, or nearby points. This is used currently to provide a way for the operator to click on a plot and directly edit the renderer which drew the pixel.

Parameters

Returns:

acceptsDataSet

return true if the dataset appears to be in a scheme accepted by this renderer. This should assume that axis units can be reset, etc.

Parameters

Returns:

addPropertyChangeListener

Adds a PropertyChangeListener to the listener list.

Parameters

Returns:

decodeDatum

Parameters

Returns:

decodeFillStyle

decode the string into a fill style

Parameters

Returns:

decodePlotSymbolConnectorControl

decode the string into a plot symbol.

Parameters

Returns:

decodePlotSymbolControl

decode the string into a plot symbol.

Parameters

Returns:

drawListIcon

Parameters

Returns:

encodeBooleanControl

return the encoding for the boolean value.

Parameters

Returns:

encodeColorControl

encode the Color control.

Parameters

Returns:

See Also:

encodeDatum

Parameters

Returns:

encodeFillStyle

encode the fill style as a string, such as: none, outline, and solid.

Parameters

Returns:

encodePlotSymbolConnectorControl

encode the plot symbol connector as a string, such as: solid, dotted

Parameters

Returns:

encodePlotSymbolControl

encode the plot symbol as a string, such as: none, circles, triangles, cross, ex, star, diamond, box

Parameters

Returns:

formatControl

convenient and official location for method that formats control string.

Parameters

Returns:

getBooleanControl

get the boolean control.

Parameters

Returns:

getBottomDecorator

Returns:

getColorBar

get the colorbar for the renderer.

Returns:

getColorControl

get the Color control.

Parameters

Returns:

See Also:

getConsumedDataSet

return the data for DataSetConsumer, which might be rebinned.

Returns:

getControl

get the string which summarizes the state of the renderer. These allow a compact string to contain the renderer settings. This should be an ampersand-delimited list of name=value pairs.

Returns:

getDataLoader

Returns:

getDataSet

returns the current dataset being displayed.

Returns:

getDataSetDescriptor

Returns:

getDataSetID

Returns:

getDatumControl

get the Datum control.

Parameters

Returns:

getDoubleArrayControl

get the double array control. These should be encoded on a string with commas delimiting values.

Parameters

Returns:

getDoubleControl

get the double control.

Parameters

Returns:

getId

Returns:

getIntegerControl

get the integer control.

Parameters

Returns:

getLastException

Returns:

getLegendLabel

get the label to describe the renderer in the plot's legend. If zero-length, then the legend label should be hidden.

Returns:

getListIcon

Returns:

getListLabel

Returns:

getParent

Returns:

getRenderCount

return the number of times render has been called since the last reset.

Returns:

getStatsFile

Returns:

getTopDecorator

Returns:

getUpdateCount

return the number of times updatePlotImage has been called since the last reset.

Returns:

getXmemento

Returns:

getYmemento

Returns:

hasControl

return true if the control is specified.

Parameters

Returns:

isActive

true when the renderer should be drawn.

Returns:

isDrawLegendLabel

get the switch used to turn off legend label. This allows the label to be hidden without loosing the information it provides.

Returns:

isDumpDataSet

Getter for property dumpDataSet.

Returns:

isTableDataSet

Parameters

Returns:

parseControl

convenient and official location for method that parses control string. This will split on ampersand, and when no ampersands are found then it will try semicolons. This is to support embedding the control string in other control strings (like Autoplot URIs) which use ampersands.

Parameters

Returns:

parseLayoutString

return the size encoded as normalized by the container size and em size.

Parameters

Returns:

See Also:

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

post the message, checking to see that there is a parent first.

Parameters

Returns:

removePropertyChangeListener

Removes a PropertyChangeListener from the listener list.

Parameters

Returns:

render

Render is called whenever the image needs to be refreshed or the content has changed. This operation should occur with an animation-interactive time scale, and an image should be cached when this is not possible. The graphics object will have its origin at the upper-left corner of the screen.

Parameters

Returns:

resetCounters

reset the counters.

Returns:

setActive

set the active property, when false the renderer will not be drawn. This is allows a renderer to be disabled without removing it from the application.

Parameters

Returns:

setBottomDecorator

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

Parameters

Returns:

setColorBar

set a colorbar for the renderer. By default, the renderer simply ignores the colorbar, but instances may introduce special handling. WARNING: some subclasses override this, but do not call super.setColorBar.

Parameters

Returns:

setControl

set the control string which contains a number of properties. These are defined for each renderer, but they should try to be consistent. See http://autoplot.org/developer.guessRenderType#Proposed_extensions When overriding this, be sure to call super.

Parameters

Returns:

See Also:

setDataSet

Set the dataset to be plotted. Different renderers accept QDataSets with different schemes. For example SeriesRenderer takes: ds[t] rank 1 dataset with rank 1 DEPEND_0 or ds[t,n] rank 2 bundle dataset with X in ds[t,0] and Y in ds[t,n-1] and SpectrogramRenderer takes: ds[t,y] rank 2 table dataset ds[n,t,y] rank 3 dataset with the first dimension join See each renderer's documentation for the schemes it takes. Note the lastException property is cleared, even when the dataset is null.

Parameters

Returns:

setDataSetDescriptor

Parameters

Returns:

setDataSetID

Parameters

Returns:

setDataSetLoader

Parameters

Returns:

setDrawLegendLabel

set the switch used to turn off legend label. This allows the label to be hidden without loosing the information it provides.

Parameters

Returns:

setDumpDataSet

Setter for property dumpDataSet setting this to true causes the dataSet to be dumped.

Parameters

Returns:

setException

set the exception to be rendered instead of the dataset.

Parameters

Returns:

setId

Parameters

Returns:

setLastException

TODO: what is the difference between lastException and exception?

Parameters

Returns:

setLegendLabel

set the label to describe the renderer in the plot's legend. If zero-length, then the legend label should be hidden.

Parameters

Returns:

setParent

Parameters

Returns:

setStatsFile

name of the file where rendering speed is recorded.

Parameters

Returns:

setTopDecorator

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

Parameters

Returns:

setUpFont

handle the fontSize property, which has values like "1em" and "7px"

Parameters

Returns:

update

Something has changed with the Render, and the plot should come back to allow this render to repaint. Its cacheImage is invalidated and a repaint is posted on the event thread.

Returns:

updateCacheImage

The cacheImage is invalidated and updateEvent posted on the event thread by calling update.

Returns:

updatePlotImage

updatePlotImage is called once the expensive operation of loading the data is completed. This operation should occur on an interactive time scale. This is an opportunity to create a cache image of the data with the current axis state, when the render operation cannot operate on an animation interactive time scale. Also, several Renders can be updating at once on separate threads, while the render methods must be called sequentially. Only Renderer should call this method! (This should be protected then, but this is not possible because of exiting use. TODO: introduce "revalidate" to replace this operation.)

Parameters

Returns: