This class provides tools to create charts from data in a simple way. More...
JFreeChart getJFreeChart () Returns theJFreeChart object associated with this chart. More...
true when plotting probabilities, false otherwise. More...
range = [xmin, xmax, ymin, ymax]. More...
range = [xmin, xmax, ymin, ymax]. More...
range = [xmin, xmax, ymin, ymax]. More...
margin. More...
x. More...
fileName. More...
\documentclass (and other) commands in the created LaTeX files. More...
This class provides tools to create charts from data in a simple way.
Its main feature is to produce TikZ/PGF (see WWW link http://sourceforge.net/projects/pgf/) compatible source code which can be included in LaTeX documents, but it can also produce charts in other formats. One can easily create a new chart, and customize its appearance using methods of this class, with the encapsulated umontreal.ssj.charts.SSJXYSeriesCollection object representing the data, and the two umontreal.ssj.charts.Axis objects representing the axes. All these classes depend on the JFreeChart API (see WWW link http://www.jfree.org/jfreechart/) which provides tools to build charts with Java, to draw them, and export them to files. However, only basic features are used here.
Moreover, XYChart provides methods to plot data using a MATLAB friendly syntax. None of these methods provides new features; they just propose a different syntax to create charts. Therefore some features are unavailable when using these methods only.
Draws a vertical line on the chart at \(x\)-coordinate x.
name is written near the line at \(y\) position yfrac (a fraction of the \(y\)-size of the chart, 0 is the bottom, 1 is the top); if right is true, name is written on the right of the line, else on the left.
Puts a grid on the background.
It is important to note that the grid is always shifted in such a way that it contains the axes. Thus, the grid does not always have an intersection at the corner points; this occurs only if the corner points are multiples of the steps: xstep and ystep sets the step in each direction.
Returns the chart margin, which is the fraction by which the chart is enlarged on its borders.
The default value is \(0.02\).
◆ getJFreeChart() JFreeChart getJFreeChart ( )Returns the JFreeChart object associated with this chart.
Gets the current chart title.
Returns the chart’s domain axis ( \(x\)-axis) object.
Returns the chart’s range axis ( \(y\)-axis) object.
The \(x\) and the \(y\) ranges of the chart are set automatically.
If right is true, the vertical axis will be on the left of the points, otherwise on the right. If top is true, the horizontal axis will be under the points, otherwise above the points.
The \(x\) and the \(y\) ranges of the chart are set automatically.
If xZero is true, the vertical axis will pass through the point \((0, y)\). If yZero is true, the horizontal axis will pass through the point \((x, 0)\).
Sets the chart margin to margin.
It is the fraction by which the chart is enlarged on its borders. Restriction: \(\mathtt{margin} \ge0\).
Flag to remove the \documentclass (and other) commands in the created LaTeX files.
If flag is true, then when charts are translated into LaTeX form, it will be as a self-contained file that can be directly compiled with LaTeX. However, in this form, the file cannot be included in another LaTeX file without causing compilation errors because of the multiple instructions \documentclass and \begin{document}. By setting flag to false, these instructions will be removed from the LaTeX chart files, which can then be included in a master LaTeX file. By default, the flag is true.
Sets the \(x\) and \(y\) ranges of the chart using the format: range = [xmin, xmax, ymin, ymax].
Sets the \(x\) and \(y\) ranges of the chart using the format: range = [xmin, xmax, ymin, ymax].
If right is true, the vertical axis will be on the left of the points, otherwise on the right. If top is true, the horizontal axis will be under the points, otherwise above the points.
Sets the \(x\) and \(y\) ranges of the chart using the format: range = [xmin, xmax, ymin, ymax].
If xZero is true, the vertical axis will pass through the point \((0, y)\). If yZero is true, the horizontal axis will pass through the point \((x, 0)\).
Must be set true when plotting probabilities, false otherwise.
true for plotting probabilities
Synchronizes \(x\)-axis ticks to the \(s\)-th series \(x\)-values.
Sets a title to this chart.
This title will appear on the chart displayed by method view.
Exports the chart to a LaTeX source code using PGF/TikZ.
This method constructs and returns a string that can be written to a LaTeX document to render the plot. width and height represents the width and the height of the produced chart. These dimensions do not take into account the axes and labels extra space. The width and the height of the chart are measured in centimeters.
Transforms the chart to LaTeX form and writes it in file fileName.
The chart’s width and height (in centimeters) are width and height.
The documentation for this class was generated from the following file:
RetroSearch is an open source project built by @garambo | Open a GitHub Issue
Search and Browse the WWW like it's 1997 | Search results from DuckDuckGo
HTML:
3.2
| Encoding:
UTF-8
| Version:
0.7.4