XYPlot
org.jfree.chart.plot

Class XYPlot

    • Field Detail

      • 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:
        Constant Field Values
      • 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.
    • Constructor Detail

      • 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 Detail

      • 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.
      • 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:
        getOrientation()
      • getAxisOffset

        public org.jfree.ui.RectangleInsets getAxisOffset()
        Returns the axis offset.
        Returns:
        The axis offset (never null).
        See Also:
        setAxisOffset(RectangleInsets)
      • setAxisOffset

        public void setAxisOffset(org.jfree.ui.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()
      • 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(int), setDomainAxis(ValueAxis)
      • getDomainAxis

        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)
      • 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:
        getDomainAxis(int)
      • 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:
        getDomainAxisLocation()
      • 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:
        getDomainAxisLocation()
      • getDomainAxisEdge

        public org.jfree.ui.RectangleEdge getDomainAxisEdge()
        Returns the edge for the primary domain axis (taking into account the plot's orientation).
        Returns:
        The edge.
        See Also:
        getDomainAxisLocation(), getOrientation()
      • getDomainAxisCount

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

        public void clearDomainAxes()
        Clears the domain axes from the plot and sends a PlotChangeEvent to all registered listeners.
        See Also:
        clearRangeAxes()
      • 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.
        Returns:
        The location (never null).
        See Also:
        setDomainAxisLocation(int, AxisLocation)
      • 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:
        getDomainAxisLocation(int)
      • getDomainAxisEdge

        public org.jfree.ui.RectangleEdge getDomainAxisEdge(int index)
        Returns the edge for a domain axis.
        Parameters:
        index - the axis index.
        Returns:
        The edge.
        See Also:
        getRangeAxisEdge(int)
      • 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:
        getRangeAxis(int), setRangeAxis(ValueAxis)
      • 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:
        getRangeAxisLocation()
      • 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:
        getRangeAxisLocation()
      • getRangeAxisEdge

        public org.jfree.ui.RectangleEdge getRangeAxisEdge()
        Returns the edge for the primary range axis.
        Returns:
        The range axis edge.
        See Also:
        getRangeAxisLocation(), getOrientation()
      • 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:
        getRangeAxis(int)
      • 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:
        getRangeAxis(int)
      • getRangeAxisCount

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

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

        public void configureRangeAxes()
        Configures the range axes.
        See Also:
        configureDomainAxes()
      • 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.
        Returns:
        The location (never null).
        See Also:
        setRangeAxisLocation(int, AxisLocation)
      • 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:
        getRangeAxisLocation(int)
      • getRangeAxisEdge

        public org.jfree.ui.RectangleEdge getRangeAxisEdge(int index)
        Returns the edge for a range axis.
        Parameters:
        index - the axis index.
        Returns:
        The edge.
        See Also:
        getRangeAxisLocation(int), getOrientation()
      • getDataset

        public XYDataset getDataset(int index)
        Returns a dataset.
        Parameters:
        index - the dataset index.
        Returns:
        The dataset (possibly null).
        See Also:
        setDataset(int, XYDataset)
      • 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:
        getDataset(), setDataset(int, XYDataset)
      • setDataset

        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)
      • 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.
      • 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:
        mapDatasetToRangeAxis(int, int)
      • 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:
        mapDatasetToDomainAxis(int, int)
      • 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.
      • setRenderer

        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()
      • setRenderer

        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)
      • 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).
      • 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:
        getDatasetRenderingOrder()
      • 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:
        getSeriesRenderingOrder()
      • 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. 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).
      • 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(int)
      • 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:
        getWeight()
      • isDomainGridlinesVisible

        public boolean isDomainGridlinesVisible()
        Returns true if the domain gridlines are visible, and false otherwise.
        Returns:
        true or false.
        See Also:
        setDomainGridlinesVisible(boolean)
      • 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:
        isDomainGridlinesVisible()
      • isDomainMinorGridlinesVisible

        public boolean isDomainMinorGridlinesVisible()
        Returns true if the domain minor gridlines are visible, and false otherwise.
        Returns:
        true or false.
        See Also:
        setDomainMinorGridlinesVisible(boolean)
      • 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:
        isDomainMinorGridlinesVisible()
      • 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(Stroke)
      • 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(Stroke)
      • 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(Paint)
      • 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(Paint)
      • isRangeGridlinesVisible

        public boolean isRangeGridlinesVisible()
        Returns true if the range axis grid is visible, and false otherwise.
        Returns:
        A boolean.
        See Also:
        setRangeGridlinesVisible(boolean)
      • 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:
        isRangeGridlinesVisible()
      • 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(Stroke)
      • 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:
        getRangeGridlineStroke()
      • 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(Paint)
      • 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:
        getRangeGridlinePaint()
      • isRangeMinorGridlinesVisible

        public boolean isRangeMinorGridlinesVisible()
        Returns true if the range axis minor grid is visible, and false otherwise.
        Returns:
        A boolean.
        See Also:
        setRangeMinorGridlinesVisible(boolean)
      • 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:
        isRangeMinorGridlinesVisible()
      • 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(Stroke)
      • 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:
        getRangeMinorGridlineStroke()
      • 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(Paint)
      • 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:
        getRangeMinorGridlinePaint()
      • 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(boolean)
      • 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:
        isDomainZeroBaselineVisible()
      • getDomainZeroBaselineStroke

        public Stroke getDomainZeroBaselineStroke()
        Returns the stroke used for the zero baseline against the domain axis.
        Returns:
        The stroke (never null).
        See Also:
        setDomainZeroBaselineStroke(Stroke)
      • 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:
        getRangeZeroBaselineStroke()
      • 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(Paint)
      • 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:
        getDomainZeroBaselinePaint()
      • 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(boolean)
      • 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:
        isRangeZeroBaselineVisible()
      • getRangeZeroBaselineStroke

        public Stroke getRangeZeroBaselineStroke()
        Returns the stroke used for the zero baseline against the range axis.
        Returns:
        The stroke (never null).
        See Also:
        setRangeZeroBaselineStroke(Stroke)
      • 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:
        getRangeZeroBaselineStroke()
      • 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(Paint)
      • 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:
        getRangeZeroBaselinePaint()
      • 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(Paint)
      • setDomainTickBandPaint

        public void setDomainTickBandPaint(Paint paint)
        Sets the paint for the domain tick bands.
        Parameters:
        paint - the paint (null permitted).
        See Also:
        getDomainTickBandPaint()
      • 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(Paint)
      • setRangeTickBandPaint

        public void setRangeTickBandPaint(Paint paint)
        Sets the paint for the range tick bands.
        Parameters:
        paint - the paint (null permitted).
        See Also:
        getRangeTickBandPaint()
      • 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(Point2D)
      • 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:
        getQuadrantOrigin()
      • 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(int, Paint)
      • 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:
        getQuadrantPaint(int)
      • 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 range axis, however this is entirely up to the renderer.

        Parameters:
        marker - the marker (null not permitted).
        See Also:
        addDomainMarker(Marker, Layer), clearDomainMarkers()
      • addDomainMarker

        public void addDomainMarker(Marker marker,                   org.jfree.ui.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)
      • clearDomainMarkers

        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)
      • addDomainMarker

        public void addDomainMarker(int index,                   Marker marker,                   org.jfree.ui.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)
      • addDomainMarker

        public void addDomainMarker(int index,                   Marker marker,                   org.jfree.ui.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,                         org.jfree.ui.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,                         org.jfree.ui.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,                         org.jfree.ui.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(Marker, Layer)
      • addRangeMarker

        public void addRangeMarker(Marker marker,                  org.jfree.ui.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)
      • addRangeMarker

        public void addRangeMarker(int index,                  Marker marker,                  org.jfree.ui.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)
      • addRangeMarker

        public void addRangeMarker(int index,                  Marker marker,                  org.jfree.ui.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,                        org.jfree.ui.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,                        org.jfree.ui.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.
      • removeRangeMarker

        public boolean removeRangeMarker(int index,                        Marker marker,                        org.jfree.ui.Layer layer,                        boolean notify)
        Removes a marker for a specific dataset/renderer and sends a PlotChangeEvent to all registered listeners.
        Parameters:
        index - the dataset/renderer index.
        marker - the marker.
        layer - the layer (foreground or background).
        notify - notify listeners?
        Returns:
        A boolean indicating whether or not the marker was actually removed.
      • 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:
        addAnnotation(XYAnnotation), getAnnotations()
      • 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).
      • 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).
      • 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.
      • 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.
        Returns:
        The axis.
      • getRangeAxisForDataset

        public ValueAxis getRangeAxisForDataset(int index)
        Returns the range axis for a dataset.
        Parameters:
        index - the dataset index.
        Returns:
        The axis.
      • 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.
      • getDomainMarkers

        public Collection getDomainMarkers(org.jfree.ui.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)
      • getRangeMarkers

        public Collection getRangeMarkers(org.jfree.ui.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)
      • getDomainMarkers

        public Collection getDomainMarkers(int index,                          org.jfree.ui.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)
      • getRangeMarkers

        public Collection getRangeMarkers(int index,                         org.jfree.ui.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)
      • 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(ValueAxis)
      • getRangeAxisIndex

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

        public boolean isDomainCrosshairVisible()
        Returns a flag indicating whether or not the domain crosshair is visible.
        Returns:
        The flag.
        See Also:
        setDomainCrosshairVisible(boolean)
      • 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:
        isDomainCrosshairVisible()
      • 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(boolean)
      • 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:
        isDomainCrosshairLockedOnData()
      • getDomainCrosshairValue

        public double getDomainCrosshairValue()
        Returns the domain crosshair value.
        Returns:
        The value.
        See Also:
        setDomainCrosshairValue(double)
      • 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:
        getDomainCrosshairValue()
      • 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:
        getDomainCrosshairValue()
      • 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:
        getDomainCrosshairStroke()
      • 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:
        getDomainCrosshairPaint()
      • 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:
        isRangeCrosshairVisible()
      • 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(boolean)
      • 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:
        isRangeCrosshairLockedOnData()
      • getRangeCrosshairValue

        public double getRangeCrosshairValue()
        Returns the range crosshair value.
        Returns:
        The value.
        See Also:
        setRangeCrosshairValue(double)
      • 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:
        getRangeCrosshairValue()
      • 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:
        getRangeCrosshairValue()
      • 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:
        getRangeCrosshairStroke()
      • 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:
        getRangeCrosshairPaint()
      • 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:
        getFixedDomainAxisSpace()
      • 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:
        getFixedDomainAxisSpace()
      • 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:
        getFixedRangeAxisSpace()
      • 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:
        getFixedRangeAxisSpace()
      • 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 axes, and false otherwise.
        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 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 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(double, double, PlotRenderingInfo, Point2D)
      • 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()
      • 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:
        isDomainZoomable()
      • 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.
      • 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:
        getFixedLegendItems()
      • 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.

SCaVis 1.8 © jWork.org