Graph2DRenderer (Graphene 0.4 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()` Calculates the graph area based on: The image size The plot ranges The value scales The font for the labels The margins
`protected void`	`calculateRanges(Range xDataRange, Range yDataRange)` Given the new data ranges, calculates the new aggregated and plot ranges.
`protected void`	`drawBackground()` Draws the background with the background color.
`protected void`	`drawGraphArea()` Draw the calculated graph area.
`protected void`	`drawHorizontalReferenceLines()` Draws the horizontal reference lines based on the calculated graph area.
`protected void`	`drawValueExplicitLine(org.epics.util.array.ListNumber xValues, org.epics.util.array.ListNumber yValues, InterpolationScheme interpolation, ReductionScheme reduction)` Draws an explicit line give the interpolation and reduction schemes, the x values and the y values.
`protected void`	`drawValueLine(org.epics.util.array.ListNumber xValues, org.epics.util.array.ListNumber yValues, InterpolationScheme interpolation)` Draws an implicit line given the interpolation scheme and the x,y values.
`protected void`	`drawVerticalReferenceLines()`
`protected void`	`drawXLabels()` Draw the horizontal labels based on the calculated graph area.
`protected void`	`drawYLabels()` Draw the vertical labels based on the calculated graph area.
`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)` Scale the x value to the graph area.
`protected double`	`scaledY(double value)` Scale the y value to the graph area.
`protected void`	`setClip(Graphics2D g)` Sets the clip area to the actual graph area
`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)
```
    Given the new data ranges, calculates the new aggregated and plot ranges.
    
    Parameters:
    xDataRange - the new data range for x
    yDataRange - the new data range for y
  - drawHorizontalReferenceLines
```
protected void drawHorizontalReferenceLines()
```
    Draws the horizontal reference lines based on the calculated graph area.
  - drawVerticalReferenceLines
```
protected void drawVerticalReferenceLines()
```
  - calculateGraphArea
```
protected void calculateGraphArea()
```
    Calculates the graph area based on:
    - The image size
    - The plot ranges
    - The value scales
    - The font for the labels
    - The margins
  - drawBackground
```
protected void drawBackground()
```
    Draws the background with the background color.
  - drawGraphArea
```
protected void drawGraphArea()
```
    Draw the calculated graph area. Draws the background, the reference lines and the labels.
  - 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)
```
    Draws an implicit line given the interpolation scheme and the x,y values. The function will scale the values.
    
    Parameters:
    xValues - the x values
    yValues - the y values
    interpolation - the interpolation scheme
  - drawValueExplicitLine
```
protected void drawValueExplicitLine(org.epics.util.array.ListNumber xValues,
                         org.epics.util.array.ListNumber yValues,
                         InterpolationScheme interpolation,
                         ReductionScheme reduction)
```
    Draws an explicit line give the interpolation and reduction schemes, the x values and the y values. The function will scale the values.
    
    Parameters:
    xValues - the x values
    yValues - the y values
    interpolation - the interpolation
    reduction - the reduction
  - scaledX
```
protected final double scaledX(double value)
```
    Scale the x value to the graph area.
    
    Parameters:
    value - the x value
    
    Returns:
    the x position in the graph area
  - scaledY
```
protected final double scaledY(double value)
```
    Scale the y value to the graph area.
    
    Parameters:
    value - the y value
    
    Returns:
    the y position in the graph area
  - setClip
```
protected void setClip(Graphics2D g)
```
    Sets the clip area to the actual graph area
    
    Parameters:
    g - the graphics context
  - drawYLabels
```
protected void drawYLabels()
```
    Draw the vertical labels based on the calculated graph area.
  - drawXLabels
```
protected void drawXLabels()
```
    Draw the horizontal labels based on the calculated graph area.

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