de.erichseifert.gral.plots

Class BarPlot

java.lang.Object

de.erichseifert.gral.graphics.AbstractDrawable

de.erichseifert.gral.graphics.DrawableContainer

de.erichseifert.gral.plots.AbstractPlot

de.erichseifert.gral.plots.XYPlot

de.erichseifert.gral.plots.BarPlot

All Implemented Interfaces:

DataListener, Container, Drawable, Navigable, AxisListener, Plot, java.io.Serializable, java.lang.Iterable<Drawable>

public class BarPlot
extends XYPlot

Class that displays data in a bar plot.

To create a new BarPlot simply create a new instance using one or more data sources. Example:

 DataTable data = new DataTable(Integer.class, Double.class);
 data.add(2010, -5.00);
 data.add(2011,  3.25);
 data.add(2012, -0.50);
 data.add(2012,  4.00);

 BarPlot plot = new BarPlot(data);
 

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	BarPlot.BarPlotLegend A legend implementation for bar plots that displays all values of the data source as items.
static class	BarPlot.BarRenderer Class that renders a bar in a bar plot.

Nested classes/interfaces inherited from class de.erichseifert.gral.plots.XYPlot

XYPlot.XYLegend, XYPlot.XYNavigationDirection, XYPlot.XYPlotArea2D, XYPlot.XYPlotNavigator

Field Summary

Fields inherited from class de.erichseifert.gral.plots.XYPlot

AXIS_X, AXIS_X2, AXIS_Y, AXIS_Y2

Constructor Summary

Constructors

Constructor and Description
BarPlot(DataSource... data) Creates a new instance and initializes it with the specified data sources.

Method Summary

Modifier and Type	Method and Description
void	add(int index, DataSource source, boolean visible) Inserts the specified data series to the plot at a specified position.
void	autoscaleAxis(java.lang.String axisName) Tries to automatically set the ranges of the axes specified by the name if it is set to auto-scale.
double	getBarHeightMin() Returns the minimum height of the bars in view units (e.g.
double	getBarWidth() Returns the width of the bars in axis coordinates.
boolean	isPaintAllBars() Returns whether all bars are filled as a whole, or if each bar is filled independently.
void	setBarHeightMin(double barHeightMin) Sets the minimum height of the bars in view units (e.g.
void	setBarWidth(double barWidth) Sets the width of the bars in axis coordinates.
void	setPaintAllBars(boolean paintAllBars) Sets whether all bars will be filled as a whole, or if each bar will be filled independently.

Methods inherited from class de.erichseifert.gral.plots.XYPlot

addPointRenderer, draw, getAreaRenderers, getLineRenderers, getNavigator, getPointRenderers, rangeChanged, removePointRenderer, setAreaRenderers, setAreaRenderers, setAxisRenderer, setLineRenderers, setLineRenderers, setPointRenderers, setPointRenderers

Methods inherited from class de.erichseifert.gral.plots.AbstractPlot

add, add, clear, contains, dataAdded, dataRemoved, dataUpdated, get, getAxesNames, getAxis, getAxisRenderer, getBackground, getBorderColor, getBorderStroke, getData, getFont, getLegend, getLegendDistance, getLegendLocation, getMapping, getPlotArea, getTitle, getVisibleData, isLegendVisible, isVisible, layout, remove, removeAxis, setAxis, setBackground, setBorderColor, setBorderStroke, setFont, setLegendDistance, setLegendLocation, setLegendVisible, setMapping, setVisible

Methods inherited from class de.erichseifert.gral.graphics.DrawableContainer

add, add, contains, getConstraints, getDrawables, getDrawablesAt, getInsets, getLayout, getPreferredSize, iterator, remove, setBounds, setBounds, setInsets, setLayout, size

Methods inherited from class de.erichseifert.gral.graphics.AbstractDrawable

getBounds, getHeight, getWidth, getX, getY, setPosition

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface de.erichseifert.gral.graphics.Drawable

getBounds, getHeight, getPreferredSize, getWidth, getX, getY, setBounds, setBounds, setPosition

Methods inherited from interface de.erichseifert.gral.graphics.Container

add, add, contains, getBounds, getConstraints, getDrawables, getDrawablesAt, getInsets, getLayout, remove, setBounds, setInsets, setLayout, size

Methods inherited from interface java.lang.Iterable

forEach, iterator, spliterator

Constructor Detail

BarPlot

public BarPlot(DataSource... data)

Creates a new instance and initializes it with the specified data sources.

Parameters:

data - Data to be displayed.

Method Detail

autoscaleAxis

public void autoscaleAxis(java.lang.String axisName)

Description copied from class: AbstractPlot

Tries to automatically set the ranges of the axes specified by the name if it is set to auto-scale.

Specified by:

autoscaleAxis in interface Plot

Overrides:

autoscaleAxis in class AbstractPlot

Parameters:

axisName - Name of the axis that should be scaled.

See Also:

Axis.setAutoscaled(boolean)

add

public void add(int index,
                DataSource source,
                boolean visible)

Description copied from class: AbstractPlot

Inserts the specified data series to the plot at a specified position.

Specified by:

add in interface Plot

Overrides:

add in class XYPlot

Parameters:

index - Position.

source - Data series.

visible - true if the series should be displayed, false otherwise.

getBarWidth

public double getBarWidth()

Returns the width of the bars in axis coordinates.

Returns:

Width of the bars in axis coordinates.

setBarWidth

public void setBarWidth(double barWidth)

Sets the width of the bars in axis coordinates.

Parameters:

barWidth - Width of the bars in axis coordinates.

getBarHeightMin

public double getBarHeightMin()

Returns the minimum height of the bars in view units (e.g. pixels on screen).

Returns:

Minimum height of the bars in view units.

setBarHeightMin

public void setBarHeightMin(double barHeightMin)

Sets the minimum height of the bars in view units (e.g. pixels on screen).

Parameters:

barHeightMin - Minimum height of the bars in view units.

isPaintAllBars

public boolean isPaintAllBars()

Returns whether all bars are filled as a whole, or if each bar is filled independently.

Returns:

true if all bars are filled as a whole, or false if each bar is filled independently.

setPaintAllBars

public void setPaintAllBars(boolean paintAllBars)

Sets whether all bars will be filled as a whole, or if each bar will be filled independently.

Parameters:

paintAllBars - true to fill all bars as a whole, or false to fill each bar independently.