Module platform
Package org.jfree.chart.plot

Class XYPlot

java.lang.Object
org.jfree.chart.plot.Plot
org.jfree.chart.plot.XYPlot
All Implemented Interfaces:
Disposable, Serializable, Cloneable, EventListener, AnnotationChangeListener, AxisChangeListener, MarkerChangeListener, RendererChangeListener, LegendItemSource, Pannable, ValueAxisPlot, Zoomable, PublicCloneable, DatasetChangeListener
Direct Known Subclasses:
CombinedDomainXYPlot, CombinedRangeXYPlot
public class XYPlot extends Plot implements ValueAxisPlot, Pannable, Zoomable, RendererChangeListener, Cloneable, PublicCloneable, Serializable
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.

See Also:

  • Field Details

    • DEFAULT_GRIDLINE_STROKE

      public static final Stroke DEFAULT_GRIDLINE_STROKE
      The default grid line stroke.

    • DEFAULT_GRIDLINE_PAINT

      public static final Paint DEFAULT_GRIDLINE_PAINT
      The default grid line paint.

    • DEFAULT_CROSSHAIR_VISIBLE

      public static final boolean DEFAULT_CROSSHAIR_VISIBLE
      The default crosshair visibility.
      See Also:

    • DEFAULT_CROSSHAIR_STROKE

      public static final Stroke DEFAULT_CROSSHAIR_STROKE
      The default crosshair stroke.

    • DEFAULT_CROSSHAIR_PAINT

      public static final Paint DEFAULT_CROSSHAIR_PAINT
      The default crosshair paint.

    • localizationResources

      protected static ResourceBundle localizationResources
      The resourceBundle for the localization.

  • Constructor Details

    • XYPlot

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

    • XYPlot

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

  • Method Details

    • getPlotType

      public String getPlotType()
      Returns the plot type as a string.
      Specified by:
      getPlotType in class Plot
      Returns:
      A short string describing the type of plot.

    • getOrientation

      public PlotOrientation getOrientation()
      Returns the orientation of the plot.
      Specified by:
      getOrientation in interface Pannable
      Specified by:
      getOrientation in interface Zoomable
      Returns:
      The orientation (never null).
      See Also:

    • setOrientation

      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:

    • getAxisOffset

      public RectangleInsets getAxisOffset()
      Returns the axis offset.
      Returns:
      The axis offset (never null).
      See Also:

    • setAxisOffset

      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:

    • getDomainAxis

      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:

    • getDomainAxis

      public ValueAxis getDomainAxis(int index)
      Returns the domain axis with the specified index, or null if there is no axis with that index.
      Parameters:
      index - the axis index.
      Returns:
      The axis (null possible).
      See Also:

    • setDomainAxis

      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:

    • setDomainAxis

      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:

    • setDomainAxis

      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:

    • setDomainAxes

      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:

    • getDomainAxisLocation

      public AxisLocation getDomainAxisLocation()
      Returns the location of the primary domain axis.
      Returns:
      The location (never null).
      See Also:

    • setDomainAxisLocation

      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:

    • setDomainAxisLocation

      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:

    • getDomainAxisEdge

      public RectangleEdge getDomainAxisEdge()
      Returns the edge for the primary domain axis (taking into account the plot's orientation).
      Returns:
      The edge.
      See Also:

    • getDomainAxisCount

      public int getDomainAxisCount()
      Returns the number of domain axes.
      Returns:
      The axis count.
      See Also:

    • clearDomainAxes

      public void clearDomainAxes()
      Clears the domain axes from the plot and sends a PlotChangeEvent to all registered listeners.
      See Also:

    • configureDomainAxes

      public void configureDomainAxes()
      Configures the domain axes.

    • getDomainAxisLocation

      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 (must be >= 0).
      Returns:
      The location (never null).
      See Also:

    • setDomainAxisLocation

      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:

    • setDomainAxisLocation

      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 (must be >= 0).
      location - the location (null not permitted for index 0).
      notify - notify listeners?
      See Also:

    • getDomainAxisEdge

      public RectangleEdge getDomainAxisEdge(int index)
      Returns the edge for a domain axis.
      Parameters:
      index - the axis index.
      Returns:
      The edge.
      See Also:

    • getRangeAxis

      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:

    • setRangeAxis

      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:

    • getRangeAxisLocation

      public AxisLocation getRangeAxisLocation()
      Returns the location of the primary range axis.
      Returns:
      The location (never null).
      See Also:

    • setRangeAxisLocation

      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:

    • setRangeAxisLocation

      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:

    • getRangeAxisEdge

      public RectangleEdge getRangeAxisEdge()
      Returns the edge for the primary range axis.
      Returns:
      The range axis edge.
      See Also:

    • getRangeAxis

      public ValueAxis getRangeAxis(int index)
      Returns the range axis with the specified index, or null if there is no axis with that index.
      Parameters:
      index - the axis index (must be >= 0).
      Returns:
      The axis (null possible).
      See Also:

    • setRangeAxis

      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:

    • setRangeAxis

      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:

    • setRangeAxes

      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:

    • getRangeAxisCount

      public int getRangeAxisCount()
      Returns the number of range axes.
      Returns:
      The axis count.
      See Also:

    • clearRangeAxes

      public void clearRangeAxes()
      Clears the range axes from the plot and sends a PlotChangeEvent to all registered listeners.
      See Also:

    • configureRangeAxes

      public void configureRangeAxes()
      Configures the range axes.
      See Also:

    • getRangeAxisLocation

      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 (must be >= 0).
      Returns:
      The location (never null).
      See Also:

    • setRangeAxisLocation

      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:

    • setRangeAxisLocation

      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:

    • getRangeAxisEdge

      public RectangleEdge getRangeAxisEdge(int index)
      Returns the edge for a range axis.
      Parameters:
      index - the axis index.
      Returns:
      The edge.
      See Also:

    • getDataset

      public XYDataset getDataset()
      Returns the primary dataset for the plot.
      Returns:
      The primary dataset (possibly null).
      See Also:

    • getDataset

      public XYDataset getDataset(int index)
      Returns the dataset with the specified index, or null if there is no dataset with that index.
      Parameters:
      index - the dataset index (must be >= 0).
      Returns:
      The dataset (possibly null).
      See Also:

    • setDataset

      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:

    • setDataset

      public void setDataset(int index, XYDataset dataset)
      Sets a dataset for the plot and sends a change event to all registered listeners.
      Parameters:
      index - the dataset index (must be >= 0).
      dataset - the dataset (null permitted).
      See Also:

    • getDatasetCount

      public int getDatasetCount()
      Returns the number of datasets.
      Returns:
      The number of datasets.

    • indexOf

      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 or -1.

    • mapDatasetToDomainAxis

      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:

    • mapDatasetToDomainAxes

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

    • mapDatasetToRangeAxis

      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:

    • mapDatasetToRangeAxes

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

    • getRendererCount

      public int getRendererCount()
      Returns the number of renderer slots for this plot.
      Returns:
      The number of renderer slots.

    • getRenderer

      public XYItemRenderer getRenderer()
      Returns the renderer for the primary dataset.
      Returns:
      The item renderer (possibly null).
      See Also:

    • getRenderer

      public XYItemRenderer getRenderer(int index)
      Returns the renderer with the specified index, or null.
      Parameters:
      index - the renderer index (must be >= 0).
      Returns:
      The renderer (possibly null).
      See Also:

    • setRenderer

      public void setRenderer(XYItemRenderer renderer)
      Sets the renderer for the primary dataset and sends a change event to all registered listeners. If the renderer is set to null, no data will be displayed.
      Parameters:
      renderer - the renderer (null permitted).
      See Also:

    • setRenderer

      public void setRenderer(int index, XYItemRenderer renderer)
      Sets the renderer for the dataset with the specified index and sends a change event to all registered listeners. Note that each dataset should have its own renderer, you should not use one renderer for multiple datasets.
      Parameters:
      index - the index (must be >= 0).
      renderer - the renderer.
      See Also:

    • setRenderer

      public void setRenderer(int index, XYItemRenderer renderer, boolean notify)
      Sets the renderer for the dataset with the specified index and, if requested, sends a change event to all registered listeners. Note that each dataset should have its own renderer, you should not use one renderer for multiple datasets.
      Parameters:
      index - the index (must be >= 0).
      renderer - the renderer.
      notify - notify listeners?
      See Also:

    • setRenderers

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

    • getDatasetRenderingOrder

      public DatasetRenderingOrder getDatasetRenderingOrder()
      Returns the dataset rendering order.
      Returns:
      The order (never null).
      See Also:

    • setDatasetRenderingOrder

      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:

    • getSeriesRenderingOrder

      public SeriesRenderingOrder getSeriesRenderingOrder()
      Returns the series rendering order.
      Returns:
      the order (never null).
      See Also:

    • setSeriesRenderingOrder

      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:

    • getIndexOf

      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.

    • getRendererForDataset

      public XYItemRenderer getRendererForDataset(XYDataset dataset)
      Returns the renderer for the specified dataset (this is either the renderer with the same index as the dataset or, if there isn't a renderer with the same index, the default renderer). If the dataset does not belong to the plot, this method will return null.
      Parameters:
      dataset - the dataset (null permitted).
      Returns:
      The renderer (possibly null).

    • getWeight

      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:

    • setWeight

      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:

    • isDomainGridlinesVisible

      public boolean isDomainGridlinesVisible()
      Returns true if the domain gridlines are visible, and false otherwise.
      Returns:
      true or false.
      See Also:

    • setDomainGridlinesVisible

      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:

    • isDomainMinorGridlinesVisible

      public boolean isDomainMinorGridlinesVisible()
      Returns true if the domain minor gridlines are visible, and false otherwise.
      Returns:
      true or false.
      See Also:

    • setDomainMinorGridlinesVisible

      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:

    • getDomainGridlineStroke

      public Stroke getDomainGridlineStroke()
      Returns the stroke for the grid-lines (if any) plotted against the domain axis.
      Returns:
      The stroke (never null).
      See Also:

    • setDomainGridlineStroke

      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:

    • getDomainMinorGridlineStroke

      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:

    • setDomainMinorGridlineStroke

      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:

    • getDomainGridlinePaint

      public Paint getDomainGridlinePaint()
      Returns the paint for the grid lines (if any) plotted against the domain axis.
      Returns:
      The paint (never null).
      See Also:

    • setDomainGridlinePaint

      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:

    • getDomainMinorGridlinePaint

      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:

    • setDomainMinorGridlinePaint

      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:

    • isRangeGridlinesVisible

      public boolean isRangeGridlinesVisible()
      Returns true if the range axis grid is visible, and false otherwise.
      Returns:
      A boolean.
      See Also:

    • setRangeGridlinesVisible

      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:

    • getRangeGridlineStroke

      public Stroke getRangeGridlineStroke()
      Returns the stroke for the grid lines (if any) plotted against the range axis.
      Returns:
      The stroke (never null).
      See Also:

    • setRangeGridlineStroke

      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:

    • getRangeGridlinePaint

      public Paint getRangeGridlinePaint()
      Returns the paint for the grid lines (if any) plotted against the range axis.
      Returns:
      The paint (never null).
      See Also:

    • setRangeGridlinePaint

      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:

    • isRangeMinorGridlinesVisible

      public boolean isRangeMinorGridlinesVisible()
      Returns true if the range axis minor grid is visible, and false otherwise.
      Returns:
      A boolean.
      See Also:

    • setRangeMinorGridlinesVisible

      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:

    • getRangeMinorGridlineStroke

      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:

    • setRangeMinorGridlineStroke

      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:

    • getRangeMinorGridlinePaint

      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:

    • setRangeMinorGridlinePaint

      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:

    • isDomainZeroBaselineVisible

      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:

    • setDomainZeroBaselineVisible

      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:

    • getDomainZeroBaselineStroke

      public Stroke getDomainZeroBaselineStroke()
      Returns the stroke used for the zero baseline against the domain axis.
      Returns:
      The stroke (never null).
      See Also:

    • setDomainZeroBaselineStroke

      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:

    • getDomainZeroBaselinePaint

      public Paint getDomainZeroBaselinePaint()
      Returns the paint for the zero baseline (if any) plotted against the domain axis.
      Returns:
      The paint (never null).
      See Also:

    • setDomainZeroBaselinePaint

      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:

    • isRangeZeroBaselineVisible

      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:

    • setRangeZeroBaselineVisible

      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:

    • getRangeZeroBaselineStroke

      public Stroke getRangeZeroBaselineStroke()
      Returns the stroke used for the zero baseline against the range axis.
      Returns:
      The stroke (never null).
      See Also:

    • setRangeZeroBaselineStroke

      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:

    • getRangeZeroBaselinePaint

      public Paint getRangeZeroBaselinePaint()
      Returns the paint for the zero baseline (if any) plotted against the range axis.
      Returns:
      The paint (never null).
      See Also:

    • setRangeZeroBaselinePaint

      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:

    • getDomainTickBandPaint

      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:

    • setDomainTickBandPaint

      public void setDomainTickBandPaint(Paint paint)
      Sets the paint for the domain tick bands.
      Parameters:
      paint - the paint (null permitted).
      See Also:

    • getRangeTickBandPaint

      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:

    • setRangeTickBandPaint

      public void setRangeTickBandPaint(Paint paint)
      Sets the paint for the range tick bands.
      Parameters:
      paint - the paint (null permitted).
      See Also:

    • getQuadrantOrigin

      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:

    • setQuadrantOrigin

      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:

    • getQuadrantPaint

      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:

    • setQuadrantPaint

      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:

    • addDomainMarker

      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 domain axis, however this is entirely up to the renderer.

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

    • addDomainMarker

      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 domain axis, however this is entirely up to the renderer.

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

    • clearDomainMarkers

      public void clearDomainMarkers()
      Clears all the (foreground and background) domain markers and sends a PlotChangeEvent to all registered listeners.
      See Also:

    • clearDomainMarkers

      public void clearDomainMarkers(int index)
      Clears the (foreground and background) domain markers for a particular renderer and sends a PlotChangeEvent to all registered listeners.
      Parameters:
      index - the renderer index.
      See Also:

    • addDomainMarker

      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:

    • addDomainMarker

      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?

    • removeDomainMarker

      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.

    • removeDomainMarker

      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.

    • removeDomainMarker

      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.

    • removeDomainMarker

      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.

    • addRangeMarker

      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:

    • addRangeMarker

      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:

    • clearRangeMarkers

      public void clearRangeMarkers()
      Clears all the range markers and sends a PlotChangeEvent to all registered listeners.
      See Also:

    • addRangeMarker

      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:

    • addRangeMarker

      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?

    • clearRangeMarkers

      public void clearRangeMarkers(int index)
      Clears the (foreground and background) range markers for a particular renderer.
      Parameters:
      index - the renderer index.

    • removeRangeMarker

      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.

    • removeRangeMarker

      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.

    • removeRangeMarker

      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 (null not permitted).
      layer - the layer (foreground or background).
      Returns:
      A boolean indicating whether or not the marker was actually removed.

    • removeRangeMarker

      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 (null not permitted).
      layer - the layer (foreground or background) (null not permitted).
      notify - notify listeners?
      Returns:
      A boolean indicating whether or not the marker was actually removed.

    • addAnnotation

      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:

    • addAnnotation

      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?

    • removeAnnotation

      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:

    • removeAnnotation

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

    • getAnnotations

      public List getAnnotations()
      Returns the list of annotations.
      Returns:
      The list of annotations.
      See Also:

    • clearAnnotations

      public void clearAnnotations()
      Clears all the annotations and sends a PlotChangeEvent to all registered listeners.
      See Also:

    • getShadowGenerator

      public ShadowGenerator getShadowGenerator()
      Returns the shadow generator for the plot, if any.
      Returns:
      The shadow generator (possibly null).

    • setShadowGenerator

      public void setShadowGenerator(ShadowGenerator generator)
      Sets the shadow generator for the plot and sends a PlotChangeEvent to all registered listeners.
      Parameters:
      generator - the generator (null permitted).

    • calculateAxisSpace

      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.

    • calculateDomainAxisSpace

      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.

    • calculateRangeAxisSpace

      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.

    • draw

      public void draw(Graphics2D g2, Rectangle2D area, Point2D anchor, PlotState parentState, PlotRenderingInfo info)
      Draws the plot within the specified area on a graphics device.
      Specified by:
      draw in class Plot
      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).

    • drawBackground

      public void drawBackground(Graphics2D g2, Rectangle2D area)
      Draws the background for the plot.
      Overrides:
      drawBackground in class Plot
      Parameters:
      g2 - the graphics device.
      area - the area.

    • drawQuadrants

      protected void drawQuadrants(Graphics2D g2, Rectangle2D area)
      Draws the quadrants.
      Parameters:
      g2 - the graphics device.
      area - the area.
      See Also:

    • drawDomainTickBands

      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:

    • drawRangeTickBands

      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:

    • drawAxes

      protected Map<Axis,AxisState> 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.

    • render

      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.

    • getDomainAxisForDataset

      public ValueAxis getDomainAxisForDataset(int index)
      Returns the domain axis for a dataset.
      Parameters:
      index - the dataset index (must be >= 0).
      Returns:
      The axis.

    • getRangeAxisForDataset

      public ValueAxis getRangeAxisForDataset(int index)
      Returns the range axis for a dataset.
      Parameters:
      index - the dataset index (must be >= 0).
      Returns:
      The axis.

    • drawDomainGridlines

      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:

    • drawRangeGridlines

      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:

    • drawZeroDomainBaseline

      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:

    • drawZeroRangeBaseline

      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:

    • drawAnnotations

      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.

    • drawDomainMarkers

      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 dataset/renderer index.
      layer - the layer (foreground or background).

    • drawRangeMarkers

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

    • getDomainMarkers

      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:

    • getRangeMarkers

      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:

    • getDomainMarkers

      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:

    • getRangeMarkers

      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:

    • drawHorizontalLine

      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.

    • drawDomainCrosshair

      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.

    • drawVerticalLine

      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.

    • drawRangeCrosshair

      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.

    • handleClick

      public void handleClick(int x, int y, PlotRenderingInfo info)
      Handles a 'click' on the plot by updating the anchor values.
      Overrides:
      handleClick in class Plot
      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.

    • getDomainAxisIndex

      public int getDomainAxisIndex(ValueAxis axis)
      Returns the index of the given domain axis.
      Parameters:
      axis - the axis.
      Returns:
      The axis index.
      See Also:

    • getRangeAxisIndex

      public int getRangeAxisIndex(ValueAxis axis)
      Returns the index of the given range axis.
      Parameters:
      axis - the axis.
      Returns:
      The axis index.
      See Also:

    • getDataRange

      public Range getDataRange(ValueAxis axis)
      Returns the range for the specified axis.
      Specified by:
      getDataRange in interface ValueAxisPlot
      Parameters:
      axis - the axis.
      Returns:
      The range.

    • annotationChanged

      public void annotationChanged(AnnotationChangeEvent event)
      Receives notification of a change to an Annotation added to this plot.
      Specified by:
      annotationChanged in interface AnnotationChangeListener
      Overrides:
      annotationChanged in class Plot
      Parameters:
      event - information about the event (not used here).

    • datasetChanged

      public void datasetChanged(DatasetChangeEvent event)
      Receives notification of a change to the plot's dataset.

      The axis ranges are updated if necessary.

      Specified by:
      datasetChanged in interface DatasetChangeListener
      Overrides:
      datasetChanged in class Plot
      Parameters:
      event - information about the event (not used here).

    • rendererChanged

      public void rendererChanged(RendererChangeEvent event)
      Receives notification of a renderer change event.
      Specified by:
      rendererChanged in interface RendererChangeListener
      Parameters:
      event - the event.

    • isDomainCrosshairVisible

      public boolean isDomainCrosshairVisible()
      Returns a flag indicating whether or not the domain crosshair is visible.
      Returns:
      The flag.
      See Also:

    • setDomainCrosshairVisible

      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:

    • isDomainCrosshairLockedOnData

      public boolean isDomainCrosshairLockedOnData()
      Returns a flag indicating whether or not the crosshair should "lock-on" to actual data values.
      Returns:
      The flag.
      See Also:

    • setDomainCrosshairLockedOnData

      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:

    • getDomainCrosshairValue

      public double getDomainCrosshairValue()
      Returns the domain crosshair value.
      Returns:
      The value.
      See Also:

    • setDomainCrosshairValue

      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:

    • setDomainCrosshairValue

      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:

    • getDomainCrosshairStroke

      public Stroke getDomainCrosshairStroke()
      Returns the Stroke used to draw the crosshair (if visible).
      Returns:
      The crosshair stroke (never null).
      See Also:

    • setDomainCrosshairStroke

      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:

    • getDomainCrosshairPaint

      public Paint getDomainCrosshairPaint()
      Returns the domain crosshair paint.
      Returns:
      The crosshair paint (never null).
      See Also:

    • setDomainCrosshairPaint

      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:

    • isRangeCrosshairVisible

      public boolean isRangeCrosshairVisible()
      Returns a flag indicating whether or not the range crosshair is visible.
      Returns:
      The flag.
      See Also:

    • setRangeCrosshairVisible

      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:

    • isRangeCrosshairLockedOnData

      public boolean isRangeCrosshairLockedOnData()
      Returns a flag indicating whether or not the crosshair should "lock-on" to actual data values.
      Returns:
      The flag.
      See Also:

    • setRangeCrosshairLockedOnData

      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:

    • getRangeCrosshairValue

      public double getRangeCrosshairValue()
      Returns the range crosshair value.
      Returns:
      The value.
      See Also:

    • setRangeCrosshairValue

      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:

    • setRangeCrosshairValue

      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:

    • getRangeCrosshairStroke

      public Stroke getRangeCrosshairStroke()
      Returns the stroke used to draw the crosshair (if visible).
      Returns:
      The crosshair stroke (never null).
      See Also:

    • setRangeCrosshairStroke

      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:

    • getRangeCrosshairPaint

      public Paint getRangeCrosshairPaint()
      Returns the range crosshair paint.
      Returns:
      The crosshair paint (never null).
      See Also:

    • setRangeCrosshairPaint

      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:

    • getFixedDomainAxisSpace

      public AxisSpace getFixedDomainAxisSpace()
      Returns the fixed domain axis space.
      Returns:
      The fixed domain axis space (possibly null).
      See Also:

    • setFixedDomainAxisSpace

      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:

    • setFixedDomainAxisSpace

      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:

    • getFixedRangeAxisSpace

      public AxisSpace getFixedRangeAxisSpace()
      Returns the fixed range axis space.
      Returns:
      The fixed range axis space (possibly null).
      See Also:

    • setFixedRangeAxisSpace

      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:

    • setFixedRangeAxisSpace

      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:

    • isDomainPannable

      public boolean isDomainPannable()
      Returns true if panning is enabled for the domain axes, and false otherwise.
      Specified by:
      isDomainPannable in interface Pannable
      Returns:
      A boolean.

    • setDomainPannable

      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.

    • isRangePannable

      public boolean isRangePannable()
      Returns true if panning is enabled for the range axis/axes, and false otherwise. The default value is false.
      Specified by:
      isRangePannable in interface Pannable
      Returns:
      A boolean.

    • setRangePannable

      public void setRangePannable(boolean pannable)
      Sets the flag that enables or disables panning of the plot along the range axis/axes.
      Parameters:
      pannable - the new flag value.

    • panDomainAxes

      public void panDomainAxes(double percent, PlotRenderingInfo info, Point2D source)
      Pans the domain axes by the specified percentage.
      Specified by:
      panDomainAxes in interface Pannable
      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.

    • panRangeAxes

      public void panRangeAxes(double percent, PlotRenderingInfo info, Point2D source)
      Pans the range axes by the specified percentage.
      Specified by:
      panRangeAxes in interface Pannable
      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.

    • zoomDomainAxes

      public void zoomDomainAxes(double factor, PlotRenderingInfo info, Point2D source)
      Multiplies the range on the domain axis/axes by the specified factor.
      Specified by:
      zoomDomainAxes in interface Zoomable
      Parameters:
      factor - the zoom factor.
      info - the plot rendering info.
      source - the source point (in Java2D space).
      See Also:

    • zoomDomainAxes

      public void zoomDomainAxes(double factor, PlotRenderingInfo info, Point2D source, boolean useAnchor)
      Multiplies the range on the domain axis/axes by the specified factor.
      Specified by:
      zoomDomainAxes in interface Zoomable
      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:

    • zoomDomainAxes

      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.
      Specified by:
      zoomDomainAxes in interface Zoomable
      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:

    • zoomRangeAxes

      public void zoomRangeAxes(double factor, PlotRenderingInfo info, Point2D source)
      Multiplies the range on the range axis/axes by the specified factor.
      Specified by:
      zoomRangeAxes in interface Zoomable
      Parameters:
      factor - the zoom factor.
      info - the plot rendering info.
      source - the source point.
      See Also:

    • zoomRangeAxes

      public void zoomRangeAxes(double factor, PlotRenderingInfo info, Point2D source, boolean useAnchor)
      Multiplies the range on the range axis/axes by the specified factor.
      Specified by:
      zoomRangeAxes in interface Zoomable
      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:

    • zoomRangeAxes

      public void zoomRangeAxes(double lowerPercent, double upperPercent, PlotRenderingInfo info, Point2D source)
      Zooms in on the range axes.
      Specified by:
      zoomRangeAxes in interface Zoomable
      Parameters:
      lowerPercent - the lower bound.
      upperPercent - the upper bound.
      info - the plot rendering info.
      source - the source point.
      See Also:

    • isDomainZoomable

      public boolean isDomainZoomable()
      Returns true, indicating that the domain axis/axes for this plot are zoomable.
      Specified by:
      isDomainZoomable in interface Zoomable
      Returns:
      A boolean.
      See Also:

    • isRangeZoomable

      public boolean isRangeZoomable()
      Returns true, indicating that the range axis/axes for this plot are zoomable.
      Specified by:
      isRangeZoomable in interface Zoomable
      Returns:
      A boolean.
      See Also:

    • getSeriesCount

      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.

    • getFixedLegendItems

      public LegendItemCollection getFixedLegendItems()
      Returns the fixed legend items, if any.
      Returns:
      The legend items (possibly null).
      See Also:

    • setFixedLegendItems

      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:

    • getLegendItems

      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.
      Specified by:
      getLegendItems in interface LegendItemSource
      Overrides:
      getLegendItems in class Plot
      Returns:
      The legend items.

    • equals

      public boolean equals(Object obj)
      Tests this plot for equality with another object.
      Overrides:
      equals in class Plot
      Parameters:
      obj - the object (null permitted).
      Returns:
      true or false.

    • clone

      public Object clone() throws CloneNotSupportedException
      Returns a clone of the plot.
      Specified by:
      clone in interface PublicCloneable
      Overrides:
      clone in class Plot
      Returns:
      A clone.
      Throws:
      CloneNotSupportedException - this can occur if some component of the plot cannot be cloned.

    • dispose

      public void dispose()
      Specified by:
      dispose in interface Disposable