public class

XYAreaRenderer

extends AbstractXYItemRenderer
implements XYItemRenderer
java.lang.Object
   ↳ org.jfree.chart.renderer.AbstractRenderer
     ↳ org.jfree.chart.renderer.xy.AbstractXYItemRenderer
       ↳ org.jfree.chart.renderer.xy.XYAreaRenderer
Known Direct Subclasses

Class Overview

Area item renderer for an XYPlot. This class can draw (a) shapes at each point, or (b) lines between points, or (c) both shapes and lines, or (d) filled areas, or (e) filled areas and shapes. The example shown here is generated by the XYAreaRendererDemo1.java program included in the JFreeChart demo collection:

XYAreaRendererSample.png

Summary

Constants
int AREA Useful constant for specifying the type of rendering (area only).
int AREA_AND_SHAPES Useful constant for specifying the type of rendering (area and shapes).
int LINES Useful constant for specifying the type of rendering (lines only).
int SHAPES Useful constant for specifying the type of rendering (shapes only).
int SHAPES_AND_LINES Useful constant for specifying the type of rendering (shapes and lines).
[Expand]
Inherited Fields
From class org.jfree.chart.renderer.AbstractRenderer
Public Constructors
XYAreaRenderer()
Constructs a new renderer.
XYAreaRenderer(int type)
Constructs a new renderer.
XYAreaRenderer(int type, XYToolTipGenerator toolTipGenerator, XYURLGenerator urlGenerator)
Constructs a new renderer.
Public Methods
Object clone()
Returns a clone of the renderer.
void drawItem(Graphics2D g2, XYItemRendererState state, Rectangle2D dataArea, PlotRenderingInfo info, XYPlot plot, ValueAxis domainAxis, ValueAxis rangeAxis, XYDataset dataset, int series, int item, CrosshairState crosshairState, int pass)
Draws the visual representation of a single data item.
boolean equals(Object obj)
Tests this renderer for equality with an arbitrary object.
Shape getLegendArea()
Returns the shape used to represent an area in the legend.
LegendItem getLegendItem(int datasetIndex, int series)
Returns a default legend item for the specified series.
boolean getPlotArea()
Returns true if Area is being plotted by the renderer.
boolean getPlotLines()
Returns true if lines are being plotted by the renderer.
boolean getPlotShapes()
Returns true if shapes are being plotted by the renderer.
XYItemRendererState initialise(Graphics2D g2, Rectangle2D dataArea, XYPlot plot, XYDataset data, PlotRenderingInfo info)
Initialises the renderer and returns a state object that should be passed to all subsequent calls to the drawItem() method.
boolean isOutline()
Returns a flag that controls whether or not outlines of the areas are drawn.
void setLegendArea(Shape area)
Sets the shape used as an area in each legend item and sends a RendererChangeEvent to all registered listeners.
void setOutline(boolean show)
Sets a flag that controls whether or not outlines of the areas are drawn and sends a RendererChangeEvent to all registered listeners.
[Expand]
Inherited Methods
From class org.jfree.chart.renderer.xy.AbstractXYItemRenderer
From class org.jfree.chart.renderer.AbstractRenderer
From class java.lang.Object
From interface org.jfree.chart.LegendItemSource
From interface org.jfree.chart.renderer.xy.XYItemRenderer

Constants

public static final int AREA

Useful constant for specifying the type of rendering (area only).

Constant Value: 4 (0x00000004)

public static final int AREA_AND_SHAPES

Useful constant for specifying the type of rendering (area and shapes).

Constant Value: 5 (0x00000005)

public static final int LINES

Useful constant for specifying the type of rendering (lines only).

Constant Value: 2 (0x00000002)

public static final int SHAPES

Useful constant for specifying the type of rendering (shapes only).

Constant Value: 1 (0x00000001)

public static final int SHAPES_AND_LINES

Useful constant for specifying the type of rendering (shapes and lines).

Constant Value: 3 (0x00000003)

Public Constructors

public XYAreaRenderer ()

Constructs a new renderer.

public XYAreaRenderer (int type)

Constructs a new renderer.

Parameters
type the type of the renderer.

public XYAreaRenderer (int type, XYToolTipGenerator toolTipGenerator, XYURLGenerator urlGenerator)

Constructs a new renderer. To specify the type of renderer, use one of the constants: SHAPES, LINES, SHAPES_AND_LINES, AREA or AREA_AND_SHAPES.

Parameters
type the type of renderer.
toolTipGenerator the tool tip generator to use (null permitted).
urlGenerator the URL generator (null permitted).

Public Methods

public Object clone ()

Returns a clone of the renderer.

Returns
  • A clone.
Throws
CloneNotSupportedException if the renderer cannot be cloned.

public void drawItem (Graphics2D g2, XYItemRendererState state, Rectangle2D dataArea, PlotRenderingInfo info, XYPlot plot, ValueAxis domainAxis, ValueAxis rangeAxis, XYDataset dataset, int series, int item, CrosshairState crosshairState, int pass)

Draws the visual representation of a single data item.

Parameters
g2 the graphics device.
state the renderer state.
dataArea the area within which the data is being drawn.
info collects information about the drawing.
plot the plot (can be used to obtain standard color information etc).
domainAxis the domain axis.
rangeAxis the range axis.
dataset the dataset.
series the series index (zero-based).
item the item index (zero-based).
crosshairState crosshair information for the plot (null permitted).
pass the pass index.

public boolean equals (Object obj)

Tests this renderer for equality with an arbitrary object.

Parameters
obj the object (null permitted).
Returns
  • A boolean.

public Shape getLegendArea ()

Returns the shape used to represent an area in the legend.

Returns
  • The legend area (never null).

public LegendItem getLegendItem (int datasetIndex, int series)

Returns a default legend item for the specified series. Subclasses should override this method to generate customised items.

Parameters
datasetIndex the dataset index (zero-based).
series the series index (zero-based).
Returns
  • A legend item for the series.

public boolean getPlotArea ()

Returns true if Area is being plotted by the renderer.

Returns
  • true if Area is being plotted by the renderer.

public boolean getPlotLines ()

Returns true if lines are being plotted by the renderer.

Returns
  • true if lines are being plotted by the renderer.

public boolean getPlotShapes ()

Returns true if shapes are being plotted by the renderer.

Returns
  • true if shapes are being plotted by the renderer.

public XYItemRendererState initialise (Graphics2D g2, Rectangle2D dataArea, XYPlot plot, XYDataset data, PlotRenderingInfo info)

Initialises the renderer and returns a state object that should be passed to all subsequent calls to the drawItem() method.

Parameters
g2 the graphics device.
dataArea the area inside the axes.
plot the plot.
data the data.
info an optional info collection object to return data back to the caller.
Returns
  • A state object for use by the renderer.

public boolean isOutline ()

Returns a flag that controls whether or not outlines of the areas are drawn.

Returns
  • The flag.
See Also

public void setLegendArea (Shape area)

Sets the shape used as an area in each legend item and sends a RendererChangeEvent to all registered listeners.

Parameters
area the area (null not permitted).

public void setOutline (boolean show)

Sets a flag that controls whether or not outlines of the areas are drawn and sends a RendererChangeEvent to all registered listeners.

Parameters
show the flag.
See Also