SSJCategorySeriesCollection Class Reference

Stores data used in a CategoryChart. More...

Inheritance diagram for SSJCategorySeriesCollection:

Collaboration diagram for SSJCategorySeriesCollection:

Public Member Functions
Data control methods
String	getCategory (int series)
	Returns the category-value in the specified series. More...
double	getValue (int series, int index)
	Returns the \(y\)-value at the specified index in the specified series. More...
CategoryDataset	getSeriesCollection ()
	Returns the CategoryDataset object associated with the current object. More...
abstract double []	getRangeBounds ()
	Returns range ( \(y\)-coordinates) min and max values. More...
abstract String	toString ()
	Returns in a String all data contained in the current object. More...

Protected Attributes
CategoryItemRenderer	renderer
CategoryDataset	seriesCollection

Rendering methods
CategoryItemRenderer	getRenderer ()
	Returns the CategoryItemRenderer object associated with the current object. More...
void	setRenderer (CategoryItemRenderer renderer)
	Sets the CategoryItemRenderer 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 YScale, double YShift, 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 CategoryChart.

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.

getCategory()

String getCategory

(

int

series

)

Returns the category-value in the specified series.

Parameters

series

required series value.

Returns

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

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 CategoryDataset object.

Returns

default color object.

getRangeBounds()

abstract double [] getRangeBounds ( )

abstract

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

Returns

range min and max values.

getRenderer()

CategoryItemRenderer getRenderer

(

)

Returns the CategoryItemRenderer object associated with the current object.

Returns

CategoryItemRenderer object associated with the current variable.

getSeriesCollection()

CategoryDataset getSeriesCollection

(

)

Returns the CategoryDataset object associated with the current object.

Returns

CategoryDataset object associated with the current variable.

getValue()

double getValue	(	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

(

CategoryItemRenderer

renderer

)

Sets the CategoryItemRenderer 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 CategoryItemRenderer object.

toLatex()

abstract String toLatex ( double  YScale, double  YShift, 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 YShift and YScale parameters. ymin and ymax represent the chart bounds.

Parameters

YScale	Range original data scale.
YShift	Range original data shift value.
ymin	Range min bound.
ymax	Range max bound.

Returns

Latex code.

toString()

abstract String toString ( )

abstract

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:

• SSJCategorySeriesCollection.java