org.epics.graphene

Class IntensityGraph2DRendererUpdate

java.lang.Object

org.epics.graphene.Graph2DRendererUpdate<IntensityGraph2DRendererUpdate>

org.epics.graphene.IntensityGraph2DRendererUpdate

public class IntensityGraph2DRendererUpdate
extends Graph2DRendererUpdate<IntensityGraph2DRendererUpdate>

A set of parameters that can be applied to a IntensityGraph2DRenderer to update its settings.

Only the parameters that are set in the update get applied to the renderer. Parameters unique to the intensity graph that can be changed are:

• zLabel margin size
• Legend pixel width
• Legend margin size between the legend and graph
• Legend margin size between the legend and the image edge

Author:

carcassi, sjdallst

Constructor Summary

Constructors

Constructor and Description
IntensityGraph2DRendererUpdate()

Method Summary

Methods

Modifier and Type	Method and Description
IntensityGraph2DRendererUpdate	drawLegend(boolean drawLegend) Sets this object's drawLegend to the given boolean value.
Boolean	getDrawLegend()
Integer	getLegendMarginToEdge()
Integer	getLegendMarginToGraph()
Integer	getLegendWidth()
ColorScheme	getValueColorScheme()
Integer	getZLabelMargin()
IntensityGraph2DRendererUpdate	legendMarginToEdge(int margin) Sets this object's legendMarginToEdge to the given margin size.
IntensityGraph2DRendererUpdate	legendMarginToGraph(int margin) Sets this object's legendMarginToGraph to the given margin size.
IntensityGraph2DRendererUpdate	legendWidth(int width) Sets this object's legendWidth to the given margin size.
IntensityGraph2DRendererUpdate	valueColorScheme(ColorScheme scheme) Sets this object's valueColorScheme to the given ColorScheme.
IntensityGraph2DRendererUpdate	zLabelMargin(int margin) Sets this object's zLabelMargin to the given margin size.

Methods inherited from class org.epics.graphene.Graph2DRendererUpdate

allAreaMargins, allLabelMargins, allMargins, backgroundColor, bottomAreaMargin, bottomMargin, getBackgroundColor, getBottomAreaMargin, getBottomMargin, getImageHeight, getImageWidth, getLabelColor, getLabelFont, getLeftAreaMargin, getLeftMargin, getReferenceLineColor, getRightAreaMargin, getRightMargin, getTopAreaMargin, getTopMargin, getXAxisRange, getXLabelMargin, getXValueScale, getYAxisRange, getYLabelMargin, getYValueScale, imageHeight, imageWidth, labelColor, labelFont, leftAreaMargin, leftMargin, referenceLineColor, rightAreaMargin, rightMargin, self, topAreaMargin, topMargin, xAxisRange, xLabelMargin, xValueScale, yAxisRange, yLabelMargin, yValueScale

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

IntensityGraph2DRendererUpdate

public IntensityGraph2DRendererUpdate()

Method Detail

drawLegend

public IntensityGraph2DRendererUpdate drawLegend(boolean drawLegend)

Sets this object's drawLegend to the given boolean value. To be used in conjunction with IntensityGraph2DRenderer's update function.

Parameters:

drawLegend - boolean that will tell IntensityGraph2DRenderer whether or not it should draw a legend

Returns:

this

valueColorScheme

public IntensityGraph2DRendererUpdate valueColorScheme(ColorScheme scheme)

Sets this object's valueColorScheme to the given ColorScheme.

Parameters:

scheme - supported schemes: any ColorScheme supported by the ValueColorSchemes

Returns:

this

zLabelMargin

public IntensityGraph2DRendererUpdate zLabelMargin(int margin)

Sets this object's zLabelMargin to the given margin size.

Parameters:

margin - integer distance(pixels) from the beginning of the z labels to the legend.

Returns:

this

legendWidth

public IntensityGraph2DRendererUpdate legendWidth(int width)

Sets this object's legendWidth to the given margin size.

Parameters:

width - corresponds to the x-axis

Returns:

this

legendMarginToGraph

public IntensityGraph2DRendererUpdate legendMarginToGraph(int margin)

Sets this object's legendMarginToGraph to the given margin size.

Parameters:

margin - distance(pixels) from the intensity graph to the legend.

Returns:

this

legendMarginToEdge

public IntensityGraph2DRendererUpdate legendMarginToEdge(int margin)

Sets this object's legendMarginToEdge to the given margin size.

Parameters:

margin - distance(pixels) from the end of the legend(including labels and other margins) to the end of the graphics component.

Returns:

this

getDrawLegend

public Boolean getDrawLegend()

Returns:

Boolean drawLegend, used to determine whether an IntensityGraph2DRenderer object will add a legend to the right of the intensity graph. Can be null.

getValueColorScheme

public ColorScheme getValueColorScheme()

Returns:

ColorScheme valueColorScheme, used to determine which color scheme will be used when drawing an intensity graph. Possible values include: GRAY_SCALE, JET, HOT, COOL, SPRING, BONE, COPPER, PINK

getZLabelMargin

public Integer getZLabelMargin()

Returns:

Integer zLabelMargin, distance(pixels) from the beginning of the z labels to the legend.

getLegendWidth

public Integer getLegendWidth()

Returns:

Integer legendWidth, corresponds to the x-axis length.

getLegendMarginToGraph

public Integer getLegendMarginToGraph()

Returns:

Integer legendMarginToGraph, distance(pixels) from the intensity graph to the legend.

getLegendMarginToEdge

public Integer getLegendMarginToEdge()

Returns:

Integer legendMarginToEdge, distance(pixels) from the end of the legend(including labels and other margins) to the end of the graphics component.