Stores data used in a CategoryChart. More...
Public Member Functions | |
Data control methods @{ | |
| 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. | |
| abstract double[] | getRangeBounds () |
| Returns range ( \(y\)-coordinates) min and max values. | |
| abstract String | toString () |
| Returns in a String all data contained in the current object. | |
Rendering methods @{ | |
| 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\). | |
| 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. | |
| 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 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.
Definition at line 41 of file SSJCategorySeriesCollection.java.
Member Function Documentation
◆ detectXColorClassic()
|
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 161 of file SSJCategorySeriesCollection.java.
◆ getCategory()
| String umontreal.ssj.charts.SSJCategorySeriesCollection.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.
Definition at line 55 of file SSJCategorySeriesCollection.java.
◆ getColor()
| Color umontreal.ssj.charts.SSJCategorySeriesCollection.getColor | ( | int | series | ) |
Gets the current plotting color of the selected series.
- Returns
- current plotting color.
Definition at line 126 of file SSJCategorySeriesCollection.java.
◆ getDefaultColor()
|
staticprotected |
Gives the default color associated with a series.
- Parameters
-
index Index of the series in the CategoryDataset object.
- Returns
- default color object.
Definition at line 217 of file SSJCategorySeriesCollection.java.
◆ getRangeBounds()
|
abstract |
Returns range ( \(y\)-coordinates) min and max values.
- Returns
- range min and max values.
Reimplemented in umontreal.ssj.charts.BoxSeriesCollection.
◆ getRenderer()
| CategoryItemRenderer umontreal.ssj.charts.SSJCategorySeriesCollection.getRenderer | ( | ) |
Returns the CategoryItemRenderer object associated with the current object.
- Returns
- CategoryItemRenderer object associated with the current variable.
Definition at line 106 of file SSJCategorySeriesCollection.java.
◆ getSeriesCollection()
| CategoryDataset umontreal.ssj.charts.SSJCategorySeriesCollection.getSeriesCollection | ( | ) |
Returns the CategoryDataset object associated with the current object.
- Returns
- CategoryDataset object associated with the current variable.
Definition at line 75 of file SSJCategorySeriesCollection.java.
◆ getValue()
| double umontreal.ssj.charts.SSJCategorySeriesCollection.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.
Definition at line 66 of file SSJCategorySeriesCollection.java.
◆ setColor()
| void umontreal.ssj.charts.SSJCategorySeriesCollection.setColor | ( | int | series, |
| Color | color ) |
Sets a new plotting color to the series \(series\).
- Parameters
-
series series index. color plotting color.
Definition at line 136 of file SSJCategorySeriesCollection.java.
◆ setRenderer()
| void umontreal.ssj.charts.SSJCategorySeriesCollection.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.
Definition at line 117 of file SSJCategorySeriesCollection.java.
◆ toLatex()
|
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.
Reimplemented in umontreal.ssj.charts.BoxSeriesCollection.
◆ toString()
|
abstract |
Returns in a String all data contained in the current object.
- Returns
- All data contained in the current object as a String.
Reimplemented in umontreal.ssj.charts.BoxSeriesCollection.
The documentation for this class was generated from the following file:
- src/main/java/umontreal/ssj/charts/SSJCategorySeriesCollection.java
