Mercurial > hg > octave-nkf
annotate doc/interpreter/plot.txi @ 20772:bc6daa38ff50
eliminate more simple uses of error_state
* graphics.cc: Eliminate simple uses of error_state.
| author | John W. Eaton <jwe@octave.org> |
|---|---|
| date | Tue, 06 Oct 2015 14:47:41 -0400 |
| parents | 031e76c51242 |
| children | 3af34e1ef330 |
| rev | line source |
|---|---|
|
19898
4197fc428c7d
maint: Update copyright notices for 2015.
John W. Eaton <jwe@octave.org>
parents:
19794
diff
changeset
|
1 @c Copyright (C) 1996-2015 John W. Eaton |
| 7018 | 2 @c |
| 3 @c This file is part of Octave. | |
| 4 @c | |
| 5 @c Octave is free software; you can redistribute it and/or modify it | |
| 6 @c under the terms of the GNU General Public License as published by the | |
| 7 @c Free Software Foundation; either version 3 of the License, or (at | |
| 8 @c your option) any later version. | |
|
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
9 @c |
| 7018 | 10 @c Octave is distributed in the hope that it will be useful, but WITHOUT |
| 11 @c ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or | |
| 12 @c FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License | |
| 13 @c for more details. | |
|
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
14 @c |
| 7018 | 15 @c You should have received a copy of the GNU General Public License |
| 16 @c along with Octave; see the file COPYING. If not, see | |
| 17 @c <http://www.gnu.org/licenses/>. | |
| 3294 | 18 |
| 4167 | 19 @node Plotting |
| 3294 | 20 @chapter Plotting |
| 6888 | 21 @cindex plotting |
| 22 @cindex graphics | |
| 3294 | 23 |
| 24 @menu | |
|
17152
f2a8592b8fbd
doc: Shorten some long subsection names in Manual.
Rik <rik@octave.org>
parents:
17123
diff
changeset
|
25 * Introduction to Plotting:: |
|
f2a8592b8fbd
doc: Shorten some long subsection names in Manual.
Rik <rik@octave.org>
parents:
17123
diff
changeset
|
26 * High-Level Plotting:: |
|
f2a8592b8fbd
doc: Shorten some long subsection names in Manual.
Rik <rik@octave.org>
parents:
17123
diff
changeset
|
27 * Graphics Data Structures:: |
|
f2a8592b8fbd
doc: Shorten some long subsection names in Manual.
Rik <rik@octave.org>
parents:
17123
diff
changeset
|
28 * Advanced Plotting:: |
| 6888 | 29 @end menu |
| 30 | |
|
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
31 @node Introduction to Plotting |
|
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
32 @section Introduction to Plotting |
|
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
33 |
|
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
34 Earlier versions of Octave provided plotting through the use of |
|
9758
09da0bd91412
Periodic grammar check of Octave documentation files to ensure common format
Rik <rdrider0-list@yahoo.com>
parents:
9752
diff
changeset
|
35 gnuplot. This capability is still available. But, a newer plotting |
|
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
36 capability is provided by access to OpenGL@. Which plotting system |
|
17097
e7a059a9a644
doc: Use XREF as anchor prefix in documentation for clearer results in Info viewer.
Rik <rik@octave.org>
parents:
16923
diff
changeset
|
37 is used is controlled by the @code{graphics_toolkit} function. |
|
e7a059a9a644
doc: Use XREF as anchor prefix in documentation for clearer results in Info viewer.
Rik <rik@octave.org>
parents:
16923
diff
changeset
|
38 @xref{Graphics Toolkits}. |
|
11576
8ac9687dbe9f
rename backend to graphics_toolkit
John W. Eaton <jwe@octave.org>
parents:
11573
diff
changeset
|
39 |
|
8ac9687dbe9f
rename backend to graphics_toolkit
John W. Eaton <jwe@octave.org>
parents:
11573
diff
changeset
|
40 The function call @code{graphics_toolkit ("fltk")} selects the |
|
11591
1d13679b587e
Use @nospell macro on certain words in docstrings.
Rik <octave@nomad.inbox5.com>
parents:
11576
diff
changeset
|
41 FLTK/OpenGL system, and @code{graphics_toolkit ("gnuplot")} selects the |
|
11576
8ac9687dbe9f
rename backend to graphics_toolkit
John W. Eaton <jwe@octave.org>
parents:
11573
diff
changeset
|
42 gnuplot system. The two systems may be used selectively through the use |
|
8ac9687dbe9f
rename backend to graphics_toolkit
John W. Eaton <jwe@octave.org>
parents:
11573
diff
changeset
|
43 of the @code{graphics_toolkit} property of the graphics handle for each |
|
8ac9687dbe9f
rename backend to graphics_toolkit
John W. Eaton <jwe@octave.org>
parents:
11573
diff
changeset
|
44 figure. This is explained in @ref{Graphics Data Structures}. |
|
12577
562e40e3d5db
Add warning about single precision in FLTK.
Rik <octave@nomad.inbox5.com>
parents:
12529
diff
changeset
|
45 @strong{Caution:} The FLTK toolkit uses single precision variables internally |
|
562e40e3d5db
Add warning about single precision in FLTK.
Rik <octave@nomad.inbox5.com>
parents:
12529
diff
changeset
|
46 which limits the maximum value that can be displayed to approximately |
|
562e40e3d5db
Add warning about single precision in FLTK.
Rik <octave@nomad.inbox5.com>
parents:
12529
diff
changeset
|
47 @math{10^{38}}. If your data contains larger values you must use the gnuplot |
|
562e40e3d5db
Add warning about single precision in FLTK.
Rik <octave@nomad.inbox5.com>
parents:
12529
diff
changeset
|
48 toolkit which supports values up to @math{10^{308}}. |
|
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
49 |
|
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
50 @node High-Level Plotting |
|
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
51 @section High-Level Plotting |
|
18398
200851c87444
Edits to Manual and indicies
Michael Godfrey <michaeldgodfrey@gmail.com>
parents:
17957
diff
changeset
|
52 @cindex plotting, high-level |
|
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
53 |
|
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
54 Octave provides simple means to create many different types of two- and |
|
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
55 three-dimensional plots using high-level functions. |
|
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
56 |
|
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
57 If you need more detailed control, see @ref{Graphics Data Structures} |
|
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
58 and @ref{Advanced Plotting}. |
| 6888 | 59 |
| 60 @menu | |
|
17152
f2a8592b8fbd
doc: Shorten some long subsection names in Manual.
Rik <rik@octave.org>
parents:
17123
diff
changeset
|
61 * Two-Dimensional Plots:: |
|
f2a8592b8fbd
doc: Shorten some long subsection names in Manual.
Rik <rik@octave.org>
parents:
17123
diff
changeset
|
62 * Three-Dimensional Plots:: |
|
f2a8592b8fbd
doc: Shorten some long subsection names in Manual.
Rik <rik@octave.org>
parents:
17123
diff
changeset
|
63 * Plot Annotations:: |
|
f2a8592b8fbd
doc: Shorten some long subsection names in Manual.
Rik <rik@octave.org>
parents:
17123
diff
changeset
|
64 * Multiple Plots on One Page:: |
|
f2a8592b8fbd
doc: Shorten some long subsection names in Manual.
Rik <rik@octave.org>
parents:
17123
diff
changeset
|
65 * Multiple Plot Windows:: |
| 19273 | 66 * Manipulation of Plot Objects:: |
|
16096
9720ecf8d257
Fix additional warning associated with Texinfo 5.0 (bug #38392)
Rik <rik@octave.org>
parents:
16094
diff
changeset
|
67 * Manipulation of Plot Windows:: |
|
9720ecf8d257
Fix additional warning associated with Texinfo 5.0 (bug #38392)
Rik <rik@octave.org>
parents:
16094
diff
changeset
|
68 * Use of the @code{interpreter} Property:: |
|
17152
f2a8592b8fbd
doc: Shorten some long subsection names in Manual.
Rik <rik@octave.org>
parents:
17123
diff
changeset
|
69 * Printing and Saving Plots:: |
|
f2a8592b8fbd
doc: Shorten some long subsection names in Manual.
Rik <rik@octave.org>
parents:
17123
diff
changeset
|
70 * Interacting with Plots:: |
|
f2a8592b8fbd
doc: Shorten some long subsection names in Manual.
Rik <rik@octave.org>
parents:
17123
diff
changeset
|
71 * Test Plotting Functions:: |
| 3294 | 72 @end menu |
| 73 | |
| 6888 | 74 @node Two-Dimensional Plots |
| 75 @subsection Two-Dimensional Plots | |
| 76 | |
|
12526
f8ea3eabcb85
Add daspect, pbaspect functions to documentation.
Rik <octave@nomad.inbox5.com>
parents:
12525
diff
changeset
|
77 @menu |
|
17152
f2a8592b8fbd
doc: Shorten some long subsection names in Manual.
Rik <rik@octave.org>
parents:
17123
diff
changeset
|
78 * Axis Configuration:: |
|
f2a8592b8fbd
doc: Shorten some long subsection names in Manual.
Rik <rik@octave.org>
parents:
17123
diff
changeset
|
79 * Two-dimensional Function Plotting:: |
|
f2a8592b8fbd
doc: Shorten some long subsection names in Manual.
Rik <rik@octave.org>
parents:
17123
diff
changeset
|
80 * Two-dimensional Geometric Shapes:: |
|
12526
f8ea3eabcb85
Add daspect, pbaspect functions to documentation.
Rik <octave@nomad.inbox5.com>
parents:
12525
diff
changeset
|
81 @end menu |
|
f8ea3eabcb85
Add daspect, pbaspect functions to documentation.
Rik <octave@nomad.inbox5.com>
parents:
12525
diff
changeset
|
82 |
| 6888 | 83 The @code{plot} function allows you to create simple x-y plots with |
| 84 linear axes. For example, | |
| 3294 | 85 |
| 6888 | 86 @example |
| 87 @group | |
| 88 x = -10:0.1:10; | |
| 89 plot (x, sin (x)); | |
| 90 @end group | |
| 91 @end example | |
| 92 | |
| 93 @noindent | |
| 6899 | 94 displays a sine wave shown in @ref{fig:plot}. On most systems, this |
| 6888 | 95 command will open a separate plot window to display the graph. |
| 5134 | 96 |
| 6888 | 97 @float Figure,fig:plot |
|
9088
77e71f3da3d6
Fix documentation image printing under new development code
Rik <rdrider0-list@yahoo.com>
parents:
9040
diff
changeset
|
98 @center @image{plot,4in} |
| 6888 | 99 @caption{Simple Two-Dimensional Plot.} |
| 100 @end float | |
| 101 | |
| 5134 | 102 @DOCSTRING(plot) |
| 103 | |
|
8817
03b7f618ab3d
include docstrings for new functions in the manual
John W. Eaton <jwe@octave.org>
parents:
8519
diff
changeset
|
104 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
|
105 independent y axes. |
|
03b7f618ab3d
include docstrings for new functions in the manual
John W. Eaton <jwe@octave.org>
parents:
8519
diff
changeset
|
106 |
|
03b7f618ab3d
include docstrings for new functions in the manual
John W. Eaton <jwe@octave.org>
parents:
8519
diff
changeset
|
107 @DOCSTRING(plotyy) |
|
03b7f618ab3d
include docstrings for new functions in the manual
John W. Eaton <jwe@octave.org>
parents:
8519
diff
changeset
|
108 |
| 6888 | 109 The functions @code{semilogx}, @code{semilogy}, and @code{loglog} are |
| 110 similar to the @code{plot} function, but produce plots in which one or | |
| 111 both of the axes use log scales. | |
| 112 | |
| 113 @DOCSTRING(semilogx) | |
| 6502 | 114 |
| 6888 | 115 @DOCSTRING(semilogy) |
| 6502 | 116 |
| 6888 | 117 @DOCSTRING(loglog) |
| 118 | |
| 119 The functions @code{bar}, @code{barh}, @code{stairs}, and @code{stem} | |
| 120 are useful for displaying discrete data. For example, | |
| 5134 | 121 |
| 6888 | 122 @example |
| 123 @group | |
| 124 hist (randn (10000, 1), 30); | |
| 125 @end group | |
| 126 @end example | |
| 5134 | 127 |
| 6888 | 128 @noindent |
| 129 produces the histogram of 10,000 normally distributed random numbers | |
| 6899 | 130 shown in @ref{fig:hist}. |
| 5134 | 131 |
| 6888 | 132 @float Figure,fig:hist |
|
9088
77e71f3da3d6
Fix documentation image printing under new development code
Rik <rdrider0-list@yahoo.com>
parents:
9040
diff
changeset
|
133 @center @image{hist,4in} |
| 6888 | 134 @caption{Histogram.} |
| 135 @end float | |
| 5134 | 136 |
| 137 @DOCSTRING(bar) | |
| 138 | |
| 6877 | 139 @DOCSTRING(barh) |
| 140 | |
| 6888 | 141 @DOCSTRING(hist) |
| 142 | |
|
16008
6f567476e6f0
Add stemleaf and printd to the manual
Michael Godfrey <michaeldgodfrey@gmail.com>
parents:
14856
diff
changeset
|
143 @DOCSTRING(stemleaf) |
|
6f567476e6f0
Add stemleaf and printd to the manual
Michael Godfrey <michaeldgodfrey@gmail.com>
parents:
14856
diff
changeset
|
144 |
|
6f567476e6f0
Add stemleaf and printd to the manual
Michael Godfrey <michaeldgodfrey@gmail.com>
parents:
14856
diff
changeset
|
145 @DOCSTRING(printd) |
|
6f567476e6f0
Add stemleaf and printd to the manual
Michael Godfrey <michaeldgodfrey@gmail.com>
parents:
14856
diff
changeset
|
146 |
| 6888 | 147 @DOCSTRING(stairs) |
| 148 | |
| 149 @DOCSTRING(stem) | |
| 150 | |
|
8817
03b7f618ab3d
include docstrings for new functions in the manual
John W. Eaton <jwe@octave.org>
parents:
8519
diff
changeset
|
151 @DOCSTRING(stem3) |
|
03b7f618ab3d
include docstrings for new functions in the manual
John W. Eaton <jwe@octave.org>
parents:
8519
diff
changeset
|
152 |
|
03b7f618ab3d
include docstrings for new functions in the manual
John W. Eaton <jwe@octave.org>
parents:
8519
diff
changeset
|
153 @DOCSTRING(scatter) |
|
03b7f618ab3d
include docstrings for new functions in the manual
John W. Eaton <jwe@octave.org>
parents:
8519
diff
changeset
|
154 |
|
03b7f618ab3d
include docstrings for new functions in the manual
John W. Eaton <jwe@octave.org>
parents:
8519
diff
changeset
|
155 @DOCSTRING(plotmatrix) |
|
03b7f618ab3d
include docstrings for new functions in the manual
John W. Eaton <jwe@octave.org>
parents:
8519
diff
changeset
|
156 |
|
03b7f618ab3d
include docstrings for new functions in the manual
John W. Eaton <jwe@octave.org>
parents:
8519
diff
changeset
|
157 @DOCSTRING(pareto) |
|
03b7f618ab3d
include docstrings for new functions in the manual
John W. Eaton <jwe@octave.org>
parents:
8519
diff
changeset
|
158 |
|
03b7f618ab3d
include docstrings for new functions in the manual
John W. Eaton <jwe@octave.org>
parents:
8519
diff
changeset
|
159 @DOCSTRING(rose) |
|
03b7f618ab3d
include docstrings for new functions in the manual
John W. Eaton <jwe@octave.org>
parents:
8519
diff
changeset
|
160 |
| 7981 | 161 The @code{contour}, @code{contourf} and @code{contourc} functions |
|
9209
923c7cb7f13f
Simplify TeXinfo files by eliminating redundant @iftex followed by @tex construction.
Rik <rdrider0-list@yahoo.com>
parents:
9088
diff
changeset
|
162 produce two-dimensional contour plots from three-dimensional data. |
| 6888 | 163 |
| 5134 | 164 @DOCSTRING(contour) |
| 165 | |
| 7981 | 166 @DOCSTRING(contourf) |
| 167 | |
| 6502 | 168 @DOCSTRING(contourc) |
| 169 | |
|
8817
03b7f618ab3d
include docstrings for new functions in the manual
John W. Eaton <jwe@octave.org>
parents:
8519
diff
changeset
|
170 @DOCSTRING(contour3) |
|
03b7f618ab3d
include docstrings for new functions in the manual
John W. Eaton <jwe@octave.org>
parents:
8519
diff
changeset
|
171 |
| 6888 | 172 The @code{errorbar}, @code{semilogxerr}, @code{semilogyerr}, and |
|
8347
fa78cb8d8a5c
corrections for typos
Brian Gough<bjg@network-theory.co.uk>
parents:
8325
diff
changeset
|
173 @code{loglogerr} functions produce plots with error bar markers. For |
| 6888 | 174 example, |
| 6877 | 175 |
| 6888 | 176 @example |
|
9088
77e71f3da3d6
Fix documentation image printing under new development code
Rik <rdrider0-list@yahoo.com>
parents:
9040
diff
changeset
|
177 @group |
| 6888 | 178 x = 0:0.1:10; |
| 179 y = sin (x); | |
| 180 yp = 0.1 .* randn (size (x)); | |
| 181 ym = -0.1 .* randn (size (x)); | |
| 182 errorbar (x, sin (x), ym, yp); | |
|
9088
77e71f3da3d6
Fix documentation image printing under new development code
Rik <rdrider0-list@yahoo.com>
parents:
9040
diff
changeset
|
183 @end group |
| 6888 | 184 @end example |
| 5134 | 185 |
| 6888 | 186 @noindent |
| 6899 | 187 produces the figure shown in @ref{fig:errorbar}. |
| 6502 | 188 |
| 6888 | 189 @float Figure,fig:errorbar |
|
9088
77e71f3da3d6
Fix documentation image printing under new development code
Rik <rdrider0-list@yahoo.com>
parents:
9040
diff
changeset
|
190 @center @image{errorbar,4in} |
| 6888 | 191 @caption{Errorbar plot.} |
| 192 @end float | |
| 5134 | 193 |
| 194 @DOCSTRING(errorbar) | |
| 195 | |
| 196 @DOCSTRING(semilogxerr) | |
| 197 | |
| 198 @DOCSTRING(semilogyerr) | |
| 199 | |
| 6888 | 200 @DOCSTRING(loglogerr) |
| 201 | |
| 202 Finally, the @code{polar} function allows you to easily plot data in | |
| 7001 | 203 polar coordinates. However, the display coordinates remain rectangular |
| 6888 | 204 and linear. For example, |
| 205 | |
| 206 @example | |
| 207 polar (0:0.1:10*pi, 0:0.1:10*pi); | |
| 208 @end example | |
| 209 | |
| 210 @noindent | |
| 6899 | 211 produces the spiral plot shown in @ref{fig:polar}. |
| 6888 | 212 |
| 213 @float Figure,fig:polar | |
|
9088
77e71f3da3d6
Fix documentation image printing under new development code
Rik <rdrider0-list@yahoo.com>
parents:
9040
diff
changeset
|
214 @center @image{polar,4in} |
| 6888 | 215 @caption{Polar plot.} |
| 216 @end float | |
| 217 | |
| 218 @DOCSTRING(polar) | |
| 219 | |
| 7120 | 220 @DOCSTRING(pie) |
| 221 | |
| 11330 | 222 @DOCSTRING(pie3) |
| 223 | |
| 7120 | 224 @DOCSTRING(quiver) |
| 225 | |
|
8817
03b7f618ab3d
include docstrings for new functions in the manual
John W. Eaton <jwe@octave.org>
parents:
8519
diff
changeset
|
226 @DOCSTRING(quiver3) |
|
03b7f618ab3d
include docstrings for new functions in the manual
John W. Eaton <jwe@octave.org>
parents:
8519
diff
changeset
|
227 |
|
03b7f618ab3d
include docstrings for new functions in the manual
John W. Eaton <jwe@octave.org>
parents:
8519
diff
changeset
|
228 @DOCSTRING(compass) |
|
03b7f618ab3d
include docstrings for new functions in the manual
John W. Eaton <jwe@octave.org>
parents:
8519
diff
changeset
|
229 |
|
03b7f618ab3d
include docstrings for new functions in the manual
John W. Eaton <jwe@octave.org>
parents:
8519
diff
changeset
|
230 @DOCSTRING(feather) |
|
03b7f618ab3d
include docstrings for new functions in the manual
John W. Eaton <jwe@octave.org>
parents:
8519
diff
changeset
|
231 |
| 7120 | 232 @DOCSTRING(pcolor) |
| 233 | |
| 7153 | 234 @DOCSTRING(area) |
| 235 | |
|
19657
78c0241306b5
Add documentation about when to use newplot (bug #40289).
Rik <rik@octave.org>
parents:
19602
diff
changeset
|
236 @DOCSTRING(fill) |
|
78c0241306b5
Add documentation about when to use newplot (bug #40289).
Rik <rik@octave.org>
parents:
19602
diff
changeset
|
237 |
|
8817
03b7f618ab3d
include docstrings for new functions in the manual
John W. Eaton <jwe@octave.org>
parents:
8519
diff
changeset
|
238 @DOCSTRING(comet) |
|
03b7f618ab3d
include docstrings for new functions in the manual
John W. Eaton <jwe@octave.org>
parents:
8519
diff
changeset
|
239 |
| 11382 | 240 @DOCSTRING(comet3) |
| 241 | |
|
19504
39a69f54417e
New functions im2frame and frame2im.
Carnë Draug <carandraug@octave.org>
parents:
19449
diff
changeset
|
242 @DOCSTRING(frame2im) |
|
39a69f54417e
New functions im2frame and frame2im.
Carnë Draug <carandraug@octave.org>
parents:
19449
diff
changeset
|
243 |
|
39a69f54417e
New functions im2frame and frame2im.
Carnë Draug <carandraug@octave.org>
parents:
19449
diff
changeset
|
244 @DOCSTRING(im2frame) |
|
39a69f54417e
New functions im2frame and frame2im.
Carnë Draug <carandraug@octave.org>
parents:
19449
diff
changeset
|
245 |
|
12526
f8ea3eabcb85
Add daspect, pbaspect functions to documentation.
Rik <octave@nomad.inbox5.com>
parents:
12525
diff
changeset
|
246 @node Axis Configuration |
|
f8ea3eabcb85
Add daspect, pbaspect functions to documentation.
Rik <octave@nomad.inbox5.com>
parents:
12525
diff
changeset
|
247 @subsubsection Axis Configuration |
|
f8ea3eabcb85
Add daspect, pbaspect functions to documentation.
Rik <octave@nomad.inbox5.com>
parents:
12525
diff
changeset
|
248 |
| 6888 | 249 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
|
250 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
|
251 appearance of tic marks. |
| 6888 | 252 |
| 253 @DOCSTRING(axis) | |
| 254 | |
| 7189 | 255 Similarly the axis limits of the colormap can be changed with the caxis |
| 256 function. | |
| 257 | |
| 258 @DOCSTRING(caxis) | |
| 259 | |
|
8817
03b7f618ab3d
include docstrings for new functions in the manual
John W. Eaton <jwe@octave.org>
parents:
8519
diff
changeset
|
260 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
|
261 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
|
262 |
|
17122
eaab03308c0b
doc: Rewrite docstrings for most plot functions.
Rik <rik@octave.org>
parents:
17099
diff
changeset
|
263 @c Add cross-references and function index entries for other limit functions. |
|
17097
e7a059a9a644
doc: Use XREF as anchor prefix in documentation for clearer results in Info viewer.
Rik <rik@octave.org>
parents:
16923
diff
changeset
|
264 @anchor{XREFylim} |
|
e7a059a9a644
doc: Use XREF as anchor prefix in documentation for clearer results in Info viewer.
Rik <rik@octave.org>
parents:
16923
diff
changeset
|
265 @anchor{XREFzlim} |
|
17122
eaab03308c0b
doc: Rewrite docstrings for most plot functions.
Rik <rik@octave.org>
parents:
17099
diff
changeset
|
266 @findex ylim |
|
eaab03308c0b
doc: Rewrite docstrings for most plot functions.
Rik <rik@octave.org>
parents:
17099
diff
changeset
|
267 @findex zlim |
|
8817
03b7f618ab3d
include docstrings for new functions in the manual
John W. Eaton <jwe@octave.org>
parents:
8519
diff
changeset
|
268 @DOCSTRING(xlim) |
|
03b7f618ab3d
include docstrings for new functions in the manual
John W. Eaton <jwe@octave.org>
parents:
8519
diff
changeset
|
269 |
|
7984
bbaa5d7d0143
Some documentation updates
David Bateman <dbateman@free.fr>
parents:
7981
diff
changeset
|
270 @node Two-dimensional Function Plotting |
|
bbaa5d7d0143
Some documentation updates
David Bateman <dbateman@free.fr>
parents:
7981
diff
changeset
|
271 @subsubsection Two-dimensional Function Plotting |
|
18398
200851c87444
Edits to Manual and indicies
Michael Godfrey <michaeldgodfrey@gmail.com>
parents:
17957
diff
changeset
|
272 @cindex plotting, two-dimensional functions |
|
200851c87444
Edits to Manual and indicies
Michael Godfrey <michaeldgodfrey@gmail.com>
parents:
17957
diff
changeset
|
273 |
|
200851c87444
Edits to Manual and indicies
Michael Godfrey <michaeldgodfrey@gmail.com>
parents:
17957
diff
changeset
|
274 Octave can plot a function from a function handle, inline function, or |
|
7984
bbaa5d7d0143
Some documentation updates
David Bateman <dbateman@free.fr>
parents:
7981
diff
changeset
|
275 string defining the function without the user needing to explicitly |
|
9040
dbd0c77e575e
Cleanup documentation file plot.texi
Rik <rdrider0-list@yahoo.com>
parents:
9032
diff
changeset
|
276 create the data to be plotted. The function @code{fplot} also generates |
|
7984
bbaa5d7d0143
Some documentation updates
David Bateman <dbateman@free.fr>
parents:
7981
diff
changeset
|
277 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
|
278 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
|
279 example, |
|
bbaa5d7d0143
Some documentation updates
David Bateman <dbateman@free.fr>
parents:
7981
diff
changeset
|
280 |
|
bbaa5d7d0143
Some documentation updates
David Bateman <dbateman@free.fr>
parents:
7981
diff
changeset
|
281 @example |
|
bbaa5d7d0143
Some documentation updates
David Bateman <dbateman@free.fr>
parents:
7981
diff
changeset
|
282 @group |
|
bbaa5d7d0143
Some documentation updates
David Bateman <dbateman@free.fr>
parents:
7981
diff
changeset
|
283 fplot (@@sin, [-10, 10], 201); |
|
bbaa5d7d0143
Some documentation updates
David Bateman <dbateman@free.fr>
parents:
7981
diff
changeset
|
284 @end group |
|
bbaa5d7d0143
Some documentation updates
David Bateman <dbateman@free.fr>
parents:
7981
diff
changeset
|
285 @end example |
|
bbaa5d7d0143
Some documentation updates
David Bateman <dbateman@free.fr>
parents:
7981
diff
changeset
|
286 |
|
bbaa5d7d0143
Some documentation updates
David Bateman <dbateman@free.fr>
parents:
7981
diff
changeset
|
287 @noindent |
|
bbaa5d7d0143
Some documentation updates
David Bateman <dbateman@free.fr>
parents:
7981
diff
changeset
|
288 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
|
289 legend displaying the name of the plotted function. |
|
bbaa5d7d0143
Some documentation updates
David Bateman <dbateman@free.fr>
parents:
7981
diff
changeset
|
290 |
|
bbaa5d7d0143
Some documentation updates
David Bateman <dbateman@free.fr>
parents:
7981
diff
changeset
|
291 @DOCSTRING(fplot) |
|
bbaa5d7d0143
Some documentation updates
David Bateman <dbateman@free.fr>
parents:
7981
diff
changeset
|
292 |
|
bbaa5d7d0143
Some documentation updates
David Bateman <dbateman@free.fr>
parents:
7981
diff
changeset
|
293 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
|
294 function include @code{ezplot}, @code{ezcontour}, @code{ezcontourf} and |
| 8046 | 295 @code{ezpolar}. |
| 296 | |
| 297 @DOCSTRING(ezplot) | |
|
7984
bbaa5d7d0143
Some documentation updates
David Bateman <dbateman@free.fr>
parents:
7981
diff
changeset
|
298 |
|
bbaa5d7d0143
Some documentation updates
David Bateman <dbateman@free.fr>
parents:
7981
diff
changeset
|
299 @DOCSTRING(ezcontour) |
|
bbaa5d7d0143
Some documentation updates
David Bateman <dbateman@free.fr>
parents:
7981
diff
changeset
|
300 |
|
bbaa5d7d0143
Some documentation updates
David Bateman <dbateman@free.fr>
parents:
7981
diff
changeset
|
301 @DOCSTRING(ezcontourf) |
|
bbaa5d7d0143
Some documentation updates
David Bateman <dbateman@free.fr>
parents:
7981
diff
changeset
|
302 |
|
bbaa5d7d0143
Some documentation updates
David Bateman <dbateman@free.fr>
parents:
7981
diff
changeset
|
303 @DOCSTRING(ezpolar) |
|
bbaa5d7d0143
Some documentation updates
David Bateman <dbateman@free.fr>
parents:
7981
diff
changeset
|
304 |
|
12761
13bcd62824a7
doc: Add documentation for gmres, rectangle to manual
Rik <octave@nomad.inbox5.com>
parents:
12690
diff
changeset
|
305 @node Two-dimensional Geometric Shapes |
|
13bcd62824a7
doc: Add documentation for gmres, rectangle to manual
Rik <octave@nomad.inbox5.com>
parents:
12690
diff
changeset
|
306 @subsubsection Two-dimensional Geometric Shapes |
|
13bcd62824a7
doc: Add documentation for gmres, rectangle to manual
Rik <octave@nomad.inbox5.com>
parents:
12690
diff
changeset
|
307 |
|
13bcd62824a7
doc: Add documentation for gmres, rectangle to manual
Rik <octave@nomad.inbox5.com>
parents:
12690
diff
changeset
|
308 @DOCSTRING(rectangle) |
|
13bcd62824a7
doc: Add documentation for gmres, rectangle to manual
Rik <octave@nomad.inbox5.com>
parents:
12690
diff
changeset
|
309 |
|
12526
f8ea3eabcb85
Add daspect, pbaspect functions to documentation.
Rik <octave@nomad.inbox5.com>
parents:
12525
diff
changeset
|
310 @node Three-Dimensional Plots |
|
f8ea3eabcb85
Add daspect, pbaspect functions to documentation.
Rik <octave@nomad.inbox5.com>
parents:
12525
diff
changeset
|
311 @subsection Three-Dimensional Plots |
|
18398
200851c87444
Edits to Manual and indicies
Michael Godfrey <michaeldgodfrey@gmail.com>
parents:
17957
diff
changeset
|
312 @cindex plotting, three-dimensional |
| 6888 | 313 |
| 314 The function @code{mesh} produces mesh surface plots. For example, | |
| 315 | |
| 316 @example | |
| 317 @group | |
| 318 tx = ty = linspace (-8, 8, 41)'; | |
| 319 [xx, yy] = meshgrid (tx, ty); | |
| 320 r = sqrt (xx .^ 2 + yy .^ 2) + eps; | |
| 321 tz = sin (r) ./ r; | |
| 322 mesh (tx, ty, tz); | |
| 323 @end group | |
| 324 @end example | |
| 325 | |
| 326 @noindent | |
| 6899 | 327 produces the familiar ``sombrero'' plot shown in @ref{fig:mesh}. Note |
| 6888 | 328 the use of the function @code{meshgrid} to create matrices of X and Y |
| 329 coordinates to use for plotting the Z data. The @code{ndgrid} function | |
| 330 is similar to @code{meshgrid}, but works for N-dimensional matrices. | |
| 331 | |
| 332 @float Figure,fig:mesh | |
|
9088
77e71f3da3d6
Fix documentation image printing under new development code
Rik <rdrider0-list@yahoo.com>
parents:
9040
diff
changeset
|
333 @center @image{mesh,4in} |
| 6888 | 334 @caption{Mesh plot.} |
| 335 @end float | |
| 5134 | 336 |
| 6888 | 337 The @code{meshc} function is similar to @code{mesh}, but also produces a |
| 338 plot of contours for the surface. | |
| 339 | |
| 340 The @code{plot3} function displays arbitrary three-dimensional data, | |
|
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
341 without requiring it to form a surface. For example, |
| 6888 | 342 |
| 343 @example | |
| 344 @group | |
| 345 t = 0:0.1:10*pi; | |
| 346 r = linspace (0, 1, numel (t)); | |
| 347 z = linspace (0, 1, numel (t)); | |
| 348 plot3 (r.*sin(t), r.*cos(t), z); | |
| 349 @end group | |
| 350 @end example | |
| 351 | |
| 352 @noindent | |
| 6899 | 353 displays the spiral in three dimensions shown in @ref{fig:plot3}. |
| 6888 | 354 |
| 355 @float Figure,fig:plot3 | |
|
9088
77e71f3da3d6
Fix documentation image printing under new development code
Rik <rdrider0-list@yahoo.com>
parents:
9040
diff
changeset
|
356 @center @image{plot3,4in} |
|
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
357 @caption{Three-dimensional spiral.} |
| 6888 | 358 @end float |
| 359 | |
| 360 Finally, the @code{view} function changes the viewpoint for | |
| 361 three-dimensional plots. | |
| 5134 | 362 |
| 363 @DOCSTRING(mesh) | |
| 364 | |
| 6788 | 365 @DOCSTRING(meshc) |
| 366 | |
|
8817
03b7f618ab3d
include docstrings for new functions in the manual
John W. Eaton <jwe@octave.org>
parents:
8519
diff
changeset
|
367 @DOCSTRING(meshz) |
|
03b7f618ab3d
include docstrings for new functions in the manual
John W. Eaton <jwe@octave.org>
parents:
8519
diff
changeset
|
368 |
| 7153 | 369 @DOCSTRING(hidden) |
| 370 | |
| 7120 | 371 @DOCSTRING(surf) |
| 372 | |
| 373 @DOCSTRING(surfc) | |
| 374 | |
|
8817
03b7f618ab3d
include docstrings for new functions in the manual
John W. Eaton <jwe@octave.org>
parents:
8519
diff
changeset
|
375 @DOCSTRING(surfl) |
|
03b7f618ab3d
include docstrings for new functions in the manual
John W. Eaton <jwe@octave.org>
parents:
8519
diff
changeset
|
376 |
|
03b7f618ab3d
include docstrings for new functions in the manual
John W. Eaton <jwe@octave.org>
parents:
8519
diff
changeset
|
377 @DOCSTRING(surfnorm) |
|
03b7f618ab3d
include docstrings for new functions in the manual
John W. Eaton <jwe@octave.org>
parents:
8519
diff
changeset
|
378 |
|
12529
0579a13f29a1
Add isocolors, isonormals, isosurface functions to documentation.
Rik <octave@nomad.inbox5.com>
parents:
12526
diff
changeset
|
379 @DOCSTRING(isosurface) |
|
0579a13f29a1
Add isocolors, isonormals, isosurface functions to documentation.
Rik <octave@nomad.inbox5.com>
parents:
12526
diff
changeset
|
380 |
|
0579a13f29a1
Add isocolors, isonormals, isosurface functions to documentation.
Rik <octave@nomad.inbox5.com>
parents:
12526
diff
changeset
|
381 @DOCSTRING(isonormals) |
|
0579a13f29a1
Add isocolors, isonormals, isosurface functions to documentation.
Rik <octave@nomad.inbox5.com>
parents:
12526
diff
changeset
|
382 |
|
0579a13f29a1
Add isocolors, isonormals, isosurface functions to documentation.
Rik <octave@nomad.inbox5.com>
parents:
12526
diff
changeset
|
383 @DOCSTRING(isocolors) |
|
0579a13f29a1
Add isocolors, isonormals, isosurface functions to documentation.
Rik <octave@nomad.inbox5.com>
parents:
12526
diff
changeset
|
384 |
|
14574
9546bb28648c
New Function, shrinkfaces.m
Martin Helm <martin@mhelm.de>
parents:
14456
diff
changeset
|
385 @DOCSTRING(shrinkfaces) |
|
9546bb28648c
New Function, shrinkfaces.m
Martin Helm <martin@mhelm.de>
parents:
14456
diff
changeset
|
386 |
|
8817
03b7f618ab3d
include docstrings for new functions in the manual
John W. Eaton <jwe@octave.org>
parents:
8519
diff
changeset
|
387 @DOCSTRING(diffuse) |
|
03b7f618ab3d
include docstrings for new functions in the manual
John W. Eaton <jwe@octave.org>
parents:
8519
diff
changeset
|
388 |
|
03b7f618ab3d
include docstrings for new functions in the manual
John W. Eaton <jwe@octave.org>
parents:
8519
diff
changeset
|
389 @DOCSTRING(specular) |
|
03b7f618ab3d
include docstrings for new functions in the manual
John W. Eaton <jwe@octave.org>
parents:
8519
diff
changeset
|
390 |
| 5134 | 391 @DOCSTRING(meshgrid) |
| 392 | |
| 6550 | 393 @DOCSTRING(ndgrid) |
| 394 | |
| 6888 | 395 @DOCSTRING(plot3) |
| 396 | |
| 6502 | 397 @DOCSTRING(view) |
| 398 | |
|
8817
03b7f618ab3d
include docstrings for new functions in the manual
John W. Eaton <jwe@octave.org>
parents:
8519
diff
changeset
|
399 @DOCSTRING(slice) |
|
03b7f618ab3d
include docstrings for new functions in the manual
John W. Eaton <jwe@octave.org>
parents:
8519
diff
changeset
|
400 |
|
03b7f618ab3d
include docstrings for new functions in the manual
John W. Eaton <jwe@octave.org>
parents:
8519
diff
changeset
|
401 @DOCSTRING(ribbon) |
|
03b7f618ab3d
include docstrings for new functions in the manual
John W. Eaton <jwe@octave.org>
parents:
8519
diff
changeset
|
402 |
| 7120 | 403 @DOCSTRING(shading) |
| 404 | |
|
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
405 @DOCSTRING(scatter3) |
|
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
406 |
| 16563 | 407 @DOCSTRING(waterfall) |
| 408 | |
|
7989
23c248d415b5
Various doc fixes. Readd cellidx
David Bateman <dbateman@free.fr>
parents:
7984
diff
changeset
|
409 @menu |
|
12526
f8ea3eabcb85
Add daspect, pbaspect functions to documentation.
Rik <octave@nomad.inbox5.com>
parents:
12525
diff
changeset
|
410 * Aspect Ratio:: |
|
17152
f2a8592b8fbd
doc: Shorten some long subsection names in Manual.
Rik <rik@octave.org>
parents:
17123
diff
changeset
|
411 * Three-dimensional Function Plotting:: |
|
f2a8592b8fbd
doc: Shorten some long subsection names in Manual.
Rik <rik@octave.org>
parents:
17123
diff
changeset
|
412 * Three-dimensional Geometric Shapes:: |
|
7989
23c248d415b5
Various doc fixes. Readd cellidx
David Bateman <dbateman@free.fr>
parents:
7984
diff
changeset
|
413 @end menu |
|
23c248d415b5
Various doc fixes. Readd cellidx
David Bateman <dbateman@free.fr>
parents:
7984
diff
changeset
|
414 |
|
12526
f8ea3eabcb85
Add daspect, pbaspect functions to documentation.
Rik <octave@nomad.inbox5.com>
parents:
12525
diff
changeset
|
415 @node Aspect Ratio |
|
f8ea3eabcb85
Add daspect, pbaspect functions to documentation.
Rik <octave@nomad.inbox5.com>
parents:
12525
diff
changeset
|
416 @subsubsection Aspect Ratio |
|
f8ea3eabcb85
Add daspect, pbaspect functions to documentation.
Rik <octave@nomad.inbox5.com>
parents:
12525
diff
changeset
|
417 |
|
f8ea3eabcb85
Add daspect, pbaspect functions to documentation.
Rik <octave@nomad.inbox5.com>
parents:
12525
diff
changeset
|
418 For three-dimensional plots the aspect ratio can be set for data with |
|
17469
710b3d5fe966
improve interpreter tex Tables
Michael Godfrey <michaeldgodfrey@gmail.com>
parents:
17281
diff
changeset
|
419 @code{daspect} and for the plot box with @code{pbaspect}. |
|
17097
e7a059a9a644
doc: Use XREF as anchor prefix in documentation for clearer results in Info viewer.
Rik <rik@octave.org>
parents:
16923
diff
changeset
|
420 @xref{Axis Configuration}, for controlling the x-, y-, and z-limits for |
|
12526
f8ea3eabcb85
Add daspect, pbaspect functions to documentation.
Rik <octave@nomad.inbox5.com>
parents:
12525
diff
changeset
|
421 plotting. |
|
f8ea3eabcb85
Add daspect, pbaspect functions to documentation.
Rik <octave@nomad.inbox5.com>
parents:
12525
diff
changeset
|
422 |
|
f8ea3eabcb85
Add daspect, pbaspect functions to documentation.
Rik <octave@nomad.inbox5.com>
parents:
12525
diff
changeset
|
423 @DOCSTRING(daspect) |
|
f8ea3eabcb85
Add daspect, pbaspect functions to documentation.
Rik <octave@nomad.inbox5.com>
parents:
12525
diff
changeset
|
424 |
|
f8ea3eabcb85
Add daspect, pbaspect functions to documentation.
Rik <octave@nomad.inbox5.com>
parents:
12525
diff
changeset
|
425 @DOCSTRING(pbaspect) |
|
f8ea3eabcb85
Add daspect, pbaspect functions to documentation.
Rik <octave@nomad.inbox5.com>
parents:
12525
diff
changeset
|
426 |
|
7989
23c248d415b5
Various doc fixes. Readd cellidx
David Bateman <dbateman@free.fr>
parents:
7984
diff
changeset
|
427 @node Three-dimensional Function Plotting |
|
23c248d415b5
Various doc fixes. Readd cellidx
David Bateman <dbateman@free.fr>
parents:
7984
diff
changeset
|
428 @subsubsection Three-dimensional Function Plotting |
|
7984
bbaa5d7d0143
Some documentation updates
David Bateman <dbateman@free.fr>
parents:
7981
diff
changeset
|
429 |
|
bbaa5d7d0143
Some documentation updates
David Bateman <dbateman@free.fr>
parents:
7981
diff
changeset
|
430 @DOCSTRING(ezplot3) |
|
bbaa5d7d0143
Some documentation updates
David Bateman <dbateman@free.fr>
parents:
7981
diff
changeset
|
431 |
|
bbaa5d7d0143
Some documentation updates
David Bateman <dbateman@free.fr>
parents:
7981
diff
changeset
|
432 @DOCSTRING(ezmesh) |
|
bbaa5d7d0143
Some documentation updates
David Bateman <dbateman@free.fr>
parents:
7981
diff
changeset
|
433 |
|
bbaa5d7d0143
Some documentation updates
David Bateman <dbateman@free.fr>
parents:
7981
diff
changeset
|
434 @DOCSTRING(ezmeshc) |
|
bbaa5d7d0143
Some documentation updates
David Bateman <dbateman@free.fr>
parents:
7981
diff
changeset
|
435 |
|
bbaa5d7d0143
Some documentation updates
David Bateman <dbateman@free.fr>
parents:
7981
diff
changeset
|
436 @DOCSTRING(ezsurf) |
|
bbaa5d7d0143
Some documentation updates
David Bateman <dbateman@free.fr>
parents:
7981
diff
changeset
|
437 |
|
bbaa5d7d0143
Some documentation updates
David Bateman <dbateman@free.fr>
parents:
7981
diff
changeset
|
438 @DOCSTRING(ezsurfc) |
|
bbaa5d7d0143
Some documentation updates
David Bateman <dbateman@free.fr>
parents:
7981
diff
changeset
|
439 |
|
8817
03b7f618ab3d
include docstrings for new functions in the manual
John W. Eaton <jwe@octave.org>
parents:
8519
diff
changeset
|
440 @node Three-dimensional Geometric Shapes |
|
03b7f618ab3d
include docstrings for new functions in the manual
John W. Eaton <jwe@octave.org>
parents:
8519
diff
changeset
|
441 @subsubsection Three-dimensional Geometric Shapes |
|
03b7f618ab3d
include docstrings for new functions in the manual
John W. Eaton <jwe@octave.org>
parents:
8519
diff
changeset
|
442 |
|
03b7f618ab3d
include docstrings for new functions in the manual
John W. Eaton <jwe@octave.org>
parents:
8519
diff
changeset
|
443 @DOCSTRING(cylinder) |
|
03b7f618ab3d
include docstrings for new functions in the manual
John W. Eaton <jwe@octave.org>
parents:
8519
diff
changeset
|
444 |
|
03b7f618ab3d
include docstrings for new functions in the manual
John W. Eaton <jwe@octave.org>
parents:
8519
diff
changeset
|
445 @DOCSTRING(sphere) |
|
03b7f618ab3d
include docstrings for new functions in the manual
John W. Eaton <jwe@octave.org>
parents:
8519
diff
changeset
|
446 |
|
03b7f618ab3d
include docstrings for new functions in the manual
John W. Eaton <jwe@octave.org>
parents:
8519
diff
changeset
|
447 @DOCSTRING(ellipsoid) |
|
03b7f618ab3d
include docstrings for new functions in the manual
John W. Eaton <jwe@octave.org>
parents:
8519
diff
changeset
|
448 |
| 6888 | 449 @node Plot Annotations |
| 450 @subsection Plot Annotations | |
| 6502 | 451 |
| 6888 | 452 You can add titles, axis labels, legends, and arbitrary text to an |
|
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
453 existing plot. For example: |
| 6877 | 454 |
| 6888 | 455 @example |
| 456 @group | |
| 457 x = -10:0.1:10; | |
| 458 plot (x, sin (x)); | |
| 459 title ("sin(x) for x = -10:0.1:10"); | |
| 460 xlabel ("x"); | |
| 461 ylabel ("sin (x)"); | |
| 462 text (pi, 0.7, "arbitrary text"); | |
| 463 legend ("sin (x)"); | |
| 464 @end group | |
| 465 @end example | |
| 6502 | 466 |
| 6888 | 467 The functions @code{grid} and @code{box} may also be used to add grid |
| 468 and border lines to the plot. By default, the grid is off and the | |
| 469 border lines are on. | |
| 5134 | 470 |
|
20000
ca7599ae464d
doc: Grammarcheck documentation ahead of 4.0 release.
Rik <rik@octave.org>
parents:
19982
diff
changeset
|
471 Finally, arrows, text and rectangular or elliptic boxes can be added to |
|
ca7599ae464d
doc: Grammarcheck documentation ahead of 4.0 release.
Rik <rik@octave.org>
parents:
19982
diff
changeset
|
472 highlight parts of a plot using the @code{annotation} function. Those objects |
|
ca7599ae464d
doc: Grammarcheck documentation ahead of 4.0 release.
Rik <rik@octave.org>
parents:
19982
diff
changeset
|
473 are drawn in an invisible axes, on top of every other axes. |
|
19946
b8e4104a8f55
Add the annotation function (bug #43282)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents:
19898
diff
changeset
|
474 |
| 5134 | 475 @DOCSTRING(title) |
| 476 | |
| 6502 | 477 @DOCSTRING(legend) |
| 478 | |
| 479 @DOCSTRING(text) | |
| 480 | |
|
8428
ee1bc8aa226b
Add cross reference from Plot Annotations to Text Properties.
Francesco Potortì <pot@gnu.org>
parents:
8347
diff
changeset
|
481 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
|
482 |
|
17097
e7a059a9a644
doc: Use XREF as anchor prefix in documentation for clearer results in Info viewer.
Rik <rik@octave.org>
parents:
16923
diff
changeset
|
483 @anchor{XREFylabel} |
|
e7a059a9a644
doc: Use XREF as anchor prefix in documentation for clearer results in Info viewer.
Rik <rik@octave.org>
parents:
16923
diff
changeset
|
484 @anchor{XREFzlabel} |
| 5134 | 485 @DOCSTRING(xlabel) |
| 486 | |
|
8817
03b7f618ab3d
include docstrings for new functions in the manual
John W. Eaton <jwe@octave.org>
parents:
8519
diff
changeset
|
487 @DOCSTRING(clabel) |
|
03b7f618ab3d
include docstrings for new functions in the manual
John W. Eaton <jwe@octave.org>
parents:
8519
diff
changeset
|
488 |
| 6502 | 489 @DOCSTRING(box) |
| 490 | |
| 491 @DOCSTRING(grid) | |
| 492 | |
|
8089
0ec09255515a
add colorbar docstring to the manual
John W. Eaton <jwe@octave.org>
parents:
8073
diff
changeset
|
493 @DOCSTRING(colorbar) |
|
0ec09255515a
add colorbar docstring to the manual
John W. Eaton <jwe@octave.org>
parents:
8073
diff
changeset
|
494 |
|
19946
b8e4104a8f55
Add the annotation function (bug #43282)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents:
19898
diff
changeset
|
495 @DOCSTRING(annotation) |
|
b8e4104a8f55
Add the annotation function (bug #43282)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents:
19898
diff
changeset
|
496 |
| 5134 | 497 @node Multiple Plots on One Page |
| 6888 | 498 @subsection Multiple Plots on One Page |
|
18398
200851c87444
Edits to Manual and indicies
Michael Godfrey <michaeldgodfrey@gmail.com>
parents:
17957
diff
changeset
|
499 @cindex plotting, multiple plots per figure |
| 6888 | 500 |
| 501 Octave can display more than one plot in a single figure. The simplest | |
| 502 way to do this is to use the @code{subplot} function to divide the plot | |
| 503 area into a series of subplot windows that are indexed by an integer. | |
| 504 For example, | |
| 505 | |
| 506 @example | |
| 507 @group | |
| 508 subplot (2, 1, 1) | |
| 509 fplot (@@sin, [-10, 10]); | |
| 510 subplot (2, 1, 2) | |
| 511 fplot (@@cos, [-10, 10]); | |
| 512 @end group | |
| 513 @end example | |
| 514 | |
| 515 @noindent | |
| 516 creates a figure with two separate axes, one displaying a sine wave and | |
| 517 the other a cosine wave. The first call to subplot divides the figure | |
| 518 into two plotting areas (two rows and one column) and makes the first plot | |
| 519 area active. The grid of plot areas created by @code{subplot} is | |
| 520 numbered in column-major order (top to bottom, left to right). | |
| 5134 | 521 |
| 522 @DOCSTRING(subplot) | |
| 523 | |
| 524 @node Multiple Plot Windows | |
| 6888 | 525 @subsection Multiple Plot Windows |
|
18398
200851c87444
Edits to Manual and indicies
Michael Godfrey <michaeldgodfrey@gmail.com>
parents:
17957
diff
changeset
|
526 @cindex plotting, multiple plot windows |
| 6888 | 527 |
| 528 You can open multiple plot windows using the @code{figure} function. | |
|
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
529 For example, |
| 6888 | 530 |
| 531 @example | |
|
9088
77e71f3da3d6
Fix documentation image printing under new development code
Rik <rdrider0-list@yahoo.com>
parents:
9040
diff
changeset
|
532 @group |
| 6888 | 533 figure (1); |
| 534 fplot (@@sin, [-10, 10]); | |
| 535 figure (2); | |
| 536 fplot (@@cos, [-10, 10]); | |
|
9088
77e71f3da3d6
Fix documentation image printing under new development code
Rik <rdrider0-list@yahoo.com>
parents:
9040
diff
changeset
|
537 @end group |
| 6888 | 538 @end example |
| 539 | |
| 540 @noindent | |
| 541 creates two figures, with the first displaying a sine wave and | |
| 542 the second a cosine wave. Figure numbers must be positive integers. | |
| 5134 | 543 |
| 544 @DOCSTRING(figure) | |
|
16096
9720ecf8d257
Fix additional warning associated with Texinfo 5.0 (bug #38392)
Rik <rik@octave.org>
parents:
16094
diff
changeset
|
545 |
| 19273 | 546 @node Manipulation of Plot Objects |
| 547 @subsection Manipulation of Plot Objects | |
| 548 @cindex plotting, object manipulation | |
| 549 | |
|
19282
4e5fae88065f
add pan docstring to the manual
John W. Eaton <jwe@octave.org>
parents:
19281
diff
changeset
|
550 @DOCSTRING(pan) |
|
4e5fae88065f
add pan docstring to the manual
John W. Eaton <jwe@octave.org>
parents:
19281
diff
changeset
|
551 |
| 19273 | 552 @DOCSTRING(rotate) |
| 553 | |
|
19280
99aec089e8c3
add rotate3d docstring to the manual
John W. Eaton <jwe@octave.org>
parents:
19273
diff
changeset
|
554 @DOCSTRING(rotate3d) |
|
99aec089e8c3
add rotate3d docstring to the manual
John W. Eaton <jwe@octave.org>
parents:
19273
diff
changeset
|
555 |
| 19281 | 556 @DOCSTRING(zoom) |
| 557 | |
|
16096
9720ecf8d257
Fix additional warning associated with Texinfo 5.0 (bug #38392)
Rik <rik@octave.org>
parents:
16094
diff
changeset
|
558 @node Manipulation of Plot Windows |
|
9720ecf8d257
Fix additional warning associated with Texinfo 5.0 (bug #38392)
Rik <rik@octave.org>
parents:
16094
diff
changeset
|
559 @subsection Manipulation of Plot Windows |
|
18398
200851c87444
Edits to Manual and indicies
Michael Godfrey <michaeldgodfrey@gmail.com>
parents:
17957
diff
changeset
|
560 @cindex plotting, window manipulation |
|
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
561 |
|
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
562 By default, Octave refreshes the plot window when a prompt is printed, |
|
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
563 or when waiting for input. The |
|
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
564 @code{drawnow} function is used to cause a plot window to be updated. |
|
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
565 |
|
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
566 @DOCSTRING(drawnow) |
|
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
567 |
|
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
568 Only figures that are modified will be updated. The @code{refresh} |
|
19449
1f2a16d41ba2
Automatically generate graphics properties documentation (bug #42536)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents:
19344
diff
changeset
|
569 function can also be used to cause an update of the current figure, even if |
|
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
570 it is not modified. |
|
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
571 |
|
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
572 @DOCSTRING(refresh) |
|
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
573 |
|
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
574 Normally, high-level plot functions like @code{plot} or @code{mesh} call |
|
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
575 @code{newplot} to initialize the state of the current axes so that the |
|
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
576 next plot is drawn in a blank window with default property settings. To |
|
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
577 have two plots superimposed over one another, use the @code{hold} |
|
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
578 function. For example, |
|
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
579 |
|
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
580 @example |
|
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
581 @group |
|
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
582 hold on; |
|
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
583 x = -10:0.1:10; |
|
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
584 plot (x, sin (x)); |
|
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
585 plot (x, cos (x)); |
|
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
586 hold off; |
|
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
587 @end group |
|
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
588 @end example |
|
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
589 |
|
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
590 @noindent |
|
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
591 displays sine and cosine waves on the same axes. If the hold state is |
|
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
592 off, consecutive plotting commands like this will only display the last |
|
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
593 plot. |
|
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
594 |
|
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
595 @DOCSTRING(newplot) |
|
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
596 |
|
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
597 @DOCSTRING(hold) |
|
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
598 |
|
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
599 @DOCSTRING(ishold) |
|
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
600 To clear the current figure, call the @code{clf} function. To clear the |
|
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
601 current axis, call the @code{cla} function. To bring the current figure |
|
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
602 to the top of the window stack, call the @code{shg} function. To delete |
|
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
603 a graphics object, call @code{delete} on its index. To close the |
|
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
604 figure window, call the @code{close} function. |
|
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
605 |
|
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
606 @DOCSTRING(clf) |
|
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
607 |
|
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
608 @DOCSTRING(cla) |
|
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
609 |
|
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
610 @DOCSTRING(shg) |
|
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
611 |
|
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
612 @DOCSTRING(delete) |
|
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
613 |
|
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
614 @DOCSTRING(close) |
|
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
615 |
|
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
616 @DOCSTRING(closereq) |
|
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
617 |
|
16096
9720ecf8d257
Fix additional warning associated with Texinfo 5.0 (bug #38392)
Rik <rik@octave.org>
parents:
16094
diff
changeset
|
618 @node Use of the @code{interpreter} Property |
|
20497
cdb382f1de79
Fix documentation build accidentally broken in 6db2ea5556a4.
Rik <rik@octave.org>
parents:
20495
diff
changeset
|
619 @subsection Use of the @code{interpreter} Property |
|
20495
6db2ea5556a4
Make use of the axes "ticklabelinterpreter" property (bug #45438)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents:
20000
diff
changeset
|
620 @anchor{XREFinterpreterusage} |
|
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
621 |
|
19034
77d5e7661b8e
doc: Update wording on using TeX interpreter in plotting.
Rik <rik@octave.org>
parents:
18398
diff
changeset
|
622 All text objects---such as titles, labels, legends, and text---include |
|
19203
c4ffcc961f3c
Document that "tex" interpreter only works with gnuplot for printing (bug #42340).
Rik <rik@octave.org>
parents:
19034
diff
changeset
|
623 the property @qcode{"interpreter"} that determines the manner in |
|
c4ffcc961f3c
Document that "tex" interpreter only works with gnuplot for printing (bug #42340).
Rik <rik@octave.org>
parents:
19034
diff
changeset
|
624 which special control sequences in the text are rendered. |
|
c4ffcc961f3c
Document that "tex" interpreter only works with gnuplot for printing (bug #42340).
Rik <rik@octave.org>
parents:
19034
diff
changeset
|
625 |
|
c4ffcc961f3c
Document that "tex" interpreter only works with gnuplot for printing (bug #42340).
Rik <rik@octave.org>
parents:
19034
diff
changeset
|
626 The interpreter property can take three values: @qcode{"none"}, @qcode{"tex"}, |
|
c4ffcc961f3c
Document that "tex" interpreter only works with gnuplot for printing (bug #42340).
Rik <rik@octave.org>
parents:
19034
diff
changeset
|
627 @qcode{"latex"}. If the interpreter is set to @qcode{"none"} then no special |
|
c4ffcc961f3c
Document that "tex" interpreter only works with gnuplot for printing (bug #42340).
Rik <rik@octave.org>
parents:
19034
diff
changeset
|
628 rendering occurs---the displayed text is a verbatim copy of the specified text. |
|
c4ffcc961f3c
Document that "tex" interpreter only works with gnuplot for printing (bug #42340).
Rik <rik@octave.org>
parents:
19034
diff
changeset
|
629 Currently, the @qcode{"latex"} interpreter is not implemented and is equivalent |
|
c4ffcc961f3c
Document that "tex" interpreter only works with gnuplot for printing (bug #42340).
Rik <rik@octave.org>
parents:
19034
diff
changeset
|
630 to @qcode{"none"}. |
|
19034
77d5e7661b8e
doc: Update wording on using TeX interpreter in plotting.
Rik <rik@octave.org>
parents:
18398
diff
changeset
|
631 |
|
77d5e7661b8e
doc: Update wording on using TeX interpreter in plotting.
Rik <rik@octave.org>
parents:
18398
diff
changeset
|
632 The @qcode{"tex"} option implements a subset of @TeX{} functionality when |
|
77d5e7661b8e
doc: Update wording on using TeX interpreter in plotting.
Rik <rik@octave.org>
parents:
18398
diff
changeset
|
633 rendering text. This allows the insertion of special glyphs such as Greek |
|
19203
c4ffcc961f3c
Document that "tex" interpreter only works with gnuplot for printing (bug #42340).
Rik <rik@octave.org>
parents:
19034
diff
changeset
|
634 characters or mathematical symbols. The special characters are inserted with a |
|
c4ffcc961f3c
Document that "tex" interpreter only works with gnuplot for printing (bug #42340).
Rik <rik@octave.org>
parents:
19034
diff
changeset
|
635 code following a backslash (\) character, as shown in @ref{tab:extended}. |
|
c4ffcc961f3c
Document that "tex" interpreter only works with gnuplot for printing (bug #42340).
Rik <rik@octave.org>
parents:
19034
diff
changeset
|
636 |
|
c4ffcc961f3c
Document that "tex" interpreter only works with gnuplot for printing (bug #42340).
Rik <rik@octave.org>
parents:
19034
diff
changeset
|
637 Note that for on-screen display the interpreter property is honored by all |
|
c4ffcc961f3c
Document that "tex" interpreter only works with gnuplot for printing (bug #42340).
Rik <rik@octave.org>
parents:
19034
diff
changeset
|
638 graphics toolkits. However for printing, @strong{only} the @qcode{"gnuplot"} |
|
c4ffcc961f3c
Document that "tex" interpreter only works with gnuplot for printing (bug #42340).
Rik <rik@octave.org>
parents:
19034
diff
changeset
|
639 toolkit renders @TeX{} instructions. |
|
c4ffcc961f3c
Document that "tex" interpreter only works with gnuplot for printing (bug #42340).
Rik <rik@octave.org>
parents:
19034
diff
changeset
|
640 |
|
c4ffcc961f3c
Document that "tex" interpreter only works with gnuplot for printing (bug #42340).
Rik <rik@octave.org>
parents:
19034
diff
changeset
|
641 Besides special glyphs, the formatting of text can be changed within the |
|
c4ffcc961f3c
Document that "tex" interpreter only works with gnuplot for printing (bug #42340).
Rik <rik@octave.org>
parents:
19034
diff
changeset
|
642 string by using the codes |
|
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
643 |
|
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
644 @multitable @columnfractions .2 .2 .6 .2 |
|
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
645 @item @tab \bf @tab Bold font @tab |
|
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
646 @item @tab \it @tab Italic font @tab |
|
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
647 @item @tab \sl @tab Oblique Font @tab |
|
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
648 @item @tab \rm @tab Normal font @tab |
|
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
649 @end multitable |
|
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
650 |
|
19203
c4ffcc961f3c
Document that "tex" interpreter only works with gnuplot for printing (bug #42340).
Rik <rik@octave.org>
parents:
19034
diff
changeset
|
651 These codes may be used in conjunction with the @{ and @} characters to limit |
|
c4ffcc961f3c
Document that "tex" interpreter only works with gnuplot for printing (bug #42340).
Rik <rik@octave.org>
parents:
19034
diff
changeset
|
652 the change to just a part of the string. For example, |
|
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
653 |
|
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
654 @example |
|
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
655 xlabel ('@{\bf H@} = a @{\bf V@}') |
|
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
656 @end example |
|
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
657 |
|
10846
a4f482e66b65
Grammarcheck more of the documentation.
Rik <octave@nomad.inbox5.com>
parents:
10828
diff
changeset
|
658 @noindent |
|
17281
bc924baa2c4e
doc: Add new @qcode macro for code samples which are quoted.
Rik <rik@octave.org>
parents:
17170
diff
changeset
|
659 where the character @qcode{'a'} will not appear in a bold font. Note that to |
|
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
660 avoid having Octave interpret the backslash characters in the strings, |
|
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
661 the strings should be in single quotes. |
|
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
662 |
|
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
663 It is also possible to change the fontname and size within the text |
|
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
664 |
|
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
665 @multitable @columnfractions .1 .4 .6 .1 |
|
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
666 @item @tab \fontname@{@var{fontname}@} @tab Specify the font to use @tab |
|
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
667 @item @tab \fontsize@{@var{size}@} @tab Specify the size of the font to |
|
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
668 use @tab |
|
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
669 @end multitable |
|
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
670 |
|
19034
77d5e7661b8e
doc: Update wording on using TeX interpreter in plotting.
Rik <rik@octave.org>
parents:
18398
diff
changeset
|
671 Finally, superscripting and subscripting can be controlled with the @qcode{'^'} |
|
17281
bc924baa2c4e
doc: Add new @qcode macro for code samples which are quoted.
Rik <rik@octave.org>
parents:
17170
diff
changeset
|
672 and @qcode{'_'} characters. If the @qcode{'^'} or @qcode{'_'} is followed by a |
|
bc924baa2c4e
doc: Add new @qcode macro for code samples which are quoted.
Rik <rik@octave.org>
parents:
17170
diff
changeset
|
673 @{ character, then all of the block surrounded by the @{ @} pair is super- or |
|
bc924baa2c4e
doc: Add new @qcode macro for code samples which are quoted.
Rik <rik@octave.org>
parents:
17170
diff
changeset
|
674 sub-scripted. Without the @{ @} pair, only the character immediately following |
|
bc924baa2c4e
doc: Add new @qcode macro for code samples which are quoted.
Rik <rik@octave.org>
parents:
17170
diff
changeset
|
675 the @qcode{'^'} or @qcode{'_'} is super- or sub-scripted. |
|
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
676 |
|
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
677 @float Table,tab:extended |
|
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
678 @tex |
|
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
679 \vskip 6pt |
|
17521
3670ce8da1a0
doc: improve format of table 15.1 for TeX characters.
Michael Godfrey <michaeldgodfrey@gmail.com>
parents:
17469
diff
changeset
|
680 \newdimen\cola \cola=78pt |
|
3670ce8da1a0
doc: improve format of table 15.1 for TeX characters.
Michael Godfrey <michaeldgodfrey@gmail.com>
parents:
17469
diff
changeset
|
681 \newdimen\colb \colb=78pt |
|
3670ce8da1a0
doc: improve format of table 15.1 for TeX characters.
Michael Godfrey <michaeldgodfrey@gmail.com>
parents:
17469
diff
changeset
|
682 \newdimen\colc \colc=78pt |
|
3670ce8da1a0
doc: improve format of table 15.1 for TeX characters.
Michael Godfrey <michaeldgodfrey@gmail.com>
parents:
17469
diff
changeset
|
683 \def\symtable#1#2#3{ |
|
3670ce8da1a0
doc: improve format of table 15.1 for TeX characters.
Michael Godfrey <michaeldgodfrey@gmail.com>
parents:
17469
diff
changeset
|
684 \hbox to \hsize {\hfill\vbox{\offinterlineskip \tabskip=0pt |
|
17469
710b3d5fe966
improve interpreter tex Tables
Michael Godfrey <michaeldgodfrey@gmail.com>
parents:
17281
diff
changeset
|
685 \hskip36pt #1 |
|
710b3d5fe966
improve interpreter tex Tables
Michael Godfrey <michaeldgodfrey@gmail.com>
parents:
17281
diff
changeset
|
686 \vskip6pt |
|
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
687 \halign{ |
|
17469
710b3d5fe966
improve interpreter tex Tables
Michael Godfrey <michaeldgodfrey@gmail.com>
parents:
17281
diff
changeset
|
688 \vrule height2.0ex depth1.ex width 0.6pt #2\tabskip=0.3em & |
|
710b3d5fe966
improve interpreter tex Tables
Michael Godfrey <michaeldgodfrey@gmail.com>
parents:
17281
diff
changeset
|
689 #2 \hfil & \vrule #2 & #2 \hfil & #2 \vrule & |
|
710b3d5fe966
improve interpreter tex Tables
Michael Godfrey <michaeldgodfrey@gmail.com>
parents:
17281
diff
changeset
|
690 #2 \hfil & \vrule #2 & #2 \hfil & #2 \vrule & |
|
710b3d5fe966
improve interpreter tex Tables
Michael Godfrey <michaeldgodfrey@gmail.com>
parents:
17281
diff
changeset
|
691 #2 \hfil & \vrule #2 & #2 \hfil & #2 \vrule |
|
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
692 width 0.6pt \tabskip=0pt\cr |
|
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
693 \noalign{\hrule height 0.6pt} |
|
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
694 & Code && Sym && Code && Sym && Code && Sym &\cr |
|
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
695 \noalign{\hrule} |
|
17469
710b3d5fe966
improve interpreter tex Tables
Michael Godfrey <michaeldgodfrey@gmail.com>
parents:
17281
diff
changeset
|
696 #3 |
|
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
697 \noalign{\hrule height 0.6pt} |
|
17469
710b3d5fe966
improve interpreter tex Tables
Michael Godfrey <michaeldgodfrey@gmail.com>
parents:
17281
diff
changeset
|
698 } |
|
710b3d5fe966
improve interpreter tex Tables
Michael Godfrey <michaeldgodfrey@gmail.com>
parents:
17281
diff
changeset
|
699 }\hfill}} |
|
17521
3670ce8da1a0
doc: improve format of table 15.1 for TeX characters.
Michael Godfrey <michaeldgodfrey@gmail.com>
parents:
17469
diff
changeset
|
700 \hoffset72pt |
|
17469
710b3d5fe966
improve interpreter tex Tables
Michael Godfrey <michaeldgodfrey@gmail.com>
parents:
17281
diff
changeset
|
701 \symtable{Greek Lowercase Letters} {#} |
|
17521
3670ce8da1a0
doc: improve format of table 15.1 for TeX characters.
Michael Godfrey <michaeldgodfrey@gmail.com>
parents:
17469
diff
changeset
|
702 {& \hbox to \cola{$\backslash$alpha } && $\alpha$ |
|
3670ce8da1a0
doc: improve format of table 15.1 for TeX characters.
Michael Godfrey <michaeldgodfrey@gmail.com>
parents:
17469
diff
changeset
|
703 && \hbox to \colb{$\backslash$beta } && $\beta$ |
|
3670ce8da1a0
doc: improve format of table 15.1 for TeX characters.
Michael Godfrey <michaeldgodfrey@gmail.com>
parents:
17469
diff
changeset
|
704 && \hbox to \colc{$\backslash$gamma} && $\gamma$ &\cr |
|
17469
710b3d5fe966
improve interpreter tex Tables
Michael Godfrey <michaeldgodfrey@gmail.com>
parents:
17281
diff
changeset
|
705 & $\backslash$delta && $\delta$ |
|
710b3d5fe966
improve interpreter tex Tables
Michael Godfrey <michaeldgodfrey@gmail.com>
parents:
17281
diff
changeset
|
706 && $\backslash$epsilon && $\epsilon$ |
|
710b3d5fe966
improve interpreter tex Tables
Michael Godfrey <michaeldgodfrey@gmail.com>
parents:
17281
diff
changeset
|
707 && $\backslash$zeta && $\zeta$ &\cr |
|
710b3d5fe966
improve interpreter tex Tables
Michael Godfrey <michaeldgodfrey@gmail.com>
parents:
17281
diff
changeset
|
708 & $\backslash$eta && $\eta$ |
|
710b3d5fe966
improve interpreter tex Tables
Michael Godfrey <michaeldgodfrey@gmail.com>
parents:
17281
diff
changeset
|
709 && $\backslash$theta && $\theta$ |
|
710b3d5fe966
improve interpreter tex Tables
Michael Godfrey <michaeldgodfrey@gmail.com>
parents:
17281
diff
changeset
|
710 && $\backslash$vartheta && $\vartheta$ &\cr |
|
710b3d5fe966
improve interpreter tex Tables
Michael Godfrey <michaeldgodfrey@gmail.com>
parents:
17281
diff
changeset
|
711 & $\backslash$iota && $\iota$ |
|
710b3d5fe966
improve interpreter tex Tables
Michael Godfrey <michaeldgodfrey@gmail.com>
parents:
17281
diff
changeset
|
712 && $\backslash$kappa && $\kappa$ |
|
710b3d5fe966
improve interpreter tex Tables
Michael Godfrey <michaeldgodfrey@gmail.com>
parents:
17281
diff
changeset
|
713 && $\backslash$lambda && $\lambda$ &\cr |
|
710b3d5fe966
improve interpreter tex Tables
Michael Godfrey <michaeldgodfrey@gmail.com>
parents:
17281
diff
changeset
|
714 & $\backslash$mu && $\mu$ |
|
710b3d5fe966
improve interpreter tex Tables
Michael Godfrey <michaeldgodfrey@gmail.com>
parents:
17281
diff
changeset
|
715 && $\backslash$nu && $\nu$ |
|
710b3d5fe966
improve interpreter tex Tables
Michael Godfrey <michaeldgodfrey@gmail.com>
parents:
17281
diff
changeset
|
716 && $\backslash$xi && $\xi$ &\cr |
|
710b3d5fe966
improve interpreter tex Tables
Michael Godfrey <michaeldgodfrey@gmail.com>
parents:
17281
diff
changeset
|
717 & $\backslash$o && $o$ |
|
710b3d5fe966
improve interpreter tex Tables
Michael Godfrey <michaeldgodfrey@gmail.com>
parents:
17281
diff
changeset
|
718 && $\backslash$pi && $\pi$ |
|
710b3d5fe966
improve interpreter tex Tables
Michael Godfrey <michaeldgodfrey@gmail.com>
parents:
17281
diff
changeset
|
719 && $\backslash$varpi && $\varpi$ &\cr |
|
710b3d5fe966
improve interpreter tex Tables
Michael Godfrey <michaeldgodfrey@gmail.com>
parents:
17281
diff
changeset
|
720 & $\backslash$rho && $\rho$ |
|
710b3d5fe966
improve interpreter tex Tables
Michael Godfrey <michaeldgodfrey@gmail.com>
parents:
17281
diff
changeset
|
721 && $\backslash$sigma && $\sigma$ |
|
710b3d5fe966
improve interpreter tex Tables
Michael Godfrey <michaeldgodfrey@gmail.com>
parents:
17281
diff
changeset
|
722 && $\backslash$varsigma && $\varsigma$ &\cr |
|
710b3d5fe966
improve interpreter tex Tables
Michael Godfrey <michaeldgodfrey@gmail.com>
parents:
17281
diff
changeset
|
723 & $\backslash$tau && $\tau$ |
|
710b3d5fe966
improve interpreter tex Tables
Michael Godfrey <michaeldgodfrey@gmail.com>
parents:
17281
diff
changeset
|
724 && $\backslash$upsilon && $\upsilon$ |
|
710b3d5fe966
improve interpreter tex Tables
Michael Godfrey <michaeldgodfrey@gmail.com>
parents:
17281
diff
changeset
|
725 && $\backslash$phi && $\phi$ &\cr |
|
710b3d5fe966
improve interpreter tex Tables
Michael Godfrey <michaeldgodfrey@gmail.com>
parents:
17281
diff
changeset
|
726 & $\backslash$chi && $\chi$ |
|
710b3d5fe966
improve interpreter tex Tables
Michael Godfrey <michaeldgodfrey@gmail.com>
parents:
17281
diff
changeset
|
727 && $\backslash$psi && $\psi$ |
|
710b3d5fe966
improve interpreter tex Tables
Michael Godfrey <michaeldgodfrey@gmail.com>
parents:
17281
diff
changeset
|
728 && $\backslash$omega && $\omega$ &\cr} |
|
710b3d5fe966
improve interpreter tex Tables
Michael Godfrey <michaeldgodfrey@gmail.com>
parents:
17281
diff
changeset
|
729 \vskip12pt |
|
710b3d5fe966
improve interpreter tex Tables
Michael Godfrey <michaeldgodfrey@gmail.com>
parents:
17281
diff
changeset
|
730 \symtable{Greek Uppercase Letters} {#} |
|
17521
3670ce8da1a0
doc: improve format of table 15.1 for TeX characters.
Michael Godfrey <michaeldgodfrey@gmail.com>
parents:
17469
diff
changeset
|
731 {& \hbox to \cola{$\backslash$Gamma} && $\Gamma$ |
|
3670ce8da1a0
doc: improve format of table 15.1 for TeX characters.
Michael Godfrey <michaeldgodfrey@gmail.com>
parents:
17469
diff
changeset
|
732 && \hbox to \colb{$\backslash$Delta} && $\Delta$ |
|
3670ce8da1a0
doc: improve format of table 15.1 for TeX characters.
Michael Godfrey <michaeldgodfrey@gmail.com>
parents:
17469
diff
changeset
|
733 && \hbox to \colc{$\backslash$Theta} && $\Theta$ &\cr |
|
17469
710b3d5fe966
improve interpreter tex Tables
Michael Godfrey <michaeldgodfrey@gmail.com>
parents:
17281
diff
changeset
|
734 & $\backslash$Lambda && $\Lambda$ |
|
710b3d5fe966
improve interpreter tex Tables
Michael Godfrey <michaeldgodfrey@gmail.com>
parents:
17281
diff
changeset
|
735 && $\backslash$Xi && $\Xi$ |
|
710b3d5fe966
improve interpreter tex Tables
Michael Godfrey <michaeldgodfrey@gmail.com>
parents:
17281
diff
changeset
|
736 && $\backslash$Pi && $\Pi$ &\cr |
|
710b3d5fe966
improve interpreter tex Tables
Michael Godfrey <michaeldgodfrey@gmail.com>
parents:
17281
diff
changeset
|
737 & $\backslash$Sigma && $\Sigma$ |
|
710b3d5fe966
improve interpreter tex Tables
Michael Godfrey <michaeldgodfrey@gmail.com>
parents:
17281
diff
changeset
|
738 && $\backslash$Upsilon && $\Upsilon$ |
|
710b3d5fe966
improve interpreter tex Tables
Michael Godfrey <michaeldgodfrey@gmail.com>
parents:
17281
diff
changeset
|
739 && $\backslash$Phi && $\Phi$ &\cr |
|
710b3d5fe966
improve interpreter tex Tables
Michael Godfrey <michaeldgodfrey@gmail.com>
parents:
17281
diff
changeset
|
740 & $\backslash$Psi && $\Psi$ |
|
710b3d5fe966
improve interpreter tex Tables
Michael Godfrey <michaeldgodfrey@gmail.com>
parents:
17281
diff
changeset
|
741 && $\backslash$Omega && $\Omega$ |
|
710b3d5fe966
improve interpreter tex Tables
Michael Godfrey <michaeldgodfrey@gmail.com>
parents:
17281
diff
changeset
|
742 && && &\cr} |
|
710b3d5fe966
improve interpreter tex Tables
Michael Godfrey <michaeldgodfrey@gmail.com>
parents:
17281
diff
changeset
|
743 \vskip12pt |
|
710b3d5fe966
improve interpreter tex Tables
Michael Godfrey <michaeldgodfrey@gmail.com>
parents:
17281
diff
changeset
|
744 \symtable{Misc Symbols Type Ord} {#} |
|
17521
3670ce8da1a0
doc: improve format of table 15.1 for TeX characters.
Michael Godfrey <michaeldgodfrey@gmail.com>
parents:
17469
diff
changeset
|
745 {& \hbox to \cola{$\backslash$aleph} && $\aleph$ |
|
3670ce8da1a0
doc: improve format of table 15.1 for TeX characters.
Michael Godfrey <michaeldgodfrey@gmail.com>
parents:
17469
diff
changeset
|
746 && \hbox to \colb{$\backslash$wp} && $\wp$ |
|
3670ce8da1a0
doc: improve format of table 15.1 for TeX characters.
Michael Godfrey <michaeldgodfrey@gmail.com>
parents:
17469
diff
changeset
|
747 && \hbox to \colc{$\backslash$Re} && $\Re$ &\cr |
|
17469
710b3d5fe966
improve interpreter tex Tables
Michael Godfrey <michaeldgodfrey@gmail.com>
parents:
17281
diff
changeset
|
748 & $\backslash$Im && $\Im$ |
|
710b3d5fe966
improve interpreter tex Tables
Michael Godfrey <michaeldgodfrey@gmail.com>
parents:
17281
diff
changeset
|
749 && $\backslash$partial && $\partial$ |
|
710b3d5fe966
improve interpreter tex Tables
Michael Godfrey <michaeldgodfrey@gmail.com>
parents:
17281
diff
changeset
|
750 && $\backslash$infty && $\infty$ &\cr |
|
710b3d5fe966
improve interpreter tex Tables
Michael Godfrey <michaeldgodfrey@gmail.com>
parents:
17281
diff
changeset
|
751 & $\backslash$prime && $\prime$ |
|
710b3d5fe966
improve interpreter tex Tables
Michael Godfrey <michaeldgodfrey@gmail.com>
parents:
17281
diff
changeset
|
752 && $\backslash$nabla && $\nabla$ |
|
710b3d5fe966
improve interpreter tex Tables
Michael Godfrey <michaeldgodfrey@gmail.com>
parents:
17281
diff
changeset
|
753 && $\backslash$surd && $\surd$ &\cr |
|
710b3d5fe966
improve interpreter tex Tables
Michael Godfrey <michaeldgodfrey@gmail.com>
parents:
17281
diff
changeset
|
754 & $\backslash$angle && $\angle$ |
|
710b3d5fe966
improve interpreter tex Tables
Michael Godfrey <michaeldgodfrey@gmail.com>
parents:
17281
diff
changeset
|
755 && $\backslash$forall && $\forall$ |
|
710b3d5fe966
improve interpreter tex Tables
Michael Godfrey <michaeldgodfrey@gmail.com>
parents:
17281
diff
changeset
|
756 && $\backslash$exists && $\exists$ &\cr |
|
710b3d5fe966
improve interpreter tex Tables
Michael Godfrey <michaeldgodfrey@gmail.com>
parents:
17281
diff
changeset
|
757 & $\backslash$neg && $\neg$ |
|
710b3d5fe966
improve interpreter tex Tables
Michael Godfrey <michaeldgodfrey@gmail.com>
parents:
17281
diff
changeset
|
758 && $\backslash$clubsuit && $\clubsuit$ |
|
710b3d5fe966
improve interpreter tex Tables
Michael Godfrey <michaeldgodfrey@gmail.com>
parents:
17281
diff
changeset
|
759 && $\backslash$diamondsuit && $\diamondsuit$ &\cr |
|
710b3d5fe966
improve interpreter tex Tables
Michael Godfrey <michaeldgodfrey@gmail.com>
parents:
17281
diff
changeset
|
760 & $\backslash$heartsuit && $\heartsuit$ |
|
710b3d5fe966
improve interpreter tex Tables
Michael Godfrey <michaeldgodfrey@gmail.com>
parents:
17281
diff
changeset
|
761 && $\backslash$spadesuit && $\spadesuit$ |
|
710b3d5fe966
improve interpreter tex Tables
Michael Godfrey <michaeldgodfrey@gmail.com>
parents:
17281
diff
changeset
|
762 && && &\cr} |
|
710b3d5fe966
improve interpreter tex Tables
Michael Godfrey <michaeldgodfrey@gmail.com>
parents:
17281
diff
changeset
|
763 \vskip12pt |
|
710b3d5fe966
improve interpreter tex Tables
Michael Godfrey <michaeldgodfrey@gmail.com>
parents:
17281
diff
changeset
|
764 \symtable{``Large'' Operators} {#} |
|
17521
3670ce8da1a0
doc: improve format of table 15.1 for TeX characters.
Michael Godfrey <michaeldgodfrey@gmail.com>
parents:
17469
diff
changeset
|
765 {& \hbox to \cola{$\backslash$int} && $\int$ |
|
3670ce8da1a0
doc: improve format of table 15.1 for TeX characters.
Michael Godfrey <michaeldgodfrey@gmail.com>
parents:
17469
diff
changeset
|
766 && \hbox to \colb{} && |
|
3670ce8da1a0
doc: improve format of table 15.1 for TeX characters.
Michael Godfrey <michaeldgodfrey@gmail.com>
parents:
17469
diff
changeset
|
767 && \hbox to \colc{} && &\cr} |
|
17469
710b3d5fe966
improve interpreter tex Tables
Michael Godfrey <michaeldgodfrey@gmail.com>
parents:
17281
diff
changeset
|
768 \vskip12pt |
|
710b3d5fe966
improve interpreter tex Tables
Michael Godfrey <michaeldgodfrey@gmail.com>
parents:
17281
diff
changeset
|
769 \symtable{Binary operators} {#} |
|
17521
3670ce8da1a0
doc: improve format of table 15.1 for TeX characters.
Michael Godfrey <michaeldgodfrey@gmail.com>
parents:
17469
diff
changeset
|
770 {& \hbox to \cola{$\backslash$pm} && $\pm$ |
|
3670ce8da1a0
doc: improve format of table 15.1 for TeX characters.
Michael Godfrey <michaeldgodfrey@gmail.com>
parents:
17469
diff
changeset
|
771 && \hbox to \colb{$\backslash$cdot} && $\cdot$ |
|
3670ce8da1a0
doc: improve format of table 15.1 for TeX characters.
Michael Godfrey <michaeldgodfrey@gmail.com>
parents:
17469
diff
changeset
|
772 && \hbox to \colc{$\backslash$times} && $\times$ &\cr |
|
17469
710b3d5fe966
improve interpreter tex Tables
Michael Godfrey <michaeldgodfrey@gmail.com>
parents:
17281
diff
changeset
|
773 & $\backslash$ast && $\ast$ |
|
710b3d5fe966
improve interpreter tex Tables
Michael Godfrey <michaeldgodfrey@gmail.com>
parents:
17281
diff
changeset
|
774 && $\backslash$circ && $\circ$ |
|
710b3d5fe966
improve interpreter tex Tables
Michael Godfrey <michaeldgodfrey@gmail.com>
parents:
17281
diff
changeset
|
775 && $\backslash$bullet && $\bullet$ &\cr |
|
710b3d5fe966
improve interpreter tex Tables
Michael Godfrey <michaeldgodfrey@gmail.com>
parents:
17281
diff
changeset
|
776 & $\backslash$div && $\div$ |
|
710b3d5fe966
improve interpreter tex Tables
Michael Godfrey <michaeldgodfrey@gmail.com>
parents:
17281
diff
changeset
|
777 && $\backslash$cap && $\cap$ |
|
710b3d5fe966
improve interpreter tex Tables
Michael Godfrey <michaeldgodfrey@gmail.com>
parents:
17281
diff
changeset
|
778 && $\backslash$cup && $\cup$ &\cr |
|
710b3d5fe966
improve interpreter tex Tables
Michael Godfrey <michaeldgodfrey@gmail.com>
parents:
17281
diff
changeset
|
779 & $\backslash$vee && $\vee$ |
|
710b3d5fe966
improve interpreter tex Tables
Michael Godfrey <michaeldgodfrey@gmail.com>
parents:
17281
diff
changeset
|
780 && $\backslash$wedge && $\wedge$ |
|
710b3d5fe966
improve interpreter tex Tables
Michael Godfrey <michaeldgodfrey@gmail.com>
parents:
17281
diff
changeset
|
781 && $\backslash$oplus && $\oplus$ &\cr |
|
710b3d5fe966
improve interpreter tex Tables
Michael Godfrey <michaeldgodfrey@gmail.com>
parents:
17281
diff
changeset
|
782 & $\backslash$otimes && $\otimes$ |
|
710b3d5fe966
improve interpreter tex Tables
Michael Godfrey <michaeldgodfrey@gmail.com>
parents:
17281
diff
changeset
|
783 && $\backslash$oslash && $\oslash$ |
|
710b3d5fe966
improve interpreter tex Tables
Michael Godfrey <michaeldgodfrey@gmail.com>
parents:
17281
diff
changeset
|
784 && && &\cr} |
|
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
785 @end tex |
|
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
786 @ifnottex |
|
17469
710b3d5fe966
improve interpreter tex Tables
Michael Godfrey <michaeldgodfrey@gmail.com>
parents:
17281
diff
changeset
|
787 @multitable @columnfractions .25 .25 .25 .25 |
|
710b3d5fe966
improve interpreter tex Tables
Michael Godfrey <michaeldgodfrey@gmail.com>
parents:
17281
diff
changeset
|
788 @item Greek Lowercase Letters |
|
710b3d5fe966
improve interpreter tex Tables
Michael Godfrey <michaeldgodfrey@gmail.com>
parents:
17281
diff
changeset
|
789 @item @tab \alpha @tab \beta @tab \gamma |
|
710b3d5fe966
improve interpreter tex Tables
Michael Godfrey <michaeldgodfrey@gmail.com>
parents:
17281
diff
changeset
|
790 @item @tab \delta @tab \epsilon @tab \zeta |
|
710b3d5fe966
improve interpreter tex Tables
Michael Godfrey <michaeldgodfrey@gmail.com>
parents:
17281
diff
changeset
|
791 @item @tab \eta @tab \theta @tab \vartheta |
|
710b3d5fe966
improve interpreter tex Tables
Michael Godfrey <michaeldgodfrey@gmail.com>
parents:
17281
diff
changeset
|
792 @item @tab \iota @tab \kappa @tab \lambda |
|
710b3d5fe966
improve interpreter tex Tables
Michael Godfrey <michaeldgodfrey@gmail.com>
parents:
17281
diff
changeset
|
793 @item @tab \mu @tab \nu @tab \xi |
|
710b3d5fe966
improve interpreter tex Tables
Michael Godfrey <michaeldgodfrey@gmail.com>
parents:
17281
diff
changeset
|
794 @item @tab \o @tab \pi @tab \varpi |
|
710b3d5fe966
improve interpreter tex Tables
Michael Godfrey <michaeldgodfrey@gmail.com>
parents:
17281
diff
changeset
|
795 @item @tab \rho @tab \sigma @tab \varsigma |
|
710b3d5fe966
improve interpreter tex Tables
Michael Godfrey <michaeldgodfrey@gmail.com>
parents:
17281
diff
changeset
|
796 @item @tab \tau @tab \upsilon @tab \phi |
|
710b3d5fe966
improve interpreter tex Tables
Michael Godfrey <michaeldgodfrey@gmail.com>
parents:
17281
diff
changeset
|
797 @item @tab \chi @tab \psi @tab \omega |
|
710b3d5fe966
improve interpreter tex Tables
Michael Godfrey <michaeldgodfrey@gmail.com>
parents:
17281
diff
changeset
|
798 @item Greek Uppercase Letters |
|
710b3d5fe966
improve interpreter tex Tables
Michael Godfrey <michaeldgodfrey@gmail.com>
parents:
17281
diff
changeset
|
799 @item @tab \Gamma @tab \Delta @tab \Theta |
|
710b3d5fe966
improve interpreter tex Tables
Michael Godfrey <michaeldgodfrey@gmail.com>
parents:
17281
diff
changeset
|
800 @item @tab \Lambda @tab \Xi @tab \Pi |
|
710b3d5fe966
improve interpreter tex Tables
Michael Godfrey <michaeldgodfrey@gmail.com>
parents:
17281
diff
changeset
|
801 @item @tab \Sigma @tab \Upsilon @tab \Phi |
|
710b3d5fe966
improve interpreter tex Tables
Michael Godfrey <michaeldgodfrey@gmail.com>
parents:
17281
diff
changeset
|
802 @item @tab \Psi @tab \Omega @tab |
|
710b3d5fe966
improve interpreter tex Tables
Michael Godfrey <michaeldgodfrey@gmail.com>
parents:
17281
diff
changeset
|
803 @item Misc Symbols Type Ord |
|
710b3d5fe966
improve interpreter tex Tables
Michael Godfrey <michaeldgodfrey@gmail.com>
parents:
17281
diff
changeset
|
804 @item @tab \aleph @tab \wp @tab \Re |
|
710b3d5fe966
improve interpreter tex Tables
Michael Godfrey <michaeldgodfrey@gmail.com>
parents:
17281
diff
changeset
|
805 @item @tab \Im @tab \partial @tab \infty |
|
710b3d5fe966
improve interpreter tex Tables
Michael Godfrey <michaeldgodfrey@gmail.com>
parents:
17281
diff
changeset
|
806 @item @tab \prime @tab \nabla @tab \surd |
|
710b3d5fe966
improve interpreter tex Tables
Michael Godfrey <michaeldgodfrey@gmail.com>
parents:
17281
diff
changeset
|
807 @item @tab \angle @tab \forall @tab \exists |
|
710b3d5fe966
improve interpreter tex Tables
Michael Godfrey <michaeldgodfrey@gmail.com>
parents:
17281
diff
changeset
|
808 @item @tab \neg @tab \clubsuit @tab \diamondsuit |
|
710b3d5fe966
improve interpreter tex Tables
Michael Godfrey <michaeldgodfrey@gmail.com>
parents:
17281
diff
changeset
|
809 @item @tab \heartsuit @tab \spadesuit @tab |
|
710b3d5fe966
improve interpreter tex Tables
Michael Godfrey <michaeldgodfrey@gmail.com>
parents:
17281
diff
changeset
|
810 @item ``Large'' Operators |
|
710b3d5fe966
improve interpreter tex Tables
Michael Godfrey <michaeldgodfrey@gmail.com>
parents:
17281
diff
changeset
|
811 @item @tab \int |
|
710b3d5fe966
improve interpreter tex Tables
Michael Godfrey <michaeldgodfrey@gmail.com>
parents:
17281
diff
changeset
|
812 @item Binary Operators |
|
710b3d5fe966
improve interpreter tex Tables
Michael Godfrey <michaeldgodfrey@gmail.com>
parents:
17281
diff
changeset
|
813 @item @tab \pm @tab \cdot @tab \times |
|
710b3d5fe966
improve interpreter tex Tables
Michael Godfrey <michaeldgodfrey@gmail.com>
parents:
17281
diff
changeset
|
814 @item @tab \ast @tab \circ @tab \bullet |
|
710b3d5fe966
improve interpreter tex Tables
Michael Godfrey <michaeldgodfrey@gmail.com>
parents:
17281
diff
changeset
|
815 @item @tab \div @tab \cap @tab \cup |
|
710b3d5fe966
improve interpreter tex Tables
Michael Godfrey <michaeldgodfrey@gmail.com>
parents:
17281
diff
changeset
|
816 @item @tab \vee @tab \wedge @tab \oplus |
|
710b3d5fe966
improve interpreter tex Tables
Michael Godfrey <michaeldgodfrey@gmail.com>
parents:
17281
diff
changeset
|
817 @item @tab \otimes @tab \oslash @tab |
|
710b3d5fe966
improve interpreter tex Tables
Michael Godfrey <michaeldgodfrey@gmail.com>
parents:
17281
diff
changeset
|
818 @item Relations |
|
710b3d5fe966
improve interpreter tex Tables
Michael Godfrey <michaeldgodfrey@gmail.com>
parents:
17281
diff
changeset
|
819 @item @tab \leq @tab \subset @tab \subseteq |
|
710b3d5fe966
improve interpreter tex Tables
Michael Godfrey <michaeldgodfrey@gmail.com>
parents:
17281
diff
changeset
|
820 @item @tab \in @tab \geq @tab \supset |
|
710b3d5fe966
improve interpreter tex Tables
Michael Godfrey <michaeldgodfrey@gmail.com>
parents:
17281
diff
changeset
|
821 @item @tab \supseteq @tab \ni @tab \mid |
|
710b3d5fe966
improve interpreter tex Tables
Michael Godfrey <michaeldgodfrey@gmail.com>
parents:
17281
diff
changeset
|
822 @item @tab \equiv @tab \sim @tab \approx |
|
710b3d5fe966
improve interpreter tex Tables
Michael Godfrey <michaeldgodfrey@gmail.com>
parents:
17281
diff
changeset
|
823 @item @tab \cong @tab \propto @tab \perp |
|
710b3d5fe966
improve interpreter tex Tables
Michael Godfrey <michaeldgodfrey@gmail.com>
parents:
17281
diff
changeset
|
824 @item Arrows |
|
710b3d5fe966
improve interpreter tex Tables
Michael Godfrey <michaeldgodfrey@gmail.com>
parents:
17281
diff
changeset
|
825 @item @tab \leftarrow @tab \Leftarrow @tab \rightarrow |
|
710b3d5fe966
improve interpreter tex Tables
Michael Godfrey <michaeldgodfrey@gmail.com>
parents:
17281
diff
changeset
|
826 @item @tab \Rightarrow @tab \leftrightarrow @tab \uparrow |
|
710b3d5fe966
improve interpreter tex Tables
Michael Godfrey <michaeldgodfrey@gmail.com>
parents:
17281
diff
changeset
|
827 @item @tab \downarrow @tab @tab |
|
710b3d5fe966
improve interpreter tex Tables
Michael Godfrey <michaeldgodfrey@gmail.com>
parents:
17281
diff
changeset
|
828 @item Openings and Closings |
|
710b3d5fe966
improve interpreter tex Tables
Michael Godfrey <michaeldgodfrey@gmail.com>
parents:
17281
diff
changeset
|
829 @item @tab \lfloor @tab \langle @tab \lceil |
|
710b3d5fe966
improve interpreter tex Tables
Michael Godfrey <michaeldgodfrey@gmail.com>
parents:
17281
diff
changeset
|
830 @item @tab \rfloor @tab \rangle @tab \rceil |
|
710b3d5fe966
improve interpreter tex Tables
Michael Godfrey <michaeldgodfrey@gmail.com>
parents:
17281
diff
changeset
|
831 @item Alternate Names |
|
710b3d5fe966
improve interpreter tex Tables
Michael Godfrey <michaeldgodfrey@gmail.com>
parents:
17281
diff
changeset
|
832 @item @tab \neq |
|
710b3d5fe966
improve interpreter tex Tables
Michael Godfrey <michaeldgodfrey@gmail.com>
parents:
17281
diff
changeset
|
833 @item Other |
|
710b3d5fe966
improve interpreter tex Tables
Michael Godfrey <michaeldgodfrey@gmail.com>
parents:
17281
diff
changeset
|
834 @item @tab \ldots @tab \0 @tab \copyright |
|
710b3d5fe966
improve interpreter tex Tables
Michael Godfrey <michaeldgodfrey@gmail.com>
parents:
17281
diff
changeset
|
835 @item @tab \deg |
|
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
836 @end multitable |
|
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
837 @end ifnottex |
|
9758
09da0bd91412
Periodic grammar check of Octave documentation files to ensure common format
Rik <rdrider0-list@yahoo.com>
parents:
9752
diff
changeset
|
838 @caption{Available special characters in @TeX{} mode} |
|
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
839 @end float |
|
17469
710b3d5fe966
improve interpreter tex Tables
Michael Godfrey <michaeldgodfrey@gmail.com>
parents:
17281
diff
changeset
|
840 @float |
|
710b3d5fe966
improve interpreter tex Tables
Michael Godfrey <michaeldgodfrey@gmail.com>
parents:
17281
diff
changeset
|
841 @tex |
|
710b3d5fe966
improve interpreter tex Tables
Michael Godfrey <michaeldgodfrey@gmail.com>
parents:
17281
diff
changeset
|
842 \vskip 6pt |
|
17521
3670ce8da1a0
doc: improve format of table 15.1 for TeX characters.
Michael Godfrey <michaeldgodfrey@gmail.com>
parents:
17469
diff
changeset
|
843 \newdimen\cola \cola=78pt |
|
3670ce8da1a0
doc: improve format of table 15.1 for TeX characters.
Michael Godfrey <michaeldgodfrey@gmail.com>
parents:
17469
diff
changeset
|
844 \newdimen\colb \colb=78pt |
|
3670ce8da1a0
doc: improve format of table 15.1 for TeX characters.
Michael Godfrey <michaeldgodfrey@gmail.com>
parents:
17469
diff
changeset
|
845 \newdimen\colc \colc=78pt |
|
17469
710b3d5fe966
improve interpreter tex Tables
Michael Godfrey <michaeldgodfrey@gmail.com>
parents:
17281
diff
changeset
|
846 \def\symtable#1#2#3{\hbox to \hsize {\hfill\vbox{\offinterlineskip \tabskip=0pt |
|
710b3d5fe966
improve interpreter tex Tables
Michael Godfrey <michaeldgodfrey@gmail.com>
parents:
17281
diff
changeset
|
847 \hskip36pt #1 |
|
710b3d5fe966
improve interpreter tex Tables
Michael Godfrey <michaeldgodfrey@gmail.com>
parents:
17281
diff
changeset
|
848 \vskip6pt |
|
710b3d5fe966
improve interpreter tex Tables
Michael Godfrey <michaeldgodfrey@gmail.com>
parents:
17281
diff
changeset
|
849 \halign{ |
|
710b3d5fe966
improve interpreter tex Tables
Michael Godfrey <michaeldgodfrey@gmail.com>
parents:
17281
diff
changeset
|
850 \vrule height2.0ex depth1.ex width 0.6pt #2\tabskip=0.3em & |
|
710b3d5fe966
improve interpreter tex Tables
Michael Godfrey <michaeldgodfrey@gmail.com>
parents:
17281
diff
changeset
|
851 #2 \hfil & \vrule #2 & #2 \hfil & #2 \vrule & |
|
710b3d5fe966
improve interpreter tex Tables
Michael Godfrey <michaeldgodfrey@gmail.com>
parents:
17281
diff
changeset
|
852 #2 \hfil & \vrule #2 & #2 \hfil & #2 \vrule & |
|
710b3d5fe966
improve interpreter tex Tables
Michael Godfrey <michaeldgodfrey@gmail.com>
parents:
17281
diff
changeset
|
853 #2 \hfil & \vrule #2 & #2 \hfil & #2 \vrule |
|
710b3d5fe966
improve interpreter tex Tables
Michael Godfrey <michaeldgodfrey@gmail.com>
parents:
17281
diff
changeset
|
854 width 0.6pt \tabskip=0pt\cr |
|
710b3d5fe966
improve interpreter tex Tables
Michael Godfrey <michaeldgodfrey@gmail.com>
parents:
17281
diff
changeset
|
855 \noalign{\hrule height 0.6pt} |
|
710b3d5fe966
improve interpreter tex Tables
Michael Godfrey <michaeldgodfrey@gmail.com>
parents:
17281
diff
changeset
|
856 & Code && Sym && Code && Sym && Code && Sym &\cr |
|
710b3d5fe966
improve interpreter tex Tables
Michael Godfrey <michaeldgodfrey@gmail.com>
parents:
17281
diff
changeset
|
857 \noalign{\hrule} |
|
710b3d5fe966
improve interpreter tex Tables
Michael Godfrey <michaeldgodfrey@gmail.com>
parents:
17281
diff
changeset
|
858 #3 |
|
710b3d5fe966
improve interpreter tex Tables
Michael Godfrey <michaeldgodfrey@gmail.com>
parents:
17281
diff
changeset
|
859 \noalign{\hrule height 0.6pt} |
|
710b3d5fe966
improve interpreter tex Tables
Michael Godfrey <michaeldgodfrey@gmail.com>
parents:
17281
diff
changeset
|
860 } |
|
710b3d5fe966
improve interpreter tex Tables
Michael Godfrey <michaeldgodfrey@gmail.com>
parents:
17281
diff
changeset
|
861 }\hfill}} |
|
17521
3670ce8da1a0
doc: improve format of table 15.1 for TeX characters.
Michael Godfrey <michaeldgodfrey@gmail.com>
parents:
17469
diff
changeset
|
862 \hoffset72pt |
|
3670ce8da1a0
doc: improve format of table 15.1 for TeX characters.
Michael Godfrey <michaeldgodfrey@gmail.com>
parents:
17469
diff
changeset
|
863 \vskip12pt |
|
17469
710b3d5fe966
improve interpreter tex Tables
Michael Godfrey <michaeldgodfrey@gmail.com>
parents:
17281
diff
changeset
|
864 \symtable{Relations} {#} |
|
17521
3670ce8da1a0
doc: improve format of table 15.1 for TeX characters.
Michael Godfrey <michaeldgodfrey@gmail.com>
parents:
17469
diff
changeset
|
865 {& \hbox to \cola{$\backslash$leq} && $\leq$ |
|
3670ce8da1a0
doc: improve format of table 15.1 for TeX characters.
Michael Godfrey <michaeldgodfrey@gmail.com>
parents:
17469
diff
changeset
|
866 && \hbox to \colb{$\backslash$subset} && $\subset$ |
|
3670ce8da1a0
doc: improve format of table 15.1 for TeX characters.
Michael Godfrey <michaeldgodfrey@gmail.com>
parents:
17469
diff
changeset
|
867 && \hbox to \colc{$\backslash$subseteq} && $\subseteq$ &\cr |
|
17469
710b3d5fe966
improve interpreter tex Tables
Michael Godfrey <michaeldgodfrey@gmail.com>
parents:
17281
diff
changeset
|
868 & $\backslash$in && $\in$ |
|
710b3d5fe966
improve interpreter tex Tables
Michael Godfrey <michaeldgodfrey@gmail.com>
parents:
17281
diff
changeset
|
869 && $\backslash$geq && $\geq$ |
|
710b3d5fe966
improve interpreter tex Tables
Michael Godfrey <michaeldgodfrey@gmail.com>
parents:
17281
diff
changeset
|
870 && $\backslash$supset && $\supset$ &\cr |
|
710b3d5fe966
improve interpreter tex Tables
Michael Godfrey <michaeldgodfrey@gmail.com>
parents:
17281
diff
changeset
|
871 & $\backslash$supseteq && $\supseteq$ |
|
710b3d5fe966
improve interpreter tex Tables
Michael Godfrey <michaeldgodfrey@gmail.com>
parents:
17281
diff
changeset
|
872 && $\backslash$ni && $\ni$ |
|
710b3d5fe966
improve interpreter tex Tables
Michael Godfrey <michaeldgodfrey@gmail.com>
parents:
17281
diff
changeset
|
873 && $\backslash$mid && $\mid$ &\cr |
|
710b3d5fe966
improve interpreter tex Tables
Michael Godfrey <michaeldgodfrey@gmail.com>
parents:
17281
diff
changeset
|
874 & $\backslash$equiv && $\equiv$ |
|
710b3d5fe966
improve interpreter tex Tables
Michael Godfrey <michaeldgodfrey@gmail.com>
parents:
17281
diff
changeset
|
875 && $\backslash$sim && $\sim$ |
|
710b3d5fe966
improve interpreter tex Tables
Michael Godfrey <michaeldgodfrey@gmail.com>
parents:
17281
diff
changeset
|
876 && $\backslash$approx && $\approx$ &\cr |
|
710b3d5fe966
improve interpreter tex Tables
Michael Godfrey <michaeldgodfrey@gmail.com>
parents:
17281
diff
changeset
|
877 & $\backslash$cong && $\cong$ |
|
710b3d5fe966
improve interpreter tex Tables
Michael Godfrey <michaeldgodfrey@gmail.com>
parents:
17281
diff
changeset
|
878 && $\backslash$propto && $\propto$ |
|
710b3d5fe966
improve interpreter tex Tables
Michael Godfrey <michaeldgodfrey@gmail.com>
parents:
17281
diff
changeset
|
879 && $\backslash$perp && $\perp$ &\cr} |
|
17521
3670ce8da1a0
doc: improve format of table 15.1 for TeX characters.
Michael Godfrey <michaeldgodfrey@gmail.com>
parents:
17469
diff
changeset
|
880 \vskip12pt |
|
17469
710b3d5fe966
improve interpreter tex Tables
Michael Godfrey <michaeldgodfrey@gmail.com>
parents:
17281
diff
changeset
|
881 \symtable{Arrows} {#} |
|
17521
3670ce8da1a0
doc: improve format of table 15.1 for TeX characters.
Michael Godfrey <michaeldgodfrey@gmail.com>
parents:
17469
diff
changeset
|
882 {& \hbox to \cola{$\backslash$leftarrow} && $\leftarrow$ |
|
3670ce8da1a0
doc: improve format of table 15.1 for TeX characters.
Michael Godfrey <michaeldgodfrey@gmail.com>
parents:
17469
diff
changeset
|
883 && \hbox to \colb{$\backslash$Leftarrow} && $\Leftarrow$ |
|
3670ce8da1a0
doc: improve format of table 15.1 for TeX characters.
Michael Godfrey <michaeldgodfrey@gmail.com>
parents:
17469
diff
changeset
|
884 && \hbox to \colc{$\backslash$rightarrow} && $\rightarrow$ &\cr |
|
17469
710b3d5fe966
improve interpreter tex Tables
Michael Godfrey <michaeldgodfrey@gmail.com>
parents:
17281
diff
changeset
|
885 & $\backslash$Rightarrow && $\Rightarrow$ |
|
710b3d5fe966
improve interpreter tex Tables
Michael Godfrey <michaeldgodfrey@gmail.com>
parents:
17281
diff
changeset
|
886 && $\backslash$leftrightarrow && $\leftrightarrow$ |
|
710b3d5fe966
improve interpreter tex Tables
Michael Godfrey <michaeldgodfrey@gmail.com>
parents:
17281
diff
changeset
|
887 && $\backslash$uparrow && $\uparrow$ &\cr |
|
710b3d5fe966
improve interpreter tex Tables
Michael Godfrey <michaeldgodfrey@gmail.com>
parents:
17281
diff
changeset
|
888 & $\backslash$downarrow && $\downarrow$ |
|
19790
446c46af4b42
strip trailing whitespace from most source files
John W. Eaton <jwe@octave.org>
parents:
19203
diff
changeset
|
889 && && |
|
17469
710b3d5fe966
improve interpreter tex Tables
Michael Godfrey <michaeldgodfrey@gmail.com>
parents:
17281
diff
changeset
|
890 && && &\cr} |
|
710b3d5fe966
improve interpreter tex Tables
Michael Godfrey <michaeldgodfrey@gmail.com>
parents:
17281
diff
changeset
|
891 \vskip12pt |
|
710b3d5fe966
improve interpreter tex Tables
Michael Godfrey <michaeldgodfrey@gmail.com>
parents:
17281
diff
changeset
|
892 \symtable{Openings and Closings} {#} |
|
17521
3670ce8da1a0
doc: improve format of table 15.1 for TeX characters.
Michael Godfrey <michaeldgodfrey@gmail.com>
parents:
17469
diff
changeset
|
893 {& \hbox to \cola{$\backslash$lfloor } && $\lfloor$ |
|
3670ce8da1a0
doc: improve format of table 15.1 for TeX characters.
Michael Godfrey <michaeldgodfrey@gmail.com>
parents:
17469
diff
changeset
|
894 && \hbox to \colb{$\backslash$langle } && $\langle$ |
|
3670ce8da1a0
doc: improve format of table 15.1 for TeX characters.
Michael Godfrey <michaeldgodfrey@gmail.com>
parents:
17469
diff
changeset
|
895 && \hbox to \colc{$\backslash$lceil } && $\lceil$ &\cr |
|
17469
710b3d5fe966
improve interpreter tex Tables
Michael Godfrey <michaeldgodfrey@gmail.com>
parents:
17281
diff
changeset
|
896 & $\backslash$rfloor && $\rfloor$ |
|
710b3d5fe966
improve interpreter tex Tables
Michael Godfrey <michaeldgodfrey@gmail.com>
parents:
17281
diff
changeset
|
897 && $\backslash$rangle && $\rangle$ |
|
710b3d5fe966
improve interpreter tex Tables
Michael Godfrey <michaeldgodfrey@gmail.com>
parents:
17281
diff
changeset
|
898 && $\backslash$rceil && $\rceil$ &\cr} |
|
710b3d5fe966
improve interpreter tex Tables
Michael Godfrey <michaeldgodfrey@gmail.com>
parents:
17281
diff
changeset
|
899 \vskip12pt |
|
710b3d5fe966
improve interpreter tex Tables
Michael Godfrey <michaeldgodfrey@gmail.com>
parents:
17281
diff
changeset
|
900 \symtable{Alternate Names} {#} |
|
17521
3670ce8da1a0
doc: improve format of table 15.1 for TeX characters.
Michael Godfrey <michaeldgodfrey@gmail.com>
parents:
17469
diff
changeset
|
901 {& \hbox to \cola{$\backslash$neq} && $\neq$ |
|
19790
446c46af4b42
strip trailing whitespace from most source files
John W. Eaton <jwe@octave.org>
parents:
19203
diff
changeset
|
902 && \hbox to \colb{} && |
|
17521
3670ce8da1a0
doc: improve format of table 15.1 for TeX characters.
Michael Godfrey <michaeldgodfrey@gmail.com>
parents:
17469
diff
changeset
|
903 && \hbox to \colc{} && &\cr} |
|
17469
710b3d5fe966
improve interpreter tex Tables
Michael Godfrey <michaeldgodfrey@gmail.com>
parents:
17281
diff
changeset
|
904 \vskip12pt |
|
710b3d5fe966
improve interpreter tex Tables
Michael Godfrey <michaeldgodfrey@gmail.com>
parents:
17281
diff
changeset
|
905 \symtable{Other (not in Appendix F Tables)} {#} |
|
17521
3670ce8da1a0
doc: improve format of table 15.1 for TeX characters.
Michael Godfrey <michaeldgodfrey@gmail.com>
parents:
17469
diff
changeset
|
906 {& \hbox to \cola{$\backslash$ldots} && $\ldots$ |
|
3670ce8da1a0
doc: improve format of table 15.1 for TeX characters.
Michael Godfrey <michaeldgodfrey@gmail.com>
parents:
17469
diff
changeset
|
907 && \hbox to \colb{$\backslash$0} && $\oslash$ |
|
3670ce8da1a0
doc: improve format of table 15.1 for TeX characters.
Michael Godfrey <michaeldgodfrey@gmail.com>
parents:
17469
diff
changeset
|
908 && \hbox to \colc{$\backslash$copyright} && $\copyright$ &\cr |
|
17524
797545fa86d0
plot.txi: fix \deg in TeX symbol table.
Michael Godfrey <michaeldgodfrey@gmail.com>
parents:
17521
diff
changeset
|
909 & $\backslash$deg && $^\circ$ |
|
19790
446c46af4b42
strip trailing whitespace from most source files
John W. Eaton <jwe@octave.org>
parents:
19203
diff
changeset
|
910 && && |
|
17469
710b3d5fe966
improve interpreter tex Tables
Michael Godfrey <michaeldgodfrey@gmail.com>
parents:
17281
diff
changeset
|
911 && && &\cr} |
|
710b3d5fe966
improve interpreter tex Tables
Michael Godfrey <michaeldgodfrey@gmail.com>
parents:
17281
diff
changeset
|
912 \vskip12pt |
|
710b3d5fe966
improve interpreter tex Tables
Michael Godfrey <michaeldgodfrey@gmail.com>
parents:
17281
diff
changeset
|
913 \hskip36pt Table 15.1: Available special characters in \TeX\ mode (cont.) |
|
710b3d5fe966
improve interpreter tex Tables
Michael Godfrey <michaeldgodfrey@gmail.com>
parents:
17281
diff
changeset
|
914 @end tex |
|
710b3d5fe966
improve interpreter tex Tables
Michael Godfrey <michaeldgodfrey@gmail.com>
parents:
17281
diff
changeset
|
915 @end float |
|
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
916 |
|
11254
31f8534eb055
Add reference to new saveas function in printed manual.
Rik <octave@nomad.inbox5.com>
parents:
10846
diff
changeset
|
917 @node Printing and Saving Plots |
|
31f8534eb055
Add reference to new saveas function in printed manual.
Rik <octave@nomad.inbox5.com>
parents:
10846
diff
changeset
|
918 @subsection Printing and Saving Plots |
|
18398
200851c87444
Edits to Manual and indicies
Michael Godfrey <michaeldgodfrey@gmail.com>
parents:
17957
diff
changeset
|
919 @cindex plotting, saving and printing plots |
|
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
920 @cindex printing plots |
|
11254
31f8534eb055
Add reference to new saveas function in printed manual.
Rik <octave@nomad.inbox5.com>
parents:
10846
diff
changeset
|
921 @cindex saving plots |
| 6888 | 922 |
|
14456
05635e4c605a
Improve documentation for print().
Ben Abbott <bpabbott@mac.com>
parents:
14138
diff
changeset
|
923 The @code{print} command allows you to send plots to you printer and |
|
05635e4c605a
Improve documentation for print().
Ben Abbott <bpabbott@mac.com>
parents:
14138
diff
changeset
|
924 to save plots in a variety of formats. For example, |
|
05635e4c605a
Improve documentation for print().
Ben Abbott <bpabbott@mac.com>
parents:
14138
diff
changeset
|
925 |
|
05635e4c605a
Improve documentation for print().
Ben Abbott <bpabbott@mac.com>
parents:
14138
diff
changeset
|
926 @example |
|
05635e4c605a
Improve documentation for print().
Ben Abbott <bpabbott@mac.com>
parents:
14138
diff
changeset
|
927 print -dpsc |
|
05635e4c605a
Improve documentation for print().
Ben Abbott <bpabbott@mac.com>
parents:
14138
diff
changeset
|
928 @end example |
|
05635e4c605a
Improve documentation for print().
Ben Abbott <bpabbott@mac.com>
parents:
14138
diff
changeset
|
929 |
|
05635e4c605a
Improve documentation for print().
Ben Abbott <bpabbott@mac.com>
parents:
14138
diff
changeset
|
930 @noindent |
|
14853
72b8b39e12be
doc: Periodic grammarcheck of documentation.
Rik <octave@nomad.inbox5.com>
parents:
14577
diff
changeset
|
931 prints the current figure to a color PostScript printer. And, |
| 6888 | 932 |
| 933 @example | |
| 934 print -deps foo.eps | |
| 935 @end example | |
| 936 | |
| 937 @noindent | |
|
14456
05635e4c605a
Improve documentation for print().
Ben Abbott <bpabbott@mac.com>
parents:
14138
diff
changeset
|
938 saves the current figure to an encapsulated PostScript file called |
| 6888 | 939 @file{foo.eps}. |
| 6502 | 940 |
|
20532
03c88436ad8c
Correctly generate figure 15.7 of the Manual.
Rik <rik@octave.org>
parents:
20525
diff
changeset
|
941 The current graphic toolkits produce very similar graphic displays but differ |
|
03c88436ad8c
Correctly generate figure 15.7 of the Manual.
Rik <rik@octave.org>
parents:
20525
diff
changeset
|
942 in their capability to display text and in print capabilities. In particular, |
|
20525
b9d4ccf4291c
Use FLTK for creating plots for Manual.
Michael D. Godfrey <michaeldgodfrey@gmail.com>
parents:
20497
diff
changeset
|
943 the OpenGL based toolkits such as @code{fltk} and @code{qt} do not support the |
|
b9d4ccf4291c
Use FLTK for creating plots for Manual.
Michael D. Godfrey <michaeldgodfrey@gmail.com>
parents:
20497
diff
changeset
|
944 @qcode{"interpreter"} property of text objects. This means that when using |
|
b9d4ccf4291c
Use FLTK for creating plots for Manual.
Michael D. Godfrey <michaeldgodfrey@gmail.com>
parents:
20497
diff
changeset
|
945 OpenGL toolkits special symbols drawn with the @qcode{"tex"} interpreter will |
|
b9d4ccf4291c
Use FLTK for creating plots for Manual.
Michael D. Godfrey <michaeldgodfrey@gmail.com>
parents:
20497
diff
changeset
|
946 appear correctly on-screen but will be rendered with interpreter @qcode{"none"} |
|
b9d4ccf4291c
Use FLTK for creating plots for Manual.
Michael D. Godfrey <michaeldgodfrey@gmail.com>
parents:
20497
diff
changeset
|
947 when printing unless one of the @qcode{standalone} (see below) modes is used. |
|
b9d4ccf4291c
Use FLTK for creating plots for Manual.
Michael D. Godfrey <michaeldgodfrey@gmail.com>
parents:
20497
diff
changeset
|
948 These modes provide access to the pdflatex processor and therefore allow full |
|
20532
03c88436ad8c
Correctly generate figure 15.7 of the Manual.
Rik <rik@octave.org>
parents:
20525
diff
changeset
|
949 use of @LaTeX{} commands. |
|
20525
b9d4ccf4291c
Use FLTK for creating plots for Manual.
Michael D. Godfrey <michaeldgodfrey@gmail.com>
parents:
20497
diff
changeset
|
950 |
|
b9d4ccf4291c
Use FLTK for creating plots for Manual.
Michael D. Godfrey <michaeldgodfrey@gmail.com>
parents:
20497
diff
changeset
|
951 A complete example showing the capabilities of text printing using the |
|
20532
03c88436ad8c
Correctly generate figure 15.7 of the Manual.
Rik <rik@octave.org>
parents:
20525
diff
changeset
|
952 @code{-dpdflatexstandalone} option is: |
|
20525
b9d4ccf4291c
Use FLTK for creating plots for Manual.
Michael D. Godfrey <michaeldgodfrey@gmail.com>
parents:
20497
diff
changeset
|
953 |
|
b9d4ccf4291c
Use FLTK for creating plots for Manual.
Michael D. Godfrey <michaeldgodfrey@gmail.com>
parents:
20497
diff
changeset
|
954 @example |
|
b9d4ccf4291c
Use FLTK for creating plots for Manual.
Michael D. Godfrey <michaeldgodfrey@gmail.com>
parents:
20497
diff
changeset
|
955 @group |
|
b9d4ccf4291c
Use FLTK for creating plots for Manual.
Michael D. Godfrey <michaeldgodfrey@gmail.com>
parents:
20497
diff
changeset
|
956 x = 0:0.01:3; |
|
b9d4ccf4291c
Use FLTK for creating plots for Manual.
Michael D. Godfrey <michaeldgodfrey@gmail.com>
parents:
20497
diff
changeset
|
957 hf = figure (); |
|
b9d4ccf4291c
Use FLTK for creating plots for Manual.
Michael D. Godfrey <michaeldgodfrey@gmail.com>
parents:
20497
diff
changeset
|
958 plot (x, erf (x)); |
|
b9d4ccf4291c
Use FLTK for creating plots for Manual.
Michael D. Godfrey <michaeldgodfrey@gmail.com>
parents:
20497
diff
changeset
|
959 hold on; |
|
b9d4ccf4291c
Use FLTK for creating plots for Manual.
Michael D. Godfrey <michaeldgodfrey@gmail.com>
parents:
20497
diff
changeset
|
960 plot (x, x, "r"); |
|
b9d4ccf4291c
Use FLTK for creating plots for Manual.
Michael D. Godfrey <michaeldgodfrey@gmail.com>
parents:
20497
diff
changeset
|
961 axis ([0, 3, 0, 1]); |
|
20547
8e056730f27c
doc: Fix building of Manual plot 15.7 under gnuplot.
Rik <rik@octave.org>
parents:
20545
diff
changeset
|
962 text (0.65, 0.6175, ['$\displaystyle\leftarrow x = @{2\over\sqrt@{\pi@}@}'... |
|
8e056730f27c
doc: Fix building of Manual plot 15.7 under gnuplot.
Rik <rik@octave.org>
parents:
20545
diff
changeset
|
963 '\int_@{0@}^@{x@}e^@{-t^2@} dt = 0.6175$']); |
|
20525
b9d4ccf4291c
Use FLTK for creating plots for Manual.
Michael D. Godfrey <michaeldgodfrey@gmail.com>
parents:
20497
diff
changeset
|
964 xlabel ("x"); |
|
b9d4ccf4291c
Use FLTK for creating plots for Manual.
Michael D. Godfrey <michaeldgodfrey@gmail.com>
parents:
20497
diff
changeset
|
965 ylabel ("erf (x)"); |
|
b9d4ccf4291c
Use FLTK for creating plots for Manual.
Michael D. Godfrey <michaeldgodfrey@gmail.com>
parents:
20497
diff
changeset
|
966 title ("erf (x) with text annotation"); |
|
20532
03c88436ad8c
Correctly generate figure 15.7 of the Manual.
Rik <rik@octave.org>
parents:
20525
diff
changeset
|
967 set (hf, "visible", "off"); |
|
03c88436ad8c
Correctly generate figure 15.7 of the Manual.
Rik <rik@octave.org>
parents:
20525
diff
changeset
|
968 print (hf, "plot15_7.pdf", "-dpdflatexstandalone"); |
|
03c88436ad8c
Correctly generate figure 15.7 of the Manual.
Rik <rik@octave.org>
parents:
20525
diff
changeset
|
969 set (hf, "visible", "on"); |
|
20525
b9d4ccf4291c
Use FLTK for creating plots for Manual.
Michael D. Godfrey <michaeldgodfrey@gmail.com>
parents:
20497
diff
changeset
|
970 system ("pdflatex plot15_7"); |
|
20532
03c88436ad8c
Correctly generate figure 15.7 of the Manual.
Rik <rik@octave.org>
parents:
20525
diff
changeset
|
971 open ("plot15_7.pdf"); |
|
20525
b9d4ccf4291c
Use FLTK for creating plots for Manual.
Michael D. Godfrey <michaeldgodfrey@gmail.com>
parents:
20497
diff
changeset
|
972 @end group |
|
b9d4ccf4291c
Use FLTK for creating plots for Manual.
Michael D. Godfrey <michaeldgodfrey@gmail.com>
parents:
20497
diff
changeset
|
973 @end example |
|
b9d4ccf4291c
Use FLTK for creating plots for Manual.
Michael D. Godfrey <michaeldgodfrey@gmail.com>
parents:
20497
diff
changeset
|
974 |
|
b9d4ccf4291c
Use FLTK for creating plots for Manual.
Michael D. Godfrey <michaeldgodfrey@gmail.com>
parents:
20497
diff
changeset
|
975 @ifnotinfo |
|
b9d4ccf4291c
Use FLTK for creating plots for Manual.
Michael D. Godfrey <michaeldgodfrey@gmail.com>
parents:
20497
diff
changeset
|
976 @noindent |
|
20532
03c88436ad8c
Correctly generate figure 15.7 of the Manual.
Rik <rik@octave.org>
parents:
20525
diff
changeset
|
977 The result of this example can be seen in @ref{fig:extendedtext} |
|
20525
b9d4ccf4291c
Use FLTK for creating plots for Manual.
Michael D. Godfrey <michaeldgodfrey@gmail.com>
parents:
20497
diff
changeset
|
978 |
|
b9d4ccf4291c
Use FLTK for creating plots for Manual.
Michael D. Godfrey <michaeldgodfrey@gmail.com>
parents:
20497
diff
changeset
|
979 @float Figure,fig:extendedtext |
|
b9d4ccf4291c
Use FLTK for creating plots for Manual.
Michael D. Godfrey <michaeldgodfrey@gmail.com>
parents:
20497
diff
changeset
|
980 @center @image{extended,4in} |
|
b9d4ccf4291c
Use FLTK for creating plots for Manual.
Michael D. Godfrey <michaeldgodfrey@gmail.com>
parents:
20497
diff
changeset
|
981 @caption{Example of inclusion of text with use of @code{-dpdflatexstandalone}} |
|
b9d4ccf4291c
Use FLTK for creating plots for Manual.
Michael D. Godfrey <michaeldgodfrey@gmail.com>
parents:
20497
diff
changeset
|
982 @end float |
|
b9d4ccf4291c
Use FLTK for creating plots for Manual.
Michael D. Godfrey <michaeldgodfrey@gmail.com>
parents:
20497
diff
changeset
|
983 @end ifnotinfo |
|
19203
c4ffcc961f3c
Document that "tex" interpreter only works with gnuplot for printing (bug #42340).
Rik <rik@octave.org>
parents:
19034
diff
changeset
|
984 |
| 6502 | 985 @DOCSTRING(print) |
| 986 | |
|
11254
31f8534eb055
Add reference to new saveas function in printed manual.
Rik <octave@nomad.inbox5.com>
parents:
10846
diff
changeset
|
987 @DOCSTRING(saveas) |
|
31f8534eb055
Add reference to new saveas function in printed manual.
Rik <octave@nomad.inbox5.com>
parents:
10846
diff
changeset
|
988 |
| 6502 | 989 @DOCSTRING(orient) |
| 5134 | 990 |
|
18715
13c80c3e9660
Add new functions hgsave and hgload (bug #39532).
Massimiliano Fasi <mogrob.sanit@gmail.com> and Rik <rik@octave.org>
parents:
18555
diff
changeset
|
991 @code{print} and @code{saveas} are used when work on a plot has finished |
|
13c80c3e9660
Add new functions hgsave and hgload (bug #39532).
Massimiliano Fasi <mogrob.sanit@gmail.com> and Rik <rik@octave.org>
parents:
18555
diff
changeset
|
992 and the output must be in a publication-ready format. During intermediate |
|
13c80c3e9660
Add new functions hgsave and hgload (bug #39532).
Massimiliano Fasi <mogrob.sanit@gmail.com> and Rik <rik@octave.org>
parents:
18555
diff
changeset
|
993 stages it is often better to save the graphics object and all of its |
|
13c80c3e9660
Add new functions hgsave and hgload (bug #39532).
Massimiliano Fasi <mogrob.sanit@gmail.com> and Rik <rik@octave.org>
parents:
18555
diff
changeset
|
994 associated information so that changes---to colors, axis limits, marker styles, |
|
13c80c3e9660
Add new functions hgsave and hgload (bug #39532).
Massimiliano Fasi <mogrob.sanit@gmail.com> and Rik <rik@octave.org>
parents:
18555
diff
changeset
|
995 etc.---can be made easily from within Octave. The @code{hgsave}/@code{hgload} |
|
13c80c3e9660
Add new functions hgsave and hgload (bug #39532).
Massimiliano Fasi <mogrob.sanit@gmail.com> and Rik <rik@octave.org>
parents:
18555
diff
changeset
|
996 commands can be used to save and re-create a graphics object. |
|
13c80c3e9660
Add new functions hgsave and hgload (bug #39532).
Massimiliano Fasi <mogrob.sanit@gmail.com> and Rik <rik@octave.org>
parents:
18555
diff
changeset
|
997 |
|
13c80c3e9660
Add new functions hgsave and hgload (bug #39532).
Massimiliano Fasi <mogrob.sanit@gmail.com> and Rik <rik@octave.org>
parents:
18555
diff
changeset
|
998 @DOCSTRING(hgsave) |
|
13c80c3e9660
Add new functions hgsave and hgload (bug #39532).
Massimiliano Fasi <mogrob.sanit@gmail.com> and Rik <rik@octave.org>
parents:
18555
diff
changeset
|
999 |
|
13c80c3e9660
Add new functions hgsave and hgload (bug #39532).
Massimiliano Fasi <mogrob.sanit@gmail.com> and Rik <rik@octave.org>
parents:
18555
diff
changeset
|
1000 @DOCSTRING(hgload) |
|
13c80c3e9660
Add new functions hgsave and hgload (bug #39532).
Massimiliano Fasi <mogrob.sanit@gmail.com> and Rik <rik@octave.org>
parents:
18555
diff
changeset
|
1001 |
|
11254
31f8534eb055
Add reference to new saveas function in printed manual.
Rik <octave@nomad.inbox5.com>
parents:
10846
diff
changeset
|
1002 @node Interacting with Plots |
|
31f8534eb055
Add reference to new saveas function in printed manual.
Rik <octave@nomad.inbox5.com>
parents:
10846
diff
changeset
|
1003 @subsection Interacting with Plots |
|
7984
bbaa5d7d0143
Some documentation updates
David Bateman <dbateman@free.fr>
parents:
7981
diff
changeset
|
1004 |
|
bbaa5d7d0143
Some documentation updates
David Bateman <dbateman@free.fr>
parents:
7981
diff
changeset
|
1005 The user can select points on a plot with the @code{ginput} function or |
|
9040
dbd0c77e575e
Cleanup documentation file plot.texi
Rik <rdrider0-list@yahoo.com>
parents:
9032
diff
changeset
|
1006 selection the position at which to place text on the plot with the |
|
12522
33bbae85769a
Add uimenu, uigetdir, uigetfile, and uiputfile to documentation.
Rik <octave@nomad.inbox5.com>
parents:
12226
diff
changeset
|
1007 @code{gtext} function using the mouse. Menus may also be created |
|
33bbae85769a
Add uimenu, uigetdir, uigetfile, and uiputfile to documentation.
Rik <octave@nomad.inbox5.com>
parents:
12226
diff
changeset
|
1008 and populated with specific user commands via the @code{uimenu} function. |
|
7984
bbaa5d7d0143
Some documentation updates
David Bateman <dbateman@free.fr>
parents:
7981
diff
changeset
|
1009 |
|
bbaa5d7d0143
Some documentation updates
David Bateman <dbateman@free.fr>
parents:
7981
diff
changeset
|
1010 @DOCSTRING(ginput) |
|
bbaa5d7d0143
Some documentation updates
David Bateman <dbateman@free.fr>
parents:
7981
diff
changeset
|
1011 |
|
bbaa5d7d0143
Some documentation updates
David Bateman <dbateman@free.fr>
parents:
7981
diff
changeset
|
1012 @DOCSTRING(waitforbuttonpress) |
|
bbaa5d7d0143
Some documentation updates
David Bateman <dbateman@free.fr>
parents:
7981
diff
changeset
|
1013 |
|
bbaa5d7d0143
Some documentation updates
David Bateman <dbateman@free.fr>
parents:
7981
diff
changeset
|
1014 @DOCSTRING(gtext) |
|
bbaa5d7d0143
Some documentation updates
David Bateman <dbateman@free.fr>
parents:
7981
diff
changeset
|
1015 |
|
12522
33bbae85769a
Add uimenu, uigetdir, uigetfile, and uiputfile to documentation.
Rik <octave@nomad.inbox5.com>
parents:
12226
diff
changeset
|
1016 @DOCSTRING(uimenu) |
|
33bbae85769a
Add uimenu, uigetdir, uigetfile, and uiputfile to documentation.
Rik <octave@nomad.inbox5.com>
parents:
12226
diff
changeset
|
1017 |
| 6788 | 1018 @node Test Plotting Functions |
| 6888 | 1019 @subsection Test Plotting Functions |
| 1020 | |
| 1021 The functions @code{sombrero} and @code{peaks} provide a way to check | |
| 1022 that plotting is working. Typing either @code{sombrero} or @code{peaks} | |
|
9209
923c7cb7f13f
Simplify TeXinfo files by eliminating redundant @iftex followed by @tex construction.
Rik <rdrider0-list@yahoo.com>
parents:
9088
diff
changeset
|
1023 at the Octave prompt should display a three-dimensional plot. |
| 6788 | 1024 |
| 6877 | 1025 @DOCSTRING(sombrero) |
| 1026 | |
| 6788 | 1027 @DOCSTRING(peaks) |
|
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
1028 @node Graphics Data Structures |
|
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
1029 @section Graphics Data Structures |
|
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
1030 @cindex graphics data structures |
| 6888 | 1031 |
| 1032 @menu | |
|
17152
f2a8592b8fbd
doc: Shorten some long subsection names in Manual.
Rik <rik@octave.org>
parents:
17123
diff
changeset
|
1033 * Introduction to Graphics Structures:: |
|
f2a8592b8fbd
doc: Shorten some long subsection names in Manual.
Rik <rik@octave.org>
parents:
17123
diff
changeset
|
1034 * Graphics Objects:: |
|
f2a8592b8fbd
doc: Shorten some long subsection names in Manual.
Rik <rik@octave.org>
parents:
17123
diff
changeset
|
1035 * Graphics Object Properties:: |
|
f2a8592b8fbd
doc: Shorten some long subsection names in Manual.
Rik <rik@octave.org>
parents:
17123
diff
changeset
|
1036 * Searching Properties:: |
|
f2a8592b8fbd
doc: Shorten some long subsection names in Manual.
Rik <rik@octave.org>
parents:
17123
diff
changeset
|
1037 * Managing Default Properties:: |
| 6888 | 1038 @end menu |
| 1039 | |
|
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
1040 @node Introduction to Graphics Structures |
|
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
1041 @subsection Introduction to Graphics Structures |
|
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
1042 @cindex introduction to graphics structures |
|
17097
e7a059a9a644
doc: Use XREF as anchor prefix in documentation for clearer results in Info viewer.
Rik <rik@octave.org>
parents:
16923
diff
changeset
|
1043 @anchor{XREFgraphics structures} |
|
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
1044 |
|
10846
a4f482e66b65
Grammarcheck more of the documentation.
Rik <octave@nomad.inbox5.com>
parents:
10828
diff
changeset
|
1045 The graphics functions use pointers, which are of class graphics_handle, in |
|
19657
78c0241306b5
Add documentation about when to use newplot (bug #40289).
Rik <rik@octave.org>
parents:
19602
diff
changeset
|
1046 order to address the data structures which control visual display. A |
|
78c0241306b5
Add documentation about when to use newplot (bug #40289).
Rik <rik@octave.org>
parents:
19602
diff
changeset
|
1047 graphics handle may point to any one of a number of different base object |
|
78c0241306b5
Add documentation about when to use newplot (bug #40289).
Rik <rik@octave.org>
parents:
19602
diff
changeset
|
1048 types and these objects are the graphics data structures themselves. The |
|
78c0241306b5
Add documentation about when to use newplot (bug #40289).
Rik <rik@octave.org>
parents:
19602
diff
changeset
|
1049 primitive graphic object types are: @code{figure}, @code{axes}, @code{line}, |
|
78c0241306b5
Add documentation about when to use newplot (bug #40289).
Rik <rik@octave.org>
parents:
19602
diff
changeset
|
1050 @code{text}, @code{patch}, @code{surface}, @code{text}, and @code{image}. |
|
78c0241306b5
Add documentation about when to use newplot (bug #40289).
Rik <rik@octave.org>
parents:
19602
diff
changeset
|
1051 |
|
78c0241306b5
Add documentation about when to use newplot (bug #40289).
Rik <rik@octave.org>
parents:
19602
diff
changeset
|
1052 Each of these objects has a function by the same name, and, each of these |
|
78c0241306b5
Add documentation about when to use newplot (bug #40289).
Rik <rik@octave.org>
parents:
19602
diff
changeset
|
1053 functions returns a graphics handle pointing to an object of the corresponding |
|
10846
a4f482e66b65
Grammarcheck more of the documentation.
Rik <octave@nomad.inbox5.com>
parents:
10828
diff
changeset
|
1054 type. In addition there are several functions which operate on properties of |
|
19657
78c0241306b5
Add documentation about when to use newplot (bug #40289).
Rik <rik@octave.org>
parents:
19602
diff
changeset
|
1055 the graphics objects and which also return handles: the functions @code{plot} |
|
78c0241306b5
Add documentation about when to use newplot (bug #40289).
Rik <rik@octave.org>
parents:
19602
diff
changeset
|
1056 and @code{plot3} return a handle pointing to an object of type line, the |
|
78c0241306b5
Add documentation about when to use newplot (bug #40289).
Rik <rik@octave.org>
parents:
19602
diff
changeset
|
1057 function @code{subplot} returns a handle pointing to an object of type axes, |
|
78c0241306b5
Add documentation about when to use newplot (bug #40289).
Rik <rik@octave.org>
parents:
19602
diff
changeset
|
1058 the function @code{fill} returns a handle pointing to an object of type patch, |
|
78c0241306b5
Add documentation about when to use newplot (bug #40289).
Rik <rik@octave.org>
parents:
19602
diff
changeset
|
1059 the functions @code{area}, @code{bar}, @code{barh}, @code{contour}, |
|
10846
a4f482e66b65
Grammarcheck more of the documentation.
Rik <octave@nomad.inbox5.com>
parents:
10828
diff
changeset
|
1060 @code{contourf}, @code{contour3}, @code{surf}, @code{mesh}, @code{surfc}, |
|
a4f482e66b65
Grammarcheck more of the documentation.
Rik <octave@nomad.inbox5.com>
parents:
10828
diff
changeset
|
1061 @code{meshc}, @code{errorbar}, @code{quiver}, @code{quiver3}, @code{scatter}, |
|
a4f482e66b65
Grammarcheck more of the documentation.
Rik <octave@nomad.inbox5.com>
parents:
10828
diff
changeset
|
1062 @code{scatter3}, @code{stair}, @code{stem}, @code{stem3} each return a handle |
|
19657
78c0241306b5
Add documentation about when to use newplot (bug #40289).
Rik <rik@octave.org>
parents:
19602
diff
changeset
|
1063 to a complex data structure as documented in |
|
78c0241306b5
Add documentation about when to use newplot (bug #40289).
Rik <rik@octave.org>
parents:
19602
diff
changeset
|
1064 @ref{XREFdatasources,,Data Sources}. |
|
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
1065 |
|
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
1066 The graphics objects are arranged in a hierarchy: |
|
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
1067 |
|
19657
78c0241306b5
Add documentation about when to use newplot (bug #40289).
Rik <rik@octave.org>
parents:
19602
diff
changeset
|
1068 1. The root is at 0. In other words, @code{get (0)} returns the properties of |
|
78c0241306b5
Add documentation about when to use newplot (bug #40289).
Rik <rik@octave.org>
parents:
19602
diff
changeset
|
1069 the root object. |
|
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
1070 |
|
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
1071 2. Below the root are @code{figure} objects. |
|
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
1072 |
|
19657
78c0241306b5
Add documentation about when to use newplot (bug #40289).
Rik <rik@octave.org>
parents:
19602
diff
changeset
|
1073 3. Below the @code{figure} objects are @code{axes} objects. |
|
78c0241306b5
Add documentation about when to use newplot (bug #40289).
Rik <rik@octave.org>
parents:
19602
diff
changeset
|
1074 |
|
78c0241306b5
Add documentation about when to use newplot (bug #40289).
Rik <rik@octave.org>
parents:
19602
diff
changeset
|
1075 4. Below the @code{axes} objects are @code{line}, @code{text}, @code{patch}, |
|
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
1076 @code{surface}, and @code{image} objects. |
|
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
1077 |
|
16814
64e7bb01fce2
doc: Improve documentation for 2-D plot functions
Rik <rik@octave.org>
parents:
16813
diff
changeset
|
1078 Graphics handles may be distinguished from function handles |
|
17097
e7a059a9a644
doc: Use XREF as anchor prefix in documentation for clearer results in Info viewer.
Rik <rik@octave.org>
parents:
16923
diff
changeset
|
1079 (@pxref{Function Handles}) by means of the function @code{ishandle}. |
|
17469
710b3d5fe966
improve interpreter tex Tables
Michael Godfrey <michaeldgodfrey@gmail.com>
parents:
17281
diff
changeset
|
1080 @code{ishandle} returns true if its argument is a handle of a graphics object. |
|
19657
78c0241306b5
Add documentation about when to use newplot (bug #40289).
Rik <rik@octave.org>
parents:
19602
diff
changeset
|
1081 In addition, a figure or axes object may be tested using @code{isfigure} or |
|
78c0241306b5
Add documentation about when to use newplot (bug #40289).
Rik <rik@octave.org>
parents:
19602
diff
changeset
|
1082 @code{isaxes} respectively. The test functions return true only if the |
|
78c0241306b5
Add documentation about when to use newplot (bug #40289).
Rik <rik@octave.org>
parents:
19602
diff
changeset
|
1083 argument is both a handle and of the correct type (figure or axes). |
|
78c0241306b5
Add documentation about when to use newplot (bug #40289).
Rik <rik@octave.org>
parents:
19602
diff
changeset
|
1084 |
|
78c0241306b5
Add documentation about when to use newplot (bug #40289).
Rik <rik@octave.org>
parents:
19602
diff
changeset
|
1085 The @code{whos} function can be used to show the object type of each currently |
|
16814
64e7bb01fce2
doc: Improve documentation for 2-D plot functions
Rik <rik@octave.org>
parents:
16813
diff
changeset
|
1086 defined graphics handle. (Note: this is not true today, but it is, I hope, |
|
64e7bb01fce2
doc: Improve documentation for 2-D plot functions
Rik <rik@octave.org>
parents:
16813
diff
changeset
|
1087 considered an error in whos. It may be better to have whos just show |
|
64e7bb01fce2
doc: Improve documentation for 2-D plot functions
Rik <rik@octave.org>
parents:
16813
diff
changeset
|
1088 graphics_handle as the class, and provide a new function which, given a |
|
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
1089 graphics handle, returns its object type. This could generalize the ishandle() |
|
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
1090 functions and, in fact, replace them.) |
|
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
1091 |
|
16814
64e7bb01fce2
doc: Improve documentation for 2-D plot functions
Rik <rik@octave.org>
parents:
16813
diff
changeset
|
1092 The @code{get} and @code{set} commands are used to obtain and set the values of |
|
64e7bb01fce2
doc: Improve documentation for 2-D plot functions
Rik <rik@octave.org>
parents:
16813
diff
changeset
|
1093 properties of graphics objects. In addition, the @code{get} command may be |
|
64e7bb01fce2
doc: Improve documentation for 2-D plot functions
Rik <rik@octave.org>
parents:
16813
diff
changeset
|
1094 used to obtain property names. |
|
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
1095 |
|
17281
bc924baa2c4e
doc: Add new @qcode macro for code samples which are quoted.
Rik <rik@octave.org>
parents:
17170
diff
changeset
|
1096 For example, the property @qcode{"type"} of the graphics object pointed to by |
|
bc924baa2c4e
doc: Add new @qcode macro for code samples which are quoted.
Rik <rik@octave.org>
parents:
17170
diff
changeset
|
1097 the graphics handle h may be displayed by: |
|
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
1098 |
| 11444 | 1099 @example |
| 1100 get (h, "type") | |
| 1101 @end example | |
| 1102 | |
| 1103 The properties and their current values are returned by @code{get (h)} | |
|
9758
09da0bd91412
Periodic grammar check of Octave documentation files to ensure common format
Rik <rdrider0-list@yahoo.com>
parents:
9752
diff
changeset
|
1104 where h is a handle of a graphics object. If only the names of the |
|
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
1105 allowed properties are wanted they may be displayed by: |
| 11444 | 1106 @code{get (h, "")}. |
|
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
1107 |
|
17281
bc924baa2c4e
doc: Add new @qcode macro for code samples which are quoted.
Rik <rik@octave.org>
parents:
17170
diff
changeset
|
1108 Thus, for example: |
|
11573
6f8ffe2c6f76
Grammarcheck txi files for 3.4 release.
Rik <octave@nomad.inbox5.com>
parents:
11523
diff
changeset
|
1109 |
| 11444 | 1110 @smallexample |
| 1111 h = figure (); | |
| 1112 get (h, "type") | |
|
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
1113 ans = figure |
| 11444 | 1114 get (h, ""); |
|
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
1115 error: get: ambiguous figure property name ; possible matches: |
|
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
1116 |
|
17957
e5566719e0a1
doc: Mention GUI in introduction. Update figure root properties.
Michael Godfrey <michaeldgodfrey@gmail.com>
parents:
17744
diff
changeset
|
1117 __enhanced__ hittest resize |
|
e5566719e0a1
doc: Mention GUI in introduction. Update figure root properties.
Michael Godfrey <michaeldgodfrey@gmail.com>
parents:
17744
diff
changeset
|
1118 __graphics_toolkit__ integerhandle resizefcn |
|
e5566719e0a1
doc: Mention GUI in introduction. Update figure root properties.
Michael Godfrey <michaeldgodfrey@gmail.com>
parents:
17744
diff
changeset
|
1119 __guidata__ interruptible selected |
|
e5566719e0a1
doc: Mention GUI in introduction. Update figure root properties.
Michael Godfrey <michaeldgodfrey@gmail.com>
parents:
17744
diff
changeset
|
1120 __modified__ inverthardcopy selectionhighlight |
|
e5566719e0a1
doc: Mention GUI in introduction. Update figure root properties.
Michael Godfrey <michaeldgodfrey@gmail.com>
parents:
17744
diff
changeset
|
1121 __myhandle__ keypressfcn selectiontype |
|
e5566719e0a1
doc: Mention GUI in introduction. Update figure root properties.
Michael Godfrey <michaeldgodfrey@gmail.com>
parents:
17744
diff
changeset
|
1122 __plot_stream__ keyreleasefcn tag |
|
e5566719e0a1
doc: Mention GUI in introduction. Update figure root properties.
Michael Godfrey <michaeldgodfrey@gmail.com>
parents:
17744
diff
changeset
|
1123 alphamap menubar toolbar |
|
e5566719e0a1
doc: Mention GUI in introduction. Update figure root properties.
Michael Godfrey <michaeldgodfrey@gmail.com>
parents:
17744
diff
changeset
|
1124 beingdeleted mincolormap type |
|
e5566719e0a1
doc: Mention GUI in introduction. Update figure root properties.
Michael Godfrey <michaeldgodfrey@gmail.com>
parents:
17744
diff
changeset
|
1125 busyaction name uicontextmenu |
|
e5566719e0a1
doc: Mention GUI in introduction. Update figure root properties.
Michael Godfrey <michaeldgodfrey@gmail.com>
parents:
17744
diff
changeset
|
1126 buttondownfcn nextplot units |
|
e5566719e0a1
doc: Mention GUI in introduction. Update figure root properties.
Michael Godfrey <michaeldgodfrey@gmail.com>
parents:
17744
diff
changeset
|
1127 children numbertitle userdata |
|
e5566719e0a1
doc: Mention GUI in introduction. Update figure root properties.
Michael Godfrey <michaeldgodfrey@gmail.com>
parents:
17744
diff
changeset
|
1128 clipping outerposition visible |
|
e5566719e0a1
doc: Mention GUI in introduction. Update figure root properties.
Michael Godfrey <michaeldgodfrey@gmail.com>
parents:
17744
diff
changeset
|
1129 closerequestfcn paperorientation windowbuttondownfcn |
|
e5566719e0a1
doc: Mention GUI in introduction. Update figure root properties.
Michael Godfrey <michaeldgodfrey@gmail.com>
parents:
17744
diff
changeset
|
1130 color paperposition windowbuttonmotionfcn |
|
e5566719e0a1
doc: Mention GUI in introduction. Update figure root properties.
Michael Godfrey <michaeldgodfrey@gmail.com>
parents:
17744
diff
changeset
|
1131 colormap paperpositionmode windowbuttonupfcn |
|
e5566719e0a1
doc: Mention GUI in introduction. Update figure root properties.
Michael Godfrey <michaeldgodfrey@gmail.com>
parents:
17744
diff
changeset
|
1132 createfcn papersize windowkeypressfcn |
|
e5566719e0a1
doc: Mention GUI in introduction. Update figure root properties.
Michael Godfrey <michaeldgodfrey@gmail.com>
parents:
17744
diff
changeset
|
1133 currentaxes papertype windowkeyreleasefcn |
|
e5566719e0a1
doc: Mention GUI in introduction. Update figure root properties.
Michael Godfrey <michaeldgodfrey@gmail.com>
parents:
17744
diff
changeset
|
1134 currentcharacter paperunits windowscrollwheelfcn |
|
e5566719e0a1
doc: Mention GUI in introduction. Update figure root properties.
Michael Godfrey <michaeldgodfrey@gmail.com>
parents:
17744
diff
changeset
|
1135 currentobject parent windowstyle |
|
e5566719e0a1
doc: Mention GUI in introduction. Update figure root properties.
Michael Godfrey <michaeldgodfrey@gmail.com>
parents:
17744
diff
changeset
|
1136 currentpoint pointer wvisual |
|
e5566719e0a1
doc: Mention GUI in introduction. Update figure root properties.
Michael Godfrey <michaeldgodfrey@gmail.com>
parents:
17744
diff
changeset
|
1137 deletefcn pointershapecdata wvisualmode |
|
e5566719e0a1
doc: Mention GUI in introduction. Update figure root properties.
Michael Godfrey <michaeldgodfrey@gmail.com>
parents:
17744
diff
changeset
|
1138 dockcontrols pointershapehotspot xdisplay |
|
e5566719e0a1
doc: Mention GUI in introduction. Update figure root properties.
Michael Godfrey <michaeldgodfrey@gmail.com>
parents:
17744
diff
changeset
|
1139 doublebuffer position xvisual |
|
e5566719e0a1
doc: Mention GUI in introduction. Update figure root properties.
Michael Godfrey <michaeldgodfrey@gmail.com>
parents:
17744
diff
changeset
|
1140 filename renderer xvisualmode |
|
e5566719e0a1
doc: Mention GUI in introduction. Update figure root properties.
Michael Godfrey <michaeldgodfrey@gmail.com>
parents:
17744
diff
changeset
|
1141 handlevisibility renderermode |
| 11444 | 1142 @end smallexample |
|
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
1143 |
|
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
1144 The root figure has index 0. Its properties may be displayed by: |
| 11444 | 1145 @code{get (0, "")}. |
| 1146 | |
| 1147 The uses of @code{get} and @code{set} are further explained in | |
|
17097
e7a059a9a644
doc: Use XREF as anchor prefix in documentation for clearer results in Info viewer.
Rik <rik@octave.org>
parents:
16923
diff
changeset
|
1148 @ref{XREFget,,get}, @ref{XREFset,,set}. |
|
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
1149 |
| 11380 | 1150 @DOCSTRING(isprop) |
| 1151 | |
| 6888 | 1152 @node Graphics Objects |
| 1153 @subsection Graphics Objects | |
|
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
1154 @cindex graphics objects |
|
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
1155 |
|
17097
e7a059a9a644
doc: Use XREF as anchor prefix in documentation for clearer results in Info viewer.
Rik <rik@octave.org>
parents:
16923
diff
changeset
|
1156 The hierarchy of graphics objects was explained above. |
|
e7a059a9a644
doc: Use XREF as anchor prefix in documentation for clearer results in Info viewer.
Rik <rik@octave.org>
parents:
16923
diff
changeset
|
1157 @xref{Introduction to Graphics Structures}. Here the |
|
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
1158 specific objects are described, and the properties contained in |
|
9758
09da0bd91412
Periodic grammar check of Octave documentation files to ensure common format
Rik <rdrider0-list@yahoo.com>
parents:
9752
diff
changeset
|
1159 these objects are discussed. Keep in mind that |
|
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
1160 graphics objects are always referenced by @dfn{handle}. |
| 6888 | 1161 |
| 1162 @table @asis | |
|
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
1163 @c @group |
|
10846
a4f482e66b65
Grammarcheck more of the documentation.
Rik <octave@nomad.inbox5.com>
parents:
10828
diff
changeset
|
1164 |
| 6888 | 1165 @item root figure |
| 8071 | 1166 @cindex root figure graphics object |
| 1167 @cindex graphics object, root figure | |
|
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
1168 the top level of the hierarchy and the parent of all figure objects. |
|
16814
64e7bb01fce2
doc: Improve documentation for 2-D plot functions
Rik <rik@octave.org>
parents:
16813
diff
changeset
|
1169 The handle index of the root figure is 0. |
| 6888 | 1170 |
| 1171 @item figure | |
| 8071 | 1172 @cindex figure graphics object |
| 1173 @cindex graphics object, figure | |
| 6888 | 1174 A figure window. |
| 1175 | |
| 1176 @item axes | |
| 8071 | 1177 @cindex axes graphics object |
| 1178 @cindex graphics object, axes | |
|
9316
c539ec5726e7
Update some of Advanced Plotting documentation.
Rik <rdrider0-list@yahoo.com>
parents:
9209
diff
changeset
|
1179 A set of axes. This object is a child of a figure object and may be a |
| 6888 | 1180 parent of line, text, image, patch, or surface objects. |
| 1181 | |
| 1182 @item line | |
| 8071 | 1183 @cindex line graphics object |
| 1184 @cindex graphics object, line | |
| 6888 | 1185 A line in two or three dimensions. |
| 1186 | |
| 1187 @item text | |
| 8071 | 1188 @cindex text graphics object |
| 1189 @cindex graphics object, text | |
| 6888 | 1190 Text annotations. |
| 1191 | |
| 1192 @item image | |
| 8071 | 1193 @cindex image graphics object |
| 1194 @cindex graphics object, image | |
| 6888 | 1195 A bitmap image. |
| 1196 | |
| 1197 @item patch | |
| 8071 | 1198 @cindex patch graphics object |
| 1199 @cindex graphics object, patch | |
| 6888 | 1200 A filled polygon, currently limited to two dimensions. |
| 1201 | |
| 1202 @item surface | |
| 8071 | 1203 @cindex surface graphics object |
|
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
1204 @cindex graphics object, surface |
| 6888 | 1205 A three-dimensional surface. |
|
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
1206 @c @end group |
| 6888 | 1207 @end table |
| 1208 | |
|
16923
5d08a2ec7edb
doc: Move graphics object functions into the right section
Mike Miller <mtmiller@ieee.org>
parents:
16814
diff
changeset
|
1209 @subsubsection Creating Graphics Objects |
|
5d08a2ec7edb
doc: Move graphics object functions into the right section
Mike Miller <mtmiller@ieee.org>
parents:
16814
diff
changeset
|
1210 @cindex creating graphics objects |
|
5d08a2ec7edb
doc: Move graphics object functions into the right section
Mike Miller <mtmiller@ieee.org>
parents:
16814
diff
changeset
|
1211 |
|
19657
78c0241306b5
Add documentation about when to use newplot (bug #40289).
Rik <rik@octave.org>
parents:
19602
diff
changeset
|
1212 You can create any graphics object primitive by calling the function of the |
|
78c0241306b5
Add documentation about when to use newplot (bug #40289).
Rik <rik@octave.org>
parents:
19602
diff
changeset
|
1213 same name as the object; In other words, @code{figure}, @code{axes}, |
|
78c0241306b5
Add documentation about when to use newplot (bug #40289).
Rik <rik@octave.org>
parents:
19602
diff
changeset
|
1214 @code{line}, @code{text}, @code{image}, @code{patch}, and @code{surface} |
|
78c0241306b5
Add documentation about when to use newplot (bug #40289).
Rik <rik@octave.org>
parents:
19602
diff
changeset
|
1215 functions. These fundamental graphic objects automatically become children |
|
78c0241306b5
Add documentation about when to use newplot (bug #40289).
Rik <rik@octave.org>
parents:
19602
diff
changeset
|
1216 of the current axes object as if @code{hold on} was in place. Seperately, axes |
|
78c0241306b5
Add documentation about when to use newplot (bug #40289).
Rik <rik@octave.org>
parents:
19602
diff
changeset
|
1217 will automatically become children of the current figure object and figures |
|
78c0241306b5
Add documentation about when to use newplot (bug #40289).
Rik <rik@octave.org>
parents:
19602
diff
changeset
|
1218 will become children of the root object 0. |
|
78c0241306b5
Add documentation about when to use newplot (bug #40289).
Rik <rik@octave.org>
parents:
19602
diff
changeset
|
1219 |
|
78c0241306b5
Add documentation about when to use newplot (bug #40289).
Rik <rik@octave.org>
parents:
19602
diff
changeset
|
1220 If this auto-joining feature is not desired then it is important to call |
|
78c0241306b5
Add documentation about when to use newplot (bug #40289).
Rik <rik@octave.org>
parents:
19602
diff
changeset
|
1221 @code{newplot} first to prepare a new figure and axes for plotting. |
|
78c0241306b5
Add documentation about when to use newplot (bug #40289).
Rik <rik@octave.org>
parents:
19602
diff
changeset
|
1222 Alternatively, the easier way is to call a high-level graphics routine which |
|
78c0241306b5
Add documentation about when to use newplot (bug #40289).
Rik <rik@octave.org>
parents:
19602
diff
changeset
|
1223 will both create the plot and then populate it with low-level graphics objects. |
|
78c0241306b5
Add documentation about when to use newplot (bug #40289).
Rik <rik@octave.org>
parents:
19602
diff
changeset
|
1224 Instead of calling @code{line}, use @code{plot}. Or use @code{surf} instead of |
|
78c0241306b5
Add documentation about when to use newplot (bug #40289).
Rik <rik@octave.org>
parents:
19602
diff
changeset
|
1225 @code{surface}. Or use @code{fill} instead of @code{patch}. |
|
16923
5d08a2ec7edb
doc: Move graphics object functions into the right section
Mike Miller <mtmiller@ieee.org>
parents:
16814
diff
changeset
|
1226 |
|
5d08a2ec7edb
doc: Move graphics object functions into the right section
Mike Miller <mtmiller@ieee.org>
parents:
16814
diff
changeset
|
1227 @DOCSTRING(axes) |
|
5d08a2ec7edb
doc: Move graphics object functions into the right section
Mike Miller <mtmiller@ieee.org>
parents:
16814
diff
changeset
|
1228 |
|
5d08a2ec7edb
doc: Move graphics object functions into the right section
Mike Miller <mtmiller@ieee.org>
parents:
16814
diff
changeset
|
1229 @DOCSTRING(line) |
|
5d08a2ec7edb
doc: Move graphics object functions into the right section
Mike Miller <mtmiller@ieee.org>
parents:
16814
diff
changeset
|
1230 |
|
5d08a2ec7edb
doc: Move graphics object functions into the right section
Mike Miller <mtmiller@ieee.org>
parents:
16814
diff
changeset
|
1231 @DOCSTRING(patch) |
|
5d08a2ec7edb
doc: Move graphics object functions into the right section
Mike Miller <mtmiller@ieee.org>
parents:
16814
diff
changeset
|
1232 |
|
5d08a2ec7edb
doc: Move graphics object functions into the right section
Mike Miller <mtmiller@ieee.org>
parents:
16814
diff
changeset
|
1233 @DOCSTRING(surface) |
|
5d08a2ec7edb
doc: Move graphics object functions into the right section
Mike Miller <mtmiller@ieee.org>
parents:
16814
diff
changeset
|
1234 |
|
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
1235 @subsubsection Handle Functions |
|
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
1236 @cindex handle functions |
|
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
1237 |
|
17123
bcada0a4f8a7
isaxes.m: New function to determine if object is axes handle.
Rik <rik@octave.org>
parents:
17122
diff
changeset
|
1238 To determine whether a variable is a graphics object index, or an index |
|
bcada0a4f8a7
isaxes.m: New function to determine if object is axes handle.
Rik <rik@octave.org>
parents:
17122
diff
changeset
|
1239 to an axes or figure, use the functions @code{ishandle}, @code{isaxes}, and |
|
bcada0a4f8a7
isaxes.m: New function to determine if object is axes handle.
Rik <rik@octave.org>
parents:
17122
diff
changeset
|
1240 @code{isfigure}. |
| 6888 | 1241 |
| 1242 @DOCSTRING(ishandle) | |
| 1243 | |
|
8817
03b7f618ab3d
include docstrings for new functions in the manual
John W. Eaton <jwe@octave.org>
parents:
8519
diff
changeset
|
1244 @DOCSTRING(ishghandle) |
|
03b7f618ab3d
include docstrings for new functions in the manual
John W. Eaton <jwe@octave.org>
parents:
8519
diff
changeset
|
1245 |
|
17123
bcada0a4f8a7
isaxes.m: New function to determine if object is axes handle.
Rik <rik@octave.org>
parents:
17122
diff
changeset
|
1246 @DOCSTRING(isaxes) |
|
bcada0a4f8a7
isaxes.m: New function to determine if object is axes handle.
Rik <rik@octave.org>
parents:
17122
diff
changeset
|
1247 |
| 6888 | 1248 @DOCSTRING(isfigure) |
| 1249 | |
| 1250 The function @code{gcf} returns an index to the current figure object, | |
| 1251 or creates one if none exists. Similarly, @code{gca} returns the | |
| 1252 current axes object, or creates one (and its parent figure object) if | |
| 1253 none exists. | |
| 1254 | |
| 1255 @DOCSTRING(gcf) | |
| 1256 | |
| 1257 @DOCSTRING(gca) | |
| 1258 | |
| 16808 | 1259 @DOCSTRING(gco) |
| 1260 | |
| 6888 | 1261 The @code{get} and @code{set} functions may be used to examine and set |
| 1262 properties for graphics objects. For example, | |
| 1263 | |
| 1264 @example | |
| 1265 @group | |
| 1266 get (0) | |
| 1267 @result{} ans = | |
| 1268 @{ | |
|
9316
c539ec5726e7
Update some of Advanced Plotting documentation.
Rik <rdrider0-list@yahoo.com>
parents:
9209
diff
changeset
|
1269 type = root |
| 6888 | 1270 currentfigure = [](0x0) |
| 1271 children = [](0x0) | |
| 1272 visible = on | |
|
10599
d0e0bb2ebebb
Remove tabs in .txi files causing problems with pdf formatting.
Rik <octave@nomad.inbox5.com>
parents:
10522
diff
changeset
|
1273 @dots{} |
| 6888 | 1274 @} |
| 1275 @end group | |
| 1276 @end example | |
| 1277 | |
| 1278 @noindent | |
| 1279 returns a structure containing all the properties of the root figure. | |
| 1280 As with all functions in Octave, the structure is returned by value, so | |
| 1281 modifying it will not modify the internal root figure plot object. To | |
| 1282 do that, you must use the @code{set} function. Also, note that in this | |
| 1283 case, the @code{currentfigure} property is empty, which indicates that | |
| 1284 there is no current figure window. | |
| 1285 | |
| 1286 The @code{get} function may also be used to find the value of a single | |
| 1287 property. For example, | |
| 1288 | |
| 1289 @example | |
| 1290 @group | |
| 1291 get (gca (), "xlim") | |
| 1292 @result{} [ 0 1 ] | |
| 1293 @end group | |
| 1294 @end example | |
| 1295 | |
| 1296 @noindent | |
| 1297 returns the range of the x-axis for the current axes object in the | |
| 1298 current figure. | |
| 1299 | |
| 1300 To set graphics object properties, use the set function. For example, | |
| 1301 | |
| 1302 @example | |
| 1303 set (gca (), "xlim", [-10, 10]); | |
| 1304 @end example | |
| 1305 | |
| 1306 @noindent | |
| 1307 sets the range of the x-axis for the current axes object in the current | |
|
18150
1c22f0465c74
doc: Add documentation about using set() to get default graphic properties.
Rik <rik@octave.org>
parents:
18078
diff
changeset
|
1308 figure to @samp{[-10, 10]}. |
|
1c22f0465c74
doc: Add documentation about using set() to get default graphic properties.
Rik <rik@octave.org>
parents:
18078
diff
changeset
|
1309 |
|
1c22f0465c74
doc: Add documentation about using set() to get default graphic properties.
Rik <rik@octave.org>
parents:
18078
diff
changeset
|
1310 Default property values can also be queried if the @code{set} function is |
|
1c22f0465c74
doc: Add documentation about using set() to get default graphic properties.
Rik <rik@octave.org>
parents:
18078
diff
changeset
|
1311 called without a value argument. When only one argument is given (a graphic |
|
1c22f0465c74
doc: Add documentation about using set() to get default graphic properties.
Rik <rik@octave.org>
parents:
18078
diff
changeset
|
1312 handle) then a structure with defaults for all properties of the given object |
|
1c22f0465c74
doc: Add documentation about using set() to get default graphic properties.
Rik <rik@octave.org>
parents:
18078
diff
changeset
|
1313 type is returned. For example, |
| 6888 | 1314 |
| 1315 @example | |
| 1316 set (gca ()) | |
| 1317 @end example | |
| 1318 | |
| 1319 @noindent | |
|
18150
1c22f0465c74
doc: Add documentation about using set() to get default graphic properties.
Rik <rik@octave.org>
parents:
18078
diff
changeset
|
1320 returns a structure containing the default property values for axes objects. |
|
1c22f0465c74
doc: Add documentation about using set() to get default graphic properties.
Rik <rik@octave.org>
parents:
18078
diff
changeset
|
1321 If @code{set} is called with two arguments (a graphic handle and a property |
|
1c22f0465c74
doc: Add documentation about using set() to get default graphic properties.
Rik <rik@octave.org>
parents:
18078
diff
changeset
|
1322 name) then only the defaults for the requested property are returned. |
| 6888 | 1323 |
| 1324 @DOCSTRING(get) | |
| 1325 | |
| 1326 @DOCSTRING(set) | |
| 1327 | |
| 1328 @DOCSTRING(ancestor) | |
| 1329 | |
|
7984
bbaa5d7d0143
Some documentation updates
David Bateman <dbateman@free.fr>
parents:
7981
diff
changeset
|
1330 @DOCSTRING(allchild) |
|
bbaa5d7d0143
Some documentation updates
David Bateman <dbateman@free.fr>
parents:
7981
diff
changeset
|
1331 |
|
14577
447038c2dde8
Add findfigs.m docstring to plot.txi
Carnë Draug <carandraug+dev@gmail.com>
parents:
14574
diff
changeset
|
1332 @DOCSTRING(findfigs) |
|
447038c2dde8
Add findfigs.m docstring to plot.txi
Carnë Draug <carandraug+dev@gmail.com>
parents:
14574
diff
changeset
|
1333 |
|
16813
81e041f5633a
doc: Add copyobj, struct2hdl, hdl2struct to manual.
Rik <rik@octave.org>
parents:
16808
diff
changeset
|
1334 @cindex saving graphics objects |
|
18398
200851c87444
Edits to Manual and indicies
Michael Godfrey <michaeldgodfrey@gmail.com>
parents:
17957
diff
changeset
|
1335 @cindex graphics objects, saving |
|
16813
81e041f5633a
doc: Add copyobj, struct2hdl, hdl2struct to manual.
Rik <rik@octave.org>
parents:
16808
diff
changeset
|
1336 |
|
81e041f5633a
doc: Add copyobj, struct2hdl, hdl2struct to manual.
Rik <rik@octave.org>
parents:
16808
diff
changeset
|
1337 Figures can be printed or saved in many graphics formats with @code{print} and |
|
81e041f5633a
doc: Add copyobj, struct2hdl, hdl2struct to manual.
Rik <rik@octave.org>
parents:
16808
diff
changeset
|
1338 @code{saveas}. Occasionally, however, it may be useful to save the original |
|
81e041f5633a
doc: Add copyobj, struct2hdl, hdl2struct to manual.
Rik <rik@octave.org>
parents:
16808
diff
changeset
|
1339 Octave handle graphic directly so that further modifications can be made such |
|
17469
710b3d5fe966
improve interpreter tex Tables
Michael Godfrey <michaeldgodfrey@gmail.com>
parents:
17281
diff
changeset
|
1340 as modifying a title or legend. |
|
710b3d5fe966
improve interpreter tex Tables
Michael Godfrey <michaeldgodfrey@gmail.com>
parents:
17281
diff
changeset
|
1341 |
|
710b3d5fe966
improve interpreter tex Tables
Michael Godfrey <michaeldgodfrey@gmail.com>
parents:
17281
diff
changeset
|
1342 This can be accomplished with the following functions by |
|
16813
81e041f5633a
doc: Add copyobj, struct2hdl, hdl2struct to manual.
Rik <rik@octave.org>
parents:
16808
diff
changeset
|
1343 |
|
81e041f5633a
doc: Add copyobj, struct2hdl, hdl2struct to manual.
Rik <rik@octave.org>
parents:
16808
diff
changeset
|
1344 @example |
|
81e041f5633a
doc: Add copyobj, struct2hdl, hdl2struct to manual.
Rik <rik@octave.org>
parents:
16808
diff
changeset
|
1345 @group |
|
81e041f5633a
doc: Add copyobj, struct2hdl, hdl2struct to manual.
Rik <rik@octave.org>
parents:
16808
diff
changeset
|
1346 fig_struct = hdl2struct (gcf); |
|
81e041f5633a
doc: Add copyobj, struct2hdl, hdl2struct to manual.
Rik <rik@octave.org>
parents:
16808
diff
changeset
|
1347 save myplot.fig -struct fig_struct; |
|
81e041f5633a
doc: Add copyobj, struct2hdl, hdl2struct to manual.
Rik <rik@octave.org>
parents:
16808
diff
changeset
|
1348 @dots{} |
|
81e041f5633a
doc: Add copyobj, struct2hdl, hdl2struct to manual.
Rik <rik@octave.org>
parents:
16808
diff
changeset
|
1349 fig_struct = load ("myplot.fig"); |
|
81e041f5633a
doc: Add copyobj, struct2hdl, hdl2struct to manual.
Rik <rik@octave.org>
parents:
16808
diff
changeset
|
1350 struct2hdl (fig_struct); |
|
81e041f5633a
doc: Add copyobj, struct2hdl, hdl2struct to manual.
Rik <rik@octave.org>
parents:
16808
diff
changeset
|
1351 @end group |
|
81e041f5633a
doc: Add copyobj, struct2hdl, hdl2struct to manual.
Rik <rik@octave.org>
parents:
16808
diff
changeset
|
1352 @end example |
|
81e041f5633a
doc: Add copyobj, struct2hdl, hdl2struct to manual.
Rik <rik@octave.org>
parents:
16808
diff
changeset
|
1353 |
|
81e041f5633a
doc: Add copyobj, struct2hdl, hdl2struct to manual.
Rik <rik@octave.org>
parents:
16808
diff
changeset
|
1354 @DOCSTRING(hdl2struct) |
|
81e041f5633a
doc: Add copyobj, struct2hdl, hdl2struct to manual.
Rik <rik@octave.org>
parents:
16808
diff
changeset
|
1355 |
|
81e041f5633a
doc: Add copyobj, struct2hdl, hdl2struct to manual.
Rik <rik@octave.org>
parents:
16808
diff
changeset
|
1356 @DOCSTRING(struct2hdl) |
|
81e041f5633a
doc: Add copyobj, struct2hdl, hdl2struct to manual.
Rik <rik@octave.org>
parents:
16808
diff
changeset
|
1357 |
|
81e041f5633a
doc: Add copyobj, struct2hdl, hdl2struct to manual.
Rik <rik@octave.org>
parents:
16808
diff
changeset
|
1358 @DOCSTRING(copyobj) |
|
81e041f5633a
doc: Add copyobj, struct2hdl, hdl2struct to manual.
Rik <rik@octave.org>
parents:
16808
diff
changeset
|
1359 |
| 6888 | 1360 @node Graphics Object Properties |
| 1361 @subsection Graphics Object Properties | |
| 1362 @cindex graphics object properties | |
| 1363 | |
| 1364 @menu | |
|
17152
f2a8592b8fbd
doc: Shorten some long subsection names in Manual.
Rik <rik@octave.org>
parents:
17123
diff
changeset
|
1365 * Root Figure Properties:: |
|
f2a8592b8fbd
doc: Shorten some long subsection names in Manual.
Rik <rik@octave.org>
parents:
17123
diff
changeset
|
1366 * Figure Properties:: |
|
f2a8592b8fbd
doc: Shorten some long subsection names in Manual.
Rik <rik@octave.org>
parents:
17123
diff
changeset
|
1367 * Axes Properties:: |
|
f2a8592b8fbd
doc: Shorten some long subsection names in Manual.
Rik <rik@octave.org>
parents:
17123
diff
changeset
|
1368 * Line Properties:: |
|
f2a8592b8fbd
doc: Shorten some long subsection names in Manual.
Rik <rik@octave.org>
parents:
17123
diff
changeset
|
1369 * Text Properties:: |
|
f2a8592b8fbd
doc: Shorten some long subsection names in Manual.
Rik <rik@octave.org>
parents:
17123
diff
changeset
|
1370 * Image Properties:: |
|
f2a8592b8fbd
doc: Shorten some long subsection names in Manual.
Rik <rik@octave.org>
parents:
17123
diff
changeset
|
1371 * Patch Properties:: |
|
f2a8592b8fbd
doc: Shorten some long subsection names in Manual.
Rik <rik@octave.org>
parents:
17123
diff
changeset
|
1372 * Surface Properties:: |
| 6888 | 1373 @end menu |
| 1374 | |
|
19449
1f2a16d41ba2
Automatically generate graphics properties documentation (bug #42536)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents:
19344
diff
changeset
|
1375 In this Section the graphics object properties are discussed in detail, starting |
|
1f2a16d41ba2
Automatically generate graphics properties documentation (bug #42536)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents:
19344
diff
changeset
|
1376 with the root figure properties and continuing through the objects |
|
19794
db92e7e28e1f
strip trailing whitespace from most source files
John W. Eaton <jwe@octave.org>
parents:
19793
diff
changeset
|
1377 hierarchy. The documentation about a specific graphics object can be displayed |
|
db92e7e28e1f
strip trailing whitespace from most source files
John W. Eaton <jwe@octave.org>
parents:
19793
diff
changeset
|
1378 using @code{doc} function, e.g., @code{doc ("axes properties")} will show |
|
db92e7e28e1f
strip trailing whitespace from most source files
John W. Eaton <jwe@octave.org>
parents:
19793
diff
changeset
|
1379 @ref{Axes Properties}. |
|
db92e7e28e1f
strip trailing whitespace from most source files
John W. Eaton <jwe@octave.org>
parents:
19793
diff
changeset
|
1380 |
|
db92e7e28e1f
strip trailing whitespace from most source files
John W. Eaton <jwe@octave.org>
parents:
19793
diff
changeset
|
1381 The allowed values for radio (string) properties can be retrieved |
|
db92e7e28e1f
strip trailing whitespace from most source files
John W. Eaton <jwe@octave.org>
parents:
19793
diff
changeset
|
1382 programmatically or displayed using the one or |
|
19602
cbce5d1bcaf9
doc: Periodic grammarcheck of documentation.
Rik <rik@octave.org>
parents:
19504
diff
changeset
|
1383 two arguments call to @code{set} function. @xref{XREFset, , set}. |
|
19449
1f2a16d41ba2
Automatically generate graphics properties documentation (bug #42536)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents:
19344
diff
changeset
|
1384 |
|
1f2a16d41ba2
Automatically generate graphics properties documentation (bug #42536)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents:
19344
diff
changeset
|
1385 In the following documentation, default values are enclosed in @{ @}. |
|
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
1386 |
| 6888 | 1387 @node Root Figure Properties |
| 1388 @subsubsection Root Figure Properties | |
|
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
1389 @cindex root figure properties |
|
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
1390 |
|
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
1391 The @code{root figure} properties are: |
|
14853
72b8b39e12be
doc: Periodic grammarcheck of documentation.
Rik <octave@nomad.inbox5.com>
parents:
14577
diff
changeset
|
1392 |
|
19449
1f2a16d41ba2
Automatically generate graphics properties documentation (bug #42536)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents:
19344
diff
changeset
|
1393 @include plot-rootproperties.texi |
|
1f2a16d41ba2
Automatically generate graphics properties documentation (bug #42536)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents:
19344
diff
changeset
|
1394 |
| 6888 | 1395 |
| 6889 | 1396 @node Figure Properties |
| 1397 @subsubsection Figure Properties | |
| 8071 | 1398 @cindex figure properties |
| 6888 | 1399 |
|
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
1400 The @code{figure} properties are: |
|
14853
72b8b39e12be
doc: Periodic grammarcheck of documentation.
Rik <octave@nomad.inbox5.com>
parents:
14577
diff
changeset
|
1401 |
|
19449
1f2a16d41ba2
Automatically generate graphics properties documentation (bug #42536)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents:
19344
diff
changeset
|
1402 @include plot-figureproperties.texi |
|
1f2a16d41ba2
Automatically generate graphics properties documentation (bug #42536)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents:
19344
diff
changeset
|
1403 |
| 6888 | 1404 |
| 1405 @node Axes Properties | |
| 1406 @subsubsection Axes Properties | |
| 8071 | 1407 @cindex axes properties |
| 6888 | 1408 |
|
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
1409 The @code{axes} properties are: |
|
14853
72b8b39e12be
doc: Periodic grammarcheck of documentation.
Rik <octave@nomad.inbox5.com>
parents:
14577
diff
changeset
|
1410 |
|
19449
1f2a16d41ba2
Automatically generate graphics properties documentation (bug #42536)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents:
19344
diff
changeset
|
1411 @include plot-axesproperties.texi |
|
1f2a16d41ba2
Automatically generate graphics properties documentation (bug #42536)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents:
19344
diff
changeset
|
1412 |
| 6888 | 1413 |
| 1414 @node Line Properties | |
| 1415 @subsubsection Line Properties | |
| 8071 | 1416 @cindex line properties |
| 6888 | 1417 |
|
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
1418 The @code{line} properties are: |
|
14853
72b8b39e12be
doc: Periodic grammarcheck of documentation.
Rik <octave@nomad.inbox5.com>
parents:
14577
diff
changeset
|
1419 |
|
19449
1f2a16d41ba2
Automatically generate graphics properties documentation (bug #42536)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents:
19344
diff
changeset
|
1420 @include plot-lineproperties.texi |
|
1f2a16d41ba2
Automatically generate graphics properties documentation (bug #42536)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents:
19344
diff
changeset
|
1421 |
| 6888 | 1422 |
| 1423 @node Text Properties | |
| 1424 @subsubsection Text Properties | |
| 8071 | 1425 @cindex text properties |
| 6888 | 1426 |
|
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
1427 The @code{text} properties are: |
|
14853
72b8b39e12be
doc: Periodic grammarcheck of documentation.
Rik <octave@nomad.inbox5.com>
parents:
14577
diff
changeset
|
1428 |
|
19449
1f2a16d41ba2
Automatically generate graphics properties documentation (bug #42536)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents:
19344
diff
changeset
|
1429 @include plot-textproperties.texi |
|
1f2a16d41ba2
Automatically generate graphics properties documentation (bug #42536)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents:
19344
diff
changeset
|
1430 |
| 6888 | 1431 |
| 1432 @node Image Properties | |
| 1433 @subsubsection Image Properties | |
| 8071 | 1434 @cindex image properties |
| 6888 | 1435 |
|
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
1436 The @code{image} properties are: |
|
14853
72b8b39e12be
doc: Periodic grammarcheck of documentation.
Rik <octave@nomad.inbox5.com>
parents:
14577
diff
changeset
|
1437 |
|
19449
1f2a16d41ba2
Automatically generate graphics properties documentation (bug #42536)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents:
19344
diff
changeset
|
1438 @include plot-imageproperties.texi |
|
1f2a16d41ba2
Automatically generate graphics properties documentation (bug #42536)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents:
19344
diff
changeset
|
1439 |
| 6888 | 1440 |
| 1441 @node Patch Properties | |
| 1442 @subsubsection Patch Properties | |
| 8071 | 1443 @cindex patch properties |
| 6888 | 1444 |
|
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
1445 The @code{patch} properties are: |
|
14853
72b8b39e12be
doc: Periodic grammarcheck of documentation.
Rik <octave@nomad.inbox5.com>
parents:
14577
diff
changeset
|
1446 |
|
19449
1f2a16d41ba2
Automatically generate graphics properties documentation (bug #42536)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents:
19344
diff
changeset
|
1447 @include plot-patchproperties.texi |
|
1f2a16d41ba2
Automatically generate graphics properties documentation (bug #42536)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents:
19344
diff
changeset
|
1448 |
| 6888 | 1449 |
| 1450 @node Surface Properties | |
| 1451 @subsubsection Surface Properties | |
| 8071 | 1452 @cindex surface properties |
| 6888 | 1453 |
|
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
1454 The @code{surface} properties are: |
|
14853
72b8b39e12be
doc: Periodic grammarcheck of documentation.
Rik <octave@nomad.inbox5.com>
parents:
14577
diff
changeset
|
1455 |
|
19449
1f2a16d41ba2
Automatically generate graphics properties documentation (bug #42536)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents:
19344
diff
changeset
|
1456 @include plot-surfaceproperties.texi |
|
1f2a16d41ba2
Automatically generate graphics properties documentation (bug #42536)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents:
19344
diff
changeset
|
1457 |
| 6889 | 1458 |
|
8070
3b53b25e2550
Add data sources and line series
David Bateman <dbateman@free.fr>
parents:
8057
diff
changeset
|
1459 @node Searching Properties |
|
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
1460 @subsection Searching Properties |
|
7984
bbaa5d7d0143
Some documentation updates
David Bateman <dbateman@free.fr>
parents:
7981
diff
changeset
|
1461 |
|
bbaa5d7d0143
Some documentation updates
David Bateman <dbateman@free.fr>
parents:
7981
diff
changeset
|
1462 @DOCSTRING(findobj) |
|
bbaa5d7d0143
Some documentation updates
David Bateman <dbateman@free.fr>
parents:
7981
diff
changeset
|
1463 |
|
bbaa5d7d0143
Some documentation updates
David Bateman <dbateman@free.fr>
parents:
7981
diff
changeset
|
1464 @DOCSTRING(findall) |
| 6891 | 1465 @node Managing Default Properties |
| 1466 @subsection Managing Default Properties | |
| 8071 | 1467 @cindex default graphics properties |
| 1468 @cindex graphics properties, default | |
| 6891 | 1469 |
| 6892 | 1470 Object properties have two classes of default values, @dfn{factory |
| 1471 defaults} (the initial values) and @dfn{user-defined defaults}, which | |
| 1472 may override the factory defaults. | |
| 6891 | 1473 |
| 1474 Although default values may be set for any object, they are set in | |
|
12610
bdf694af4aa5
plot.txi: Clarify that inheritance of default property values only applies to the named object type.
Ben Abbott <bpabbott@mac.com>
parents:
12578
diff
changeset
|
1475 parent objects and apply to child objects, of the specified object type. |
|
13931
9de488c6c59c
doc: Spellcheck documentation before 3.6.0 release
Rik <octave@nomad.inbox5.com>
parents:
12763
diff
changeset
|
1476 For example, setting the default @code{color} property of @code{line} |
|
17281
bc924baa2c4e
doc: Add new @qcode macro for code samples which are quoted.
Rik <rik@octave.org>
parents:
17170
diff
changeset
|
1477 objects to @qcode{"green"}, for the @code{root} object, will result in all |
|
bc924baa2c4e
doc: Add new @qcode macro for code samples which are quoted.
Rik <rik@octave.org>
parents:
17170
diff
changeset
|
1478 @code{line} objects inheriting the @code{color} @qcode{"green"} as the default |
|
12610
bdf694af4aa5
plot.txi: Clarify that inheritance of default property values only applies to the named object type.
Ben Abbott <bpabbott@mac.com>
parents:
12578
diff
changeset
|
1479 value. |
| 6891 | 1480 |
| 1481 @example | |
| 1482 set (0, "defaultlinecolor", "green"); | |
| 1483 @end example | |
| 1484 | |
| 1485 @noindent | |
| 1486 sets the default line color for all objects. The rule for constructing | |
| 1487 the property name to set a default value is | |
| 1488 | |
| 1489 @example | |
| 1490 default + @var{object-type} + @var{property-name} | |
| 1491 @end example | |
| 1492 | |
| 1493 This rule can lead to some strange looking names, for example | |
| 1494 @code{defaultlinelinewidth"} specifies the default @code{linewidth} | |
| 1495 property for @code{line} objects. | |
| 1496 | |
| 1497 The example above used the root figure object, 0, so the default | |
| 1498 property value will apply to all line objects. However, default values | |
| 1499 are hierarchical, so defaults set in a figure objects override those | |
| 1500 set in the root figure object. Likewise, defaults set in axes objects | |
| 1501 override those set in figure or root figure objects. For example, | |
| 1502 | |
| 1503 @example | |
| 1504 @group | |
| 1505 subplot (2, 1, 1); | |
| 1506 set (0, "defaultlinecolor", "red"); | |
| 1507 set (1, "defaultlinecolor", "green"); | |
| 1508 set (gca (), "defaultlinecolor", "blue"); | |
| 1509 line (1:10, rand (1, 10)); | |
| 1510 subplot (2, 1, 2); | |
| 1511 line (1:10, rand (1, 10)); | |
| 1512 figure (2) | |
| 1513 line (1:10, rand (1, 10)); | |
| 1514 @end group | |
| 1515 @end example | |
| 1516 | |
| 1517 @noindent | |
| 1518 produces two figures. The line in first subplot window of the first | |
| 1519 figure is blue because it inherits its color from its parent axes | |
| 1520 object. The line in the second subplot window of the first figure is | |
| 1521 green because it inherits its color from its parent figure object. The | |
| 1522 line in the second figure window is red because it inherits its color | |
| 1523 from the global root figure parent object. | |
| 1524 | |
| 1525 To remove a user-defined default setting, set the default property to | |
|
17281
bc924baa2c4e
doc: Add new @qcode macro for code samples which are quoted.
Rik <rik@octave.org>
parents:
17170
diff
changeset
|
1526 the value @qcode{"remove"}. For example, |
| 6891 | 1527 |
| 1528 @example | |
| 1529 set (gca (), "defaultlinecolor", "remove"); | |
| 1530 @end example | |
| 1531 | |
| 1532 @noindent | |
| 1533 removes the user-defined default line color setting from the current axes | |
|
12189
9558ca33648d
Add functions reset, whitebg to documentation.
Rik <octave@nomad.inbox5.com>
parents:
11591
diff
changeset
|
1534 object. To quickly remove all user-defined defaults use the @code{reset} |
|
9558ca33648d
Add functions reset, whitebg to documentation.
Rik <octave@nomad.inbox5.com>
parents:
11591
diff
changeset
|
1535 function. |
|
9558ca33648d
Add functions reset, whitebg to documentation.
Rik <octave@nomad.inbox5.com>
parents:
11591
diff
changeset
|
1536 |
|
9558ca33648d
Add functions reset, whitebg to documentation.
Rik <octave@nomad.inbox5.com>
parents:
11591
diff
changeset
|
1537 @DOCSTRING(reset) |
| 6891 | 1538 |
|
17281
bc924baa2c4e
doc: Add new @qcode macro for code samples which are quoted.
Rik <rik@octave.org>
parents:
17170
diff
changeset
|
1539 Getting the @qcode{"default"} property of an object returns a list of |
| 6891 | 1540 user-defined defaults set for the object. For example, |
| 1541 | |
| 1542 @example | |
| 1543 get (gca (), "default"); | |
| 1544 @end example | |
| 1545 | |
| 1546 @noindent | |
| 1547 returns a list of user-defined default values for the current axes | |
| 1548 object. | |
| 1549 | |
| 1550 Factory default values are stored in the root figure object. The | |
| 1551 command | |
| 1552 | |
| 1553 @example | |
| 1554 get (0, "factory"); | |
| 1555 @end example | |
| 1556 | |
| 1557 @noindent | |
| 1558 returns a list of factory defaults. | |
| 1559 | |
|
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
1560 @node Advanced Plotting |
|
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
1561 @section Advanced Plotting |
|
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
1562 |
|
12525
d36266a54202
Add getappdata, setappdata, isappdata, rmappdata functions to documentation.
Rik <octave@nomad.inbox5.com>
parents:
12522
diff
changeset
|
1563 |
|
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
1564 @menu |
|
17152
f2a8592b8fbd
doc: Shorten some long subsection names in Manual.
Rik <rik@octave.org>
parents:
17123
diff
changeset
|
1565 * Colors:: |
|
f2a8592b8fbd
doc: Shorten some long subsection names in Manual.
Rik <rik@octave.org>
parents:
17123
diff
changeset
|
1566 * Line Styles:: |
|
f2a8592b8fbd
doc: Shorten some long subsection names in Manual.
Rik <rik@octave.org>
parents:
17123
diff
changeset
|
1567 * Marker Styles:: |
|
f2a8592b8fbd
doc: Shorten some long subsection names in Manual.
Rik <rik@octave.org>
parents:
17123
diff
changeset
|
1568 * Callbacks:: |
|
12525
d36266a54202
Add getappdata, setappdata, isappdata, rmappdata functions to documentation.
Rik <octave@nomad.inbox5.com>
parents:
12522
diff
changeset
|
1569 * Application-defined Data:: |
|
17152
f2a8592b8fbd
doc: Shorten some long subsection names in Manual.
Rik <rik@octave.org>
parents:
17123
diff
changeset
|
1570 * Object Groups:: |
|
f2a8592b8fbd
doc: Shorten some long subsection names in Manual.
Rik <rik@octave.org>
parents:
17123
diff
changeset
|
1571 * Graphics Toolkits:: |
|
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
1572 @end menu |
|
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
1573 |
|
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
1574 |
| 6889 | 1575 @node Colors |
| 1576 @subsection Colors | |
| 8071 | 1577 @cindex graphics colors |
| 1578 @cindex colors, graphics | |
| 6889 | 1579 |
| 1580 Colors may be specified as RGB triplets with values ranging from zero to | |
|
17281
bc924baa2c4e
doc: Add new @qcode macro for code samples which are quoted.
Rik <rik@octave.org>
parents:
17170
diff
changeset
|
1581 one, or by name. Recognized color names include @qcode{"blue"}, |
|
bc924baa2c4e
doc: Add new @qcode macro for code samples which are quoted.
Rik <rik@octave.org>
parents:
17170
diff
changeset
|
1582 @qcode{"black"}, @qcode{"cyan"}, @qcode{"green"}, @qcode{"magenta"}, |
|
bc924baa2c4e
doc: Add new @qcode macro for code samples which are quoted.
Rik <rik@octave.org>
parents:
17170
diff
changeset
|
1583 @qcode{"red"}, @qcode{"white"}, and @qcode{"yellow"}. |
| 6889 | 1584 |
| 1585 @node Line Styles | |
| 1586 @subsection Line Styles | |
| 8071 | 1587 @cindex line styles, graphics |
| 1588 @cindex graphics line styles | |
| 1589 | |
| 7001 | 1590 Line styles are specified by the following properties: |
| 6889 | 1591 |
| 1592 @table @code | |
| 1593 @item linestyle | |
| 1594 May be one of | |
|
14853
72b8b39e12be
doc: Periodic grammarcheck of documentation.
Rik <octave@nomad.inbox5.com>
parents:
14577
diff
changeset
|
1595 |
|
18078
b06a9768b643
doc: Don't use @table @qcode to avoid problems with Texinfo 5.2.
Rik <rik@octave.org>
parents:
17957
diff
changeset
|
1596 @table @asis |
|
b06a9768b643
doc: Don't use @table @qcode to avoid problems with Texinfo 5.2.
Rik <rik@octave.org>
parents:
17957
diff
changeset
|
1597 @item @qcode{"-"} |
|
12690
e9e35a707721
doc: Add 'none' to list of plot linestyles.
Rik <octave@nomad.inbox5.com>
parents:
12607
diff
changeset
|
1598 Solid line. [default] |
|
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
1599 |
|
18541
2b01c11197d6
Fix contraction of '--' to '-' in Info format of Line Styles (bug #41585)
Rik <rik@octave.org>
parents:
18407
diff
changeset
|
1600 @c Special handling required to avoid '--' becoming single en-dash in Info |
|
18542
d39fd728ddef
Tweak cset 044bbf569cd3 to get '--' to display in HTML as well (bug #41585).
Rik <rik@octave.org>
parents:
18541
diff
changeset
|
1601 @ifnottex |
|
19602
cbce5d1bcaf9
doc: Periodic grammarcheck of documentation.
Rik <rik@octave.org>
parents:
19504
diff
changeset
|
1602 |
|
18542
d39fd728ddef
Tweak cset 044bbf569cd3 to get '--' to display in HTML as well (bug #41585).
Rik <rik@octave.org>
parents:
18541
diff
changeset
|
1603 @item @verb{|"--"|} |
|
d39fd728ddef
Tweak cset 044bbf569cd3 to get '--' to display in HTML as well (bug #41585).
Rik <rik@octave.org>
parents:
18541
diff
changeset
|
1604 @end ifnottex |
|
18541
2b01c11197d6
Fix contraction of '--' to '-' in Info format of Line Styles (bug #41585)
Rik <rik@octave.org>
parents:
18407
diff
changeset
|
1605 @iftex |
|
19602
cbce5d1bcaf9
doc: Periodic grammarcheck of documentation.
Rik <rik@octave.org>
parents:
19504
diff
changeset
|
1606 |
|
18541
2b01c11197d6
Fix contraction of '--' to '-' in Info format of Line Styles (bug #41585)
Rik <rik@octave.org>
parents:
18407
diff
changeset
|
1607 @item @code{"--"} |
|
2b01c11197d6
Fix contraction of '--' to '-' in Info format of Line Styles (bug #41585)
Rik <rik@octave.org>
parents:
18407
diff
changeset
|
1608 @end iftex |
|
12690
e9e35a707721
doc: Add 'none' to list of plot linestyles.
Rik <octave@nomad.inbox5.com>
parents:
12607
diff
changeset
|
1609 Dashed line. |
|
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
1610 |
|
18078
b06a9768b643
doc: Don't use @table @qcode to avoid problems with Texinfo 5.2.
Rik <rik@octave.org>
parents:
17957
diff
changeset
|
1611 @item @qcode{":"} |
|
12690
e9e35a707721
doc: Add 'none' to list of plot linestyles.
Rik <octave@nomad.inbox5.com>
parents:
12607
diff
changeset
|
1612 Dotted line. |
|
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
1613 |
|
18078
b06a9768b643
doc: Don't use @table @qcode to avoid problems with Texinfo 5.2.
Rik <rik@octave.org>
parents:
17957
diff
changeset
|
1614 @item @qcode{"-."} |
| 6889 | 1615 A dash-dot line. |
|
12690
e9e35a707721
doc: Add 'none' to list of plot linestyles.
Rik <octave@nomad.inbox5.com>
parents:
12607
diff
changeset
|
1616 |
|
17281
bc924baa2c4e
doc: Add new @qcode macro for code samples which are quoted.
Rik <rik@octave.org>
parents:
17170
diff
changeset
|
1617 @item @qcode{"none"} |
|
12690
e9e35a707721
doc: Add 'none' to list of plot linestyles.
Rik <octave@nomad.inbox5.com>
parents:
12607
diff
changeset
|
1618 No line. Points will still be marked using the current Marker Style. |
| 6889 | 1619 @end table |
| 1620 | |
| 1621 @item linewidth | |
| 1622 A number specifying the width of the line. The default is 1. A value | |
| 1623 of 2 is twice as wide as the default, etc. | |
| 1624 @end table | |
| 1625 | |
| 1626 @node Marker Styles | |
| 1627 @subsection Marker Styles | |
| 8071 | 1628 @cindex graphics marker styles |
| 1629 @cindex marker styles, graphics | |
| 1630 | |
| 7001 | 1631 Marker styles are specified by the following properties: |
|
14853
72b8b39e12be
doc: Periodic grammarcheck of documentation.
Rik <octave@nomad.inbox5.com>
parents:
14577
diff
changeset
|
1632 |
| 6889 | 1633 @table @code |
| 1634 @item marker | |
| 1635 A character indicating a plot marker to be place at each data point, or | |
|
17281
bc924baa2c4e
doc: Add new @qcode macro for code samples which are quoted.
Rik <rik@octave.org>
parents:
17170
diff
changeset
|
1636 @qcode{"none"}, meaning no markers should be displayed. |
| 6889 | 1637 |
|
16094
8899c785cc99
doc: Fix warnings associated with Texinfo 5.0 (bug #38392)
Rik <rik@octave.org>
parents:
16008
diff
changeset
|
1638 @item markeredgecolor |
|
17281
bc924baa2c4e
doc: Add new @qcode macro for code samples which are quoted.
Rik <rik@octave.org>
parents:
17170
diff
changeset
|
1639 The color of the edge around the marker, or @qcode{"auto"}, meaning that |
| 6889 | 1640 the edge color is the same as the face color. @xref{Colors}. |
| 1641 | |
|
16094
8899c785cc99
doc: Fix warnings associated with Texinfo 5.0 (bug #38392)
Rik <rik@octave.org>
parents:
16008
diff
changeset
|
1642 @item markerfacecolor |
|
17281
bc924baa2c4e
doc: Add new @qcode macro for code samples which are quoted.
Rik <rik@octave.org>
parents:
17170
diff
changeset
|
1643 The color of the marker, or @qcode{"none"} to indicate that the marker |
| 6889 | 1644 should not be filled. @xref{Colors}. |
| 1645 | |
|
16094
8899c785cc99
doc: Fix warnings associated with Texinfo 5.0 (bug #38392)
Rik <rik@octave.org>
parents:
16008
diff
changeset
|
1646 @item markersize |
| 6889 | 1647 A number specifying the size of the marker. The default is 1. A value |
| 1648 of 2 is twice as large as the default, etc. | |
| 6888 | 1649 @end table |
| 1650 | |
|
12607
2846ea58b288
colstyle.m: Add new function (bug #33063)
Rik <octave@nomad.inbox5.com>
parents:
12578
diff
changeset
|
1651 The @code{colstyle} function will parse a @code{plot}-style specification |
|
2846ea58b288
colstyle.m: Add new function (bug #33063)
Rik <octave@nomad.inbox5.com>
parents:
12578
diff
changeset
|
1652 and will return the color, line, and marker values that would result. |
|
2846ea58b288
colstyle.m: Add new function (bug #33063)
Rik <octave@nomad.inbox5.com>
parents:
12578
diff
changeset
|
1653 |
|
2846ea58b288
colstyle.m: Add new function (bug #33063)
Rik <octave@nomad.inbox5.com>
parents:
12578
diff
changeset
|
1654 @DOCSTRING(colstyle) |
|
2846ea58b288
colstyle.m: Add new function (bug #33063)
Rik <octave@nomad.inbox5.com>
parents:
12578
diff
changeset
|
1655 |
|
8056
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
1656 @node Callbacks |
|
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
1657 @subsection Callbacks |
| 8071 | 1658 @cindex callbacks |
|
8056
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
1659 |
|
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
1660 Callback functions can be associated with graphics objects and triggered |
|
9040
dbd0c77e575e
Cleanup documentation file plot.texi
Rik <rdrider0-list@yahoo.com>
parents:
9032
diff
changeset
|
1661 after certain events occur. The basic structure of all callback function |
|
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
1662 is |
|
8056
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
1663 |
|
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
1664 @example |
|
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
1665 @group |
|
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
1666 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
|
1667 @dots{} |
|
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
1668 endfunction |
|
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
1669 @end group |
|
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
1670 @end example |
|
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
1671 |
|
10846
a4f482e66b65
Grammarcheck more of the documentation.
Rik <octave@nomad.inbox5.com>
parents:
10828
diff
changeset
|
1672 @noindent |
|
8056
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
1673 where @code{src} gives a handle to the source of the callback, and |
|
9040
dbd0c77e575e
Cleanup documentation file plot.texi
Rik <rdrider0-list@yahoo.com>
parents:
9032
diff
changeset
|
1674 @code{code} gives some event specific data. This can then be associated |
|
8056
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
1675 with an object either at the objects creation or later with the |
|
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
1676 @code{set} function. For example, |
|
8056
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
1677 |
|
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
1678 @example |
|
14856
c3fd61c59e9c
maint: Use Octave coding conventions for cuddling parentheses in doc directory
Rik <octave@nomad.inbox5.com>
parents:
14853
diff
changeset
|
1679 plot (x, "DeleteFcn", @@(s, e) disp ("Window Deleted")) |
|
8056
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
1680 @end example |
|
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
1681 |
|
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
1682 @noindent |
|
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
1683 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
|
1684 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
|
1685 |
|
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
1686 Additional user arguments can be passed to callback functions, and will |
|
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
1687 be passed after the 2 default arguments. For example: |
|
8056
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
1688 |
|
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
1689 @example |
|
9088
77e71f3da3d6
Fix documentation image printing under new development code
Rik <rdrider0-list@yahoo.com>
parents:
9040
diff
changeset
|
1690 @group |
| 8057 | 1691 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
|
1692 @dots{} |
| 8057 | 1693 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
|
1694 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
|
1695 endfunction |
|
9088
77e71f3da3d6
Fix documentation image printing under new development code
Rik <rdrider0-list@yahoo.com>
parents:
9040
diff
changeset
|
1696 @end group |
|
8056
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
1697 @end example |
|
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
1698 |
|
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
1699 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
|
1700 are |
|
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
1701 |
|
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
1702 @itemize @bullet |
|
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
1703 @item CreateFcn |
|
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
1704 This is the callback that is called at the moment of the objects |
|
9040
dbd0c77e575e
Cleanup documentation file plot.texi
Rik <rdrider0-list@yahoo.com>
parents:
9032
diff
changeset
|
1705 creation. It is not called if the object is altered in any way, and so |
|
8056
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
1706 it only makes sense to define this callback in the function call that |
|
9040
dbd0c77e575e
Cleanup documentation file plot.texi
Rik <rdrider0-list@yahoo.com>
parents:
9032
diff
changeset
|
1707 defines the object. Callbacks that are added to @code{CreateFcn} later with |
|
8056
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
1708 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
|
1709 |
|
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
1710 @item DeleteFcn |
|
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
1711 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
|
1712 |
|
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
1713 @item ButtonDownFcn |
|
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
1714 This is the callback that is called if a mouse button is pressed while |
|
9040
dbd0c77e575e
Cleanup documentation file plot.texi
Rik <rdrider0-list@yahoo.com>
parents:
9032
diff
changeset
|
1715 the pointer is over this object. Note, that the gnuplot interface does |
|
8056
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
1716 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
|
1717 @end itemize |
|
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
1718 |
|
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
1719 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
|
1720 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
|
1721 functions. |
|
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
1722 |
|
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
1723 @DOCSTRING(gcbo) |
|
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
1724 |
|
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
1725 @DOCSTRING(gcbf) |
|
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
1726 |
|
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
1727 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
|
1728 function described below. |
|
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
1729 |
|
12525
d36266a54202
Add getappdata, setappdata, isappdata, rmappdata functions to documentation.
Rik <octave@nomad.inbox5.com>
parents:
12522
diff
changeset
|
1730 @node Application-defined Data |
|
17152
f2a8592b8fbd
doc: Shorten some long subsection names in Manual.
Rik <rik@octave.org>
parents:
17123
diff
changeset
|
1731 @subsection Application-defined Data |
|
12578
f5a780d675a1
Clean up operator and function indices in documentation.
Rik <octave@nomad.inbox5.com>
parents:
12577
diff
changeset
|
1732 @cindex application-defined data |
|
12525
d36266a54202
Add getappdata, setappdata, isappdata, rmappdata functions to documentation.
Rik <octave@nomad.inbox5.com>
parents:
12522
diff
changeset
|
1733 |
|
d36266a54202
Add getappdata, setappdata, isappdata, rmappdata functions to documentation.
Rik <octave@nomad.inbox5.com>
parents:
12522
diff
changeset
|
1734 Octave has a provision for attaching application-defined data to a graphics |
|
d36266a54202
Add getappdata, setappdata, isappdata, rmappdata functions to documentation.
Rik <octave@nomad.inbox5.com>
parents:
12522
diff
changeset
|
1735 handle. The data can be anything which is meaningful to the application, and |
|
d36266a54202
Add getappdata, setappdata, isappdata, rmappdata functions to documentation.
Rik <octave@nomad.inbox5.com>
parents:
12522
diff
changeset
|
1736 will be completely ignored by Octave. |
|
d36266a54202
Add getappdata, setappdata, isappdata, rmappdata functions to documentation.
Rik <octave@nomad.inbox5.com>
parents:
12522
diff
changeset
|
1737 |
|
d36266a54202
Add getappdata, setappdata, isappdata, rmappdata functions to documentation.
Rik <octave@nomad.inbox5.com>
parents:
12522
diff
changeset
|
1738 @DOCSTRING(setappdata) |
|
d36266a54202
Add getappdata, setappdata, isappdata, rmappdata functions to documentation.
Rik <octave@nomad.inbox5.com>
parents:
12522
diff
changeset
|
1739 |
|
d36266a54202
Add getappdata, setappdata, isappdata, rmappdata functions to documentation.
Rik <octave@nomad.inbox5.com>
parents:
12522
diff
changeset
|
1740 @DOCSTRING(getappdata) |
|
d36266a54202
Add getappdata, setappdata, isappdata, rmappdata functions to documentation.
Rik <octave@nomad.inbox5.com>
parents:
12522
diff
changeset
|
1741 |
|
d36266a54202
Add getappdata, setappdata, isappdata, rmappdata functions to documentation.
Rik <octave@nomad.inbox5.com>
parents:
12522
diff
changeset
|
1742 @DOCSTRING(rmappdata) |
|
d36266a54202
Add getappdata, setappdata, isappdata, rmappdata functions to documentation.
Rik <octave@nomad.inbox5.com>
parents:
12522
diff
changeset
|
1743 |
|
d36266a54202
Add getappdata, setappdata, isappdata, rmappdata functions to documentation.
Rik <octave@nomad.inbox5.com>
parents:
12522
diff
changeset
|
1744 @DOCSTRING(isappdata) |
|
d36266a54202
Add getappdata, setappdata, isappdata, rmappdata functions to documentation.
Rik <octave@nomad.inbox5.com>
parents:
12522
diff
changeset
|
1745 |
|
8056
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
1746 @node Object Groups |
|
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
1747 @subsection Object Groups |
| 8071 | 1748 @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
|
1749 |
|
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
1750 A number of Octave high level plot functions return groups of other |
|
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
1751 graphics objects or they return graphics objects that have their |
|
8056
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
1752 properties linked in such a way that changes to one of the properties |
|
9040
dbd0c77e575e
Cleanup documentation file plot.texi
Rik <rdrider0-list@yahoo.com>
parents:
9032
diff
changeset
|
1753 results in changes in the others. A graphic object that groups other |
|
8056
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
1754 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
|
1755 |
|
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
1756 @DOCSTRING(hggroup) |
|
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
1757 |
|
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
1758 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
|
1759 |
|
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
1760 @example |
|
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
1761 @group |
|
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
1762 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
|
1763 hg = hggroup (); |
|
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
1764 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
|
1765 hold on |
|
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
1766 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
|
1767 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
|
1768 @end group |
|
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
1769 @end example |
|
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
1770 |
|
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
1771 @noindent |
|
9040
dbd0c77e575e
Cleanup documentation file plot.texi
Rik <rdrider0-list@yahoo.com>
parents:
9032
diff
changeset
|
1772 which groups the two plots into a single object and controls their |
|
dbd0c77e575e
Cleanup documentation file plot.texi
Rik <rdrider0-list@yahoo.com>
parents:
9032
diff
changeset
|
1773 visibility directly. The default properties of an @code{hggroup} are |
|
8056
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
1774 the same as the set of common properties for the other graphics |
|
9040
dbd0c77e575e
Cleanup documentation file plot.texi
Rik <rdrider0-list@yahoo.com>
parents:
9032
diff
changeset
|
1775 objects. Additional properties can be added with the @code{addproperty} |
|
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
1776 function. |
|
8056
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
1777 |
|
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
1778 @DOCSTRING(addproperty) |
|
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
1779 |
|
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
1780 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
|
1781 other property of either the children of the group, or any other |
|
9040
dbd0c77e575e
Cleanup documentation file plot.texi
Rik <rdrider0-list@yahoo.com>
parents:
9032
diff
changeset
|
1782 graphics object. Add so to control the way in which this newly added |
|
8056
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
1783 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
|
1784 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
|
1785 |
|
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
1786 @DOCSTRING(addlistener) |
|
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
1787 |
|
8817
03b7f618ab3d
include docstrings for new functions in the manual
John W. Eaton <jwe@octave.org>
parents:
8519
diff
changeset
|
1788 @DOCSTRING(dellistener) |
|
03b7f618ab3d
include docstrings for new functions in the manual
John W. Eaton <jwe@octave.org>
parents:
8519
diff
changeset
|
1789 |
|
8056
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
1790 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
|
1791 |
|
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
1792 @example |
|
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
1793 @group |
|
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
1794 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
|
1795 hg = hggroup (); |
|
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
1796 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
|
1797 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
|
1798 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
|
1799 hold on |
|
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
1800 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
|
1801 |
|
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
1802 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
|
1803 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
|
1804 endfunction |
|
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
1805 @end group |
|
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
1806 @end example |
|
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
1807 |
|
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
1808 @noindent |
|
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
1809 that adds a @code{linestyle} property to the @code{hggroup} and |
|
9040
dbd0c77e575e
Cleanup documentation file plot.texi
Rik <rdrider0-list@yahoo.com>
parents:
9032
diff
changeset
|
1810 propagating any changes its value to the children of the group. The |
|
8070
3b53b25e2550
Add data sources and line series
David Bateman <dbateman@free.fr>
parents:
8057
diff
changeset
|
1811 @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
|
1812 |
|
3b53b25e2550
Add data sources and line series
David Bateman <dbateman@free.fr>
parents:
8057
diff
changeset
|
1813 @example |
|
3b53b25e2550
Add data sources and line series
David Bateman <dbateman@free.fr>
parents:
8057
diff
changeset
|
1814 @group |
|
3b53b25e2550
Add data sources and line series
David Bateman <dbateman@free.fr>
parents:
8057
diff
changeset
|
1815 x = 0:0.1:10; |
|
3b53b25e2550
Add data sources and line series
David Bateman <dbateman@free.fr>
parents:
8057
diff
changeset
|
1816 hg = hggroup (); |
|
3b53b25e2550
Add data sources and line series
David Bateman <dbateman@free.fr>
parents:
8057
diff
changeset
|
1817 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
|
1818 addproperty ("linestyle", hg, "linelinestyle", get (h, "linestyle")); |
|
3b53b25e2550
Add data sources and line series
David Bateman <dbateman@free.fr>
parents:
8057
diff
changeset
|
1819 hold on |
|
3b53b25e2550
Add data sources and line series
David Bateman <dbateman@free.fr>
parents:
8057
diff
changeset
|
1820 h2 = plot (x, cos (x), "color", [0, 1, 0], "parent", hg); |
|
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
1821 hlink = linkprop ([hg, h1, h2], "color"); |
|
8070
3b53b25e2550
Add data sources and line series
David Bateman <dbateman@free.fr>
parents:
8057
diff
changeset
|
1822 @end group |
|
3b53b25e2550
Add data sources and line series
David Bateman <dbateman@free.fr>
parents:
8057
diff
changeset
|
1823 @end example |
|
3b53b25e2550
Add data sources and line series
David Bateman <dbateman@free.fr>
parents:
8057
diff
changeset
|
1824 |
|
3b53b25e2550
Add data sources and line series
David Bateman <dbateman@free.fr>
parents:
8057
diff
changeset
|
1825 @DOCSTRING(linkprop) |
|
8056
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
1826 |
|
18894
d1750be79dee
linkaxes.m: Implement new function linkaxes.
Willem Atsma <willem.atsma@tanglebridge.com>
parents:
18715
diff
changeset
|
1827 @DOCSTRING(linkaxes) |
|
d1750be79dee
linkaxes.m: Implement new function linkaxes.
Willem Atsma <willem.atsma@tanglebridge.com>
parents:
18715
diff
changeset
|
1828 |
|
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
1829 These capabilities are used in a number of basic graphics objects. |
|
8056
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
1830 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
|
1831 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
|
1832 |
|
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
1833 @itemize @bullet |
|
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
1834 @item group together multiple graphics objects, |
|
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
1835 |
|
8056
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
1836 @item create linked properties between different graphics objects, and |
|
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
1837 |
|
8056
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
1838 @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
|
1839 @end itemize |
|
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
1840 |
|
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
1841 @noindent |
|
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
1842 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
|
1843 @code{hggroup} of the stem series contains two line objects representing |
|
9040
dbd0c77e575e
Cleanup documentation file plot.texi
Rik <rdrider0-list@yahoo.com>
parents:
9032
diff
changeset
|
1844 the body and head of the stem. The @code{ydata} property of the |
|
8056
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
1845 @code{hggroup} of the stem series represents the head of the stem, |
|
9040
dbd0c77e575e
Cleanup documentation file plot.texi
Rik <rdrider0-list@yahoo.com>
parents:
9032
diff
changeset
|
1846 whereas the body of the stem is between the baseline and this value. For |
|
8056
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
1847 example |
|
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
1848 |
|
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
1849 @example |
|
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
1850 @group |
|
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
1851 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
|
1852 get (h, "xdata") |
|
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
1853 @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
|
1854 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
|
1855 @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
|
1856 @end group |
|
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
1857 @end example |
|
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
1858 |
|
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
1859 @noindent |
|
9040
dbd0c77e575e
Cleanup documentation file plot.texi
Rik <rdrider0-list@yahoo.com>
parents:
9032
diff
changeset
|
1860 shows the difference between the @code{xdata} of the @code{hggroup} |
|
8056
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
1861 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
|
1862 |
|
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
1863 The basic properties of such group objects is that they consist of one |
|
8056
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
1864 or more linked @code{hggroup}, and that changes in certain properties of |
|
9040
dbd0c77e575e
Cleanup documentation file plot.texi
Rik <rdrider0-list@yahoo.com>
parents:
9032
diff
changeset
|
1865 these groups are propagated to other members of the group. Whereas, |
|
8056
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
1866 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
|
1867 member. |
|
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
1868 |
|
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
1869 In addition the members of the group can also be linked to other |
|
9040
dbd0c77e575e
Cleanup documentation file plot.texi
Rik <rdrider0-list@yahoo.com>
parents:
9032
diff
changeset
|
1870 graphics objects through callback functions. For example the baseline of |
|
8056
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
1871 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
|
1872 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
|
1873 corresponding hggroup elements. |
|
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
1874 |
|
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
1875 @menu |
|
17152
f2a8592b8fbd
doc: Shorten some long subsection names in Manual.
Rik <rik@octave.org>
parents:
17123
diff
changeset
|
1876 * Data Sources in Object Groups:: |
|
f2a8592b8fbd
doc: Shorten some long subsection names in Manual.
Rik <rik@octave.org>
parents:
17123
diff
changeset
|
1877 * Area Series:: |
|
f2a8592b8fbd
doc: Shorten some long subsection names in Manual.
Rik <rik@octave.org>
parents:
17123
diff
changeset
|
1878 * Bar Series:: |
|
f2a8592b8fbd
doc: Shorten some long subsection names in Manual.
Rik <rik@octave.org>
parents:
17123
diff
changeset
|
1879 * Contour Groups:: |
|
f2a8592b8fbd
doc: Shorten some long subsection names in Manual.
Rik <rik@octave.org>
parents:
17123
diff
changeset
|
1880 * Error Bar Series:: |
|
f2a8592b8fbd
doc: Shorten some long subsection names in Manual.
Rik <rik@octave.org>
parents:
17123
diff
changeset
|
1881 * Line Series:: |
|
f2a8592b8fbd
doc: Shorten some long subsection names in Manual.
Rik <rik@octave.org>
parents:
17123
diff
changeset
|
1882 * Quiver Group:: |
|
f2a8592b8fbd
doc: Shorten some long subsection names in Manual.
Rik <rik@octave.org>
parents:
17123
diff
changeset
|
1883 * Scatter Group:: |
|
f2a8592b8fbd
doc: Shorten some long subsection names in Manual.
Rik <rik@octave.org>
parents:
17123
diff
changeset
|
1884 * Stair Group:: |
|
f2a8592b8fbd
doc: Shorten some long subsection names in Manual.
Rik <rik@octave.org>
parents:
17123
diff
changeset
|
1885 * Stem Series:: |
|
f2a8592b8fbd
doc: Shorten some long subsection names in Manual.
Rik <rik@octave.org>
parents:
17123
diff
changeset
|
1886 * Surface Group:: |
|
8056
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
1887 @end menu |
|
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
1888 |
|
11257
8d4c57258523
fix some menu problems in the manual
John W. Eaton <jwe@octave.org>
parents:
11255
diff
changeset
|
1889 @node Data Sources in Object Groups |
|
8d4c57258523
fix some menu problems in the manual
John W. Eaton <jwe@octave.org>
parents:
11255
diff
changeset
|
1890 @subsubsection Data Sources in Object Groups |
| 8071 | 1891 @cindex data sources in object groups |
|
17097
e7a059a9a644
doc: Use XREF as anchor prefix in documentation for clearer results in Info viewer.
Rik <rik@octave.org>
parents:
16923
diff
changeset
|
1892 @anchor{XREFdatasources} |
|
9040
dbd0c77e575e
Cleanup documentation file plot.texi
Rik <rdrider0-list@yahoo.com>
parents:
9032
diff
changeset
|
1893 All of the group objects contain data source parameters. There are |
|
8070
3b53b25e2550
Add data sources and line series
David Bateman <dbateman@free.fr>
parents:
8057
diff
changeset
|
1894 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
|
1895 the relevant data property of the group when the @code{refreshdata} |
|
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
1896 function is called. |
|
8070
3b53b25e2550
Add data sources and line series
David Bateman <dbateman@free.fr>
parents:
8057
diff
changeset
|
1897 |
|
3b53b25e2550
Add data sources and line series
David Bateman <dbateman@free.fr>
parents:
8057
diff
changeset
|
1898 @DOCSTRING(refreshdata) |
|
3b53b25e2550
Add data sources and line series
David Bateman <dbateman@free.fr>
parents:
8057
diff
changeset
|
1899 |
|
17097
e7a059a9a644
doc: Use XREF as anchor prefix in documentation for clearer results in Info viewer.
Rik <rik@octave.org>
parents:
16923
diff
changeset
|
1900 @anchor{XREFlinkdata} |
|
8070
3b53b25e2550
Add data sources and line series
David Bateman <dbateman@free.fr>
parents:
8057
diff
changeset
|
1901 @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
|
1902 @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
|
1903 @c command |
|
8070
3b53b25e2550
Add data sources and line series
David Bateman <dbateman@free.fr>
parents:
8057
diff
changeset
|
1904 |
|
11257
8d4c57258523
fix some menu problems in the manual
John W. Eaton <jwe@octave.org>
parents:
11255
diff
changeset
|
1905 @node Area Series |
|
8d4c57258523
fix some menu problems in the manual
John W. Eaton <jwe@octave.org>
parents:
11255
diff
changeset
|
1906 @subsubsection Area Series |
| 8071 | 1907 @cindex series objects |
| 1908 @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
|
1909 |
|
9040
dbd0c77e575e
Cleanup documentation file plot.texi
Rik <rdrider0-list@yahoo.com>
parents:
9032
diff
changeset
|
1910 Area series objects are created by the @code{area} function. Each of the |
|
dbd0c77e575e
Cleanup documentation file plot.texi
Rik <rdrider0-list@yahoo.com>
parents:
9032
diff
changeset
|
1911 @code{hggroup} elements contains a single patch object. The properties |
|
8056
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
1912 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
|
1913 |
|
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
1914 @table @code |
|
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
1915 @item basevalue |
|
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
1916 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
|
1917 |
|
17170
d6499c14021c
doc: Periodic grammarcheck of documentation.
Rik <rik@octave.org>
parents:
17152
diff
changeset
|
1918 @item linewidth |
|
8056
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
1919 @itemx linestyle |
|
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
1920 The line width and style of the edge of the patch objects making up the |
|
9040
dbd0c77e575e
Cleanup documentation file plot.texi
Rik <rdrider0-list@yahoo.com>
parents:
9032
diff
changeset
|
1921 areas. @xref{Line Styles}. |
|
8056
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
1922 |
|
17170
d6499c14021c
doc: Periodic grammarcheck of documentation.
Rik <rik@octave.org>
parents:
17152
diff
changeset
|
1923 @item edgecolor |
|
8056
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
1924 @itemx facecolor |
|
17469
710b3d5fe966
improve interpreter tex Tables
Michael Godfrey <michaeldgodfrey@gmail.com>
parents:
17281
diff
changeset
|
1925 The line and fill color of the patch objects making up the areas. |
|
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
1926 @xref{Colors}. |
|
8056
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
1927 |
|
17170
d6499c14021c
doc: Periodic grammarcheck of documentation.
Rik <rik@octave.org>
parents:
17152
diff
changeset
|
1928 @item xdata |
|
8056
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
1929 @itemx ydata |
|
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
1930 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
|
1931 @code{area} prior to the cumulative summation used in the @code{area} |
|
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
1932 function. |
|
8070
3b53b25e2550
Add data sources and line series
David Bateman <dbateman@free.fr>
parents:
8057
diff
changeset
|
1933 |
|
17170
d6499c14021c
doc: Periodic grammarcheck of documentation.
Rik <rik@octave.org>
parents:
17152
diff
changeset
|
1934 @item xdatasource |
|
8070
3b53b25e2550
Add data sources and line series
David Bateman <dbateman@free.fr>
parents:
8057
diff
changeset
|
1935 @itemx ydatasource |
|
3b53b25e2550
Add data sources and line series
David Bateman <dbateman@free.fr>
parents:
8057
diff
changeset
|
1936 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
|
1937 @end table |
|
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
1938 |
|
11257
8d4c57258523
fix some menu problems in the manual
John W. Eaton <jwe@octave.org>
parents:
11255
diff
changeset
|
1939 @node Bar Series |
|
8d4c57258523
fix some menu problems in the manual
John W. Eaton <jwe@octave.org>
parents:
11255
diff
changeset
|
1940 @subsubsection Bar Series |
| 8071 | 1941 @cindex series objects |
| 1942 @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
|
1943 |
|
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
1944 Bar series objects are created by the @code{bar} or @code{barh} |
|
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
1945 functions. Each @code{hggroup} element contains a single patch object. |
|
8056
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
1946 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
|
1947 |
|
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
1948 @table @code |
|
17170
d6499c14021c
doc: Periodic grammarcheck of documentation.
Rik <rik@octave.org>
parents:
17152
diff
changeset
|
1949 @item showbaseline |
|
8056
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
1950 @itemx baseline |
|
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
1951 @itemx basevalue |
|
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
1952 The property @code{showbaseline} flags whether the baseline of the bar |
|
17281
bc924baa2c4e
doc: Add new @qcode macro for code samples which are quoted.
Rik <rik@octave.org>
parents:
17170
diff
changeset
|
1953 series is displayed (default is @qcode{"on"}). The handle of the graphics |
|
bc924baa2c4e
doc: Add new @qcode macro for code samples which are quoted.
Rik <rik@octave.org>
parents:
17170
diff
changeset
|
1954 object representing the baseline is given by the @code{baseline} property and |
|
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
1955 the y-value of the baseline by the @code{basevalue} property. |
|
8056
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
1956 |
|
18398
200851c87444
Edits to Manual and indicies
Michael Godfrey <michaeldgodfrey@gmail.com>
parents:
17957
diff
changeset
|
1957 Changes to any of these properties are propagated to the other members of |
|
200851c87444
Edits to Manual and indicies
Michael Godfrey <michaeldgodfrey@gmail.com>
parents:
17957
diff
changeset
|
1958 the bar series and to the baseline itself. Equally, changes in the |
|
8056
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
1959 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
|
1960 corresponding bar series. |
|
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
1961 |
|
17170
d6499c14021c
doc: Periodic grammarcheck of documentation.
Rik <rik@octave.org>
parents:
17152
diff
changeset
|
1962 @item barwidth |
|
8056
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
1963 @itemx barlayout |
|
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
1964 @itemx horizontal |
|
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
1965 The property @code{barwidth} is the width of the bar corresponding to |
|
9040
dbd0c77e575e
Cleanup documentation file plot.texi
Rik <rdrider0-list@yahoo.com>
parents:
9032
diff
changeset
|
1966 the @var{width} variable passed to @code{bar} or @var{barh}. Whether the |
|
17281
bc924baa2c4e
doc: Add new @qcode macro for code samples which are quoted.
Rik <rik@octave.org>
parents:
17170
diff
changeset
|
1967 bar series is @qcode{"grouped"} or @qcode{"stacked"} is determined by the |
|
8056
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
1968 @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
|
1969 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
|
1970 |
|
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
1971 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
|
1972 the bar series. |
|
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
1973 |
|
17170
d6499c14021c
doc: Periodic grammarcheck of documentation.
Rik <rik@octave.org>
parents:
17152
diff
changeset
|
1974 @item linewidth |
|
8056
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
1975 @itemx linestyle |
|
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
1976 The line width and style of the edge of the patch objects making up the |
|
9040
dbd0c77e575e
Cleanup documentation file plot.texi
Rik <rdrider0-list@yahoo.com>
parents:
9032
diff
changeset
|
1977 bars. @xref{Line Styles}. |
|
8056
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
1978 |
|
17170
d6499c14021c
doc: Periodic grammarcheck of documentation.
Rik <rik@octave.org>
parents:
17152
diff
changeset
|
1979 @item edgecolor |
|
8056
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
1980 @itemx facecolor |
|
9040
dbd0c77e575e
Cleanup documentation file plot.texi
Rik <rdrider0-list@yahoo.com>
parents:
9032
diff
changeset
|
1981 The line and fill color of the patch objects making up the bars. @xref{Colors}. |
|
8056
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
1982 |
|
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
1983 @item xdata |
|
9040
dbd0c77e575e
Cleanup documentation file plot.texi
Rik <rdrider0-list@yahoo.com>
parents:
9032
diff
changeset
|
1984 The nominal x positions of the bars. Changes in this property and |
|
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
1985 propagated to the other members of the bar series. |
|
8056
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
1986 |
|
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
1987 @item ydata |
|
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
1988 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
|
1989 |
|
17170
d6499c14021c
doc: Periodic grammarcheck of documentation.
Rik <rik@octave.org>
parents:
17152
diff
changeset
|
1990 @item xdatasource |
|
8070
3b53b25e2550
Add data sources and line series
David Bateman <dbateman@free.fr>
parents:
8057
diff
changeset
|
1991 @itemx ydatasource |
|
3b53b25e2550
Add data sources and line series
David Bateman <dbateman@free.fr>
parents:
8057
diff
changeset
|
1992 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
|
1993 @end table |
|
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
1994 |
|
11257
8d4c57258523
fix some menu problems in the manual
John W. Eaton <jwe@octave.org>
parents:
11255
diff
changeset
|
1995 @node Contour Groups |
|
8d4c57258523
fix some menu problems in the manual
John W. Eaton <jwe@octave.org>
parents:
11255
diff
changeset
|
1996 @subsubsection Contour Groups |
| 8071 | 1997 @cindex series objects |
| 1998 @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
|
1999 |
|
8289
ac7f334d9652
Add contour group objects and the clabel function
David Bateman <dbateman@free.fr>
parents:
8286
diff
changeset
|
2000 Contour group objects are created by the @code{contour}, @code{contourf} |
|
9040
dbd0c77e575e
Cleanup documentation file plot.texi
Rik <rdrider0-list@yahoo.com>
parents:
9032
diff
changeset
|
2001 and @code{contour3} functions. The are equally one of the handles returned |
|
dbd0c77e575e
Cleanup documentation file plot.texi
Rik <rdrider0-list@yahoo.com>
parents:
9032
diff
changeset
|
2002 by the @code{surfc} and @code{meshc} functions. The properties of the contour |
|
8289
ac7f334d9652
Add contour group objects and the clabel function
David Bateman <dbateman@free.fr>
parents:
8286
diff
changeset
|
2003 group are |
|
ac7f334d9652
Add contour group objects and the clabel function
David Bateman <dbateman@free.fr>
parents:
8286
diff
changeset
|
2004 |
|
ac7f334d9652
Add contour group objects and the clabel function
David Bateman <dbateman@free.fr>
parents:
8286
diff
changeset
|
2005 @table @code |
|
ac7f334d9652
Add contour group objects and the clabel function
David Bateman <dbateman@free.fr>
parents:
8286
diff
changeset
|
2006 @item contourmatrix |
|
ac7f334d9652
Add contour group objects and the clabel function
David Bateman <dbateman@free.fr>
parents:
8286
diff
changeset
|
2007 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
|
2008 create the contours of the plot. |
|
ac7f334d9652
Add contour group objects and the clabel function
David Bateman <dbateman@free.fr>
parents:
8286
diff
changeset
|
2009 |
|
ac7f334d9652
Add contour group objects and the clabel function
David Bateman <dbateman@free.fr>
parents:
8286
diff
changeset
|
2010 @item fill |
|
17281
bc924baa2c4e
doc: Add new @qcode macro for code samples which are quoted.
Rik <rik@octave.org>
parents:
17170
diff
changeset
|
2011 A radio property that can have the values @qcode{"on"} or @qcode{"off"} that |
|
bc924baa2c4e
doc: Add new @qcode macro for code samples which are quoted.
Rik <rik@octave.org>
parents:
17170
diff
changeset
|
2012 flags whether the contours to plot are to be filled. |
|
8289
ac7f334d9652
Add contour group objects and the clabel function
David Bateman <dbateman@free.fr>
parents:
8286
diff
changeset
|
2013 |
|
17170
d6499c14021c
doc: Periodic grammarcheck of documentation.
Rik <rik@octave.org>
parents:
17152
diff
changeset
|
2014 @item zlevelmode |
|
8289
ac7f334d9652
Add contour group objects and the clabel function
David Bateman <dbateman@free.fr>
parents:
8286
diff
changeset
|
2015 @itemx zlevel |
|
17281
bc924baa2c4e
doc: Add new @qcode macro for code samples which are quoted.
Rik <rik@octave.org>
parents:
17170
diff
changeset
|
2016 The radio property @code{zlevelmode} can have the values @qcode{"none"}, |
|
bc924baa2c4e
doc: Add new @qcode macro for code samples which are quoted.
Rik <rik@octave.org>
parents:
17170
diff
changeset
|
2017 @qcode{"auto"}, or @qcode{"manual"}. When its value is @qcode{"none"} there is |
|
bc924baa2c4e
doc: Add new @qcode macro for code samples which are quoted.
Rik <rik@octave.org>
parents:
17170
diff
changeset
|
2018 no z component to the plotted contours. When its value is @qcode{"auto"} the z |
|
bc924baa2c4e
doc: Add new @qcode macro for code samples which are quoted.
Rik <rik@octave.org>
parents:
17170
diff
changeset
|
2019 value of the plotted contours is at the same value as the contour itself. If |
|
bc924baa2c4e
doc: Add new @qcode macro for code samples which are quoted.
Rik <rik@octave.org>
parents:
17170
diff
changeset
|
2020 the value is @qcode{"manual"}, then the z value at which to plot the contour is |
|
bc924baa2c4e
doc: Add new @qcode macro for code samples which are quoted.
Rik <rik@octave.org>
parents:
17170
diff
changeset
|
2021 determined by the @code{zlevel} property. |
|
8289
ac7f334d9652
Add contour group objects and the clabel function
David Bateman <dbateman@free.fr>
parents:
8286
diff
changeset
|
2022 |
|
17170
d6499c14021c
doc: Periodic grammarcheck of documentation.
Rik <rik@octave.org>
parents:
17152
diff
changeset
|
2023 @item levellistmode |
|
8289
ac7f334d9652
Add contour group objects and the clabel function
David Bateman <dbateman@free.fr>
parents:
8286
diff
changeset
|
2024 @itemx levellist |
|
ac7f334d9652
Add contour group objects and the clabel function
David Bateman <dbateman@free.fr>
parents:
8286
diff
changeset
|
2025 @itemx levelstepmode |
|
ac7f334d9652
Add contour group objects and the clabel function
David Bateman <dbateman@free.fr>
parents:
8286
diff
changeset
|
2026 @itemx levelstep |
|
17281
bc924baa2c4e
doc: Add new @qcode macro for code samples which are quoted.
Rik <rik@octave.org>
parents:
17170
diff
changeset
|
2027 If @code{levellistmode} is @qcode{"manual"}, then the levels at which to plot |
|
bc924baa2c4e
doc: Add new @qcode macro for code samples which are quoted.
Rik <rik@octave.org>
parents:
17170
diff
changeset
|
2028 the contours is determined by @code{levellist}. If @code{levellistmode} is set |
|
bc924baa2c4e
doc: Add new @qcode macro for code samples which are quoted.
Rik <rik@octave.org>
parents:
17170
diff
changeset
|
2029 to @qcode{"auto"}, then the distance between contours is determined by |
|
bc924baa2c4e
doc: Add new @qcode macro for code samples which are quoted.
Rik <rik@octave.org>
parents:
17170
diff
changeset
|
2030 @code{levelstep}. If both @code{levellistmode} and @code{levelstepmode} are |
|
bc924baa2c4e
doc: Add new @qcode macro for code samples which are quoted.
Rik <rik@octave.org>
parents:
17170
diff
changeset
|
2031 set to @qcode{"auto"}, then there are assumed to be 10 equal spaced contours. |
|
8289
ac7f334d9652
Add contour group objects and the clabel function
David Bateman <dbateman@free.fr>
parents:
8286
diff
changeset
|
2032 |
|
17170
d6499c14021c
doc: Periodic grammarcheck of documentation.
Rik <rik@octave.org>
parents:
17152
diff
changeset
|
2033 @item textlistmode |
|
8289
ac7f334d9652
Add contour group objects and the clabel function
David Bateman <dbateman@free.fr>
parents:
8286
diff
changeset
|
2034 @itemx textlist |
|
ac7f334d9652
Add contour group objects and the clabel function
David Bateman <dbateman@free.fr>
parents:
8286
diff
changeset
|
2035 @itemx textstepmode |
|
ac7f334d9652
Add contour group objects and the clabel function
David Bateman <dbateman@free.fr>
parents:
8286
diff
changeset
|
2036 @itemx textstep |
|
17281
bc924baa2c4e
doc: Add new @qcode macro for code samples which are quoted.
Rik <rik@octave.org>
parents:
17170
diff
changeset
|
2037 If @code{textlistmode} is @qcode{"manual"}, then the labeled contours |
|
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
2038 is determined by @code{textlist}. If @code{textlistmode} is set to |
|
17281
bc924baa2c4e
doc: Add new @qcode macro for code samples which are quoted.
Rik <rik@octave.org>
parents:
17170
diff
changeset
|
2039 @qcode{"auto"}, then the distance between labeled contours is determined by |
|
9040
dbd0c77e575e
Cleanup documentation file plot.texi
Rik <rdrider0-list@yahoo.com>
parents:
9032
diff
changeset
|
2040 @code{textstep}. If both @code{textlistmode} and @code{textstepmode} |
|
17281
bc924baa2c4e
doc: Add new @qcode macro for code samples which are quoted.
Rik <rik@octave.org>
parents:
17170
diff
changeset
|
2041 are set to @qcode{"auto"}, then there are assumed to be 10 equal spaced |
|
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
2042 labeled contours. |
|
8289
ac7f334d9652
Add contour group objects and the clabel function
David Bateman <dbateman@free.fr>
parents:
8286
diff
changeset
|
2043 |
|
ac7f334d9652
Add contour group objects and the clabel function
David Bateman <dbateman@free.fr>
parents:
8286
diff
changeset
|
2044 @item showtext |
|
ac7f334d9652
Add contour group objects and the clabel function
David Bateman <dbateman@free.fr>
parents:
8286
diff
changeset
|
2045 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
|
2046 |
|
ac7f334d9652
Add contour group objects and the clabel function
David Bateman <dbateman@free.fr>
parents:
8286
diff
changeset
|
2047 @item labelspacing |
|
ac7f334d9652
Add contour group objects and the clabel function
David Bateman <dbateman@free.fr>
parents:
8286
diff
changeset
|
2048 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
|
2049 |
|
ac7f334d9652
Add contour group objects and the clabel function
David Bateman <dbateman@free.fr>
parents:
8286
diff
changeset
|
2050 @item linewidth |
|
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
2051 |
|
8289
ac7f334d9652
Add contour group objects and the clabel function
David Bateman <dbateman@free.fr>
parents:
8286
diff
changeset
|
2052 @item linestyle |
|
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
2053 |
|
8289
ac7f334d9652
Add contour group objects and the clabel function
David Bateman <dbateman@free.fr>
parents:
8286
diff
changeset
|
2054 @item linecolor |
|
9040
dbd0c77e575e
Cleanup documentation file plot.texi
Rik <rdrider0-list@yahoo.com>
parents:
9032
diff
changeset
|
2055 The properties of the contour lines. The properties @code{linewidth} and |
|
dbd0c77e575e
Cleanup documentation file plot.texi
Rik <rdrider0-list@yahoo.com>
parents:
9032
diff
changeset
|
2056 @code{linestyle} are similar to the corresponding properties for lines. The |
| 8297 | 2057 property @code{linecolor} is a color property (@pxref{Colors}), that can also |
|
17281
bc924baa2c4e
doc: Add new @qcode macro for code samples which are quoted.
Rik <rik@octave.org>
parents:
17170
diff
changeset
|
2058 have the values of @qcode{"none"} or @qcode{"auto"}. If @code{linecolor} is |
|
bc924baa2c4e
doc: Add new @qcode macro for code samples which are quoted.
Rik <rik@octave.org>
parents:
17170
diff
changeset
|
2059 @qcode{"none"}, then no contour line is drawn. If @code{linecolor} is |
|
bc924baa2c4e
doc: Add new @qcode macro for code samples which are quoted.
Rik <rik@octave.org>
parents:
17170
diff
changeset
|
2060 @qcode{"auto"} then the line color is determined by the colormap. |
|
8289
ac7f334d9652
Add contour group objects and the clabel function
David Bateman <dbateman@free.fr>
parents:
8286
diff
changeset
|
2061 |
|
17170
d6499c14021c
doc: Periodic grammarcheck of documentation.
Rik <rik@octave.org>
parents:
17152
diff
changeset
|
2062 @item xdata |
|
8289
ac7f334d9652
Add contour group objects and the clabel function
David Bateman <dbateman@free.fr>
parents:
8286
diff
changeset
|
2063 @itemx ydata |
|
ac7f334d9652
Add contour group objects and the clabel function
David Bateman <dbateman@free.fr>
parents:
8286
diff
changeset
|
2064 @itemx zdata |
|
ac7f334d9652
Add contour group objects and the clabel function
David Bateman <dbateman@free.fr>
parents:
8286
diff
changeset
|
2065 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
|
2066 |
|
17170
d6499c14021c
doc: Periodic grammarcheck of documentation.
Rik <rik@octave.org>
parents:
17152
diff
changeset
|
2067 @item xdatasource |
|
8289
ac7f334d9652
Add contour group objects and the clabel function
David Bateman <dbateman@free.fr>
parents:
8286
diff
changeset
|
2068 @itemx ydatasource |
|
ac7f334d9652
Add contour group objects and the clabel function
David Bateman <dbateman@free.fr>
parents:
8286
diff
changeset
|
2069 @itemx zdatasource |
|
ac7f334d9652
Add contour group objects and the clabel function
David Bateman <dbateman@free.fr>
parents:
8286
diff
changeset
|
2070 Data source variables. |
|
ac7f334d9652
Add contour group objects and the clabel function
David Bateman <dbateman@free.fr>
parents:
8286
diff
changeset
|
2071 @end table |
|
8056
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
2072 |
|
11257
8d4c57258523
fix some menu problems in the manual
John W. Eaton <jwe@octave.org>
parents:
11255
diff
changeset
|
2073 @node Error Bar Series |
|
8d4c57258523
fix some menu problems in the manual
John W. Eaton <jwe@octave.org>
parents:
11255
diff
changeset
|
2074 @subsubsection Error Bar Series |
| 8071 | 2075 @cindex series objects |
| 2076 @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
|
2077 |
|
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
2078 Error bar series are created by the @code{errorbar} function. Each |
|
9040
dbd0c77e575e
Cleanup documentation file plot.texi
Rik <rdrider0-list@yahoo.com>
parents:
9032
diff
changeset
|
2079 @code{hggroup} element contains two line objects representing the data and |
|
dbd0c77e575e
Cleanup documentation file plot.texi
Rik <rdrider0-list@yahoo.com>
parents:
9032
diff
changeset
|
2080 the errorbars separately. The properties of the error bar series are |
| 8258 | 2081 |
| 2082 @table @code | |
| 2083 @item color | |
|
17469
710b3d5fe966
improve interpreter tex Tables
Michael Godfrey <michaeldgodfrey@gmail.com>
parents:
17281
diff
changeset
|
2084 The RGB color or color name of the line objects of the error bars. |
|
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
2085 @xref{Colors}. |
| 8258 | 2086 |
|
17170
d6499c14021c
doc: Periodic grammarcheck of documentation.
Rik <rik@octave.org>
parents:
17152
diff
changeset
|
2087 @item linewidth |
| 8258 | 2088 @itemx linestyle |
|
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
2089 The line width and style of the line objects of the error bars. @xref{Line |
|
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
2090 Styles}. |
| 8258 | 2091 |
|
17170
d6499c14021c
doc: Periodic grammarcheck of documentation.
Rik <rik@octave.org>
parents:
17152
diff
changeset
|
2092 @item marker |
| 8258 | 2093 @itemx markeredgecolor |
| 2094 @itemx markerfacecolor | |
| 2095 @itemx markersize | |
|
9040
dbd0c77e575e
Cleanup documentation file plot.texi
Rik <rdrider0-list@yahoo.com>
parents:
9032
diff
changeset
|
2096 The line and fill color of the markers on the error bars. @xref{Colors}. |
| 8258 | 2097 |
|
17170
d6499c14021c
doc: Periodic grammarcheck of documentation.
Rik <rik@octave.org>
parents:
17152
diff
changeset
|
2098 @item xdata |
| 8258 | 2099 @itemx ydata |
| 2100 @itemx ldata | |
| 2101 @itemx udata | |
| 2102 @itemx xldata | |
| 2103 @itemx xudata | |
| 2104 The original x, y, l, u, xl, xu data of the error bars. | |
| 2105 | |
|
17170
d6499c14021c
doc: Periodic grammarcheck of documentation.
Rik <rik@octave.org>
parents:
17152
diff
changeset
|
2106 @item xdatasource |
| 8258 | 2107 @itemx ydatasource |
| 2108 @itemx ldatasource | |
| 2109 @itemx udatasource | |
| 2110 @itemx xldatasource | |
| 2111 @itemx xudatasource | |
| 2112 Data source variables. | |
| 2113 @end table | |
| 2114 | |
|
11257
8d4c57258523
fix some menu problems in the manual
John W. Eaton <jwe@octave.org>
parents:
11255
diff
changeset
|
2115 @node Line Series |
|
8d4c57258523
fix some menu problems in the manual
John W. Eaton <jwe@octave.org>
parents:
11255
diff
changeset
|
2116 @subsubsection Line Series |
| 8071 | 2117 @cindex series objects |
| 2118 @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
|
2119 |
| 8257 | 2120 Line series objects are created by the @code{plot} and @code{plot3} |
|
9040
dbd0c77e575e
Cleanup documentation file plot.texi
Rik <rdrider0-list@yahoo.com>
parents:
9032
diff
changeset
|
2121 functions and are of the type @code{line}. The properties of the |
| 8257 | 2122 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
|
2123 |
|
3b53b25e2550
Add data sources and line series
David Bateman <dbateman@free.fr>
parents:
8057
diff
changeset
|
2124 @table @code |
|
3b53b25e2550
Add data sources and line series
David Bateman <dbateman@free.fr>
parents:
8057
diff
changeset
|
2125 @item color |
|
9040
dbd0c77e575e
Cleanup documentation file plot.texi
Rik <rdrider0-list@yahoo.com>
parents:
9032
diff
changeset
|
2126 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
|
2127 |
|
17170
d6499c14021c
doc: Periodic grammarcheck of documentation.
Rik <rik@octave.org>
parents:
17152
diff
changeset
|
2128 @item linewidth |
|
8070
3b53b25e2550
Add data sources and line series
David Bateman <dbateman@free.fr>
parents:
8057
diff
changeset
|
2129 @itemx linestyle |
|
9040
dbd0c77e575e
Cleanup documentation file plot.texi
Rik <rdrider0-list@yahoo.com>
parents:
9032
diff
changeset
|
2130 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
|
2131 |
|
17170
d6499c14021c
doc: Periodic grammarcheck of documentation.
Rik <rik@octave.org>
parents:
17152
diff
changeset
|
2132 @item marker |
|
8070
3b53b25e2550
Add data sources and line series
David Bateman <dbateman@free.fr>
parents:
8057
diff
changeset
|
2133 @itemx markeredgecolor |
|
3b53b25e2550
Add data sources and line series
David Bateman <dbateman@free.fr>
parents:
8057
diff
changeset
|
2134 @itemx markerfacecolor |
|
3b53b25e2550
Add data sources and line series
David Bateman <dbateman@free.fr>
parents:
8057
diff
changeset
|
2135 @itemx markersize |
|
9040
dbd0c77e575e
Cleanup documentation file plot.texi
Rik <rdrider0-list@yahoo.com>
parents:
9032
diff
changeset
|
2136 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
|
2137 |
|
17170
d6499c14021c
doc: Periodic grammarcheck of documentation.
Rik <rik@octave.org>
parents:
17152
diff
changeset
|
2138 @item xdata |
|
8070
3b53b25e2550
Add data sources and line series
David Bateman <dbateman@free.fr>
parents:
8057
diff
changeset
|
2139 @itemx ydata |
|
3b53b25e2550
Add data sources and line series
David Bateman <dbateman@free.fr>
parents:
8057
diff
changeset
|
2140 @itemx zdata |
| 8257 | 2141 The original x, y and z data. |
|
8070
3b53b25e2550
Add data sources and line series
David Bateman <dbateman@free.fr>
parents:
8057
diff
changeset
|
2142 |
|
17170
d6499c14021c
doc: Periodic grammarcheck of documentation.
Rik <rik@octave.org>
parents:
17152
diff
changeset
|
2143 @item xdatasource |
|
8070
3b53b25e2550
Add data sources and line series
David Bateman <dbateman@free.fr>
parents:
8057
diff
changeset
|
2144 @itemx ydatasource |
|
3b53b25e2550
Add data sources and line series
David Bateman <dbateman@free.fr>
parents:
8057
diff
changeset
|
2145 @itemx zdatasource |
|
3b53b25e2550
Add data sources and line series
David Bateman <dbateman@free.fr>
parents:
8057
diff
changeset
|
2146 Data source variables. |
|
3b53b25e2550
Add data sources and line series
David Bateman <dbateman@free.fr>
parents:
8057
diff
changeset
|
2147 @end table |
|
8056
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
2148 |
|
11257
8d4c57258523
fix some menu problems in the manual
John W. Eaton <jwe@octave.org>
parents:
11255
diff
changeset
|
2149 @node Quiver Group |
|
8d4c57258523
fix some menu problems in the manual
John W. Eaton <jwe@octave.org>
parents:
11255
diff
changeset
|
2150 @subsubsection Quiver Group |
| 8071 | 2151 @cindex group objects |
| 2152 @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
|
2153 |
|
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
2154 Quiver series objects are created by the @code{quiver} or @code{quiver3} |
|
9040
dbd0c77e575e
Cleanup documentation file plot.texi
Rik <rdrider0-list@yahoo.com>
parents:
9032
diff
changeset
|
2155 functions. Each @code{hggroup} element of the series contains three line |
|
8056
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
2156 objects as children representing the body and head of the arrow, |
|
11365
4b4d5a4d7d0e
Fix typo in Quiver section of plot.txi
Rik <octave@nomad.inbox5.com>
parents:
11330
diff
changeset
|
2157 together with a marker as the point of origin of the arrows. The |
|
8056
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
2158 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
|
2159 |
|
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
2160 @table @code |
|
17170
d6499c14021c
doc: Periodic grammarcheck of documentation.
Rik <rik@octave.org>
parents:
17152
diff
changeset
|
2161 @item autoscale |
|
8056
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
2162 @itemx autoscalefactor |
|
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
2163 Flag whether the length of the arrows is scaled or defined directly from |
|
9040
dbd0c77e575e
Cleanup documentation file plot.texi
Rik <rdrider0-list@yahoo.com>
parents:
9032
diff
changeset
|
2164 the @var{u}, @var{v} and @var{w} data. If the arrow length is flagged |
|
8056
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
2165 as being scaled by the @code{autoscale} property, then the length of the |
|
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
2166 autoscaled arrow is controlled by the @code{autoscalefactor}. |
|
8056
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
2167 |
|
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
2168 @item maxheadsize |
|
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
2169 This property controls the size of the head of the arrows in the quiver |
|
9040
dbd0c77e575e
Cleanup documentation file plot.texi
Rik <rdrider0-list@yahoo.com>
parents:
9032
diff
changeset
|
2170 series. The default value is 0.2. |
|
8056
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
2171 |
|
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
2172 @item showarrowhead |
|
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
2173 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
|
2174 |
|
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
2175 @item color |
|
9040
dbd0c77e575e
Cleanup documentation file plot.texi
Rik <rdrider0-list@yahoo.com>
parents:
9032
diff
changeset
|
2176 The RGB color or color name of the line objects of the quiver. @xref{Colors}. |
|
8056
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
2177 |
|
17170
d6499c14021c
doc: Periodic grammarcheck of documentation.
Rik <rik@octave.org>
parents:
17152
diff
changeset
|
2178 @item linewidth |
|
8056
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
2179 @itemx linestyle |
|
9040
dbd0c77e575e
Cleanup documentation file plot.texi
Rik <rdrider0-list@yahoo.com>
parents:
9032
diff
changeset
|
2180 The line width and style of the line objects of the quiver. @xref{Line Styles}. |
|
8056
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
2181 |
|
17170
d6499c14021c
doc: Periodic grammarcheck of documentation.
Rik <rik@octave.org>
parents:
17152
diff
changeset
|
2182 @item marker |
|
8056
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
2183 @itemx markerfacecolor |
|
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
2184 @itemx markersize |
|
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
2185 The line and fill color of the marker objects at the original of the |
|
9040
dbd0c77e575e
Cleanup documentation file plot.texi
Rik <rdrider0-list@yahoo.com>
parents:
9032
diff
changeset
|
2186 arrows. @xref{Colors}. |
|
8056
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
2187 |
|
17170
d6499c14021c
doc: Periodic grammarcheck of documentation.
Rik <rik@octave.org>
parents:
17152
diff
changeset
|
2188 @item xdata |
|
8056
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
2189 @itemx ydata |
|
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
2190 @itemx zdata |
|
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
2191 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
|
2192 |
|
17170
d6499c14021c
doc: Periodic grammarcheck of documentation.
Rik <rik@octave.org>
parents:
17152
diff
changeset
|
2193 @item udata |
|
8056
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
2194 @itemx vdata |
|
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
2195 @itemx wdata |
|
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
2196 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
|
2197 |
|
17170
d6499c14021c
doc: Periodic grammarcheck of documentation.
Rik <rik@octave.org>
parents:
17152
diff
changeset
|
2198 @item xdatasource |
|
8070
3b53b25e2550
Add data sources and line series
David Bateman <dbateman@free.fr>
parents:
8057
diff
changeset
|
2199 @itemx ydatasource |
|
3b53b25e2550
Add data sources and line series
David Bateman <dbateman@free.fr>
parents:
8057
diff
changeset
|
2200 @itemx zdatasource |
|
3b53b25e2550
Add data sources and line series
David Bateman <dbateman@free.fr>
parents:
8057
diff
changeset
|
2201 @itemx udatasource |
|
3b53b25e2550
Add data sources and line series
David Bateman <dbateman@free.fr>
parents:
8057
diff
changeset
|
2202 @itemx vdatasource |
|
3b53b25e2550
Add data sources and line series
David Bateman <dbateman@free.fr>
parents:
8057
diff
changeset
|
2203 @itemx wdatasource |
|
3b53b25e2550
Add data sources and line series
David Bateman <dbateman@free.fr>
parents:
8057
diff
changeset
|
2204 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
|
2205 @end table |
|
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
2206 |
|
11257
8d4c57258523
fix some menu problems in the manual
John W. Eaton <jwe@octave.org>
parents:
11255
diff
changeset
|
2207 @node Scatter Group |
|
8d4c57258523
fix some menu problems in the manual
John W. Eaton <jwe@octave.org>
parents:
11255
diff
changeset
|
2208 @subsubsection Scatter Group |
| 8071 | 2209 @cindex group objects |
| 2210 @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
|
2211 |
| 8257 | 2212 Scatter series objects are created by the @code{scatter} or @code{scatter3} |
|
9040
dbd0c77e575e
Cleanup documentation file plot.texi
Rik <rdrider0-list@yahoo.com>
parents:
9032
diff
changeset
|
2213 functions. A single hggroup element contains as many children as there are |
| 8257 | 2214 points in the scatter plot, with each child representing one of the points. |
| 2215 The properties of the stem series are | |
| 2216 | |
| 2217 @table @code | |
| 2218 @item linewidth | |
|
9040
dbd0c77e575e
Cleanup documentation file plot.texi
Rik <rdrider0-list@yahoo.com>
parents:
9032
diff
changeset
|
2219 The line width of the line objects of the points. @xref{Line Styles}. |
| 8257 | 2220 |
|
17170
d6499c14021c
doc: Periodic grammarcheck of documentation.
Rik <rik@octave.org>
parents:
17152
diff
changeset
|
2221 @item marker |
| 8257 | 2222 @itemx markeredgecolor |
| 2223 @itemx markerfacecolor | |
|
9040
dbd0c77e575e
Cleanup documentation file plot.texi
Rik <rdrider0-list@yahoo.com>
parents:
9032
diff
changeset
|
2224 The line and fill color of the markers of the points. @xref{Colors}. |
| 8257 | 2225 |
|
17170
d6499c14021c
doc: Periodic grammarcheck of documentation.
Rik <rik@octave.org>
parents:
17152
diff
changeset
|
2226 @item xdata |
| 8257 | 2227 @itemx ydata |
| 2228 @itemx zdata | |
| 2229 The original x, y and z data of the stems. | |
| 2230 | |
| 2231 @item cdata | |
|
9040
dbd0c77e575e
Cleanup documentation file plot.texi
Rik <rdrider0-list@yahoo.com>
parents:
9032
diff
changeset
|
2232 The color data for the points of the plot. Each point can have a separate |
| 8257 | 2233 color, or a unique color can be specified. |
| 2234 | |
| 2235 @item sizedata | |
|
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
2236 The size data for the points of the plot. Each point can its own size or a |
| 8257 | 2237 unique size can be specified. |
| 2238 | |
|
17170
d6499c14021c
doc: Periodic grammarcheck of documentation.
Rik <rik@octave.org>
parents:
17152
diff
changeset
|
2239 @item xdatasource |
| 8257 | 2240 @itemx ydatasource |
| 2241 @itemx zdatasource | |
| 2242 @itemx cdatasource | |
| 2243 @itemx sizedatasource | |
| 2244 Data source variables. | |
| 2245 @end table | |
|
8056
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
2246 |
|
11257
8d4c57258523
fix some menu problems in the manual
John W. Eaton <jwe@octave.org>
parents:
11255
diff
changeset
|
2247 @node Stair Group |
|
8d4c57258523
fix some menu problems in the manual
John W. Eaton <jwe@octave.org>
parents:
11255
diff
changeset
|
2248 @subsubsection Stair Group |
| 8071 | 2249 @cindex group objects |
| 2250 @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
|
2251 |
|
9040
dbd0c77e575e
Cleanup documentation file plot.texi
Rik <rdrider0-list@yahoo.com>
parents:
9032
diff
changeset
|
2252 Stair series objects are created by the @code{stair} function. Each |
|
8056
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
2253 @code{hggroup} element of the series contains a single line object as a |
|
9040
dbd0c77e575e
Cleanup documentation file plot.texi
Rik <rdrider0-list@yahoo.com>
parents:
9032
diff
changeset
|
2254 child representing the stair. The properties of the stair series are |
|
8056
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
2255 |
|
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
2256 @table @code |
|
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
2257 @item color |
|
9040
dbd0c77e575e
Cleanup documentation file plot.texi
Rik <rdrider0-list@yahoo.com>
parents:
9032
diff
changeset
|
2258 The RGB color or color name of the line objects of the stairs. @xref{Colors}. |
|
8056
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
2259 |
|
17170
d6499c14021c
doc: Periodic grammarcheck of documentation.
Rik <rik@octave.org>
parents:
17152
diff
changeset
|
2260 @item linewidth |
|
8056
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
2261 @itemx linestyle |
|
9040
dbd0c77e575e
Cleanup documentation file plot.texi
Rik <rdrider0-list@yahoo.com>
parents:
9032
diff
changeset
|
2262 The line width and style of the line objects of the stairs. @xref{Line Styles}. |
|
8056
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
2263 |
|
17170
d6499c14021c
doc: Periodic grammarcheck of documentation.
Rik <rik@octave.org>
parents:
17152
diff
changeset
|
2264 @item marker |
|
8056
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
2265 @itemx markeredgecolor |
|
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
2266 @itemx markerfacecolor |
|
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
2267 @itemx markersize |
|
9040
dbd0c77e575e
Cleanup documentation file plot.texi
Rik <rdrider0-list@yahoo.com>
parents:
9032
diff
changeset
|
2268 The line and fill color of the markers on the stairs. @xref{Colors}. |
|
8056
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
2269 |
|
17170
d6499c14021c
doc: Periodic grammarcheck of documentation.
Rik <rik@octave.org>
parents:
17152
diff
changeset
|
2270 @item xdata |
|
8056
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
2271 @itemx ydata |
|
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
2272 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
|
2273 |
|
17170
d6499c14021c
doc: Periodic grammarcheck of documentation.
Rik <rik@octave.org>
parents:
17152
diff
changeset
|
2274 @item xdatasource |
|
8070
3b53b25e2550
Add data sources and line series
David Bateman <dbateman@free.fr>
parents:
8057
diff
changeset
|
2275 @itemx ydatasource |
|
3b53b25e2550
Add data sources and line series
David Bateman <dbateman@free.fr>
parents:
8057
diff
changeset
|
2276 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
|
2277 @end table |
|
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
2278 |
| 8073 | 2279 @node Stem Series |
| 2280 @subsubsection Stem Series | |
| 2281 @cindex series objects | |
| 2282 @cindex stem series | |
| 2283 | |
| 8257 | 2284 Stem series objects are created by the @code{stem} or @code{stem3} |
|
9040
dbd0c77e575e
Cleanup documentation file plot.texi
Rik <rdrider0-list@yahoo.com>
parents:
9032
diff
changeset
|
2285 functions. Each @code{hggroup} element contains a single line object |
|
dbd0c77e575e
Cleanup documentation file plot.texi
Rik <rdrider0-list@yahoo.com>
parents:
9032
diff
changeset
|
2286 as a child representing the stems. The properties of the stem series |
| 8257 | 2287 are |
| 2288 | |
| 2289 @table @code | |
|
17170
d6499c14021c
doc: Periodic grammarcheck of documentation.
Rik <rik@octave.org>
parents:
17152
diff
changeset
|
2290 @item showbaseline |
| 8257 | 2291 @itemx baseline |
| 2292 @itemx basevalue | |
| 2293 The property @code{showbaseline} flags whether the baseline of the | |
|
17281
bc924baa2c4e
doc: Add new @qcode macro for code samples which are quoted.
Rik <rik@octave.org>
parents:
17170
diff
changeset
|
2294 stem series is displayed (default is @qcode{"on"}). The handle of the graphics |
| 8257 | 2295 object representing the baseline is given by the @code{baseline} |
| 2296 property and the y-value (or z-value for @code{stem3}) of the baseline | |
| 2297 by the @code{basevalue} property. | |
| 2298 | |
| 2299 Changes to any of these property are propagated to the other members of | |
|
9040
dbd0c77e575e
Cleanup documentation file plot.texi
Rik <rdrider0-list@yahoo.com>
parents:
9032
diff
changeset
|
2300 the stem series and to the baseline itself. Equally changes in the |
| 8257 | 2301 properties of the base line itself are propagated to the members of the |
| 2302 corresponding stem series. | |
| 2303 | |
| 2304 @item color | |
|
9040
dbd0c77e575e
Cleanup documentation file plot.texi
Rik <rdrider0-list@yahoo.com>
parents:
9032
diff
changeset
|
2305 The RGB color or color name of the line objects of the stems. @xref{Colors}. |
| 8257 | 2306 |
|
17170
d6499c14021c
doc: Periodic grammarcheck of documentation.
Rik <rik@octave.org>
parents:
17152
diff
changeset
|
2307 @item linewidth |
| 8257 | 2308 @itemx linestyle |
|
9040
dbd0c77e575e
Cleanup documentation file plot.texi
Rik <rdrider0-list@yahoo.com>
parents:
9032
diff
changeset
|
2309 The line width and style of the line objects of the stems. @xref{Line Styles}. |
| 8257 | 2310 |
|
17170
d6499c14021c
doc: Periodic grammarcheck of documentation.
Rik <rik@octave.org>
parents:
17152
diff
changeset
|
2311 @item marker |
| 8257 | 2312 @itemx markeredgecolor |
| 2313 @itemx markerfacecolor | |
| 2314 @itemx markersize | |
|
9040
dbd0c77e575e
Cleanup documentation file plot.texi
Rik <rdrider0-list@yahoo.com>
parents:
9032
diff
changeset
|
2315 The line and fill color of the markers on the stems. @xref{Colors}. |
| 8257 | 2316 |
|
17170
d6499c14021c
doc: Periodic grammarcheck of documentation.
Rik <rik@octave.org>
parents:
17152
diff
changeset
|
2317 @item xdata |
| 8257 | 2318 @itemx ydata |
| 2319 @itemx zdata | |
| 2320 The original x, y and z data of the stems. | |
| 2321 | |
|
17170
d6499c14021c
doc: Periodic grammarcheck of documentation.
Rik <rik@octave.org>
parents:
17152
diff
changeset
|
2322 @item xdatasource |
| 8257 | 2323 @itemx ydatasource |
| 2324 @itemx zdatasource | |
| 2325 Data source variables. | |
| 2326 @end table | |
| 8073 | 2327 |
|
11257
8d4c57258523
fix some menu problems in the manual
John W. Eaton <jwe@octave.org>
parents:
11255
diff
changeset
|
2328 @node Surface Group |
|
8d4c57258523
fix some menu problems in the manual
John W. Eaton <jwe@octave.org>
parents:
11255
diff
changeset
|
2329 @subsubsection Surface Group |
| 8071 | 2330 @cindex group objects |
| 2331 @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
|
2332 |
| 8257 | 2333 Surface group objects are created by the @code{surf} or @code{mesh} |
| 2334 functions, but are equally one of the handles returned by the @code{surfc} | |
|
9040
dbd0c77e575e
Cleanup documentation file plot.texi
Rik <rdrider0-list@yahoo.com>
parents:
9032
diff
changeset
|
2335 or @code{meshc} functions. The surface group is of the type @code{surface}. |
| 8257 | 2336 |
| 2337 The properties of the surface group are | |
| 2338 | |
| 2339 @table @code | |
| 2340 @item edgecolor | |
|
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
2341 |
| 8257 | 2342 @item facecolor |
|
17469
710b3d5fe966
improve interpreter tex Tables
Michael Godfrey <michaeldgodfrey@gmail.com>
parents:
17281
diff
changeset
|
2343 The RGB color or color name of the edges or faces of the surface. |
|
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
2344 @xref{Colors}. |
| 8257 | 2345 |
|
17170
d6499c14021c
doc: Periodic grammarcheck of documentation.
Rik <rik@octave.org>
parents:
17152
diff
changeset
|
2346 @item linewidth |
| 8257 | 2347 @itemx linestyle |
|
9040
dbd0c77e575e
Cleanup documentation file plot.texi
Rik <rdrider0-list@yahoo.com>
parents:
9032
diff
changeset
|
2348 The line width and style of the lines on the surface. @xref{Line Styles}. |
| 8257 | 2349 |
|
17170
d6499c14021c
doc: Periodic grammarcheck of documentation.
Rik <rik@octave.org>
parents:
17152
diff
changeset
|
2350 @item marker |
| 8257 | 2351 @itemx markeredgecolor |
| 2352 @itemx markerfacecolor | |
| 2353 @itemx markersize | |
|
9040
dbd0c77e575e
Cleanup documentation file plot.texi
Rik <rdrider0-list@yahoo.com>
parents:
9032
diff
changeset
|
2354 The line and fill color of the markers on the surface. @xref{Colors}. |
| 8257 | 2355 |
|
17170
d6499c14021c
doc: Periodic grammarcheck of documentation.
Rik <rik@octave.org>
parents:
17152
diff
changeset
|
2356 @item xdata |
| 8257 | 2357 @itemx ydata |
| 2358 @itemx zdata | |
|
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
2359 @itemx cdata |
| 8257 | 2360 The original x, y, z and c data. |
| 2361 | |
|
17170
d6499c14021c
doc: Periodic grammarcheck of documentation.
Rik <rik@octave.org>
parents:
17152
diff
changeset
|
2362 @item xdatasource |
| 8257 | 2363 @itemx ydatasource |
| 2364 @itemx zdatasource | |
| 2365 @itemx cdatasource | |
| 2366 Data source variables. | |
| 2367 @end table | |
|
8056
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
2368 |
|
11576
8ac9687dbe9f
rename backend to graphics_toolkit
John W. Eaton <jwe@octave.org>
parents:
11573
diff
changeset
|
2369 @node Graphics Toolkits |
|
8ac9687dbe9f
rename backend to graphics_toolkit
John W. Eaton <jwe@octave.org>
parents:
11573
diff
changeset
|
2370 @subsection Graphics Toolkits |
|
8ac9687dbe9f
rename backend to graphics_toolkit
John W. Eaton <jwe@octave.org>
parents:
11573
diff
changeset
|
2371 @cindex graphics toolkits |
|
8ac9687dbe9f
rename backend to graphics_toolkit
John W. Eaton <jwe@octave.org>
parents:
11573
diff
changeset
|
2372 @cindex toolkits, graphics |
|
8ac9687dbe9f
rename backend to graphics_toolkit
John W. Eaton <jwe@octave.org>
parents:
11573
diff
changeset
|
2373 |
|
8ac9687dbe9f
rename backend to graphics_toolkit
John W. Eaton <jwe@octave.org>
parents:
11573
diff
changeset
|
2374 @DOCSTRING(graphics_toolkit) |
|
8ac9687dbe9f
rename backend to graphics_toolkit
John W. Eaton <jwe@octave.org>
parents:
11573
diff
changeset
|
2375 |
|
8ac9687dbe9f
rename backend to graphics_toolkit
John W. Eaton <jwe@octave.org>
parents:
11573
diff
changeset
|
2376 @DOCSTRING(available_graphics_toolkits) |
|
8056
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
2377 |
|
14134
84f38aeb9f0e
doc: Add register_graphics_toolkit() and loaded_graphics_toolkits() to documentation
Rik <octave@nomad.inbox5.com>
parents:
13947
diff
changeset
|
2378 @DOCSTRING(loaded_graphics_toolkits) |
|
84f38aeb9f0e
doc: Add register_graphics_toolkit() and loaded_graphics_toolkits() to documentation
Rik <octave@nomad.inbox5.com>
parents:
13947
diff
changeset
|
2379 |
|
84f38aeb9f0e
doc: Add register_graphics_toolkit() and loaded_graphics_toolkits() to documentation
Rik <octave@nomad.inbox5.com>
parents:
13947
diff
changeset
|
2380 @DOCSTRING(register_graphics_toolkit) |
|
84f38aeb9f0e
doc: Add register_graphics_toolkit() and loaded_graphics_toolkits() to documentation
Rik <octave@nomad.inbox5.com>
parents:
13947
diff
changeset
|
2381 |
|
8056
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
2382 @menu |
|
17152
f2a8592b8fbd
doc: Shorten some long subsection names in Manual.
Rik <rik@octave.org>
parents:
17123
diff
changeset
|
2383 * Customizing Toolkit Behavior:: |
|
8056
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
2384 @end menu |
|
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
2385 |
|
12226
8cc154f45e37
Rename fltk_mouse_wheel_zoom, fltk_gui_mode functions to remove fltk_ prefix.
Rik <octave@nomad.inbox5.com>
parents:
12215
diff
changeset
|
2386 @node Customizing Toolkit Behavior |
|
8cc154f45e37
Rename fltk_mouse_wheel_zoom, fltk_gui_mode functions to remove fltk_ prefix.
Rik <octave@nomad.inbox5.com>
parents:
12215
diff
changeset
|
2387 @subsubsection Customizing Toolkit Behavior |
|
8cc154f45e37
Rename fltk_mouse_wheel_zoom, fltk_gui_mode functions to remove fltk_ prefix.
Rik <octave@nomad.inbox5.com>
parents:
12215
diff
changeset
|
2388 @cindex toolkit customization |
|
8cc154f45e37
Rename fltk_mouse_wheel_zoom, fltk_gui_mode functions to remove fltk_ prefix.
Rik <octave@nomad.inbox5.com>
parents:
12215
diff
changeset
|
2389 |
|
8cc154f45e37
Rename fltk_mouse_wheel_zoom, fltk_gui_mode functions to remove fltk_ prefix.
Rik <octave@nomad.inbox5.com>
parents:
12215
diff
changeset
|
2390 The specific behavior of the backend toolkit may be modified using the |
|
8cc154f45e37
Rename fltk_mouse_wheel_zoom, fltk_gui_mode functions to remove fltk_ prefix.
Rik <octave@nomad.inbox5.com>
parents:
12215
diff
changeset
|
2391 following utility functions. Note: Not all functions apply to every |
|
8cc154f45e37
Rename fltk_mouse_wheel_zoom, fltk_gui_mode functions to remove fltk_ prefix.
Rik <octave@nomad.inbox5.com>
parents:
12215
diff
changeset
|
2392 graphics toolkit. |
| 3428 | 2393 |
| 2394 @DOCSTRING(gnuplot_binary) |