Graph2DRenderer (Graphene 0.3 API)

java.lang.Object
- org.epics.graphene.Graph2DRenderer<T>

Direct Known Subclasses:

AreaGraph2DRenderer, BubbleGraph2DRenderer, LineGraph2DRenderer, ScatterGraph2DRenderer
```
public abstract class Graph2DRenderer<T extends Graph2DRendererUpdate>
extends Object
```
The base class for all graph renderers.

Author:

carcassi

Field Summary

Fields
Modifier and Type	Field and Description
`protected Color`	`backgroundColor`
`protected int`	`bottomAreaMargin`
`protected int`	`bottomMargin`
`protected Graphics2D`	`g`
`protected Color`	`labelColor`
`protected Font`	`labelFont`
`protected FontMetrics`	`labelFontMetrics`
`protected int`	`leftAreaMargin`
`protected int`	`leftMargin`
`protected Color`	`referenceLineColor`
`protected int`	`rightAreaMargin`
`protected int`	`rightMargin`
`protected int`	`topAreaMargin`
`protected int`	`topMargin`
`protected int`	`xAreaEnd`
`protected int`	`xAreaStart`
`protected int`	`xLabelMargin`
`protected double`	`xPlotCoordEnd`
`protected double`	`xPlotCoordStart`
`protected double`	`xPlotCoordWidth`
`protected double`	`xPlotValueEnd`
`protected double`	`xPlotValueStart`
`protected org.epics.util.array.ListDouble`	`xReferenceCoords`
`protected List<String>`	`xReferenceLabels`
`protected org.epics.util.array.ListDouble`	`xReferenceValues`
`protected int`	`yAreaEnd`
`protected int`	`yAreaStart`
`protected int`	`yLabelMargin`
`protected double`	`yPlotCoordEnd`
`protected double`	`yPlotCoordHeight`
`protected double`	`yPlotCoordStart`
`protected double`	`yPlotValueEnd`
`protected double`	`yPlotValueStart`
`protected org.epics.util.array.ListDouble`	`yReferenceCoords`
`protected List<String>`	`yReferenceLabels`
`protected org.epics.util.array.ListDouble`	`yReferenceValues`

Constructor Summary

Constructors
Constructor and Description

Graph2DRenderer(int graphWidth, int graphHeight)
Creates a graph renderer.

Constructors
Constructor and Description
`Graph2DRenderer(int graphWidth, int graphHeight)` Creates a graph renderer.

Method Summary

Methods
Modifier and Type	Method and Description
`protected void`	`calculateGraphArea()`
`protected void`	`calculateRanges(Range xDataRange, Range yDataRange)`
`protected void`	`drawBackground()`
`protected void`	`drawGraphArea()`
`protected void`	`drawHorizontalReferenceLines()`
`protected void`	`drawValueExplicitLine(org.epics.util.array.ListNumber xValues, org.epics.util.array.ListNumber yValues, InterpolationScheme interpolation, ReductionScheme reduction)`
`protected void`	`drawValueLine(org.epics.util.array.ListNumber xValues, org.epics.util.array.ListNumber yValues, InterpolationScheme interpolation)`
`protected void`	`drawVerticalReferenceLines()`
`protected void`	`drawXLabels()`
`protected void`	`drawYLabels()`
`int`	`getImageHeight()` The current height of the graph.
`int`	`getImageWidth()` The current width of the graph.
`Range`	`getXAggregatedRange()` The aggregated range of all the data that has been rendered.
`AxisRange`	`getXAxisRange()` The current strategy to calculate the x range for the graph.
`Range`	`getXPlotRange()` The range of the x axis in the last graph rendering.
`Range`	`getYAggregatedRange()` The aggregated range of all the data that has been rendered.
`AxisRange`	`getYAxisRange()` The current strategy to calculate the y range for the graph.
`Range`	`getYPlotRange()` The range of the y axis in the last graph rendering.
`abstract T`	`newUpdate()` Creates a new update for the given graph.
`protected void`	`processScaledValue(int index, double valueX, double valueY, double scaledX, double scaledY)`
`protected double`	`scaledX(double value)`
`protected double`	`scaledY(double value)`
`protected void`	`setClip(Graphics2D g)`
`void`	`update(T update)` Applies the update to the renderer.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

xPlotValueStart
```
protected double xPlotValueStart
```

yPlotValueStart
```
protected double yPlotValueStart
```

xPlotValueEnd
```
protected double xPlotValueEnd
```

yPlotValueEnd
```
protected double yPlotValueEnd
```

yPlotCoordHeight
```
protected double yPlotCoordHeight
```

xPlotCoordWidth
```
protected double xPlotCoordWidth
```

xPlotCoordStart
```
protected double xPlotCoordStart
```

yPlotCoordStart
```
protected double yPlotCoordStart
```

yPlotCoordEnd
```
protected double yPlotCoordEnd
```

xPlotCoordEnd
```
protected double xPlotCoordEnd
```

xAreaStart
```
protected int xAreaStart
```

yAreaStart
```
protected int yAreaStart
```

yAreaEnd
```
protected int yAreaEnd
```

xAreaEnd
```
protected int xAreaEnd
```

g
```
protected Graphics2D g
```

backgroundColor
```
protected Color backgroundColor
```

labelColor
```
protected Color labelColor
```

referenceLineColor
```
protected Color referenceLineColor
```

labelFont
```
protected Font labelFont
```

bottomMargin
```
protected int bottomMargin
```

topMargin
```
protected int topMargin
```

leftMargin
```
protected int leftMargin
```

rightMargin
```
protected int rightMargin
```

bottomAreaMargin
```
protected int bottomAreaMargin
```

topAreaMargin
```
protected int topAreaMargin
```

leftAreaMargin
```
protected int leftAreaMargin
```

rightAreaMargin
```
protected int rightAreaMargin
```

xLabelMargin
```
protected int xLabelMargin
```

yLabelMargin
```
protected int yLabelMargin
```

labelFontMetrics
```
protected FontMetrics labelFontMetrics
```

xReferenceCoords

protected org.epics.util.array.ListDouble xReferenceCoords

xReferenceValues

protected org.epics.util.array.ListDouble xReferenceValues

xReferenceLabels

protected List<String> xReferenceLabels

yReferenceCoords

protected org.epics.util.array.ListDouble yReferenceCoords

yReferenceValues

protected org.epics.util.array.ListDouble yReferenceValues

yReferenceLabels

protected List<String> yReferenceLabels

Constructor Detail
- Graph2DRenderer
```
public Graph2DRenderer(int graphWidth,
               int graphHeight)
```
  Creates a graph renderer.
  
  Parameters:
  graphWidth - the graph width
  graphHeight - the graph height

Method Detail

getImageHeight
```
public int getImageHeight()
```
The current height of the graph.

Returns:
the graph height

getImageWidth
```
public int getImageWidth()
```
The current width of the graph.

Returns:
the graph width

getXAxisRange
```
public AxisRange getXAxisRange()
```
The current strategy to calculate the x range for the graph.

Returns:
the x axis range calculator

getYAxisRange
```
public AxisRange getYAxisRange()
```
The current strategy to calculate the y range for the graph.

Returns:
the y axis range calculator

getXAggregatedRange
```
public Range getXAggregatedRange()
```
The aggregated range of all the data that has been rendered.

Returns:
the aggregated data x range

getYAggregatedRange
```
public Range getYAggregatedRange()
```
The aggregated range of all the data that has been rendered.

Returns:
the aggregated data y range

getXPlotRange
```
public Range getXPlotRange()
```
The range of the x axis in the last graph rendering.

Returns:
the x axis range

getYPlotRange
```
public Range getYPlotRange()
```
The range of the y axis in the last graph rendering.

Returns:
the y axis range

update
```
public void update(T update)
```
Applies the update to the renderer.
When sub-classing, one should re-implement this method by first calling it and then applying all the updates specific to the sub-class.

Parameters:
update - the update to apply

newUpdate
```
public abstract T newUpdate()
```
Creates a new update for the given graph.

Returns:
a new update object

calculateRanges

protected void calculateRanges(Range xDataRange,
                   Range yDataRange)

drawHorizontalReferenceLines

protected void drawHorizontalReferenceLines()

drawVerticalReferenceLines

protected void drawVerticalReferenceLines()

calculateGraphArea
```
protected void calculateGraphArea()
```

drawBackground
```
protected void drawBackground()
```

drawGraphArea
```
protected void drawGraphArea()
```

processScaledValue

protected void processScaledValue(int index,
                      double valueX,
                      double valueY,
                      double scaledX,
                      double scaledY)

drawValueLine

protected void drawValueLine(org.epics.util.array.ListNumber xValues,
                 org.epics.util.array.ListNumber yValues,
                 InterpolationScheme interpolation)

drawValueExplicitLine

protected void drawValueExplicitLine(org.epics.util.array.ListNumber xValues,
                         org.epics.util.array.ListNumber yValues,
                         InterpolationScheme interpolation,
                         ReductionScheme reduction)

scaledX

protected final double scaledX(double value)

scaledY

protected final double scaledY(double value)

setClip
```
protected void setClip(Graphics2D g)
```

drawYLabels
```
protected void drawYLabels()
```

drawXLabels
```
protected void drawXLabels()
```

Class Graph2DRenderer<T extends Graph2DRendererUpdate>

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

xPlotValueStart

yPlotValueStart

xPlotValueEnd

yPlotValueEnd

yPlotCoordHeight

xPlotCoordWidth

xPlotCoordStart

yPlotCoordStart

yPlotCoordEnd

xPlotCoordEnd

xAreaStart

yAreaStart

yAreaEnd

xAreaEnd

g

backgroundColor

labelColor

referenceLineColor

labelFont

bottomMargin

topMargin

leftMargin

rightMargin

bottomAreaMargin

topAreaMargin

leftAreaMargin

rightAreaMargin

xLabelMargin

yLabelMargin

labelFontMetrics

xReferenceCoords

xReferenceValues

xReferenceLabels

yReferenceCoords

yReferenceValues

yReferenceLabels

Constructor Detail

Graph2DRenderer

Method Detail

getImageHeight

getImageWidth

getXAxisRange

getYAxisRange

getXAggregatedRange

getYAggregatedRange

getXPlotRange

getYPlotRange

update

newUpdate

calculateRanges

drawHorizontalReferenceLines

drawVerticalReferenceLines

calculateGraphArea

drawBackground

drawGraphArea

processScaledValue

drawValueLine

drawValueExplicitLine

scaledX

scaledY

setClip

drawYLabels

drawXLabels