Package org.jfree.chart.renderer

Class XYAreaRenderer

java.lang.Object
org.jfree.chart.renderer.AbstractRenderer
org.jfree.chart.renderer.AbstractXYItemRenderer
org.jfree.chart.renderer.XYAreaRenderer
All Implemented Interfaces:
Serializable, Cloneable, XYItemRenderer, org.jfree.util.PublicCloneable
Direct Known Subclasses:
StackedXYAreaRenderer
public class XYAreaRenderer
extends AbstractXYItemRenderer
implements XYItemRenderer, Cloneable, org.jfree.util.PublicCloneable, Serializable
Area item renderer for an XYPlot. This class can draw (a) shapes at each point, or (b) lines between points, or (c) both shapes and lines, or (d) filled areas, or (e) filled areas and shapes.
See Also:
Serialized Form

  • Field Details

    • SHAPES

      public static final int SHAPES
      Useful constant for specifying the type of rendering (shapes only).
      See Also:
      Constant Field Values

    • LINES

      public static final int LINES
      Useful constant for specifying the type of rendering (lines only).
      See Also:
      Constant Field Values

    • SHAPES_AND_LINES

      public static final int SHAPES_AND_LINES
      Useful constant for specifying the type of rendering (shapes and lines).
      See Also:
      Constant Field Values

    • AREA

      public static final int AREA
      Useful constant for specifying the type of rendering (area only).
      See Also:
      Constant Field Values

    • AREA_AND_SHAPES

      public static final int AREA_AND_SHAPES
      Useful constant for specifying the type of rendering (area and shapes).
      See Also:
      Constant Field Values

  • Constructor Details

    • XYAreaRenderer

      public XYAreaRenderer()
      Constructs a new renderer.

    • XYAreaRenderer

      public XYAreaRenderer​(int type)
      Constructs a new renderer.
      Parameters:
      type - the type of the renderer.

    • XYAreaRenderer

      public XYAreaRenderer​(int type, XYToolTipGenerator labelGenerator, XYURLGenerator urlGenerator)
      Constructs a new renderer.

      To specify the type of renderer, use one of the constants: SHAPES, LINES, SHAPES_AND_LINES, AREA or AREA_AND_SHAPES.

      Parameters:
      type - the type of renderer.
      labelGenerator - the tool tip generator to use. null is none.
      urlGenerator - the URL generator (null permitted).

  • Method Details

    • isOutline

      public boolean isOutline()
      Returns a flag that controls whether or not outlines of the areas are drawn.
      Returns:
      the flag.

    • setOutline

      public void setOutline​(boolean show)
      Sets a flag that controls whether or not outlines of the areas are drawn.
      Parameters:
      show - the flag.

    • getPlotShapes

      public boolean getPlotShapes()
      Returns true if shapes are being plotted by the renderer.
      Returns:
      true if shapes are being plotted by the renderer.

    • getPlotLines

      public boolean getPlotLines()
      Returns true if lines are being plotted by the renderer.
      Returns:
      true if lines are being plotted by the renderer.

    • getPlotArea

      public boolean getPlotArea()
      Returns true if Area is being plotted by the renderer.
      Returns:
      true if Area is being plotted by the renderer.

    • initialise

      public XYItemRendererState initialise​(Graphics2D g2, Rectangle2D dataArea, XYPlot plot, XYDataset data, PlotRenderingInfo info)
      Initialises the renderer and returns a state object that should be passed to all subsequent calls to the drawItem(...) method.
      Specified by:
      initialise in interface XYItemRenderer
      Overrides:
      initialise in class AbstractXYItemRenderer
      Parameters:
      g2 - the graphics device.
      dataArea - the area inside the axes.
      plot - the plot.
      data - the data.
      info - an optional info collection object to return data back to the caller.
      Returns:
      a state object for use by the renderer.

    • drawItem

      public void drawItem​(Graphics2D g2, XYItemRendererState state, Rectangle2D dataArea, PlotRenderingInfo info, XYPlot plot, ValueAxis domainAxis, ValueAxis rangeAxis, XYDataset dataset, int series, int item, CrosshairState crosshairState, int pass)
      Draws the visual representation of a single data item.
      Specified by:
      drawItem in interface XYItemRenderer
      Parameters:
      g2 - the graphics device.
      state - the renderer state.
      dataArea - the area within which the data is being drawn.
      info - collects information about the drawing.
      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.

    • clone

      public Object clone() throws CloneNotSupportedException
      Returns a clone of the renderer.
      Specified by:
      clone in interface org.jfree.util.PublicCloneable
      Returns:
      A clone.
      Throws:
      CloneNotSupportedException - if the renderer cannot be cloned.