Mercurial > hg > octave-nkf
annotate doc/interpreter/plot.txi @ 8817:03b7f618ab3d
include docstrings for new functions in the manual
| author | John W. Eaton <jwe@octave.org> |
|---|---|
| date | Thu, 19 Feb 2009 15:39:19 -0500 |
| parents | 68aa5abfd136 |
| children | eb63fbe60fab |
| rev | line source |
|---|---|
| 7018 | 1 @c Copyright (C) 1996, 1997, 1999, 2000, 2002, 2003, 2004, 2005, |
| 2 @c 2006, 2007 John W. Eaton | |
| 3 @c | |
| 4 @c This file is part of Octave. | |
| 5 @c | |
| 6 @c Octave is free software; you can redistribute it and/or modify it | |
| 7 @c under the terms of the GNU General Public License as published by the | |
| 8 @c Free Software Foundation; either version 3 of the License, or (at | |
| 9 @c your option) any later version. | |
| 10 @c | |
| 11 @c Octave is distributed in the hope that it will be useful, but WITHOUT | |
| 12 @c ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or | |
| 13 @c FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License | |
| 14 @c for more details. | |
| 15 @c | |
| 16 @c You should have received a copy of the GNU General Public License | |
| 17 @c along with Octave; see the file COPYING. If not, see | |
| 18 @c <http://www.gnu.org/licenses/>. | |
| 3294 | 19 |
| 4167 | 20 @node Plotting |
| 3294 | 21 @chapter Plotting |
| 6888 | 22 @cindex plotting |
| 23 @cindex graphics | |
| 3294 | 24 |
| 25 @menu | |
| 6888 | 26 * Plotting Basics:: |
| 27 * Advanced Plotting:: | |
| 28 @end menu | |
| 29 | |
| 30 @node Plotting Basics | |
| 31 @section Plotting Basics | |
| 32 | |
| 33 Octave makes it easy to create many different types of two- and | |
| 34 three-dimensional plots using a few high-level functions. | |
| 35 | |
| 36 If you need finer control over graphics, see @ref{Advanced Plotting}. | |
| 37 | |
| 38 @menu | |
| 39 * Two-Dimensional Plots:: | |
| 3294 | 40 * Three-Dimensional Plotting:: |
| 41 * Plot Annotations:: | |
| 42 * Multiple Plots on One Page:: | |
| 3428 | 43 * Multiple Plot Windows:: |
| 6888 | 44 * Printing Plots:: |
|
7984
bbaa5d7d0143
Some documentation updates
David Bateman <dbateman@free.fr>
parents:
7981
diff
changeset
|
45 * Interacting with plots:: |
| 6888 | 46 * Test Plotting Functions:: |
| 3294 | 47 @end menu |
| 48 | |
| 6888 | 49 @node Two-Dimensional Plots |
| 50 @subsection Two-Dimensional Plots | |
| 51 | |
| 52 The @code{plot} function allows you to create simple x-y plots with | |
| 53 linear axes. For example, | |
| 3294 | 54 |
| 6888 | 55 @example |
| 56 @group | |
| 57 x = -10:0.1:10; | |
| 58 plot (x, sin (x)); | |
| 59 @end group | |
| 60 @end example | |
| 61 | |
| 62 @noindent | |
| 6899 | 63 displays a sine wave shown in @ref{fig:plot}. On most systems, this |
| 6888 | 64 command will open a separate plot window to display the graph. |
| 5134 | 65 |
| 6888 | 66 @float Figure,fig:plot |
| 67 @image{plot,8cm} | |
| 68 @caption{Simple Two-Dimensional Plot.} | |
| 69 @end float | |
| 70 | |
| 5134 | 71 @DOCSTRING(plot) |
| 72 | |
|
8817
03b7f618ab3d
include docstrings for new functions in the manual
John W. Eaton <jwe@octave.org>
parents:
8519
diff
changeset
|
73 The @code{plotyy} function may be used to create a plot with two |
|
03b7f618ab3d
include docstrings for new functions in the manual
John W. Eaton <jwe@octave.org>
parents:
8519
diff
changeset
|
74 independent y axes. |
|
03b7f618ab3d
include docstrings for new functions in the manual
John W. Eaton <jwe@octave.org>
parents:
8519
diff
changeset
|
75 |
|
03b7f618ab3d
include docstrings for new functions in the manual
John W. Eaton <jwe@octave.org>
parents:
8519
diff
changeset
|
76 @DOCSTRING(plotyy) |
|
03b7f618ab3d
include docstrings for new functions in the manual
John W. Eaton <jwe@octave.org>
parents:
8519
diff
changeset
|
77 |
| 6888 | 78 The functions @code{semilogx}, @code{semilogy}, and @code{loglog} are |
| 79 similar to the @code{plot} function, but produce plots in which one or | |
| 80 both of the axes use log scales. | |
| 81 | |
| 82 @DOCSTRING(semilogx) | |
| 6502 | 83 |
| 6888 | 84 @DOCSTRING(semilogy) |
| 6502 | 85 |
| 6888 | 86 @DOCSTRING(loglog) |
| 87 | |
| 88 The functions @code{bar}, @code{barh}, @code{stairs}, and @code{stem} | |
| 89 are useful for displaying discrete data. For example, | |
| 5134 | 90 |
| 6888 | 91 @example |
| 92 @group | |
| 93 hist (randn (10000, 1), 30); | |
| 94 @end group | |
| 95 @end example | |
| 5134 | 96 |
| 6888 | 97 @noindent |
| 98 produces the histogram of 10,000 normally distributed random numbers | |
| 6899 | 99 shown in @ref{fig:hist}. |
| 5134 | 100 |
| 6888 | 101 @float Figure,fig:hist |
| 102 @image{hist,8cm} | |
| 103 @caption{Histogram.} | |
| 104 @end float | |
| 5134 | 105 |
| 106 @DOCSTRING(bar) | |
| 107 | |
| 6877 | 108 @DOCSTRING(barh) |
| 109 | |
| 6888 | 110 @DOCSTRING(hist) |
| 111 | |
| 112 @DOCSTRING(stairs) | |
| 113 | |
| 114 @DOCSTRING(stem) | |
| 115 | |
|
8817
03b7f618ab3d
include docstrings for new functions in the manual
John W. Eaton <jwe@octave.org>
parents:
8519
diff
changeset
|
116 @DOCSTRING(stem3) |
|
03b7f618ab3d
include docstrings for new functions in the manual
John W. Eaton <jwe@octave.org>
parents:
8519
diff
changeset
|
117 |
|
03b7f618ab3d
include docstrings for new functions in the manual
John W. Eaton <jwe@octave.org>
parents:
8519
diff
changeset
|
118 @DOCSTRING(scatter) |
|
03b7f618ab3d
include docstrings for new functions in the manual
John W. Eaton <jwe@octave.org>
parents:
8519
diff
changeset
|
119 |
|
03b7f618ab3d
include docstrings for new functions in the manual
John W. Eaton <jwe@octave.org>
parents:
8519
diff
changeset
|
120 @DOCSTRING(scatter3) |
|
03b7f618ab3d
include docstrings for new functions in the manual
John W. Eaton <jwe@octave.org>
parents:
8519
diff
changeset
|
121 |
|
03b7f618ab3d
include docstrings for new functions in the manual
John W. Eaton <jwe@octave.org>
parents:
8519
diff
changeset
|
122 @DOCSTRING(plotmatrix) |
|
03b7f618ab3d
include docstrings for new functions in the manual
John W. Eaton <jwe@octave.org>
parents:
8519
diff
changeset
|
123 |
|
03b7f618ab3d
include docstrings for new functions in the manual
John W. Eaton <jwe@octave.org>
parents:
8519
diff
changeset
|
124 @DOCSTRING(pareto) |
|
03b7f618ab3d
include docstrings for new functions in the manual
John W. Eaton <jwe@octave.org>
parents:
8519
diff
changeset
|
125 |
|
03b7f618ab3d
include docstrings for new functions in the manual
John W. Eaton <jwe@octave.org>
parents:
8519
diff
changeset
|
126 @DOCSTRING(rose) |
|
03b7f618ab3d
include docstrings for new functions in the manual
John W. Eaton <jwe@octave.org>
parents:
8519
diff
changeset
|
127 |
| 7981 | 128 The @code{contour}, @code{contourf} and @code{contourc} functions |
| 129 produce two-dimensional contour plots from three dimensional data. | |
| 6888 | 130 |
| 5134 | 131 @DOCSTRING(contour) |
| 132 | |
| 7981 | 133 @DOCSTRING(contourf) |
| 134 | |
| 6502 | 135 @DOCSTRING(contourc) |
| 136 | |
|
8817
03b7f618ab3d
include docstrings for new functions in the manual
John W. Eaton <jwe@octave.org>
parents:
8519
diff
changeset
|
137 @DOCSTRING(contour3) |
|
03b7f618ab3d
include docstrings for new functions in the manual
John W. Eaton <jwe@octave.org>
parents:
8519
diff
changeset
|
138 |
| 6888 | 139 The @code{errorbar}, @code{semilogxerr}, @code{semilogyerr}, and |
|
8347
fa78cb8d8a5c
corrections for typos
Brian Gough<bjg@network-theory.co.uk>
parents:
8325
diff
changeset
|
140 @code{loglogerr} functions produce plots with error bar markers. For |
| 6888 | 141 example, |
| 6877 | 142 |
| 6888 | 143 @example |
| 144 x = 0:0.1:10; | |
| 145 y = sin (x); | |
| 146 yp = 0.1 .* randn (size (x)); | |
| 147 ym = -0.1 .* randn (size (x)); | |
| 148 errorbar (x, sin (x), ym, yp); | |
| 149 @end example | |
| 5134 | 150 |
| 6888 | 151 @noindent |
| 6899 | 152 produces the figure shown in @ref{fig:errorbar}. |
| 6502 | 153 |
| 6888 | 154 @float Figure,fig:errorbar |
| 155 @image{errorbar,8cm} | |
| 156 @caption{Errorbar plot.} | |
| 157 @end float | |
| 5134 | 158 |
| 159 @DOCSTRING(errorbar) | |
| 160 | |
| 161 @DOCSTRING(semilogxerr) | |
| 162 | |
| 163 @DOCSTRING(semilogyerr) | |
| 164 | |
| 6888 | 165 @DOCSTRING(loglogerr) |
| 166 | |
| 167 Finally, the @code{polar} function allows you to easily plot data in | |
| 7001 | 168 polar coordinates. However, the display coordinates remain rectangular |
| 6888 | 169 and linear. For example, |
| 170 | |
| 171 @example | |
| 172 polar (0:0.1:10*pi, 0:0.1:10*pi); | |
| 173 @end example | |
| 174 | |
| 175 @noindent | |
| 6899 | 176 produces the spiral plot shown in @ref{fig:polar}. |
| 6888 | 177 |
| 178 @float Figure,fig:polar | |
| 179 @image{polar,8cm} | |
| 180 @caption{Polar plot.} | |
| 181 @end float | |
| 182 | |
| 183 @DOCSTRING(polar) | |
| 184 | |
| 7120 | 185 @DOCSTRING(pie) |
| 186 | |
| 187 @DOCSTRING(quiver) | |
| 188 | |
|
8817
03b7f618ab3d
include docstrings for new functions in the manual
John W. Eaton <jwe@octave.org>
parents:
8519
diff
changeset
|
189 @DOCSTRING(quiver3) |
|
03b7f618ab3d
include docstrings for new functions in the manual
John W. Eaton <jwe@octave.org>
parents:
8519
diff
changeset
|
190 |
|
03b7f618ab3d
include docstrings for new functions in the manual
John W. Eaton <jwe@octave.org>
parents:
8519
diff
changeset
|
191 @DOCSTRING(compass) |
|
03b7f618ab3d
include docstrings for new functions in the manual
John W. Eaton <jwe@octave.org>
parents:
8519
diff
changeset
|
192 |
|
03b7f618ab3d
include docstrings for new functions in the manual
John W. Eaton <jwe@octave.org>
parents:
8519
diff
changeset
|
193 @DOCSTRING(feather) |
|
03b7f618ab3d
include docstrings for new functions in the manual
John W. Eaton <jwe@octave.org>
parents:
8519
diff
changeset
|
194 |
| 7120 | 195 @DOCSTRING(pcolor) |
| 196 | |
| 7153 | 197 @DOCSTRING(area) |
| 198 | |
|
8817
03b7f618ab3d
include docstrings for new functions in the manual
John W. Eaton <jwe@octave.org>
parents:
8519
diff
changeset
|
199 @DOCSTRING(comet) |
|
03b7f618ab3d
include docstrings for new functions in the manual
John W. Eaton <jwe@octave.org>
parents:
8519
diff
changeset
|
200 |
| 6888 | 201 The axis function may be used to change the axis limits of an existing |
|
8429
f34ab2b433e8
One word missing from int8 help string.
Francesco Potortì <pot@gnu.org>
parents:
8428
diff
changeset
|
202 plot and various other axis properties, such as the aspect ratio and the |
|
f34ab2b433e8
One word missing from int8 help string.
Francesco Potortì <pot@gnu.org>
parents:
8428
diff
changeset
|
203 appearance of tic marks. |
| 6888 | 204 |
| 205 @DOCSTRING(axis) | |
| 206 | |
| 7189 | 207 Similarly the axis limits of the colormap can be changed with the caxis |
| 208 function. | |
| 209 | |
| 210 @DOCSTRING(caxis) | |
| 211 | |
|
8817
03b7f618ab3d
include docstrings for new functions in the manual
John W. Eaton <jwe@octave.org>
parents:
8519
diff
changeset
|
212 The @code{xlim}, @code{ylim}, and @code{zlim} functions may be used to |
|
03b7f618ab3d
include docstrings for new functions in the manual
John W. Eaton <jwe@octave.org>
parents:
8519
diff
changeset
|
213 get or set individual axis limits. Each has the same form. |
|
03b7f618ab3d
include docstrings for new functions in the manual
John W. Eaton <jwe@octave.org>
parents:
8519
diff
changeset
|
214 |
|
03b7f618ab3d
include docstrings for new functions in the manual
John W. Eaton <jwe@octave.org>
parents:
8519
diff
changeset
|
215 @anchor{doc-ylim} |
|
03b7f618ab3d
include docstrings for new functions in the manual
John W. Eaton <jwe@octave.org>
parents:
8519
diff
changeset
|
216 @anchor{doc-zlim} |
|
03b7f618ab3d
include docstrings for new functions in the manual
John W. Eaton <jwe@octave.org>
parents:
8519
diff
changeset
|
217 @DOCSTRING(xlim) |
|
03b7f618ab3d
include docstrings for new functions in the manual
John W. Eaton <jwe@octave.org>
parents:
8519
diff
changeset
|
218 |
|
7989
23c248d415b5
Various doc fixes. Readd cellidx
David Bateman <dbateman@free.fr>
parents:
7984
diff
changeset
|
219 @menu |
|
23c248d415b5
Various doc fixes. Readd cellidx
David Bateman <dbateman@free.fr>
parents:
7984
diff
changeset
|
220 * Two-dimensional Function Plotting:: |
|
23c248d415b5
Various doc fixes. Readd cellidx
David Bateman <dbateman@free.fr>
parents:
7984
diff
changeset
|
221 @end menu |
|
23c248d415b5
Various doc fixes. Readd cellidx
David Bateman <dbateman@free.fr>
parents:
7984
diff
changeset
|
222 |
|
7984
bbaa5d7d0143
Some documentation updates
David Bateman <dbateman@free.fr>
parents:
7981
diff
changeset
|
223 @node Two-dimensional Function Plotting |
|
bbaa5d7d0143
Some documentation updates
David Bateman <dbateman@free.fr>
parents:
7981
diff
changeset
|
224 @subsubsection Two-dimensional Function Plotting |
|
bbaa5d7d0143
Some documentation updates
David Bateman <dbateman@free.fr>
parents:
7981
diff
changeset
|
225 |
|
bbaa5d7d0143
Some documentation updates
David Bateman <dbateman@free.fr>
parents:
7981
diff
changeset
|
226 Octave can plot a function from a function handle inline function or |
|
bbaa5d7d0143
Some documentation updates
David Bateman <dbateman@free.fr>
parents:
7981
diff
changeset
|
227 string defining the function without the user needing to explicitly |
|
bbaa5d7d0143
Some documentation updates
David Bateman <dbateman@free.fr>
parents:
7981
diff
changeset
|
228 create the data to be plotted. The function @code{fplot} also generates |
|
bbaa5d7d0143
Some documentation updates
David Bateman <dbateman@free.fr>
parents:
7981
diff
changeset
|
229 two-dimensional plots with linear axes using a function name and limits |
|
bbaa5d7d0143
Some documentation updates
David Bateman <dbateman@free.fr>
parents:
7981
diff
changeset
|
230 for the range of the x-coordinate instead of the x and y data. For |
|
bbaa5d7d0143
Some documentation updates
David Bateman <dbateman@free.fr>
parents:
7981
diff
changeset
|
231 example, |
|
bbaa5d7d0143
Some documentation updates
David Bateman <dbateman@free.fr>
parents:
7981
diff
changeset
|
232 |
|
bbaa5d7d0143
Some documentation updates
David Bateman <dbateman@free.fr>
parents:
7981
diff
changeset
|
233 @example |
|
bbaa5d7d0143
Some documentation updates
David Bateman <dbateman@free.fr>
parents:
7981
diff
changeset
|
234 @group |
|
bbaa5d7d0143
Some documentation updates
David Bateman <dbateman@free.fr>
parents:
7981
diff
changeset
|
235 fplot (@@sin, [-10, 10], 201); |
|
bbaa5d7d0143
Some documentation updates
David Bateman <dbateman@free.fr>
parents:
7981
diff
changeset
|
236 @end group |
|
bbaa5d7d0143
Some documentation updates
David Bateman <dbateman@free.fr>
parents:
7981
diff
changeset
|
237 @end example |
|
bbaa5d7d0143
Some documentation updates
David Bateman <dbateman@free.fr>
parents:
7981
diff
changeset
|
238 |
|
bbaa5d7d0143
Some documentation updates
David Bateman <dbateman@free.fr>
parents:
7981
diff
changeset
|
239 @noindent |
|
bbaa5d7d0143
Some documentation updates
David Bateman <dbateman@free.fr>
parents:
7981
diff
changeset
|
240 produces a plot that is equivalent to the one above, but also includes a |
|
bbaa5d7d0143
Some documentation updates
David Bateman <dbateman@free.fr>
parents:
7981
diff
changeset
|
241 legend displaying the name of the plotted function. |
|
bbaa5d7d0143
Some documentation updates
David Bateman <dbateman@free.fr>
parents:
7981
diff
changeset
|
242 |
|
bbaa5d7d0143
Some documentation updates
David Bateman <dbateman@free.fr>
parents:
7981
diff
changeset
|
243 @DOCSTRING(fplot) |
|
bbaa5d7d0143
Some documentation updates
David Bateman <dbateman@free.fr>
parents:
7981
diff
changeset
|
244 |
|
bbaa5d7d0143
Some documentation updates
David Bateman <dbateman@free.fr>
parents:
7981
diff
changeset
|
245 Other functions that can create two-dimensional plots directly from a |
|
8055
d51c3541be28
contrib.txi: new documentation for contributors
Jaroslav Hajek <highegg@gmail.com>
parents:
8046
diff
changeset
|
246 function include @code{ezplot}, @code{ezcontour}, @code{ezcontourf} and |
| 8046 | 247 @code{ezpolar}. |
| 248 | |
| 249 @DOCSTRING(ezplot) | |
|
7984
bbaa5d7d0143
Some documentation updates
David Bateman <dbateman@free.fr>
parents:
7981
diff
changeset
|
250 |
|
bbaa5d7d0143
Some documentation updates
David Bateman <dbateman@free.fr>
parents:
7981
diff
changeset
|
251 @DOCSTRING(ezcontour) |
|
bbaa5d7d0143
Some documentation updates
David Bateman <dbateman@free.fr>
parents:
7981
diff
changeset
|
252 |
|
bbaa5d7d0143
Some documentation updates
David Bateman <dbateman@free.fr>
parents:
7981
diff
changeset
|
253 @DOCSTRING(ezcontourf) |
|
bbaa5d7d0143
Some documentation updates
David Bateman <dbateman@free.fr>
parents:
7981
diff
changeset
|
254 |
|
bbaa5d7d0143
Some documentation updates
David Bateman <dbateman@free.fr>
parents:
7981
diff
changeset
|
255 @DOCSTRING(ezpolar) |
|
bbaa5d7d0143
Some documentation updates
David Bateman <dbateman@free.fr>
parents:
7981
diff
changeset
|
256 |
| 5134 | 257 @node Three-Dimensional Plotting |
| 6888 | 258 @subsection Three-Dimensional Plotting |
| 259 | |
| 260 The function @code{mesh} produces mesh surface plots. For example, | |
| 261 | |
| 262 @example | |
| 263 @group | |
| 264 tx = ty = linspace (-8, 8, 41)'; | |
| 265 [xx, yy] = meshgrid (tx, ty); | |
| 266 r = sqrt (xx .^ 2 + yy .^ 2) + eps; | |
| 267 tz = sin (r) ./ r; | |
| 268 mesh (tx, ty, tz); | |
| 269 @end group | |
| 270 @end example | |
| 271 | |
| 272 @noindent | |
| 6899 | 273 produces the familiar ``sombrero'' plot shown in @ref{fig:mesh}. Note |
| 6888 | 274 the use of the function @code{meshgrid} to create matrices of X and Y |
| 275 coordinates to use for plotting the Z data. The @code{ndgrid} function | |
| 276 is similar to @code{meshgrid}, but works for N-dimensional matrices. | |
| 277 | |
| 278 @float Figure,fig:mesh | |
| 279 @image{mesh,8cm} | |
| 280 @caption{Mesh plot.} | |
| 281 @end float | |
| 5134 | 282 |
| 6888 | 283 The @code{meshc} function is similar to @code{mesh}, but also produces a |
| 284 plot of contours for the surface. | |
| 285 | |
| 286 The @code{plot3} function displays arbitrary three-dimensional data, | |
| 287 without requiring it to form a surface. For example | |
| 288 | |
| 289 @example | |
| 290 @group | |
| 291 t = 0:0.1:10*pi; | |
| 292 r = linspace (0, 1, numel (t)); | |
| 293 z = linspace (0, 1, numel (t)); | |
| 294 plot3 (r.*sin(t), r.*cos(t), z); | |
| 295 @end group | |
| 296 @end example | |
| 297 | |
| 298 @noindent | |
| 6899 | 299 displays the spiral in three dimensions shown in @ref{fig:plot3}. |
| 6888 | 300 |
| 301 @float Figure,fig:plot3 | |
| 302 @image{plot3,8cm} | |
| 303 @caption{Three dimensional spiral.} | |
| 304 @end float | |
| 305 | |
| 306 Finally, the @code{view} function changes the viewpoint for | |
| 307 three-dimensional plots. | |
| 5134 | 308 |
| 309 @DOCSTRING(mesh) | |
| 310 | |
| 6788 | 311 @DOCSTRING(meshc) |
| 312 | |
|
8817
03b7f618ab3d
include docstrings for new functions in the manual
John W. Eaton <jwe@octave.org>
parents:
8519
diff
changeset
|
313 @DOCSTRING(meshz) |
|
03b7f618ab3d
include docstrings for new functions in the manual
John W. Eaton <jwe@octave.org>
parents:
8519
diff
changeset
|
314 |
| 7153 | 315 @DOCSTRING(hidden) |
| 316 | |
| 7120 | 317 @DOCSTRING(surf) |
| 318 | |
| 319 @DOCSTRING(surfc) | |
| 320 | |
|
8817
03b7f618ab3d
include docstrings for new functions in the manual
John W. Eaton <jwe@octave.org>
parents:
8519
diff
changeset
|
321 @DOCSTRING(surfl) |
|
03b7f618ab3d
include docstrings for new functions in the manual
John W. Eaton <jwe@octave.org>
parents:
8519
diff
changeset
|
322 |
|
03b7f618ab3d
include docstrings for new functions in the manual
John W. Eaton <jwe@octave.org>
parents:
8519
diff
changeset
|
323 @DOCSTRING(surfnorm) |
|
03b7f618ab3d
include docstrings for new functions in the manual
John W. Eaton <jwe@octave.org>
parents:
8519
diff
changeset
|
324 |
|
03b7f618ab3d
include docstrings for new functions in the manual
John W. Eaton <jwe@octave.org>
parents:
8519
diff
changeset
|
325 @DOCSTRING(diffuse) |
|
03b7f618ab3d
include docstrings for new functions in the manual
John W. Eaton <jwe@octave.org>
parents:
8519
diff
changeset
|
326 |
|
03b7f618ab3d
include docstrings for new functions in the manual
John W. Eaton <jwe@octave.org>
parents:
8519
diff
changeset
|
327 @DOCSTRING(specular) |
|
03b7f618ab3d
include docstrings for new functions in the manual
John W. Eaton <jwe@octave.org>
parents:
8519
diff
changeset
|
328 |
| 5134 | 329 @DOCSTRING(meshgrid) |
| 330 | |
| 6550 | 331 @DOCSTRING(ndgrid) |
| 332 | |
| 6888 | 333 @DOCSTRING(plot3) |
| 334 | |
| 6502 | 335 @DOCSTRING(view) |
| 336 | |
|
8817
03b7f618ab3d
include docstrings for new functions in the manual
John W. Eaton <jwe@octave.org>
parents:
8519
diff
changeset
|
337 @DOCSTRING(slice) |
|
03b7f618ab3d
include docstrings for new functions in the manual
John W. Eaton <jwe@octave.org>
parents:
8519
diff
changeset
|
338 |
|
03b7f618ab3d
include docstrings for new functions in the manual
John W. Eaton <jwe@octave.org>
parents:
8519
diff
changeset
|
339 @DOCSTRING(ribbon) |
|
03b7f618ab3d
include docstrings for new functions in the manual
John W. Eaton <jwe@octave.org>
parents:
8519
diff
changeset
|
340 |
| 7120 | 341 @DOCSTRING(shading) |
| 342 | |
|
7989
23c248d415b5
Various doc fixes. Readd cellidx
David Bateman <dbateman@free.fr>
parents:
7984
diff
changeset
|
343 @menu |
|
23c248d415b5
Various doc fixes. Readd cellidx
David Bateman <dbateman@free.fr>
parents:
7984
diff
changeset
|
344 * Three-dimensional Function Plotting:: |
|
8817
03b7f618ab3d
include docstrings for new functions in the manual
John W. Eaton <jwe@octave.org>
parents:
8519
diff
changeset
|
345 * Three-dimensional Geometric Shapes:: |
|
7989
23c248d415b5
Various doc fixes. Readd cellidx
David Bateman <dbateman@free.fr>
parents:
7984
diff
changeset
|
346 @end menu |
|
23c248d415b5
Various doc fixes. Readd cellidx
David Bateman <dbateman@free.fr>
parents:
7984
diff
changeset
|
347 |
|
23c248d415b5
Various doc fixes. Readd cellidx
David Bateman <dbateman@free.fr>
parents:
7984
diff
changeset
|
348 @node Three-dimensional Function Plotting |
|
23c248d415b5
Various doc fixes. Readd cellidx
David Bateman <dbateman@free.fr>
parents:
7984
diff
changeset
|
349 @subsubsection Three-dimensional Function Plotting |
|
7984
bbaa5d7d0143
Some documentation updates
David Bateman <dbateman@free.fr>
parents:
7981
diff
changeset
|
350 |
|
bbaa5d7d0143
Some documentation updates
David Bateman <dbateman@free.fr>
parents:
7981
diff
changeset
|
351 @DOCSTRING(ezplot3) |
|
bbaa5d7d0143
Some documentation updates
David Bateman <dbateman@free.fr>
parents:
7981
diff
changeset
|
352 |
|
bbaa5d7d0143
Some documentation updates
David Bateman <dbateman@free.fr>
parents:
7981
diff
changeset
|
353 @DOCSTRING(ezmesh) |
|
bbaa5d7d0143
Some documentation updates
David Bateman <dbateman@free.fr>
parents:
7981
diff
changeset
|
354 |
|
bbaa5d7d0143
Some documentation updates
David Bateman <dbateman@free.fr>
parents:
7981
diff
changeset
|
355 @DOCSTRING(ezmeshc) |
|
bbaa5d7d0143
Some documentation updates
David Bateman <dbateman@free.fr>
parents:
7981
diff
changeset
|
356 |
|
bbaa5d7d0143
Some documentation updates
David Bateman <dbateman@free.fr>
parents:
7981
diff
changeset
|
357 @DOCSTRING(ezsurf) |
|
bbaa5d7d0143
Some documentation updates
David Bateman <dbateman@free.fr>
parents:
7981
diff
changeset
|
358 |
|
bbaa5d7d0143
Some documentation updates
David Bateman <dbateman@free.fr>
parents:
7981
diff
changeset
|
359 @DOCSTRING(ezsurfc) |
|
bbaa5d7d0143
Some documentation updates
David Bateman <dbateman@free.fr>
parents:
7981
diff
changeset
|
360 |
|
8817
03b7f618ab3d
include docstrings for new functions in the manual
John W. Eaton <jwe@octave.org>
parents:
8519
diff
changeset
|
361 @node Three-dimensional Geometric Shapes |
|
03b7f618ab3d
include docstrings for new functions in the manual
John W. Eaton <jwe@octave.org>
parents:
8519
diff
changeset
|
362 @subsubsection Three-dimensional Geometric Shapes |
|
03b7f618ab3d
include docstrings for new functions in the manual
John W. Eaton <jwe@octave.org>
parents:
8519
diff
changeset
|
363 |
|
03b7f618ab3d
include docstrings for new functions in the manual
John W. Eaton <jwe@octave.org>
parents:
8519
diff
changeset
|
364 @DOCSTRING(cylinder) |
|
03b7f618ab3d
include docstrings for new functions in the manual
John W. Eaton <jwe@octave.org>
parents:
8519
diff
changeset
|
365 |
|
03b7f618ab3d
include docstrings for new functions in the manual
John W. Eaton <jwe@octave.org>
parents:
8519
diff
changeset
|
366 @DOCSTRING(sphere) |
|
03b7f618ab3d
include docstrings for new functions in the manual
John W. Eaton <jwe@octave.org>
parents:
8519
diff
changeset
|
367 |
|
03b7f618ab3d
include docstrings for new functions in the manual
John W. Eaton <jwe@octave.org>
parents:
8519
diff
changeset
|
368 @DOCSTRING(ellipsoid) |
|
03b7f618ab3d
include docstrings for new functions in the manual
John W. Eaton <jwe@octave.org>
parents:
8519
diff
changeset
|
369 |
| 6888 | 370 @node Plot Annotations |
| 371 @subsection Plot Annotations | |
| 6502 | 372 |
| 6888 | 373 You can add titles, axis labels, legends, and arbitrary text to an |
| 374 existing plot. For example, | |
| 6877 | 375 |
| 6888 | 376 @example |
| 377 @group | |
| 378 x = -10:0.1:10; | |
| 379 plot (x, sin (x)); | |
| 380 title ("sin(x) for x = -10:0.1:10"); | |
| 381 xlabel ("x"); | |
| 382 ylabel ("sin (x)"); | |
| 383 text (pi, 0.7, "arbitrary text"); | |
| 384 legend ("sin (x)"); | |
| 385 @end group | |
| 386 @end example | |
| 6502 | 387 |
| 6888 | 388 The functions @code{grid} and @code{box} may also be used to add grid |
| 389 and border lines to the plot. By default, the grid is off and the | |
| 390 border lines are on. | |
| 5134 | 391 |
| 392 @DOCSTRING(title) | |
| 393 | |
| 6502 | 394 @DOCSTRING(legend) |
| 395 | |
| 396 @DOCSTRING(text) | |
| 397 | |
|
8428
ee1bc8aa226b
Add cross reference from Plot Annotations to Text Properties.
Francesco Potortì <pot@gnu.org>
parents:
8347
diff
changeset
|
398 See @ref{Text Properties} for the properties that you can set. |
|
ee1bc8aa226b
Add cross reference from Plot Annotations to Text Properties.
Francesco Potortì <pot@gnu.org>
parents:
8347
diff
changeset
|
399 |
|
8286
6f2d95255911
fix @seealso references to point to existing anchors
Thorsten Meyer <thorsten.meyier@gmx.de>
parents:
8261
diff
changeset
|
400 @anchor{doc-ylabel} |
|
6f2d95255911
fix @seealso references to point to existing anchors
Thorsten Meyer <thorsten.meyier@gmx.de>
parents:
8261
diff
changeset
|
401 @anchor{doc-zlabel} |
| 5134 | 402 @DOCSTRING(xlabel) |
| 403 | |
|
8817
03b7f618ab3d
include docstrings for new functions in the manual
John W. Eaton <jwe@octave.org>
parents:
8519
diff
changeset
|
404 @DOCSTRING(clabel) |
|
03b7f618ab3d
include docstrings for new functions in the manual
John W. Eaton <jwe@octave.org>
parents:
8519
diff
changeset
|
405 |
| 6502 | 406 @DOCSTRING(box) |
| 407 | |
| 408 @DOCSTRING(grid) | |
| 409 | |
|
8089
0ec09255515a
add colorbar docstring to the manual
John W. Eaton <jwe@octave.org>
parents:
8073
diff
changeset
|
410 @DOCSTRING(colorbar) |
|
0ec09255515a
add colorbar docstring to the manual
John W. Eaton <jwe@octave.org>
parents:
8073
diff
changeset
|
411 |
| 5134 | 412 @node Multiple Plots on One Page |
| 6888 | 413 @subsection Multiple Plots on One Page |
| 414 | |
| 415 Octave can display more than one plot in a single figure. The simplest | |
| 416 way to do this is to use the @code{subplot} function to divide the plot | |
| 417 area into a series of subplot windows that are indexed by an integer. | |
| 418 For example, | |
| 419 | |
| 420 @example | |
| 421 @group | |
| 422 subplot (2, 1, 1) | |
| 423 fplot (@@sin, [-10, 10]); | |
| 424 subplot (2, 1, 2) | |
| 425 fplot (@@cos, [-10, 10]); | |
| 426 @end group | |
| 427 @end example | |
| 428 | |
| 429 @noindent | |
| 430 creates a figure with two separate axes, one displaying a sine wave and | |
| 431 the other a cosine wave. The first call to subplot divides the figure | |
| 432 into two plotting areas (two rows and one column) and makes the first plot | |
| 433 area active. The grid of plot areas created by @code{subplot} is | |
| 434 numbered in column-major order (top to bottom, left to right). | |
| 5134 | 435 |
| 436 @DOCSTRING(subplot) | |
| 437 | |
| 438 @node Multiple Plot Windows | |
| 6888 | 439 @subsection Multiple Plot Windows |
| 440 | |
| 441 You can open multiple plot windows using the @code{figure} function. | |
| 442 For example | |
| 443 | |
| 444 @example | |
| 445 figure (1); | |
| 446 fplot (@@sin, [-10, 10]); | |
| 447 figure (2); | |
| 448 fplot (@@cos, [-10, 10]); | |
| 449 @end example | |
| 450 | |
| 451 @noindent | |
| 452 creates two figures, with the first displaying a sine wave and | |
| 453 the second a cosine wave. Figure numbers must be positive integers. | |
| 5134 | 454 |
| 455 @DOCSTRING(figure) | |
| 456 | |
| 6502 | 457 @node Printing Plots |
| 6888 | 458 @subsection Printing Plots |
| 459 | |
| 460 The @code{print} command allows you to save plots in a variety of | |
| 461 formats. For example, | |
| 462 | |
| 463 @example | |
| 464 print -deps foo.eps | |
| 465 @end example | |
| 466 | |
| 467 @noindent | |
| 468 writes the current figure to an encapsulated PostScript file called | |
| 469 @file{foo.eps}. | |
| 6502 | 470 |
| 471 @DOCSTRING(print) | |
| 472 | |
| 473 @DOCSTRING(orient) | |
| 5134 | 474 |
|
7984
bbaa5d7d0143
Some documentation updates
David Bateman <dbateman@free.fr>
parents:
7981
diff
changeset
|
475 @node Interacting with plots |
|
bbaa5d7d0143
Some documentation updates
David Bateman <dbateman@free.fr>
parents:
7981
diff
changeset
|
476 @subsection Interacting with plots |
|
bbaa5d7d0143
Some documentation updates
David Bateman <dbateman@free.fr>
parents:
7981
diff
changeset
|
477 |
|
bbaa5d7d0143
Some documentation updates
David Bateman <dbateman@free.fr>
parents:
7981
diff
changeset
|
478 The user can select points on a plot with the @code{ginput} function or |
|
bbaa5d7d0143
Some documentation updates
David Bateman <dbateman@free.fr>
parents:
7981
diff
changeset
|
479 selction the position at which to place text on the plot with the |
|
bbaa5d7d0143
Some documentation updates
David Bateman <dbateman@free.fr>
parents:
7981
diff
changeset
|
480 @code{gtext} function using the mouse. |
|
bbaa5d7d0143
Some documentation updates
David Bateman <dbateman@free.fr>
parents:
7981
diff
changeset
|
481 |
|
bbaa5d7d0143
Some documentation updates
David Bateman <dbateman@free.fr>
parents:
7981
diff
changeset
|
482 @DOCSTRING(ginput) |
|
bbaa5d7d0143
Some documentation updates
David Bateman <dbateman@free.fr>
parents:
7981
diff
changeset
|
483 |
|
bbaa5d7d0143
Some documentation updates
David Bateman <dbateman@free.fr>
parents:
7981
diff
changeset
|
484 @DOCSTRING(waitforbuttonpress) |
|
bbaa5d7d0143
Some documentation updates
David Bateman <dbateman@free.fr>
parents:
7981
diff
changeset
|
485 |
|
bbaa5d7d0143
Some documentation updates
David Bateman <dbateman@free.fr>
parents:
7981
diff
changeset
|
486 @DOCSTRING(gtext) |
|
bbaa5d7d0143
Some documentation updates
David Bateman <dbateman@free.fr>
parents:
7981
diff
changeset
|
487 |
| 6788 | 488 @node Test Plotting Functions |
| 6888 | 489 @subsection Test Plotting Functions |
| 490 | |
| 491 The functions @code{sombrero} and @code{peaks} provide a way to check | |
| 492 that plotting is working. Typing either @code{sombrero} or @code{peaks} | |
| 493 at the Octave prompt should display a three dimensional plot. | |
| 6788 | 494 |
| 6877 | 495 @DOCSTRING(sombrero) |
| 496 | |
| 6788 | 497 @DOCSTRING(peaks) |
| 498 | |
| 6888 | 499 @node Advanced Plotting |
| 500 @section Advanced Plotting | |
| 501 | |
| 502 @menu | |
| 503 * Graphics Objects:: | |
| 504 * Graphics Object Properties:: | |
| 6891 | 505 * Managing Default Properties:: |
| 6889 | 506 * Colors:: |
| 507 * Line Styles:: | |
| 508 * Marker Styles:: | |
|
8056
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
509 * Callbacks:: |
|
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
510 * Object Groups:: |
|
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
511 * Graphics backends:: |
| 6888 | 512 @end menu |
| 513 | |
| 514 @node Graphics Objects | |
| 515 @subsection Graphics Objects | |
| 516 | |
| 517 Plots in Octave are constructed from the following @dfn{graphics | |
| 518 objects}. Each graphics object has a set of properties that define its | |
| 519 appearance and may also contain links to other graphics objects. | |
| 520 Graphics objects are only referenced by a numeric index, or @dfn{handle}. | |
| 521 | |
| 522 @table @asis | |
| 523 @item root figure | |
| 8071 | 524 @cindex root figure graphics object |
| 525 @cindex graphics object, root figure | |
| 6888 | 526 The parent of all figure objects. The index for the root figure is |
| 527 defined to be 0. | |
| 528 | |
| 529 @item figure | |
| 8071 | 530 @cindex figure graphics object |
| 531 @cindex graphics object, figure | |
| 6888 | 532 A figure window. |
| 533 | |
| 534 @item axes | |
| 8071 | 535 @cindex axes graphics object |
| 536 @cindex graphics object, axes | |
| 6888 | 537 An set of axes. This object is a child of a figure object and may be a |
| 538 parent of line, text, image, patch, or surface objects. | |
| 539 | |
| 540 @item line | |
| 8071 | 541 @cindex line graphics object |
| 542 @cindex graphics object, line | |
| 6888 | 543 A line in two or three dimensions. |
| 544 | |
| 545 @item text | |
| 8071 | 546 @cindex text graphics object |
| 547 @cindex graphics object, text | |
| 6888 | 548 Text annotations. |
| 549 | |
| 550 @item image | |
| 8071 | 551 @cindex image graphics object |
| 552 @cindex graphics object, image | |
| 6888 | 553 A bitmap image. |
| 554 | |
| 555 @item patch | |
| 8071 | 556 @cindex patch graphics object |
| 557 @cindex graphics object, patch | |
| 6888 | 558 A filled polygon, currently limited to two dimensions. |
| 559 | |
| 560 @item surface | |
| 8071 | 561 @cindex surface graphics object |
| 562 @cindex graphics object, surface | |
| 6888 | 563 A three-dimensional surface. |
| 564 @end table | |
| 565 | |
| 566 To determine whether an object is a graphics object index or a figure | |
| 567 index, use the functions @code{ishandle} and @code{isfigure}. | |
| 568 | |
| 569 @DOCSTRING(ishandle) | |
| 570 | |
|
8817
03b7f618ab3d
include docstrings for new functions in the manual
John W. Eaton <jwe@octave.org>
parents:
8519
diff
changeset
|
571 @DOCSTRING(ishghandle) |
|
03b7f618ab3d
include docstrings for new functions in the manual
John W. Eaton <jwe@octave.org>
parents:
8519
diff
changeset
|
572 |
| 6888 | 573 @DOCSTRING(isfigure) |
| 574 | |
| 575 The function @code{gcf} returns an index to the current figure object, | |
| 576 or creates one if none exists. Similarly, @code{gca} returns the | |
| 577 current axes object, or creates one (and its parent figure object) if | |
| 578 none exists. | |
| 579 | |
| 580 @DOCSTRING(gcf) | |
| 581 | |
| 582 @DOCSTRING(gca) | |
| 583 | |
| 584 The @code{get} and @code{set} functions may be used to examine and set | |
| 585 properties for graphics objects. For example, | |
| 586 | |
| 587 @example | |
| 588 @group | |
| 589 get (0) | |
| 590 @result{} ans = | |
| 591 @{ | |
| 592 type = root figure | |
| 593 currentfigure = [](0x0) | |
| 594 children = [](0x0) | |
| 595 visible = on | |
| 596 @} | |
| 597 @end group | |
| 598 @end example | |
| 599 | |
| 600 @noindent | |
| 601 returns a structure containing all the properties of the root figure. | |
| 602 As with all functions in Octave, the structure is returned by value, so | |
| 603 modifying it will not modify the internal root figure plot object. To | |
| 604 do that, you must use the @code{set} function. Also, note that in this | |
| 605 case, the @code{currentfigure} property is empty, which indicates that | |
| 606 there is no current figure window. | |
| 607 | |
| 608 The @code{get} function may also be used to find the value of a single | |
| 609 property. For example, | |
| 610 | |
| 611 @example | |
| 612 @group | |
| 613 get (gca (), "xlim") | |
| 614 @result{} [ 0 1 ] | |
| 615 @end group | |
| 616 @end example | |
| 617 | |
| 618 @noindent | |
| 619 returns the range of the x-axis for the current axes object in the | |
| 620 current figure. | |
| 621 | |
| 622 To set graphics object properties, use the set function. For example, | |
| 623 | |
| 624 @example | |
| 625 set (gca (), "xlim", [-10, 10]); | |
| 626 @end example | |
| 627 | |
| 628 @noindent | |
| 629 sets the range of the x-axis for the current axes object in the current | |
| 630 figure to @samp{[-10, 10]}. Additionally, calling set with a graphics | |
| 631 object index as the only argument returns a structure containing the | |
| 632 default values for all the properties for the given object type. For | |
| 633 example, | |
| 634 | |
| 635 @example | |
| 636 set (gca ()) | |
| 637 @end example | |
| 638 | |
| 639 @noindent | |
| 640 returns a structure containing the default property values for axes | |
| 641 objects. | |
| 642 | |
| 643 @DOCSTRING(get) | |
| 644 | |
| 645 @DOCSTRING(set) | |
| 646 | |
| 647 @DOCSTRING(ancestor) | |
| 648 | |
|
7984
bbaa5d7d0143
Some documentation updates
David Bateman <dbateman@free.fr>
parents:
7981
diff
changeset
|
649 @DOCSTRING(allchild) |
|
bbaa5d7d0143
Some documentation updates
David Bateman <dbateman@free.fr>
parents:
7981
diff
changeset
|
650 |
| 6888 | 651 You can create axes, line, and patch objects directly using the |
| 652 @code{axes}, @code{line}, and @code{patch} functions. These objects | |
| 653 become children of the current axes object. | |
| 654 | |
| 655 @DOCSTRING(axes) | |
| 656 | |
| 657 @DOCSTRING(line) | |
| 658 | |
| 659 @DOCSTRING(patch) | |
| 660 | |
|
8817
03b7f618ab3d
include docstrings for new functions in the manual
John W. Eaton <jwe@octave.org>
parents:
8519
diff
changeset
|
661 @DOCSTRING(fill) |
|
03b7f618ab3d
include docstrings for new functions in the manual
John W. Eaton <jwe@octave.org>
parents:
8519
diff
changeset
|
662 |
| 7120 | 663 @DOCSTRING(surface) |
| 664 | |
| 6888 | 665 By default, Octave refreshes the plot window when a prompt is printed, |
| 666 or when waiting for input. To force an update at other times, call the | |
| 667 @code{drawnow} function. | |
| 668 | |
| 669 @DOCSTRING(drawnow) | |
| 670 | |
|
8070
3b53b25e2550
Add data sources and line series
David Bateman <dbateman@free.fr>
parents:
8057
diff
changeset
|
671 Only figures that are modified will be updated. The @code{refresh} |
|
3b53b25e2550
Add data sources and line series
David Bateman <dbateman@free.fr>
parents:
8057
diff
changeset
|
672 function can also be to force an update of the current figure, even if |
|
3b53b25e2550
Add data sources and line series
David Bateman <dbateman@free.fr>
parents:
8057
diff
changeset
|
673 it is nor modified. |
|
3b53b25e2550
Add data sources and line series
David Bateman <dbateman@free.fr>
parents:
8057
diff
changeset
|
674 |
|
3b53b25e2550
Add data sources and line series
David Bateman <dbateman@free.fr>
parents:
8057
diff
changeset
|
675 @DOCSTRING(refresh) |
|
3b53b25e2550
Add data sources and line series
David Bateman <dbateman@free.fr>
parents:
8057
diff
changeset
|
676 |
| 6888 | 677 Normally, high-level plot functions like @code{plot} or @code{mesh} call |
| 678 @code{newplot} to initialize the state of the current axes so that the | |
| 679 next plot is drawn in a blank window with default property settings. To | |
| 680 have two plots superimposed over one another, call the @code{hold} | |
| 681 function. For example, | |
| 682 | |
| 683 @example | |
| 684 @group | |
| 685 hold ("on"); | |
| 686 x = -10:0.1:10; | |
| 687 plot (x, sin (x)); | |
| 688 plot (x, cos (x)); | |
| 689 hold ("off"); | |
| 690 @end group | |
| 691 @end example | |
| 692 | |
| 693 @noindent | |
| 694 displays sine and cosine waves on the same axes. If the hold state is | |
| 695 off, consecutive plotting commands like this will only display the last | |
| 696 plot. | |
| 697 | |
| 698 @DOCSTRING(newplot) | |
| 699 | |
| 700 @DOCSTRING(hold) | |
| 701 | |
| 702 @DOCSTRING(ishold) | |
| 703 | |
|
8286
6f2d95255911
fix @seealso references to point to existing anchors
Thorsten Meyer <thorsten.meyier@gmx.de>
parents:
8261
diff
changeset
|
704 To clear the current figure, call the @code{clf} function. To clear the |
|
6f2d95255911
fix @seealso references to point to existing anchors
Thorsten Meyer <thorsten.meyier@gmx.de>
parents:
8261
diff
changeset
|
705 current axis, call the @code{cla} function. To bring the current fingure |
| 6888 | 706 to the top of the window stack, call the @code{shg} function. To delete |
| 707 a graphics object, call @code{delete} on its index. To close the | |
| 708 figure window, call the @code{close} function. | |
| 709 | |
| 710 @DOCSTRING(clf) | |
| 711 | |
|
8286
6f2d95255911
fix @seealso references to point to existing anchors
Thorsten Meyer <thorsten.meyier@gmx.de>
parents:
8261
diff
changeset
|
712 @DOCSTRING(cla) |
|
6f2d95255911
fix @seealso references to point to existing anchors
Thorsten Meyer <thorsten.meyier@gmx.de>
parents:
8261
diff
changeset
|
713 |
| 6888 | 714 @DOCSTRING(shg) |
| 715 | |
| 716 @DOCSTRING(delete) | |
| 717 | |
| 718 @DOCSTRING(close) | |
| 719 | |
| 720 @DOCSTRING(closereq) | |
| 721 | |
| 722 @node Graphics Object Properties | |
| 723 @subsection Graphics Object Properties | |
| 724 @cindex graphics object properties | |
| 725 | |
| 726 @menu | |
| 727 * Root Figure Properties:: | |
| 6889 | 728 * Figure Properties:: |
| 6888 | 729 * Axes Properties:: |
| 730 * Line Properties:: | |
| 731 * Text Properties:: | |
| 732 * Image Properties:: | |
| 733 * Patch Properties:: | |
| 734 * Surface Properties:: | |
|
8070
3b53b25e2550
Add data sources and line series
David Bateman <dbateman@free.fr>
parents:
8057
diff
changeset
|
735 * Searching Properties:: |
| 6888 | 736 @end menu |
| 737 | |
| 738 @node Root Figure Properties | |
| 739 @subsubsection Root Figure Properties | |
| 740 | |
| 741 @table @code | |
| 742 @item currentfigure | |
| 6889 | 743 Index to graphics object for the current figure. |
| 744 | |
| 745 @c FIXME -- does this work? | |
| 746 @c @item visible | |
| 747 @c Either @code{"on"} or @code{"off"} to toggle display of figures. | |
| 6888 | 748 @end table |
| 749 | |
| 6889 | 750 @node Figure Properties |
| 751 @subsubsection Figure Properties | |
| 8071 | 752 @cindex figure properties |
| 6888 | 753 |
| 754 @table @code | |
| 755 @item nextplot | |
| 6889 | 756 May be one of |
| 757 @table @code | |
| 758 @item "new" | |
| 759 @item "add" | |
| 760 @item "replace" | |
| 761 @item "replacechildren" | |
| 762 @end table | |
| 763 | |
| 6888 | 764 @item closerequestfcn |
| 6889 | 765 Handle of function to call when a figure is closed. |
| 766 | |
| 6888 | 767 @item currentaxes |
| 6889 | 768 Index to graphics object of current axes. |
| 769 | |
| 6888 | 770 @item colormap |
| 6889 | 771 An N-by-3 matrix containing the color map for the current axes. |
| 772 | |
| 6888 | 773 @item visible |
| 6889 | 774 Either @code{"on"} or @code{"off"} to toggle display of the figure. |
| 775 | |
| 6888 | 776 @item paperorientation |
| 6889 | 777 Indicates the orientation for printing. Either @code{"landscape"} or |
| 778 @code{"portrait"}. | |
| 6888 | 779 @end table |
| 780 | |
| 781 @node Axes Properties | |
| 782 @subsubsection Axes Properties | |
| 8071 | 783 @cindex axes properties |
| 6888 | 784 |
| 785 @table @code | |
| 786 @item position | |
| 8071 | 787 A vector specifying the position of the plot, excluding titles, axes and |
| 788 legend. The four elements of the vector are the coordinates of the | |
| 789 lower left corner and width and height of the plot, in units normalized | |
| 790 to the width and height of the plot window. For example, @code{[0.2, | |
| 791 0.3, 0.4, 0.5]} sets the lower left corner of the axes at @math{(0.2, | |
| 792 0.3)} and the width and height to be 0.4 and 0.5 respectively. See also | |
| 793 the @code{outerposition} property. | |
| 6889 | 794 |
| 6888 | 795 @item title |
| 6889 | 796 Index of text object for the axes title. |
| 797 | |
| 6888 | 798 @item box |
| 6889 | 799 Either @code{"on"} or @code{"off"} to toggle display of the box around |
| 800 the axes. | |
| 801 | |
| 6888 | 802 @item key |
| 6889 | 803 Either @code{"on"} or @code{"off"} to toggle display of the legend. |
| 804 Note that this property is not compatible with @sc{Matlab} and may be | |
| 805 removed in a future version of Octave. | |
| 806 | |
| 6888 | 807 @item keybox |
| 6889 | 808 Either @code{"on"} or @code{"off"} to toggle display of a box around the |
| 809 legend. Note that this property is not compatible with @sc{Matlab} and | |
| 810 may be removed in a future version of Octave. | |
| 811 | |
| 6888 | 812 @item keypos |
| 6889 | 813 An integer from 1 to 4 specifying the position of the legend. 1 |
| 814 indicates upper right corner, 2 indicates upper left, 3 indicates lower | |
| 815 left, and 4 indicates lower right. Note that this property is not | |
| 816 compatible with @sc{Matlab} and may be removed in a future version of | |
| 817 Octave. | |
| 818 | |
| 6888 | 819 @item dataaspectratio |
| 6889 | 820 A two-element vector specifying the relative height and width of the |
| 821 data displayed in the axes. Setting @code{dataaspectratio} to @samp{1, | |
| 822 2]} causes the length of one unit as displayed on the y axis to be the | |
| 823 same as the length of 2 units on the x axis. Setting | |
| 824 @code{dataaspectratio} also forces the @code{dataaspectratiomode} | |
| 825 property to be set to @code{"manual"}. | |
| 826 | |
| 6888 | 827 @item dataaspectratiomode |
| 6889 | 828 Either @code{"manual"} or @code{"auto"}. |
| 829 | |
| 6888 | 830 @item xlim |
| 831 @itemx ylim | |
| 832 @itemx zlim | |
| 833 @itemx clim | |
| 6889 | 834 Two-element vectors defining the limits for the x, y, and z axes and the |
| 835 Setting one of these properties also forces the corresponding mode | |
| 836 property to be set to @code{"manual"}. | |
| 837 | |
| 6888 | 838 @item xlimmode |
| 839 @itemx ylimmode | |
| 840 @itemx zlimmode | |
| 841 @itemx climmode | |
| 6889 | 842 Either @code{"manual"} or @code{"auto"}. |
| 843 | |
| 6888 | 844 @item xlabel |
| 845 @itemx ylabel | |
| 846 @itemx zlabel | |
| 6889 | 847 Indices to text objects for the axes labels. |
| 848 | |
| 6888 | 849 @item xgrid |
| 850 @itemx ygrid | |
| 851 @itemx zgrid | |
| 6889 | 852 Either @code{"on"} or @code{"off"} to toggle display of grid lines. |
| 853 | |
| 6888 | 854 @item xminorgrid |
| 855 @itemx yminorgrid | |
| 856 @itemx zminorgrid | |
| 6889 | 857 Either @code{"on"} or @code{"off"} to toggle display of minor grid lines. |
| 858 | |
| 6888 | 859 @item xtick |
| 860 @itemx ytick | |
| 861 @itemx ztick | |
| 6889 | 862 Setting one of these properties also forces the corresponding mode |
| 863 property to be set to @code{"manual"}. | |
| 864 | |
| 6888 | 865 @item xtickmode |
| 866 @itemx ytickmode | |
| 867 @itemx ztickmode | |
| 6889 | 868 Either @code{"manual"} or @code{"auto"}. |
| 869 | |
| 6888 | 870 @item xticklabel |
| 871 @itemx yticklabel | |
| 872 @itemx zticklabel | |
| 6889 | 873 Setting one of these properties also forces the corresponding mode |
| 874 property to be set to @code{"manual"}. | |
| 875 | |
| 6888 | 876 @item xticklabelmode |
| 877 @itemx yticklabelmode | |
| 878 @itemx zticklabelmode | |
| 6889 | 879 Either @code{"manual"} or @code{"auto"}. |
| 880 | |
| 6888 | 881 @item xscale |
| 882 @itemx yscale | |
| 883 @itemx zscale | |
| 6889 | 884 Either @code{"linear"} or @code{"log"}. |
| 885 | |
| 6888 | 886 @item xdir |
| 887 @itemx ydir | |
| 888 @itemx zdir | |
| 6889 | 889 Either @code{"forward"} or @code{"reverse"}. |
| 890 | |
| 6888 | 891 @item xaxislocation |
| 892 @itemx yaxislocation | |
| 6889 | 893 Either @code{"top"} or @code{"bottom"} for the x axis and @code{"left"} |
| 894 or @code{"right"} for the y axis. | |
| 895 | |
| 6888 | 896 @item view |
| 6889 | 897 A three element vector specifying the view point for three-dimensional plots. |
| 898 | |
| 6888 | 899 @item visible |
| 6889 | 900 Either @code{"on"} or @code{"off"} to toggle display of the axes. |
| 901 | |
| 6888 | 902 @item nextplot |
| 6889 | 903 May be one of |
| 904 @table @code | |
| 905 @item "new" | |
| 906 @item "add" | |
| 907 @item "replace" | |
| 908 @item "replacechildren" | |
| 909 @end table | |
| 910 | |
| 6888 | 911 @item outerposition |
| 8071 | 912 A vector specifying the position of the plot, including titles, axes and |
| 913 legend. The four elements of the vector are the coordinates of the | |
| 914 lower left corner and width and height of the plot, in units normalized | |
| 915 to the width and height of the plot window. For example, @code{[0.2, | |
| 916 0.3, 0.4, 0.5]} sets the lower left corner of the axes at @math{(0.2, | |
| 917 0.3)} and the width and height to be 0.4 and 0.5 respectively. See also | |
| 918 the @code{position} property. | |
| 6888 | 919 @end table |
| 920 | |
| 921 @node Line Properties | |
| 922 @subsubsection Line Properties | |
| 8071 | 923 @cindex line properties |
| 6888 | 924 |
| 925 @table @code | |
| 926 @itemx xdata | |
| 927 @itemx ydata | |
| 928 @itemx zdata | |
| 929 @itemx ldata | |
| 930 @itemx udata | |
| 931 @itemx xldata | |
| 932 @itemx xudata | |
| 6889 | 933 The data to be plotted. The @code{ldata} and @code{udata} elements are |
|
8325
b93ac0586e4b
spelling corrections
Brian Gough<bjg@network-theory.co.uk>
parents:
8297
diff
changeset
|
934 for errorbars in the y direction, and the @code{xldata} and @code{xudata} |
| 6889 | 935 elements are for errorbars in the x direction. |
| 936 | |
| 6888 | 937 @item color |
| 6889 | 938 The RGB color of the line, or a color name. @xref{Colors}. |
| 939 | |
| 6888 | 940 @item linestyle |
| 6889 | 941 @itemx linewidth |
| 942 @xref{Line Styles}. | |
| 943 | |
| 6888 | 944 @item marker |
| 945 @item markeredgecolor | |
| 946 @item markerfacecolor | |
| 947 @item markersize | |
| 6889 | 948 @xref{Marker Styles}. |
| 949 | |
| 6888 | 950 @item keylabel |
| 6889 | 951 The text of the legend entry corresponding to this line. Note that this |
| 952 property is not compatible with @sc{Matlab} and may be removed in a | |
| 953 future version of Octave. | |
| 6888 | 954 @end table |
| 955 | |
| 956 @node Text Properties | |
| 957 @subsubsection Text Properties | |
| 8071 | 958 @cindex text properties |
| 6888 | 959 |
| 960 @table @code | |
| 961 @item string | |
| 6889 | 962 The character string contained by the text object. |
| 963 | |
| 6888 | 964 @item units |
| 6889 | 965 May be @code{"normalized"} or @code{"graph"}. |
| 966 | |
| 6888 | 967 @item position |
| 6889 | 968 The coordinates of the text object. |
| 969 | |
| 6888 | 970 @item rotation |
| 6889 | 971 The angle of rotation for the displayed text, measured in degrees. |
| 972 | |
| 6888 | 973 @item horizontalalignment |
| 6889 | 974 May be @code{"left"}, @code{"center"}, or @code{"right"}. |
| 975 | |
| 6888 | 976 @item color |
| 6889 | 977 The color of the text. @xref{Colors}. |
| 7189 | 978 |
| 979 @item fontname | |
| 980 The font used for the text. | |
| 981 | |
| 982 @item fontsize | |
| 983 The size of the font, in points to use. | |
| 984 | |
| 985 @item fontangle | |
| 986 Flag whether the font is italic or normal. Valid values are 'normal', | |
| 987 'italic' and 'oblique'. | |
| 988 | |
| 989 @item fontweight | |
| 990 Flag whether the font is bold, etc. Valid values are 'normal', 'bold', | |
| 991 'demi' or 'light'. | |
| 992 | |
| 993 @item interpreter | |
| 994 Determines how the text is rendered. Valid values are 'none', 'tex' or | |
| 995 'latex'. | |
| 6888 | 996 @end table |
| 997 | |
| 7189 | 998 All text objects, including titles, labels, legends, and text, include |
| 999 the property 'interpreter', this property determines the manner in which | |
| 1000 special control sequences in the text are rendered. If the interpreter | |
| 1001 is set to 'none', then no rendering occurs. At this point the 'latex' | |
| 1002 option is not implemented and so the 'latex' interpreter also does not | |
| 1003 interpret the text. | |
| 1004 | |
| 1005 The 'tex' option implements a subset of @sc{TeX} functionality in the | |
| 1006 rendering of the text. This allows the insertion of special characters | |
| 1007 such as Greek or mathematical symbols within the text. The special | |
| 1008 characters are also inserted with a code starting with the back-slash | |
| 1009 (\) character, as in the table @ref{tab:extended}. | |
| 1010 | |
|
8325
b93ac0586e4b
spelling corrections
Brian Gough<bjg@network-theory.co.uk>
parents:
8297
diff
changeset
|
1011 In addition, the formatting of the text can be changed within the string |
| 7189 | 1012 with the codes |
| 1013 | |
| 1014 @multitable @columnfractions .2 .2 .6 .2 | |
| 1015 @item @tab \bf @tab Bold font @tab | |
| 1016 @item @tab \it @tab Italic font @tab | |
| 1017 @item @tab \sl @tab Oblique Font @tab | |
| 1018 @item @tab \rm @tab Normal font @tab | |
| 1019 @end multitable | |
| 1020 | |
| 1021 These are be used in conjunction with the @{ and @} characters to limit | |
| 1022 the change in the font to part of the string. For example | |
| 1023 | |
| 1024 @example | |
| 1025 xlabel ('@{\bf H@} = a @{\bf V@}') | |
| 1026 @end example | |
| 1027 | |
| 1028 where the character 'a' will not appear in a bold font. Note that to | |
| 1029 avoid having Octave interpret the backslash characters in the strings, | |
| 1030 the strings should be in single quotes. | |
| 1031 | |
| 1032 It is also possible to change the fontname and size within the text | |
| 1033 | |
| 1034 @multitable @columnfractions .1 .4 .6 .1 | |
| 1035 @item @tab \fontname@{@var{fontname}@} @tab Specify the font to use @tab | |
| 1036 @item @tab \fontsize@{@var{size}@} @tab Specify the size of the font to | |
| 1037 use @tab | |
| 1038 @end multitable | |
| 1039 | |
| 1040 Finally, the superscript and subscripting can be controlled with the '^' | |
| 1041 and '_' characters. If the '^' or '_' is followed by a @{ character, | |
| 1042 then all of the block surrounded by the @{ @} pair is super- or | |
| 1043 sub-scripted. Without the @{ @} pair, only the character immediately | |
| 1044 following the '^' or '_' is super- or sub-scripted. | |
| 1045 | |
| 1046 @float Table,tab:extended | |
| 1047 @iftex | |
| 1048 @tex | |
| 1049 \vskip 6pt | |
| 1050 {\hbox to \hsize {\hfill\vbox{\offinterlineskip \tabskip=0pt | |
| 1051 \halign{ | |
| 1052 \vrule height2.0ex depth1.ex width 0.6pt #\tabskip=0.3em & | |
| 1053 # \hfil & \vrule # & # \hfil & # \vrule & | |
| 1054 # \hfil & \vrule # & # \hfil & # \vrule & | |
| 1055 # \hfil & \vrule # & # \hfil & # \vrule | |
| 1056 width 0.6pt \tabskip=0pt\cr | |
| 1057 \noalign{\hrule height 0.6pt} | |
| 1058 & Code && Sym && Code && Sym && Code && Sym &\cr | |
| 1059 \noalign{\hrule} | |
|
7608
49810341db91
Correct typos in __go_draw_axes__.m and update Manual
godfrey@qss.Stanford.EDU
parents:
7189
diff
changeset
|
1060 & $\backslash$forall && $\forall$ |
|
49810341db91
Correct typos in __go_draw_axes__.m and update Manual
godfrey@qss.Stanford.EDU
parents:
7189
diff
changeset
|
1061 && $\backslash$exists && $\exists$ |
|
49810341db91
Correct typos in __go_draw_axes__.m and update Manual
godfrey@qss.Stanford.EDU
parents:
7189
diff
changeset
|
1062 && $\backslash$ni && $\ni$ &\cr |
|
49810341db91
Correct typos in __go_draw_axes__.m and update Manual
godfrey@qss.Stanford.EDU
parents:
7189
diff
changeset
|
1063 & $\backslash$cong && $\cong$ |
|
49810341db91
Correct typos in __go_draw_axes__.m and update Manual
godfrey@qss.Stanford.EDU
parents:
7189
diff
changeset
|
1064 && $\backslash$Delta && $\Delta$ |
|
49810341db91
Correct typos in __go_draw_axes__.m and update Manual
godfrey@qss.Stanford.EDU
parents:
7189
diff
changeset
|
1065 && $\backslash$Phi && $\Phi$ &\cr |
|
49810341db91
Correct typos in __go_draw_axes__.m and update Manual
godfrey@qss.Stanford.EDU
parents:
7189
diff
changeset
|
1066 & $\backslash$Gamma && $\Gamma$ |
|
49810341db91
Correct typos in __go_draw_axes__.m and update Manual
godfrey@qss.Stanford.EDU
parents:
7189
diff
changeset
|
1067 && $\backslash$vartheta && $\vartheta$ |
|
49810341db91
Correct typos in __go_draw_axes__.m and update Manual
godfrey@qss.Stanford.EDU
parents:
7189
diff
changeset
|
1068 && $\backslash$Lambda && $\Lambda$ &\cr |
|
49810341db91
Correct typos in __go_draw_axes__.m and update Manual
godfrey@qss.Stanford.EDU
parents:
7189
diff
changeset
|
1069 & $\backslash$Pi && $\Pi$ |
|
49810341db91
Correct typos in __go_draw_axes__.m and update Manual
godfrey@qss.Stanford.EDU
parents:
7189
diff
changeset
|
1070 && $\backslash$Theta && $\Theta$ |
|
49810341db91
Correct typos in __go_draw_axes__.m and update Manual
godfrey@qss.Stanford.EDU
parents:
7189
diff
changeset
|
1071 && $\backslash$Sigma && $\Sigma$ &\cr |
|
49810341db91
Correct typos in __go_draw_axes__.m and update Manual
godfrey@qss.Stanford.EDU
parents:
7189
diff
changeset
|
1072 & $\backslash$varsigma && $\varsigma$ |
|
49810341db91
Correct typos in __go_draw_axes__.m and update Manual
godfrey@qss.Stanford.EDU
parents:
7189
diff
changeset
|
1073 && $\backslash$Omega && $\Omega$ |
|
49810341db91
Correct typos in __go_draw_axes__.m and update Manual
godfrey@qss.Stanford.EDU
parents:
7189
diff
changeset
|
1074 && $\backslash$Xi && $\Xi$ &\cr |
|
49810341db91
Correct typos in __go_draw_axes__.m and update Manual
godfrey@qss.Stanford.EDU
parents:
7189
diff
changeset
|
1075 & $\backslash$Psi && $\Psi$ |
|
49810341db91
Correct typos in __go_draw_axes__.m and update Manual
godfrey@qss.Stanford.EDU
parents:
7189
diff
changeset
|
1076 && $\backslash$perp && $\perp$ |
|
49810341db91
Correct typos in __go_draw_axes__.m and update Manual
godfrey@qss.Stanford.EDU
parents:
7189
diff
changeset
|
1077 && $\backslash$alpha && $\alpha$ &\cr |
|
49810341db91
Correct typos in __go_draw_axes__.m and update Manual
godfrey@qss.Stanford.EDU
parents:
7189
diff
changeset
|
1078 & $\backslash$beta && $\beta$ |
|
49810341db91
Correct typos in __go_draw_axes__.m and update Manual
godfrey@qss.Stanford.EDU
parents:
7189
diff
changeset
|
1079 && $\backslash$chi && $\chi$ |
|
49810341db91
Correct typos in __go_draw_axes__.m and update Manual
godfrey@qss.Stanford.EDU
parents:
7189
diff
changeset
|
1080 && $\backslash$delta && $\delta$ &\cr |
|
49810341db91
Correct typos in __go_draw_axes__.m and update Manual
godfrey@qss.Stanford.EDU
parents:
7189
diff
changeset
|
1081 & $\backslash$epsilon && $\epsilon$ |
|
49810341db91
Correct typos in __go_draw_axes__.m and update Manual
godfrey@qss.Stanford.EDU
parents:
7189
diff
changeset
|
1082 && $\backslash$phi && $\phi$ |
|
49810341db91
Correct typos in __go_draw_axes__.m and update Manual
godfrey@qss.Stanford.EDU
parents:
7189
diff
changeset
|
1083 && $\backslash$gamma && $\gamma$ &\cr |
|
49810341db91
Correct typos in __go_draw_axes__.m and update Manual
godfrey@qss.Stanford.EDU
parents:
7189
diff
changeset
|
1084 & $\backslash$eta && $\eta$ |
|
49810341db91
Correct typos in __go_draw_axes__.m and update Manual
godfrey@qss.Stanford.EDU
parents:
7189
diff
changeset
|
1085 && $\backslash$iota && $\iota$ |
|
49810341db91
Correct typos in __go_draw_axes__.m and update Manual
godfrey@qss.Stanford.EDU
parents:
7189
diff
changeset
|
1086 && $\backslash$varphi && $\varphi$ &\cr |
|
49810341db91
Correct typos in __go_draw_axes__.m and update Manual
godfrey@qss.Stanford.EDU
parents:
7189
diff
changeset
|
1087 & $\backslash$kappa && $\kappa$ |
|
49810341db91
Correct typos in __go_draw_axes__.m and update Manual
godfrey@qss.Stanford.EDU
parents:
7189
diff
changeset
|
1088 && $\backslash$lambda && $\lambda$ |
|
49810341db91
Correct typos in __go_draw_axes__.m and update Manual
godfrey@qss.Stanford.EDU
parents:
7189
diff
changeset
|
1089 && $\backslash$mu && $\mu$ &\cr |
|
49810341db91
Correct typos in __go_draw_axes__.m and update Manual
godfrey@qss.Stanford.EDU
parents:
7189
diff
changeset
|
1090 & $\backslash$nu && $\nu$ |
|
49810341db91
Correct typos in __go_draw_axes__.m and update Manual
godfrey@qss.Stanford.EDU
parents:
7189
diff
changeset
|
1091 && $\backslash$o && $\o$ |
|
49810341db91
Correct typos in __go_draw_axes__.m and update Manual
godfrey@qss.Stanford.EDU
parents:
7189
diff
changeset
|
1092 && $\backslash$pi && $\pi$ &\cr |
|
49810341db91
Correct typos in __go_draw_axes__.m and update Manual
godfrey@qss.Stanford.EDU
parents:
7189
diff
changeset
|
1093 & $\backslash$theta && $\theta$ |
|
49810341db91
Correct typos in __go_draw_axes__.m and update Manual
godfrey@qss.Stanford.EDU
parents:
7189
diff
changeset
|
1094 && $\backslash$rho && $\rho$ |
|
49810341db91
Correct typos in __go_draw_axes__.m and update Manual
godfrey@qss.Stanford.EDU
parents:
7189
diff
changeset
|
1095 && $\backslash$sigma && $\sigma$ &\cr |
|
49810341db91
Correct typos in __go_draw_axes__.m and update Manual
godfrey@qss.Stanford.EDU
parents:
7189
diff
changeset
|
1096 & $\backslash$tau && $\tau$ |
|
49810341db91
Correct typos in __go_draw_axes__.m and update Manual
godfrey@qss.Stanford.EDU
parents:
7189
diff
changeset
|
1097 && $\backslash$upsilon && $\upsilon$ |
|
49810341db91
Correct typos in __go_draw_axes__.m and update Manual
godfrey@qss.Stanford.EDU
parents:
7189
diff
changeset
|
1098 && $\backslash$varpi && $\varpi$ &\cr |
|
49810341db91
Correct typos in __go_draw_axes__.m and update Manual
godfrey@qss.Stanford.EDU
parents:
7189
diff
changeset
|
1099 & $\backslash$omega && $\omega$ |
|
49810341db91
Correct typos in __go_draw_axes__.m and update Manual
godfrey@qss.Stanford.EDU
parents:
7189
diff
changeset
|
1100 && $\backslash$xi && $\xi$ |
|
49810341db91
Correct typos in __go_draw_axes__.m and update Manual
godfrey@qss.Stanford.EDU
parents:
7189
diff
changeset
|
1101 && $\backslash$psi && $\psi$ &\cr |
|
49810341db91
Correct typos in __go_draw_axes__.m and update Manual
godfrey@qss.Stanford.EDU
parents:
7189
diff
changeset
|
1102 & $\backslash$zeta && $\zeta$ |
|
49810341db91
Correct typos in __go_draw_axes__.m and update Manual
godfrey@qss.Stanford.EDU
parents:
7189
diff
changeset
|
1103 && $\backslash$sim && $\sim$ |
|
49810341db91
Correct typos in __go_draw_axes__.m and update Manual
godfrey@qss.Stanford.EDU
parents:
7189
diff
changeset
|
1104 && $\backslash$Upsilon && $\Upsilon$ &\cr |
|
49810341db91
Correct typos in __go_draw_axes__.m and update Manual
godfrey@qss.Stanford.EDU
parents:
7189
diff
changeset
|
1105 & $\backslash$prime && $\prime$ |
|
49810341db91
Correct typos in __go_draw_axes__.m and update Manual
godfrey@qss.Stanford.EDU
parents:
7189
diff
changeset
|
1106 && $\backslash$leq && $\leq$ |
|
49810341db91
Correct typos in __go_draw_axes__.m and update Manual
godfrey@qss.Stanford.EDU
parents:
7189
diff
changeset
|
1107 && $\backslash$infty && $\infty$ &\cr |
|
49810341db91
Correct typos in __go_draw_axes__.m and update Manual
godfrey@qss.Stanford.EDU
parents:
7189
diff
changeset
|
1108 & $\backslash$clubsuit && $\clubsuit$ |
|
49810341db91
Correct typos in __go_draw_axes__.m and update Manual
godfrey@qss.Stanford.EDU
parents:
7189
diff
changeset
|
1109 && $\backslash$diamondsuit && $\diamondsuit$ |
|
49810341db91
Correct typos in __go_draw_axes__.m and update Manual
godfrey@qss.Stanford.EDU
parents:
7189
diff
changeset
|
1110 && $\backslash$heartsuit && $\heartsuit$ &\cr |
|
49810341db91
Correct typos in __go_draw_axes__.m and update Manual
godfrey@qss.Stanford.EDU
parents:
7189
diff
changeset
|
1111 & $\backslash$spadesuit && $\spadesuit$ |
|
49810341db91
Correct typos in __go_draw_axes__.m and update Manual
godfrey@qss.Stanford.EDU
parents:
7189
diff
changeset
|
1112 && $\backslash$leftrightarrow && $\leftrightarrow$ |
|
49810341db91
Correct typos in __go_draw_axes__.m and update Manual
godfrey@qss.Stanford.EDU
parents:
7189
diff
changeset
|
1113 && $\backslash$leftarrow && $\leftarrow$ &\cr |
|
49810341db91
Correct typos in __go_draw_axes__.m and update Manual
godfrey@qss.Stanford.EDU
parents:
7189
diff
changeset
|
1114 & $\backslash$uparrow && $\uparrow$ |
|
49810341db91
Correct typos in __go_draw_axes__.m and update Manual
godfrey@qss.Stanford.EDU
parents:
7189
diff
changeset
|
1115 && $\backslash$rightarrow && $\rightarrow$ |
|
49810341db91
Correct typos in __go_draw_axes__.m and update Manual
godfrey@qss.Stanford.EDU
parents:
7189
diff
changeset
|
1116 && $\backslash$downarrow && $\downarrow$ &\cr |
|
49810341db91
Correct typos in __go_draw_axes__.m and update Manual
godfrey@qss.Stanford.EDU
parents:
7189
diff
changeset
|
1117 & $\backslash$circ && $\circ$ |
|
49810341db91
Correct typos in __go_draw_axes__.m and update Manual
godfrey@qss.Stanford.EDU
parents:
7189
diff
changeset
|
1118 && $\backslash$pm && $\pm$ |
|
49810341db91
Correct typos in __go_draw_axes__.m and update Manual
godfrey@qss.Stanford.EDU
parents:
7189
diff
changeset
|
1119 && $\backslash$geq && $\geq$ &\cr |
|
49810341db91
Correct typos in __go_draw_axes__.m and update Manual
godfrey@qss.Stanford.EDU
parents:
7189
diff
changeset
|
1120 & $\backslash$times && $\times$ |
|
49810341db91
Correct typos in __go_draw_axes__.m and update Manual
godfrey@qss.Stanford.EDU
parents:
7189
diff
changeset
|
1121 && $\backslash$propto && $\propto$ |
|
49810341db91
Correct typos in __go_draw_axes__.m and update Manual
godfrey@qss.Stanford.EDU
parents:
7189
diff
changeset
|
1122 && $\backslash$partial && $\partial$ &\cr |
|
49810341db91
Correct typos in __go_draw_axes__.m and update Manual
godfrey@qss.Stanford.EDU
parents:
7189
diff
changeset
|
1123 & $\backslash$bullet && $\bullet$ |
|
49810341db91
Correct typos in __go_draw_axes__.m and update Manual
godfrey@qss.Stanford.EDU
parents:
7189
diff
changeset
|
1124 && $\backslash$div && $\div$ |
|
49810341db91
Correct typos in __go_draw_axes__.m and update Manual
godfrey@qss.Stanford.EDU
parents:
7189
diff
changeset
|
1125 && $\backslash$neq && $\neq$ &\cr |
|
49810341db91
Correct typos in __go_draw_axes__.m and update Manual
godfrey@qss.Stanford.EDU
parents:
7189
diff
changeset
|
1126 & $\backslash$equiv && $\equiv$ |
|
49810341db91
Correct typos in __go_draw_axes__.m and update Manual
godfrey@qss.Stanford.EDU
parents:
7189
diff
changeset
|
1127 && $\backslash$approx && $\approx$ |
|
49810341db91
Correct typos in __go_draw_axes__.m and update Manual
godfrey@qss.Stanford.EDU
parents:
7189
diff
changeset
|
1128 && $\backslash$ldots && $\ldots$ &\cr |
|
49810341db91
Correct typos in __go_draw_axes__.m and update Manual
godfrey@qss.Stanford.EDU
parents:
7189
diff
changeset
|
1129 & $\backslash$mid && $\mid$ |
|
49810341db91
Correct typos in __go_draw_axes__.m and update Manual
godfrey@qss.Stanford.EDU
parents:
7189
diff
changeset
|
1130 && $\backslash$aleph && $\aleph$ |
|
49810341db91
Correct typos in __go_draw_axes__.m and update Manual
godfrey@qss.Stanford.EDU
parents:
7189
diff
changeset
|
1131 && $\backslash$Im && $\Im$ &\cr |
|
49810341db91
Correct typos in __go_draw_axes__.m and update Manual
godfrey@qss.Stanford.EDU
parents:
7189
diff
changeset
|
1132 & $\backslash$Re && $\Re$ |
|
49810341db91
Correct typos in __go_draw_axes__.m and update Manual
godfrey@qss.Stanford.EDU
parents:
7189
diff
changeset
|
1133 && $\backslash$wp && $\wp$ |
|
49810341db91
Correct typos in __go_draw_axes__.m and update Manual
godfrey@qss.Stanford.EDU
parents:
7189
diff
changeset
|
1134 && $\backslash$otimes && $\otimes$ &\cr |
|
49810341db91
Correct typos in __go_draw_axes__.m and update Manual
godfrey@qss.Stanford.EDU
parents:
7189
diff
changeset
|
1135 & $\backslash$oplus && $\oplus$ |
|
49810341db91
Correct typos in __go_draw_axes__.m and update Manual
godfrey@qss.Stanford.EDU
parents:
7189
diff
changeset
|
1136 && $\backslash$oslash && $\oslash$ |
|
49810341db91
Correct typos in __go_draw_axes__.m and update Manual
godfrey@qss.Stanford.EDU
parents:
7189
diff
changeset
|
1137 && $\backslash$cap && $\cap$ &\cr |
|
49810341db91
Correct typos in __go_draw_axes__.m and update Manual
godfrey@qss.Stanford.EDU
parents:
7189
diff
changeset
|
1138 & $\backslash$cup && $\cup$ |
|
49810341db91
Correct typos in __go_draw_axes__.m and update Manual
godfrey@qss.Stanford.EDU
parents:
7189
diff
changeset
|
1139 && $\backslash$supset && $\supset$ |
|
49810341db91
Correct typos in __go_draw_axes__.m and update Manual
godfrey@qss.Stanford.EDU
parents:
7189
diff
changeset
|
1140 && $\backslash$supseteq && $\supseteq$ &\cr |
|
49810341db91
Correct typos in __go_draw_axes__.m and update Manual
godfrey@qss.Stanford.EDU
parents:
7189
diff
changeset
|
1141 & $\backslash$subset && $\subset$ |
|
49810341db91
Correct typos in __go_draw_axes__.m and update Manual
godfrey@qss.Stanford.EDU
parents:
7189
diff
changeset
|
1142 && $\backslash$subseteq && $\subseteq$ |
|
49810341db91
Correct typos in __go_draw_axes__.m and update Manual
godfrey@qss.Stanford.EDU
parents:
7189
diff
changeset
|
1143 && $\backslash$in && $\in$ &\cr |
|
49810341db91
Correct typos in __go_draw_axes__.m and update Manual
godfrey@qss.Stanford.EDU
parents:
7189
diff
changeset
|
1144 & $\backslash$notin && $\notin$ |
|
49810341db91
Correct typos in __go_draw_axes__.m and update Manual
godfrey@qss.Stanford.EDU
parents:
7189
diff
changeset
|
1145 && $\backslash$angle && $\angle$ |
|
49810341db91
Correct typos in __go_draw_axes__.m and update Manual
godfrey@qss.Stanford.EDU
parents:
7189
diff
changeset
|
1146 && $\backslash$bigtriangledown && $\bigtriangledown$ &\cr |
|
49810341db91
Correct typos in __go_draw_axes__.m and update Manual
godfrey@qss.Stanford.EDU
parents:
7189
diff
changeset
|
1147 & $\backslash$langle && $\langle$ |
|
49810341db91
Correct typos in __go_draw_axes__.m and update Manual
godfrey@qss.Stanford.EDU
parents:
7189
diff
changeset
|
1148 && $\backslash$rangle && $\rangle$ |
|
49810341db91
Correct typos in __go_draw_axes__.m and update Manual
godfrey@qss.Stanford.EDU
parents:
7189
diff
changeset
|
1149 && $\backslash$nabla && $\nabla$ &\cr |
|
49810341db91
Correct typos in __go_draw_axes__.m and update Manual
godfrey@qss.Stanford.EDU
parents:
7189
diff
changeset
|
1150 & $\backslash$prod && $\prod$ |
|
49810341db91
Correct typos in __go_draw_axes__.m and update Manual
godfrey@qss.Stanford.EDU
parents:
7189
diff
changeset
|
1151 && $\backslash$surd && $\surd$ |
|
49810341db91
Correct typos in __go_draw_axes__.m and update Manual
godfrey@qss.Stanford.EDU
parents:
7189
diff
changeset
|
1152 && $\backslash$cdot && $\cdot$ &\cr |
|
49810341db91
Correct typos in __go_draw_axes__.m and update Manual
godfrey@qss.Stanford.EDU
parents:
7189
diff
changeset
|
1153 & $\backslash$neg && $\neg$ |
|
49810341db91
Correct typos in __go_draw_axes__.m and update Manual
godfrey@qss.Stanford.EDU
parents:
7189
diff
changeset
|
1154 && $\backslash$wedge && $\wedge$ |
|
49810341db91
Correct typos in __go_draw_axes__.m and update Manual
godfrey@qss.Stanford.EDU
parents:
7189
diff
changeset
|
1155 && $\backslash$vee && $\vee$ &\cr |
|
49810341db91
Correct typos in __go_draw_axes__.m and update Manual
godfrey@qss.Stanford.EDU
parents:
7189
diff
changeset
|
1156 & $\backslash$Leftrightarrow && $\Leftrightarrow$ |
|
49810341db91
Correct typos in __go_draw_axes__.m and update Manual
godfrey@qss.Stanford.EDU
parents:
7189
diff
changeset
|
1157 && $\backslash$Leftarrow && $\Leftarrow$ |
|
49810341db91
Correct typos in __go_draw_axes__.m and update Manual
godfrey@qss.Stanford.EDU
parents:
7189
diff
changeset
|
1158 && $\backslash$Uparrow && $\Uparrow$ &\cr |
|
49810341db91
Correct typos in __go_draw_axes__.m and update Manual
godfrey@qss.Stanford.EDU
parents:
7189
diff
changeset
|
1159 & $\backslash$Rightarrow && $\Rightarrow$ |
|
49810341db91
Correct typos in __go_draw_axes__.m and update Manual
godfrey@qss.Stanford.EDU
parents:
7189
diff
changeset
|
1160 && $\backslash$Downarrow && $\Downarrow$ |
|
49810341db91
Correct typos in __go_draw_axes__.m and update Manual
godfrey@qss.Stanford.EDU
parents:
7189
diff
changeset
|
1161 && $\backslash$diamond && $\diamond$ &\cr |
|
49810341db91
Correct typos in __go_draw_axes__.m and update Manual
godfrey@qss.Stanford.EDU
parents:
7189
diff
changeset
|
1162 & $\backslash$copyright && $\copyright$ |
|
49810341db91
Correct typos in __go_draw_axes__.m and update Manual
godfrey@qss.Stanford.EDU
parents:
7189
diff
changeset
|
1163 && $\backslash$rfloor && $\rfloor$ |
|
49810341db91
Correct typos in __go_draw_axes__.m and update Manual
godfrey@qss.Stanford.EDU
parents:
7189
diff
changeset
|
1164 && $\backslash$lceil && $\lceil$ &\cr |
|
49810341db91
Correct typos in __go_draw_axes__.m and update Manual
godfrey@qss.Stanford.EDU
parents:
7189
diff
changeset
|
1165 & $\backslash$lfloor && $\lfloor$ |
|
49810341db91
Correct typos in __go_draw_axes__.m and update Manual
godfrey@qss.Stanford.EDU
parents:
7189
diff
changeset
|
1166 && $\backslash$rceil && $\rceil$ |
|
49810341db91
Correct typos in __go_draw_axes__.m and update Manual
godfrey@qss.Stanford.EDU
parents:
7189
diff
changeset
|
1167 && $\backslash$int && $\int$ &\cr |
| 7189 | 1168 \noalign{\hrule height 0.6pt} |
| 1169 }}\hfill}} | |
| 1170 @end tex | |
| 1171 @end iftex | |
| 1172 @ifnottex | |
| 1173 @multitable @columnfractions .125 .25 .25 .25 .125 | |
|
7608
49810341db91
Correct typos in __go_draw_axes__.m and update Manual
godfrey@qss.Stanford.EDU
parents:
7189
diff
changeset
|
1174 @item @tab \forall @tab \exists @tab \ni @tab |
|
49810341db91
Correct typos in __go_draw_axes__.m and update Manual
godfrey@qss.Stanford.EDU
parents:
7189
diff
changeset
|
1175 @item @tab \cong @tab \Delta @tab \Phi @tab |
|
49810341db91
Correct typos in __go_draw_axes__.m and update Manual
godfrey@qss.Stanford.EDU
parents:
7189
diff
changeset
|
1176 @item @tab \Gamma @tab \vartheta @tab \Lambda @tab |
|
49810341db91
Correct typos in __go_draw_axes__.m and update Manual
godfrey@qss.Stanford.EDU
parents:
7189
diff
changeset
|
1177 @item @tab \Pi @tab \Theta @tab \Sigma @tab |
|
49810341db91
Correct typos in __go_draw_axes__.m and update Manual
godfrey@qss.Stanford.EDU
parents:
7189
diff
changeset
|
1178 @item @tab \varsigma @tab \Omega @tab \Xi @tab |
|
49810341db91
Correct typos in __go_draw_axes__.m and update Manual
godfrey@qss.Stanford.EDU
parents:
7189
diff
changeset
|
1179 @item @tab \Psi @tab \perp @tab \alpha @tab |
|
49810341db91
Correct typos in __go_draw_axes__.m and update Manual
godfrey@qss.Stanford.EDU
parents:
7189
diff
changeset
|
1180 @item @tab \beta @tab \chi @tab \delta @tab |
|
49810341db91
Correct typos in __go_draw_axes__.m and update Manual
godfrey@qss.Stanford.EDU
parents:
7189
diff
changeset
|
1181 @item @tab \epsilon @tab \phi @tab \gamma @tab |
|
49810341db91
Correct typos in __go_draw_axes__.m and update Manual
godfrey@qss.Stanford.EDU
parents:
7189
diff
changeset
|
1182 @item @tab \eta @tab \iota @tab \varphi @tab |
|
49810341db91
Correct typos in __go_draw_axes__.m and update Manual
godfrey@qss.Stanford.EDU
parents:
7189
diff
changeset
|
1183 @item @tab \kappa @tab \lambda @tab \mu @tab |
|
49810341db91
Correct typos in __go_draw_axes__.m and update Manual
godfrey@qss.Stanford.EDU
parents:
7189
diff
changeset
|
1184 @item @tab \nu @tab \o @tab \pi @tab |
|
49810341db91
Correct typos in __go_draw_axes__.m and update Manual
godfrey@qss.Stanford.EDU
parents:
7189
diff
changeset
|
1185 @item @tab \theta @tab \rho @tab \sigma @tab |
|
49810341db91
Correct typos in __go_draw_axes__.m and update Manual
godfrey@qss.Stanford.EDU
parents:
7189
diff
changeset
|
1186 @item @tab \tau @tab \upsilon @tab \varpi @tab |
|
49810341db91
Correct typos in __go_draw_axes__.m and update Manual
godfrey@qss.Stanford.EDU
parents:
7189
diff
changeset
|
1187 @item @tab \omega @tab \xi @tab \psi @tab |
|
49810341db91
Correct typos in __go_draw_axes__.m and update Manual
godfrey@qss.Stanford.EDU
parents:
7189
diff
changeset
|
1188 @item @tab \zeta @tab \sim @tab \Upsilon @tab |
|
49810341db91
Correct typos in __go_draw_axes__.m and update Manual
godfrey@qss.Stanford.EDU
parents:
7189
diff
changeset
|
1189 @item @tab \prime @tab \leq @tab \infty @tab |
|
49810341db91
Correct typos in __go_draw_axes__.m and update Manual
godfrey@qss.Stanford.EDU
parents:
7189
diff
changeset
|
1190 @item @tab \clubsuit @tab \diamondsuit @tab \heartsuit @tab |
|
49810341db91
Correct typos in __go_draw_axes__.m and update Manual
godfrey@qss.Stanford.EDU
parents:
7189
diff
changeset
|
1191 @item @tab \spadesuit @tab \leftrightarrow @tab \leftarrow @tab |
|
49810341db91
Correct typos in __go_draw_axes__.m and update Manual
godfrey@qss.Stanford.EDU
parents:
7189
diff
changeset
|
1192 @item @tab \uparrow @tab \rightarrow @tab \downarrow @tab |
|
49810341db91
Correct typos in __go_draw_axes__.m and update Manual
godfrey@qss.Stanford.EDU
parents:
7189
diff
changeset
|
1193 @item @tab \circ @tab \pm @tab \geq @tab |
|
49810341db91
Correct typos in __go_draw_axes__.m and update Manual
godfrey@qss.Stanford.EDU
parents:
7189
diff
changeset
|
1194 @item @tab \times @tab \propto @tab \partial @tab |
|
49810341db91
Correct typos in __go_draw_axes__.m and update Manual
godfrey@qss.Stanford.EDU
parents:
7189
diff
changeset
|
1195 @item @tab \bullet @tab \div @tab \neq @tab |
|
49810341db91
Correct typos in __go_draw_axes__.m and update Manual
godfrey@qss.Stanford.EDU
parents:
7189
diff
changeset
|
1196 @item @tab \equiv @tab \approx @tab \ldots @tab |
|
49810341db91
Correct typos in __go_draw_axes__.m and update Manual
godfrey@qss.Stanford.EDU
parents:
7189
diff
changeset
|
1197 @item @tab \mid @tab \aleph @tab \Im @tab |
|
49810341db91
Correct typos in __go_draw_axes__.m and update Manual
godfrey@qss.Stanford.EDU
parents:
7189
diff
changeset
|
1198 @item @tab \Re @tab \wp @tab \otimes @tab |
|
49810341db91
Correct typos in __go_draw_axes__.m and update Manual
godfrey@qss.Stanford.EDU
parents:
7189
diff
changeset
|
1199 @item @tab \oplus @tab \oslash @tab \cap @tab |
|
49810341db91
Correct typos in __go_draw_axes__.m and update Manual
godfrey@qss.Stanford.EDU
parents:
7189
diff
changeset
|
1200 @item @tab \cup @tab \supset @tab \supseteq @tab |
|
49810341db91
Correct typos in __go_draw_axes__.m and update Manual
godfrey@qss.Stanford.EDU
parents:
7189
diff
changeset
|
1201 @item @tab \subset @tab \subseteq @tab \in @tab |
|
49810341db91
Correct typos in __go_draw_axes__.m and update Manual
godfrey@qss.Stanford.EDU
parents:
7189
diff
changeset
|
1202 @item @tab \notin @tab \angle @tab \bigrightriangledown @tab |
|
49810341db91
Correct typos in __go_draw_axes__.m and update Manual
godfrey@qss.Stanford.EDU
parents:
7189
diff
changeset
|
1203 @item @tab \langle @tab \rangle @tab \nabla @tab |
|
49810341db91
Correct typos in __go_draw_axes__.m and update Manual
godfrey@qss.Stanford.EDU
parents:
7189
diff
changeset
|
1204 @item @tab \prod @tab \surd @tab \cdot @tab |
|
49810341db91
Correct typos in __go_draw_axes__.m and update Manual
godfrey@qss.Stanford.EDU
parents:
7189
diff
changeset
|
1205 @item @tab \neg @tab \wedge @tab \vee @tab |
|
49810341db91
Correct typos in __go_draw_axes__.m and update Manual
godfrey@qss.Stanford.EDU
parents:
7189
diff
changeset
|
1206 @item @tab \Leftrightarrow @tab \Leftarrow @tab \Uparrow @tab |
|
49810341db91
Correct typos in __go_draw_axes__.m and update Manual
godfrey@qss.Stanford.EDU
parents:
7189
diff
changeset
|
1207 @item @tab \Rightarrow @tab \Downarrow @tab \diamond @tab |
|
49810341db91
Correct typos in __go_draw_axes__.m and update Manual
godfrey@qss.Stanford.EDU
parents:
7189
diff
changeset
|
1208 @item @tab \copyright @tab \lfloor @tab \lceil @tab |
|
49810341db91
Correct typos in __go_draw_axes__.m and update Manual
godfrey@qss.Stanford.EDU
parents:
7189
diff
changeset
|
1209 @item @tab \rfloor @tab \rceil @tab \int @tab |
| 7189 | 1210 @end multitable |
| 1211 @end ifnottex | |
| 1212 @caption{Available special characters in @sc{TeX} mode} | |
| 1213 @end float | |
| 1214 | |
| 1215 A complete example showing the capabilities of the extended text is | |
| 1216 | |
| 1217 @example | |
| 1218 @group | |
| 1219 x = 0:0.01:3; | |
| 1220 plot(x,erf(x)); | |
| 1221 hold on; | |
| 1222 plot(x,x,"r"); | |
| 1223 axis([0, 3, 0, 1]); | |
| 1224 text(0.65, 0.6175, strcat('\leftarrow x = @{2/\surd\pi', | |
| 1225 ' @{\fontsize@{16@}\int_@{\fontsize@{8@}0@}^@{\fontsize@{8@}x@}@}', | |
| 1226 ' e^@{-t^2@} dt@} = 0.6175')) | |
| 1227 @end group | |
| 1228 @end example | |
| 1229 | |
| 1230 @ifnotinfo | |
| 1231 @noindent | |
| 1232 The result of which can be seen in @ref{fig:extendedtext} | |
| 1233 | |
| 1234 @float Figure,fig:extendedtext | |
| 1235 @image{extended,8cm} | |
| 1236 @caption{Example of inclusion of text with the @sc{TeX} interpreter} | |
| 1237 @end float | |
| 1238 @end ifnotinfo | |
| 1239 | |
| 6888 | 1240 @node Image Properties |
| 1241 @subsubsection Image Properties | |
| 8071 | 1242 @cindex image properties |
| 6888 | 1243 |
| 1244 @table @code | |
| 1245 @item cdata | |
| 6889 | 1246 The data for the image. Each pixel of the image corresponds to an |
| 1247 element of @code{cdata}. The value of an element of @code{cdata} | |
| 1248 specifies the row-index into the colormap of the axes object containing | |
| 1249 the image. The color value found in the color map for the given index | |
| 1250 determines the color of the pixel. | |
| 1251 | |
| 1252 @item xdata | |
| 6888 | 1253 @itemx ydata |
| 7001 | 1254 Two-element vectors specifying the range of the x- and y- coordinates for |
| 6889 | 1255 the image. |
| 6888 | 1256 @end table |
| 1257 | |
| 1258 @node Patch Properties | |
| 1259 @subsubsection Patch Properties | |
| 8071 | 1260 @cindex patch properties |
| 6888 | 1261 |
| 1262 @table @code | |
| 1263 @item cdata | |
| 1264 @itemx xdata | |
| 1265 @itemx ydata | |
| 1266 @itemx zdata | |
| 6889 | 1267 Data defining the patch object. |
| 1268 | |
| 6888 | 1269 @item facecolor |
| 6889 | 1270 The fill color of the patch. @xref{Colors}. |
| 1271 | |
| 6888 | 1272 @item facealpha |
| 6889 | 1273 A number in the range [0, 1] indicating the transparency of the patch. |
| 1274 | |
| 6888 | 1275 @item edgecolor |
| 6889 | 1276 The color of the line defining the patch. @xref{Colors}. |
| 1277 | |
| 6888 | 1278 @item linestyle |
| 6889 | 1279 @itemx linewidth |
| 1280 @xref{Line Styles}. | |
| 1281 | |
| 6888 | 1282 @item marker |
| 6889 | 1283 @itemx markeredgecolor |
| 1284 @itemx markerfacecolor | |
| 1285 @itemx markersize | |
| 1286 @xref{Marker Styles}. | |
| 6888 | 1287 @end table |
| 1288 | |
| 1289 @node Surface Properties | |
| 1290 @subsubsection Surface Properties | |
| 8071 | 1291 @cindex surface properties |
| 6888 | 1292 |
| 1293 @table @code | |
| 1294 @item xdata | |
| 1295 @itemx ydata | |
| 1296 @itemx zdata | |
| 6889 | 1297 The data determining the surface. The @code{xdata} and @code{ydata} |
| 1298 elements are vectors and @code{zdata} must be a matrix. | |
| 1299 | |
| 6888 | 1300 @item keylabel |
| 6889 | 1301 The text of the legend entry corresponding to this surface. Note that |
| 1302 this property is not compatible with @sc{Matlab} and may be removed in a | |
| 1303 future version of Octave. | |
| 1304 @end table | |
| 1305 | |
|
8070
3b53b25e2550
Add data sources and line series
David Bateman <dbateman@free.fr>
parents:
8057
diff
changeset
|
1306 @node Searching Properties |
|
3b53b25e2550
Add data sources and line series
David Bateman <dbateman@free.fr>
parents:
8057
diff
changeset
|
1307 @subsubsection Searching Properties |
|
7984
bbaa5d7d0143
Some documentation updates
David Bateman <dbateman@free.fr>
parents:
7981
diff
changeset
|
1308 |
|
bbaa5d7d0143
Some documentation updates
David Bateman <dbateman@free.fr>
parents:
7981
diff
changeset
|
1309 @DOCSTRING(findobj) |
|
bbaa5d7d0143
Some documentation updates
David Bateman <dbateman@free.fr>
parents:
7981
diff
changeset
|
1310 |
|
bbaa5d7d0143
Some documentation updates
David Bateman <dbateman@free.fr>
parents:
7981
diff
changeset
|
1311 @DOCSTRING(findall) |
|
bbaa5d7d0143
Some documentation updates
David Bateman <dbateman@free.fr>
parents:
7981
diff
changeset
|
1312 |
|
bbaa5d7d0143
Some documentation updates
David Bateman <dbateman@free.fr>
parents:
7981
diff
changeset
|
1313 |
| 6891 | 1314 @node Managing Default Properties |
| 1315 @subsection Managing Default Properties | |
| 8071 | 1316 @cindex default graphics properties |
| 1317 @cindex graphics properties, default | |
| 6891 | 1318 |
| 6892 | 1319 Object properties have two classes of default values, @dfn{factory |
| 1320 defaults} (the initial values) and @dfn{user-defined defaults}, which | |
| 1321 may override the factory defaults. | |
| 6891 | 1322 |
| 1323 Although default values may be set for any object, they are set in | |
| 1324 parent objects and apply to child objects. For example, | |
| 1325 | |
| 1326 @example | |
| 1327 set (0, "defaultlinecolor", "green"); | |
| 1328 @end example | |
| 1329 | |
| 1330 @noindent | |
| 1331 sets the default line color for all objects. The rule for constructing | |
| 1332 the property name to set a default value is | |
| 1333 | |
| 1334 @example | |
| 1335 default + @var{object-type} + @var{property-name} | |
| 1336 @end example | |
| 1337 | |
| 1338 This rule can lead to some strange looking names, for example | |
| 1339 @code{defaultlinelinewidth"} specifies the default @code{linewidth} | |
| 1340 property for @code{line} objects. | |
| 1341 | |
| 1342 The example above used the root figure object, 0, so the default | |
| 1343 property value will apply to all line objects. However, default values | |
| 1344 are hierarchical, so defaults set in a figure objects override those | |
| 1345 set in the root figure object. Likewise, defaults set in axes objects | |
| 1346 override those set in figure or root figure objects. For example, | |
| 1347 | |
| 1348 @example | |
| 1349 @group | |
| 1350 subplot (2, 1, 1); | |
| 1351 set (0, "defaultlinecolor", "red"); | |
| 1352 set (1, "defaultlinecolor", "green"); | |
| 1353 set (gca (), "defaultlinecolor", "blue"); | |
| 1354 line (1:10, rand (1, 10)); | |
| 1355 subplot (2, 1, 2); | |
| 1356 line (1:10, rand (1, 10)); | |
| 1357 figure (2) | |
| 1358 line (1:10, rand (1, 10)); | |
| 1359 @end group | |
| 1360 @end example | |
| 1361 | |
| 1362 @noindent | |
| 1363 produces two figures. The line in first subplot window of the first | |
| 1364 figure is blue because it inherits its color from its parent axes | |
| 1365 object. The line in the second subplot window of the first figure is | |
| 1366 green because it inherits its color from its parent figure object. The | |
| 1367 line in the second figure window is red because it inherits its color | |
| 1368 from the global root figure parent object. | |
| 1369 | |
| 1370 To remove a user-defined default setting, set the default property to | |
| 1371 the value @code{"remove"}. For example, | |
| 1372 | |
| 1373 @example | |
| 1374 set (gca (), "defaultlinecolor", "remove"); | |
| 1375 @end example | |
| 1376 | |
| 1377 @noindent | |
| 1378 removes the user-defined default line color setting from the current axes | |
| 1379 object. | |
| 1380 | |
| 1381 Getting the @code{"default"} property of an object returns a list of | |
| 1382 user-defined defaults set for the object. For example, | |
| 1383 | |
| 1384 @example | |
| 1385 get (gca (), "default"); | |
| 1386 @end example | |
| 1387 | |
| 1388 @noindent | |
| 1389 returns a list of user-defined default values for the current axes | |
| 1390 object. | |
| 1391 | |
| 1392 Factory default values are stored in the root figure object. The | |
| 1393 command | |
| 1394 | |
| 1395 @example | |
| 1396 get (0, "factory"); | |
| 1397 @end example | |
| 1398 | |
| 1399 @noindent | |
| 1400 returns a list of factory defaults. | |
| 1401 | |
| 6889 | 1402 @node Colors |
| 1403 @subsection Colors | |
| 8071 | 1404 @cindex graphics colors |
| 1405 @cindex colors, graphics | |
| 6889 | 1406 |
| 1407 Colors may be specified as RGB triplets with values ranging from zero to | |
| 1408 one, or by name. Recognized color names include @code{"blue"}, | |
| 1409 @code{"black"}, @code{"cyan"}, @code{"green"}, @code{"magenta"}, | |
| 1410 @code{"red"}, @code{"white"}, and @code{"yellow"}. | |
| 1411 | |
| 1412 @node Line Styles | |
| 1413 @subsection Line Styles | |
| 8071 | 1414 @cindex line styles, graphics |
| 1415 @cindex graphics line styles | |
| 1416 | |
| 7001 | 1417 Line styles are specified by the following properties: |
| 6889 | 1418 |
| 1419 @table @code | |
| 1420 @item linestyle | |
| 1421 May be one of | |
| 1422 @table @code | |
| 1423 @item "-" | |
| 1424 Solid lines. | |
| 1425 @item "--" | |
| 1426 Dashed lines. | |
| 1427 @item ":" | |
| 1428 Points. | |
| 1429 @item "-." | |
| 1430 A dash-dot line. | |
| 1431 @end table | |
| 1432 | |
| 1433 @item linewidth | |
| 1434 A number specifying the width of the line. The default is 1. A value | |
| 1435 of 2 is twice as wide as the default, etc. | |
| 1436 @end table | |
| 1437 | |
| 1438 @node Marker Styles | |
| 1439 @subsection Marker Styles | |
| 8071 | 1440 @cindex graphics marker styles |
| 1441 @cindex marker styles, graphics | |
| 1442 | |
| 7001 | 1443 Marker styles are specified by the following properties: |
| 6889 | 1444 @table @code |
| 1445 @item marker | |
| 1446 A character indicating a plot marker to be place at each data point, or | |
| 1447 @code{"none"}, meaning no markers should be displayed. | |
| 1448 | |
| 1449 @itemx markeredgecolor | |
| 1450 The color of the edge around the marker, or @code{"auto"}, meaning that | |
| 1451 the edge color is the same as the face color. @xref{Colors}. | |
| 1452 | |
| 1453 @itemx markerfacecolor | |
| 1454 The color of the marker, or @code{"none"} to indicate that the marker | |
| 1455 should not be filled. @xref{Colors}. | |
| 1456 | |
| 1457 @itemx markersize | |
| 1458 A number specifying the size of the marker. The default is 1. A value | |
| 1459 of 2 is twice as large as the default, etc. | |
| 6888 | 1460 @end table |
| 1461 | |
|
8056
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
1462 @node Callbacks |
|
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
1463 @subsection Callbacks |
| 8071 | 1464 @cindex callbacks |
|
8056
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
1465 |
|
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
1466 Callback functions can be associated with graphics objects and triggered |
|
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
1467 after certain events occur. The basic structure of all callback function |
|
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
1468 is |
|
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
1469 |
|
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
1470 @example |
|
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
1471 @group |
|
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
1472 function mycallback (src, data) |
|
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
1473 @dots{} |
|
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
1474 endfunction |
|
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
1475 @end group |
|
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
1476 @end example |
|
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
1477 |
|
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
1478 where @code{src} gives a handle to the source of the callback, and |
|
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
1479 @code{code} gives some event specific data. This can then be associated |
|
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
1480 with an object either at the objects creation or later with the |
|
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
1481 @code{set} function. For example |
|
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
1482 |
|
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
1483 @example |
|
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
1484 plot (x, "DeleteFcn", @@(s, e) disp("Window Deleted")) |
|
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
1485 @end example |
|
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
1486 |
|
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
1487 @noindent |
|
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
1488 where at the moment that the plot is deleted, the message "Window |
|
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
1489 Deleted" will be displayed. |
|
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
1490 |
|
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
1491 Additional user arguments can be passed to callback functions, and will |
|
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
1492 be passed after the 2 default arguments. For example |
|
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
1493 |
|
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
1494 @example |
| 8057 | 1495 plot (x, "DeleteFcn", @{@@mycallback, "1"@}) |
|
8056
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
1496 @dots{} |
| 8057 | 1497 function mycallback (src, data, a1) |
|
8056
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
1498 fprintf ("Closing plot %d\n", a1); |
|
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
1499 endfunction |
|
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
1500 @end example |
|
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
1501 |
|
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
1502 The basic callback functions that are available for all graphics objects |
|
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
1503 are |
|
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
1504 |
|
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
1505 @itemize @bullet |
|
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
1506 @item CreateFcn |
|
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
1507 This is the callback that is called at the moment of the objects |
|
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
1508 creation. It is not called if the object is altered in any way, and so |
|
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
1509 it only makes sense to define this callback in the function call that |
|
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
1510 defines the object. Callbacks that are added to @code{CreateFcn} later with |
|
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
1511 the @code{set} function will never be executed. |
|
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
1512 |
|
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
1513 @item DeleteFcn |
|
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
1514 This is the callback that is called at the moment an object is deleted. |
|
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
1515 |
|
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
1516 @item ButtonDownFcn |
|
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
1517 This is the callback that is called if a mouse button is pressed while |
|
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
1518 the pointer is over this object. Note, that the gnuplot interface does |
|
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
1519 not respect this callback. |
|
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
1520 @end itemize |
|
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
1521 |
|
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
1522 The object and figure that the event occurred in that resulted in the |
|
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
1523 callback being called can be found with the @code{gcbo} and @code{gcbf} |
|
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
1524 functions. |
|
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
1525 |
|
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
1526 @DOCSTRING(gcbo) |
|
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
1527 |
|
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
1528 @DOCSTRING(gcbf) |
|
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
1529 |
|
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
1530 Callbacks can equally be added to properties with the @code{addlistener} |
|
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
1531 function described below. |
|
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
1532 |
|
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
1533 @node Object Groups |
|
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
1534 @subsection Object Groups |
| 8071 | 1535 @cindex object groups |
|
8056
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
1536 |
|
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
1537 A number of Octave high level plot functions return groups of other |
|
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
1538 graphics objects or they return graphics objects that are have their |
|
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
1539 properties linked in such a way that changes to one of the properties |
|
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
1540 results in changes in the others. A graphic object that groups other |
|
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
1541 objects is an @code{hggroup} |
|
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
1542 |
|
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
1543 @DOCSTRING(hggroup) |
|
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
1544 |
|
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
1545 For example a simple use of a @code{hggroup} might be |
|
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
1546 |
|
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
1547 @example |
|
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
1548 @group |
|
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
1549 x = 0:0.1:10; |
|
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
1550 hg = hggroup (); |
|
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
1551 plot (x, sin (x), "color", [1, 0, 0], "parent", hg); |
|
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
1552 hold on |
|
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
1553 plot (x, cos (x), "color", [0, 1, 0], "parent", hg); |
|
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
1554 set (hg, "visible", "off"); |
|
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
1555 @end group |
|
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
1556 @end example |
|
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
1557 |
|
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
1558 @noindent |
|
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
1559 which groups the two plots into a single object and contols their |
|
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
1560 visiblity directly. The default properties of an @code{hggroup} are |
|
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
1561 the same as the set of common properties for the other graphics |
|
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
1562 objects. Additional properties can be added with the @code{addproperty} |
|
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
1563 function. |
|
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
1564 |
|
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
1565 @DOCSTRING(addproperty) |
|
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
1566 |
|
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
1567 Once a property in added to an @code{hggroup}, it is not linked to any |
|
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
1568 other property of either the children of the group, or any other |
|
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
1569 graphics object. Add so to control the way in which this newly added |
|
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
1570 property is used, the @code{addlistener} function is used to define a |
|
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
1571 callback function that is executed when the property is altered. |
|
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
1572 |
|
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
1573 @DOCSTRING(addlistener) |
|
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
1574 |
|
8817
03b7f618ab3d
include docstrings for new functions in the manual
John W. Eaton <jwe@octave.org>
parents:
8519
diff
changeset
|
1575 @DOCSTRING(dellistener) |
|
03b7f618ab3d
include docstrings for new functions in the manual
John W. Eaton <jwe@octave.org>
parents:
8519
diff
changeset
|
1576 |
|
8056
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
1577 An example of the use of these two functions might be |
|
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
1578 |
|
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
1579 @example |
|
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
1580 @group |
|
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
1581 x = 0:0.1:10; |
|
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
1582 hg = hggroup (); |
|
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
1583 h = plot (x, sin (x), "color", [1, 0, 0], "parent", hg); |
|
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
1584 addproperty ("linestyle", hg, "linelinestyle", get (h, "linestyle")); |
|
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
1585 addlistener (hg, "linestyle", @@update_props); |
|
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
1586 hold on |
|
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
1587 plot (x, cos (x), "color", [0, 1, 0], "parent", hg); |
|
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
1588 |
|
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
1589 function update_props (h, d) |
|
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
1590 set (get (h, "children"), "linestyle", get (h, "linestyle")); |
|
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
1591 endfunction |
|
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
1592 @end group |
|
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
1593 @end example |
|
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
1594 |
|
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
1595 @noindent |
|
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
1596 that adds a @code{linestyle} property to the @code{hggroup} and |
|
8070
3b53b25e2550
Add data sources and line series
David Bateman <dbateman@free.fr>
parents:
8057
diff
changeset
|
1597 propagating any changes its its value to the children of the group. The |
|
3b53b25e2550
Add data sources and line series
David Bateman <dbateman@free.fr>
parents:
8057
diff
changeset
|
1598 @code{linkprop} function can be used to simplify the above to be |
|
3b53b25e2550
Add data sources and line series
David Bateman <dbateman@free.fr>
parents:
8057
diff
changeset
|
1599 |
|
3b53b25e2550
Add data sources and line series
David Bateman <dbateman@free.fr>
parents:
8057
diff
changeset
|
1600 @example |
|
3b53b25e2550
Add data sources and line series
David Bateman <dbateman@free.fr>
parents:
8057
diff
changeset
|
1601 @group |
|
3b53b25e2550
Add data sources and line series
David Bateman <dbateman@free.fr>
parents:
8057
diff
changeset
|
1602 x = 0:0.1:10; |
|
3b53b25e2550
Add data sources and line series
David Bateman <dbateman@free.fr>
parents:
8057
diff
changeset
|
1603 hg = hggroup (); |
|
3b53b25e2550
Add data sources and line series
David Bateman <dbateman@free.fr>
parents:
8057
diff
changeset
|
1604 h1 = plot (x, sin (x), "color", [1, 0, 0], "parent", hg); |
|
3b53b25e2550
Add data sources and line series
David Bateman <dbateman@free.fr>
parents:
8057
diff
changeset
|
1605 addproperty ("linestyle", hg, "linelinestyle", get (h, "linestyle")); |
|
3b53b25e2550
Add data sources and line series
David Bateman <dbateman@free.fr>
parents:
8057
diff
changeset
|
1606 hold on |
|
3b53b25e2550
Add data sources and line series
David Bateman <dbateman@free.fr>
parents:
8057
diff
changeset
|
1607 h2 = plot (x, cos (x), "color", [0, 1, 0], "parent", hg); |
|
3b53b25e2550
Add data sources and line series
David Bateman <dbateman@free.fr>
parents:
8057
diff
changeset
|
1608 hlink = linkprop ([hg, h1, h2], "color"); |
|
3b53b25e2550
Add data sources and line series
David Bateman <dbateman@free.fr>
parents:
8057
diff
changeset
|
1609 @end group |
|
3b53b25e2550
Add data sources and line series
David Bateman <dbateman@free.fr>
parents:
8057
diff
changeset
|
1610 @end example |
|
3b53b25e2550
Add data sources and line series
David Bateman <dbateman@free.fr>
parents:
8057
diff
changeset
|
1611 |
|
3b53b25e2550
Add data sources and line series
David Bateman <dbateman@free.fr>
parents:
8057
diff
changeset
|
1612 @DOCSTRING(linkprop) |
|
8056
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
1613 |
|
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
1614 These capabilities are used in a number of basic graphics objects. |
|
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
1615 The @code{hggroup} objects created by the functions of Octave contain |
|
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
1616 one or more graphics object and are used to: |
|
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
1617 |
|
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
1618 @itemize @bullet |
|
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
1619 @item group together multiple graphics objects, |
|
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
1620 @item create linked properties between different graphics objects, and |
|
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
1621 @item to hide the nominal user data, from the actual data of the objects. |
|
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
1622 @end itemize |
|
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
1623 |
|
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
1624 @noindent |
|
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
1625 For example the @code{stem} function creates a stem series where each |
|
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
1626 @code{hggroup} of the stem series contains two line objects representing |
|
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
1627 the body and head of the stem. The @code{ydata} property of the |
|
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
1628 @code{hggroup} of the stem series represents the head of the stem, |
|
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
1629 whereas the body of the stem is between the baseline and this value. For |
|
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
1630 example |
|
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
1631 |
|
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
1632 @example |
|
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
1633 @group |
|
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
1634 h = stem (1:4) |
|
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
1635 get (h, "xdata") |
|
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
1636 @result{} [ 1 2 3 4]' |
|
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
1637 get (get (h, "children")(1), "xdata") |
|
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
1638 @result{} [ 1 1 NaN 2 2 NaN 3 3 NaN 4 4 NaN]' |
|
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
1639 @end group |
|
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
1640 @end example |
|
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
1641 |
|
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
1642 @noindent |
|
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
1643 shows the the difference between the @code{xdata} of the @code{hggroup} |
|
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
1644 of a stem series object and the underlying line. |
|
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
1645 |
|
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
1646 The basic properties of such group objects is that they consist of one |
|
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
1647 or more linked @code{hggroup}, and that changes in certain properties of |
|
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
1648 these groups are propagated to other members of the group. Whereas, |
|
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
1649 certain properties of the members of the group only apply to the current |
|
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
1650 member. |
|
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
1651 |
|
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
1652 In addition the members of the group can also be linked to other |
|
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
1653 graphics objects through callback functions. For example the baseline of |
|
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
1654 the @code{bar} or @code{stem} functions is a line object, whose length |
|
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
1655 and position are automatically adjusted, based on changes to the |
|
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
1656 corresponding hggroup elements. |
|
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
1657 |
|
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
1658 @menu |
|
8070
3b53b25e2550
Add data sources and line series
David Bateman <dbateman@free.fr>
parents:
8057
diff
changeset
|
1659 * Data sources in object groups:: |
|
8056
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
1660 * Area series:: |
|
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
1661 * Bar series:: |
|
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
1662 * Contour groups:: |
|
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
1663 * Error bar series:: |
|
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
1664 * Line series:: |
|
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
1665 * Quiver group:: |
|
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
1666 * Scatter group:: |
|
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
1667 * Stair group:: |
|
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
1668 * Stem Series:: |
|
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
1669 * Surface group:: |
|
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
1670 @end menu |
|
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
1671 |
|
8070
3b53b25e2550
Add data sources and line series
David Bateman <dbateman@free.fr>
parents:
8057
diff
changeset
|
1672 @node Data sources in object groups |
|
3b53b25e2550
Add data sources and line series
David Bateman <dbateman@free.fr>
parents:
8057
diff
changeset
|
1673 @subsubsection Data sources in object groups |
| 8071 | 1674 @cindex data sources in object groups |
|
8070
3b53b25e2550
Add data sources and line series
David Bateman <dbateman@free.fr>
parents:
8057
diff
changeset
|
1675 |
|
3b53b25e2550
Add data sources and line series
David Bateman <dbateman@free.fr>
parents:
8057
diff
changeset
|
1676 All of the group objects contain data source parameters. There are |
|
3b53b25e2550
Add data sources and line series
David Bateman <dbateman@free.fr>
parents:
8057
diff
changeset
|
1677 string parameters that contain an expression that is evaluated to update |
|
3b53b25e2550
Add data sources and line series
David Bateman <dbateman@free.fr>
parents:
8057
diff
changeset
|
1678 the relevant data property of the group when the @code{refreshdata} |
|
3b53b25e2550
Add data sources and line series
David Bateman <dbateman@free.fr>
parents:
8057
diff
changeset
|
1679 function is called. |
|
3b53b25e2550
Add data sources and line series
David Bateman <dbateman@free.fr>
parents:
8057
diff
changeset
|
1680 |
|
3b53b25e2550
Add data sources and line series
David Bateman <dbateman@free.fr>
parents:
8057
diff
changeset
|
1681 @DOCSTRING(refreshdata) |
|
3b53b25e2550
Add data sources and line series
David Bateman <dbateman@free.fr>
parents:
8057
diff
changeset
|
1682 |
|
8286
6f2d95255911
fix @seealso references to point to existing anchors
Thorsten Meyer <thorsten.meyier@gmx.de>
parents:
8261
diff
changeset
|
1683 @anchor{doc-linkdata} |
|
8070
3b53b25e2550
Add data sources and line series
David Bateman <dbateman@free.fr>
parents:
8057
diff
changeset
|
1684 @c add the description of the linkdata function here when it is written |
|
8286
6f2d95255911
fix @seealso references to point to existing anchors
Thorsten Meyer <thorsten.meyier@gmx.de>
parents:
8261
diff
changeset
|
1685 @c remove the explicit anchor when you add the corresponding @DOCSTRING |
|
6f2d95255911
fix @seealso references to point to existing anchors
Thorsten Meyer <thorsten.meyier@gmx.de>
parents:
8261
diff
changeset
|
1686 @c command |
|
8070
3b53b25e2550
Add data sources and line series
David Bateman <dbateman@free.fr>
parents:
8057
diff
changeset
|
1687 |
|
8056
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
1688 @node Area series |
|
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
1689 @subsubsection Area series |
| 8071 | 1690 @cindex series objects |
| 1691 @cindex area series | |
|
8056
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
1692 |
|
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
1693 Area series objects are created by the @code{area} function. Each of the |
|
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
1694 @code{hggroup} elements contains a single patch object. The properties |
|
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
1695 of the area series are |
|
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
1696 |
|
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
1697 @table @code |
|
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
1698 @item basevalue |
|
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
1699 The value where the base of the area plot is drawn. |
|
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
1700 |
|
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
1701 @item linewidth |
|
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
1702 @itemx linestyle |
|
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
1703 The line width and style of the edge of the patch objects making up the |
|
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
1704 areas. @xref{Line Styles}. |
|
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
1705 |
|
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
1706 @item edgecolor |
|
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
1707 @itemx facecolor |
|
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
1708 The line and fill color of the patch objects making up the areas. @xref{Colors}. |
|
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
1709 |
|
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
1710 @item xdata |
|
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
1711 @itemx ydata |
|
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
1712 The x and y coordinates of the original columns of the data passed to |
|
8325
b93ac0586e4b
spelling corrections
Brian Gough<bjg@network-theory.co.uk>
parents:
8297
diff
changeset
|
1713 @code{area} prior to the cumulative summation used in the @code{area} |
|
8056
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
1714 function. |
|
8070
3b53b25e2550
Add data sources and line series
David Bateman <dbateman@free.fr>
parents:
8057
diff
changeset
|
1715 |
|
3b53b25e2550
Add data sources and line series
David Bateman <dbateman@free.fr>
parents:
8057
diff
changeset
|
1716 @item xdatasource |
|
3b53b25e2550
Add data sources and line series
David Bateman <dbateman@free.fr>
parents:
8057
diff
changeset
|
1717 @itemx ydatasource |
|
3b53b25e2550
Add data sources and line series
David Bateman <dbateman@free.fr>
parents:
8057
diff
changeset
|
1718 Data source variables. |
|
8056
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
1719 @end table |
|
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
1720 |
|
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
1721 @node Bar series |
|
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
1722 @subsubsection Bar series |
| 8071 | 1723 @cindex series objects |
| 1724 @cindex bar series | |
|
8056
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
1725 |
|
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
1726 Bar series objects are created by the @code{bar} or @code{barh} |
|
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
1727 functions. Each @code{hgrroup} element contains a single patch object. |
|
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
1728 The properties of the bar series are |
|
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
1729 |
|
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
1730 @table @code |
|
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
1731 @item showbaseline |
|
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
1732 @itemx baseline |
|
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
1733 @itemx basevalue |
|
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
1734 The property @code{showbaseline} flags whether the baseline of the bar |
|
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
1735 series is displayed (default is "on"). The handle of the graphics object |
|
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
1736 representing the baseline is given by the @code{baseline} property and |
|
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
1737 the y-value of the baseline by the @code{basevalue} property. |
|
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
1738 |
|
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
1739 Changes to any of these property are propagated to the other members of |
|
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
1740 the bar series and to the baseline itself. Equally changes in the |
|
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
1741 properties of the base line itself are propagated to the members of the |
|
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
1742 corresponding bar series. |
|
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
1743 |
|
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
1744 @item barwidth |
|
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
1745 @itemx barlayout |
|
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
1746 @itemx horizontal |
|
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
1747 The property @code{barwidth} is the width of the bar corresponding to |
|
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
1748 the @var{width} variable passed to @code{bar} or @var{barh}. Whether the |
|
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
1749 bar series is "grouped" or "stacked" is determined by the |
|
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
1750 @code{barlayout} property and whether the bars are horizontal or |
|
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
1751 vertical by the @code{horizontal} property. |
|
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
1752 |
|
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
1753 Changes to any of these property are propagated to the other members of |
|
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
1754 the bar series. |
|
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
1755 |
|
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
1756 @item linewidth |
|
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
1757 @itemx linestyle |
|
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
1758 The line width and style of the edge of the patch objects making up the |
|
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
1759 bars. @xref{Line Styles}. |
|
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
1760 |
|
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
1761 @item edgecolor |
|
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
1762 @itemx facecolor |
|
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
1763 The line and fill color of the patch objects making up the bars. @xref{Colors}. |
|
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
1764 |
|
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
1765 @item xdata |
|
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
1766 The nominal x positions of the bars. Changes in this property and |
|
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
1767 propagated to the other members of the bar series. |
|
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
1768 |
|
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
1769 @item ydata |
|
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
1770 The y value of the bars in the @code{hggroup}. |
|
8070
3b53b25e2550
Add data sources and line series
David Bateman <dbateman@free.fr>
parents:
8057
diff
changeset
|
1771 |
|
3b53b25e2550
Add data sources and line series
David Bateman <dbateman@free.fr>
parents:
8057
diff
changeset
|
1772 @item xdatasource |
|
3b53b25e2550
Add data sources and line series
David Bateman <dbateman@free.fr>
parents:
8057
diff
changeset
|
1773 @itemx ydatasource |
|
3b53b25e2550
Add data sources and line series
David Bateman <dbateman@free.fr>
parents:
8057
diff
changeset
|
1774 Data source variables. |
|
8056
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
1775 @end table |
|
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
1776 |
|
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
1777 @node Contour groups |
|
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
1778 @subsubsection Contour groups |
| 8071 | 1779 @cindex series objects |
| 1780 @cindex contour series | |
|
8056
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
1781 |
|
8289
ac7f334d9652
Add contour group objects and the clabel function
David Bateman <dbateman@free.fr>
parents:
8286
diff
changeset
|
1782 Contour group objects are created by the @code{contour}, @code{contourf} |
|
ac7f334d9652
Add contour group objects and the clabel function
David Bateman <dbateman@free.fr>
parents:
8286
diff
changeset
|
1783 and @code{contour3} functions. The are equally one of the handles returned |
|
ac7f334d9652
Add contour group objects and the clabel function
David Bateman <dbateman@free.fr>
parents:
8286
diff
changeset
|
1784 by the @code{surfc} and @code{meshc} functions. The properties of the contour |
|
ac7f334d9652
Add contour group objects and the clabel function
David Bateman <dbateman@free.fr>
parents:
8286
diff
changeset
|
1785 group are |
|
ac7f334d9652
Add contour group objects and the clabel function
David Bateman <dbateman@free.fr>
parents:
8286
diff
changeset
|
1786 |
|
ac7f334d9652
Add contour group objects and the clabel function
David Bateman <dbateman@free.fr>
parents:
8286
diff
changeset
|
1787 @table @code |
|
ac7f334d9652
Add contour group objects and the clabel function
David Bateman <dbateman@free.fr>
parents:
8286
diff
changeset
|
1788 @item contourmatrix |
|
ac7f334d9652
Add contour group objects and the clabel function
David Bateman <dbateman@free.fr>
parents:
8286
diff
changeset
|
1789 A read only property that contains the data return by @code{contourc} used to |
|
ac7f334d9652
Add contour group objects and the clabel function
David Bateman <dbateman@free.fr>
parents:
8286
diff
changeset
|
1790 create the contours of the plot. |
|
ac7f334d9652
Add contour group objects and the clabel function
David Bateman <dbateman@free.fr>
parents:
8286
diff
changeset
|
1791 |
|
ac7f334d9652
Add contour group objects and the clabel function
David Bateman <dbateman@free.fr>
parents:
8286
diff
changeset
|
1792 @item fill |
|
ac7f334d9652
Add contour group objects and the clabel function
David Bateman <dbateman@free.fr>
parents:
8286
diff
changeset
|
1793 A radio property that can have the values "on" or "off" that flags whether the |
|
ac7f334d9652
Add contour group objects and the clabel function
David Bateman <dbateman@free.fr>
parents:
8286
diff
changeset
|
1794 contours to plot are to be filled. |
|
ac7f334d9652
Add contour group objects and the clabel function
David Bateman <dbateman@free.fr>
parents:
8286
diff
changeset
|
1795 |
|
ac7f334d9652
Add contour group objects and the clabel function
David Bateman <dbateman@free.fr>
parents:
8286
diff
changeset
|
1796 @item zlevelmode |
|
ac7f334d9652
Add contour group objects and the clabel function
David Bateman <dbateman@free.fr>
parents:
8286
diff
changeset
|
1797 @itemx zlevel |
|
ac7f334d9652
Add contour group objects and the clabel function
David Bateman <dbateman@free.fr>
parents:
8286
diff
changeset
|
1798 The radio property @code{zlevelmode} can have the values "none", "auto" or |
|
ac7f334d9652
Add contour group objects and the clabel function
David Bateman <dbateman@free.fr>
parents:
8286
diff
changeset
|
1799 "manual". When its value is "none" there is no z component to the plotted |
|
ac7f334d9652
Add contour group objects and the clabel function
David Bateman <dbateman@free.fr>
parents:
8286
diff
changeset
|
1800 contours. When its value is "auto" the z value of the plotted contours is |
|
ac7f334d9652
Add contour group objects and the clabel function
David Bateman <dbateman@free.fr>
parents:
8286
diff
changeset
|
1801 at the same value as the contour itself. If the value is "manual", then the |
|
ac7f334d9652
Add contour group objects and the clabel function
David Bateman <dbateman@free.fr>
parents:
8286
diff
changeset
|
1802 z value at which to plot the contour is determined by the @code{zlevel} |
|
ac7f334d9652
Add contour group objects and the clabel function
David Bateman <dbateman@free.fr>
parents:
8286
diff
changeset
|
1803 property. |
|
ac7f334d9652
Add contour group objects and the clabel function
David Bateman <dbateman@free.fr>
parents:
8286
diff
changeset
|
1804 |
|
ac7f334d9652
Add contour group objects and the clabel function
David Bateman <dbateman@free.fr>
parents:
8286
diff
changeset
|
1805 @item levellistmode |
|
ac7f334d9652
Add contour group objects and the clabel function
David Bateman <dbateman@free.fr>
parents:
8286
diff
changeset
|
1806 @itemx levellist |
|
ac7f334d9652
Add contour group objects and the clabel function
David Bateman <dbateman@free.fr>
parents:
8286
diff
changeset
|
1807 @itemx levelstepmode |
|
ac7f334d9652
Add contour group objects and the clabel function
David Bateman <dbateman@free.fr>
parents:
8286
diff
changeset
|
1808 @itemx levelstep |
|
ac7f334d9652
Add contour group objects and the clabel function
David Bateman <dbateman@free.fr>
parents:
8286
diff
changeset
|
1809 If @code{levellistmode} is "manual", then the levels at whch to plot the |
|
ac7f334d9652
Add contour group objects and the clabel function
David Bateman <dbateman@free.fr>
parents:
8286
diff
changeset
|
1810 contours is determined by @code{levellist}. If @code{levellistmode} is |
|
ac7f334d9652
Add contour group objects and the clabel function
David Bateman <dbateman@free.fr>
parents:
8286
diff
changeset
|
1811 set to "auto", then the distance between contours is determined by |
|
ac7f334d9652
Add contour group objects and the clabel function
David Bateman <dbateman@free.fr>
parents:
8286
diff
changeset
|
1812 @code{levelstep}. If both @code{levellistmode} and @code{levelstepmode} |
|
ac7f334d9652
Add contour group objects and the clabel function
David Bateman <dbateman@free.fr>
parents:
8286
diff
changeset
|
1813 are set to "auto", then there are assumed to be 10 equal spaced contours. |
|
ac7f334d9652
Add contour group objects and the clabel function
David Bateman <dbateman@free.fr>
parents:
8286
diff
changeset
|
1814 |
|
ac7f334d9652
Add contour group objects and the clabel function
David Bateman <dbateman@free.fr>
parents:
8286
diff
changeset
|
1815 @item textlistmode |
|
ac7f334d9652
Add contour group objects and the clabel function
David Bateman <dbateman@free.fr>
parents:
8286
diff
changeset
|
1816 @itemx textlist |
|
ac7f334d9652
Add contour group objects and the clabel function
David Bateman <dbateman@free.fr>
parents:
8286
diff
changeset
|
1817 @itemx textstepmode |
|
ac7f334d9652
Add contour group objects and the clabel function
David Bateman <dbateman@free.fr>
parents:
8286
diff
changeset
|
1818 @itemx textstep |
|
ac7f334d9652
Add contour group objects and the clabel function
David Bateman <dbateman@free.fr>
parents:
8286
diff
changeset
|
1819 If @code{textlistmode} is "manual", then the labelled contours |
|
ac7f334d9652
Add contour group objects and the clabel function
David Bateman <dbateman@free.fr>
parents:
8286
diff
changeset
|
1820 is determined by @code{textlist}. If @code{textlistmode} is set to |
|
ac7f334d9652
Add contour group objects and the clabel function
David Bateman <dbateman@free.fr>
parents:
8286
diff
changeset
|
1821 "auto", then the distance between labelled contours is determined by |
|
ac7f334d9652
Add contour group objects and the clabel function
David Bateman <dbateman@free.fr>
parents:
8286
diff
changeset
|
1822 @code{textstep}. If both @code{textlistmode} and @code{textstepmode} |
|
ac7f334d9652
Add contour group objects and the clabel function
David Bateman <dbateman@free.fr>
parents:
8286
diff
changeset
|
1823 are set to "auto", then there are assumed to be 10 equal spaced |
|
ac7f334d9652
Add contour group objects and the clabel function
David Bateman <dbateman@free.fr>
parents:
8286
diff
changeset
|
1824 labelled contours. |
|
ac7f334d9652
Add contour group objects and the clabel function
David Bateman <dbateman@free.fr>
parents:
8286
diff
changeset
|
1825 |
|
ac7f334d9652
Add contour group objects and the clabel function
David Bateman <dbateman@free.fr>
parents:
8286
diff
changeset
|
1826 @item showtext |
|
ac7f334d9652
Add contour group objects and the clabel function
David Bateman <dbateman@free.fr>
parents:
8286
diff
changeset
|
1827 Flag whether the contour labels are shown or not. |
|
ac7f334d9652
Add contour group objects and the clabel function
David Bateman <dbateman@free.fr>
parents:
8286
diff
changeset
|
1828 |
|
ac7f334d9652
Add contour group objects and the clabel function
David Bateman <dbateman@free.fr>
parents:
8286
diff
changeset
|
1829 @item labelspacing |
|
ac7f334d9652
Add contour group objects and the clabel function
David Bateman <dbateman@free.fr>
parents:
8286
diff
changeset
|
1830 The distance between labels on a single contour in points. |
|
ac7f334d9652
Add contour group objects and the clabel function
David Bateman <dbateman@free.fr>
parents:
8286
diff
changeset
|
1831 |
|
ac7f334d9652
Add contour group objects and the clabel function
David Bateman <dbateman@free.fr>
parents:
8286
diff
changeset
|
1832 @item linewidth |
|
ac7f334d9652
Add contour group objects and the clabel function
David Bateman <dbateman@free.fr>
parents:
8286
diff
changeset
|
1833 @item linestyle |
|
ac7f334d9652
Add contour group objects and the clabel function
David Bateman <dbateman@free.fr>
parents:
8286
diff
changeset
|
1834 @item linecolor |
|
ac7f334d9652
Add contour group objects and the clabel function
David Bateman <dbateman@free.fr>
parents:
8286
diff
changeset
|
1835 The properties of the contour lines. The properties @code{linewidth} and |
|
ac7f334d9652
Add contour group objects and the clabel function
David Bateman <dbateman@free.fr>
parents:
8286
diff
changeset
|
1836 @code{linestyle} are similar to the correponding properties for lines. The |
| 8297 | 1837 property @code{linecolor} is a color property (@pxref{Colors}), that can also |
|
8289
ac7f334d9652
Add contour group objects and the clabel function
David Bateman <dbateman@free.fr>
parents:
8286
diff
changeset
|
1838 have the values of "none" or "auto". If @code{linecolor} is "none", then no |
|
ac7f334d9652
Add contour group objects and the clabel function
David Bateman <dbateman@free.fr>
parents:
8286
diff
changeset
|
1839 contour line is drawn. If @code{linecolor} is "auto" then the line color is |
|
ac7f334d9652
Add contour group objects and the clabel function
David Bateman <dbateman@free.fr>
parents:
8286
diff
changeset
|
1840 determined by the colormap. |
|
ac7f334d9652
Add contour group objects and the clabel function
David Bateman <dbateman@free.fr>
parents:
8286
diff
changeset
|
1841 |
|
ac7f334d9652
Add contour group objects and the clabel function
David Bateman <dbateman@free.fr>
parents:
8286
diff
changeset
|
1842 @item xdata |
|
ac7f334d9652
Add contour group objects and the clabel function
David Bateman <dbateman@free.fr>
parents:
8286
diff
changeset
|
1843 @itemx ydata |
|
ac7f334d9652
Add contour group objects and the clabel function
David Bateman <dbateman@free.fr>
parents:
8286
diff
changeset
|
1844 @itemx zdata |
|
ac7f334d9652
Add contour group objects and the clabel function
David Bateman <dbateman@free.fr>
parents:
8286
diff
changeset
|
1845 The original x, y, and z data of the contour lines. |
|
ac7f334d9652
Add contour group objects and the clabel function
David Bateman <dbateman@free.fr>
parents:
8286
diff
changeset
|
1846 |
|
ac7f334d9652
Add contour group objects and the clabel function
David Bateman <dbateman@free.fr>
parents:
8286
diff
changeset
|
1847 @item xdatasource |
|
ac7f334d9652
Add contour group objects and the clabel function
David Bateman <dbateman@free.fr>
parents:
8286
diff
changeset
|
1848 @itemx ydatasource |
|
ac7f334d9652
Add contour group objects and the clabel function
David Bateman <dbateman@free.fr>
parents:
8286
diff
changeset
|
1849 @itemx zdatasource |
|
ac7f334d9652
Add contour group objects and the clabel function
David Bateman <dbateman@free.fr>
parents:
8286
diff
changeset
|
1850 Data source variables. |
|
ac7f334d9652
Add contour group objects and the clabel function
David Bateman <dbateman@free.fr>
parents:
8286
diff
changeset
|
1851 @end table |
|
8056
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
1852 |
|
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
1853 @node Error bar series |
|
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
1854 @subsubsection Error bar series |
| 8071 | 1855 @cindex series objects |
| 1856 @cindex error bar series | |
|
8056
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
1857 |
| 8258 | 1858 Error bar series are created by the @code{errorbar} function. Each |
| 1859 @code{hgrroup} element contains two line objects represnting the data and | |
| 1860 the errorbars separately. The properties of the error bar series are | |
| 1861 | |
| 1862 @table @code | |
| 1863 @item color | |
| 1864 The RGB color or color name of the line objects of the error bars. @xref{Colors}. | |
| 1865 | |
| 1866 @item linewidth | |
| 1867 @itemx linestyle | |
| 1868 The line width and style of the line objects of the error bars. @xref{Line Styles}. | |
| 1869 | |
| 1870 @item marker | |
| 1871 @itemx markeredgecolor | |
| 1872 @itemx markerfacecolor | |
| 1873 @itemx markersize | |
| 1874 The line and fill color of the markers on the error bars. @xref{Colors}. | |
| 1875 | |
| 1876 @item xdata | |
| 1877 @itemx ydata | |
| 1878 @itemx ldata | |
| 1879 @itemx udata | |
| 1880 @itemx xldata | |
| 1881 @itemx xudata | |
| 1882 The original x, y, l, u, xl, xu data of the error bars. | |
| 1883 | |
| 1884 @item xdatasource | |
| 1885 @itemx ydatasource | |
| 1886 @itemx ldatasource | |
| 1887 @itemx udatasource | |
| 1888 @itemx xldatasource | |
| 1889 @itemx xudatasource | |
| 1890 Data source variables. | |
| 1891 @end table | |
| 1892 | |
|
8056
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
1893 @node Line series |
|
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
1894 @subsubsection Line series |
| 8071 | 1895 @cindex series objects |
| 1896 @cindex line series | |
|
8056
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
1897 |
| 8257 | 1898 Line series objects are created by the @code{plot} and @code{plot3} |
| 1899 functions and are of the type @code{line}. The properties of the | |
| 1900 line series with the ability to add data sources. | |
|
8070
3b53b25e2550
Add data sources and line series
David Bateman <dbateman@free.fr>
parents:
8057
diff
changeset
|
1901 |
|
3b53b25e2550
Add data sources and line series
David Bateman <dbateman@free.fr>
parents:
8057
diff
changeset
|
1902 @table @code |
|
3b53b25e2550
Add data sources and line series
David Bateman <dbateman@free.fr>
parents:
8057
diff
changeset
|
1903 @item color |
| 8257 | 1904 The RGB color or color name of the line objects. @xref{Colors}. |
|
8070
3b53b25e2550
Add data sources and line series
David Bateman <dbateman@free.fr>
parents:
8057
diff
changeset
|
1905 |
|
3b53b25e2550
Add data sources and line series
David Bateman <dbateman@free.fr>
parents:
8057
diff
changeset
|
1906 @item linewidth |
|
3b53b25e2550
Add data sources and line series
David Bateman <dbateman@free.fr>
parents:
8057
diff
changeset
|
1907 @itemx linestyle |
| 8257 | 1908 The line width and style of the line objects. @xref{Line Styles}. |
|
8070
3b53b25e2550
Add data sources and line series
David Bateman <dbateman@free.fr>
parents:
8057
diff
changeset
|
1909 |
|
3b53b25e2550
Add data sources and line series
David Bateman <dbateman@free.fr>
parents:
8057
diff
changeset
|
1910 @item marker |
|
3b53b25e2550
Add data sources and line series
David Bateman <dbateman@free.fr>
parents:
8057
diff
changeset
|
1911 @itemx markeredgecolor |
|
3b53b25e2550
Add data sources and line series
David Bateman <dbateman@free.fr>
parents:
8057
diff
changeset
|
1912 @itemx markerfacecolor |
|
3b53b25e2550
Add data sources and line series
David Bateman <dbateman@free.fr>
parents:
8057
diff
changeset
|
1913 @itemx markersize |
| 8257 | 1914 The line and fill color of the markers. @xref{Colors}. |
|
8070
3b53b25e2550
Add data sources and line series
David Bateman <dbateman@free.fr>
parents:
8057
diff
changeset
|
1915 |
|
3b53b25e2550
Add data sources and line series
David Bateman <dbateman@free.fr>
parents:
8057
diff
changeset
|
1916 @item xdata |
|
3b53b25e2550
Add data sources and line series
David Bateman <dbateman@free.fr>
parents:
8057
diff
changeset
|
1917 @itemx ydata |
|
3b53b25e2550
Add data sources and line series
David Bateman <dbateman@free.fr>
parents:
8057
diff
changeset
|
1918 @itemx zdata |
| 8257 | 1919 The original x, y and z data. |
|
8070
3b53b25e2550
Add data sources and line series
David Bateman <dbateman@free.fr>
parents:
8057
diff
changeset
|
1920 |
|
3b53b25e2550
Add data sources and line series
David Bateman <dbateman@free.fr>
parents:
8057
diff
changeset
|
1921 @item xdatasource |
|
3b53b25e2550
Add data sources and line series
David Bateman <dbateman@free.fr>
parents:
8057
diff
changeset
|
1922 @itemx ydatasource |
|
3b53b25e2550
Add data sources and line series
David Bateman <dbateman@free.fr>
parents:
8057
diff
changeset
|
1923 @itemx zdatasource |
|
3b53b25e2550
Add data sources and line series
David Bateman <dbateman@free.fr>
parents:
8057
diff
changeset
|
1924 Data source variables. |
|
3b53b25e2550
Add data sources and line series
David Bateman <dbateman@free.fr>
parents:
8057
diff
changeset
|
1925 @end table |
|
8056
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
1926 |
|
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
1927 @node Quiver group |
|
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
1928 @subsubsection Quiver group |
| 8071 | 1929 @cindex group objects |
| 1930 @cindex quiver group | |
|
8056
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
1931 |
|
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
1932 Quiver series objects are created by the @code{quiver} or @code{quiver3} |
|
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
1933 functions. Each @code{hggroup} element of the series contains three line |
|
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
1934 objects as children representing the body and head of the arrow, |
|
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
1935 together with a marker as the point of original of the arrows. The |
|
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
1936 properties of the quiver series are |
|
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
1937 |
|
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
1938 @table @code |
|
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
1939 @item autoscale |
|
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
1940 @itemx autoscalefactor |
|
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
1941 Flag whether the length of the arrows is scaled or defined directly from |
|
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
1942 the @var{u}, @var{v} and @var{w} data. If the arrow length is falgged |
|
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
1943 as being scaled by the @code{autoscale} property, then the length of the |
|
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
1944 autoscaled arrow is controlled by the @code{autoscalefactor}. |
|
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
1945 |
|
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
1946 @item maxheadsize |
|
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
1947 This property controls the size of the head of the arrows in the quiver |
|
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
1948 series. The default value is 0.2. |
|
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
1949 |
|
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
1950 @item showarrowhead |
|
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
1951 Flag whether the arrow heads are displayed in the quiver plot. |
|
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
1952 |
|
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
1953 @item color |
|
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
1954 The RGB color or color name of the line objects of the quiver. @xref{Colors}. |
|
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
1955 |
|
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
1956 @item linewidth |
|
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
1957 @itemx linestyle |
|
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
1958 The line width and style of the line objects of the quiver. @xref{Line Styles}. |
|
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
1959 |
|
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
1960 @item marker |
|
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
1961 @itemx markerfacecolor |
|
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
1962 @itemx markersize |
|
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
1963 The line and fill color of the marker objects at the original of the |
|
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
1964 arrows. @xref{Colors}. |
|
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
1965 |
|
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
1966 @item xdata |
|
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
1967 @itemx ydata |
|
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
1968 @itemx zdata |
|
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
1969 The origins of the values of the vector field. |
|
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
1970 |
|
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
1971 @item udata |
|
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
1972 @itemx vdata |
|
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
1973 @itemx wdata |
|
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
1974 The values of the vector field to plot. |
|
8070
3b53b25e2550
Add data sources and line series
David Bateman <dbateman@free.fr>
parents:
8057
diff
changeset
|
1975 |
|
3b53b25e2550
Add data sources and line series
David Bateman <dbateman@free.fr>
parents:
8057
diff
changeset
|
1976 @item xdatasource |
|
3b53b25e2550
Add data sources and line series
David Bateman <dbateman@free.fr>
parents:
8057
diff
changeset
|
1977 @itemx ydatasource |
|
3b53b25e2550
Add data sources and line series
David Bateman <dbateman@free.fr>
parents:
8057
diff
changeset
|
1978 @itemx zdatasource |
|
3b53b25e2550
Add data sources and line series
David Bateman <dbateman@free.fr>
parents:
8057
diff
changeset
|
1979 @itemx udatasource |
|
3b53b25e2550
Add data sources and line series
David Bateman <dbateman@free.fr>
parents:
8057
diff
changeset
|
1980 @itemx vdatasource |
|
3b53b25e2550
Add data sources and line series
David Bateman <dbateman@free.fr>
parents:
8057
diff
changeset
|
1981 @itemx wdatasource |
|
3b53b25e2550
Add data sources and line series
David Bateman <dbateman@free.fr>
parents:
8057
diff
changeset
|
1982 Data source variables. |
|
8056
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
1983 @end table |
|
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
1984 |
|
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
1985 @node Scatter group |
|
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
1986 @subsubsection Scatter group |
| 8071 | 1987 @cindex group objects |
| 1988 @cindex scatter group | |
|
8056
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
1989 |
| 8257 | 1990 Scatter series objects are created by the @code{scatter} or @code{scatter3} |
| 1991 functions. A single hggroup element contains as many children as there are | |
| 1992 points in the scatter plot, with each child representing one of the points. | |
| 1993 The properties of the stem series are | |
| 1994 | |
| 1995 @table @code | |
| 1996 @item linewidth | |
| 1997 The line width of the line objects of the points. @xref{Line Styles}. | |
| 1998 | |
| 1999 @item marker | |
| 2000 @itemx markeredgecolor | |
| 2001 @itemx markerfacecolor | |
| 2002 The line and fill color of the markers of the points. @xref{Colors}. | |
| 2003 | |
| 2004 @item xdata | |
| 2005 @itemx ydata | |
| 2006 @itemx zdata | |
| 2007 The original x, y and z data of the stems. | |
| 2008 | |
| 2009 @item cdata | |
| 2010 The color data for the points of the plot. Each point can have a separate | |
| 2011 color, or a unique color can be specified. | |
| 2012 | |
| 2013 @item sizedata | |
| 2014 The size data for the points of the plot. Each point can its own size or a | |
| 2015 unique size can be specified. | |
| 2016 | |
| 2017 @item xdatasource | |
| 2018 @itemx ydatasource | |
| 2019 @itemx zdatasource | |
| 2020 @itemx cdatasource | |
| 2021 @itemx sizedatasource | |
| 2022 Data source variables. | |
| 2023 @end table | |
|
8056
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
2024 |
|
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
2025 @node Stair group |
|
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
2026 @subsubsection Stair group |
| 8071 | 2027 @cindex group objects |
| 2028 @cindex stair group | |
|
8056
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
2029 |
|
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
2030 Stair series objects are created by the @code{stair} function. Each |
|
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
2031 @code{hggroup} element of the series contains a single line object as a |
|
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
2032 child representing the stair. The properties of the stair series are |
|
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
2033 |
|
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
2034 @table @code |
|
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
2035 @item color |
|
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
2036 The RGB color or color name of the line objects of the stairs. @xref{Colors}. |
|
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
2037 |
|
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
2038 @item linewidth |
|
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
2039 @itemx linestyle |
|
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
2040 The line width and style of the line objects of the stairs. @xref{Line Styles}. |
|
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
2041 |
|
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
2042 @item marker |
|
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
2043 @itemx markeredgecolor |
|
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
2044 @itemx markerfacecolor |
|
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
2045 @itemx markersize |
|
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
2046 The line and fill color of the markers on the stairs. @xref{Colors}. |
|
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
2047 |
|
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
2048 @item xdata |
|
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
2049 @itemx ydata |
|
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
2050 The original x and y data of the stairs. |
|
8070
3b53b25e2550
Add data sources and line series
David Bateman <dbateman@free.fr>
parents:
8057
diff
changeset
|
2051 |
|
3b53b25e2550
Add data sources and line series
David Bateman <dbateman@free.fr>
parents:
8057
diff
changeset
|
2052 @item xdatasource |
|
3b53b25e2550
Add data sources and line series
David Bateman <dbateman@free.fr>
parents:
8057
diff
changeset
|
2053 @itemx ydatasource |
|
3b53b25e2550
Add data sources and line series
David Bateman <dbateman@free.fr>
parents:
8057
diff
changeset
|
2054 Data source variables. |
|
8056
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
2055 @end table |
|
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
2056 |
| 8073 | 2057 @node Stem Series |
| 2058 @subsubsection Stem Series | |
| 2059 @cindex series objects | |
| 2060 @cindex stem series | |
| 2061 | |
| 8257 | 2062 Stem series objects are created by the @code{stem} or @code{stem3} |
| 2063 functions. Each @code{hgrroup} element contains a single line object | |
| 2064 as a child respresenting the stems. The properties of the stem series | |
| 2065 are | |
| 2066 | |
| 2067 @table @code | |
| 2068 @item showbaseline | |
| 2069 @itemx baseline | |
| 2070 @itemx basevalue | |
| 2071 The property @code{showbaseline} flags whether the baseline of the | |
| 2072 stem series is displayed (default is "on"). The handle of the graphics | |
| 2073 object representing the baseline is given by the @code{baseline} | |
| 2074 property and the y-value (or z-value for @code{stem3}) of the baseline | |
| 2075 by the @code{basevalue} property. | |
| 2076 | |
| 2077 Changes to any of these property are propagated to the other members of | |
| 2078 the stem series and to the baseline itself. Equally changes in the | |
| 2079 properties of the base line itself are propagated to the members of the | |
| 2080 corresponding stem series. | |
| 2081 | |
| 2082 @item color | |
| 2083 The RGB color or color name of the line objects of the stems. @xref{Colors}. | |
| 2084 | |
| 2085 @item linewidth | |
| 2086 @itemx linestyle | |
| 2087 The line width and style of the line objects of the stems. @xref{Line Styles}. | |
| 2088 | |
| 2089 @item marker | |
| 2090 @itemx markeredgecolor | |
| 2091 @itemx markerfacecolor | |
| 2092 @itemx markersize | |
| 2093 The line and fill color of the markers on the stems. @xref{Colors}. | |
| 2094 | |
| 2095 @item xdata | |
| 2096 @itemx ydata | |
| 2097 @itemx zdata | |
| 2098 The original x, y and z data of the stems. | |
| 2099 | |
| 2100 @item xdatasource | |
| 2101 @itemx ydatasource | |
| 2102 @itemx zdatasource | |
| 2103 Data source variables. | |
| 2104 @end table | |
| 8073 | 2105 |
|
8056
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
2106 @node Surface group |
|
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
2107 @subsubsection Surface group |
| 8071 | 2108 @cindex group objects |
| 2109 @cindex surface group | |
|
8056
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
2110 |
| 8257 | 2111 Surface group objects are created by the @code{surf} or @code{mesh} |
| 2112 functions, but are equally one of the handles returned by the @code{surfc} | |
| 2113 or @code{meshc} functions. The surface group is of the type @code{surface}. | |
| 2114 | |
| 2115 The properties of the surface group are | |
| 2116 | |
| 2117 @table @code | |
| 2118 @item edgecolor | |
| 2119 @item facecolor | |
| 2120 The RGB color or color name of the edges or faces of the surface. @xref{Colors}. | |
| 2121 | |
| 2122 @item linewidth | |
| 2123 @itemx linestyle | |
| 2124 The line width and style of the lines on the surface. @xref{Line Styles}. | |
| 2125 | |
| 2126 @item marker | |
| 2127 @itemx markeredgecolor | |
| 2128 @itemx markerfacecolor | |
| 2129 @itemx markersize | |
| 2130 The line and fill color of the markers on the surface. @xref{Colors}. | |
| 2131 | |
| 2132 @item xdata | |
| 2133 @itemx ydata | |
| 2134 @itemx zdata | |
| 2135 @item cdata | |
| 2136 The original x, y, z and c data. | |
| 2137 | |
| 2138 @item xdatasource | |
| 2139 @itemx ydatasource | |
| 2140 @itemx zdatasource | |
| 2141 @itemx cdatasource | |
| 2142 Data source variables. | |
| 2143 @end table | |
|
8056
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
2144 |
|
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
2145 @node Graphics backends |
|
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
2146 @subsection Graphics backends |
| 8071 | 2147 @cindex graphics backends |
| 2148 @cindex backends, graphics | |
|
8056
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
2149 |
| 8519 | 2150 @DOCSTRING(backend) |
|
8070
3b53b25e2550
Add data sources and line series
David Bateman <dbateman@free.fr>
parents:
8057
diff
changeset
|
2151 |
|
8056
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
2152 @DOCSTRING(available_backends) |
|
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
2153 |
|
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
2154 @menu |
|
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
2155 * Interaction with gnuplot:: |
|
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
2156 @end menu |
|
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
2157 |
| 4167 | 2158 @node Interaction with gnuplot |
|
8056
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
2159 @subsubsection Interaction with @code{gnuplot} |
| 8071 | 2160 @cindex gnuplot interaction |
| 3428 | 2161 |
| 2162 @DOCSTRING(gnuplot_binary) |