Module platform

Package org.jfree.chart.renderer.xy

Class XYBubbleRenderer

java.lang.Object

org.jfree.chart.renderer.AbstractRenderer

org.jfree.chart.renderer.xy.AbstractXYItemRenderer

org.jfree.chart.renderer.xy.XYBubbleRenderer

All Implemented Interfaces:

Serializable, Cloneable, EventListener, AnnotationChangeListener, LegendItemSource, XYItemRenderer, PublicCloneable

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:

See Also:

• Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
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(int)).
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(int)).
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(int)).
static final long	serialVersionUID	For serialization.

Fields inherited from class org.jfree.chart.renderer.AbstractRenderer

DEFAULT_OUTLINE_PAINT, DEFAULT_OUTLINE_STROKE, DEFAULT_PAINT, DEFAULT_SHAPE, DEFAULT_STROKE, DEFAULT_VALUE_LABEL_FONT, DEFAULT_VALUE_LABEL_PAINT, ZERO

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
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.
LegendItem	getLegendItem(int datasetIndex, int series)	Returns a legend item for the specified series.
int	getScaleType()	Returns the scale type that was set when the renderer was constructed.

Methods inherited from class org.jfree.chart.renderer.xy.AbstractXYItemRenderer

addAnnotation, addAnnotation, addEntity, annotationChanged, beginElementGroup, calculateDomainMarkerTextAnchorPoint, drawAnnotations, drawDomainLine, drawDomainMarker, drawItemLabel, drawRangeLine, drawRangeMarker, fillDomainGridBand, fillRangeGridBand, findDomainBounds, findDomainBounds, findRangeBounds, findRangeBounds, getAnnotations, getDefaultItemLabelGenerator, getDefaultToolTipGenerator, getDrawingSupplier, getItemLabelGenerator, getLegendItemLabelGenerator, getLegendItems, getLegendItemToolTipGenerator, getLegendItemURLGenerator, getPassCount, getPlot, getSeriesItemLabelGenerator, getSeriesToolTipGenerator, getToolTipGenerator, getURLGenerator, initialise, lineTo, moveTo, removeAnnotation, removeAnnotations, setDefaultItemLabelGenerator, setDefaultToolTipGenerator, setLegendItemLabelGenerator, setLegendItemToolTipGenerator, setLegendItemURLGenerator, setPlot, setSeriesItemLabelGenerator, setSeriesToolTipGenerator, setURLGenerator, updateCrosshairValues

Methods inherited from class org.jfree.chart.renderer.AbstractRenderer

addChangeListener, beginElementGroup, calculateLabelAnchorPoint, clearSeriesPaints, clearSeriesStrokes, endElementGroup, fireChangeEvent, getAutoPopulateSeriesFillPaint, getAutoPopulateSeriesOutlinePaint, getAutoPopulateSeriesOutlineStroke, getAutoPopulateSeriesPaint, getAutoPopulateSeriesShape, getAutoPopulateSeriesStroke, getDataBoundsIncludesVisibleSeriesOnly, getDefaultCreateEntities, getDefaultEntityRadius, getDefaultFillPaint, getDefaultItemLabelFont, getDefaultItemLabelPaint, getDefaultItemLabelsVisible, getDefaultLegendShape, getDefaultLegendTextFont, getDefaultLegendTextPaint, getDefaultNegativeItemLabelPosition, getDefaultOutlinePaint, getDefaultOutlineStroke, getDefaultPaint, getDefaultPositiveItemLabelPosition, getDefaultSeriesVisible, getDefaultSeriesVisibleInLegend, getDefaultShape, getDefaultStroke, getItemCreateEntity, getItemFillPaint, getItemLabelAnchorOffset, getItemLabelFont, getItemLabelPaint, getItemOutlinePaint, getItemOutlineStroke, getItemPaint, getItemShape, getItemStroke, getItemVisible, getLegendShape, getLegendTextFont, getLegendTextPaint, getNegativeItemLabelPosition, getPositiveItemLabelPosition, getSeriesCreateEntities, getSeriesFillPaint, getSeriesItemLabelFont, getSeriesItemLabelPaint, getSeriesNegativeItemLabelPosition, getSeriesOutlinePaint, getSeriesOutlineStroke, getSeriesPaint, getSeriesPositiveItemLabelPosition, getSeriesShape, getSeriesStroke, getSeriesVisible, getSeriesVisibleInLegend, getTreatLegendShapeAsLine, hashCode, hasListener, isItemLabelVisible, isSeriesItemLabelsVisible, isSeriesVisible, isSeriesVisibleInLegend, lookupLegendShape, lookupLegendTextFont, lookupLegendTextPaint, lookupSeriesFillPaint, lookupSeriesOutlinePaint, lookupSeriesOutlineStroke, lookupSeriesPaint, lookupSeriesShape, lookupSeriesStroke, notifyListeners, removeChangeListener, setAutoPopulateSeriesFillPaint, setAutoPopulateSeriesOutlinePaint, setAutoPopulateSeriesOutlineStroke, setAutoPopulateSeriesPaint, setAutoPopulateSeriesShape, setAutoPopulateSeriesStroke, setDataBoundsIncludesVisibleSeriesOnly, setDefaultCreateEntities, setDefaultCreateEntities, setDefaultEntityRadius, setDefaultFillPaint, setDefaultFillPaint, setDefaultItemLabelFont, setDefaultItemLabelFont, setDefaultItemLabelPaint, setDefaultItemLabelPaint, setDefaultItemLabelsVisible, setDefaultItemLabelsVisible, setDefaultLegendShape, setDefaultLegendTextFont, setDefaultLegendTextPaint, setDefaultNegativeItemLabelPosition, setDefaultNegativeItemLabelPosition, setDefaultOutlinePaint, setDefaultOutlinePaint, setDefaultOutlineStroke, setDefaultOutlineStroke, setDefaultPaint, setDefaultPaint, setDefaultPositiveItemLabelPosition, setDefaultPositiveItemLabelPosition, setDefaultSeriesVisible, setDefaultSeriesVisible, setDefaultSeriesVisibleInLegend, setDefaultSeriesVisibleInLegend, setDefaultShape, setDefaultShape, setDefaultStroke, setDefaultStroke, setItemLabelAnchorOffset, setLegendShape, setLegendTextFont, setLegendTextPaint, setSeriesCreateEntities, setSeriesCreateEntities, setSeriesFillPaint, setSeriesFillPaint, setSeriesItemLabelFont, setSeriesItemLabelFont, setSeriesItemLabelPaint, setSeriesItemLabelPaint, setSeriesItemLabelsVisible, setSeriesItemLabelsVisible, setSeriesItemLabelsVisible, setSeriesNegativeItemLabelPosition, setSeriesNegativeItemLabelPosition, setSeriesOutlinePaint, setSeriesOutlinePaint, setSeriesOutlineStroke, setSeriesOutlineStroke, setSeriesPaint, setSeriesPaint, setSeriesPositiveItemLabelPosition, setSeriesPositiveItemLabelPosition, setSeriesShape, setSeriesShape, setSeriesStroke, setSeriesStroke, setSeriesVisible, setSeriesVisible, setSeriesVisibleInLegend, setSeriesVisibleInLegend, setTreatLegendShapeAsLine

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.jfree.chart.LegendItemSource

getLegendItems

Methods inherited from interface org.jfree.chart.renderer.xy.XYItemRenderer

addAnnotation, addAnnotation, addChangeListener, drawAnnotations, drawDomainLine, drawDomainMarker, drawRangeLine, drawRangeMarker, fillDomainGridBand, fillRangeGridBand, findDomainBounds, findRangeBounds, getDefaultCreateEntities, getDefaultFillPaint, getDefaultItemLabelFont, getDefaultItemLabelGenerator, getDefaultItemLabelPaint, getDefaultItemLabelsVisible, getDefaultNegativeItemLabelPosition, getDefaultOutlinePaint, getDefaultOutlineStroke, getDefaultPaint, getDefaultPositiveItemLabelPosition, getDefaultSeriesVisible, getDefaultSeriesVisibleInLegend, getDefaultShape, getDefaultStroke, getDefaultToolTipGenerator, getItemCreateEntity, getItemFillPaint, getItemLabelFont, getItemLabelGenerator, getItemLabelPaint, getItemOutlinePaint, getItemOutlineStroke, getItemPaint, getItemShape, getItemStroke, getItemVisible, getLegendItemLabelGenerator, getNegativeItemLabelPosition, getPassCount, getPlot, getPositiveItemLabelPosition, getSeriesCreateEntities, getSeriesFillPaint, getSeriesItemLabelFont, getSeriesItemLabelGenerator, getSeriesItemLabelPaint, getSeriesNegativeItemLabelPosition, getSeriesOutlinePaint, getSeriesOutlineStroke, getSeriesPaint, getSeriesPositiveItemLabelPosition, getSeriesShape, getSeriesStroke, getSeriesToolTipGenerator, getSeriesVisible, getSeriesVisibleInLegend, getToolTipGenerator, getURLGenerator, initialise, isItemLabelVisible, isSeriesItemLabelsVisible, isSeriesVisible, isSeriesVisibleInLegend, removeAnnotation, removeAnnotations, removeChangeListener, setDefaultCreateEntities, setDefaultCreateEntities, setDefaultFillPaint, setDefaultFillPaint, setDefaultItemLabelFont, setDefaultItemLabelGenerator, setDefaultItemLabelPaint, setDefaultItemLabelsVisible, setDefaultItemLabelsVisible, setDefaultNegativeItemLabelPosition, setDefaultNegativeItemLabelPosition, setDefaultOutlinePaint, setDefaultOutlinePaint, setDefaultOutlineStroke, setDefaultOutlineStroke, setDefaultPaint, setDefaultPaint, setDefaultPositiveItemLabelPosition, setDefaultPositiveItemLabelPosition, setDefaultSeriesVisible, setDefaultSeriesVisible, setDefaultSeriesVisibleInLegend, setDefaultSeriesVisibleInLegend, setDefaultShape, setDefaultShape, setDefaultStroke, setDefaultStroke, setDefaultToolTipGenerator, setLegendItemLabelGenerator, setPlot, setSeriesCreateEntities, setSeriesCreateEntities, setSeriesFillPaint, setSeriesFillPaint, setSeriesItemLabelFont, setSeriesItemLabelGenerator, setSeriesItemLabelPaint, setSeriesItemLabelsVisible, setSeriesItemLabelsVisible, setSeriesItemLabelsVisible, setSeriesNegativeItemLabelPosition, setSeriesNegativeItemLabelPosition, setSeriesOutlinePaint, setSeriesOutlinePaint, setSeriesOutlineStroke, setSeriesOutlineStroke, setSeriesPaint, setSeriesPaint, setSeriesPositiveItemLabelPosition, setSeriesPositiveItemLabelPosition, setSeriesShape, setSeriesShape, setSeriesStroke, setSeriesStroke, setSeriesToolTipGenerator, setSeriesVisible, setSeriesVisible, setSeriesVisibleInLegend, setSeriesVisibleInLegend, setURLGenerator

Field Details

serialVersionUID

public static final long serialVersionUID

For serialization.

See Also:

• Constant Field Values

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(int)).

See Also:

• Constant Field Values

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(int)).

See Also:

• Constant Field Values

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(int)).

See Also:

• Constant Field Values

Constructor Details

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 Details

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).

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.

Specified by:

drawItem in interface XYItemRenderer

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.

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.

Specified by:

getLegendItem in interface XYItemRenderer

Overrides:

getLegendItem in class AbstractXYItemRenderer

Parameters:

datasetIndex - the dataset index (zero-based).

series - the series index (zero-based).

Returns:

A legend item for the series.

equals

public boolean equals(Object obj)

Tests this renderer for equality with an arbitrary object.

Overrides:

equals in class AbstractXYItemRenderer

Parameters:

obj - the object (null permitted).

Returns:

A boolean.

clone

public Object clone()
             throws CloneNotSupportedException

Returns a clone of the renderer.

Specified by:

clone in interface PublicCloneable

Overrides:

clone in class AbstractXYItemRenderer

Returns:

A clone.

Throws:

CloneNotSupportedException - if the renderer cannot be cloned.