Stores data used in a XYChart. More...

Inheritance diagram for umontreal.ssj.charts.SSJXYSeriesCollection:

Public Member Functions
Data control methods @{
double	getX (int series, int index)
	Returns the \(x\)-value at the specified index in the specified series.
double	getY (int series, int index)
	Returns the \(y\)-value at the specified index in the specified series.
XYDataset	getSeriesCollection ()
	Returns the XYDataset object associated with the current object.
double[]	getDomainBounds ()
	Returns domain ( \(x\)-coordinates) min and max values.
double[]	getRangeBounds ()
	Returns range ( \(y\)-coordinates) min and max values.
String	toString ()
	Returns in a String all data contained in the current object.

Rendering methods @{
XYItemRenderer	getRenderer ()
	Returns the XYItemRenderer object associated with the current object.
void	setRenderer (XYItemRenderer renderer)
	Sets the XYItemRenderer 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\).
abstract String	toLatex (double XScale, double YScale, double XShift, double YShift, double xmin, double xmax, double ymin, double ymax)
	Formats and returns a string containing a LaTeX-compatible source code which represents this data series collection.
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

Stores data used in a XYChart.

This class provides tools to manage data sets and rendering options, and modify plot color, plot style, and marks on points for each series.

Definition at line 41 of file SSJXYSeriesCollection.java.

Member Function Documentation

◆ detectXColorClassic()

String umontreal.ssj.charts.SSJXYSeriesCollection.detectXColorClassic ( Color color )

staticprotected

Converts a java Color object into a friendly and readable LaTeX/xcolor string.

Parameters

color in color.

Returns: friendly color with string format as possible, null otherwise.

Definition at line 212 of file SSJXYSeriesCollection.java.

◆ getColor()

Color umontreal.ssj.charts.SSJXYSeriesCollection.getColor ( int series )

Gets the current plotting color of the selected series.

Returns: current plotting color.

Definition at line 172 of file SSJXYSeriesCollection.java.

◆ getDefaultColor()

Color umontreal.ssj.charts.SSJXYSeriesCollection.getDefaultColor ( int index )

staticprotected

Gives the default color associated with a series.

Parameters

index Index of the series in the XYDataset object.

Returns: default color object.

Definition at line 268 of file SSJXYSeriesCollection.java.

◆ getDomainBounds()

double[] umontreal.ssj.charts.SSJXYSeriesCollection.getDomainBounds ( )

Returns domain ( \(x\)-coordinates) min and max values.

Returns: domain min and max values.

Definition at line 85 of file SSJXYSeriesCollection.java.

◆ getRangeBounds()

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

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

Returns: range min and max values.

Definition at line 107 of file SSJXYSeriesCollection.java.

◆ getRenderer()

XYItemRenderer umontreal.ssj.charts.SSJXYSeriesCollection.getRenderer ( )

Returns the XYItemRenderer object associated with the current object.

Returns: XYItemRenderer object associated with the current variable.

Definition at line 152 of file SSJXYSeriesCollection.java.

◆ getSeriesCollection()

XYDataset umontreal.ssj.charts.SSJXYSeriesCollection.getSeriesCollection ( )

Returns the XYDataset object associated with the current object.

Returns: XYDataset object associated with the current variable.

Reimplemented in umontreal.ssj.charts.HistogramSeriesCollection.

Definition at line 76 of file SSJXYSeriesCollection.java.

◆ getX()

double umontreal.ssj.charts.SSJXYSeriesCollection.getX	(	int	series,
		int	index )

Returns the \(x\)-value at the specified index in the specified series.

Parameters

series	required series value.
index	value’s index.

Returns: \(x\)-value at the specified index in the specified series.

Definition at line 56 of file SSJXYSeriesCollection.java.

◆ getY()

double umontreal.ssj.charts.SSJXYSeriesCollection.getY	(	int	series,
		int	index )

Returns the \(y\)-value at the specified index in the specified series.

Parameters

series	required series value.
index	value’s index.

Returns: \(y\)-value at the specified index in the specified series.

Definition at line 67 of file SSJXYSeriesCollection.java.

◆ setColor()

void umontreal.ssj.charts.SSJXYSeriesCollection.setColor	(	int	series,
		Color	color )

Sets a new plotting color to the series \(series\).

Parameters

series	series index.
color	plotting color.

Definition at line 182 of file SSJXYSeriesCollection.java.

◆ setRenderer()

void umontreal.ssj.charts.SSJXYSeriesCollection.setRenderer ( XYItemRenderer renderer )

Sets the XYItemRenderer object associated with the current variable.

This object determines the chart JFreeChart look, produced by method view in class umontreal.ssj.charts.XYChart.

Parameters

renderer new XYItemRenderer object.

Definition at line 163 of file SSJXYSeriesCollection.java.

◆ toLatex()

abstract String umontreal.ssj.charts.SSJXYSeriesCollection.toLatex	(	double	XScale,
		double	YScale,
		double	XShift,
		double	YShift,
		double	xmin,
		double	xmax,
		double	ymin,
		double	ymax )

abstract

Formats and returns a string containing a LaTeX-compatible source code which represents this data series collection.

The original datasets are shifted and scaled with the XShift, YShift, XScale and YScale parameters. xmin, xmax, ymin and ymax represent the chart bounds.

Parameters

XScale	Domain original data scale.
YScale	Range original data scale.
XShift	Domain original data shift value.
YShift	Range original data shift value.
xmin	Domain min bound.
xmax	Domain nax bound.
ymin	Range min bound.
ymax	Range nax bound.

Returns: TikZ code.

Reimplemented in umontreal.ssj.charts.EmpiricalSeriesCollection, and umontreal.ssj.charts.HistogramSeriesCollection.

◆ toString()

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

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

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

Definition at line 129 of file SSJXYSeriesCollection.java.

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

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

SSJ API Documentation Stochastic Simulation in Java

Public Member Functions

Rendering methods @{

Detailed Description

Member Function Documentation

◆ detectXColorClassic()

◆ getColor()

◆ getDefaultColor()

◆ getDomainBounds()

◆ getRangeBounds()

◆ getRenderer()

◆ getSeriesCollection()

◆ getX()

◆ getY()

◆ setColor()

◆ setRenderer()

◆ toLatex()

◆ toString()