Class ClusteredXYBarRenderer

  • All Implemented Interfaces:
    java.io.Serializable, java.lang.Cloneable, java.util.EventListener, AnnotationChangeListener, LegendItemSource, XYItemRenderer, PublicCloneable

    public class ClusteredXYBarRenderer
    extends XYBarRenderer
    implements java.lang.Cloneable, PublicCloneable, java.io.Serializable
    An extension of XYBarRenderer that displays bars for different series values at the same x next to each other. The assumption here is that for each x (time or else) there is a y value for each series. If this is not the case, there will be spaces between bars for a given x. The example shown here is generated by the ClusteredXYBarRendererDemo1.java program included in the JFreeChart demo collection:

    ClusteredXYBarRendererSample.png

    This renderer does not include code to calculate the crosshair point for the plot.

    See Also:
    Serialized Form
    • Field Detail

      • serialVersionUID

        private static final long serialVersionUID
        For serialization.
        See Also:
        Constant Field Values
      • centerBarAtStartValue

        private final boolean centerBarAtStartValue
        Determines whether bar center should be interval start.
    • Constructor Detail

      • ClusteredXYBarRenderer

        public ClusteredXYBarRenderer()
        Default constructor. Bar margin is set to 0.0.
      • ClusteredXYBarRenderer

        public ClusteredXYBarRenderer​(double margin,
                                      boolean centerBarAtStartValue)
        Constructs a new XY clustered bar renderer.
        Parameters:
        margin - the percentage amount to trim from the width of each bar.
        centerBarAtStartValue - if true, bars will be centered on the start of the time period.
    • Method Detail

      • getPassCount

        public int getPassCount()
        Returns the number of passes through the dataset that this renderer requires. In this case, two passes are required, the first for drawing the shadows (if visible), and the second for drawing the bars.
        Specified by:
        getPassCount in interface XYItemRenderer
        Overrides:
        getPassCount in class AbstractXYItemRenderer
        Returns:
        2.
      • findDomainBoundsWithOffset

        protected Range findDomainBoundsWithOffset​(IntervalXYDataset dataset)
        Iterates over the items in an IntervalXYDataset to find the range of x-values including the interval OFFSET so that it centers the interval around the start value.
        Parameters:
        dataset - the dataset (null not permitted).
        Returns:
        The range (possibly null).
      • drawItem

        public 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)
        Draws the visual representation of a single data item. This method is mostly copied from the superclass, the change is that in the calculated space for a singe bar we draw bars for each series next to each other. The width of each bar is the available width divided by the number of series. Bars for each series are drawn in order left to right.
        Specified by:
        drawItem in interface XYItemRenderer
        Overrides:
        drawItem in class XYBarRenderer
        Parameters:
        g2 - the graphics device.
        state - the renderer state.
        dataArea - the area within which the plot 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.
        item - the item index.
        crosshairState - crosshair information for the plot (null permitted).
        pass - the pass index.
      • equals

        public boolean equals​(java.lang.Object obj)
        Tests this renderer for equality with an arbitrary object, returning true if obj is a ClusteredXYBarRenderer with the same settings as this renderer, and false otherwise.
        Overrides:
        equals in class XYBarRenderer
        Parameters:
        obj - the object (null permitted).
        Returns:
        A boolean.
      • clone

        public java.lang.Object clone()
                               throws java.lang.CloneNotSupportedException
        Returns a clone of the renderer.
        Specified by:
        clone in interface PublicCloneable
        Overrides:
        clone in class XYBarRenderer
        Returns:
        A clone.
        Throws:
        java.lang.CloneNotSupportedException - if the renderer cannot be cloned.