public class

StackedAreaRenderer

extends AreaRenderer
implements Serializable Cloneable
java.lang.Object
   ↳ org.jfree.chart.renderer.AbstractRenderer
     ↳ org.jfree.chart.renderer.category.AbstractCategoryItemRenderer
       ↳ org.jfree.chart.renderer.category.AreaRenderer
         ↳ org.jfree.chart.renderer.category.StackedAreaRenderer

Class Overview

A renderer that draws stacked area charts for a CategoryPlot. The example shown here is generated by the StackedAreaChartDemo1.java program included in the JFreeChart Demo Collection:

StackedAreaRendererSample.png

Summary

[Expand]
Inherited Fields
From class org.jfree.chart.renderer.AbstractRenderer
Public Constructors
StackedAreaRenderer()
Creates a new renderer.
StackedAreaRenderer(boolean renderAsPercentages)
Creates a new renderer.
Public Methods
void drawItem(Graphics2D g2, CategoryItemRendererState state, Rectangle2D dataArea, CategoryPlot plot, CategoryAxis domainAxis, ValueAxis rangeAxis, CategoryDataset dataset, int row, int column, int pass)
Draw a single data item.
boolean equals(Object obj)
Checks this instance for equality with an arbitrary object.
Range findRangeBounds(CategoryDataset dataset)
Returns the range of values the renderer requires to display all the items from the specified dataset.
int getPassCount()
Returns the number of passes (2) required by this renderer.
boolean getRenderAsPercentages()
Returns true if the renderer displays each item value as a percentage (so that the stacked areas add to 100%), and false otherwise.
void setRenderAsPercentages(boolean asPercentages)
Sets the flag that controls whether the renderer displays each item value as a percentage (so that the stacked areas add to 100%), and sends a RendererChangeEvent to all registered listeners.
Protected Methods
double getPreviousHeight(CategoryDataset dataset, int series, int category)
This method is deprecated. As of 1.0.13, as the method is never used internally.
double[] getStackValues(CategoryDataset dataset, int series, int index, int[] validRows)
Calculates the stacked values (one positive and one negative) of all series up to, but not including, series for the specified item.
[Expand]
Inherited Methods
From class org.jfree.chart.renderer.category.AreaRenderer
From class org.jfree.chart.renderer.category.AbstractCategoryItemRenderer
From class org.jfree.chart.renderer.AbstractRenderer
From class java.lang.Object
From interface org.jfree.chart.LegendItemSource
From interface org.jfree.chart.renderer.category.CategoryItemRenderer

Public Constructors

public StackedAreaRenderer ()

Creates a new renderer.

public StackedAreaRenderer (boolean renderAsPercentages)

Creates a new renderer.

Parameters
renderAsPercentages a flag that controls whether the data values are rendered as percentages.

Public Methods

public void drawItem (Graphics2D g2, CategoryItemRendererState state, Rectangle2D dataArea, CategoryPlot plot, CategoryAxis domainAxis, ValueAxis rangeAxis, CategoryDataset dataset, int row, int column, int pass)

Draw a single data item.

Parameters
g2 the graphics device.
state the renderer state.
dataArea the data plot area.
plot the plot.
domainAxis the domain axis.
rangeAxis the range axis.
dataset the data.
row the row index (zero-based).
column the column index (zero-based).
pass the pass index.

public boolean equals (Object obj)

Checks this instance for equality with an arbitrary object.

Parameters
obj the object (null not permitted).
Returns
  • A boolean.

public Range findRangeBounds (CategoryDataset dataset)

Returns the range of values the renderer requires to display all the items from the specified dataset.

Parameters
dataset the dataset (null not permitted).
Returns
  • The range (or null if the dataset is empty).

public int getPassCount ()

Returns the number of passes (2) required by this renderer. The first pass is used to draw the areas, the second pass is used to draw the item labels (if visible).

Returns
  • The number of passes required by the renderer.

public boolean getRenderAsPercentages ()

Returns true if the renderer displays each item value as a percentage (so that the stacked areas add to 100%), and false otherwise.

Returns
  • A boolean.

public void setRenderAsPercentages (boolean asPercentages)

Sets the flag that controls whether the renderer displays each item value as a percentage (so that the stacked areas add to 100%), and sends a RendererChangeEvent to all registered listeners.

Parameters
asPercentages the flag.

Protected Methods

protected double getPreviousHeight (CategoryDataset dataset, int series, int category)

This method is deprecated.
As of 1.0.13, as the method is never used internally.

Calculates the stacked value of the all series up to, but not including series for the specified category, category. It returns 0.0 if series is the first series, i.e. 0.

Parameters
dataset the dataset (null not permitted).
series the series.
category the category.
Returns
  • double returns a cumulative value for all series' values up to but excluding series for Object category.

protected double[] getStackValues (CategoryDataset dataset, int series, int index, int[] validRows)

Calculates the stacked values (one positive and one negative) of all series up to, but not including, series for the specified item. It returns [0.0, 0.0] if series is the first series.

Parameters
dataset the dataset (null not permitted).
series the series index.
index the item index.
Returns
  • An array containing the cumulative negative and positive values for all series values up to but excluding series for index.