This class stores data used in a umontreal.ssj.charts.CategoryChart. More...

Inheritance diagram for umontreal.ssj.charts.BoxSeriesCollection:

Public Member Functions
	BoxSeriesCollection ()
	Creates a new BoxSeriesCollection instance with an empty dataset.
	BoxSeriesCollection (double[] data, int numPoints)
	Creates a new BoxSeriesCollection instance with default parameters and input series data.
	BoxSeriesCollection (double[]... data)
	Creates a new BoxSeriesCollection instance with default parameters and given data series.
	BoxSeriesCollection (DefaultBoxAndWhiskerCategoryDataset data)
	Creates a new BoxSeriesCollection instance with default parameters and given data series.
Data control methods @{
int	add (double[] data)
	Adds a data series into the series collection.
int	add (double[] data, int numPoints)
	Adds a data series into the series collection.
String	getName (int series)
	Gets the current name of the selected series.
double[]	getRangeBounds ()
	Returns the range ( \(y\)-coordinates) min and max values.
String	toString ()
	Returns in a String all data contained in the current object.
String	toLatex (double YScale, double YShift, double ymin, double ymax)
	NOT IMPLEMENTED: To do.
Public Member Functions inherited from umontreal.ssj.charts.SSJCategorySeriesCollection
String	getCategory (int series)
	Returns the category-value in the specified series.
double	getValue (int series, int index)
	Returns the \(y\)-value at the specified index in the specified series.
CategoryDataset	getSeriesCollection ()
	Returns the CategoryDataset object associated with the current object.
CategoryItemRenderer	getRenderer ()
	Returns the CategoryItemRenderer object associated with the current object.
void	setRenderer (CategoryItemRenderer renderer)
	Sets the CategoryItemRenderer object associated with the current variable.
Color	getColor (int series)
	Gets the current plotting color of the selected series.
void	setColor (int series, Color color)
	Sets a new plotting color to the series \(series\).

Additional Inherited Members
static String	detectXColorClassic (Color color)
	Converts a java Color object into a friendly and readable LaTeX/xcolor string.
static Color	getDefaultColor (int index)
	Gives the default color associated with a series.

Detailed Description

This class stores data used in a umontreal.ssj.charts.CategoryChart.

It also provides complementary tools to draw box-and-whisker plots; for example, one may add or remove plots series and modify plot style. This class is linked with the JFreeChart DefaultBoxAndWhiskerCategoryDataset class to store data plots, and linked with the JFreeChart BoxAndWhiskerRenderer to render the plots.

Definition at line 45 of file BoxSeriesCollection.java.

Constructor & Destructor Documentation

◆ BoxSeriesCollection() [1/4]

umontreal.ssj.charts.BoxSeriesCollection.BoxSeriesCollection ( )

Creates a new BoxSeriesCollection instance with an empty dataset.

Definition at line 51 of file BoxSeriesCollection.java.

◆ BoxSeriesCollection() [2/4]

umontreal.ssj.charts.BoxSeriesCollection.BoxSeriesCollection	(	double[]	data,
		int	numPoints )

Creates a new BoxSeriesCollection instance with default parameters and input series data.

Only the first numPoints of data will taken into account.

Parameters

data	point sets.
numPoints	Number of points

Definition at line 65 of file BoxSeriesCollection.java.

◆ BoxSeriesCollection() [3/4]

umontreal.ssj.charts.BoxSeriesCollection.BoxSeriesCollection ( double...[] data )

Creates a new BoxSeriesCollection instance with default parameters and given data series.

The input parameter represents series of point sets.

Parameters

data	series of point sets.

Definition at line 86 of file BoxSeriesCollection.java.

◆ BoxSeriesCollection() [4/4]

umontreal.ssj.charts.BoxSeriesCollection.BoxSeriesCollection ( DefaultBoxAndWhiskerCategoryDataset data )

Creates a new BoxSeriesCollection instance with default parameters and given data series.

The input parameter represents a DefaultBoxAndWhiskerCategoryDataset.

Parameters

data	series of point sets.

Definition at line 111 of file BoxSeriesCollection.java.

Member Function Documentation

◆ add() [1/2]

int umontreal.ssj.charts.BoxSeriesCollection.add ( double[] data )

Adds a data series into the series collection.

Vector data represents a point set.

Parameters

data	point sets.

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

Definition at line 130 of file BoxSeriesCollection.java.

◆ add() [2/2]

int umontreal.ssj.charts.BoxSeriesCollection.add	(	double[]	data,
		int	numPoints )

Adds a data series into the series collection.

Vector data represents a point set. Only the first numPoints of data will be added to 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 DefaultBoxAndWhiskerXYDataset object.

Definition at line 144 of file BoxSeriesCollection.java.

◆ getName()

String umontreal.ssj.charts.BoxSeriesCollection.getName ( int series )

Gets the current name of the selected series.

Parameters

series series index.

Returns: current name of the series.

Definition at line 162 of file BoxSeriesCollection.java.

◆ getRangeBounds()

double[] umontreal.ssj.charts.BoxSeriesCollection.getRangeBounds ( )

Returns the range ( \(y\)-coordinates) min and max values.

Returns: range min and max values.

Reimplemented from umontreal.ssj.charts.SSJCategorySeriesCollection.

Definition at line 171 of file BoxSeriesCollection.java.

◆ toLatex()

String umontreal.ssj.charts.BoxSeriesCollection.toLatex	(	double	YScale,
		double	YShift,
		double	ymin,
		double	ymax )

NOT IMPLEMENTED: To do.

Parameters

ymin
ymax

Returns: LaTeX source code

Reimplemented from umontreal.ssj.charts.SSJCategorySeriesCollection.

Definition at line 213 of file BoxSeriesCollection.java.

◆ toString()

String umontreal.ssj.charts.BoxSeriesCollection.toString ( )

Returns in a String all data contained in the current object.

Returns: All data contained in the current object as a String.

Reimplemented from umontreal.ssj.charts.SSJCategorySeriesCollection.

Definition at line 196 of file BoxSeriesCollection.java.

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

src/main/java/umontreal/ssj/charts/BoxSeriesCollection.java

SSJ API Documentation Stochastic Simulation in Java

Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ BoxSeriesCollection() [1/4]

◆ BoxSeriesCollection() [2/4]

◆ BoxSeriesCollection() [3/4]

◆ BoxSeriesCollection() [4/4]

Member Function Documentation

◆ add() [1/2]

◆ add() [2/2]

◆ getName()

◆ getRangeBounds()

◆ toLatex()

◆ toString()