public class

ScatterRenderer

extends AbstractCategoryItemRenderer
implements Serializable Cloneable
java.lang.Object
   ↳ org.jfree.chart.renderer.AbstractRenderer
     ↳ org.jfree.chart.renderer.category.AbstractCategoryItemRenderer
       ↳ org.jfree.chart.renderer.category.ScatterRenderer

Class Overview

A renderer that handles the multiple values from a MultiValueCategoryDataset by plotting a shape for each value for each given item in the dataset. The example shown here is generated by the ScatterRendererDemo1.java program included in the JFreeChart Demo Collection:

ScatterRendererSample.png

Summary

[Expand]
Inherited Fields
From class org.jfree.chart.renderer.AbstractRenderer
Public Constructors
ScatterRenderer()
Constructs a new renderer.
Public Methods
Object clone()
Returns an independent copy of the renderer.
void drawItem(Graphics2D g2, CategoryItemRendererState state, Rectangle2D dataArea, CategoryPlot plot, CategoryAxis domainAxis, ValueAxis rangeAxis, CategoryDataset dataset, int row, int column, int pass)
Draw a single data item.
boolean equals(Object obj)
Tests this renderer for equality with an arbitrary object.
boolean getBaseShapesFilled()
Returns the base 'shape filled' attribute.
boolean getDrawOutlines()
Returns true if outlines should be drawn for shapes, and false otherwise.
double getItemMargin()
Returns the item margin, which is the gap between items within a category (expressed as a percentage of the overall category width).
boolean getItemShapeFilled(int series, int item)
Returns the flag used to control whether or not the shape for an item is filled.
LegendItem getLegendItem(int datasetIndex, int series)
Returns a legend item for a series.
boolean getSeriesShapesFilled(int series)
Returns the flag used to control whether or not the shapes for a series are filled.
boolean getUseFillPaint()
Returns true if the renderer should use the fill paint setting to fill shapes, and false if it should just use the regular paint.
boolean getUseOutlinePaint()
Returns the flag that controls whether the outline paint is used for shape outlines.
boolean getUseSeriesOffset()
Returns the flag that controls whether or not the x-position for each data item is offset within the category according to the series.
void setBaseShapesFilled(boolean flag)
Sets the base 'shapes filled' flag and sends a RendererChangeEvent to all registered listeners.
void setDrawOutlines(boolean flag)
Sets the flag that controls whether outlines are drawn for shapes, and sends a RendererChangeEvent to all registered listeners.
void setItemMargin(double margin)
Sets the item margin, which is the gap between items within a category (expressed as a percentage of the overall category width), and sends a RendererChangeEvent to all registered listeners.
void setSeriesShapesFilled(int series, boolean filled)
Sets the 'shapes filled' flag for a series and sends a RendererChangeEvent to all registered listeners.
void setSeriesShapesFilled(int series, Boolean filled)
Sets the 'shapes filled' flag for a series and sends a RendererChangeEvent to all registered listeners.
void setUseFillPaint(boolean flag)
Sets the flag that controls whether the fill paint is used to fill shapes, and sends a RendererChangeEvent to all registered listeners.
void setUseOutlinePaint(boolean use)
Sets the flag that controls whether the outline paint is used for shape outlines, and sends a RendererChangeEvent to all registered listeners.
void setUseSeriesOffset(boolean offset)
Sets the flag that controls whether or not the x-position for each data item is offset within its category according to the series, and sends a RendererChangeEvent to all registered listeners.
[Expand]
Inherited Methods
From class org.jfree.chart.renderer.category.AbstractCategoryItemRenderer
From class org.jfree.chart.renderer.AbstractRenderer
From class java.lang.Object
From interface org.jfree.chart.LegendItemSource
From interface org.jfree.chart.renderer.category.CategoryItemRenderer

Public Constructors

public ScatterRenderer ()

Constructs a new renderer.

Public Methods

public Object clone ()

Returns an independent copy of the renderer.

Returns
  • A clone.
Throws
CloneNotSupportedException should not happen.

public void drawItem (Graphics2D g2, CategoryItemRendererState state, Rectangle2D dataArea, CategoryPlot plot, CategoryAxis domainAxis, ValueAxis rangeAxis, CategoryDataset dataset, int row, int column, int pass)

Draw a single data item.

Parameters
g2 the graphics device.
state the renderer state.
dataArea the area in which the data is drawn.
plot the plot.
domainAxis the domain axis.
rangeAxis the range axis.
dataset the dataset.
row the row index (zero-based).
column the column index (zero-based).
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 boolean getBaseShapesFilled ()

Returns the base 'shape filled' attribute.

Returns
  • The base flag.

public boolean getDrawOutlines ()

Returns true if outlines should be drawn for shapes, and false otherwise.

Returns
  • A boolean.
See Also

public double getItemMargin ()

Returns the item margin, which is the gap between items within a category (expressed as a percentage of the overall category width). This can be used to match the offset alignment with the bars drawn by a BarRenderer).

Returns
  • The item margin.
See Also

public boolean getItemShapeFilled (int series, int item)

Returns the flag used to control whether or not the shape for an item is filled. The default implementation passes control to the getSeriesShapesFilled method. You can override this method if you require different behaviour.

Parameters
series the series index (zero-based).
item the item index (zero-based).
Returns
  • A boolean.

public LegendItem getLegendItem (int datasetIndex, int series)

Returns a legend item for a series.

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

public boolean getSeriesShapesFilled (int series)

Returns the flag used to control whether or not the shapes for a series are filled.

Parameters
series the series index (zero-based).
Returns
  • A boolean.

public boolean getUseFillPaint ()

Returns true if the renderer should use the fill paint setting to fill shapes, and false if it should just use the regular paint.

Returns
  • A boolean.

public boolean getUseOutlinePaint ()

Returns the flag that controls whether the outline paint is used for shape outlines. If not, the regular series paint is used.

Returns
  • A boolean.
See Also

public boolean getUseSeriesOffset ()

Returns the flag that controls whether or not the x-position for each data item is offset within the category according to the series.

Returns
  • A boolean.
See Also

public void setBaseShapesFilled (boolean flag)

Sets the base 'shapes filled' flag and sends a RendererChangeEvent to all registered listeners.

Parameters
flag the flag.

public void setDrawOutlines (boolean flag)

Sets the flag that controls whether outlines are drawn for shapes, and sends a RendererChangeEvent to all registered listeners.

In some cases, shapes look better if they do NOT have an outline, but this flag allows you to set your own preference.

Parameters
flag the flag.
See Also

public void setItemMargin (double margin)

Sets the item margin, which is the gap between items within a category (expressed as a percentage of the overall category width), and sends a RendererChangeEvent to all registered listeners.

Parameters
margin the margin (0.0 <= margin < 1.0).
See Also

public void setSeriesShapesFilled (int series, boolean filled)

Sets the 'shapes filled' flag for a series and sends a RendererChangeEvent to all registered listeners.

Parameters
series the series index (zero-based).
filled the flag.

public void setSeriesShapesFilled (int series, Boolean filled)

Sets the 'shapes filled' flag for a series and sends a RendererChangeEvent to all registered listeners.

Parameters
series the series index (zero-based).
filled the flag.

public void setUseFillPaint (boolean flag)

Sets the flag that controls whether the fill paint is used to fill shapes, and sends a RendererChangeEvent to all registered listeners.

Parameters
flag the flag.

public void setUseOutlinePaint (boolean use)

Sets the flag that controls whether the outline paint is used for shape outlines, and sends a RendererChangeEvent to all registered listeners.

Parameters
use the flag.
See Also

public void setUseSeriesOffset (boolean offset)

Sets the flag that controls whether or not the x-position for each data item is offset within its category according to the series, and sends a RendererChangeEvent to all registered listeners.

Parameters
offset the offset.
See Also