org.epics.graphene

Class SparklineGraph2DRendererUpdate

java.lang.Object

org.epics.graphene.Graph2DRendererUpdate<SparklineGraph2DRendererUpdate>

org.epics.graphene.SparklineGraph2DRendererUpdate

public class SparklineGraph2DRendererUpdate
extends Graph2DRendererUpdate<SparklineGraph2DRendererUpdate>

A set of parameters that can be applied to a SparklineGraph2DRenderer to update it's settings.

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

• Colors of the circles drawn at the important data points of a sparkline graph
• Size of the circles drawn at the important data points
• Whether to draw circles at the important data points
• Interpolation scheme used in drawing the sparkline line
• Aspect ratio to be maintained in the graph area

Author:

asbarber, jkfeng, sjdallst

Constructor Summary

Constructors

Constructor and Description
SparklineGraph2DRendererUpdate()

Method Summary

Methods

Modifier and Type	Method and Description
SparklineGraph2DRendererUpdate	aspectRatio(double ratio) Sets the width to height aspect ratio for the graph area.
SparklineGraph2DRendererUpdate	circleDiameter(int diameter) Sets the diameter of the circles drawn.
SparklineGraph2DRendererUpdate	drawCircles(boolean decision) Sets whether circles are drawn on the line at important values.
Double	getAspectRatio() Gets the width to height aspect ratio of the graph area
Integer	getCircleDiameter() Gets the diameter of the circle.
Boolean	getDrawCircles() Gets the decision for whether circles are drawn.
InterpolationScheme	getInterpolation() Gets the interpolation scheme of the line.
Color	getLastValueColor() Gets the color of the circle drawn for the last value.
Color	getMaxValueColor() Gets the color of the circle drawn for the maximum value.
Color	getMinValueColor() Gets the color of the circle drawn for the minimum value.
SparklineGraph2DRendererUpdate	interpolation(InterpolationScheme scheme) Sets the interpolation scheme of the line.
SparklineGraph2DRendererUpdate	lastValueColor(Color color) Sets the color of the circle drawn at the last value.
SparklineGraph2DRendererUpdate	maxValueColor(Color color) Sets the color of the circle drawn at the maximum value.
SparklineGraph2DRendererUpdate	minValueColor(Color color) Sets the color of the circle drawn at the minimum value.

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

SparklineGraph2DRendererUpdate

public SparklineGraph2DRendererUpdate()

Method Detail

minValueColor

public SparklineGraph2DRendererUpdate minValueColor(Color color)

Sets the color of the circle drawn at the minimum value.

Parameters:

color - color for the minimum value circle

Returns:

this

maxValueColor

public SparklineGraph2DRendererUpdate maxValueColor(Color color)

Sets the color of the circle drawn at the maximum value.

Parameters:

color - color for the maximum value circle

Returns:

this

lastValueColor

public SparklineGraph2DRendererUpdate lastValueColor(Color color)

Sets the color of the circle drawn at the last value.

Parameters:

color - color for the last value circle

Returns:

this

circleDiameter

public SparklineGraph2DRendererUpdate circleDiameter(int diameter)

Sets the diameter of the circles drawn.

Parameters:

diameter - size of circle diameter in pixels

Returns:

this

drawCircles

public SparklineGraph2DRendererUpdate drawCircles(boolean decision)

Sets whether circles are drawn on the line at important values.

Parameters:

decision - whether circles are drawn

Returns:

this

interpolation

public SparklineGraph2DRendererUpdate interpolation(InterpolationScheme scheme)

Sets the interpolation scheme of the line.

Parameters:

scheme - new interpolation scheme

Returns:

this

aspectRatio

public SparklineGraph2DRendererUpdate aspectRatio(double ratio)

Sets the width to height aspect ratio for the graph area.

Parameters:

ratio - ratio between width and height that should be maintained

Returns:

this

getMinValueColor

public Color getMinValueColor()

Gets the color of the circle drawn for the minimum value.

Returns:

color of the circle at the minimum

getMaxValueColor

public Color getMaxValueColor()

Gets the color of the circle drawn for the maximum value.

Returns:

color of the circle at the maximum

getLastValueColor

public Color getLastValueColor()

Gets the color of the circle drawn for the last value.

Returns:

color of the circle at the last index

getCircleDiameter

public Integer getCircleDiameter()

Gets the diameter of the circle.

Returns:

size of the diameter of the circles drawn in pixels

getDrawCircles

public Boolean getDrawCircles()

Gets the decision for whether circles are drawn.

Returns:

whether circles are drawn

getInterpolation

public InterpolationScheme getInterpolation()

Gets the interpolation scheme of the line.

Returns:

interpolation scheme for the line

getAspectRatio

public Double getAspectRatio()

Gets the width to height aspect ratio of the graph area

Returns:

width to height aspect ratio