SSJXYSeriesCollection Class Reference

Stores data used in a XYChart. More...

Inheritance diagram for SSJXYSeriesCollection:

Collaboration diagram for 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. More...
double	getY (int series, int index)
	Returns the \(y\)-value at the specified index in the specified series. More...
XYDataset	getSeriesCollection ()
	Returns the XYDataset object associated with the current object. More...
double []	getDomainBounds ()
	Returns domain ( \(x\)-coordinates) min and max values. More...
double []	getRangeBounds ()
	Returns range ( \(y\)-coordinates) min and max values. More...
String	toString ()
	Returns in a String all data contained in the current object. More...

Protected Attributes
XYItemRenderer	renderer
XYDataset	seriesCollection

Rendering methods
XYItemRenderer	getRenderer ()
	Returns the XYItemRenderer object associated with the current object. More...
void	setRenderer (XYItemRenderer renderer)
	Sets the XYItemRenderer object associated with the current variable. More...
Color	getColor (int series)
	Gets the current plotting color of the selected series. More...
void	setColor (int series, Color color)
	Sets a new plotting color to the series \(series\). More...
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. More...
static String	detectXColorClassic (Color color)
	Converts a java Color object into a friendly and readable LaTeX/xcolor string. More...
static Color	getDefaultColor (int index)
	Gives the default color associated with a series. More...
static double	max (double[] t)
static double	min (double[] t)

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.

Member Function Documentation

detectXColorClassic()

static String 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.

getColor()

Color getColor

(

int

series

)

Gets the current plotting color of the selected series.

Returns

current plotting color.

getDefaultColor()

static Color 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.

getDomainBounds()

double [] getDomainBounds

(

)

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

Returns

domain min and max values.

getRangeBounds()

double [] getRangeBounds

(

)

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

Returns

range min and max values.

getRenderer()

XYItemRenderer getRenderer

(

)

Returns the XYItemRenderer object associated with the current object.

Returns

XYItemRenderer object associated with the current variable.

getSeriesCollection()

XYDataset getSeriesCollection

(

)

Returns the XYDataset object associated with the current object.

Returns

XYDataset object associated with the current variable.

getX()

double 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.

getY()

double 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.

setColor()

void setColor	(	int	series,
		Color	color
	)

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

Parameters

series	series index.
color	plotting color.

setRenderer()

void 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.

toLatex()

abstract String 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.

toString()

String toString

(

)

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

Returns

All data contained in the current object as a String.

---

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

• SSJXYSeriesCollection.java