Documentation of 'org.jfree.chart.renderer.xy.XYBarRenderer' Java class
XYBarRenderer
org.jfree.chart.renderer.xy

Class XYBarRenderer

    • Constructor Detail

      • XYBarRenderer

        public XYBarRenderer()
        The default constructor.
      • XYBarRenderer

        public XYBarRenderer(double margin)
        Constructs a new renderer.
        Parameters:
        margin - the percentage amount to trim from the width of each bar.
    • Method Detail

      • getDefaultBarPainter

        public static XYBarPainter getDefaultBarPainter()
        Returns the default bar painter.
        Returns:
        The default bar painter.
        Since:
        1.0.11
      • setDefaultBarPainter

        public static void setDefaultBarPainter(XYBarPainter painter)
        Sets the default bar painter.
        Parameters:
        painter - the painter (null not permitted).
        Since:
        1.0.11
      • getDefaultShadowsVisible

        public static boolean getDefaultShadowsVisible()
        Returns the default value for the shadowsVisible flag.
        Returns:
        A boolean.
        Since:
        1.0.13
        See Also:
        setDefaultShadowsVisible(boolean)
      • setDefaultShadowsVisible

        public static void setDefaultShadowsVisible(boolean visible)
        Sets the default value for the shadows visible flag.
        Parameters:
        visible - the new value for the default.
        Since:
        1.0.13
        See Also:
        getDefaultShadowsVisible()
      • getBase

        public double getBase()
        Returns the base value for the bars.
        Returns:
        The base value for the bars.
        See Also:
        setBase(double)
      • setBase

        public void setBase(double base)
        Sets the base value for the bars and sends a RendererChangeEvent to all registered listeners. The base value is not used if the dataset's y-interval is being used to determine the bar length.
        Parameters:
        base - the new base value.
        See Also:
        getBase(), getUseYInterval()
      • getUseYInterval

        public boolean getUseYInterval()
        Returns a flag that determines whether the y-interval from the dataset is used to calculate the length of each bar.
        Returns:
        A boolean.
        See Also:
        setUseYInterval(boolean)
      • setUseYInterval

        public void setUseYInterval(boolean use)
        Sets the flag that determines whether the y-interval from the dataset is used to calculate the length of each bar, and sends a RendererChangeEvent to all registered listeners.
        Parameters:
        use - the flag.
        See Also:
        getUseYInterval()
      • getMargin

        public double getMargin()
        Returns the margin which is a percentage amount by which the bars are trimmed.
        Returns:
        The margin.
        See Also:
        setMargin(double)
      • setMargin

        public void setMargin(double margin)
        Sets the percentage amount by which the bars are trimmed and sends a RendererChangeEvent to all registered listeners.
        Parameters:
        margin - the new margin.
        See Also:
        getMargin()
      • isDrawBarOutline

        public boolean isDrawBarOutline()
        Returns a flag that controls whether or not bar outlines are drawn.
        Returns:
        A boolean.
        See Also:
        setDrawBarOutline(boolean)
      • setDrawBarOutline

        public void setDrawBarOutline(boolean draw)
        Sets the flag that controls whether or not bar outlines are drawn and sends a RendererChangeEvent to all registered listeners.
        Parameters:
        draw - the flag.
        See Also:
        isDrawBarOutline()
      • getGradientPaintTransformer

        public org.jfree.ui.GradientPaintTransformer getGradientPaintTransformer()
        Returns the gradient paint transformer (an object used to transform gradient paint objects to fit each bar).
        Returns:
        A transformer (null possible).
        See Also:
        setGradientPaintTransformer(GradientPaintTransformer)
      • setGradientPaintTransformer

        public void setGradientPaintTransformer(org.jfree.ui.GradientPaintTransformer transformer)
        Sets the gradient paint transformer and sends a RendererChangeEvent to all registered listeners.
        Parameters:
        transformer - the transformer (null permitted).
        See Also:
        getGradientPaintTransformer()
      • getLegendBar

        public java.awt.Shape getLegendBar()
        Returns the shape used to represent bars in each legend item.
        Returns:
        The shape used to represent bars in each legend item (never null).
        See Also:
        setLegendBar(Shape)
      • setLegendBar

        public void setLegendBar(java.awt.Shape bar)
        Sets the shape used to represent bars in each legend item and sends a RendererChangeEvent to all registered listeners.
        Parameters:
        bar - the bar shape (null not permitted).
        See Also:
        getLegendBar()
      • setPositiveItemLabelPositionFallback

        public void setPositiveItemLabelPositionFallback(ItemLabelPosition position)
        Sets the fallback position for positive item labels that don't fit within a bar, and sends a RendererChangeEvent to all registered listeners.
        Parameters:
        position - the position (null permitted).
        Since:
        1.0.2
        See Also:
        getPositiveItemLabelPositionFallback()
      • setNegativeItemLabelPositionFallback

        public void setNegativeItemLabelPositionFallback(ItemLabelPosition position)
        Sets the fallback position for negative item labels that don't fit within a bar, and sends a RendererChangeEvent to all registered listeners.
        Parameters:
        position - the position (null permitted).
        Since:
        1.0.2
        See Also:
        getNegativeItemLabelPositionFallback()
      • getBarPainter

        public XYBarPainter getBarPainter()
        Returns the bar painter.
        Returns:
        The bar painter (never null).
        Since:
        1.0.11
      • setBarPainter

        public void setBarPainter(XYBarPainter painter)
        Sets the bar painter and sends a RendererChangeEvent to all registered listeners.
        Parameters:
        painter - the painter (null not permitted).
        Since:
        1.0.11
      • getShadowsVisible

        public boolean getShadowsVisible()
        Returns the flag that controls whether or not shadows are drawn for the bars.
        Returns:
        A boolean.
        Since:
        1.0.11
      • setShadowVisible

        public void setShadowVisible(boolean visible)
        Sets the flag that controls whether or not the renderer draws shadows for the bars, and sends a RendererChangeEvent to all registered listeners.
        Parameters:
        visible - the new flag value.
        Since:
        1.0.11
      • getShadowXOffset

        public double getShadowXOffset()
        Returns the shadow x-offset.
        Returns:
        The shadow x-offset.
        Since:
        1.0.11
      • setShadowXOffset

        public void setShadowXOffset(double offset)
        Sets the x-offset for the bar shadow and sends a RendererChangeEvent to all registered listeners.
        Parameters:
        offset - the offset.
        Since:
        1.0.11
      • getShadowYOffset

        public double getShadowYOffset()
        Returns the shadow y-offset.
        Returns:
        The shadow y-offset.
        Since:
        1.0.11
      • setShadowYOffset

        public void setShadowYOffset(double offset)
        Sets the y-offset for the bar shadow and sends a RendererChangeEvent to all registered listeners.
        Parameters:
        offset - the offset.
        Since:
        1.0.11
      • getBarAlignmentFactor

        public double getBarAlignmentFactor()
        Returns the bar alignment factor.
        Returns:
        The bar alignment factor.
        Since:
        1.0.13
      • setBarAlignmentFactor

        public void setBarAlignmentFactor(double factor)
        Sets the bar alignment factor and sends a RendererChangeEvent to all registered listeners. If the alignment factor is outside the range 0.0 to 1.0, no alignment will be performed by the renderer.
        Parameters:
        factor - the factor.
        Since:
        1.0.13
      • initialise

        public XYItemRendererState initialise(java.awt.Graphics2D g2,
                                              java.awt.geom.Rectangle2D dataArea,
                                              XYPlot plot,
                                              XYDataset dataset,
                                              PlotRenderingInfo info)
        Initialises the renderer and returns a state object that should be passed to all subsequent calls to the drawItem() method. 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.
        dataset - the data.
        info - an optional info collection object to return data back to the caller.
        Returns:
        A state object.
      • getLegendItem

        public LegendItem getLegendItem(int datasetIndex,
                                        int series)
        Returns a default legend item for the specified series. Subclasses should override this method to generate customised items.
        Specified by:
        getLegendItem in interface XYItemRenderer
        Overrides:
        getLegendItem in class AbstractXYItemRenderer
        Parameters:
        datasetIndex - the dataset index (zero-based).
        series - the series index (zero-based).
        Returns:
        A legend item for the series.
      • 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.
        Specified by:
        drawItem in interface XYItemRenderer
        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 (zero-based).
        item - the item index (zero-based).
        crosshairState - crosshair information for the plot (null permitted).
        pass - the pass index.
      • clone

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

        public boolean equals(java.lang.Object obj)
        Tests this renderer for equality with an arbitrary object.
        Overrides:
        equals in class AbstractXYItemRenderer
        Parameters:
        obj - the object to test against (null permitted).
        Returns:
        A boolean.

DMelt 3.0 © DataMelt by jWork.ORG

You see the box below because you did not login.