Class XYPlot

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 boolean DEFAULT_CROSSHAIR_VISIBLE

The default crosshair visibility.

Field Value:

false

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 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 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:

getAnnotations(), removeAnnotation(XYAnnotation)

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:

clearDomainMarkers(int), addRangeMarker(int,Marker,Layer)

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:

addDomainMarker(Marker,Layer), clearDomainMarkers()

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:

addDomainMarker(int,Marker,Layer)

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:

clearRangeMarkers(int), addDomainMarker(int,Marker,Layer)

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(Marker,Layer)

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:

addRangeMarker(int,Marker,Layer)

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.

public void clearAnnotations()

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

See Also:

addAnnotation(XYAnnotation)

public void clearDomainAxes()

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

See Also:

clearRangeAxes()

public void clearDomainMarkers()

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

See Also:

addDomainMarker(int,Marker,Layer)

public void clearDomainMarkers(int index)

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

Parameters:

index - the renderer index.

See Also:

clearRangeMarkers(int)

public void clearRangeAxes()

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

See Also:

clearDomainAxes()

public void clearRangeMarkers()

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

See Also:

clearRangeMarkers()

public void clearRangeMarkers(int index)

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

Parameters:

index - the renderer index.

public Object clone()
            throws CloneNotSupportedException

Returns a clone of the plot.

Overrides:

clone in interface Plot

Returns:

A clone.

public void configureDomainAxes()

Configures the domain axes.

public void configureRangeAxes()

Configures the range axes.

See Also:

configureDomainAxes()

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 interface Plot

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.

Overrides:

draw in interface 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).

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.

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.

public void drawBackground(Graphics2D g2,
                           Rectangle2D area)

Draws the background for the plot.

Overrides:

drawBackground in interface Plot

Parameters:

g2 - the graphics device.

area - the area.

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.

Since:

1.0.4

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.

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

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:

setDomainTickBandPaint(Paint)

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:

setQuadrantOrigin(Point2D), setQuadrantPaint(int,Paint)

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.

Since:

1.0.4

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.

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

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:

setRangeTickBandPaint(Paint)

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.

Since:

1.0.5

See Also:

setDomainZeroBaselineVisible(boolean)

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:

setRangeZeroBaselineVisible(boolean)

public boolean equals(Object obj)

Tests this plot for equality with another object.

Overrides:

equals in interface Plot

Parameters:

obj - the object (null permitted).

Returns:

true or false.

public List getAnnotations()

Returns the list of annotations.

Returns:

The list of annotations.

Since:

1.0.1

See Also:

addAnnotation(XYAnnotation)

public RectangleInsets getAxisOffset()

Returns the axis offset.

Returns:

The axis offset (never null).

See Also:

setAxisOffset(RectangleInsets)

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.

public XYDataset getDataset()

Returns the primary dataset for the plot.

Returns:

The primary dataset (possibly null).

See Also:

getDataset(int), setDataset(XYDataset)

public XYDataset getDataset(int index)

Returns a dataset.

Parameters:

index - the dataset index.

Returns:

The dataset (possibly null).

See Also:

setDataset(int,XYDataset)

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:

setDatasetRenderingOrder(DatasetRenderingOrder)

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(int), setDomainAxis(ValueAxis)

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:

setDomainAxis(int,ValueAxis)

public int getDomainAxisCount()

Returns the number of domain axes.

Returns:

The axis count.

See Also:

getRangeAxisCount()

public RectangleEdge getDomainAxisEdge()

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

Returns:

The edge.

See Also:

getDomainAxisLocation(), getOrientation()

public RectangleEdge getDomainAxisEdge(int index)

Returns the edge for a domain axis.

Parameters:

index - the axis index.

Returns:

The edge.

See Also:

getRangeAxisEdge(int)

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:

getRangeAxisIndex(ValueAxis)

public AxisLocation getDomainAxisLocation()

Returns the location of the primary domain axis.

Returns:

The location (never null).

See Also:

setDomainAxisLocation(AxisLocation)

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:

setDomainAxisLocation(int,AxisLocation)

public Paint getDomainCrosshairPaint()

Returns the domain crosshair paint.

Returns:

The crosshair paint (never null).

See Also:

setDomainCrosshairPaint(Paint), isDomainCrosshairVisible(), getDomainCrosshairStroke()

public Stroke getDomainCrosshairStroke()

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

Returns:

The crosshair stroke (never null).

See Also:

setDomainCrosshairStroke(Stroke), isDomainCrosshairVisible(), getDomainCrosshairPaint()

public double getDomainCrosshairValue()

Returns the domain crosshair value.

Returns:

The value.

See Also:

setDomainCrosshairValue(double)

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(Paint)

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(Stroke)

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(Layer)

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(int,Layer)

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(Paint)

public Paint getDomainZeroBaselinePaint()

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

Returns:

The paint (never null).

Since:

1.0.5

See Also:

setDomainZeroBaselinePaint(Paint)

public Stroke getDomainZeroBaselineStroke()

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

Returns:

The stroke (never null).

Since:

1.0.5

See Also:

setDomainZeroBaselineStroke(Stroke)

public AxisSpace getFixedDomainAxisSpace()

Returns the fixed domain axis space.

Returns:

The fixed domain axis space (possibly null).

See Also:

setFixedDomainAxisSpace(AxisSpace)

public LegendItemCollection getFixedLegendItems()

Returns the fixed legend items, if any.

Returns:

The legend items (possibly null).

See Also:

setFixedLegendItems(LegendItemCollection)

public AxisSpace getFixedRangeAxisSpace()

Returns the fixed range axis space.

Returns:

The fixed range axis space (possibly null).

See Also:

setFixedRangeAxisSpace(AxisSpace)

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.

Specified by:

getLegendItems in interface LegendItemSource

Overrides:

getLegendItems in interface Plot

Returns:

The legend items.

public PlotOrientation getOrientation()

Returns the orientation of the plot.

Specified by:

getOrientation in interface Zoomable

Returns:

The orientation (never null).

See Also:

setOrientation(PlotOrientation)

public String getPlotType()

Returns the plot type as a string.

Overrides:

getPlotType in interface Plot

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:

setQuadrantOrigin(Point2D)

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(int,Paint)

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:

getRangeAxis(int), setRangeAxis(ValueAxis)

public ValueAxis getRangeAxis(int index)

Returns a range axis.

Parameters:

index - the axis index.

Returns:

The axis (null possible).

See Also:

setRangeAxis(int,ValueAxis)

public int getRangeAxisCount()

Returns the number of range axes.

Returns:

The axis count.

See Also:

getDomainAxisCount()

public RectangleEdge getRangeAxisEdge()

Returns the edge for the primary range axis.

Returns:

The range axis edge.

See Also:

getRangeAxisLocation(), getOrientation()

public RectangleEdge getRangeAxisEdge(int index)

Returns the edge for a range axis.

Parameters:

index - the axis index.

Returns:

The edge.

See Also:

getRangeAxisLocation(int), getOrientation()

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:

getDomainAxisIndex(ValueAxis)

public AxisLocation getRangeAxisLocation()

Returns the location of the primary range axis.

Returns:

The location (never null).

See Also:

setRangeAxisLocation(AxisLocation)

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:

setRangeAxisLocation(int,AxisLocation)

public Paint getRangeCrosshairPaint()

Returns the range crosshair paint.

Returns:

The crosshair paint (never null).

See Also:

setRangeCrosshairPaint(Paint), isRangeCrosshairVisible(), getRangeCrosshairStroke()

public Stroke getRangeCrosshairStroke()

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

Returns:

The crosshair stroke (never null).

See Also:

setRangeCrosshairStroke(Stroke), isRangeCrosshairVisible(), getRangeCrosshairPaint()

public double getRangeCrosshairValue()

Returns the range crosshair value.

Returns:

The value.

See Also:

setRangeCrosshairValue(double)

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(Paint)

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(Stroke)

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(Layer)

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:

getDomainMarkers(int,Layer)

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(Paint)

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(Paint)

public Stroke getRangeZeroBaselineStroke()

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

Returns:

The stroke (never null).

See Also:

setRangeZeroBaselineStroke(Stroke)

public XYItemRenderer getRenderer()

Returns the renderer for the primary dataset.

Returns:

The item renderer (possibly null).

See Also:

setRenderer(XYItemRenderer)

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:

setRenderer(int,XYItemRenderer)

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:

setSeriesRenderingOrder(SeriesRenderingOrder)

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

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

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

Overrides:

handleClick in interface 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.

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:

setDomainCrosshairLockedOnData(boolean)

public boolean isDomainCrosshairVisible()

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

Returns:

The flag.

See Also:

setDomainCrosshairVisible(boolean)

public boolean isDomainGridlinesVisible()

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

Returns:

true or false.

See Also:

setDomainGridlinesVisible(boolean)

public boolean isDomainZeroBaselineVisible()

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

Returns:

A boolean.

Since:

1.0.5

See Also:

setDomainZeroBaselineVisible(boolean)

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 isRangeCrosshairLockedOnData()

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

Returns:

The flag.

See Also:

setRangeCrosshairLockedOnData(boolean)

public boolean isRangeCrosshairVisible()

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

Returns:

The flag.

See Also:

setRangeCrosshairVisible(boolean), isDomainCrosshairVisible()

public boolean isRangeGridlinesVisible()

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

Returns:

A boolean.

See Also:

setRangeGridlinesVisible(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:

setRangeZeroBaselineVisible(boolean)

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:

isDomainZoomable()

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:

mapDatasetToRangeAxis(int,int)

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:

mapDatasetToDomainAxis(int,int)

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:

addAnnotation(XYAnnotation), getAnnotations()

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.

Specified by:

rendererChanged in interface RendererChangeListener

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:

getAxisOffset()

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:

getDataset(int)

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:

getDataset(), setDataset(int,XYDataset)

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:

getDatasetRenderingOrder()

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:

setRangeAxes(ValueAxis[])

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:

getDomainAxis(int), setRangeAxis(int,ValueAxis)

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:

getDomainAxis(int)

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:

getDomainAxis(), setDomainAxis(int,ValueAxis)

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:

getDomainAxisLocation(int)

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?

Since:

1.0.5

See Also:

getDomainAxisLocation(int), setRangeAxisLocation(int,AxisLocation,boolean)

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:

getDomainAxisLocation()

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:

getDomainAxisLocation()

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:

isDomainCrosshairLockedOnData()

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:

getDomainCrosshairPaint()

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:

getDomainCrosshairStroke()

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:

getDomainCrosshairValue()

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:

getDomainCrosshairValue()

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:

isDomainCrosshairVisible()

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

See Also:

getDomainGridlinePaint()

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.

If you set this to null, no grid lines will be drawn.

Parameters:

stroke - the stroke (null not permitted).

See Also:

getDomainGridlineStroke()

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:

isDomainGridlinesVisible()

public void setDomainTickBandPaint(Paint paint)

Sets the paint for the domain tick bands.

Parameters:

paint - the paint (null permitted).

See Also:

getDomainTickBandPaint()

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

Since:

1.0.5

See Also:

getDomainZeroBaselinePaint()

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

Since:

1.0.5

See Also:

getRangeZeroBaselineStroke()

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.

Since:

1.0.5

See Also:

isDomainZeroBaselineVisible()

public void setFixedDomainAxisSpace(AxisSpace space)

Sets the fixed domain axis space.

Parameters:

space - the space (null permitted).

See Also:

getFixedDomainAxisSpace()

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:

getFixedLegendItems()

public void setFixedRangeAxisSpace(AxisSpace space)

Sets the fixed range axis space.

Parameters:

space - the space (null permitted).

See Also:

getFixedRangeAxisSpace()

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:

getOrientation()

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:

getQuadrantOrigin()

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:

getQuadrantPaint(int)

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:

setDomainAxes(ValueAxis[])

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:

getRangeAxis(int)

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:

getRangeAxis(int)

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:

getRangeAxis(), setRangeAxis(int,ValueAxis)

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:

getRangeAxisLocation(int)

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?

Since:

1.0.5

See Also:

getRangeAxisLocation(int), setDomainAxisLocation(int,AxisLocation,boolean)

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:

getRangeAxisLocation()

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:

getRangeAxisLocation()

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:

isRangeCrosshairLockedOnData()

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:

getRangeCrosshairPaint()

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:

getRangeCrosshairStroke()

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:

getRangeCrosshairValue()

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:

getRangeCrosshairValue()

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:

isRangeCrosshairVisible()

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:

getRangeGridlinePaint()

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:

getRangeGridlineStroke()

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:

isRangeGridlinesVisible()

public void setRangeTickBandPaint(Paint paint)

Sets the paint for the range tick bands.

Parameters:

paint - the paint (null permitted).

See Also:

getRangeTickBandPaint()

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:

getRangeZeroBaselinePaint()

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:

getRangeZeroBaselineStroke()

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:

isRangeZeroBaselineVisible()

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:

getRenderer(int)

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:

getRenderer(int)

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:

getRenderer()

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:

getSeriesRenderingOrder()

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:

getWeight()