java.lang.Object
   ↳ org.jfree.chart.plot.Plot
     ↳ org.jfree.chart.plot.XYPlot
Known Direct Subclasses

Class Overview

A general class for plotting data in the form of (x, y) pairs. This plot can use data from any class that implements the XYDataset interface.

XYPlot makes use of an XYItemRenderer to draw each point on the plot. By using different renderers, various chart types can be produced.

The ChartFactory class contains static methods for creating pre-configured charts.

Summary

Constants
boolean DEFAULT_CROSSHAIR_VISIBLE The default crosshair visibility.
[Expand]
Inherited Constants
From class org.jfree.chart.plot.Plot
Fields
public static final Paint DEFAULT_CROSSHAIR_PAINT The default crosshair paint.
public static final Stroke DEFAULT_CROSSHAIR_STROKE The default crosshair stroke.
public static final Paint DEFAULT_GRIDLINE_PAINT The default grid line paint.
public static final Stroke DEFAULT_GRIDLINE_STROKE The default grid line stroke.
protected static ResourceBundle localizationResources The resourceBundle for the localization.
[Expand]
Inherited Fields
From class org.jfree.chart.plot.Plot
Public Constructors
XYPlot()
Creates a new XYPlot instance with no dataset, no axes and no renderer.
XYPlot(XYDataset dataset, ValueAxis domainAxis, ValueAxis rangeAxis, XYItemRenderer renderer)
Creates a new plot with the specified dataset, axes and renderer.
Public Methods
void addAnnotation(XYAnnotation annotation)
Adds an annotation to the plot and sends a PlotChangeEvent to all registered listeners.
void addAnnotation(XYAnnotation annotation, boolean notify)
Adds an annotation to the plot and, if requested, sends a PlotChangeEvent to all registered listeners.
void addDomainMarker(int index, Marker marker, Layer layer)
Adds a marker for a specific dataset/renderer and sends a PlotChangeEvent to all registered listeners.
void addDomainMarker(int index, Marker marker, Layer layer, boolean notify)
Adds a marker for a specific dataset/renderer and, if requested, sends a PlotChangeEvent to all registered listeners.
void addDomainMarker(Marker marker)
Adds a marker for the domain axis and sends a PlotChangeEvent to all registered listeners.
void addDomainMarker(Marker marker, Layer layer)
Adds a marker for the domain axis in the specified layer and sends a PlotChangeEvent to all registered listeners.
void addRangeMarker(int index, Marker marker, Layer layer, boolean notify)
Adds a marker for a specific dataset/renderer and, if requested, sends a PlotChangeEvent to all registered listeners.
void addRangeMarker(Marker marker)
Adds a marker for the range axis and sends a PlotChangeEvent to all registered listeners.
void addRangeMarker(Marker marker, Layer layer)
Adds a marker for the range axis in the specified layer and sends a PlotChangeEvent to all registered listeners.
void addRangeMarker(int index, Marker marker, Layer layer)
Adds a marker for a specific dataset/renderer and sends a PlotChangeEvent to all registered listeners.
void clearAnnotations()
Clears all the annotations and sends a PlotChangeEvent to all registered listeners.
void clearDomainAxes()
Clears the domain axes from the plot and sends a PlotChangeEvent to all registered listeners.
void clearDomainMarkers(int index)
Clears the (foreground and background) domain markers for a particular renderer.
void clearDomainMarkers()
Clears all the (foreground and background) domain markers and sends a PlotChangeEvent to all registered listeners.
void clearRangeAxes()
Clears the range axes from the plot and sends a PlotChangeEvent to all registered listeners.
void clearRangeMarkers(int index)
Clears the (foreground and background) range markers for a particular renderer.
void clearRangeMarkers()
Clears all the range markers and sends a PlotChangeEvent to all registered listeners.
Object clone()
Returns a clone of the plot.
void configureDomainAxes()
Configures the domain axes.
void configureRangeAxes()
Configures the range axes.
void datasetChanged(DatasetChangeEvent event)
Receives notification of a change to the plot's dataset.
void draw(Graphics2D g2, Rectangle2D area, Point2D anchor, PlotState parentState, PlotRenderingInfo info)
Draws the plot within the specified area on a graphics device.
void drawAnnotations(Graphics2D g2, Rectangle2D dataArea, PlotRenderingInfo info)
Draws the annotations for the plot.
void drawBackground(Graphics2D g2, Rectangle2D area)
Draws the background for the plot.
void drawDomainTickBands(Graphics2D g2, Rectangle2D dataArea, List ticks)
Draws the domain tick bands, if any.
void drawRangeTickBands(Graphics2D g2, Rectangle2D dataArea, List ticks)
Draws the range tick bands, if any.
boolean equals(Object obj)
Tests this plot for equality with another object.
List getAnnotations()
Returns the list of annotations.
RectangleInsets getAxisOffset()
Returns the axis offset.
Range getDataRange(ValueAxis axis)
Returns the range for the specified axis.
XYDataset getDataset(int index)
Returns a dataset.
XYDataset getDataset()
Returns the primary dataset for the plot.
int getDatasetCount()
Returns the number of datasets.
DatasetRenderingOrder getDatasetRenderingOrder()
Returns the dataset rendering order.
ValueAxis getDomainAxis(int index)
Returns the domain axis with the specified index, or null.
ValueAxis getDomainAxis()
Returns the domain axis with index 0.
int getDomainAxisCount()
Returns the number of domain axes.
RectangleEdge getDomainAxisEdge(int index)
Returns the edge for a domain axis.
RectangleEdge getDomainAxisEdge()
Returns the edge for the primary domain axis (taking into account the plot's orientation).
ValueAxis getDomainAxisForDataset(int index)
Returns the domain axis for a dataset.
int getDomainAxisIndex(ValueAxis axis)
Returns the index of the given domain axis.
AxisLocation getDomainAxisLocation(int index)
Returns the location for a domain axis.
AxisLocation getDomainAxisLocation()
Returns the location of the primary domain axis.
Paint getDomainCrosshairPaint()
Returns the domain crosshair paint.
Stroke getDomainCrosshairStroke()
Returns the Stroke used to draw the crosshair (if visible).
double getDomainCrosshairValue()
Returns the domain crosshair value.
Paint getDomainGridlinePaint()
Returns the paint for the grid lines (if any) plotted against the domain axis.
Stroke getDomainGridlineStroke()
Returns the stroke for the grid-lines (if any) plotted against the domain axis.
Collection getDomainMarkers(int index, Layer layer)
Returns a collection of domain markers for a particular renderer and layer.
Collection getDomainMarkers(Layer layer)
Returns the list of domain markers (read only) for the specified layer.
Paint getDomainMinorGridlinePaint()
Returns the paint for the minor grid lines (if any) plotted against the domain axis.
Stroke getDomainMinorGridlineStroke()
Returns the stroke for the minor grid-lines (if any) plotted against the domain axis.
Paint getDomainTickBandPaint()
Returns the paint used for the domain tick bands.
Paint getDomainZeroBaselinePaint()
Returns the paint for the zero baseline (if any) plotted against the domain axis.
Stroke getDomainZeroBaselineStroke()
Returns the stroke used for the zero baseline against the domain axis.
AxisSpace getFixedDomainAxisSpace()
Returns the fixed domain axis space.
LegendItemCollection getFixedLegendItems()
Returns the fixed legend items, if any.
AxisSpace getFixedRangeAxisSpace()
Returns the fixed range axis space.
int getIndexOf(XYItemRenderer renderer)
Returns the index of the specified renderer, or -1 if the renderer is not assigned to this plot.
LegendItemCollection getLegendItems()
Returns the legend items for the plot.
PlotOrientation getOrientation()
Returns the orientation of the plot.
String getPlotType()
Returns the plot type as a string.
Point2D getQuadrantOrigin()
Returns the origin for the quadrants that can be displayed on the plot.
Paint getQuadrantPaint(int index)
Returns the paint used for the specified quadrant.
ValueAxis getRangeAxis(int index)
Returns a range axis.
ValueAxis getRangeAxis()
Returns the range axis for the plot.
int getRangeAxisCount()
Returns the number of range axes.
RectangleEdge getRangeAxisEdge()
Returns the edge for the primary range axis.
RectangleEdge getRangeAxisEdge(int index)
Returns the edge for a range axis.
ValueAxis getRangeAxisForDataset(int index)
Returns the range axis for a dataset.
int getRangeAxisIndex(ValueAxis axis)
Returns the index of the given range axis.
AxisLocation getRangeAxisLocation(int index)
Returns the location for a range axis.
AxisLocation getRangeAxisLocation()
Returns the location of the primary range axis.
Paint getRangeCrosshairPaint()
Returns the range crosshair paint.
Stroke getRangeCrosshairStroke()
Returns the stroke used to draw the crosshair (if visible).
double getRangeCrosshairValue()
Returns the range crosshair value.
Paint getRangeGridlinePaint()
Returns the paint for the grid lines (if any) plotted against the range axis.
Stroke getRangeGridlineStroke()
Returns the stroke for the grid lines (if any) plotted against the range axis.
Collection getRangeMarkers(int index, Layer layer)
Returns a collection of range markers for a particular renderer and layer.
Collection getRangeMarkers(Layer layer)
Returns the list of range markers (read only) for the specified layer.
Paint getRangeMinorGridlinePaint()
Returns the paint for the minor grid lines (if any) plotted against the range axis.
Stroke getRangeMinorGridlineStroke()
Returns the stroke for the minor grid lines (if any) plotted against the range axis.
Paint getRangeTickBandPaint()
Returns the paint used for the range tick bands.
Paint getRangeZeroBaselinePaint()
Returns the paint for the zero baseline (if any) plotted against the range axis.
Stroke getRangeZeroBaselineStroke()
Returns the stroke used for the zero baseline against the range axis.
XYItemRenderer getRenderer(int index)
Returns the renderer for a dataset, or null.
XYItemRenderer getRenderer()
Returns the renderer for the primary dataset.
int getRendererCount()
Returns the number of renderer slots for this plot.
XYItemRenderer getRendererForDataset(XYDataset dataset)
Returns the renderer for the specified dataset.
int getSeriesCount()
Returns the number of series in the primary dataset for this plot.
SeriesRenderingOrder getSeriesRenderingOrder()
Returns the series rendering order.
int getWeight()
Returns the weight for this plot when it is used as a subplot within a combined plot.
void handleClick(int x, int y, PlotRenderingInfo info)
Handles a 'click' on the plot by updating the anchor values.
int indexOf(XYDataset dataset)
Returns the index of the specified dataset, or -1 if the dataset does not belong to the plot.
boolean isDomainCrosshairLockedOnData()
Returns a flag indicating whether or not the crosshair should "lock-on" to actual data values.
boolean isDomainCrosshairVisible()
Returns a flag indicating whether or not the domain crosshair is visible.
boolean isDomainGridlinesVisible()
Returns true if the domain gridlines are visible, and false otherwise.
boolean isDomainMinorGridlinesVisible()
Returns true if the domain minor gridlines are visible, and false otherwise.
boolean isDomainPannable()
Returns true if panning is enabled for the domain axes, and false otherwise.
boolean isDomainZeroBaselineVisible()
Returns a flag that controls whether or not a zero baseline is displayed for the domain axis.
boolean isDomainZoomable()
Returns true, indicating that the domain axis/axes for this plot are zoomable.
boolean isRangeCrosshairLockedOnData()
Returns a flag indicating whether or not the crosshair should "lock-on" to actual data values.
boolean isRangeCrosshairVisible()
Returns a flag indicating whether or not the range crosshair is visible.
boolean isRangeGridlinesVisible()
Returns true if the range axis grid is visible, and false otherwise.
boolean isRangeMinorGridlinesVisible()
Returns true if the range axis minor grid is visible, and false otherwise.
boolean isRangePannable()
Returns true if panning is enabled for the range axes, and false otherwise.
boolean isRangeZeroBaselineVisible()
Returns a flag that controls whether or not a zero baseline is displayed for the range axis.
boolean isRangeZoomable()
Returns true, indicating that the range axis/axes for this plot are zoomable.
void mapDatasetToDomainAxes(int index, List axisIndices)
Maps the specified dataset to the axes in the list.
void mapDatasetToDomainAxis(int index, int axisIndex)
Maps a dataset to a particular domain axis.
void mapDatasetToRangeAxes(int index, List axisIndices)
Maps the specified dataset to the axes in the list.
void mapDatasetToRangeAxis(int index, int axisIndex)
Maps a dataset to a particular range axis.
void panDomainAxes(double percent, PlotRenderingInfo info, Point2D source)
Pans the domain axes by the specified percentage.
void panRangeAxes(double percent, PlotRenderingInfo info, Point2D source)
Pans the range axes by the specified percentage.
boolean removeAnnotation(XYAnnotation annotation)
Removes an annotation from the plot and sends a PlotChangeEvent to all registered listeners.
boolean removeAnnotation(XYAnnotation annotation, boolean notify)
Removes an annotation from the plot and sends a PlotChangeEvent to all registered listeners.
boolean removeDomainMarker(int index, Marker marker, Layer layer)
Removes a marker for a specific dataset/renderer and sends a PlotChangeEvent to all registered listeners.
boolean removeDomainMarker(Marker marker, Layer layer)
Removes a marker for the domain axis in the specified layer and sends a PlotChangeEvent to all registered listeners.
boolean removeDomainMarker(Marker marker)
Removes a marker for the domain axis and sends a PlotChangeEvent to all registered listeners.
boolean removeDomainMarker(int index, Marker marker, Layer layer, boolean notify)
Removes a marker for a specific dataset/renderer and, if requested, sends a PlotChangeEvent to all registered listeners.
boolean removeRangeMarker(int index, Marker marker, Layer layer, boolean notify)
Removes a marker for a specific dataset/renderer and sends a PlotChangeEvent to all registered listeners.
boolean removeRangeMarker(Marker marker)
Removes a marker for the range axis and sends a PlotChangeEvent to all registered listeners.
boolean removeRangeMarker(int index, Marker marker, Layer layer)
Removes a marker for a specific dataset/renderer and sends a PlotChangeEvent to all registered listeners.
boolean removeRangeMarker(Marker marker, Layer layer)
Removes a marker for the range axis in the specified layer and sends a PlotChangeEvent to all registered listeners.
boolean render(Graphics2D g2, Rectangle2D dataArea, int index, PlotRenderingInfo info, CrosshairState crosshairState)
Draws a representation of the data within the dataArea region, using the current renderer.
void rendererChanged(RendererChangeEvent event)
Receives notification of a renderer change event.
void setAxisOffset(RectangleInsets offset)
Sets the axis offsets (gap between the data area and the axes) and sends a PlotChangeEvent to all registered listeners.
void setDataset(XYDataset dataset)
Sets the primary dataset for the plot, replacing the existing dataset if there is one.
void setDataset(int index, XYDataset dataset)
Sets a dataset for the plot.
void setDatasetRenderingOrder(DatasetRenderingOrder order)
Sets the rendering order and sends a PlotChangeEvent to all registered listeners.
void setDomainAxes(ValueAxis[] axes)
Sets the domain axes for this plot and sends a PlotChangeEvent to all registered listeners.
void setDomainAxis(int index, ValueAxis axis)
Sets a domain axis and sends a PlotChangeEvent to all registered listeners.
void setDomainAxis(ValueAxis axis)
Sets the domain axis for the plot and sends a PlotChangeEvent to all registered listeners.
void setDomainAxis(int index, ValueAxis axis, boolean notify)
Sets a domain axis and, if requested, sends a PlotChangeEvent to all registered listeners.
void setDomainAxisLocation(int index, AxisLocation location, boolean notify)
Sets the axis location for a domain axis and, if requested, sends a PlotChangeEvent to all registered listeners.
void setDomainAxisLocation(int index, AxisLocation location)
Sets the location for a domain axis and sends a PlotChangeEvent to all registered listeners.
void setDomainAxisLocation(AxisLocation location, boolean notify)
Sets the location of the domain axis and, if requested, sends a PlotChangeEvent to all registered listeners.
void setDomainAxisLocation(AxisLocation location)
Sets the location of the primary domain axis and sends a PlotChangeEvent to all registered listeners.
void setDomainCrosshairLockedOnData(boolean flag)
Sets the flag indicating whether or not the domain crosshair should "lock-on" to actual data values.
void setDomainCrosshairPaint(Paint paint)
Sets the paint used to draw the crosshairs (if visible) and sends a PlotChangeEvent to all registered listeners.
void setDomainCrosshairStroke(Stroke stroke)
Sets the Stroke used to draw the crosshairs (if visible) and notifies registered listeners that the axis has been modified.
void setDomainCrosshairValue(double value, boolean notify)
Sets the domain crosshair value and, if requested, sends a PlotChangeEvent to all registered listeners (provided that the domain crosshair is visible).
void setDomainCrosshairValue(double value)
Sets the domain crosshair value and sends a PlotChangeEvent to all registered listeners (provided that the domain crosshair is visible).
void setDomainCrosshairVisible(boolean flag)
Sets the flag indicating whether or not the domain crosshair is visible and, if the flag changes, sends a PlotChangeEvent to all registered listeners.
void setDomainGridlinePaint(Paint paint)
Sets the paint for the grid lines plotted against the domain axis, and sends a PlotChangeEvent to all registered listeners.
void setDomainGridlineStroke(Stroke stroke)
Sets the stroke for the grid lines plotted against the domain axis, and sends a PlotChangeEvent to all registered listeners.
void setDomainGridlinesVisible(boolean visible)
Sets the flag that controls whether or not the domain grid-lines are visible.
void setDomainMinorGridlinePaint(Paint paint)
Sets the paint for the minor grid lines plotted against the domain axis, and sends a PlotChangeEvent to all registered listeners.
void setDomainMinorGridlineStroke(Stroke stroke)
Sets the stroke for the minor grid lines plotted against the domain axis, and sends a PlotChangeEvent to all registered listeners.
void setDomainMinorGridlinesVisible(boolean visible)
Sets the flag that controls whether or not the domain minor grid-lines are visible.
void setDomainPannable(boolean pannable)
Sets the flag that enables or disables panning of the plot along the domain axes.
void setDomainTickBandPaint(Paint paint)
Sets the paint for the domain tick bands.
void setDomainZeroBaselinePaint(Paint paint)
Sets the paint for the zero baseline plotted against the domain axis and sends a PlotChangeEvent to all registered listeners.
void setDomainZeroBaselineStroke(Stroke stroke)
Sets the stroke for the zero baseline for the domain axis, and sends a PlotChangeEvent to all registered listeners.
void setDomainZeroBaselineVisible(boolean visible)
Sets the flag that controls whether or not the zero baseline is displayed for the domain axis, and sends a PlotChangeEvent to all registered listeners.
void setFixedDomainAxisSpace(AxisSpace space)
Sets the fixed domain axis space and sends a PlotChangeEvent to all registered listeners.
void setFixedDomainAxisSpace(AxisSpace space, boolean notify)
Sets the fixed domain axis space and, if requested, sends a PlotChangeEvent to all registered listeners.
void setFixedLegendItems(LegendItemCollection items)
Sets the fixed legend items for the plot.
void setFixedRangeAxisSpace(AxisSpace space, boolean notify)
Sets the fixed range axis space and, if requested, sends a PlotChangeEvent to all registered listeners.
void setFixedRangeAxisSpace(AxisSpace space)
Sets the fixed range axis space and sends a PlotChangeEvent to all registered listeners.
void setOrientation(PlotOrientation orientation)
Sets the orientation for the plot and sends a PlotChangeEvent to all registered listeners.
void setQuadrantOrigin(Point2D origin)
Sets the quadrant origin and sends a PlotChangeEvent to all registered listeners.
void setQuadrantPaint(int index, Paint paint)
Sets the paint used for the specified quadrant and sends a PlotChangeEvent to all registered listeners.
void setRangeAxes(ValueAxis[] axes)
Sets the range axes for this plot and sends a PlotChangeEvent to all registered listeners.
void setRangeAxis(int index, ValueAxis axis, boolean notify)
Sets a range axis and, if requested, sends a PlotChangeEvent to all registered listeners.
void setRangeAxis(ValueAxis axis)
Sets the range axis for the plot and sends a PlotChangeEvent to all registered listeners.
void setRangeAxis(int index, ValueAxis axis)
Sets a range axis and sends a PlotChangeEvent to all registered listeners.
void setRangeAxisLocation(int index, AxisLocation location, boolean notify)
Sets the axis location for a domain axis and, if requested, sends a PlotChangeEvent to all registered listeners.
void setRangeAxisLocation(AxisLocation location)
Sets the location of the primary range axis and sends a PlotChangeEvent to all registered listeners.
void setRangeAxisLocation(AxisLocation location, boolean notify)
Sets the location of the primary range axis and, if requested, sends a PlotChangeEvent to all registered listeners.
void setRangeAxisLocation(int index, AxisLocation location)
Sets the location for a range axis and sends a PlotChangeEvent to all registered listeners.
void setRangeCrosshairLockedOnData(boolean flag)
Sets the flag indicating whether or not the range crosshair should "lock-on" to actual data values.
void setRangeCrosshairPaint(Paint paint)
Sets the paint used to color the crosshairs (if visible) and sends a PlotChangeEvent to all registered listeners.
void setRangeCrosshairStroke(Stroke stroke)
Sets the stroke used to draw the crosshairs (if visible) and sends a PlotChangeEvent to all registered listeners.
void setRangeCrosshairValue(double value)
Sets the range crosshair value.
void setRangeCrosshairValue(double value, boolean notify)
Sets the range crosshair value and sends a PlotChangeEvent to all registered listeners, but only if the crosshair is visible.
void setRangeCrosshairVisible(boolean flag)
Sets the flag indicating whether or not the range crosshair is visible.
void setRangeGridlinePaint(Paint paint)
Sets the paint for the grid lines plotted against the range axis and sends a PlotChangeEvent to all registered listeners.
void setRangeGridlineStroke(Stroke stroke)
Sets the stroke for the grid lines plotted against the range axis, and sends a PlotChangeEvent to all registered listeners.
void setRangeGridlinesVisible(boolean visible)
Sets the flag that controls whether or not the range axis grid lines are visible.
void setRangeMinorGridlinePaint(Paint paint)
Sets the paint for the minor grid lines plotted against the range axis and sends a PlotChangeEvent to all registered listeners.
void setRangeMinorGridlineStroke(Stroke stroke)
Sets the stroke for the minor grid lines plotted against the range axis, and sends a PlotChangeEvent to all registered listeners.
void setRangeMinorGridlinesVisible(boolean visible)
Sets the flag that controls whether or not the range axis minor grid lines are visible.
void setRangePannable(boolean pannable)
Sets the flag that enables or disables panning of the plot along the range axes.
void setRangeTickBandPaint(Paint paint)
Sets the paint for the range tick bands.
void setRangeZeroBaselinePaint(Paint paint)
Sets the paint for the zero baseline plotted against the range axis and sends a PlotChangeEvent to all registered listeners.
void setRangeZeroBaselineStroke(Stroke stroke)
Sets the stroke for the zero baseline for the range axis, and sends a PlotChangeEvent to all registered listeners.
void setRangeZeroBaselineVisible(boolean visible)
Sets the flag that controls whether or not the zero baseline is displayed for the range axis, and sends a PlotChangeEvent to all registered listeners.
void setRenderer(int index, XYItemRenderer renderer)
Sets a renderer and sends a PlotChangeEvent to all registered listeners.
void setRenderer(int index, XYItemRenderer renderer, boolean notify)
Sets a renderer and sends a PlotChangeEvent to all registered listeners.
void setRenderer(XYItemRenderer renderer)
Sets the renderer for the primary dataset and sends a PlotChangeEvent to all registered listeners.
void setRenderers(XYItemRenderer[] renderers)
Sets the renderers for this plot and sends a PlotChangeEvent to all registered listeners.
void setSeriesRenderingOrder(SeriesRenderingOrder order)
Sets the series order and sends a PlotChangeEvent to all registered listeners.
void setWeight(int weight)
Sets the weight for the plot and sends a PlotChangeEvent to all registered listeners.
void zoomDomainAxes(double factor, PlotRenderingInfo info, Point2D source, boolean useAnchor)
Multiplies the range on the domain axis/axes by the specified factor.
void zoomDomainAxes(double factor, PlotRenderingInfo info, Point2D source)
Multiplies the range on the domain axis/axes by the specified factor.
void zoomDomainAxes(double lowerPercent, double upperPercent, PlotRenderingInfo info, Point2D source)
Zooms in on the domain axis/axes.
void zoomRangeAxes(double factor, PlotRenderingInfo info, Point2D source, boolean useAnchor)
Multiplies the range on the range axis/axes by the specified factor.
void zoomRangeAxes(double lowerPercent, double upperPercent, PlotRenderingInfo info, Point2D source)
Zooms in on the range axes.
void zoomRangeAxes(double factor, PlotRenderingInfo info, Point2D source)
Multiplies the range on the range axis/axes by the specified factor.
Protected Methods
AxisSpace calculateAxisSpace(Graphics2D g2, Rectangle2D plotArea)
Calculates the space required for all the axes in the plot.
AxisSpace calculateDomainAxisSpace(Graphics2D g2, Rectangle2D plotArea, AxisSpace space)
Calculates the space required for the domain axis/axes.
AxisSpace calculateRangeAxisSpace(Graphics2D g2, Rectangle2D plotArea, AxisSpace space)
Calculates the space required for the range axis/axes.
Map drawAxes(Graphics2D g2, Rectangle2D plotArea, Rectangle2D dataArea, PlotRenderingInfo plotState)
A utility method for drawing the axes.
void drawDomainCrosshair(Graphics2D g2, Rectangle2D dataArea, PlotOrientation orientation, double value, ValueAxis axis, Stroke stroke, Paint paint)
Draws a domain crosshair.
void drawDomainGridlines(Graphics2D g2, Rectangle2D dataArea, List ticks)
Draws the gridlines for the plot, if they are visible.
void drawDomainMarkers(Graphics2D g2, Rectangle2D dataArea, int index, Layer layer)
Draws the domain markers (if any) for an axis and layer.
void drawHorizontalLine(Graphics2D g2, Rectangle2D dataArea, double value, Stroke stroke, Paint paint)
Utility method for drawing a horizontal line across the data area of the plot.
void drawQuadrants(Graphics2D g2, Rectangle2D area)
Draws the quadrants.
void drawRangeCrosshair(Graphics2D g2, Rectangle2D dataArea, PlotOrientation orientation, double value, ValueAxis axis, Stroke stroke, Paint paint)
Draws a range crosshair.
void drawRangeGridlines(Graphics2D g2, Rectangle2D area, List ticks)
Draws the gridlines for the plot's primary range axis, if they are visible.
void drawRangeMarkers(Graphics2D g2, Rectangle2D dataArea, int index, Layer layer)
Draws the range markers (if any) for a renderer and layer.
void drawVerticalLine(Graphics2D g2, Rectangle2D dataArea, double value, Stroke stroke, Paint paint)
Utility method for drawing a vertical line on the data area of the plot.
void drawZeroDomainBaseline(Graphics2D g2, Rectangle2D area)
Draws a base line across the chart at value zero on the domain axis.
void drawZeroRangeBaseline(Graphics2D g2, Rectangle2D area)
Draws a base line across the chart at value zero on the range axis.
[Expand]
Inherited Methods
From class org.jfree.chart.plot.Plot
From class java.lang.Object
From interface org.jfree.chart.LegendItemSource
From interface org.jfree.chart.event.AxisChangeListener
From interface org.jfree.chart.event.MarkerChangeListener
From interface org.jfree.chart.event.RendererChangeListener
From interface org.jfree.chart.plot.Pannable
From interface org.jfree.chart.plot.ValueAxisPlot
From interface org.jfree.chart.plot.Zoomable
From interface org.jfree.data.general.DatasetChangeListener

Constants

public static final boolean DEFAULT_CROSSHAIR_VISIBLE

The default crosshair visibility.

Constant Value: false

Fields

public static final Paint DEFAULT_CROSSHAIR_PAINT

The default crosshair paint.

public static final Stroke DEFAULT_CROSSHAIR_STROKE

The default crosshair stroke.

public static final Paint DEFAULT_GRIDLINE_PAINT

The default grid line paint.

public static final Stroke DEFAULT_GRIDLINE_STROKE

The default grid line stroke.

protected static ResourceBundle localizationResources

The resourceBundle for the localization.

Public Constructors

public XYPlot ()

Creates a new XYPlot instance with no dataset, no axes and no renderer. You should specify these items before using the plot.

public XYPlot (XYDataset dataset, ValueAxis domainAxis, ValueAxis rangeAxis, XYItemRenderer renderer)

Creates a new plot with the specified dataset, axes and renderer. Any of the arguments can be null, but in that case you should take care to specify the value before using the plot (otherwise a NullPointerException may be thrown).

Parameters
dataset the dataset (null permitted).
domainAxis the domain axis (null permitted).
rangeAxis the range axis (null permitted).
renderer the renderer (null permitted).

Public Methods

public void addAnnotation (XYAnnotation annotation)

Adds an annotation to the plot and sends a PlotChangeEvent to all registered listeners.

Parameters
annotation the annotation (null not permitted).
See Also

public void addAnnotation (XYAnnotation annotation, boolean notify)

Adds an annotation to the plot and, if requested, sends a PlotChangeEvent to all registered listeners.

Parameters
annotation the annotation (null not permitted).
notify notify listeners?

public void addDomainMarker (int index, Marker marker, Layer layer)

Adds a marker for a specific dataset/renderer and sends a PlotChangeEvent to all registered listeners.

Typically a marker will be drawn by the renderer as a line perpendicular to the domain axis (that the renderer is mapped to), however this is entirely up to the renderer.

Parameters
index the dataset/renderer index.
marker the marker.
layer the layer (foreground or background).
See Also

public void addDomainMarker (int index, Marker marker, Layer layer, boolean notify)

Adds a marker for a specific dataset/renderer and, if requested, sends a PlotChangeEvent to all registered listeners.

Typically a marker will be drawn by the renderer as a line perpendicular to the domain axis (that the renderer is mapped to), however this is entirely up to the renderer.

Parameters
index the dataset/renderer index.
marker the marker.
layer the layer (foreground or background).
notify notify listeners?

public void addDomainMarker (Marker marker)

Adds a marker for the domain axis and sends a PlotChangeEvent to all registered listeners.

Typically a marker will be drawn by the renderer as a line perpendicular to the range axis, however this is entirely up to the renderer.

Parameters
marker the marker (null not permitted).
See Also

public void addDomainMarker (Marker marker, Layer layer)

Adds a marker for the domain axis in the specified layer and sends a PlotChangeEvent to all registered listeners.

Typically a marker will be drawn by the renderer as a line perpendicular to the range axis, however this is entirely up to the renderer.

Parameters
marker the marker (null not permitted).
layer the layer (foreground or background).
See Also

public void addRangeMarker (int index, Marker marker, Layer layer, boolean notify)

Adds a marker for a specific dataset/renderer and, if requested, sends a PlotChangeEvent to all registered listeners.

Typically a marker will be drawn by the renderer as a line perpendicular to the range axis, however this is entirely up to the renderer.

Parameters
index the dataset/renderer index.
marker the marker.
layer the layer (foreground or background).
notify notify listeners?

public void addRangeMarker (Marker marker)

Adds a marker for the range axis and sends a PlotChangeEvent to all registered listeners.

Typically a marker will be drawn by the renderer as a line perpendicular to the range axis, however this is entirely up to the renderer.

Parameters
marker the marker (null not permitted).
See Also

public void addRangeMarker (Marker marker, Layer layer)

Adds a marker for the range axis in the specified layer and sends a PlotChangeEvent to all registered listeners.

Typically a marker will be drawn by the renderer as a line perpendicular to the range axis, however this is entirely up to the renderer.

Parameters
marker the marker (null not permitted).
layer the layer (foreground or background).
See Also

public void addRangeMarker (int index, Marker marker, Layer layer)

Adds a marker for a specific dataset/renderer and sends a PlotChangeEvent to all registered listeners.

Typically a marker will be drawn by the renderer as a line perpendicular to the range axis, however this is entirely up to the renderer.

Parameters
index the dataset/renderer index.
marker the marker.
layer the layer (foreground or background).
See Also

public void clearAnnotations ()

Clears all the annotations and sends a PlotChangeEvent to all registered listeners.

See Also

public void clearDomainAxes ()

Clears the domain axes from the plot and sends a PlotChangeEvent to all registered listeners.

See Also

public void clearDomainMarkers (int index)

Clears the (foreground and background) domain markers for a particular renderer.

Parameters
index the renderer index.
See Also

public void clearDomainMarkers ()

Clears all the (foreground and background) domain markers and sends a PlotChangeEvent to all registered listeners.

See Also

public void clearRangeAxes ()

Clears the range axes from the plot and sends a PlotChangeEvent to all registered listeners.

See Also

public void clearRangeMarkers (int index)

Clears the (foreground and background) range markers for a particular renderer.

Parameters
index the renderer index.

public void clearRangeMarkers ()

Clears all the range markers and sends a PlotChangeEvent to all registered listeners.

See Also

public Object clone ()

Returns a clone of the plot.

Returns
  • A clone.
Throws
CloneNotSupportedException this can occur if some component of the plot cannot be cloned.

public void configureDomainAxes ()

Configures the domain axes.

public void configureRangeAxes ()

Configures the range axes.

See Also

public void datasetChanged (DatasetChangeEvent event)

Receives notification of a change to the plot's dataset.

The axis ranges are updated if necessary.

Parameters
event information about the event (not used here).

public void draw (Graphics2D g2, Rectangle2D area, Point2D anchor, PlotState parentState, PlotRenderingInfo info)

Draws the plot within the specified area on a graphics device.

Parameters
g2 the graphics device.
area the plot area (in Java2D space).
anchor an anchor point in Java2D space (null permitted).
parentState the state from the parent plot, if there is one (null permitted).
info collects chart drawing information (null permitted).

public void drawAnnotations (Graphics2D g2, Rectangle2D dataArea, PlotRenderingInfo info)

Draws the annotations for the plot.

Parameters
g2 the graphics device.
dataArea the data area.
info the chart rendering info.

public void drawBackground (Graphics2D g2, Rectangle2D area)

Draws the background for the plot.

Parameters
g2 the graphics device.
area the area.

public void drawDomainTickBands (Graphics2D g2, Rectangle2D dataArea, List ticks)

Draws the domain tick bands, if any.

Parameters
g2 the graphics device.
dataArea the data area.
ticks the ticks.
See Also

public void drawRangeTickBands (Graphics2D g2, Rectangle2D dataArea, List ticks)

Draws the range tick bands, if any.

Parameters
g2 the graphics device.
dataArea the data area.
ticks the ticks.
See Also

public boolean equals (Object obj)

Tests this plot for equality with another object.

Parameters
obj the object (null permitted).
Returns
  • true or false.

public List getAnnotations ()

Returns the list of annotations.

Returns
  • The list of annotations.
See Also

public RectangleInsets getAxisOffset ()

Returns the axis offset.

Returns
  • The axis offset (never null).
See Also

public Range getDataRange (ValueAxis axis)

Returns the range for the specified axis.

Parameters
axis the axis.
Returns
  • The range.

public XYDataset getDataset (int index)

Returns a dataset.

Parameters
index the dataset index.
Returns
  • The dataset (possibly null).
See Also

public XYDataset getDataset ()

Returns the primary dataset for the plot.

Returns
  • The primary dataset (possibly null).
See Also

public int getDatasetCount ()

Returns the number of datasets.

Returns
  • The number of datasets.

public DatasetRenderingOrder getDatasetRenderingOrder ()

Returns the dataset rendering order.

Returns
  • The order (never null).
See Also

public ValueAxis getDomainAxis (int index)

Returns the domain axis with the specified index, or null.

Parameters
index the axis index.
Returns
  • The axis (null possible).
See Also

public ValueAxis getDomainAxis ()

Returns the domain axis with index 0. If the domain axis for this plot is null, then the method will return the parent plot's domain axis (if there is a parent plot).

Returns
  • The domain axis (possibly null).
See Also

public int getDomainAxisCount ()

Returns the number of domain axes.

Returns
  • The axis count.
See Also

public RectangleEdge getDomainAxisEdge (int index)

Returns the edge for a domain axis.

Parameters
index the axis index.
Returns
  • The edge.
See Also

public RectangleEdge getDomainAxisEdge ()

Returns the edge for the primary domain axis (taking into account the plot's orientation).

Returns
  • The edge.
See Also

public ValueAxis getDomainAxisForDataset (int index)

Returns the domain axis for a dataset.

Parameters
index the dataset index.
Returns
  • The axis.

public int getDomainAxisIndex (ValueAxis axis)

Returns the index of the given domain axis.

Parameters
axis the axis.
Returns
  • The axis index.
See Also

public AxisLocation getDomainAxisLocation (int index)

Returns the location for a domain axis. If this hasn't been set explicitly, the method returns the location that is opposite to the primary domain axis location.

Parameters
index the axis index.
Returns
  • The location (never null).
See Also

public AxisLocation getDomainAxisLocation ()

Returns the location of the primary domain axis.

Returns
  • The location (never null).
See Also

public Paint getDomainCrosshairPaint ()

Returns the domain crosshair paint.

Returns
  • The crosshair paint (never null).
See Also

public Stroke getDomainCrosshairStroke ()

Returns the Stroke used to draw the crosshair (if visible).

Returns
  • The crosshair stroke (never null).
See Also

public double getDomainCrosshairValue ()

Returns the domain crosshair value.

Returns
  • The value.
See Also

public Paint getDomainGridlinePaint ()

Returns the paint for the grid lines (if any) plotted against the domain axis.

Returns
  • The paint (never null).
See Also

public Stroke getDomainGridlineStroke ()

Returns the stroke for the grid-lines (if any) plotted against the domain axis.

Returns
  • The stroke (never null).
See Also

public Collection getDomainMarkers (int index, Layer layer)

Returns a collection of domain markers for a particular renderer and layer.

Parameters
index the renderer index.
layer the layer.
Returns
  • A collection of markers (possibly null).
See Also

public Collection getDomainMarkers (Layer layer)

Returns the list of domain markers (read only) for the specified layer.

Parameters
layer the layer (foreground or background).
Returns
  • The list of domain markers.
See Also

public Paint getDomainMinorGridlinePaint ()

Returns the paint for the minor grid lines (if any) plotted against the domain axis.

Returns
  • The paint (never null).
See Also

public Stroke getDomainMinorGridlineStroke ()

Returns the stroke for the minor grid-lines (if any) plotted against the domain axis.

Returns
  • The stroke (never null).
See Also

public Paint getDomainTickBandPaint ()

Returns the paint used for the domain tick bands. If this is null, no tick bands will be drawn.

Returns
  • The paint (possibly null).
See Also

public Paint getDomainZeroBaselinePaint ()

Returns the paint for the zero baseline (if any) plotted against the domain axis.

Returns
  • The paint (never null).
See Also

public Stroke getDomainZeroBaselineStroke ()

Returns the stroke used for the zero baseline against the domain axis.

Returns
  • The stroke (never null).
See Also

public AxisSpace getFixedDomainAxisSpace ()

Returns the fixed domain axis space.

Returns
  • The fixed domain axis space (possibly null).
See Also

public LegendItemCollection getFixedLegendItems ()

Returns the fixed legend items, if any.

Returns
  • The legend items (possibly null).
See Also

public AxisSpace getFixedRangeAxisSpace ()

Returns the fixed range axis space.

Returns
  • The fixed range axis space (possibly null).
See Also

public int getIndexOf (XYItemRenderer renderer)

Returns the index of the specified renderer, or -1 if the renderer is not assigned to this plot.

Parameters
renderer the renderer (null permitted).
Returns
  • The renderer index.

public LegendItemCollection getLegendItems ()

Returns the legend items for the plot. Each legend item is generated by the plot's renderer, since the renderer is responsible for the visual representation of the data.

Returns
  • The legend items.

public PlotOrientation getOrientation ()

Returns the orientation of the plot.

Returns
  • The orientation (never null).
See Also

public String getPlotType ()

Returns the plot type as a string.

Returns
  • A short string describing the type of plot.

public Point2D getQuadrantOrigin ()

Returns the origin for the quadrants that can be displayed on the plot. This defaults to (0, 0).

Returns
  • The origin point (never null).
See Also

public Paint getQuadrantPaint (int index)

Returns the paint used for the specified quadrant.

Parameters
index the quadrant index (0-3).
Returns
  • The paint (possibly null).
See Also

public ValueAxis getRangeAxis (int index)

Returns a range axis.

Parameters
index the axis index.
Returns
  • The axis (null possible).
See Also

public ValueAxis getRangeAxis ()

Returns the range axis for the plot. If the range axis for this plot is null, then the method will return the parent plot's range axis (if there is a parent plot).

Returns
  • The range axis.
See Also

public int getRangeAxisCount ()

Returns the number of range axes.

Returns
  • The axis count.
See Also

public RectangleEdge getRangeAxisEdge ()

Returns the edge for the primary range axis.

Returns
  • The range axis edge.
See Also

public RectangleEdge getRangeAxisEdge (int index)

Returns the edge for a range axis.

Parameters
index the axis index.
Returns
  • The edge.
See Also

public ValueAxis getRangeAxisForDataset (int index)

Returns the range axis for a dataset.

Parameters
index the dataset index.
Returns
  • The axis.

public int getRangeAxisIndex (ValueAxis axis)

Returns the index of the given range axis.

Parameters
axis the axis.
Returns
  • The axis index.
See Also

public AxisLocation getRangeAxisLocation (int index)

Returns the location for a range axis. If this hasn't been set explicitly, the method returns the location that is opposite to the primary range axis location.

Parameters
index the axis index.
Returns
  • The location (never null).
See Also

public AxisLocation getRangeAxisLocation ()

Returns the location of the primary range axis.

Returns
  • The location (never null).
See Also

public Paint getRangeCrosshairPaint ()

Returns the range crosshair paint.

Returns
  • The crosshair paint (never null).
See Also

public Stroke getRangeCrosshairStroke ()

Returns the stroke used to draw the crosshair (if visible).

Returns
  • The crosshair stroke (never null).
See Also

public double getRangeCrosshairValue ()

Returns the range crosshair value.

Returns
  • The value.
See Also

public Paint getRangeGridlinePaint ()

Returns the paint for the grid lines (if any) plotted against the range axis.

Returns
  • The paint (never null).
See Also

public Stroke getRangeGridlineStroke ()

Returns the stroke for the grid lines (if any) plotted against the range axis.

Returns
  • The stroke (never null).
See Also

public Collection getRangeMarkers (int index, Layer layer)

Returns a collection of range markers for a particular renderer and layer.

Parameters
index the renderer index.
layer the layer.
Returns
  • A collection of markers (possibly null).
See Also

public Collection getRangeMarkers (Layer layer)

Returns the list of range markers (read only) for the specified layer.

Parameters
layer the layer (foreground or background).
Returns
  • The list of range markers.
See Also

public Paint getRangeMinorGridlinePaint ()

Returns the paint for the minor grid lines (if any) plotted against the range axis.

Returns
  • The paint (never null).
See Also

public Stroke getRangeMinorGridlineStroke ()

Returns the stroke for the minor grid lines (if any) plotted against the range axis.

Returns
  • The stroke (never null).
See Also

public Paint getRangeTickBandPaint ()

Returns the paint used for the range tick bands. If this is null, no tick bands will be drawn.

Returns
  • The paint (possibly null).
See Also

public Paint getRangeZeroBaselinePaint ()

Returns the paint for the zero baseline (if any) plotted against the range axis.

Returns
  • The paint (never null).
See Also

public Stroke getRangeZeroBaselineStroke ()

Returns the stroke used for the zero baseline against the range axis.

Returns
  • The stroke (never null).
See Also

public XYItemRenderer getRenderer (int index)

Returns the renderer for a dataset, or null.

Parameters
index the renderer index.
Returns
  • The renderer (possibly null).
See Also

public XYItemRenderer getRenderer ()

Returns the renderer for the primary dataset.

Returns
  • The item renderer (possibly null).
See Also

public int getRendererCount ()

Returns the number of renderer slots for this plot.

Returns
  • The number of renderer slots.

public XYItemRenderer getRendererForDataset (XYDataset dataset)

Returns the renderer for the specified dataset. The code first determines the index of the dataset, then checks if there is a renderer with the same index (if not, the method returns renderer(0).

Parameters
dataset the dataset (null permitted).
Returns
  • The renderer (possibly null).

public int getSeriesCount ()

Returns the number of series in the primary dataset for this plot. If the dataset is null, the method returns 0.

Returns
  • The series count.

public SeriesRenderingOrder getSeriesRenderingOrder ()

Returns the series rendering order.

Returns
  • the order (never null).
See Also

public int getWeight ()

Returns the weight for this plot when it is used as a subplot within a combined plot.

Returns
  • The weight.
See Also

public void handleClick (int x, int y, PlotRenderingInfo info)

Handles a 'click' on the plot by updating the anchor values.

Parameters
x the x-coordinate, where the click occurred, in Java2D space.
y the y-coordinate, where the click occurred, in Java2D space.
info object containing information about the plot dimensions.

public int indexOf (XYDataset dataset)

Returns the index of the specified dataset, or -1 if the dataset does not belong to the plot.

Parameters
dataset the dataset (null not permitted).
Returns
  • The index.

public boolean isDomainCrosshairLockedOnData ()

Returns a flag indicating whether or not the crosshair should "lock-on" to actual data values.

Returns
  • The flag.
See Also

public boolean isDomainCrosshairVisible ()

Returns a flag indicating whether or not the domain crosshair is visible.

Returns
  • The flag.
See Also

public boolean isDomainGridlinesVisible ()

Returns true if the domain gridlines are visible, and false otherwise.

Returns
  • true or false.
See Also

public boolean isDomainMinorGridlinesVisible ()

Returns true if the domain minor gridlines are visible, and false otherwise.

Returns
  • true or false.
See Also

public boolean isDomainPannable ()

Returns true if panning is enabled for the domain axes, and false otherwise.

Returns
  • A boolean.

public boolean isDomainZeroBaselineVisible ()

Returns a flag that controls whether or not a zero baseline is displayed for the domain axis.

Returns
  • A boolean.
See Also

public boolean isDomainZoomable ()

Returns true, indicating that the domain axis/axes for this plot are zoomable.

Returns
  • A boolean.
See Also

public boolean isRangeCrosshairLockedOnData ()

Returns a flag indicating whether or not the crosshair should "lock-on" to actual data values.

Returns
  • The flag.
See Also

public boolean isRangeCrosshairVisible ()

Returns a flag indicating whether or not the range crosshair is visible.

Returns
  • The flag.
See Also

public boolean isRangeGridlinesVisible ()

Returns true if the range axis grid is visible, and false otherwise.

Returns
  • A boolean.
See Also

public boolean isRangeMinorGridlinesVisible ()

Returns true if the range axis minor grid is visible, and false otherwise.

Returns
  • A boolean.
See Also

public boolean isRangePannable ()

Returns true if panning is enabled for the range axes, and false otherwise.

Returns
  • A boolean.

public boolean isRangeZeroBaselineVisible ()

Returns a flag that controls whether or not a zero baseline is displayed for the range axis.

Returns
  • A boolean.
See Also

public boolean isRangeZoomable ()

Returns true, indicating that the range axis/axes for this plot are zoomable.

Returns
  • A boolean.
See Also

public void mapDatasetToDomainAxes (int index, List axisIndices)

Maps the specified dataset to the axes in the list. Note that the conversion of data values into Java2D space is always performed using the first axis in the list.

Parameters
index the dataset index (zero-based).
axisIndices the axis indices (null permitted).

public void mapDatasetToDomainAxis (int index, int axisIndex)

Maps a dataset to a particular domain axis. All data will be plotted against axis zero by default, no mapping is required for this case.

Parameters
index the dataset index (zero-based).
axisIndex the axis index.
See Also

public void mapDatasetToRangeAxes (int index, List axisIndices)

Maps the specified dataset to the axes in the list. Note that the conversion of data values into Java2D space is always performed using the first axis in the list.

Parameters
index the dataset index (zero-based).
axisIndices the axis indices (null permitted).

public void mapDatasetToRangeAxis (int index, int axisIndex)

Maps a dataset to a particular range axis. All data will be plotted against axis zero by default, no mapping is required for this case.

Parameters
index the dataset index (zero-based).
axisIndex the axis index.
See Also

public void panDomainAxes (double percent, PlotRenderingInfo info, Point2D source)

Pans the domain axes by the specified percentage.

Parameters
percent the distance to pan (as a percentage of the axis length).
info the plot info
source the source point where the pan action started.

public void panRangeAxes (double percent, PlotRenderingInfo info, Point2D source)

Pans the range axes by the specified percentage.

Parameters
percent the distance to pan (as a percentage of the axis length).
info the plot info
source the source point where the pan action started.

public boolean removeAnnotation (XYAnnotation annotation)

Removes an annotation from the plot and sends a PlotChangeEvent to all registered listeners.

Parameters
annotation the annotation (null not permitted).
Returns
  • A boolean (indicates whether or not the annotation was removed).
See Also

public boolean removeAnnotation (XYAnnotation annotation, boolean notify)

Removes an annotation from the plot and sends a PlotChangeEvent to all registered listeners.

Parameters
annotation the annotation (null not permitted).
notify notify listeners?
Returns
  • A boolean (indicates whether or not the annotation was removed).

public boolean removeDomainMarker (int index, Marker marker, Layer layer)

Removes a marker for a specific dataset/renderer and sends a PlotChangeEvent to all registered listeners.

Parameters
index the dataset/renderer index.
marker the marker.
layer the layer (foreground or background).
Returns
  • A boolean indicating whether or not the marker was actually removed.

public boolean removeDomainMarker (Marker marker, Layer layer)

Removes a marker for the domain axis in the specified layer and sends a PlotChangeEvent to all registered listeners.

Parameters
marker the marker (null not permitted).
layer the layer (foreground or background).
Returns
  • A boolean indicating whether or not the marker was actually removed.

public boolean removeDomainMarker (Marker marker)

Removes a marker for the domain axis and sends a PlotChangeEvent to all registered listeners.

Parameters
marker the marker.
Returns
  • A boolean indicating whether or not the marker was actually removed.

public boolean removeDomainMarker (int index, Marker marker, Layer layer, boolean notify)

Removes a marker for a specific dataset/renderer and, if requested, sends a PlotChangeEvent to all registered listeners.

Parameters
index the dataset/renderer index.
marker the marker.
layer the layer (foreground or background).
notify notify listeners?
Returns
  • A boolean indicating whether or not the marker was actually removed.

public boolean removeRangeMarker (int index, Marker marker, Layer layer, boolean notify)

Removes a marker for a specific dataset/renderer and sends a PlotChangeEvent to all registered listeners.

Parameters
index the dataset/renderer index.
marker the marker.
layer the layer (foreground or background).
notify notify listeners?
Returns
  • A boolean indicating whether or not the marker was actually removed.

public boolean removeRangeMarker (Marker marker)

Removes a marker for the range axis and sends a PlotChangeEvent to all registered listeners.

Parameters
marker the marker.
Returns
  • A boolean indicating whether or not the marker was actually removed.

public boolean removeRangeMarker (int index, Marker marker, Layer layer)

Removes a marker for a specific dataset/renderer and sends a PlotChangeEvent to all registered listeners.

Parameters
index the dataset/renderer index.
marker the marker.
layer the layer (foreground or background).
Returns
  • A boolean indicating whether or not the marker was actually removed.

public boolean removeRangeMarker (Marker marker, Layer layer)

Removes a marker for the range axis in the specified layer and sends a PlotChangeEvent to all registered listeners.

Parameters
marker the marker (null not permitted).
layer the layer (foreground or background).
Returns
  • A boolean indicating whether or not the marker was actually removed.

public boolean render (Graphics2D g2, Rectangle2D dataArea, int index, PlotRenderingInfo info, CrosshairState crosshairState)

Draws a representation of the data within the dataArea region, using the current renderer.

The info and crosshairState arguments may be null.

Parameters
g2 the graphics device.
dataArea the region in which the data is to be drawn.
index the dataset index.
info an optional object for collection dimension information.
crosshairState collects crosshair information (null permitted).
Returns
  • A flag that indicates whether any data was actually rendered.

public void rendererChanged (RendererChangeEvent event)

Receives notification of a renderer change event.

Parameters
event the event.

public void setAxisOffset (RectangleInsets offset)

Sets the axis offsets (gap between the data area and the axes) and sends a PlotChangeEvent to all registered listeners.

Parameters
offset the offset (null not permitted).
See Also

public void setDataset (XYDataset dataset)

Sets the primary dataset for the plot, replacing the existing dataset if there is one.

Parameters
dataset the dataset (null permitted).
See Also

public void setDataset (int index, XYDataset dataset)

Sets a dataset for the plot.

Parameters
index the dataset index.
dataset the dataset (null permitted).
See Also

public void setDatasetRenderingOrder (DatasetRenderingOrder order)

Sets the rendering order and sends a PlotChangeEvent to all registered listeners. By default, the plot renders the primary dataset last (so that the primary dataset overlays the secondary datasets). You can reverse this if you want to.

Parameters
order the rendering order (null not permitted).
See Also

public void setDomainAxes (ValueAxis[] axes)

Sets the domain axes for this plot and sends a PlotChangeEvent to all registered listeners.

Parameters
axes the axes (null not permitted).
See Also

public void setDomainAxis (int index, ValueAxis axis)

Sets a domain axis and sends a PlotChangeEvent to all registered listeners.

Parameters
index the axis index.
axis the axis (null permitted).
See Also

public void setDomainAxis (ValueAxis axis)

Sets the domain axis for the plot and sends a PlotChangeEvent to all registered listeners.

Parameters
axis the new axis (null permitted).
See Also

public void setDomainAxis (int index, ValueAxis axis, boolean notify)

Sets a domain axis and, if requested, sends a PlotChangeEvent to all registered listeners.

Parameters
index the axis index.
axis the axis.
notify notify listeners?
See Also

public void setDomainAxisLocation (int index, AxisLocation location, boolean notify)

Sets the axis location for a domain axis and, if requested, sends a PlotChangeEvent to all registered listeners.

Parameters
index the axis index.
location the location (null not permitted for index 0).
notify notify listeners?
See Also

public void setDomainAxisLocation (int index, AxisLocation location)

Sets the location for a domain axis and sends a PlotChangeEvent to all registered listeners.

Parameters
index the axis index.
location the location (null not permitted for index 0).
See Also

public void setDomainAxisLocation (AxisLocation location, boolean notify)

Sets the location of the domain axis and, if requested, sends a PlotChangeEvent to all registered listeners.

Parameters
location the location (null not permitted).
notify notify listeners?
See Also

public void setDomainAxisLocation (AxisLocation location)

Sets the location of the primary domain axis and sends a PlotChangeEvent to all registered listeners.

Parameters
location the location (null not permitted).
See Also

public void setDomainCrosshairLockedOnData (boolean flag)

Sets the flag indicating whether or not the domain crosshair should "lock-on" to actual data values. If the flag value changes, this method sends a PlotChangeEvent to all registered listeners.

Parameters
flag the flag.
See Also

public void setDomainCrosshairPaint (Paint paint)

Sets the paint used to draw the crosshairs (if visible) and sends a PlotChangeEvent to all registered listeners.

Parameters
paint the new crosshair paint (null not permitted).
See Also

public void setDomainCrosshairStroke (Stroke stroke)

Sets the Stroke used to draw the crosshairs (if visible) and notifies registered listeners that the axis has been modified.

Parameters
stroke the new crosshair stroke (null not permitted).
See Also

public void setDomainCrosshairValue (double value, boolean notify)

Sets the domain crosshair value and, if requested, sends a PlotChangeEvent to all registered listeners (provided that the domain crosshair is visible).

Parameters
value the new value.
notify notify listeners?
See Also

public void setDomainCrosshairValue (double value)

Sets the domain crosshair value and sends a PlotChangeEvent to all registered listeners (provided that the domain crosshair is visible).

Parameters
value the value.
See Also

public void setDomainCrosshairVisible (boolean flag)

Sets the flag indicating whether or not the domain crosshair is visible and, if the flag changes, sends a PlotChangeEvent to all registered listeners.

Parameters
flag the new value of the flag.
See Also

public void setDomainGridlinePaint (Paint paint)

Sets the paint for the grid lines plotted against the domain axis, and sends a PlotChangeEvent to all registered listeners.

Parameters
paint the paint (null not permitted).
Throws
IllegalArgumentException if paint is null.
See Also

public void setDomainGridlineStroke (Stroke stroke)

Sets the stroke for the grid lines plotted against the domain axis, and sends a PlotChangeEvent to all registered listeners.

Parameters
stroke the stroke (null not permitted).
Throws
IllegalArgumentException if stroke is null.
See Also

public void setDomainGridlinesVisible (boolean visible)

Sets the flag that controls whether or not the domain grid-lines are visible.

If the flag value is changed, a PlotChangeEvent is sent to all registered listeners.

Parameters
visible the new value of the flag.
See Also

public void setDomainMinorGridlinePaint (Paint paint)

Sets the paint for the minor grid lines plotted against the domain axis, and sends a PlotChangeEvent to all registered listeners.

Parameters
paint the paint (null not permitted).
Throws
IllegalArgumentException if paint is null.
See Also

public void setDomainMinorGridlineStroke (Stroke stroke)

Sets the stroke for the minor grid lines plotted against the domain axis, and sends a PlotChangeEvent to all registered listeners.

Parameters
stroke the stroke (null not permitted).
Throws
IllegalArgumentException if stroke is null.
See Also

public void setDomainMinorGridlinesVisible (boolean visible)

Sets the flag that controls whether or not the domain minor grid-lines are visible.

If the flag value is changed, a PlotChangeEvent is sent to all registered listeners.

Parameters
visible the new value of the flag.
See Also

public void setDomainPannable (boolean pannable)

Sets the flag that enables or disables panning of the plot along the domain axes.

Parameters
pannable the new flag value.

public void setDomainTickBandPaint (Paint paint)

Sets the paint for the domain tick bands.

Parameters
paint the paint (null permitted).
See Also

public void setDomainZeroBaselinePaint (Paint paint)

Sets the paint for the zero baseline plotted against the domain axis and sends a PlotChangeEvent to all registered listeners.

Parameters
paint the paint (null not permitted).
See Also

public void setDomainZeroBaselineStroke (Stroke stroke)

Sets the stroke for the zero baseline for the domain axis, and sends a PlotChangeEvent to all registered listeners.

Parameters
stroke the stroke (null not permitted).
See Also

public void setDomainZeroBaselineVisible (boolean visible)

Sets the flag that controls whether or not the zero baseline is displayed for the domain axis, and sends a PlotChangeEvent to all registered listeners.

Parameters
visible the flag.
See Also

public void setFixedDomainAxisSpace (AxisSpace space)

Sets the fixed domain axis space and sends a PlotChangeEvent to all registered listeners.

Parameters
space the space (null permitted).
See Also

public void setFixedDomainAxisSpace (AxisSpace space, boolean notify)

Sets the fixed domain axis space and, if requested, sends a PlotChangeEvent to all registered listeners.

Parameters
space the space (null permitted).
notify notify listeners?
See Also

public void setFixedLegendItems (LegendItemCollection items)

Sets the fixed legend items for the plot. Leave this set to null if you prefer the legend items to be created automatically.

Parameters
items the legend items (null permitted).
See Also

public void setFixedRangeAxisSpace (AxisSpace space, boolean notify)

Sets the fixed range axis space and, if requested, sends a PlotChangeEvent to all registered listeners.

Parameters
space the space (null permitted).
notify notify listeners?
See Also

public void setFixedRangeAxisSpace (AxisSpace space)

Sets the fixed range axis space and sends a PlotChangeEvent to all registered listeners.

Parameters
space the space (null permitted).
See Also

public void setOrientation (PlotOrientation orientation)

Sets the orientation for the plot and sends a PlotChangeEvent to all registered listeners.

Parameters
orientation the orientation (null not allowed).
See Also

public void setQuadrantOrigin (Point2D origin)

Sets the quadrant origin and sends a PlotChangeEvent to all registered listeners.

Parameters
origin the origin (null not permitted).
See Also

public void setQuadrantPaint (int index, Paint paint)

Sets the paint used for the specified quadrant and sends a PlotChangeEvent to all registered listeners.

Parameters
index the quadrant index (0-3).
paint the paint (null permitted).
See Also

public void setRangeAxes (ValueAxis[] axes)

Sets the range axes for this plot and sends a PlotChangeEvent to all registered listeners.

Parameters
axes the axes (null not permitted).
See Also

public void setRangeAxis (int index, ValueAxis axis, boolean notify)

Sets a range axis and, if requested, sends a PlotChangeEvent to all registered listeners.

Parameters
index the axis index.
axis the axis (null permitted).
notify notify listeners?
See Also

public void setRangeAxis (ValueAxis axis)

Sets the range axis for the plot and sends a PlotChangeEvent to all registered listeners.

Parameters
axis the axis (null permitted).
See Also

public void setRangeAxis (int index, ValueAxis axis)

Sets a range axis and sends a PlotChangeEvent to all registered listeners.

Parameters
index the axis index.
axis the axis (null permitted).
See Also

public void setRangeAxisLocation (int index, AxisLocation location, boolean notify)

Sets the axis location for a domain axis and, if requested, sends a PlotChangeEvent to all registered listeners.

Parameters
index the axis index.
location the location (null not permitted for index 0).
notify notify listeners?
See Also

public void setRangeAxisLocation (AxisLocation location)

Sets the location of the primary range axis and sends a PlotChangeEvent to all registered listeners.

Parameters
location the location (null not permitted).
See Also

public void setRangeAxisLocation (AxisLocation location, boolean notify)

Sets the location of the primary range axis and, if requested, sends a PlotChangeEvent to all registered listeners.

Parameters
location the location (null not permitted).
notify notify listeners?
See Also

public void setRangeAxisLocation (int index, AxisLocation location)

Sets the location for a range axis and sends a PlotChangeEvent to all registered listeners.

Parameters
index the axis index.
location the location (null permitted).
See Also

public void setRangeCrosshairLockedOnData (boolean flag)

Sets the flag indicating whether or not the range crosshair should "lock-on" to actual data values. If the flag value changes, this method sends a PlotChangeEvent to all registered listeners.

Parameters
flag the flag.
See Also

public void setRangeCrosshairPaint (Paint paint)

Sets the paint used to color the crosshairs (if visible) and sends a PlotChangeEvent to all registered listeners.

Parameters
paint the new crosshair paint (null not permitted).
See Also

public void setRangeCrosshairStroke (Stroke stroke)

Sets the stroke used to draw the crosshairs (if visible) and sends a PlotChangeEvent to all registered listeners.

Parameters
stroke the new crosshair stroke (null not permitted).
See Also

public void setRangeCrosshairValue (double value)

Sets the range crosshair value.

Registered listeners are notified that the plot has been modified, but only if the crosshair is visible.

Parameters
value the new value.
See Also

public void setRangeCrosshairValue (double value, boolean notify)

Sets the range crosshair value and sends a PlotChangeEvent to all registered listeners, but only if the crosshair is visible.

Parameters
value the new value.
notify a flag that controls whether or not listeners are notified.
See Also

public void setRangeCrosshairVisible (boolean flag)

Sets the flag indicating whether or not the range crosshair is visible. If the flag value changes, this method sends a PlotChangeEvent to all registered listeners.

Parameters
flag the new value of the flag.
See Also

public void setRangeGridlinePaint (Paint paint)

Sets the paint for the grid lines plotted against the range axis and sends a PlotChangeEvent to all registered listeners.

Parameters
paint the paint (null not permitted).
See Also

public void setRangeGridlineStroke (Stroke stroke)

Sets the stroke for the grid lines plotted against the range axis, and sends a PlotChangeEvent to all registered listeners.

Parameters
stroke the stroke (null not permitted).
See Also

public void setRangeGridlinesVisible (boolean visible)

Sets the flag that controls whether or not the range axis grid lines are visible.

If the flag value is changed, a PlotChangeEvent is sent to all registered listeners.

Parameters
visible the new value of the flag.
See Also

public void setRangeMinorGridlinePaint (Paint paint)

Sets the paint for the minor grid lines plotted against the range axis and sends a PlotChangeEvent to all registered listeners.

Parameters
paint the paint (null not permitted).
See Also

public void setRangeMinorGridlineStroke (Stroke stroke)

Sets the stroke for the minor grid lines plotted against the range axis, and sends a PlotChangeEvent to all registered listeners.

Parameters
stroke the stroke (null not permitted).
See Also

public void setRangeMinorGridlinesVisible (boolean visible)

Sets the flag that controls whether or not the range axis minor grid lines are visible.

If the flag value is changed, a PlotChangeEvent is sent to all registered listeners.

Parameters
visible the new value of the flag.
See Also

public void setRangePannable (boolean pannable)

Sets the flag that enables or disables panning of the plot along the range axes.

Parameters
pannable the new flag value.

public void setRangeTickBandPaint (Paint paint)

Sets the paint for the range tick bands.

Parameters
paint the paint (null permitted).
See Also

public void setRangeZeroBaselinePaint (Paint paint)

Sets the paint for the zero baseline plotted against the range axis and sends a PlotChangeEvent to all registered listeners.

Parameters
paint the paint (null not permitted).
See Also

public void setRangeZeroBaselineStroke (Stroke stroke)

Sets the stroke for the zero baseline for the range axis, and sends a PlotChangeEvent to all registered listeners.

Parameters
stroke the stroke (null not permitted).
See Also

public void setRangeZeroBaselineVisible (boolean visible)

Sets the flag that controls whether or not the zero baseline is displayed for the range axis, and sends a PlotChangeEvent to all registered listeners.

Parameters
visible the flag.
See Also

public void setRenderer (int index, XYItemRenderer renderer)

Sets a renderer and sends a PlotChangeEvent to all registered listeners.

Parameters
index the index.
renderer the renderer.
See Also

public void setRenderer (int index, XYItemRenderer renderer, boolean notify)

Sets a renderer and sends a PlotChangeEvent to all registered listeners.

Parameters
index the index.
renderer the renderer.
notify notify listeners?
See Also

public void setRenderer (XYItemRenderer renderer)

Sets the renderer for the primary dataset and sends a PlotChangeEvent to all registered listeners. If the renderer is set to null, no data will be displayed.

Parameters
renderer the renderer (null permitted).
See Also

public void setRenderers (XYItemRenderer[] renderers)

Sets the renderers for this plot and sends a PlotChangeEvent to all registered listeners.

Parameters
renderers the renderers (null not permitted).

public void setSeriesRenderingOrder (SeriesRenderingOrder order)

Sets the series order and sends a PlotChangeEvent to all registered listeners. By default, the plot renders the primary series last (so that the primary series appears to be on top). You can reverse this if you want to.

Parameters
order the rendering order (null not permitted).
See Also

public void setWeight (int weight)

Sets the weight for the plot and sends a PlotChangeEvent to all registered listeners.

Parameters
weight the weight.
See Also

public void zoomDomainAxes (double factor, PlotRenderingInfo info, Point2D source, boolean useAnchor)

Multiplies the range on the domain axis/axes by the specified factor.

Parameters
factor the zoom factor.
info the plot rendering info.
source the source point (in Java2D space).
useAnchor use source point as zoom anchor?
See Also

public void zoomDomainAxes (double factor, PlotRenderingInfo info, Point2D source)

Multiplies the range on the domain axis/axes by the specified factor.

Parameters
factor the zoom factor.
info the plot rendering info.
source the source point (in Java2D space).
See Also

public void zoomDomainAxes (double lowerPercent, double upperPercent, PlotRenderingInfo info, Point2D source)

Zooms in on the domain axis/axes. The new lower and upper bounds are specified as percentages of the current axis range, where 0 percent is the current lower bound and 100 percent is the current upper bound.

Parameters
lowerPercent a percentage that determines the new lower bound for the axis (e.g. 0.20 is twenty percent).
upperPercent a percentage that determines the new upper bound for the axis (e.g. 0.80 is eighty percent).
info the plot rendering info.
source the source point (ignored).
See Also

public void zoomRangeAxes (double factor, PlotRenderingInfo info, Point2D source, boolean useAnchor)

Multiplies the range on the range axis/axes by the specified factor.

Parameters
factor the zoom factor.
info the plot rendering info.
source the source point.
useAnchor a flag that controls whether or not the source point is used for the zoom anchor.
See Also

public void zoomRangeAxes (double lowerPercent, double upperPercent, PlotRenderingInfo info, Point2D source)

Zooms in on the range axes.

Parameters
lowerPercent the lower bound.
upperPercent the upper bound.
info the plot rendering info.
source the source point.
See Also

public void zoomRangeAxes (double factor, PlotRenderingInfo info, Point2D source)

Multiplies the range on the range axis/axes by the specified factor.

Parameters
factor the zoom factor.
info the plot rendering info.
source the source point.
See Also

Protected Methods

protected AxisSpace calculateAxisSpace (Graphics2D g2, Rectangle2D plotArea)

Calculates the space required for all the axes in the plot.

Parameters
g2 the graphics device.
plotArea the plot area.
Returns
  • The required space.

protected AxisSpace calculateDomainAxisSpace (Graphics2D g2, Rectangle2D plotArea, AxisSpace space)

Calculates the space required for the domain axis/axes.

Parameters
g2 the graphics device.
plotArea the plot area.
space a carrier for the result (null permitted).
Returns
  • The required space.

protected AxisSpace calculateRangeAxisSpace (Graphics2D g2, Rectangle2D plotArea, AxisSpace space)

Calculates the space required for the range axis/axes.

Parameters
g2 the graphics device.
plotArea the plot area.
space a carrier for the result (null permitted).
Returns
  • The required space.

protected Map drawAxes (Graphics2D g2, Rectangle2D plotArea, Rectangle2D dataArea, PlotRenderingInfo plotState)

A utility method for drawing the axes.

Parameters
g2 the graphics device (null not permitted).
plotArea the plot area (null not permitted).
dataArea the data area (null not permitted).
plotState collects information about the plot (null permitted).
Returns
  • A map containing the state for each axis drawn.

protected void drawDomainCrosshair (Graphics2D g2, Rectangle2D dataArea, PlotOrientation orientation, double value, ValueAxis axis, Stroke stroke, Paint paint)

Draws a domain crosshair.

Parameters
g2 the graphics target.
dataArea the data area.
orientation the plot orientation.
value the crosshair value.
axis the axis against which the value is measured.
stroke the stroke used to draw the crosshair line.
paint the paint used to draw the crosshair line.

protected void drawDomainGridlines (Graphics2D g2, Rectangle2D dataArea, List ticks)

Draws the gridlines for the plot, if they are visible.

Parameters
g2 the graphics device.
dataArea the data area.
ticks the ticks.
See Also

protected void drawDomainMarkers (Graphics2D g2, Rectangle2D dataArea, int index, Layer layer)

Draws the domain markers (if any) for an axis and layer. This method is typically called from within the draw() method.

Parameters
g2 the graphics device.
dataArea the data area.
index the renderer index.
layer the layer (foreground or background).

protected void drawHorizontalLine (Graphics2D g2, Rectangle2D dataArea, double value, Stroke stroke, Paint paint)

Utility method for drawing a horizontal line across the data area of the plot.

Parameters
g2 the graphics device.
dataArea the data area.
value the coordinate, where to draw the line.
stroke the stroke to use.
paint the paint to use.

protected void drawQuadrants (Graphics2D g2, Rectangle2D area)

Draws the quadrants.

Parameters
g2 the graphics device.
area the area.
See Also

protected void drawRangeCrosshair (Graphics2D g2, Rectangle2D dataArea, PlotOrientation orientation, double value, ValueAxis axis, Stroke stroke, Paint paint)

Draws a range crosshair.

Parameters
g2 the graphics target.
dataArea the data area.
orientation the plot orientation.
value the crosshair value.
axis the axis against which the value is measured.
stroke the stroke used to draw the crosshair line.
paint the paint used to draw the crosshair line.

protected void drawRangeGridlines (Graphics2D g2, Rectangle2D area, List ticks)

Draws the gridlines for the plot's primary range axis, if they are visible.

Parameters
g2 the graphics device.
area the data area.
ticks the ticks.
See Also

protected void drawRangeMarkers (Graphics2D g2, Rectangle2D dataArea, int index, Layer layer)

Draws the range markers (if any) for a renderer and layer. This method is typically called from within the draw() method.

Parameters
g2 the graphics device.
dataArea the data area.
index the renderer index.
layer the layer (foreground or background).

protected void drawVerticalLine (Graphics2D g2, Rectangle2D dataArea, double value, Stroke stroke, Paint paint)

Utility method for drawing a vertical line on the data area of the plot.

Parameters
g2 the graphics device.
dataArea the data area.
value the coordinate, where to draw the line.
stroke the stroke to use.
paint the paint to use.

protected void drawZeroDomainBaseline (Graphics2D g2, Rectangle2D area)

Draws a base line across the chart at value zero on the domain axis.

Parameters
g2 the graphics device.
area the data area.
See Also

protected void drawZeroRangeBaseline (Graphics2D g2, Rectangle2D area)

Draws a base line across the chart at value zero on the range axis.

Parameters
g2 the graphics device.
area the data area.
See Also