Module platform
Package org.jfree.chart.renderer.category

Class CategoryItemRendererState

java.lang.Object
org.jfree.chart.renderer.RendererState
org.jfree.chart.renderer.category.CategoryItemRendererState
Direct Known Subclasses:
CategoryStepRenderer.State
public class CategoryItemRendererState extends RendererState
An object that retains temporary state information for a CategoryItemRenderer.

  • Constructor Details

    • CategoryItemRendererState

      public CategoryItemRendererState(PlotRenderingInfo info)
      Creates a new object for recording temporary state information for a renderer.
      Parameters:
      info - the plot rendering info (null permitted).

  • Method Details

    • getBarWidth

      public double getBarWidth()
      Returns the bar width.
      Returns:
      The bar width.
      See Also:

    • setBarWidth

      public void setBarWidth(double width)
      Sets the bar width. The renderer calculates this value and stores it here - it is not intended that users can manually set the bar width.
      Parameters:
      width - the width.
      See Also:

    • getSeriesRunningTotal

      public double getSeriesRunningTotal()
      Returns the series running total.
      Returns:
      The running total.
      See Also:
      • setSeriesRunningTotal(double)

    • getCrosshairState

      public CategoryCrosshairState getCrosshairState()
      Returns the crosshair state, if any.
      Returns:
      The crosshair state (possibly null).
      See Also:

    • setCrosshairState

      public void setCrosshairState(CategoryCrosshairState state)
      Sets the crosshair state.
      Parameters:
      state - the new state (null permitted).
      See Also:

    • getVisibleSeriesIndex

      public int getVisibleSeriesIndex(int rowIndex)
      Returns the index of the row relative to the visible rows. If no visible rows have been specified, the original row index is returned. If the row index is not included in the array of visible rows, -1 is returned.
      Parameters:
      rowIndex - the row index.
      Returns:
      The new row index or -1.

    • getVisibleSeriesCount

      public int getVisibleSeriesCount()
      Returns the number of visible series or -1 if no visible series have been specified.
      Returns:
      The number or -1.

    • getVisibleSeriesArray

      public int[] getVisibleSeriesArray()
      Returns a copy of the visible series array.
      Returns:
      The visible series array (possibly null).

    • setVisibleSeriesArray

      public void setVisibleSeriesArray(int[] visibleSeries)
      Sets an array with the indices of the visible rows.
      Parameters:
      visibleSeries - the array (null permitted).