org.epics.graphene

Class Graph2DRendererUpdate<T extends Graph2DRendererUpdate<T>>

java.lang.Object

org.epics.graphene.Graph2DRendererUpdate<T>

Direct Known Subclasses:

AreaGraph2DRendererUpdate, BubbleGraph2DRendererUpdate, IntensityGraph2DRendererUpdate, LineGraph2DRendererUpdate, MultilineGraph2DRendererUpdate, ScatterGraph2DRendererUpdate, SparklineGraph2DRendererUpdate

public class Graph2DRendererUpdate<T extends Graph2DRendererUpdate<T>>
extends Object

Author:

carcassi

Constructor Summary

Constructors

Constructor and Description
Graph2DRendererUpdate()

Method Summary

Methods

Modifier and Type	Method and Description
T	allAreaMargins(int areaMarginSize) Updates the parameter for all margins (top, bottom, left, right) of the graph area.
T	allLabelMargins(int labelMarginSize) Updates the parameter for the margins for the labels on both axes.
T	allMargins(int marginSize) Updates the parameter for all margins (top, bottom, left, right).
T	backgroundColor(Color backgroundColor) Updates the parameter for the color of the image background.
T	bottomAreaMargin(int bottomAreaMargin) Updates the parameter for margin at the bottom of the graph area.
T	bottomMargin(int bottomMargin) Updates the parameter for margin at the bottom.
Color	getBackgroundColor() Gets background color of the image.
Integer	getBottomAreaMargin() Gets the margin between the bottom of the graph area and the axes/labels area.
Integer	getBottomMargin() Gets the margin between the bottom of the image and the bottom of the axes/labels area.
Integer	getImageHeight() Gets height of image.
Integer	getImageWidth() Gets width of image.
Color	getLabelColor() Gets color of labels for the axes.
Font	getLabelFont() Gets font of labels for the axes.
Integer	getLeftAreaMargin() Gets the margin between the left of the graph area and the axes/labels area.
Integer	getLeftMargin() Gets the margin between the left of the image and the left of the axes/labels area.
Color	getReferenceLineColor() Gets color of reference lines on the graph area.
Integer	getRightAreaMargin() Gets the margin between the right of the graph area and the axes/labels area.
Integer	getRightMargin() Gets the margin between the right of the image and the right of the axes/labels area.
Integer	getTopAreaMargin() Gets the margin between the top of the graph area and the axes/labels area.
Integer	getTopMargin() Gets the margin between the top of the image and the top of the axes/labels area.
AxisRange	getXAxisRange() Gets x-axis range.
Integer	getXLabelMargin() Gets the margin separating x-axis labels from the graph area.
ValueScale	getXValueScale() Gets the scaling tool to scale down the values on the x-axis.
AxisRange	getYAxisRange() Gets y-axis range.
Integer	getYLabelMargin() Gets the margin separating y-axis labels from the graph area.
ValueScale	getYValueScale() Gets the scaling tool to scale down the values on the y-axis.
T	imageHeight(int height) Updates the parameter for the height of the image that is rendered.
T	imageWidth(int width) Updates the parameter for the width of the image that is rendered.
T	labelColor(Color labelColor) Updates the parameter for the color of the labels for axes.
T	labelFont(Font labelFont) Updates the parameter for the font of the labels for axes.
T	leftAreaMargin(int leftAreaMargin) Updates the parameter for margin at the left of the graph area.
T	leftMargin(int leftMargin) Updates the parameter for margin at the left.
T	referenceLineColor(Color referenceLineColor) Updates the parameter for the color of the reference lines on the background.
T	rightAreaMargin(int rightAreaMargin) Updates the parameter for margin at the right of the graph area.
T	rightMargin(int rightMargin) Updates the parameter for margin at the right.
protected T	self() Gets the update.
T	topAreaMargin(int topAreaMargin) Updates the parameter for margin at the top of the graph area.
T	topMargin(int topMargin) Updates the parameter for margin at the top.
T	xAxisRange(AxisRange xAxisRange) Updates the parameter for the range (max - min) of the values on the x-axis.
T	xLabelMargin(int xLabelMargin) Updates the parameter for the margin for the labels on the x-axis.
T	xValueScale(ValueScale xValueScale) Updates the parameter for the scaling on the x-axis.
T	yAxisRange(AxisRange yAxisRange) Updates the parameter for the range (max - min) of the values on the y-axis.
T	yLabelMargin(int yLabelMargin) Updates the parameter for the margin for the labels on the y-axis.
T	yValueScale(ValueScale yValueScale) Updates the parameter for the scaling on the y-axis.

Methods inherited from class java.lang.Object

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

Constructor Detail

Graph2DRendererUpdate

public Graph2DRendererUpdate()

Method Detail

self

protected T self()

Gets the update. Casts this appropriately. For all subclasses, casts the objects as the subclass object (not Graph2DRendererUpdate).

Returns:

this, casted as the appropriate object type

imageHeight

public T imageHeight(int height)

Updates the parameter for the height of the image that is rendered. The height must be greater than zero.

Parameters:

height - size of image height in pixels

Returns:

this

imageWidth

public T imageWidth(int width)

Updates the parameter for the width of the image that is rendered. The width must be greater than zero.

Parameters:

width - size of image width in pixels

Returns:

this

xAxisRange

public T xAxisRange(AxisRange xAxisRange)

Updates the parameter for the range (max - min) of the values on the x-axis.

Parameters:

xAxisRange - specifies the x-axis range (composed of the data range and the aggregated data range)

Returns:

this

yAxisRange

public T yAxisRange(AxisRange yAxisRange)

Updates the parameter for the range (max - min) of the values on the y-axis.

Parameters:

yAxisRange - specifies the y-axis range (composed of the data range and the aggregated data range)

Returns:

this

xValueScale

public T xValueScale(ValueScale xValueScale)

Updates the parameter for the scaling on the x-axis. This will enable actual data to be scaled to a specified min and max.

Parameters:

xValueScale - tool used for changing actual data to scaled data on the x-axis.

Returns:

this

yValueScale

public T yValueScale(ValueScale yValueScale)

Updates the parameter for the scaling on the y-axis. This will enable actual data to be scaled to a specified min and max.

Parameters:

yValueScale - tool used for changing actual data to scaled data on the y-axis.

Returns:

this

backgroundColor

public T backgroundColor(Color backgroundColor)

Updates the parameter for the color of the image background.

Parameters:

backgroundColor - color of image background

Returns:

this

labelColor

public T labelColor(Color labelColor)

Updates the parameter for the color of the labels for axes.

Parameters:

labelColor - color of labels

Returns:

this

referenceLineColor

public T referenceLineColor(Color referenceLineColor)

Updates the parameter for the color of the reference lines on the background.

Parameters:

referenceLineColor - color of reference lines

Returns:

this

labelFont

public T labelFont(Font labelFont)

Updates the parameter for the font of the labels for axes.

Parameters:

labelFont - font used for labels

Returns:

this

bottomMargin

public T bottomMargin(int bottomMargin)

Updates the parameter for margin at the bottom. This margin splits the bottom of the image from the bottom of the graph area. The margin size must be a non-negative integer.

Parameters:

bottomMargin - margin at bottom of image in pixels

Returns:

this

topMargin

public T topMargin(int topMargin)

Updates the parameter for margin at the top. This margin splits the top of the image from the top of the label/axis area. The margin size must be a non-negative integer.

Parameters:

topMargin - margin at top of image in pixels

Returns:

this

leftMargin

public T leftMargin(int leftMargin)

Updates the parameter for margin at the left. This margin splits the left of the image from the left of the label/axis area. The margin size must be a non-negative integer.

Parameters:

leftMargin - margin at top of image in pixels

Returns:

this

rightMargin

public T rightMargin(int rightMargin)

Updates the parameter for margin at the right. This margin splits the right of the image from the right of the label/axis area. The margin size must be a non-negative integer.

Parameters:

rightMargin - margin at right of image in pixels

Returns:

this

allMargins

public T allMargins(int marginSize)

Updates the parameter for all margins (top, bottom, left, right). All margins are set to the same size. This margin region splits the edge of the image from the edge of the label/axis area. The margin size must be a non-negative integer.

Parameters:

marginSize - margin on all sides of image in pixels

Returns:

this

bottomAreaMargin

public T bottomAreaMargin(int bottomAreaMargin)

Updates the parameter for margin at the bottom of the graph area. This margin splits the bottom of the graph area (where the line is drawn) from the bottom of the label/axis area. The margin size must be a non-negative integer.

Parameters:

bottomAreaMargin - margin at bottom of the graph area in pixels

Returns:

this

topAreaMargin

public T topAreaMargin(int topAreaMargin)

Updates the parameter for margin at the top of the graph area. This margin splits the top of the graph area (where the line is drawn) from the top of the label/axis area. The margin size must be a non-negative integer.

Parameters:

topAreaMargin - margin at top of the graph area in pixels

Returns:

this

leftAreaMargin

public T leftAreaMargin(int leftAreaMargin)

Updates the parameter for margin at the left of the graph area. This margin splits the left of the graph area (where the line is drawn) from the left of the label/axis area. The margin size must be a non-negative integer.

Parameters:

leftAreaMargin - margin at left of the graph area in pixels

Returns:

this

rightAreaMargin

public T rightAreaMargin(int rightAreaMargin)

Updates the parameter for margin at the right of the graph area. This margin splits the right of the graph area (where the line is drawn) from the right of the label/axis area. The margin size must be a non-negative integer.

Parameters:

rightAreaMargin - margin at right of the graph area in pixels

Returns:

this

allAreaMargins

public T allAreaMargins(int areaMarginSize)

Updates the parameter for all margins (top, bottom, left, right) of the graph area. All margins are set to the same size. This margin splits the all edges of the graph area (where the line is drawn) from all edges of the label/axis area. The margin size must be a non-negative integer.

Parameters:

areaMarginSize - margin on all sides of graph area in pixels

Returns:

this

xLabelMargin

public T xLabelMargin(int xLabelMargin)

Updates the parameter for the margin for the labels on the x-axis. This margin splits the area for the x-axis labels from the graph area. The margin size must be a non-negative integer.

Parameters:

xLabelMargin - margin for the x-axis labels in pixels

Returns:

this

yLabelMargin

public T yLabelMargin(int yLabelMargin)

Updates the parameter for the margin for the labels on the y-axis. This margin splits the area for the y-axis labels from the graph area. The margin size must be a non-negative integer.

Parameters:

yLabelMargin - margin for the y-axis labels in pixels

Returns:

this

allLabelMargins

public T allLabelMargins(int labelMarginSize)

Updates the parameter for the margins for the labels on both axes. This margin splits the area for the labels on both axes from the graph area. The margin size must be a non-negative integer.

Parameters:

labelMarginSize - margin for the x-axis and y-axis labels in pixels

Returns:

this

getImageHeight

public Integer getImageHeight()

Gets height of image. Ensured as a positive non-zero integer.

Returns:

the height of the image in pixels

getImageWidth

public Integer getImageWidth()

Gets width of image. Ensured as a positive non-zero integer.

Returns:

the width of the image in pixels

getXAxisRange

public AxisRange getXAxisRange()

Gets x-axis range.

Returns:

range (of data and of aggregated data) of the values on the x-axis

getYAxisRange

public AxisRange getYAxisRange()

Gets y-axis range.

Returns:

range (of data and of aggregated data) of the values on the y-axis

getXValueScale

public ValueScale getXValueScale()

Gets the scaling tool to scale down the values on the x-axis.

Returns:

the scaling on the x-axis

getYValueScale

public ValueScale getYValueScale()

Gets the scaling tool to scale down the values on the y-axis.

Returns:

the scaling on the y-axis

getBackgroundColor

public Color getBackgroundColor()

Gets background color of the image.

Returns:

the color of the background of the image

getLabelColor

public Color getLabelColor()

Gets color of labels for the axes.

Returns:

the color of the label of the axes

getReferenceLineColor

public Color getReferenceLineColor()

Gets color of reference lines on the graph area.

Returns:

the color of the reference lines on the graph area

getLabelFont

public Font getLabelFont()

Gets font of labels for the axes.

Returns:

the font for the labels on the axes

getBottomMargin

public Integer getBottomMargin()

Gets the margin between the bottom of the image and the bottom of the axes/labels area. Ensured as a non-negative integer.

Returns:

the bottom margin for the image and the axes area

getTopMargin

public Integer getTopMargin()

Gets the margin between the top of the image and the top of the axes/labels area. Ensured as a non-negative integer.

Returns:

the bottom margin for the image and the axes area

getLeftMargin

public Integer getLeftMargin()

Gets the margin between the left of the image and the left of the axes/labels area. Ensured as a non-negative integer.

Returns:

the left margin for the image and the axes area

getRightMargin

public Integer getRightMargin()

Gets the margin between the right of the image and the right of the axes/labels area. Ensured as a non-negative integer.

Returns:

the right margin for the image and the axes area

getBottomAreaMargin

public Integer getBottomAreaMargin()

Gets the margin between the bottom of the graph area and the axes/labels area.

Returns:

the bottom margin for the image and the axes area

getTopAreaMargin

public Integer getTopAreaMargin()

Gets the margin between the top of the graph area and the axes/labels area.

Returns:

the top margin for the image and the axes area

getLeftAreaMargin

public Integer getLeftAreaMargin()

Gets the margin between the left of the graph area and the axes/labels area.

Returns:

the left margin for the image and the axes area

getRightAreaMargin

public Integer getRightAreaMargin()

Gets the margin between the right of the graph area and the axes/labels area.

Returns:

the right margin for the image and the axes area

getXLabelMargin

public Integer getXLabelMargin()

Gets the margin separating x-axis labels from the graph area.

Returns:

the margin for the x-axis labels from the graph area

getYLabelMargin

public Integer getYLabelMargin()

Gets the margin separating y-axis labels from the graph area.

Returns:

the margin for the y-axis labels from the graph area