Package org.jfree.chart.renderer

Class XYStepAreaRenderer

java.lang.Object
org.jfree.chart.renderer.AbstractRenderer
org.jfree.chart.renderer.AbstractXYItemRenderer
org.jfree.chart.renderer.XYStepAreaRenderer
All Implemented Interfaces:
Serializable, Cloneable, XYItemRenderer, org.jfree.util.PublicCloneable
public class XYStepAreaRenderer
extends AbstractXYItemRenderer
implements XYItemRenderer, Cloneable, org.jfree.util.PublicCloneable, Serializable
A step chart renderer that fills the area between the step and the x-axis.
Author:
Matthias Rose
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

    • 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

    • XYStepAreaRenderer

      public XYStepAreaRenderer()
      Constructs a new renderer.

    • XYStepAreaRenderer

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

    • XYStepAreaRenderer

      public XYStepAreaRenderer​(int type, XYToolTipGenerator toolTipGenerator, XYURLGenerator urlGenerator)
      Constructs a new renderer.

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

      Parameters:
      type - the type of renderer.
      toolTipGenerator - the tool tip generator to use (null permitted).
      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, and sends a RendererChangeEvent to all registered listeners.
      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.

    • setPlotShapes

      public void setPlotShapes​(boolean flag)
      Sets the flag that controls whether or not shapes are displayed for each data item.
      Parameters:
      flag - the flag.

    • isShapesFilled

      public boolean isShapesFilled()
      Returns the flag that controls whether or not the shapes are filled.
      Returns:
      a boolean.

    • setShapesFilled

      public void setShapesFilled​(boolean filled)
      Sets the 'shapes filled' for ALL series.
      Parameters:
      filled - the flag.

    • getPlotArea

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

    • setPlotArea

      public void setPlotArea​(boolean flag)
      Sets a flag that controls whether or not areas are drawn for each data item.
      Parameters:
      flag - the flag.

    • getRangeBase

      public double getRangeBase()
      Returns the value on the range axis which defines the 'lower' border of the area.
      Returns:
      double the value on the range axis which defines the 'lower' border of the area.

    • setRangeBase

      public void setRangeBase​(double val)
      Sets the value on the range axis which defines the default border of the area. E.g. setRangeBase(Double.NEGATIVE_INFINITY) lets areas always reach the lower border of the plotArea.
      Parameters:
      val - the value on the range axis which defines the default border of the area.

    • initialise

      public XYItemRendererState initialise​(Graphics2D g2, Rectangle2D dataArea, XYPlot plot, XYDataset data, PlotRenderingInfo info)
      Initialises the renderer. Here we calculate the Java2D y-coordinate for zero, since all the bars have their bases fixed at zero.
      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:
      The number of passes required 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.