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

CONTROL_KEY_SYMBOL

CONTROL_KEY_SYMBOL_SIZE

CONTROL_KEY_FONT_SIZE

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

CONTROL_KEY_REFERENCE

CONTROL_KEY_DRAW_ERROR

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

decodePlotSymbolConnectorControl

decodePlotSymbolConnectorControl( String s, org.das2.graph.PsymConnector deflt ) → PsymConnector

decode the string into a plot symbol.

Parameters

s - the symbol name, such as none, dashes, dashFine
deflt - the symbol to use when the value is not parsed.

Returns:

the parsed value.

search for examples view on GitHub view source

decodePlotSymbolControl

decodePlotSymbolControl( String s, org.das2.graph.PlotSymbol deflt ) → PlotSymbol

decode the string into a plot symbol.

Parameters

s - the symbol name, such as none, circles, triangles, cross, ex, star, diamond, box
deflt - the symbol to use when the value is not parsed.

Returns:

the parsed value.

search for examples view on GitHub view source

encodeBooleanControl

encodeBooleanControl( boolean v ) → String

return the encoding for the boolean value.

Parameters

v - the boolean value.

Returns:

"T" or "F"

search for examples view on GitHub view source

encodeColorControl

encodeColorControl( java.awt.Color color ) → String

encode the Color control.

Parameters

color -

Returns:

the color encoded as a string.

See Also:

ColorUtil#encodeColor(java.awt.Color)


search for examples view on GitHub view source

encodePlotSymbolConnectorControl

encodePlotSymbolConnectorControl( org.das2.graph.PsymConnector psymConnector ) → String

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

Parameters

psymConnector -

Returns:

the string encoding.

search for examples view on GitHub view source

encodePlotSymbolControl

encodePlotSymbolControl( org.das2.graph.PlotSymbol psym ) → String

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

Parameters

psym - the plot symbol.

Returns:

the string encoding.

search for examples view on GitHub view source

formatControl

formatControl( java.util.Map c ) → String

convenient and official location for method that formats control string.

Parameters

c -

Returns:

java.lang.String

search for examples view on GitHub view source

getBooleanControl

getBooleanControl( String key, boolean deft ) → boolean

get the boolean control.

Parameters

key - the key name.
deft - the default value.

Returns:

the boolean value, where "T" is true, false otherwise; or the default when the value is not found.

search for examples view on GitHub view source

getBottomDecorator

getBottomDecorator( ) → Painter

Returns:

org.das2.graph.Painter

search for examples view on GitHub view source

getColorControl

getColorControl( String key, java.awt.Color deft ) → Color

get the Color control.

Parameters

key - the key name.
deft - the default value

Returns:

the Color or the default when the value is not found.

See Also:

ColorUtil#decodeColor(java.lang.String)


search for examples view on GitHub view source

getConsumedDataSet

getConsumedDataSet( ) → QDataSet

return the data for DataSetConsumer, which might be rebinned.

Returns:

org.das2.qds.QDataSet

search for examples view on GitHub view source

getDataLoader

getDataLoader( ) → DataLoader

Returns:

org.das2.graph.DataLoader

search for examples view on GitHub view source

getDataSetDescriptor

getDataSetDescriptor( ) → DataSetDescriptor

Returns:

org.das2.dataset.DataSetDescriptor

search for examples view on GitHub view source

getDataSetID

getDataSetID( ) → String

Returns:

java.lang.String

search for examples view on GitHub view source

getDatumControl

getDatumControl( String key, Datum deft ) → Datum

get the Datum control.

Parameters

key - the key name.
deft - the default value, which also provides the units.

Returns:

the Datum or the default when the value is not found.

search for examples view on GitHub view source

getDoubleArrayControl

getDoubleArrayControl( String key, double[] deft ) → double

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

Parameters

key - the key name.
deft - the default value.

Returns:

the double array, each element parsed with Double.parseDouble or the default when the value is not found.

search for examples view on GitHub view source

getDoubleControl

getDoubleControl( String key, double deft ) → double

get the double control.

Parameters

key - the key name.
deft - the default value.

Returns:

the double, parsed with Double.parseDouble; or the default when the value is not found.

search for examples view on GitHub view source

getIntegerControl

getIntegerControl( String key, int deft ) → int

get the integer control.

Parameters

key - the key name.
deft - the default value.

Returns:

the int, parsed with Integer.parseInt; or the default when the value is not found.

search for examples view on GitHub view source

getLastException

getLastException( ) → Exception

Returns:

java.lang.Exception

search for examples view on GitHub view source

getLegendLabel

getLegendLabel( ) → String

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

Returns:

the label to describe the renderer

search for examples view on GitHub view source

getRenderCount

getRenderCount( ) → int

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

Returns:

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

search for examples view on GitHub view source

getStatsFile

getStatsFile( ) → String

Returns:

java.lang.String

search for examples view on GitHub view source

getTopDecorator

getTopDecorator( ) → Painter

Returns:

org.das2.graph.Painter

search for examples view on GitHub view source

getUpdateCount

getUpdateCount( ) → int

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

Returns:

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

search for examples view on GitHub view source

getXmemento

getXmemento( ) → Memento

Returns:

org.das2.graph.DasAxis.Memento

search for examples view on GitHub view source

getYmemento

getYmemento( ) → Memento

Returns:

org.das2.graph.DasAxis.Memento

search for examples view on GitHub view source

hasControl

hasControl( String key ) → boolean

return true if the control is specified.

Parameters

key - the key name

Returns:

true if the control is specified.

search for examples view on GitHub view source

isActive

isActive( ) → boolean

true when the renderer should be drawn.

Returns:

true when the renderer should be drawn.

search for examples view on GitHub view source

isDrawLegendLabel

isDrawLegendLabel( ) → boolean

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

Returns:

true if the legend label should be drawn

search for examples view on GitHub view source

isDumpDataSet

isDumpDataSet( ) → boolean

Getter for property dumpDataSet.

Returns:

Value of property dumpDataSet.

search for examples view on GitHub view source

parseControl

parseControl( String c ) → Map

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

c - the control string or null.

Returns:

the control string, parsed.

search for examples view on GitHub view source

resetCounters

resetCounters( ) → void

reset the counters.

Returns:

void (returns nothing)

search for examples view on GitHub view source

setBottomDecorator

setBottomDecorator( org.das2.graph.Painter bottomDecorator ) → void

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

Parameters

bottomDecorator - the Painter to call, or null to clear.

Returns:

void (returns nothing)

search for examples view on GitHub view source

setDataSetDescriptor

setDataSetDescriptor( org.das2.dataset.DataSetDescriptor dsd ) → void

Returns:

void (returns nothing)

search for examples view on GitHub view source

setDataSetID

setDataSetID( String id ) → void

Returns:

void (returns nothing)

search for examples view on GitHub view source

setDataSetLoader

setDataSetLoader( org.das2.graph.DataLoader loader ) → void

Returns:

void (returns nothing)

search for examples view on GitHub view source

setDrawLegendLabel

setDrawLegendLabel( boolean drawLegendLabel ) → void

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

Parameters

drawLegendLabel - true if the legend label should be drawn

Returns:

void (returns nothing)

search for examples view on GitHub view source

setDumpDataSet

setDumpDataSet( boolean dumpDataSet ) → void

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

Parameters

dumpDataSet - New value of property dumpDataSet.

Returns:

void (returns nothing)

search for examples view on GitHub view source

setException

setException( java.lang.Exception e ) → void

set the exception to be rendered instead of the dataset.

Parameters

e -

Returns:

void (returns nothing)

search for examples view on GitHub view source

setId

setId( String id ) → void

Returns:

void (returns nothing)

search for examples view on GitHub view source

setLastException

setLastException( java.lang.Exception e ) → void

TODO: what is the difference between lastException and exception?

Parameters

e -

Returns:

void (returns nothing)

search for examples view on GitHub view source

setLegendLabel

setLegendLabel( String legendLabel ) → void

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

Parameters

legendLabel - the label to describe the renderer

Returns:

void (returns nothing)

search for examples view on GitHub view source

setStatsFile

setStatsFile( String recordFile ) → void

name of the file where rendering speed is recorded.

Parameters

recordFile -

Returns:

void (returns nothing)

search for examples view on GitHub view source

setTopDecorator

setTopDecorator( org.das2.graph.Painter topDecorator ) → void

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

Parameters

topDecorator - the Painter to call, or null to clear.

Returns:

void (returns nothing)

search for examples view on GitHub view source

setUpFont

setUpFont( java.awt.Font f, String fontSize ) → Font

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

Parameters

f - the parent font.
fontSize - fontSize property, for example "1em" and "7px"

Returns:

the relative font.

search for examples view on GitHub view source

updateCacheImage

updateCacheImage( ) → void

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

Returns:

void (returns nothing)

search for examples view on GitHub view source