org.jfree.chart.renderer.xy

Class XYBubbleRenderer

public class XYBubbleRenderer extends AbstractXYItemRenderer implements XYItemRenderer, PublicCloneable

A renderer that draws a circle at each data point with a diameter that is determined by the z-value in the dataset (the renderer requires the dataset to be an instance of XYZDataset. The example shown here is generated by the XYBubbleChartDemo1.java program included in the JFreeChart demo collection:

XYBubbleRendererSample.png
Field Summary
static longserialVersionUID
For serialization.
static intSCALE_ON_BOTH_AXES
A constant to specify that the bubbles drawn by this renderer should be scaled on both axes (see XYBubbleRenderer).
static intSCALE_ON_DOMAIN_AXIS
A constant to specify that the bubbles drawn by this renderer should be scaled on the domain axis (see XYBubbleRenderer).
static intSCALE_ON_RANGE_AXIS
A constant to specify that the bubbles drawn by this renderer should be scaled on the range axis (see XYBubbleRenderer).
Constructor Summary
XYBubbleRenderer()
Constructs a new renderer.
XYBubbleRenderer(int scaleType)
Constructs a new renderer with the specified type of scaling.
Method Summary
Objectclone()
Returns a clone of the renderer.
voiddrawItem(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.
booleanequals(Object obj)
Tests this renderer for equality with an arbitrary object.
LegendItemgetLegendItem(int datasetIndex, int series)
Returns a legend item for the specified series.
intgetScaleType()
Returns the scale type that was set when the renderer was constructed.

Field Detail

serialVersionUID

public static final long serialVersionUID
For serialization.

SCALE_ON_BOTH_AXES

public static final int SCALE_ON_BOTH_AXES
A constant to specify that the bubbles drawn by this renderer should be scaled on both axes (see XYBubbleRenderer).

SCALE_ON_DOMAIN_AXIS

public static final int SCALE_ON_DOMAIN_AXIS
A constant to specify that the bubbles drawn by this renderer should be scaled on the domain axis (see XYBubbleRenderer).

SCALE_ON_RANGE_AXIS

public static final int SCALE_ON_RANGE_AXIS
A constant to specify that the bubbles drawn by this renderer should be scaled on the range axis (see XYBubbleRenderer).

Constructor Detail

XYBubbleRenderer

public XYBubbleRenderer()
Constructs a new renderer.

XYBubbleRenderer

public XYBubbleRenderer(int scaleType)
Constructs a new renderer with the specified type of scaling.

Parameters: scaleType the type of scaling (must be one of: SCALE_ON_BOTH_AXES, SCALE_ON_DOMAIN_AXIS, SCALE_ON_RANGE_AXIS).

Method Detail

clone

public Object clone()
Returns a clone of the renderer.

Returns: A clone.

Throws: CloneNotSupportedException if the renderer cannot be cloned.

drawItem

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 (horizontal) axis. rangeAxis the range (vertical) axis. dataset the dataset (an XYZDataset is expected). series the series index (zero-based). item the item index (zero-based). crosshairState crosshair information for the plot (null permitted). pass the pass index.

equals

public boolean equals(Object obj)
Tests this renderer for equality with an arbitrary object.

Parameters: obj the object (null permitted).

Returns: A boolean.

getLegendItem

public LegendItem getLegendItem(int datasetIndex, int series)
Returns a legend item for the specified series. The default method is overridden so that the legend displays circles for all series.

Parameters: datasetIndex the dataset index (zero-based). series the series index (zero-based).

Returns: A legend item for the series.

getScaleType

public int getScaleType()
Returns the scale type that was set when the renderer was constructed.

Returns: The scale type (one of: SCALE_ON_BOTH_AXES, SCALE_ON_DOMAIN_AXIS, SCALE_ON_RANGE_AXIS).

Copyright © 2000-2009 by Object Refinery Limited. All Rights Reserved.