Package org.jfree.chart.renderer.xy

Interface XYItemRenderer

    • Method Detail

      • getPlot

        XYPlot getPlot()
        Returns the plot that this renderer has been assigned to.
        Returns:
        The plot.

      • setPlot

        void setPlot​(XYPlot plot)
        Sets the plot that this renderer is assigned to. This method will be called by the plot class...you do not need to call it yourself.
        Parameters:
        plot - the plot.

      • getPassCount

        int getPassCount()
        Returns the number of passes through the data required by the renderer.
        Returns:
        The pass count.

      • findDomainBounds

        Range findDomainBounds​(XYDataset dataset)
        Returns the lower and upper bounds (range) of the x-values in the specified dataset.
        Parameters:
        dataset - the dataset (null permitted).
        Returns:
        The range.

      • findRangeBounds

        Range findRangeBounds​(XYDataset dataset)
        Returns the lower and upper bounds (range) of the y-values in the specified dataset. The implementation of this method will take into account the presentation used by the renderers (for example, a renderer that "stacks" values will return a bigger range than a renderer that doesn't).
        Parameters:
        dataset - the dataset (null permitted).
        Returns:
        The range (or null if the dataset is null or empty).

      • getItemVisible

        boolean getItemVisible​(int series,
                       int item)
        Returns a boolean that indicates whether or not the specified item should be drawn (this is typically used to hide an entire series).
        Parameters:
        series - the series index.
        item - the item index.
        Returns:
        A boolean.

      • isSeriesVisible

        boolean isSeriesVisible​(int series)
        Returns a boolean that indicates whether or not the specified series should be drawn (this is typically used to hide an entire series).
        Parameters:
        series - the series index.
        Returns:
        A boolean.

      • getSeriesVisible

        java.lang.Boolean getSeriesVisible​(int series)
        Returns the flag that controls whether a series is visible.
        Parameters:
        series - the series index (zero-based).
        Returns:
        The flag (possibly null).
        See Also:
        setSeriesVisible(int, Boolean)

      • setSeriesVisible

        void setSeriesVisible​(int series,
                      java.lang.Boolean visible)
        Sets the flag that controls whether a series is visible and sends a RendererChangeEvent to all registered listeners.
        Parameters:
        series - the series index (zero-based).
        visible - the flag (null permitted).
        See Also:
        getSeriesVisible(int)

      • setSeriesVisible

        void setSeriesVisible​(int series,
                      java.lang.Boolean visible,
                      boolean notify)
        Sets the flag that controls whether a series is visible and, if requested, sends a RendererChangeEvent to all registered listeners.
        Parameters:
        series - the series index.
        visible - the flag (null permitted).
        notify - notify listeners?
        See Also:
        getSeriesVisible(int)

      • isSeriesVisibleInLegend

        boolean isSeriesVisibleInLegend​(int series)
        Returns true if the series should be shown in the legend, and false otherwise.
        Parameters:
        series - the series index.
        Returns:
        A boolean.

      • getSeriesVisibleInLegend

        java.lang.Boolean getSeriesVisibleInLegend​(int series)
        Returns the flag that controls whether a series is visible in the legend. This method returns only the "per series" settings - to incorporate the override and base settings as well, you need to use the isSeriesVisibleInLegend(int) method.
        Parameters:
        series - the series index (zero-based).
        Returns:
        The flag (possibly null).
        See Also:
        setSeriesVisibleInLegend(int, Boolean)

      • setSeriesVisibleInLegend

        void setSeriesVisibleInLegend​(int series,
                              java.lang.Boolean visible)
        Sets the flag that controls whether a series is visible in the legend and sends a RendererChangeEvent to all registered listeners.
        Parameters:
        series - the series index (zero-based).
        visible - the flag (null permitted).
        See Also:
        getSeriesVisibleInLegend(int)

      • setSeriesVisibleInLegend

        void setSeriesVisibleInLegend​(int series,
                              java.lang.Boolean visible,
                              boolean notify)
        Sets the flag that controls whether a series is visible in the legend and, if requested, sends a RendererChangeEvent to all registered listeners.
        Parameters:
        series - the series index.
        visible - the flag (null permitted).
        notify - notify listeners?
        See Also:
        getSeriesVisibleInLegend(int)

      • getItemPaint

        java.awt.Paint getItemPaint​(int row,
                            int column)
        Returns the paint used to color data items as they are drawn.
        Parameters:
        row - the row (or series) index (zero-based).
        column - the column (or category) index (zero-based).
        Returns:
        The paint (never null).

      • getSeriesPaint

        java.awt.Paint getSeriesPaint​(int series)
        Returns the paint used to color an item drawn by the renderer.
        Parameters:
        series - the series index (zero-based).
        Returns:
        The paint (possibly null).
        See Also:
        setSeriesPaint(int, Paint)

      • setSeriesPaint

        void setSeriesPaint​(int series,
                    java.awt.Paint paint)
        Sets the paint used for a series and sends a RendererChangeEvent to all registered listeners.
        Parameters:
        series - the series index (zero-based).
        paint - the paint (null permitted).
        See Also:
        getSeriesPaint(int)

      • getItemOutlinePaint

        java.awt.Paint getItemOutlinePaint​(int row,
                                   int column)
        Returns the paint used to outline data items as they are drawn.
        Parameters:
        row - the row (or series) index (zero-based).
        column - the column (or category) index (zero-based).
        Returns:
        The paint (never null).

      • getSeriesOutlinePaint

        java.awt.Paint getSeriesOutlinePaint​(int series)
        Returns the paint used to outline an item drawn by the renderer.
        Parameters:
        series - the series (zero-based index).
        Returns:
        The paint (possibly null).
        See Also:
        setSeriesOutlinePaint(int, Paint)

      • getItemStroke

        java.awt.Stroke getItemStroke​(int row,
                              int column)
        Returns the stroke used to draw data items.
        Parameters:
        row - the row (or series) index (zero-based).
        column - the column (or category) index (zero-based).
        Returns:
        The stroke (never null).

      • getSeriesStroke

        java.awt.Stroke getSeriesStroke​(int series)
        Returns the stroke used to draw the items in a series.
        Parameters:
        series - the series (zero-based index).
        Returns:
        The stroke (possibly null).
        See Also:
        setSeriesStroke(int, Stroke)

      • setSeriesStroke

        void setSeriesStroke​(int series,
                     java.awt.Stroke stroke)
        Sets the stroke used for a series and sends a RendererChangeEvent to all registered listeners.
        Parameters:
        series - the series index (zero-based).
        stroke - the stroke (null permitted).
        See Also:
        getSeriesStroke(int)

      • getItemOutlineStroke

        java.awt.Stroke getItemOutlineStroke​(int row,
                                     int column)
        Returns the stroke used to outline data items. The default implementation passes control to the lookupSeriesOutlineStroke method. You can override this method if you require different behaviour.
        Parameters:
        row - the row (or series) index (zero-based).
        column - the column (or category) index (zero-based).
        Returns:
        The stroke (never null).

      • getItemShape

        java.awt.Shape getItemShape​(int row,
                            int column)
        Returns a shape used to represent a data item.
        Parameters:
        row - the row (or series) index (zero-based).
        column - the column (or category) index (zero-based).
        Returns:
        The shape (never null).

      • getSeriesShape

        java.awt.Shape getSeriesShape​(int series)
        Returns a shape used to represent the items in a series.
        Parameters:
        series - the series (zero-based index).
        Returns:
        The shape (possibly null).
        See Also:
        setSeriesShape(int, Shape)

      • setSeriesShape

        void setSeriesShape​(int series,
                    java.awt.Shape shape)
        Sets the shape used for a series and sends a RendererChangeEvent to all registered listeners.
        Parameters:
        series - the series index (zero-based).
        shape - the shape (null permitted).
        See Also:
        getSeriesShape(int)

      • getLegendItem

        LegendItem getLegendItem​(int datasetIndex,
                         int series)
        Returns a legend item for a series from a dataset.
        Parameters:
        datasetIndex - the dataset index.
        series - the series (zero-based index).
        Returns:
        The legend item (possibly null).

      • getToolTipGenerator

        XYToolTipGenerator getToolTipGenerator​(int row,
                                       int column)
        Returns the tool tip generator for a data item.
        Parameters:
        row - the row index (zero based).
        column - the column index (zero based).
        Returns:
        The generator (possibly null).

      • setURLGenerator

        void setURLGenerator​(XYURLGenerator urlGenerator)
        Sets the URL generator for HTML image maps.
        Parameters:
        urlGenerator - the URL generator (null permitted).

      • isItemLabelVisible

        boolean isItemLabelVisible​(int row,
                           int column)
        Returns true if an item label is visible, and false otherwise.
        Parameters:
        row - the row index (zero-based).
        column - the column index (zero-based).
        Returns:
        A boolean.

      • isSeriesItemLabelsVisible

        boolean isSeriesItemLabelsVisible​(int series)
        Returns true if the item labels for a series are visible, and false otherwise.
        Parameters:
        series - the series index (zero-based).
        Returns:
        A boolean.

      • setSeriesItemLabelsVisible

        void setSeriesItemLabelsVisible​(int series,
                                java.lang.Boolean visible)
        Sets a flag that controls the visibility of the item labels for a series.
        Parameters:
        series - the series index (zero-based).
        visible - the flag (null permitted).
        See Also:
        isSeriesItemLabelsVisible(int)

      • setSeriesItemLabelsVisible

        void setSeriesItemLabelsVisible​(int series,
                                java.lang.Boolean visible,
                                boolean notify)
        Sets the visibility of item labels for a series and, if requested, sends a RendererChangeEvent to all registered listeners.
        Parameters:
        series - the series index (zero-based).
        visible - the visible flag.
        notify - a flag that controls whether or not listeners are notified.
        See Also:
        isSeriesItemLabelsVisible(int)

      • setBaseItemLabelsVisible

        void setBaseItemLabelsVisible​(java.lang.Boolean visible,
                              boolean notify)
        Sets the base visibility for item labels and, if requested, sends a RendererChangeEvent to all registered listeners.
        Parameters:
        visible - the visibility flag.
        notify - a flag that controls whether or not listeners are notified.
        See Also:
        getBaseItemLabelsVisible()

      • getItemLabelGenerator

        XYItemLabelGenerator getItemLabelGenerator​(int row,
                                           int column)
        Returns the item label generator for a data item.
        Parameters:
        row - the row index (zero based).
        column - the column index (zero based).
        Returns:
        The generator (possibly null).

      • getItemLabelFont

        java.awt.Font getItemLabelFont​(int row,
                               int column)
        Returns the font for an item label.
        Parameters:
        row - the row index (zero-based).
        column - the column index (zero-based).
        Returns:
        The font (never null).

      • getSeriesItemLabelFont

        java.awt.Font getSeriesItemLabelFont​(int series)
        Returns the font for all the item labels in a series.
        Parameters:
        series - the series index (zero-based).
        Returns:
        The font (possibly null).

      • getItemLabelPaint

        java.awt.Paint getItemLabelPaint​(int row,
                                 int column)
        Returns the paint used to draw an item label.
        Parameters:
        row - the row index (zero based).
        column - the column index (zero based).
        Returns:
        The paint (never null).

      • getBaseItemLabelPaint

        java.awt.Paint getBaseItemLabelPaint()
        Returns the base item label paint.
        Returns:
        The paint (never null).

      • setBaseItemLabelPaint

        void setBaseItemLabelPaint​(java.awt.Paint paint)
        Sets the base item label paint and sends a RendererChangeEvent to all registered listeners.
        Parameters:
        paint - the paint (null not permitted).

      • getPositiveItemLabelPosition

        ItemLabelPosition getPositiveItemLabelPosition​(int row,
                                               int column)
        Returns the item label position for positive values.
        Parameters:
        row - the row index (zero-based).
        column - the column index (zero-based).
        Returns:
        The item label position (never null).

      • getSeriesPositiveItemLabelPosition

        ItemLabelPosition getSeriesPositiveItemLabelPosition​(int series)
        Returns the item label position for all positive values in a series.
        Parameters:
        series - the series index (zero-based).
        Returns:
        The item label position (never null).

      • setSeriesPositiveItemLabelPosition

        void setSeriesPositiveItemLabelPosition​(int series,
                                        ItemLabelPosition position,
                                        boolean notify)
        Sets the item label position for all positive values in a series and (if requested) sends a RendererChangeEvent to all registered listeners.
        Parameters:
        series - the series index (zero-based).
        position - the position (null permitted).
        notify - notify registered listeners?

      • getNegativeItemLabelPosition

        ItemLabelPosition getNegativeItemLabelPosition​(int row,
                                               int column)
        Returns the item label position for negative values. This method can be overridden to provide customisation of the item label position for individual data items.
        Parameters:
        row - the row index (zero-based).
        column - the column (zero-based).
        Returns:
        The item label position (never null).

      • getSeriesNegativeItemLabelPosition

        ItemLabelPosition getSeriesNegativeItemLabelPosition​(int series)
        Returns the item label position for all negative values in a series.
        Parameters:
        series - the series index (zero-based).
        Returns:
        The item label position (never null).

      • setSeriesNegativeItemLabelPosition

        void setSeriesNegativeItemLabelPosition​(int series,
                                        ItemLabelPosition position,
                                        boolean notify)
        Sets the item label position for negative values in a series and (if requested) sends a RendererChangeEvent to all registered listeners.
        Parameters:
        series - the series index (zero-based).
        position - the position (null permitted).
        notify - notify registered listeners?

      • addAnnotation

        void addAnnotation​(XYAnnotation annotation)
        Adds an annotation and sends a RendererChangeEvent to all registered listeners. The annotation is added to the foreground layer.
        Parameters:
        annotation - the annotation (null not permitted).

      • addAnnotation

        void addAnnotation​(XYAnnotation annotation,
                   org.jfree.ui.Layer layer)
        Adds an annotation to the specified layer.
        Parameters:
        annotation - the annotation (null not permitted).
        layer - the layer (null not permitted).

      • removeAnnotation

        boolean removeAnnotation​(XYAnnotation annotation)
        Removes the specified annotation and sends a RendererChangeEvent to all registered listeners.
        Parameters:
        annotation - the annotation to remove (null not permitted).
        Returns:
        A boolean to indicate whether or not the annotation was successfully removed.

      • drawAnnotations

        void drawAnnotations​(java.awt.Graphics2D g2,
                     java.awt.geom.Rectangle2D dataArea,
                     ValueAxis domainAxis,
                     ValueAxis rangeAxis,
                     org.jfree.ui.Layer layer,
                     PlotRenderingInfo info)
        Draws all the annotations for the specified layer.
        Parameters:
        g2 - the graphics device.
        dataArea - the data area.
        domainAxis - the domain axis.
        rangeAxis - the range axis.
        layer - the layer.
        info - the plot rendering info.

      • initialise

        XYItemRendererState initialise​(java.awt.Graphics2D g2,
                               java.awt.geom.Rectangle2D dataArea,
                               XYPlot plot,
                               XYDataset dataset,
                               PlotRenderingInfo info)
        Initialises the renderer then returns the number of 'passes' through the data that the renderer will require (usually just one). This method will be called before the first item is rendered, giving the renderer an opportunity to initialise any state information it wants to maintain. The renderer can do nothing if it chooses.
        Parameters:
        g2 - the graphics device.
        dataArea - the area inside the axes.
        plot - the plot.
        dataset - the dataset.
        info - an optional info collection object to return data back to the caller.
        Returns:
        The number of passes the renderer requires.

      • drawItem

        void drawItem​(java.awt.Graphics2D g2,
              XYItemRendererState state,
              java.awt.geom.Rectangle2D dataArea,
              PlotRenderingInfo info,
              XYPlot plot,
              ValueAxis domainAxis,
              ValueAxis rangeAxis,
              XYDataset dataset,
              int series,
              int item,
              CrosshairState crosshairState,
              int pass)
        Called for each item to be plotted.

        The XYPlot can make multiple passes through the dataset, depending on the value returned by the renderer's initialise() method.

        Parameters:
        g2 - the graphics device.
        state - the renderer state.
        dataArea - the area within which the data is being rendered.
        info - collects drawing info.
        plot - the plot (can be used to obtain standard color information etc).
        domainAxis - the domain axis.
        rangeAxis - the range axis.
        dataset - the dataset.
        series - the series index (zero-based).
        item - the item index (zero-based).
        crosshairState - crosshair information for the plot (null permitted).
        pass - the pass index.

      • fillDomainGridBand

        void fillDomainGridBand​(java.awt.Graphics2D g2,
                        XYPlot plot,
                        ValueAxis axis,
                        java.awt.geom.Rectangle2D dataArea,
                        double start,
                        double end)
        Fills a band between two values on the axis. This can be used to color bands between the grid lines.
        Parameters:
        g2 - the graphics device.
        plot - the plot.
        axis - the domain axis.
        dataArea - the data area.
        start - the start value.
        end - the end value.

      • fillRangeGridBand

        void fillRangeGridBand​(java.awt.Graphics2D g2,
                       XYPlot plot,
                       ValueAxis axis,
                       java.awt.geom.Rectangle2D dataArea,
                       double start,
                       double end)
        Fills a band between two values on the range axis. This can be used to color bands between the grid lines.
        Parameters:
        g2 - the graphics device.
        plot - the plot.
        axis - the range axis.
        dataArea - the data area.
        start - the start value.
        end - the end value.

      • drawDomainGridLine

        void drawDomainGridLine​(java.awt.Graphics2D g2,
                        XYPlot plot,
                        ValueAxis axis,
                        java.awt.geom.Rectangle2D dataArea,
                        double value)
        Draws a grid line against the domain axis.
        Parameters:
        g2 - the graphics device.
        plot - the plot.
        axis - the value axis.
        dataArea - the area for plotting data (not yet adjusted for any 3D effect).
        value - the value.

      • drawRangeLine

        void drawRangeLine​(java.awt.Graphics2D g2,
                   XYPlot plot,
                   ValueAxis axis,
                   java.awt.geom.Rectangle2D dataArea,
                   double value,
                   java.awt.Paint paint,
                   java.awt.Stroke stroke)
        Draws a line perpendicular to the range axis.
        Parameters:
        g2 - the graphics device.
        plot - the plot.
        axis - the value axis.
        dataArea - the area for plotting data.
        value - the data value.
        paint - the paint (null not permitted).
        stroke - the stroke (null not permitted).

      • drawDomainMarker

        void drawDomainMarker​(java.awt.Graphics2D g2,
                      XYPlot plot,
                      ValueAxis axis,
                      Marker marker,
                      java.awt.geom.Rectangle2D dataArea)
        Draws the specified marker against the domain axis.
        Parameters:
        g2 - the graphics device.
        plot - the plot.
        axis - the value axis.
        marker - the marker.
        dataArea - the axis data area.

      • drawRangeMarker

        void drawRangeMarker​(java.awt.Graphics2D g2,
                     XYPlot plot,
                     ValueAxis axis,
                     Marker marker,
                     java.awt.geom.Rectangle2D dataArea)
        Draws a horizontal line across the chart to represent a 'range marker'.
        Parameters:
        g2 - the graphics device.
        plot - the plot.
        axis - the value axis.
        marker - the marker line.
        dataArea - the axis data area.

      • getSeriesVisible

        java.lang.Boolean getSeriesVisible()
        Deprecated.
        This method should no longer be used (as of version 1.0.6). It is sufficient to rely on getSeriesVisible(int) and getBaseSeriesVisible().
        Returns the flag that controls the visibility of ALL series. This flag overrides the per series and default settings - you must set it to null if you want the other settings to apply.
        Returns:
        The flag (possibly null).

      • setSeriesVisible

        void setSeriesVisible​(java.lang.Boolean visible)
        Deprecated.
        This method should no longer be used (as of version 1.0.6). It is sufficient to rely on setSeriesVisible(int, Boolean) and setBaseSeriesVisible(boolean).
        Sets the flag that controls the visibility of ALL series and sends a RendererChangeEvent to all registered listeners. This flag overrides the per series and default settings - you must set it to null if you want the other settings to apply.
        Parameters:
        visible - the flag (null permitted).

      • setSeriesVisible

        void setSeriesVisible​(java.lang.Boolean visible,
                      boolean notify)
        Deprecated.
        This method should no longer be used (as of version 1.0.6). It is sufficient to rely on setSeriesVisible(int, Boolean, boolean) and setBaseSeriesVisible(boolean, boolean).
        Sets the flag that controls the visibility of ALL series and sends a RendererChangeEvent to all registered listeners. This flag overrides the per series and default settings - you must set it to null if you want the other settings to apply.
        Parameters:
        visible - the flag (null permitted).
        notify - notify listeners?

      • getSeriesVisibleInLegend

        java.lang.Boolean getSeriesVisibleInLegend()
        Deprecated.
        This method should no longer be used (as of version 1.0.6). It is sufficient to rely on getSeriesVisibleInLegend(int) and getBaseSeriesVisibleInLegend().
        Returns the flag that controls the visibility of ALL series in the legend. This flag overrides the per series and default settings - you must set it to null if you want the other settings to apply.
        Returns:
        The flag (possibly null).

      • setPaint

        void setPaint​(java.awt.Paint paint)
        Deprecated.
        This method should no longer be used (as of version 1.0.6). It is sufficient to rely on setSeriesPaint(int, Paint) and setBasePaint(Paint).
        Sets the paint to be used for ALL series, and sends a RendererChangeEvent to all registered listeners. If this is null, the renderer will use the paint for the series.
        Parameters:
        paint - the paint (null permitted).

      • getItemLabelFont

        java.awt.Font getItemLabelFont()
        Deprecated.
        This method should no longer be used (as of version 1.0.6). It is sufficient to rely on getSeriesItemLabelFont(int) and getBaseItemLabelFont().
        Returns the font used for all item labels. This may be null, in which case the per series font settings will apply.
        Returns:
        The font (possibly null).

      • getItemLabelPaint

        java.awt.Paint getItemLabelPaint()
        Deprecated.
        This method should no longer be used (as of version 1.0.6). It is sufficient to rely on getSeriesItemLabelPaint(int) and getBaseItemLabelPaint().
        Returns the paint used for all item labels. This may be null, in which case the per series paint settings will apply.
        Returns:
        The paint (possibly null).