Class BoxAndWhiskerRenderer

    • Constructor Detail

      • BoxAndWhiskerRenderer

        public BoxAndWhiskerRenderer()
        Default constructor.
    • Method Detail

      • getArtifactPaint

        public Paint getArtifactPaint()
        Returns the paint used to color the median and average markers.
        Returns:
        The paint used to draw the median and average markers (never null).
        See Also:
        setArtifactPaint(Paint)
      • setArtifactPaint

        public void setArtifactPaint​(Paint paint)
        Sets the paint used to color the median and average markers and sends a RendererChangeEvent to all registered listeners.
        Parameters:
        paint - the paint (null not permitted).
        See Also:
        getArtifactPaint()
      • getFillBox

        public boolean getFillBox()
        Returns the flag that controls whether or not the box is filled.
        Returns:
        A boolean.
        See Also:
        setFillBox(boolean)
      • setFillBox

        public void setFillBox​(boolean flag)
        Sets the flag that controls whether or not the box is filled and sends a RendererChangeEvent to all registered listeners.
        Parameters:
        flag - the flag.
        See Also:
        getFillBox()
      • getItemMargin

        public double getItemMargin()
        Returns the item margin. This is a percentage of the available space that is allocated to the space between items in the chart.
        Returns:
        The margin.
        See Also:
        setItemMargin(double)
      • setItemMargin

        public void setItemMargin​(double margin)
        Sets the item margin and sends a RendererChangeEvent to all registered listeners.
        Parameters:
        margin - the margin (a percentage).
        See Also:
        getItemMargin()
      • getMaximumBarWidth

        public double getMaximumBarWidth()
        Returns the maximum bar width as a percentage of the available drawing space. Take care with the encoding, for example 0.10 is ten percent.
        Returns:
        The maximum bar width.
        Since:
        1.0.10
        See Also:
        setMaximumBarWidth(double)
      • setMaximumBarWidth

        public void setMaximumBarWidth​(double percent)
        Sets the maximum bar width, which is specified as a percentage of the available space for all bars, and sends a RendererChangeEvent to all registered listeners.
        Parameters:
        percent - the maximum bar width (a percentage, where 0.10 is ten percent).
        Since:
        1.0.10
        See Also:
        getMaximumBarWidth()
      • isMeanVisible

        public boolean isMeanVisible()
        Returns the flag that controls whether or not the mean indicator is draw for each item.
        Returns:
        A boolean.
        Since:
        1.0.13
        See Also:
        setMeanVisible(boolean)
      • setMeanVisible

        public void setMeanVisible​(boolean visible)
        Sets the flag that controls whether or not the mean indicator is drawn for each item, and sends a RendererChangeEvent to all registered listeners.
        Parameters:
        visible - the new flag value.
        Since:
        1.0.13
        See Also:
        isMeanVisible()
      • isMedianVisible

        public boolean isMedianVisible()
        Returns the flag that controls whether or not the median indicator is draw for each item.
        Returns:
        A boolean.
        Since:
        1.0.13
        See Also:
        setMedianVisible(boolean)
      • setMedianVisible

        public void setMedianVisible​(boolean visible)
        Sets the flag that controls whether or not the median indicator is drawn for each item, and sends a RendererChangeEvent to all registered listeners.
        Parameters:
        visible - the new flag value.
        Since:
        1.0.13
        See Also:
        isMedianVisible()
      • getUseOutlinePaintForWhiskers

        public boolean getUseOutlinePaintForWhiskers()
        Returns the flag that, if true, causes the whiskers to be drawn using the series outline paint.
        Returns:
        A boolean.
        Since:
        1.0.14
      • setUseOutlinePaintForWhiskers

        public void setUseOutlinePaintForWhiskers​(boolean flag)
        Sets the flag that, if true, causes the whiskers to be drawn using the series outline paint, and sends a RendererChangeEvent to all registered listeners.
        Parameters:
        flag - the new flag value.
        Since:
        1.0.14
      • getWhiskerWidth

        public double getWhiskerWidth()
        Returns the width of the whiskers as fraction of the bar width.
        Returns:
        The width of the whiskers.
        Since:
        1.0.14
        See Also:
        setWhiskerWidth(double)
      • setWhiskerWidth

        public void setWhiskerWidth​(double width)
        Sets the width of the whiskers as a fraction of the bar width and sends a RendererChangeEvent to all registered listeners.
        Parameters:
        width - a value between 0 and 1 indicating how wide the whisker is supposed to be compared to the bar.
        Since:
        1.0.14
        See Also:
        getWhiskerWidth(), CategoryItemRendererState.getBarWidth()
      • drawHorizontalItem

        public void drawHorizontalItem​(Graphics2D g2,
                                       CategoryItemRendererState state,
                                       Rectangle2D dataArea,
                                       CategoryPlot plot,
                                       CategoryAxis domainAxis,
                                       ValueAxis rangeAxis,
                                       CategoryDataset dataset,
                                       int row,
                                       int column)
        Draws the visual representation of a single data item when the plot has a horizontal orientation.
        Parameters:
        g2 - the graphics device.
        state - the renderer state.
        dataArea - the area within which the plot is being drawn.
        plot - the plot (can be used to obtain standard color information etc).
        domainAxis - the domain axis.
        rangeAxis - the range axis.
        dataset - the dataset (must be an instance of BoxAndWhiskerCategoryDataset).
        row - the row index (zero-based).
        column - the column index (zero-based).
      • drawVerticalItem

        public void drawVerticalItem​(Graphics2D g2,
                                     CategoryItemRendererState state,
                                     Rectangle2D dataArea,
                                     CategoryPlot plot,
                                     CategoryAxis domainAxis,
                                     ValueAxis rangeAxis,
                                     CategoryDataset dataset,
                                     int row,
                                     int column)
        Draws the visual representation of a single data item when the plot has a vertical orientation.
        Parameters:
        g2 - the graphics device.
        state - the renderer state.
        dataArea - the area within which the plot is being drawn.
        plot - the plot (can be used to obtain standard color information etc).
        domainAxis - the domain axis.
        rangeAxis - the range axis.
        dataset - the dataset (must be an instance of BoxAndWhiskerCategoryDataset).
        row - the row index (zero-based).
        column - the column index (zero-based).
      • equals

        public boolean equals​(Object obj)
        Tests this renderer for equality with an arbitrary object.
        Overrides:
        equals in class AbstractCategoryItemRenderer
        Parameters:
        obj - the object (null permitted).
        Returns:
        true or false.