This class provides tools to create and manage box-and-whisker plots. More...

Inheritance diagram for BoxChart:

Collaboration diagram for BoxChart:

Public Member Functions
	BoxChart ()
	Initializes a new `BoxChart` instance with an empty data set.

	BoxChart (String title, String XLabel, String YLabel, double[] data, int numPoints)
	Initializes a new `BoxChart` instance with data `data`. More...

	BoxChart (String title, String XLabel, String YLabel, double[]... data)
	Initializes a new `BoxChart` instance with data `data`. More...

int	add (double[] data)
	Adds a data series into the series collection. More...

int	add (double[] data, int numPoints)
	Adds a data series into the series collection. More...

BoxSeriesCollection	getSeriesCollection ()
	Returns the chart’s dataset. More...

void	setSeriesCollection (BoxSeriesCollection dataset)
	Links a new dataset to the current chart. More...

void	setFillBox (boolean fill)
	Sets `fill` to `true`, if the boxes are to be filled. More...

JFrame	view (int width, int height)
	Displays chart on the screen using Swing. More...

Latex-specific method
String	toLatex (double width, double height)
	NOT IMPLEMENTED. More...

Public Member Functions inherited from CategoryChart
JFreeChart	getJFreeChart ()
	Returns the `JFreeChart` object associated with this chart. More...

Axis	getYAxis ()
	Returns the chart’s range axis ( \(y\)-axis) object. More...

abstract JFrame	view (int width, int height)
	Displays the chart on the screen using Swing. More...

String	getTitle ()
	Gets the current chart title. More...

void	setTitle (String title)
	Sets a title to this chart. More...

void	setAutoRange ()
	Sets chart \(y\) range to automatic values.

void	enableGrid (double xstep, double ystep)
	Puts a grid on the background. More...

void	disableGrid ()
	Disables the background grid.

abstract String	toLatex (double width, double height)
	Transforms the chart into LaTeX form and returns it as a `String`.

void	setLatexDocFlag (boolean flag)
	Same as in XYChart.

Protected Member Functions
void	init (String title, String XLabel, String YLabel)

void	initAxis ()

Protected Member Functions inherited from CategoryChart
double	computeYScale (double position)

double	computeScale (double[] bounds)

Additional Inherited Members
Protected Attributes inherited from CategoryChart
Axis	YAxis

SSJCategorySeriesCollection	dataset

JFreeChart	chart

boolean	latexDocFlag = true

boolean	autoRange

double []	manualRange

boolean	grid = false

double	ystepGrid

final double	BOR = 0.1

Detailed Description

This class provides tools to create and manage box-and-whisker plots.

Each BoxChart object is linked with a umontreal.ssj.charts.BoxSeriesCollection data set.

A boxplot is a convenient way of viewing sets of numerical data through their summaries: the smallest observation, first quartile ( \(Q_1 = x_{.25}\)), median ( \(Q_2 = x_{.5}\)), third quartile ( \(Q_3 = x_{.75}\)), and largest observation. Sometimes, the mean and the outliers are also plotted.

In the charts created by this class, the box has its lower limit at \(Q_1\) and its upper limit at \(Q_3\). The median is indicated by the line inside the box, while the mean is at the center of the filled circle inside the box. Define the interquartile range as ( \(Q_3 - Q_1\)). Any data observation which is more than \(1.5(Q_3 - Q_1)\) lower than the first quartile or \(1.5(Q_3 - Q_1)\) higher than the third quartile is considered an outlier. The smallest and the largest values that are not outliers are connected to the box with a vertical line or "whisker" which is ended by a horizontal line. Outliers are indicated by hollow circles outside the whiskers. Triangles indicate the existence of very far outliers.

Constructor & Destructor Documentation

◆ BoxChart() [1/2]

BoxChart	(	String	title,
		String	XLabel,
		String	YLabel,
		double []	data,
		int	numPoints
	)

Initializes a new BoxChart instance with data data.

title is a title, XLabel is a short description of the \(x\)-axis, and YLabel a short description of the \(y\)-axis. The input parameter data represents a set of plotting data. Only the first numPoints of data will be considered for the plot.

Parameters

title	chart title.
XLabel	Label on \(x\)-axis.
YLabel	Label on \(y\)-axis.
data	point sets.
numPoints	Number of points to plot

◆ BoxChart() [2/2]

BoxChart	(	String	title,
		String	XLabel,
		String	YLabel,
		double... []	data
	)

Initializes a new BoxChart instance with data data.

title sets a title, XLabel is a short description of the \(x\)-axis, and YLabel is a short description of the \(y\)-axis. The input parameter data represents a set of plotting data.

Parameters

title	chart title.
XLabel	Label on \(x\)-axis.
YLabel	Label on \(y\)-axis.
data	series of point sets.

Member Function Documentation

◆ add() [1/2]

int add ( double [] data )

Adds a data series into the series collection.

Vector data represents a set of plotting data.

Parameters

data	point sets.

Returns: Integer that represent the new point set’s position in the JFreeChart BoxSeriesCollection object.

◆ add() [2/2]

int add	(	double []	data,
		int	numPoints
	)

Adds a data series into the series collection.

Vector data represents a set of plotting data. Only the first numPoints of data will be taken into account for the new series.

Parameters

data	point set.
numPoints	number of points to add.

Returns: Integer that represent the new point set’s position in the JFreeChart BoxSeriesCollection object.

◆ getSeriesCollection()

BoxSeriesCollection getSeriesCollection ( )

Returns the chart’s dataset.

Returns: the chart’s dataset.

◆ setFillBox()

void setFillBox ( boolean fill )

Sets fill to true, if the boxes are to be filled.

Parameters

fill	true if the boxes are filled

◆ setSeriesCollection()

void setSeriesCollection ( BoxSeriesCollection dataset )

Links a new dataset to the current chart.

Parameters

dataset new dataset.

◆ toLatex()

String toLatex	(	double	width,
		double	height
	)

NOT IMPLEMENTED.

Parameters

width	Chart’s width in centimeters.
height	Chart’s height in centimeters.

Returns: LaTeX source code.

◆ view()

JFrame view	(	int	width,
		int	height
	)

Displays chart on the screen using Swing.

This method creates an application containing a chart panel displaying the chart. The created frame is positioned on-screen, and displayed before it is returned. The circle represents the mean, the dark line inside the box is the median, the box limits are the first and third quartiles, the lower whisker (the lower line outside the box) is the first decile, and the upper whisker is the ninth decile. The outliers, if any, are represented by empty circles, or arrows if outside the range bounds.

Parameters

width	frame width.
height	frame height.

Returns: frame containing the chart.

;

The documentation for this class was generated from the following file:

BoxChart.java

Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ BoxChart() [1/2]

◆ BoxChart() [2/2]

Member Function Documentation

◆ add() [1/2]

◆ add() [2/2]

◆ getSeriesCollection()

◆ setFillBox()

◆ setSeriesCollection()

◆ toLatex()

◆ view()