Mercurial > octave-nkf
annotate doc/interpreter/plot.txi @ 17122:eaab03308c0b
doc: Rewrite docstrings for most plot functions.
Emphasize clarity, use common "voice", and increase density of seealso links.
* doc/interpreter/plot.txi: Add @findex entries that were in xlim.m
* scripts/miscellaneous/getappdata.m scripts/miscellaneous/setappdata.m,
scripts/plot/allchild.m, scripts/plot/ancestor.m, scripts/plot/area.m,
scripts/plot/axes.m, scripts/plot/axis.m, scripts/plot/bar.m,
scripts/plot/barh.m, scripts/plot/box.m, scripts/plot/caxis.m,
scripts/plot/cla.m, scripts/plot/clabel.m, scripts/plot/clf.m,
scripts/plot/close.m, scripts/plot/closereq.m, scripts/plot/colorbar.m,
scripts/plot/comet.m, scripts/plot/comet3.m, scripts/plot/compass.m,
scripts/plot/contour.m, scripts/plot/contour3.m, scripts/plot/contourc.m,
scripts/plot/contourf.m, scripts/plot/copyobj.m, scripts/plot/cylinder.m,
scripts/plot/daspect.m, scripts/plot/diffuse.m, scripts/plot/ellipsoid.m,
scripts/plot/errorbar.m, scripts/plot/ezcontour.m, scripts/plot/ezcontourf.m,
scripts/plot/ezmesh.m, scripts/plot/ezmeshc.m, scripts/plot/ezplot.m,
scripts/plot/ezplot3.m, scripts/plot/ezpolar.m, scripts/plot/ezsurf.m,
scripts/plot/ezsurfc.m, scripts/plot/feather.m, scripts/plot/figure.m,
scripts/plot/fill.m, scripts/plot/findall.m, scripts/plot/findobj.m,
scripts/plot/fplot.m, scripts/plot/gca.m, scripts/plot/gcbf.m,
scripts/plot/gcbo.m, scripts/plot/gcf.m, scripts/plot/gco.m,
scripts/plot/ginput.m, scripts/plot/graphics_toolkit.m, scripts/plot/grid.m,
scripts/plot/gtext.m, scripts/plot/guidata.m, scripts/plot/guihandles.m,
scripts/plot/hdl2struct.m, scripts/plot/hggroup.m, scripts/plot/hidden.m,
scripts/plot/hist.m, scripts/plot/hold.m, scripts/plot/ishghandle.m,
scripts/plot/ishold.m, scripts/plot/isocolors.m, scripts/plot/isprop.m,
scripts/plot/legend.m, scripts/plot/line.m, scripts/plot/linkprop.m,
scripts/plot/loglog.m, scripts/plot/loglogerr.m, scripts/plot/mesh.m,
scripts/plot/meshc.m, scripts/plot/meshgrid.m, scripts/plot/meshz.m,
scripts/plot/newplot.m, scripts/plot/orient.m, scripts/plot/pareto.m,
scripts/plot/patch.m, scripts/plot/pcolor.m, scripts/plot/peaks.m,
scripts/plot/pie.m, scripts/plot/pie3.m, scripts/plot/plot.m,
scripts/plot/plot3.m, scripts/plot/plotmatrix.m, scripts/plot/plotyy.m,
scripts/plot/polar.m, scripts/plot/print.m, scripts/plot/quiver.m,
scripts/plot/quiver3.m, scripts/plot/rectangle.m, scripts/plot/refresh.m,
scripts/plot/refreshdata.m, scripts/plot/ribbon.m, scripts/plot/rose.m,
scripts/plot/saveas.m, scripts/plot/scatter.m, scripts/plot/scatter3.m,
scripts/plot/semilogx.m, scripts/plot/semilogxerr.m, scripts/plot/semilogy.m,
scripts/plot/semilogyerr.m, scripts/plot/shading.m, scripts/plot/shg.m,
scripts/plot/shrinkfaces.m, scripts/plot/slice.m, scripts/plot/specular.m,
scripts/plot/sphere.m, scripts/plot/stairs.m, scripts/plot/stem.m,
scripts/plot/stem3.m, scripts/plot/struct2hdl.m, scripts/plot/subplot.m,
scripts/plot/surf.m, scripts/plot/surface.m, scripts/plot/surfc.m,
scripts/plot/surfl.m, scripts/plot/tetramesh.m, scripts/plot/text.m,
scripts/plot/title.m, scripts/plot/trimesh.m, scripts/plot/triplot.m,
scripts/plot/trisurf.m, scripts/plot/view.m, scripts/plot/waitbar.m,
scripts/plot/waitforbuttonpress.m, scripts/plot/waterfall.m,
scripts/plot/whitebg.m, scripts/plot/xlabel.m, scripts/plot/xlim.m,
scripts/plot/ylabel.m, scripts/plot/ylim.m, scripts/plot/zlabel.m,
scripts/plot/zlim.m: Rewrite docstrings for most plot functions.
Emphasize clarity, use common "voice", and increase density of seealso links.
author | Rik <rik@octave.org> |
---|---|
date | Wed, 31 Jul 2013 13:53:30 -0700 |
parents | a033fd3669c0 |
children | bcada0a4f8a7 |
rev | line source |
---|---|
14138
72c96de7a403
maint: update copyright notices for 2012
John W. Eaton <jwe@octave.org>
parents:
14134
diff
changeset
|
1 @c Copyright (C) 1996-2012 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 | |
9676 | 25 * Introduction to Plotting:: |
26 * High-Level Plotting:: | |
27 * Graphics Data Structures:: | |
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 |
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
52 |
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
53 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
|
54 three-dimensional plots using high-level functions. |
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
55 |
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
56 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
|
57 and @ref{Advanced Plotting}. |
6888 | 58 |
59 @menu | |
9676 | 60 * Two-Dimensional Plots:: |
12526
f8ea3eabcb85
Add daspect, pbaspect functions to documentation.
Rik <octave@nomad.inbox5.com>
parents:
12525
diff
changeset
|
61 * Three-Dimensional Plots:: |
9676 | 62 * Plot Annotations:: |
63 * Multiple Plots on One Page:: | |
64 * Multiple Plot Windows:: | |
16096
9720ecf8d257
Fix additional warning associated with Texinfo 5.0 (bug #38392)
Rik <rik@octave.org>
parents:
16094
diff
changeset
|
65 * Manipulation of Plot Windows:: |
9720ecf8d257
Fix additional warning associated with Texinfo 5.0 (bug #38392)
Rik <rik@octave.org>
parents:
16094
diff
changeset
|
66 * Use of the @code{interpreter} Property:: |
11254
31f8534eb055
Add reference to new saveas function in printed manual.
Rik <octave@nomad.inbox5.com>
parents:
10846
diff
changeset
|
67 * Printing and Saving Plots:: |
31f8534eb055
Add reference to new saveas function in printed manual.
Rik <octave@nomad.inbox5.com>
parents:
10846
diff
changeset
|
68 * Interacting with Plots:: |
9676 | 69 * Test Plotting Functions:: |
3294 | 70 @end menu |
71 | |
6888 | 72 @node Two-Dimensional Plots |
73 @subsection Two-Dimensional Plots | |
74 | |
12526
f8ea3eabcb85
Add daspect, pbaspect functions to documentation.
Rik <octave@nomad.inbox5.com>
parents:
12525
diff
changeset
|
75 @menu |
f8ea3eabcb85
Add daspect, pbaspect functions to documentation.
Rik <octave@nomad.inbox5.com>
parents:
12525
diff
changeset
|
76 * Axis Configuration:: |
f8ea3eabcb85
Add daspect, pbaspect functions to documentation.
Rik <octave@nomad.inbox5.com>
parents:
12525
diff
changeset
|
77 * Two-dimensional Function Plotting:: |
12761
13bcd62824a7
doc: Add documentation for gmres, rectangle to manual
Rik <octave@nomad.inbox5.com>
parents:
12690
diff
changeset
|
78 * Two-dimensional Geometric Shapes:: |
12526
f8ea3eabcb85
Add daspect, pbaspect functions to documentation.
Rik <octave@nomad.inbox5.com>
parents:
12525
diff
changeset
|
79 @end menu |
f8ea3eabcb85
Add daspect, pbaspect functions to documentation.
Rik <octave@nomad.inbox5.com>
parents:
12525
diff
changeset
|
80 |
6888 | 81 The @code{plot} function allows you to create simple x-y plots with |
82 linear axes. For example, | |
3294 | 83 |
6888 | 84 @example |
85 @group | |
86 x = -10:0.1:10; | |
87 plot (x, sin (x)); | |
88 @end group | |
89 @end example | |
90 | |
91 @noindent | |
6899 | 92 displays a sine wave shown in @ref{fig:plot}. On most systems, this |
6888 | 93 command will open a separate plot window to display the graph. |
5134 | 94 |
6888 | 95 @float Figure,fig:plot |
9088
77e71f3da3d6
Fix documentation image printing under new development code
Rik <rdrider0-list@yahoo.com>
parents:
9040
diff
changeset
|
96 @center @image{plot,4in} |
6888 | 97 @caption{Simple Two-Dimensional Plot.} |
98 @end float | |
99 | |
5134 | 100 @DOCSTRING(plot) |
101 | |
8817
03b7f618ab3d
include docstrings for new functions in the manual
John W. Eaton <jwe@octave.org>
parents:
8519
diff
changeset
|
102 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
|
103 independent y axes. |
03b7f618ab3d
include docstrings for new functions in the manual
John W. Eaton <jwe@octave.org>
parents:
8519
diff
changeset
|
104 |
03b7f618ab3d
include docstrings for new functions in the manual
John W. Eaton <jwe@octave.org>
parents:
8519
diff
changeset
|
105 @DOCSTRING(plotyy) |
03b7f618ab3d
include docstrings for new functions in the manual
John W. Eaton <jwe@octave.org>
parents:
8519
diff
changeset
|
106 |
6888 | 107 The functions @code{semilogx}, @code{semilogy}, and @code{loglog} are |
108 similar to the @code{plot} function, but produce plots in which one or | |
109 both of the axes use log scales. | |
110 | |
111 @DOCSTRING(semilogx) | |
6502 | 112 |
6888 | 113 @DOCSTRING(semilogy) |
6502 | 114 |
6888 | 115 @DOCSTRING(loglog) |
116 | |
117 The functions @code{bar}, @code{barh}, @code{stairs}, and @code{stem} | |
118 are useful for displaying discrete data. For example, | |
5134 | 119 |
6888 | 120 @example |
121 @group | |
122 hist (randn (10000, 1), 30); | |
123 @end group | |
124 @end example | |
5134 | 125 |
6888 | 126 @noindent |
127 produces the histogram of 10,000 normally distributed random numbers | |
6899 | 128 shown in @ref{fig:hist}. |
5134 | 129 |
6888 | 130 @float Figure,fig:hist |
9088
77e71f3da3d6
Fix documentation image printing under new development code
Rik <rdrider0-list@yahoo.com>
parents:
9040
diff
changeset
|
131 @center @image{hist,4in} |
6888 | 132 @caption{Histogram.} |
133 @end float | |
5134 | 134 |
135 @DOCSTRING(bar) | |
136 | |
6877 | 137 @DOCSTRING(barh) |
138 | |
6888 | 139 @DOCSTRING(hist) |
140 | |
16008
6f567476e6f0
Add stemleaf and printd to the manual
Michael Godfrey <michaeldgodfrey@gmail.com>
parents:
14856
diff
changeset
|
141 @DOCSTRING(stemleaf) |
6f567476e6f0
Add stemleaf and printd to the manual
Michael Godfrey <michaeldgodfrey@gmail.com>
parents:
14856
diff
changeset
|
142 |
6f567476e6f0
Add stemleaf and printd to the manual
Michael Godfrey <michaeldgodfrey@gmail.com>
parents:
14856
diff
changeset
|
143 @DOCSTRING(printd) |
6f567476e6f0
Add stemleaf and printd to the manual
Michael Godfrey <michaeldgodfrey@gmail.com>
parents:
14856
diff
changeset
|
144 |
6888 | 145 @DOCSTRING(stairs) |
146 | |
147 @DOCSTRING(stem) | |
148 | |
8817
03b7f618ab3d
include docstrings for new functions in the manual
John W. Eaton <jwe@octave.org>
parents:
8519
diff
changeset
|
149 @DOCSTRING(stem3) |
03b7f618ab3d
include docstrings for new functions in the manual
John W. Eaton <jwe@octave.org>
parents:
8519
diff
changeset
|
150 |
03b7f618ab3d
include docstrings for new functions in the manual
John W. Eaton <jwe@octave.org>
parents:
8519
diff
changeset
|
151 @DOCSTRING(scatter) |
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(plotmatrix) |
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(pareto) |
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(rose) |
03b7f618ab3d
include docstrings for new functions in the manual
John W. Eaton <jwe@octave.org>
parents:
8519
diff
changeset
|
158 |
7981 | 159 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
|
160 produce two-dimensional contour plots from three-dimensional data. |
6888 | 161 |
5134 | 162 @DOCSTRING(contour) |
163 | |
7981 | 164 @DOCSTRING(contourf) |
165 | |
6502 | 166 @DOCSTRING(contourc) |
167 | |
8817
03b7f618ab3d
include docstrings for new functions in the manual
John W. Eaton <jwe@octave.org>
parents:
8519
diff
changeset
|
168 @DOCSTRING(contour3) |
03b7f618ab3d
include docstrings for new functions in the manual
John W. Eaton <jwe@octave.org>
parents:
8519
diff
changeset
|
169 |
6888 | 170 The @code{errorbar}, @code{semilogxerr}, @code{semilogyerr}, and |
8347
fa78cb8d8a5c
corrections for typos
Brian Gough<bjg@network-theory.co.uk>
parents:
8325
diff
changeset
|
171 @code{loglogerr} functions produce plots with error bar markers. For |
6888 | 172 example, |
6877 | 173 |
6888 | 174 @example |
9088
77e71f3da3d6
Fix documentation image printing under new development code
Rik <rdrider0-list@yahoo.com>
parents:
9040
diff
changeset
|
175 @group |
6888 | 176 x = 0:0.1:10; |
177 y = sin (x); | |
178 yp = 0.1 .* randn (size (x)); | |
179 ym = -0.1 .* randn (size (x)); | |
180 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
|
181 @end group |
6888 | 182 @end example |
5134 | 183 |
6888 | 184 @noindent |
6899 | 185 produces the figure shown in @ref{fig:errorbar}. |
6502 | 186 |
6888 | 187 @float Figure,fig:errorbar |
9088
77e71f3da3d6
Fix documentation image printing under new development code
Rik <rdrider0-list@yahoo.com>
parents:
9040
diff
changeset
|
188 @center @image{errorbar,4in} |
6888 | 189 @caption{Errorbar plot.} |
190 @end float | |
5134 | 191 |
192 @DOCSTRING(errorbar) | |
193 | |
194 @DOCSTRING(semilogxerr) | |
195 | |
196 @DOCSTRING(semilogyerr) | |
197 | |
6888 | 198 @DOCSTRING(loglogerr) |
199 | |
200 Finally, the @code{polar} function allows you to easily plot data in | |
7001 | 201 polar coordinates. However, the display coordinates remain rectangular |
6888 | 202 and linear. For example, |
203 | |
204 @example | |
205 polar (0:0.1:10*pi, 0:0.1:10*pi); | |
206 @end example | |
207 | |
208 @noindent | |
6899 | 209 produces the spiral plot shown in @ref{fig:polar}. |
6888 | 210 |
211 @float Figure,fig:polar | |
9088
77e71f3da3d6
Fix documentation image printing under new development code
Rik <rdrider0-list@yahoo.com>
parents:
9040
diff
changeset
|
212 @center @image{polar,4in} |
6888 | 213 @caption{Polar plot.} |
214 @end float | |
215 | |
216 @DOCSTRING(polar) | |
217 | |
7120 | 218 @DOCSTRING(pie) |
219 | |
11330 | 220 @DOCSTRING(pie3) |
221 | |
7120 | 222 @DOCSTRING(quiver) |
223 | |
8817
03b7f618ab3d
include docstrings for new functions in the manual
John W. Eaton <jwe@octave.org>
parents:
8519
diff
changeset
|
224 @DOCSTRING(quiver3) |
03b7f618ab3d
include docstrings for new functions in the manual
John W. Eaton <jwe@octave.org>
parents:
8519
diff
changeset
|
225 |
03b7f618ab3d
include docstrings for new functions in the manual
John W. Eaton <jwe@octave.org>
parents:
8519
diff
changeset
|
226 @DOCSTRING(compass) |
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(feather) |
03b7f618ab3d
include docstrings for new functions in the manual
John W. Eaton <jwe@octave.org>
parents:
8519
diff
changeset
|
229 |
7120 | 230 @DOCSTRING(pcolor) |
231 | |
7153 | 232 @DOCSTRING(area) |
233 | |
8817
03b7f618ab3d
include docstrings for new functions in the manual
John W. Eaton <jwe@octave.org>
parents:
8519
diff
changeset
|
234 @DOCSTRING(comet) |
03b7f618ab3d
include docstrings for new functions in the manual
John W. Eaton <jwe@octave.org>
parents:
8519
diff
changeset
|
235 |
11382 | 236 @DOCSTRING(comet3) |
237 | |
12526
f8ea3eabcb85
Add daspect, pbaspect functions to documentation.
Rik <octave@nomad.inbox5.com>
parents:
12525
diff
changeset
|
238 @node Axis Configuration |
f8ea3eabcb85
Add daspect, pbaspect functions to documentation.
Rik <octave@nomad.inbox5.com>
parents:
12525
diff
changeset
|
239 @subsubsection Axis Configuration |
f8ea3eabcb85
Add daspect, pbaspect functions to documentation.
Rik <octave@nomad.inbox5.com>
parents:
12525
diff
changeset
|
240 |
6888 | 241 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
|
242 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
|
243 appearance of tic marks. |
6888 | 244 |
245 @DOCSTRING(axis) | |
246 | |
7189 | 247 Similarly the axis limits of the colormap can be changed with the caxis |
248 function. | |
249 | |
250 @DOCSTRING(caxis) | |
251 | |
8817
03b7f618ab3d
include docstrings for new functions in the manual
John W. Eaton <jwe@octave.org>
parents:
8519
diff
changeset
|
252 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
|
253 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
|
254 |
17122
eaab03308c0b
doc: Rewrite docstrings for most plot functions.
Rik <rik@octave.org>
parents:
17099
diff
changeset
|
255 @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
|
256 @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
|
257 @anchor{XREFzlim} |
17122
eaab03308c0b
doc: Rewrite docstrings for most plot functions.
Rik <rik@octave.org>
parents:
17099
diff
changeset
|
258 @findex ylim |
eaab03308c0b
doc: Rewrite docstrings for most plot functions.
Rik <rik@octave.org>
parents:
17099
diff
changeset
|
259 @findex zlim |
8817
03b7f618ab3d
include docstrings for new functions in the manual
John W. Eaton <jwe@octave.org>
parents:
8519
diff
changeset
|
260 @DOCSTRING(xlim) |
03b7f618ab3d
include docstrings for new functions in the manual
John W. Eaton <jwe@octave.org>
parents:
8519
diff
changeset
|
261 |
7984
bbaa5d7d0143
Some documentation updates
David Bateman <dbateman@free.fr>
parents:
7981
diff
changeset
|
262 @node Two-dimensional Function Plotting |
bbaa5d7d0143
Some documentation updates
David Bateman <dbateman@free.fr>
parents:
7981
diff
changeset
|
263 @subsubsection Two-dimensional Function Plotting |
bbaa5d7d0143
Some documentation updates
David Bateman <dbateman@free.fr>
parents:
7981
diff
changeset
|
264 |
bbaa5d7d0143
Some documentation updates
David Bateman <dbateman@free.fr>
parents:
7981
diff
changeset
|
265 Octave can plot a function from a function handle inline function or |
bbaa5d7d0143
Some documentation updates
David Bateman <dbateman@free.fr>
parents:
7981
diff
changeset
|
266 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
|
267 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
|
268 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
|
269 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
|
270 example, |
bbaa5d7d0143
Some documentation updates
David Bateman <dbateman@free.fr>
parents:
7981
diff
changeset
|
271 |
bbaa5d7d0143
Some documentation updates
David Bateman <dbateman@free.fr>
parents:
7981
diff
changeset
|
272 @example |
bbaa5d7d0143
Some documentation updates
David Bateman <dbateman@free.fr>
parents:
7981
diff
changeset
|
273 @group |
bbaa5d7d0143
Some documentation updates
David Bateman <dbateman@free.fr>
parents:
7981
diff
changeset
|
274 fplot (@@sin, [-10, 10], 201); |
bbaa5d7d0143
Some documentation updates
David Bateman <dbateman@free.fr>
parents:
7981
diff
changeset
|
275 @end group |
bbaa5d7d0143
Some documentation updates
David Bateman <dbateman@free.fr>
parents:
7981
diff
changeset
|
276 @end example |
bbaa5d7d0143
Some documentation updates
David Bateman <dbateman@free.fr>
parents:
7981
diff
changeset
|
277 |
bbaa5d7d0143
Some documentation updates
David Bateman <dbateman@free.fr>
parents:
7981
diff
changeset
|
278 @noindent |
bbaa5d7d0143
Some documentation updates
David Bateman <dbateman@free.fr>
parents:
7981
diff
changeset
|
279 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
|
280 legend displaying the name of the plotted function. |
bbaa5d7d0143
Some documentation updates
David Bateman <dbateman@free.fr>
parents:
7981
diff
changeset
|
281 |
bbaa5d7d0143
Some documentation updates
David Bateman <dbateman@free.fr>
parents:
7981
diff
changeset
|
282 @DOCSTRING(fplot) |
bbaa5d7d0143
Some documentation updates
David Bateman <dbateman@free.fr>
parents:
7981
diff
changeset
|
283 |
bbaa5d7d0143
Some documentation updates
David Bateman <dbateman@free.fr>
parents:
7981
diff
changeset
|
284 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
|
285 function include @code{ezplot}, @code{ezcontour}, @code{ezcontourf} and |
8046 | 286 @code{ezpolar}. |
287 | |
288 @DOCSTRING(ezplot) | |
7984
bbaa5d7d0143
Some documentation updates
David Bateman <dbateman@free.fr>
parents:
7981
diff
changeset
|
289 |
bbaa5d7d0143
Some documentation updates
David Bateman <dbateman@free.fr>
parents:
7981
diff
changeset
|
290 @DOCSTRING(ezcontour) |
bbaa5d7d0143
Some documentation updates
David Bateman <dbateman@free.fr>
parents:
7981
diff
changeset
|
291 |
bbaa5d7d0143
Some documentation updates
David Bateman <dbateman@free.fr>
parents:
7981
diff
changeset
|
292 @DOCSTRING(ezcontourf) |
bbaa5d7d0143
Some documentation updates
David Bateman <dbateman@free.fr>
parents:
7981
diff
changeset
|
293 |
bbaa5d7d0143
Some documentation updates
David Bateman <dbateman@free.fr>
parents:
7981
diff
changeset
|
294 @DOCSTRING(ezpolar) |
bbaa5d7d0143
Some documentation updates
David Bateman <dbateman@free.fr>
parents:
7981
diff
changeset
|
295 |
12761
13bcd62824a7
doc: Add documentation for gmres, rectangle to manual
Rik <octave@nomad.inbox5.com>
parents:
12690
diff
changeset
|
296 @node Two-dimensional Geometric Shapes |
13bcd62824a7
doc: Add documentation for gmres, rectangle to manual
Rik <octave@nomad.inbox5.com>
parents:
12690
diff
changeset
|
297 @subsubsection Two-dimensional Geometric Shapes |
13bcd62824a7
doc: Add documentation for gmres, rectangle to manual
Rik <octave@nomad.inbox5.com>
parents:
12690
diff
changeset
|
298 |
13bcd62824a7
doc: Add documentation for gmres, rectangle to manual
Rik <octave@nomad.inbox5.com>
parents:
12690
diff
changeset
|
299 @DOCSTRING(rectangle) |
13bcd62824a7
doc: Add documentation for gmres, rectangle to manual
Rik <octave@nomad.inbox5.com>
parents:
12690
diff
changeset
|
300 |
12526
f8ea3eabcb85
Add daspect, pbaspect functions to documentation.
Rik <octave@nomad.inbox5.com>
parents:
12525
diff
changeset
|
301 @node Three-Dimensional Plots |
f8ea3eabcb85
Add daspect, pbaspect functions to documentation.
Rik <octave@nomad.inbox5.com>
parents:
12525
diff
changeset
|
302 @subsection Three-Dimensional Plots |
6888 | 303 |
304 The function @code{mesh} produces mesh surface plots. For example, | |
305 | |
306 @example | |
307 @group | |
308 tx = ty = linspace (-8, 8, 41)'; | |
309 [xx, yy] = meshgrid (tx, ty); | |
310 r = sqrt (xx .^ 2 + yy .^ 2) + eps; | |
311 tz = sin (r) ./ r; | |
312 mesh (tx, ty, tz); | |
313 @end group | |
314 @end example | |
315 | |
316 @noindent | |
6899 | 317 produces the familiar ``sombrero'' plot shown in @ref{fig:mesh}. Note |
6888 | 318 the use of the function @code{meshgrid} to create matrices of X and Y |
319 coordinates to use for plotting the Z data. The @code{ndgrid} function | |
320 is similar to @code{meshgrid}, but works for N-dimensional matrices. | |
321 | |
322 @float Figure,fig:mesh | |
9088
77e71f3da3d6
Fix documentation image printing under new development code
Rik <rdrider0-list@yahoo.com>
parents:
9040
diff
changeset
|
323 @center @image{mesh,4in} |
6888 | 324 @caption{Mesh plot.} |
325 @end float | |
5134 | 326 |
6888 | 327 The @code{meshc} function is similar to @code{mesh}, but also produces a |
328 plot of contours for the surface. | |
329 | |
330 The @code{plot3} function displays arbitrary three-dimensional data, | |
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
331 without requiring it to form a surface. For example, |
6888 | 332 |
333 @example | |
334 @group | |
335 t = 0:0.1:10*pi; | |
336 r = linspace (0, 1, numel (t)); | |
337 z = linspace (0, 1, numel (t)); | |
338 plot3 (r.*sin(t), r.*cos(t), z); | |
339 @end group | |
340 @end example | |
341 | |
342 @noindent | |
6899 | 343 displays the spiral in three dimensions shown in @ref{fig:plot3}. |
6888 | 344 |
345 @float Figure,fig:plot3 | |
9088
77e71f3da3d6
Fix documentation image printing under new development code
Rik <rdrider0-list@yahoo.com>
parents:
9040
diff
changeset
|
346 @center @image{plot3,4in} |
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
347 @caption{Three-dimensional spiral.} |
6888 | 348 @end float |
349 | |
350 Finally, the @code{view} function changes the viewpoint for | |
351 three-dimensional plots. | |
5134 | 352 |
353 @DOCSTRING(mesh) | |
354 | |
6788 | 355 @DOCSTRING(meshc) |
356 | |
8817
03b7f618ab3d
include docstrings for new functions in the manual
John W. Eaton <jwe@octave.org>
parents:
8519
diff
changeset
|
357 @DOCSTRING(meshz) |
03b7f618ab3d
include docstrings for new functions in the manual
John W. Eaton <jwe@octave.org>
parents:
8519
diff
changeset
|
358 |
7153 | 359 @DOCSTRING(hidden) |
360 | |
7120 | 361 @DOCSTRING(surf) |
362 | |
363 @DOCSTRING(surfc) | |
364 | |
8817
03b7f618ab3d
include docstrings for new functions in the manual
John W. Eaton <jwe@octave.org>
parents:
8519
diff
changeset
|
365 @DOCSTRING(surfl) |
03b7f618ab3d
include docstrings for new functions in the manual
John W. Eaton <jwe@octave.org>
parents:
8519
diff
changeset
|
366 |
03b7f618ab3d
include docstrings for new functions in the manual
John W. Eaton <jwe@octave.org>
parents:
8519
diff
changeset
|
367 @DOCSTRING(surfnorm) |
03b7f618ab3d
include docstrings for new functions in the manual
John W. Eaton <jwe@octave.org>
parents:
8519
diff
changeset
|
368 |
12529
0579a13f29a1
Add isocolors, isonormals, isosurface functions to documentation.
Rik <octave@nomad.inbox5.com>
parents:
12526
diff
changeset
|
369 @DOCSTRING(isosurface) |
0579a13f29a1
Add isocolors, isonormals, isosurface functions to documentation.
Rik <octave@nomad.inbox5.com>
parents:
12526
diff
changeset
|
370 |
0579a13f29a1
Add isocolors, isonormals, isosurface functions to documentation.
Rik <octave@nomad.inbox5.com>
parents:
12526
diff
changeset
|
371 @DOCSTRING(isonormals) |
0579a13f29a1
Add isocolors, isonormals, isosurface functions to documentation.
Rik <octave@nomad.inbox5.com>
parents:
12526
diff
changeset
|
372 |
0579a13f29a1
Add isocolors, isonormals, isosurface functions to documentation.
Rik <octave@nomad.inbox5.com>
parents:
12526
diff
changeset
|
373 @DOCSTRING(isocolors) |
0579a13f29a1
Add isocolors, isonormals, isosurface functions to documentation.
Rik <octave@nomad.inbox5.com>
parents:
12526
diff
changeset
|
374 |
14574
9546bb28648c
New Function, shrinkfaces.m
Martin Helm <martin@mhelm.de>
parents:
14456
diff
changeset
|
375 @DOCSTRING(shrinkfaces) |
9546bb28648c
New Function, shrinkfaces.m
Martin Helm <martin@mhelm.de>
parents:
14456
diff
changeset
|
376 |
8817
03b7f618ab3d
include docstrings for new functions in the manual
John W. Eaton <jwe@octave.org>
parents:
8519
diff
changeset
|
377 @DOCSTRING(diffuse) |
03b7f618ab3d
include docstrings for new functions in the manual
John W. Eaton <jwe@octave.org>
parents:
8519
diff
changeset
|
378 |
03b7f618ab3d
include docstrings for new functions in the manual
John W. Eaton <jwe@octave.org>
parents:
8519
diff
changeset
|
379 @DOCSTRING(specular) |
03b7f618ab3d
include docstrings for new functions in the manual
John W. Eaton <jwe@octave.org>
parents:
8519
diff
changeset
|
380 |
5134 | 381 @DOCSTRING(meshgrid) |
382 | |
6550 | 383 @DOCSTRING(ndgrid) |
384 | |
6888 | 385 @DOCSTRING(plot3) |
386 | |
6502 | 387 @DOCSTRING(view) |
388 | |
8817
03b7f618ab3d
include docstrings for new functions in the manual
John W. Eaton <jwe@octave.org>
parents:
8519
diff
changeset
|
389 @DOCSTRING(slice) |
03b7f618ab3d
include docstrings for new functions in the manual
John W. Eaton <jwe@octave.org>
parents:
8519
diff
changeset
|
390 |
03b7f618ab3d
include docstrings for new functions in the manual
John W. Eaton <jwe@octave.org>
parents:
8519
diff
changeset
|
391 @DOCSTRING(ribbon) |
03b7f618ab3d
include docstrings for new functions in the manual
John W. Eaton <jwe@octave.org>
parents:
8519
diff
changeset
|
392 |
7120 | 393 @DOCSTRING(shading) |
394 | |
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
395 @DOCSTRING(scatter3) |
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
396 |
16563 | 397 @DOCSTRING(waterfall) |
398 | |
7989
23c248d415b5
Various doc fixes. Readd cellidx
David Bateman <dbateman@free.fr>
parents:
7984
diff
changeset
|
399 @menu |
12526
f8ea3eabcb85
Add daspect, pbaspect functions to documentation.
Rik <octave@nomad.inbox5.com>
parents:
12525
diff
changeset
|
400 * Aspect Ratio:: |
9676 | 401 * Three-dimensional Function Plotting:: |
402 * Three-dimensional Geometric Shapes:: | |
7989
23c248d415b5
Various doc fixes. Readd cellidx
David Bateman <dbateman@free.fr>
parents:
7984
diff
changeset
|
403 @end menu |
23c248d415b5
Various doc fixes. Readd cellidx
David Bateman <dbateman@free.fr>
parents:
7984
diff
changeset
|
404 |
12526
f8ea3eabcb85
Add daspect, pbaspect functions to documentation.
Rik <octave@nomad.inbox5.com>
parents:
12525
diff
changeset
|
405 @node Aspect Ratio |
f8ea3eabcb85
Add daspect, pbaspect functions to documentation.
Rik <octave@nomad.inbox5.com>
parents:
12525
diff
changeset
|
406 @subsubsection Aspect Ratio |
f8ea3eabcb85
Add daspect, pbaspect functions to documentation.
Rik <octave@nomad.inbox5.com>
parents:
12525
diff
changeset
|
407 |
f8ea3eabcb85
Add daspect, pbaspect functions to documentation.
Rik <octave@nomad.inbox5.com>
parents:
12525
diff
changeset
|
408 For three-dimensional plots the aspect ratio can be set for data with |
f8ea3eabcb85
Add daspect, pbaspect functions to documentation.
Rik <octave@nomad.inbox5.com>
parents:
12525
diff
changeset
|
409 @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
|
410 @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
|
411 plotting. |
f8ea3eabcb85
Add daspect, pbaspect functions to documentation.
Rik <octave@nomad.inbox5.com>
parents:
12525
diff
changeset
|
412 |
f8ea3eabcb85
Add daspect, pbaspect functions to documentation.
Rik <octave@nomad.inbox5.com>
parents:
12525
diff
changeset
|
413 @DOCSTRING(daspect) |
f8ea3eabcb85
Add daspect, pbaspect functions to documentation.
Rik <octave@nomad.inbox5.com>
parents:
12525
diff
changeset
|
414 |
f8ea3eabcb85
Add daspect, pbaspect functions to documentation.
Rik <octave@nomad.inbox5.com>
parents:
12525
diff
changeset
|
415 @DOCSTRING(pbaspect) |
f8ea3eabcb85
Add daspect, pbaspect functions to documentation.
Rik <octave@nomad.inbox5.com>
parents:
12525
diff
changeset
|
416 |
7989
23c248d415b5
Various doc fixes. Readd cellidx
David Bateman <dbateman@free.fr>
parents:
7984
diff
changeset
|
417 @node Three-dimensional Function Plotting |
23c248d415b5
Various doc fixes. Readd cellidx
David Bateman <dbateman@free.fr>
parents:
7984
diff
changeset
|
418 @subsubsection Three-dimensional Function Plotting |
7984
bbaa5d7d0143
Some documentation updates
David Bateman <dbateman@free.fr>
parents:
7981
diff
changeset
|
419 |
bbaa5d7d0143
Some documentation updates
David Bateman <dbateman@free.fr>
parents:
7981
diff
changeset
|
420 @DOCSTRING(ezplot3) |
bbaa5d7d0143
Some documentation updates
David Bateman <dbateman@free.fr>
parents:
7981
diff
changeset
|
421 |
bbaa5d7d0143
Some documentation updates
David Bateman <dbateman@free.fr>
parents:
7981
diff
changeset
|
422 @DOCSTRING(ezmesh) |
bbaa5d7d0143
Some documentation updates
David Bateman <dbateman@free.fr>
parents:
7981
diff
changeset
|
423 |
bbaa5d7d0143
Some documentation updates
David Bateman <dbateman@free.fr>
parents:
7981
diff
changeset
|
424 @DOCSTRING(ezmeshc) |
bbaa5d7d0143
Some documentation updates
David Bateman <dbateman@free.fr>
parents:
7981
diff
changeset
|
425 |
bbaa5d7d0143
Some documentation updates
David Bateman <dbateman@free.fr>
parents:
7981
diff
changeset
|
426 @DOCSTRING(ezsurf) |
bbaa5d7d0143
Some documentation updates
David Bateman <dbateman@free.fr>
parents:
7981
diff
changeset
|
427 |
bbaa5d7d0143
Some documentation updates
David Bateman <dbateman@free.fr>
parents:
7981
diff
changeset
|
428 @DOCSTRING(ezsurfc) |
bbaa5d7d0143
Some documentation updates
David Bateman <dbateman@free.fr>
parents:
7981
diff
changeset
|
429 |
8817
03b7f618ab3d
include docstrings for new functions in the manual
John W. Eaton <jwe@octave.org>
parents:
8519
diff
changeset
|
430 @node Three-dimensional Geometric Shapes |
03b7f618ab3d
include docstrings for new functions in the manual
John W. Eaton <jwe@octave.org>
parents:
8519
diff
changeset
|
431 @subsubsection Three-dimensional Geometric Shapes |
03b7f618ab3d
include docstrings for new functions in the manual
John W. Eaton <jwe@octave.org>
parents:
8519
diff
changeset
|
432 |
03b7f618ab3d
include docstrings for new functions in the manual
John W. Eaton <jwe@octave.org>
parents:
8519
diff
changeset
|
433 @DOCSTRING(cylinder) |
03b7f618ab3d
include docstrings for new functions in the manual
John W. Eaton <jwe@octave.org>
parents:
8519
diff
changeset
|
434 |
03b7f618ab3d
include docstrings for new functions in the manual
John W. Eaton <jwe@octave.org>
parents:
8519
diff
changeset
|
435 @DOCSTRING(sphere) |
03b7f618ab3d
include docstrings for new functions in the manual
John W. Eaton <jwe@octave.org>
parents:
8519
diff
changeset
|
436 |
03b7f618ab3d
include docstrings for new functions in the manual
John W. Eaton <jwe@octave.org>
parents:
8519
diff
changeset
|
437 @DOCSTRING(ellipsoid) |
03b7f618ab3d
include docstrings for new functions in the manual
John W. Eaton <jwe@octave.org>
parents:
8519
diff
changeset
|
438 |
6888 | 439 @node Plot Annotations |
440 @subsection Plot Annotations | |
6502 | 441 |
6888 | 442 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
|
443 existing plot. For example: |
6877 | 444 |
6888 | 445 @example |
446 @group | |
447 x = -10:0.1:10; | |
448 plot (x, sin (x)); | |
449 title ("sin(x) for x = -10:0.1:10"); | |
450 xlabel ("x"); | |
451 ylabel ("sin (x)"); | |
452 text (pi, 0.7, "arbitrary text"); | |
453 legend ("sin (x)"); | |
454 @end group | |
455 @end example | |
6502 | 456 |
6888 | 457 The functions @code{grid} and @code{box} may also be used to add grid |
458 and border lines to the plot. By default, the grid is off and the | |
459 border lines are on. | |
5134 | 460 |
461 @DOCSTRING(title) | |
462 | |
6502 | 463 @DOCSTRING(legend) |
464 | |
465 @DOCSTRING(text) | |
466 | |
8428
ee1bc8aa226b
Add cross reference from Plot Annotations to Text Properties.
Francesco Potortì <pot@gnu.org>
parents:
8347
diff
changeset
|
467 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
|
468 |
17097
e7a059a9a644
doc: Use XREF as anchor prefix in documentation for clearer results in Info viewer.
Rik <rik@octave.org>
parents:
16923
diff
changeset
|
469 @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
|
470 @anchor{XREFzlabel} |
5134 | 471 @DOCSTRING(xlabel) |
472 | |
8817
03b7f618ab3d
include docstrings for new functions in the manual
John W. Eaton <jwe@octave.org>
parents:
8519
diff
changeset
|
473 @DOCSTRING(clabel) |
03b7f618ab3d
include docstrings for new functions in the manual
John W. Eaton <jwe@octave.org>
parents:
8519
diff
changeset
|
474 |
6502 | 475 @DOCSTRING(box) |
476 | |
477 @DOCSTRING(grid) | |
478 | |
8089
0ec09255515a
add colorbar docstring to the manual
John W. Eaton <jwe@octave.org>
parents:
8073
diff
changeset
|
479 @DOCSTRING(colorbar) |
0ec09255515a
add colorbar docstring to the manual
John W. Eaton <jwe@octave.org>
parents:
8073
diff
changeset
|
480 |
5134 | 481 @node Multiple Plots on One Page |
6888 | 482 @subsection Multiple Plots on One Page |
483 | |
484 Octave can display more than one plot in a single figure. The simplest | |
485 way to do this is to use the @code{subplot} function to divide the plot | |
486 area into a series of subplot windows that are indexed by an integer. | |
487 For example, | |
488 | |
489 @example | |
490 @group | |
491 subplot (2, 1, 1) | |
492 fplot (@@sin, [-10, 10]); | |
493 subplot (2, 1, 2) | |
494 fplot (@@cos, [-10, 10]); | |
495 @end group | |
496 @end example | |
497 | |
498 @noindent | |
499 creates a figure with two separate axes, one displaying a sine wave and | |
500 the other a cosine wave. The first call to subplot divides the figure | |
501 into two plotting areas (two rows and one column) and makes the first plot | |
502 area active. The grid of plot areas created by @code{subplot} is | |
503 numbered in column-major order (top to bottom, left to right). | |
5134 | 504 |
505 @DOCSTRING(subplot) | |
506 | |
507 @node Multiple Plot Windows | |
6888 | 508 @subsection Multiple Plot Windows |
509 | |
510 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
|
511 For example, |
6888 | 512 |
513 @example | |
9088
77e71f3da3d6
Fix documentation image printing under new development code
Rik <rdrider0-list@yahoo.com>
parents:
9040
diff
changeset
|
514 @group |
6888 | 515 figure (1); |
516 fplot (@@sin, [-10, 10]); | |
517 figure (2); | |
518 fplot (@@cos, [-10, 10]); | |
9088
77e71f3da3d6
Fix documentation image printing under new development code
Rik <rdrider0-list@yahoo.com>
parents:
9040
diff
changeset
|
519 @end group |
6888 | 520 @end example |
521 | |
522 @noindent | |
523 creates two figures, with the first displaying a sine wave and | |
524 the second a cosine wave. Figure numbers must be positive integers. | |
5134 | 525 |
526 @DOCSTRING(figure) | |
16096
9720ecf8d257
Fix additional warning associated with Texinfo 5.0 (bug #38392)
Rik <rik@octave.org>
parents:
16094
diff
changeset
|
527 |
9720ecf8d257
Fix additional warning associated with Texinfo 5.0 (bug #38392)
Rik <rik@octave.org>
parents:
16094
diff
changeset
|
528 @node Manipulation of Plot Windows |
9720ecf8d257
Fix additional warning associated with Texinfo 5.0 (bug #38392)
Rik <rik@octave.org>
parents:
16094
diff
changeset
|
529 @subsection Manipulation of Plot Windows |
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
530 |
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
531 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
|
532 or when waiting for input. The |
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
533 @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
|
534 |
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
535 @DOCSTRING(drawnow) |
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
536 |
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
537 Only figures that are modified will be updated. The @code{refresh} |
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
538 function can also be used to force an update of the current figure, even if |
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
539 it is not modified. |
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
540 |
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
541 @DOCSTRING(refresh) |
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
542 |
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
543 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
|
544 @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
|
545 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
|
546 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
|
547 function. For example, |
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
548 |
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
549 @example |
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
550 @group |
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
551 hold on; |
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
552 x = -10:0.1:10; |
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
553 plot (x, sin (x)); |
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
554 plot (x, cos (x)); |
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
555 hold off; |
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
556 @end group |
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
557 @end example |
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
558 |
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
559 @noindent |
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
560 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
|
561 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
|
562 plot. |
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
563 |
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
564 @DOCSTRING(newplot) |
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(hold) |
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 @DOCSTRING(ishold) |
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
569 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
|
570 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
|
571 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
|
572 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
|
573 figure window, call the @code{close} function. |
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
574 |
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
575 @DOCSTRING(clf) |
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
576 |
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
577 @DOCSTRING(cla) |
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
578 |
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
579 @DOCSTRING(shg) |
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
580 |
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
581 @DOCSTRING(delete) |
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
582 |
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
583 @DOCSTRING(close) |
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
584 |
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
585 @DOCSTRING(closereq) |
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
586 |
16096
9720ecf8d257
Fix additional warning associated with Texinfo 5.0 (bug #38392)
Rik <rik@octave.org>
parents:
16094
diff
changeset
|
587 @node Use of the @code{interpreter} Property |
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
588 @subsection Use of the @code{interpreter} Property |
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 All text objects, including titles, labels, legends, and text, include |
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
591 the property 'interpreter', this property determines the manner in which |
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
592 special control sequences in the text are rendered. If the interpreter |
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
593 is set to 'none', then no rendering occurs. At this point the 'latex' |
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
594 option is not implemented and so the 'latex' interpreter also does not |
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
595 interpret the text. |
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
596 |
9758
09da0bd91412
Periodic grammar check of Octave documentation files to ensure common format
Rik <rdrider0-list@yahoo.com>
parents:
9752
diff
changeset
|
597 The 'tex' option implements a subset of @TeX{} functionality in the |
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
598 rendering of the text. This allows the insertion of special characters |
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
599 such as Greek or mathematical symbols within the text. The special |
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
600 characters are also inserted with a code starting with the back-slash |
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
601 (\) character, as in the table @ref{tab:extended}. |
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
602 |
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
603 In addition, the formatting of the text can be changed within the string |
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
604 with the codes |
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 @multitable @columnfractions .2 .2 .6 .2 |
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
607 @item @tab \bf @tab Bold font @tab |
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
608 @item @tab \it @tab Italic font @tab |
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
609 @item @tab \sl @tab Oblique Font @tab |
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
610 @item @tab \rm @tab Normal font @tab |
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
611 @end multitable |
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
612 |
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
613 These are be used in conjunction with the @{ and @} characters to limit |
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
614 the change in the font to part of the string. For example, |
9672
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 @example |
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
617 xlabel ('@{\bf H@} = a @{\bf V@}') |
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
618 @end example |
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
619 |
10846
a4f482e66b65
Grammarcheck more of the documentation.
Rik <octave@nomad.inbox5.com>
parents:
10828
diff
changeset
|
620 @noindent |
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
621 where the character 'a' will not appear in a bold font. Note that to |
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
622 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
|
623 the strings should be in single quotes. |
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
624 |
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
625 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
|
626 |
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
627 @multitable @columnfractions .1 .4 .6 .1 |
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
628 @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
|
629 @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
|
630 use @tab |
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
631 @end multitable |
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
632 |
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
633 Finally, the superscript and subscripting can be controlled with the '^' |
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
634 and '_' characters. If the '^' or '_' is followed by a @{ character, |
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
635 then all of the block surrounded by the @{ @} pair is super- or |
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
636 sub-scripted. Without the @{ @} pair, only the character immediately |
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
637 following the '^' or '_' is super- or sub-scripted. |
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
638 |
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
639 @float Table,tab:extended |
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
640 @tex |
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
641 \vskip 6pt |
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
642 {\hbox to \hsize {\hfill\vbox{\offinterlineskip \tabskip=0pt |
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
643 \halign{ |
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
644 \vrule height2.0ex depth1.ex width 0.6pt #\tabskip=0.3em & |
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
645 # \hfil & \vrule # & # \hfil & # \vrule & |
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
646 # \hfil & \vrule # & # \hfil & # \vrule & |
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
647 # \hfil & \vrule # & # \hfil & # \vrule |
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
648 width 0.6pt \tabskip=0pt\cr |
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
649 \noalign{\hrule height 0.6pt} |
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
650 & Code && Sym && Code && Sym && Code && Sym &\cr |
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
651 \noalign{\hrule} |
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
652 & $\backslash$forall && $\forall$ |
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
653 && $\backslash$exists && $\exists$ |
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
654 && $\backslash$ni && $\ni$ &\cr |
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
655 & $\backslash$cong && $\cong$ |
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
656 && $\backslash$Delta && $\Delta$ |
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
657 && $\backslash$Phi && $\Phi$ &\cr |
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
658 & $\backslash$Gamma && $\Gamma$ |
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
659 && $\backslash$vartheta && $\vartheta$ |
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
660 && $\backslash$Lambda && $\Lambda$ &\cr |
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
661 & $\backslash$Pi && $\Pi$ |
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
662 && $\backslash$Theta && $\Theta$ |
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
663 && $\backslash$Sigma && $\Sigma$ &\cr |
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
664 & $\backslash$varsigma && $\varsigma$ |
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
665 && $\backslash$Omega && $\Omega$ |
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
666 && $\backslash$Xi && $\Xi$ &\cr |
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
667 & $\backslash$Psi && $\Psi$ |
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
668 && $\backslash$perp && $\perp$ |
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
669 && $\backslash$alpha && $\alpha$ &\cr |
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
670 & $\backslash$beta && $\beta$ |
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
671 && $\backslash$chi && $\chi$ |
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
672 && $\backslash$delta && $\delta$ &\cr |
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
673 & $\backslash$epsilon && $\epsilon$ |
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
674 && $\backslash$phi && $\phi$ |
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
675 && $\backslash$gamma && $\gamma$ &\cr |
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
676 & $\backslash$eta && $\eta$ |
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
677 && $\backslash$iota && $\iota$ |
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
678 && $\backslash$varphi && $\varphi$ &\cr |
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
679 & $\backslash$kappa && $\kappa$ |
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
680 && $\backslash$lambda && $\lambda$ |
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
681 && $\backslash$mu && $\mu$ &\cr |
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
682 & $\backslash$nu && $\nu$ |
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
683 && $\backslash$o && $\o$ |
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
684 && $\backslash$pi && $\pi$ &\cr |
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
685 & $\backslash$theta && $\theta$ |
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
686 && $\backslash$rho && $\rho$ |
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
687 && $\backslash$sigma && $\sigma$ &\cr |
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
688 & $\backslash$tau && $\tau$ |
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
689 && $\backslash$upsilon && $\upsilon$ |
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
690 && $\backslash$varpi && $\varpi$ &\cr |
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
691 & $\backslash$omega && $\omega$ |
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
692 && $\backslash$xi && $\xi$ |
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
693 && $\backslash$psi && $\psi$ &\cr |
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
694 & $\backslash$zeta && $\zeta$ |
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
695 && $\backslash$sim && $\sim$ |
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
696 && $\backslash$Upsilon && $\Upsilon$ &\cr |
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
697 & $\backslash$prime && $\prime$ |
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
698 && $\backslash$leq && $\leq$ |
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
699 && $\backslash$infty && $\infty$ &\cr |
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
700 & $\backslash$clubsuit && $\clubsuit$ |
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
701 && $\backslash$diamondsuit && $\diamondsuit$ |
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
702 && $\backslash$heartsuit && $\heartsuit$ &\cr |
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
703 & $\backslash$spadesuit && $\spadesuit$ |
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
704 && $\backslash$leftrightarrow && $\leftrightarrow$ |
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
705 && $\backslash$leftarrow && $\leftarrow$ &\cr |
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
706 & $\backslash$uparrow && $\uparrow$ |
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
707 && $\backslash$rightarrow && $\rightarrow$ |
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
708 && $\backslash$downarrow && $\downarrow$ &\cr |
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
709 & $\backslash$circ && $\circ$ |
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
710 && $\backslash$pm && $\pm$ |
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
711 && $\backslash$geq && $\geq$ &\cr |
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
712 & $\backslash$times && $\times$ |
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
713 && $\backslash$propto && $\propto$ |
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
714 && $\backslash$partial && $\partial$ &\cr |
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
715 & $\backslash$bullet && $\bullet$ |
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
716 && $\backslash$div && $\div$ |
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
717 && $\backslash$neq && $\neq$ &\cr |
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
718 & $\backslash$equiv && $\equiv$ |
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
719 && $\backslash$approx && $\approx$ |
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
720 && $\backslash$ldots && $\ldots$ &\cr |
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
721 & $\backslash$mid && $\mid$ |
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
722 && $\backslash$aleph && $\aleph$ |
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
723 && $\backslash$Im && $\Im$ &\cr |
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
724 & $\backslash$Re && $\Re$ |
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
725 && $\backslash$wp && $\wp$ |
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
726 && $\backslash$otimes && $\otimes$ &\cr |
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
727 & $\backslash$oplus && $\oplus$ |
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
728 && $\backslash$oslash && $\oslash$ |
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
729 && $\backslash$cap && $\cap$ &\cr |
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
730 & $\backslash$cup && $\cup$ |
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
731 && $\backslash$supset && $\supset$ |
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
732 && $\backslash$supseteq && $\supseteq$ &\cr |
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
733 & $\backslash$subset && $\subset$ |
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
734 && $\backslash$subseteq && $\subseteq$ |
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
735 && $\backslash$in && $\in$ &\cr |
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
736 & $\backslash$notin && $\notin$ |
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
737 && $\backslash$angle && $\angle$ |
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
738 && $\backslash$bigtriangledown && $\bigtriangledown$ &\cr |
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
739 & $\backslash$langle && $\langle$ |
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
740 && $\backslash$rangle && $\rangle$ |
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
741 && $\backslash$nabla && $\nabla$ &\cr |
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
742 & $\backslash$prod && $\prod$ |
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
743 && $\backslash$surd && $\surd$ |
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
744 && $\backslash$cdot && $\cdot$ &\cr |
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
745 & $\backslash$neg && $\neg$ |
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
746 && $\backslash$wedge && $\wedge$ |
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
747 && $\backslash$vee && $\vee$ &\cr |
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
748 & $\backslash$Leftrightarrow && $\Leftrightarrow$ |
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
749 && $\backslash$Leftarrow && $\Leftarrow$ |
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
750 && $\backslash$Uparrow && $\Uparrow$ &\cr |
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
751 & $\backslash$Rightarrow && $\Rightarrow$ |
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
752 && $\backslash$Downarrow && $\Downarrow$ |
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
753 && $\backslash$diamond && $\diamond$ &\cr |
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
754 & $\backslash$copyright && $\copyright$ |
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
755 && $\backslash$rfloor && $\rfloor$ |
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
756 && $\backslash$lceil && $\lceil$ &\cr |
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
757 & $\backslash$lfloor && $\lfloor$ |
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
758 && $\backslash$rceil && $\rceil$ |
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
759 && $\backslash$int && $\int$ &\cr |
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
760 \noalign{\hrule height 0.6pt} |
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
761 }}\hfill}} |
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
762 @end tex |
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
763 @ifnottex |
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
764 @multitable @columnfractions .125 .25 .25 .25 .125 |
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
765 @item @tab \forall @tab \exists @tab \ni @tab |
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
766 @item @tab \cong @tab \Delta @tab \Phi @tab |
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
767 @item @tab \Gamma @tab \vartheta @tab \Lambda @tab |
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
768 @item @tab \Pi @tab \Theta @tab \Sigma @tab |
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
769 @item @tab \varsigma @tab \Omega @tab \Xi @tab |
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
770 @item @tab \Psi @tab \perp @tab \alpha @tab |
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
771 @item @tab \beta @tab \chi @tab \delta @tab |
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
772 @item @tab \epsilon @tab \phi @tab \gamma @tab |
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
773 @item @tab \eta @tab \iota @tab \varphi @tab |
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
774 @item @tab \kappa @tab \lambda @tab \mu @tab |
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
775 @item @tab \nu @tab \o @tab \pi @tab |
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
776 @item @tab \theta @tab \rho @tab \sigma @tab |
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
777 @item @tab \tau @tab \upsilon @tab \varpi @tab |
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
778 @item @tab \omega @tab \xi @tab \psi @tab |
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
779 @item @tab \zeta @tab \sim @tab \Upsilon @tab |
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
780 @item @tab \prime @tab \leq @tab \infty @tab |
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
781 @item @tab \clubsuit @tab \diamondsuit @tab \heartsuit @tab |
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
782 @item @tab \spadesuit @tab \leftrightarrow @tab \leftarrow @tab |
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
783 @item @tab \uparrow @tab \rightarrow @tab \downarrow @tab |
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
784 @item @tab \circ @tab \pm @tab \geq @tab |
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
785 @item @tab \times @tab \propto @tab \partial @tab |
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
786 @item @tab \bullet @tab \div @tab \neq @tab |
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
787 @item @tab \equiv @tab \approx @tab \ldots @tab |
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
788 @item @tab \mid @tab \aleph @tab \Im @tab |
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
789 @item @tab \Re @tab \wp @tab \otimes @tab |
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
790 @item @tab \oplus @tab \oslash @tab \cap @tab |
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
791 @item @tab \cup @tab \supset @tab \supseteq @tab |
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
792 @item @tab \subset @tab \subseteq @tab \in @tab |
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
793 @item @tab \notin @tab \angle @tab \bigrightriangledown @tab |
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
794 @item @tab \langle @tab \rangle @tab \nabla @tab |
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
795 @item @tab \prod @tab \surd @tab \cdot @tab |
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
796 @item @tab \neg @tab \wedge @tab \vee @tab |
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
797 @item @tab \Leftrightarrow @tab \Leftarrow @tab \Uparrow @tab |
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
798 @item @tab \Rightarrow @tab \Downarrow @tab \diamond @tab |
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
799 @item @tab \copyright @tab \lfloor @tab \lceil @tab |
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
800 @item @tab \rfloor @tab \rceil @tab \int @tab |
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
801 @end multitable |
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
802 @end ifnottex |
9758
09da0bd91412
Periodic grammar check of Octave documentation files to ensure common format
Rik <rdrider0-list@yahoo.com>
parents:
9752
diff
changeset
|
803 @caption{Available special characters in @TeX{} mode} |
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
804 @end float |
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
805 |
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
806 A complete example showing the capabilities of the extended text is |
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
807 |
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
808 @example |
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
809 @group |
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
810 x = 0:0.01:3; |
14856
c3fd61c59e9c
maint: Use Octave coding conventions for cuddling parentheses in doc directory
Rik <octave@nomad.inbox5.com>
parents:
14853
diff
changeset
|
811 plot (x, erf (x)); |
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
812 hold on; |
14856
c3fd61c59e9c
maint: Use Octave coding conventions for cuddling parentheses in doc directory
Rik <octave@nomad.inbox5.com>
parents:
14853
diff
changeset
|
813 plot (x,x,"r"); |
c3fd61c59e9c
maint: Use Octave coding conventions for cuddling parentheses in doc directory
Rik <octave@nomad.inbox5.com>
parents:
14853
diff
changeset
|
814 axis ([0, 3, 0, 1]); |
c3fd61c59e9c
maint: Use Octave coding conventions for cuddling parentheses in doc directory
Rik <octave@nomad.inbox5.com>
parents:
14853
diff
changeset
|
815 text (0.65, 0.6175, strcat ('\leftarrow x = @{2/\surd\pi', |
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
816 ' @{\fontsize@{16@}\int_@{\fontsize@{8@}0@}^@{\fontsize@{8@}x@}@}', |
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
817 ' e^@{-t^2@} dt@} = 0.6175')) |
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
818 @end group |
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
819 @end example |
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
820 |
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
821 @ifnotinfo |
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
822 @noindent |
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
823 The result of which can be seen in @ref{fig:extendedtext} |
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
824 |
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
825 @float Figure,fig:extendedtext |
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
826 @center @image{extended,4in} |
9758
09da0bd91412
Periodic grammar check of Octave documentation files to ensure common format
Rik <rdrider0-list@yahoo.com>
parents:
9752
diff
changeset
|
827 @caption{Example of inclusion of text with the @TeX{} interpreter} |
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
828 @end float |
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
829 @end ifnotinfo |
5134 | 830 |
11254
31f8534eb055
Add reference to new saveas function in printed manual.
Rik <octave@nomad.inbox5.com>
parents:
10846
diff
changeset
|
831 @node Printing and Saving Plots |
31f8534eb055
Add reference to new saveas function in printed manual.
Rik <octave@nomad.inbox5.com>
parents:
10846
diff
changeset
|
832 @subsection Printing and Saving Plots |
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
833 @cindex printing plots |
11254
31f8534eb055
Add reference to new saveas function in printed manual.
Rik <octave@nomad.inbox5.com>
parents:
10846
diff
changeset
|
834 @cindex saving plots |
6888 | 835 |
14456
05635e4c605a
Improve documentation for print().
Ben Abbott <bpabbott@mac.com>
parents:
14138
diff
changeset
|
836 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
|
837 to save plots in a variety of formats. For example, |
05635e4c605a
Improve documentation for print().
Ben Abbott <bpabbott@mac.com>
parents:
14138
diff
changeset
|
838 |
05635e4c605a
Improve documentation for print().
Ben Abbott <bpabbott@mac.com>
parents:
14138
diff
changeset
|
839 @example |
05635e4c605a
Improve documentation for print().
Ben Abbott <bpabbott@mac.com>
parents:
14138
diff
changeset
|
840 print -dpsc |
05635e4c605a
Improve documentation for print().
Ben Abbott <bpabbott@mac.com>
parents:
14138
diff
changeset
|
841 @end example |
05635e4c605a
Improve documentation for print().
Ben Abbott <bpabbott@mac.com>
parents:
14138
diff
changeset
|
842 |
05635e4c605a
Improve documentation for print().
Ben Abbott <bpabbott@mac.com>
parents:
14138
diff
changeset
|
843 @noindent |
14853
72b8b39e12be
doc: Periodic grammarcheck of documentation.
Rik <octave@nomad.inbox5.com>
parents:
14577
diff
changeset
|
844 prints the current figure to a color PostScript printer. And, |
6888 | 845 |
846 @example | |
847 print -deps foo.eps | |
848 @end example | |
849 | |
850 @noindent | |
14456
05635e4c605a
Improve documentation for print().
Ben Abbott <bpabbott@mac.com>
parents:
14138
diff
changeset
|
851 saves the current figure to an encapsulated PostScript file called |
6888 | 852 @file{foo.eps}. |
6502 | 853 |
854 @DOCSTRING(print) | |
855 | |
11254
31f8534eb055
Add reference to new saveas function in printed manual.
Rik <octave@nomad.inbox5.com>
parents:
10846
diff
changeset
|
856 @DOCSTRING(saveas) |
31f8534eb055
Add reference to new saveas function in printed manual.
Rik <octave@nomad.inbox5.com>
parents:
10846
diff
changeset
|
857 |
6502 | 858 @DOCSTRING(orient) |
5134 | 859 |
11254
31f8534eb055
Add reference to new saveas function in printed manual.
Rik <octave@nomad.inbox5.com>
parents:
10846
diff
changeset
|
860 @node Interacting with Plots |
31f8534eb055
Add reference to new saveas function in printed manual.
Rik <octave@nomad.inbox5.com>
parents:
10846
diff
changeset
|
861 @subsection Interacting with Plots |
7984
bbaa5d7d0143
Some documentation updates
David Bateman <dbateman@free.fr>
parents:
7981
diff
changeset
|
862 |
bbaa5d7d0143
Some documentation updates
David Bateman <dbateman@free.fr>
parents:
7981
diff
changeset
|
863 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
|
864 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
|
865 @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
|
866 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
|
867 |
bbaa5d7d0143
Some documentation updates
David Bateman <dbateman@free.fr>
parents:
7981
diff
changeset
|
868 @DOCSTRING(ginput) |
bbaa5d7d0143
Some documentation updates
David Bateman <dbateman@free.fr>
parents:
7981
diff
changeset
|
869 |
bbaa5d7d0143
Some documentation updates
David Bateman <dbateman@free.fr>
parents:
7981
diff
changeset
|
870 @DOCSTRING(waitforbuttonpress) |
bbaa5d7d0143
Some documentation updates
David Bateman <dbateman@free.fr>
parents:
7981
diff
changeset
|
871 |
bbaa5d7d0143
Some documentation updates
David Bateman <dbateman@free.fr>
parents:
7981
diff
changeset
|
872 @DOCSTRING(gtext) |
bbaa5d7d0143
Some documentation updates
David Bateman <dbateman@free.fr>
parents:
7981
diff
changeset
|
873 |
12522
33bbae85769a
Add uimenu, uigetdir, uigetfile, and uiputfile to documentation.
Rik <octave@nomad.inbox5.com>
parents:
12226
diff
changeset
|
874 @DOCSTRING(uimenu) |
33bbae85769a
Add uimenu, uigetdir, uigetfile, and uiputfile to documentation.
Rik <octave@nomad.inbox5.com>
parents:
12226
diff
changeset
|
875 |
6788 | 876 @node Test Plotting Functions |
6888 | 877 @subsection Test Plotting Functions |
878 | |
879 The functions @code{sombrero} and @code{peaks} provide a way to check | |
880 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
|
881 at the Octave prompt should display a three-dimensional plot. |
6788 | 882 |
6877 | 883 @DOCSTRING(sombrero) |
884 | |
6788 | 885 @DOCSTRING(peaks) |
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
886 @node Graphics Data Structures |
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
887 @section Graphics Data Structures |
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
888 @cindex graphics data structures |
6888 | 889 |
890 @menu | |
9676 | 891 * Introduction to Graphics Structures:: |
892 * Graphics Objects:: | |
893 * Graphics Object Properties:: | |
894 * Searching Properties:: | |
895 * Managing Default Properties:: | |
6888 | 896 @end menu |
897 | |
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
898 @node Introduction to Graphics Structures |
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
899 @subsection Introduction to Graphics Structures |
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
900 @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
|
901 @anchor{XREFgraphics structures} |
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
902 |
10846
a4f482e66b65
Grammarcheck more of the documentation.
Rik <octave@nomad.inbox5.com>
parents:
10828
diff
changeset
|
903 The graphics functions use pointers, which are of class graphics_handle, in |
a4f482e66b65
Grammarcheck more of the documentation.
Rik <octave@nomad.inbox5.com>
parents:
10828
diff
changeset
|
904 order to address the data structures which control graphical displays. A |
a4f482e66b65
Grammarcheck more of the documentation.
Rik <octave@nomad.inbox5.com>
parents:
10828
diff
changeset
|
905 graphics handle may point any one of a number of different object types. The |
a4f482e66b65
Grammarcheck more of the documentation.
Rik <octave@nomad.inbox5.com>
parents:
10828
diff
changeset
|
906 objects are the graphics data structures. The types of objects are: |
a4f482e66b65
Grammarcheck more of the documentation.
Rik <octave@nomad.inbox5.com>
parents:
10828
diff
changeset
|
907 @code{figure}, @code{axes}, @code{line}, @code{text}, @code{patch}, |
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
908 @code{surface}, @code{text} and @code{image}. |
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
909 |
10846
a4f482e66b65
Grammarcheck more of the documentation.
Rik <octave@nomad.inbox5.com>
parents:
10828
diff
changeset
|
910 Each of these objects has a function by the same name. and, each of these |
a4f482e66b65
Grammarcheck more of the documentation.
Rik <octave@nomad.inbox5.com>
parents:
10828
diff
changeset
|
911 functions returns a graphics handle pointing to an object of corresponding |
a4f482e66b65
Grammarcheck more of the documentation.
Rik <octave@nomad.inbox5.com>
parents:
10828
diff
changeset
|
912 type. In addition there are several functions which operate on properties of |
a4f482e66b65
Grammarcheck more of the documentation.
Rik <octave@nomad.inbox5.com>
parents:
10828
diff
changeset
|
913 the graphics objects and which return handles: the functions @code{ plot} and |
a4f482e66b65
Grammarcheck more of the documentation.
Rik <octave@nomad.inbox5.com>
parents:
10828
diff
changeset
|
914 @code{plot3} return a handle pointing to an object of type line, the function |
a4f482e66b65
Grammarcheck more of the documentation.
Rik <octave@nomad.inbox5.com>
parents:
10828
diff
changeset
|
915 @code{subplot} returns a handle pointing to an object of type axes, the |
a4f482e66b65
Grammarcheck more of the documentation.
Rik <octave@nomad.inbox5.com>
parents:
10828
diff
changeset
|
916 function @code{fill} returns a handle pointing to an object of type patch, the |
a4f482e66b65
Grammarcheck more of the documentation.
Rik <octave@nomad.inbox5.com>
parents:
10828
diff
changeset
|
917 functions @code{area}, @code{bar}, @code{barh}, @code{contour}, |
a4f482e66b65
Grammarcheck more of the documentation.
Rik <octave@nomad.inbox5.com>
parents:
10828
diff
changeset
|
918 @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
|
919 @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
|
920 @code{scatter3}, @code{stair}, @code{stem}, @code{stem3} each return a handle |
17097
e7a059a9a644
doc: Use XREF as anchor prefix in documentation for clearer results in Info viewer.
Rik <rik@octave.org>
parents:
16923
diff
changeset
|
921 as documented in @ref{XREFdatasources,,Data Sources}. |
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
922 |
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
923 |
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
924 The graphics objects are arranged in a hierarchy: |
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
925 |
11444 | 926 1. The root is at 0. i.e., @code{get (0)} returns the properties of the root |
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
927 object. |
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
928 |
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
929 2. Below the root are @code{figure} objects. |
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
930 |
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
931 3. Below the @code{figure} objects are @code{axes}. |
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
932 |
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
933 4. Below the @code{axes} objects are |
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
934 @code{line}, @code{text}, @code{patch}, |
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
935 @code{surface}, and @code{image} objects. |
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
936 |
16814
64e7bb01fce2
doc: Improve documentation for 2-D plot functions
Rik <rik@octave.org>
parents:
16813
diff
changeset
|
937 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
|
938 (@pxref{Function Handles}) by means of the function @code{ishandle}. |
16814
64e7bb01fce2
doc: Improve documentation for 2-D plot functions
Rik <rik@octave.org>
parents:
16813
diff
changeset
|
939 @code{ishandle} returns true if its argument is a handle of a graphics object. |
64e7bb01fce2
doc: Improve documentation for 2-D plot functions
Rik <rik@octave.org>
parents:
16813
diff
changeset
|
940 In addition, the figure object may be tested using @code{isfigure}. |
64e7bb01fce2
doc: Improve documentation for 2-D plot functions
Rik <rik@octave.org>
parents:
16813
diff
changeset
|
941 @code{isfigure} returns true only if its argument is a handle of a figure. The |
64e7bb01fce2
doc: Improve documentation for 2-D plot functions
Rik <rik@octave.org>
parents:
16813
diff
changeset
|
942 @code{whos} function can be used to show the object type of each currently |
64e7bb01fce2
doc: Improve documentation for 2-D plot functions
Rik <rik@octave.org>
parents:
16813
diff
changeset
|
943 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
|
944 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
|
945 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
|
946 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
|
947 functions and, in fact, replace them.) |
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
948 |
16814
64e7bb01fce2
doc: Improve documentation for 2-D plot functions
Rik <rik@octave.org>
parents:
16813
diff
changeset
|
949 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
|
950 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
|
951 used to obtain property names. |
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
952 |
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
953 For example, the property "type" of the graphics object pointed to by the |
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
954 graphics handle h may be displayed by: |
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
955 |
11444 | 956 @example |
957 get (h, "type") | |
958 @end example | |
959 | |
960 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
|
961 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
|
962 allowed properties are wanted they may be displayed by: |
11444 | 963 @code{get (h, "")}. |
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
964 |
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
965 Thus, for example, |
11573
6f8ffe2c6f76
Grammarcheck txi files for 3.4 release.
Rik <octave@nomad.inbox5.com>
parents:
11523
diff
changeset
|
966 |
11444 | 967 @smallexample |
968 h = figure (); | |
969 get (h, "type") | |
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
970 ans = figure |
11444 | 971 get (h, ""); |
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
972 error: get: ambiguous figure property name ; possible matches: |
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
973 |
11576
8ac9687dbe9f
rename backend to graphics_toolkit
John W. Eaton <jwe@octave.org>
parents:
11573
diff
changeset
|
974 __graphics_toolkit__ hittest resize |
8ac9687dbe9f
rename backend to graphics_toolkit
John W. Eaton <jwe@octave.org>
parents:
11573
diff
changeset
|
975 __enhanced__ integerhandle resizefcn |
8ac9687dbe9f
rename backend to graphics_toolkit
John W. Eaton <jwe@octave.org>
parents:
11573
diff
changeset
|
976 __modified__ interruptible selected |
8ac9687dbe9f
rename backend to graphics_toolkit
John W. Eaton <jwe@octave.org>
parents:
11573
diff
changeset
|
977 __myhandle__ inverthardcopy selectionhighlight |
8ac9687dbe9f
rename backend to graphics_toolkit
John W. Eaton <jwe@octave.org>
parents:
11573
diff
changeset
|
978 __plot_stream__ keypressfcn selectiontype |
8ac9687dbe9f
rename backend to graphics_toolkit
John W. Eaton <jwe@octave.org>
parents:
11573
diff
changeset
|
979 alphamap keyreleasefcn tag |
8ac9687dbe9f
rename backend to graphics_toolkit
John W. Eaton <jwe@octave.org>
parents:
11573
diff
changeset
|
980 beingdeleted menubar toolbar |
8ac9687dbe9f
rename backend to graphics_toolkit
John W. Eaton <jwe@octave.org>
parents:
11573
diff
changeset
|
981 busyaction mincolormap type |
8ac9687dbe9f
rename backend to graphics_toolkit
John W. Eaton <jwe@octave.org>
parents:
11573
diff
changeset
|
982 buttondownfcn name uicontextmenu |
8ac9687dbe9f
rename backend to graphics_toolkit
John W. Eaton <jwe@octave.org>
parents:
11573
diff
changeset
|
983 children nextplot units |
8ac9687dbe9f
rename backend to graphics_toolkit
John W. Eaton <jwe@octave.org>
parents:
11573
diff
changeset
|
984 clipping numbertitle userdata |
8ac9687dbe9f
rename backend to graphics_toolkit
John W. Eaton <jwe@octave.org>
parents:
11573
diff
changeset
|
985 closerequestfcn paperorientation visible |
8ac9687dbe9f
rename backend to graphics_toolkit
John W. Eaton <jwe@octave.org>
parents:
11573
diff
changeset
|
986 color paperposition windowbuttondownfcn |
8ac9687dbe9f
rename backend to graphics_toolkit
John W. Eaton <jwe@octave.org>
parents:
11573
diff
changeset
|
987 colormap paperpositionmode windowbuttonmotionfcn |
8ac9687dbe9f
rename backend to graphics_toolkit
John W. Eaton <jwe@octave.org>
parents:
11573
diff
changeset
|
988 createfcn papersize windowbuttonupfcn |
17099
a033fd3669c0
Alphabetize graphic properties and add properties missing from Matlab.
Rik <rik@octave.org>
parents:
17097
diff
changeset
|
989 currentaxes papertype windowscrollwheelfcn |
11576
8ac9687dbe9f
rename backend to graphics_toolkit
John W. Eaton <jwe@octave.org>
parents:
11573
diff
changeset
|
990 currentcharacter paperunits windowstyle |
8ac9687dbe9f
rename backend to graphics_toolkit
John W. Eaton <jwe@octave.org>
parents:
11573
diff
changeset
|
991 currentobject parent wvisual |
8ac9687dbe9f
rename backend to graphics_toolkit
John W. Eaton <jwe@octave.org>
parents:
11573
diff
changeset
|
992 currentpoint pointer wvisualmode |
8ac9687dbe9f
rename backend to graphics_toolkit
John W. Eaton <jwe@octave.org>
parents:
11573
diff
changeset
|
993 deletefcn pointershapecdata xdisplay |
8ac9687dbe9f
rename backend to graphics_toolkit
John W. Eaton <jwe@octave.org>
parents:
11573
diff
changeset
|
994 dockcontrols pointershapehotspot xvisual |
8ac9687dbe9f
rename backend to graphics_toolkit
John W. Eaton <jwe@octave.org>
parents:
11573
diff
changeset
|
995 doublebuffer position xvisualmode |
8ac9687dbe9f
rename backend to graphics_toolkit
John W. Eaton <jwe@octave.org>
parents:
11573
diff
changeset
|
996 filename renderer |
8ac9687dbe9f
rename backend to graphics_toolkit
John W. Eaton <jwe@octave.org>
parents:
11573
diff
changeset
|
997 handlevisibility renderermode |
11444 | 998 @end smallexample |
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
999 |
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
1000 The root figure has index 0. Its properties may be displayed by: |
11444 | 1001 @code{get (0, "")}. |
1002 | |
1003 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
|
1004 @ref{XREFget,,get}, @ref{XREFset,,set}. |
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
1005 |
11380 | 1006 @DOCSTRING(isprop) |
1007 | |
6888 | 1008 @node Graphics Objects |
1009 @subsection Graphics Objects | |
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
1010 @cindex graphics objects |
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
1011 |
17097
e7a059a9a644
doc: Use XREF as anchor prefix in documentation for clearer results in Info viewer.
Rik <rik@octave.org>
parents:
16923
diff
changeset
|
1012 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
|
1013 @xref{Introduction to Graphics Structures}. Here the |
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
1014 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
|
1015 these objects are discussed. Keep in mind that |
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
1016 graphics objects are always referenced by @dfn{handle}. |
6888 | 1017 |
1018 @table @asis | |
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
1019 @c @group |
10846
a4f482e66b65
Grammarcheck more of the documentation.
Rik <octave@nomad.inbox5.com>
parents:
10828
diff
changeset
|
1020 |
6888 | 1021 @item root figure |
8071 | 1022 @cindex root figure graphics object |
1023 @cindex graphics object, root figure | |
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
1024 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
|
1025 The handle index of the root figure is 0. |
6888 | 1026 |
1027 @item figure | |
8071 | 1028 @cindex figure graphics object |
1029 @cindex graphics object, figure | |
6888 | 1030 A figure window. |
1031 | |
1032 @item axes | |
8071 | 1033 @cindex axes graphics object |
1034 @cindex graphics object, axes | |
9316
c539ec5726e7
Update some of Advanced Plotting documentation.
Rik <rdrider0-list@yahoo.com>
parents:
9209
diff
changeset
|
1035 A set of axes. This object is a child of a figure object and may be a |
6888 | 1036 parent of line, text, image, patch, or surface objects. |
1037 | |
1038 @item line | |
8071 | 1039 @cindex line graphics object |
1040 @cindex graphics object, line | |
6888 | 1041 A line in two or three dimensions. |
1042 | |
1043 @item text | |
8071 | 1044 @cindex text graphics object |
1045 @cindex graphics object, text | |
6888 | 1046 Text annotations. |
1047 | |
1048 @item image | |
8071 | 1049 @cindex image graphics object |
1050 @cindex graphics object, image | |
6888 | 1051 A bitmap image. |
1052 | |
1053 @item patch | |
8071 | 1054 @cindex patch graphics object |
1055 @cindex graphics object, patch | |
6888 | 1056 A filled polygon, currently limited to two dimensions. |
1057 | |
1058 @item surface | |
8071 | 1059 @cindex surface graphics object |
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
1060 @cindex graphics object, surface |
6888 | 1061 A three-dimensional surface. |
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
1062 @c @end group |
6888 | 1063 @end table |
1064 | |
16923
5d08a2ec7edb
doc: Move graphics object functions into the right section
Mike Miller <mtmiller@ieee.org>
parents:
16814
diff
changeset
|
1065 @subsubsection Creating Graphics Objects |
5d08a2ec7edb
doc: Move graphics object functions into the right section
Mike Miller <mtmiller@ieee.org>
parents:
16814
diff
changeset
|
1066 @cindex creating graphics objects |
5d08a2ec7edb
doc: Move graphics object functions into the right section
Mike Miller <mtmiller@ieee.org>
parents:
16814
diff
changeset
|
1067 |
5d08a2ec7edb
doc: Move graphics object functions into the right section
Mike Miller <mtmiller@ieee.org>
parents:
16814
diff
changeset
|
1068 You can create axes, line, patch, and surface objects directly using the |
5d08a2ec7edb
doc: Move graphics object functions into the right section
Mike Miller <mtmiller@ieee.org>
parents:
16814
diff
changeset
|
1069 @code{axes}, @code{line}, @code{patch}, @code{fill}, and @code{surface} |
5d08a2ec7edb
doc: Move graphics object functions into the right section
Mike Miller <mtmiller@ieee.org>
parents:
16814
diff
changeset
|
1070 functions. These objects become children of the current axes object. |
5d08a2ec7edb
doc: Move graphics object functions into the right section
Mike Miller <mtmiller@ieee.org>
parents:
16814
diff
changeset
|
1071 |
5d08a2ec7edb
doc: Move graphics object functions into the right section
Mike Miller <mtmiller@ieee.org>
parents:
16814
diff
changeset
|
1072 @DOCSTRING(axes) |
5d08a2ec7edb
doc: Move graphics object functions into the right section
Mike Miller <mtmiller@ieee.org>
parents:
16814
diff
changeset
|
1073 |
5d08a2ec7edb
doc: Move graphics object functions into the right section
Mike Miller <mtmiller@ieee.org>
parents:
16814
diff
changeset
|
1074 @DOCSTRING(line) |
5d08a2ec7edb
doc: Move graphics object functions into the right section
Mike Miller <mtmiller@ieee.org>
parents:
16814
diff
changeset
|
1075 |
5d08a2ec7edb
doc: Move graphics object functions into the right section
Mike Miller <mtmiller@ieee.org>
parents:
16814
diff
changeset
|
1076 @DOCSTRING(patch) |
5d08a2ec7edb
doc: Move graphics object functions into the right section
Mike Miller <mtmiller@ieee.org>
parents:
16814
diff
changeset
|
1077 |
5d08a2ec7edb
doc: Move graphics object functions into the right section
Mike Miller <mtmiller@ieee.org>
parents:
16814
diff
changeset
|
1078 @DOCSTRING(fill) |
5d08a2ec7edb
doc: Move graphics object functions into the right section
Mike Miller <mtmiller@ieee.org>
parents:
16814
diff
changeset
|
1079 |
5d08a2ec7edb
doc: Move graphics object functions into the right section
Mike Miller <mtmiller@ieee.org>
parents:
16814
diff
changeset
|
1080 @DOCSTRING(surface) |
5d08a2ec7edb
doc: Move graphics object functions into the right section
Mike Miller <mtmiller@ieee.org>
parents:
16814
diff
changeset
|
1081 |
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
1082 @subsubsection Handle Functions |
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
1083 @cindex handle functions |
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
1084 |
9316
c539ec5726e7
Update some of Advanced Plotting documentation.
Rik <rdrider0-list@yahoo.com>
parents:
9209
diff
changeset
|
1085 To determine whether a variable is a graphics object index or a figure |
6888 | 1086 index, use the functions @code{ishandle} and @code{isfigure}. |
1087 | |
1088 @DOCSTRING(ishandle) | |
1089 | |
8817
03b7f618ab3d
include docstrings for new functions in the manual
John W. Eaton <jwe@octave.org>
parents:
8519
diff
changeset
|
1090 @DOCSTRING(ishghandle) |
03b7f618ab3d
include docstrings for new functions in the manual
John W. Eaton <jwe@octave.org>
parents:
8519
diff
changeset
|
1091 |
6888 | 1092 @DOCSTRING(isfigure) |
1093 | |
1094 The function @code{gcf} returns an index to the current figure object, | |
1095 or creates one if none exists. Similarly, @code{gca} returns the | |
1096 current axes object, or creates one (and its parent figure object) if | |
1097 none exists. | |
1098 | |
1099 @DOCSTRING(gcf) | |
1100 | |
1101 @DOCSTRING(gca) | |
1102 | |
16808 | 1103 @DOCSTRING(gco) |
1104 | |
6888 | 1105 The @code{get} and @code{set} functions may be used to examine and set |
1106 properties for graphics objects. For example, | |
1107 | |
1108 @example | |
1109 @group | |
1110 get (0) | |
1111 @result{} ans = | |
1112 @{ | |
9316
c539ec5726e7
Update some of Advanced Plotting documentation.
Rik <rdrider0-list@yahoo.com>
parents:
9209
diff
changeset
|
1113 type = root |
6888 | 1114 currentfigure = [](0x0) |
1115 children = [](0x0) | |
1116 visible = on | |
10599
d0e0bb2ebebb
Remove tabs in .txi files causing problems with pdf formatting.
Rik <octave@nomad.inbox5.com>
parents:
10522
diff
changeset
|
1117 @dots{} |
6888 | 1118 @} |
1119 @end group | |
1120 @end example | |
1121 | |
1122 @noindent | |
1123 returns a structure containing all the properties of the root figure. | |
1124 As with all functions in Octave, the structure is returned by value, so | |
1125 modifying it will not modify the internal root figure plot object. To | |
1126 do that, you must use the @code{set} function. Also, note that in this | |
1127 case, the @code{currentfigure} property is empty, which indicates that | |
1128 there is no current figure window. | |
1129 | |
1130 The @code{get} function may also be used to find the value of a single | |
1131 property. For example, | |
1132 | |
1133 @example | |
1134 @group | |
1135 get (gca (), "xlim") | |
1136 @result{} [ 0 1 ] | |
1137 @end group | |
1138 @end example | |
1139 | |
1140 @noindent | |
1141 returns the range of the x-axis for the current axes object in the | |
1142 current figure. | |
1143 | |
1144 To set graphics object properties, use the set function. For example, | |
1145 | |
1146 @example | |
1147 set (gca (), "xlim", [-10, 10]); | |
1148 @end example | |
1149 | |
1150 @noindent | |
1151 sets the range of the x-axis for the current axes object in the current | |
1152 figure to @samp{[-10, 10]}. Additionally, calling set with a graphics | |
1153 object index as the only argument returns a structure containing the | |
1154 default values for all the properties for the given object type. For | |
1155 example, | |
1156 | |
1157 @example | |
1158 set (gca ()) | |
1159 @end example | |
1160 | |
1161 @noindent | |
1162 returns a structure containing the default property values for axes | |
1163 objects. | |
1164 | |
1165 @DOCSTRING(get) | |
1166 | |
1167 @DOCSTRING(set) | |
1168 | |
1169 @DOCSTRING(ancestor) | |
1170 | |
7984
bbaa5d7d0143
Some documentation updates
David Bateman <dbateman@free.fr>
parents:
7981
diff
changeset
|
1171 @DOCSTRING(allchild) |
bbaa5d7d0143
Some documentation updates
David Bateman <dbateman@free.fr>
parents:
7981
diff
changeset
|
1172 |
14577
447038c2dde8
Add findfigs.m docstring to plot.txi
Carnë Draug <carandraug+dev@gmail.com>
parents:
14574
diff
changeset
|
1173 @DOCSTRING(findfigs) |
447038c2dde8
Add findfigs.m docstring to plot.txi
Carnë Draug <carandraug+dev@gmail.com>
parents:
14574
diff
changeset
|
1174 |
16813
81e041f5633a
doc: Add copyobj, struct2hdl, hdl2struct to manual.
Rik <rik@octave.org>
parents:
16808
diff
changeset
|
1175 @cindex saving graphics objects |
81e041f5633a
doc: Add copyobj, struct2hdl, hdl2struct to manual.
Rik <rik@octave.org>
parents:
16808
diff
changeset
|
1176 |
81e041f5633a
doc: Add copyobj, struct2hdl, hdl2struct to manual.
Rik <rik@octave.org>
parents:
16808
diff
changeset
|
1177 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
|
1178 @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
|
1179 Octave handle graphic directly so that further modifications can be made such |
81e041f5633a
doc: Add copyobj, struct2hdl, hdl2struct to manual.
Rik <rik@octave.org>
parents:
16808
diff
changeset
|
1180 as modifying a title or legend. |
81e041f5633a
doc: Add copyobj, struct2hdl, hdl2struct to manual.
Rik <rik@octave.org>
parents:
16808
diff
changeset
|
1181 |
81e041f5633a
doc: Add copyobj, struct2hdl, hdl2struct to manual.
Rik <rik@octave.org>
parents:
16808
diff
changeset
|
1182 This can be accomplished with the following functions by |
81e041f5633a
doc: Add copyobj, struct2hdl, hdl2struct to manual.
Rik <rik@octave.org>
parents:
16808
diff
changeset
|
1183 |
81e041f5633a
doc: Add copyobj, struct2hdl, hdl2struct to manual.
Rik <rik@octave.org>
parents:
16808
diff
changeset
|
1184 @example |
81e041f5633a
doc: Add copyobj, struct2hdl, hdl2struct to manual.
Rik <rik@octave.org>
parents:
16808
diff
changeset
|
1185 @group |
81e041f5633a
doc: Add copyobj, struct2hdl, hdl2struct to manual.
Rik <rik@octave.org>
parents:
16808
diff
changeset
|
1186 fig_struct = hdl2struct (gcf); |
81e041f5633a
doc: Add copyobj, struct2hdl, hdl2struct to manual.
Rik <rik@octave.org>
parents:
16808
diff
changeset
|
1187 save myplot.fig -struct fig_struct; |
81e041f5633a
doc: Add copyobj, struct2hdl, hdl2struct to manual.
Rik <rik@octave.org>
parents:
16808
diff
changeset
|
1188 @dots{} |
81e041f5633a
doc: Add copyobj, struct2hdl, hdl2struct to manual.
Rik <rik@octave.org>
parents:
16808
diff
changeset
|
1189 fig_struct = load ("myplot.fig"); |
81e041f5633a
doc: Add copyobj, struct2hdl, hdl2struct to manual.
Rik <rik@octave.org>
parents:
16808
diff
changeset
|
1190 struct2hdl (fig_struct); |
81e041f5633a
doc: Add copyobj, struct2hdl, hdl2struct to manual.
Rik <rik@octave.org>
parents:
16808
diff
changeset
|
1191 @end group |
81e041f5633a
doc: Add copyobj, struct2hdl, hdl2struct to manual.
Rik <rik@octave.org>
parents:
16808
diff
changeset
|
1192 @end example |
81e041f5633a
doc: Add copyobj, struct2hdl, hdl2struct to manual.
Rik <rik@octave.org>
parents:
16808
diff
changeset
|
1193 |
81e041f5633a
doc: Add copyobj, struct2hdl, hdl2struct to manual.
Rik <rik@octave.org>
parents:
16808
diff
changeset
|
1194 @DOCSTRING(hdl2struct) |
81e041f5633a
doc: Add copyobj, struct2hdl, hdl2struct to manual.
Rik <rik@octave.org>
parents:
16808
diff
changeset
|
1195 |
81e041f5633a
doc: Add copyobj, struct2hdl, hdl2struct to manual.
Rik <rik@octave.org>
parents:
16808
diff
changeset
|
1196 @DOCSTRING(struct2hdl) |
81e041f5633a
doc: Add copyobj, struct2hdl, hdl2struct to manual.
Rik <rik@octave.org>
parents:
16808
diff
changeset
|
1197 |
81e041f5633a
doc: Add copyobj, struct2hdl, hdl2struct to manual.
Rik <rik@octave.org>
parents:
16808
diff
changeset
|
1198 @DOCSTRING(copyobj) |
81e041f5633a
doc: Add copyobj, struct2hdl, hdl2struct to manual.
Rik <rik@octave.org>
parents:
16808
diff
changeset
|
1199 |
6888 | 1200 @node Graphics Object Properties |
1201 @subsection Graphics Object Properties | |
1202 @cindex graphics object properties | |
1203 | |
1204 @menu | |
9676 | 1205 * Root Figure Properties:: |
1206 * Figure Properties:: | |
1207 * Axes Properties:: | |
1208 * Line Properties:: | |
1209 * Text Properties:: | |
1210 * Image Properties:: | |
1211 * Patch Properties:: | |
1212 * Surface Properties:: | |
6888 | 1213 @end menu |
1214 | |
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
1215 In this Section the object properties are discussed in detail, starting |
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
1216 with the root figure properties and continuing through the graphics object |
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
1217 hierarchy. |
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
1218 |
6888 | 1219 @node Root Figure Properties |
1220 @subsubsection Root Figure Properties | |
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
1221 @cindex root figure properties |
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
1222 |
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
1223 The @code{root figure} properties are: |
14853
72b8b39e12be
doc: Periodic grammarcheck of documentation.
Rik <octave@nomad.inbox5.com>
parents:
14577
diff
changeset
|
1224 |
6888 | 1225 @table @code |
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
1226 @item __modified__ |
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
1227 --- Values: "on," "off" |
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
1228 |
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
1229 @item __myhandle__ |
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
1230 |
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
1231 @item beingdeleted |
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
1232 --- Values: "on," "off" |
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
1233 |
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
1234 @item busyaction |
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
1235 |
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
1236 @item buttondownfcn |
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
1237 |
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
1238 @item callbackobject |
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
1239 |
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
1240 @item children |
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
1241 |
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
1242 @item clipping |
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
1243 --- Values: "on," "off" |
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
1244 |
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
1245 @item createfcn |
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
1246 |
6888 | 1247 @item currentfigure |
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
1248 |
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
1249 @item deletefcn |
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
1250 |
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
1251 @item handlevisibility |
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
1252 --- Values: "on," "off" |
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
1253 |
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
1254 @item hittest |
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
1255 --- Values: "on," "off" |
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
1256 |
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
1257 @item interruptible |
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
1258 --- Values: "on," "off" |
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
1259 |
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
1260 @item parent |
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
1261 |
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
1262 @item screendepth |
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
1263 |
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
1264 @item screenpixelsperinch |
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
1265 |
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
1266 @item screensize |
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
1267 |
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
1268 @item selected |
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
1269 |
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
1270 @item selectionhighlight |
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
1271 |
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
1272 @item screendepth |
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
1273 |
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
1274 @item screenpixelsperinch |
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
1275 |
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
1276 @item showhiddenhandles |
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
1277 --- Values: "on," "off" |
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
1278 |
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
1279 @item tag |
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
1280 |
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
1281 @item type |
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
1282 |
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
1283 @item uicontextmenu |
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
1284 |
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
1285 @item units |
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
1286 |
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
1287 @item userdata |
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
1288 |
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
1289 @item visible |
6888 | 1290 @end table |
1291 | |
6889 | 1292 @node Figure Properties |
1293 @subsubsection Figure Properties | |
8071 | 1294 @cindex figure properties |
6888 | 1295 |
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
1296 The @code{figure} properties are: |
14853
72b8b39e12be
doc: Periodic grammarcheck of documentation.
Rik <octave@nomad.inbox5.com>
parents:
14577
diff
changeset
|
1297 |
6888 | 1298 @table @code |
11576
8ac9687dbe9f
rename backend to graphics_toolkit
John W. Eaton <jwe@octave.org>
parents:
11573
diff
changeset
|
1299 @item __graphics_toolkit__ |
8ac9687dbe9f
rename backend to graphics_toolkit
John W. Eaton <jwe@octave.org>
parents:
11573
diff
changeset
|
1300 --- The graphics toolkit currently in use. |
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
1301 |
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
1302 @item __enhanced__ |
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
1303 |
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
1304 @item __modified__ |
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
1305 |
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
1306 @item __myhandle__ |
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
1307 |
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
1308 @item __plot_stream__ |
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
1309 |
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
1310 @item alphamap |
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
1311 |
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
1312 @item beingdeleted |
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
1313 --- Values: "on," "off" |
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
1314 |
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
1315 @item busyaction |
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
1316 |
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
1317 @item buttondownfcn |
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
1318 |
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
1319 @item children |
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
1320 Handle to children. |
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
1321 |
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
1322 @item clipping |
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
1323 --- Values: "on," "off" |
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
1324 |
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
1325 @item closerequestfcn |
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
1326 --- Handle of function to call on close. |
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
1327 |
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
1328 @item color |
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
1329 |
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
1330 @item colormap |
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
1331 An N-by-3 matrix containing the color map for the current axes. |
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
1332 |
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
1333 @item paperorientation |
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
1334 |
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
1335 @item createfcn |
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
1336 |
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
1337 @item currentaxes |
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
1338 Handle to graphics object of current axes. |
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
1339 |
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
1340 @item currentcharacter |
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
1341 |
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
1342 @item currentobject |
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
1343 |
10522
6538ff562949
document keypress and mouse callback properties
Shai Ayal <shaiay@users.sourceforge.net>
parents:
9758
diff
changeset
|
1344 @item currentpoint |
6538ff562949
document keypress and mouse callback properties
Shai Ayal <shaiay@users.sourceforge.net>
parents:
9758
diff
changeset
|
1345 Holds the coordinates of the point over which the mouse pointer was when |
10711
fbd7843974fa
Periodic grammar check of documentation files to ensure common format.
Rik <octave@nomad.inbox5.com>
parents:
10599
diff
changeset
|
1346 the mouse button was pressed. If a mouse callback function is defined, |
10522
6538ff562949
document keypress and mouse callback properties
Shai Ayal <shaiay@users.sourceforge.net>
parents:
9758
diff
changeset
|
1347 @code{"currentpoint"} holds the coordinates of the point over which the |
6538ff562949
document keypress and mouse callback properties
Shai Ayal <shaiay@users.sourceforge.net>
parents:
9758
diff
changeset
|
1348 mouse pointer is when the function gets called. |
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
1349 |
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
1350 @item deletefcn |
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
1351 |
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
1352 @item dockcontrols |
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
1353 --- Values: "on," "off" |
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
1354 |
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
1355 @item doublebuffer |
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
1356 --- Values: "on," "off" |
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
1357 |
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
1358 @item filename |
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
1359 |
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
1360 @item handlevisibility |
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
1361 --- Values: "on," "off" |
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
1362 |
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
1363 @item hittest |
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
1364 |
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
1365 @item integerhandle |
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
1366 |
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
1367 @item interruptible |
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
1368 --- Values: "on," "off" |
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
1369 |
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
1370 @item inverthardcopy |
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
1371 |
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
1372 @item keypressfcn |
10522
6538ff562949
document keypress and mouse callback properties
Shai Ayal <shaiay@users.sourceforge.net>
parents:
9758
diff
changeset
|
1373 see @code{"keypressfcn"} |
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
1374 |
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
1375 @item keyreleasefcn |
10711
fbd7843974fa
Periodic grammar check of documentation files to ensure common format.
Rik <octave@nomad.inbox5.com>
parents:
10599
diff
changeset
|
1376 With @code{"keypressfcn"}, The keyboard callback functions. These |
10522
6538ff562949
document keypress and mouse callback properties
Shai Ayal <shaiay@users.sourceforge.net>
parents:
9758
diff
changeset
|
1377 callback functions get called when a key is pressed/released |
10711
fbd7843974fa
Periodic grammar check of documentation files to ensure common format.
Rik <octave@nomad.inbox5.com>
parents:
10599
diff
changeset
|
1378 respectively. The functions are called with two input arguments. The |
fbd7843974fa
Periodic grammar check of documentation files to ensure common format.
Rik <octave@nomad.inbox5.com>
parents:
10599
diff
changeset
|
1379 first argument holds the handle of the calling figure. The second |
10522
6538ff562949
document keypress and mouse callback properties
Shai Ayal <shaiay@users.sourceforge.net>
parents:
9758
diff
changeset
|
1380 argument holds the event structure which has the following members: |
14853
72b8b39e12be
doc: Periodic grammarcheck of documentation.
Rik <octave@nomad.inbox5.com>
parents:
14577
diff
changeset
|
1381 |
10522
6538ff562949
document keypress and mouse callback properties
Shai Ayal <shaiay@users.sourceforge.net>
parents:
9758
diff
changeset
|
1382 @table @code |
6538ff562949
document keypress and mouse callback properties
Shai Ayal <shaiay@users.sourceforge.net>
parents:
9758
diff
changeset
|
1383 @item Character |
6538ff562949
document keypress and mouse callback properties
Shai Ayal <shaiay@users.sourceforge.net>
parents:
9758
diff
changeset
|
1384 The ASCII value of the key |
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
1385 |
10522
6538ff562949
document keypress and mouse callback properties
Shai Ayal <shaiay@users.sourceforge.net>
parents:
9758
diff
changeset
|
1386 @item Key |
6538ff562949
document keypress and mouse callback properties
Shai Ayal <shaiay@users.sourceforge.net>
parents:
9758
diff
changeset
|
1387 lowercase value of the key |
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
1388 |
10522
6538ff562949
document keypress and mouse callback properties
Shai Ayal <shaiay@users.sourceforge.net>
parents:
9758
diff
changeset
|
1389 @item Modifier |
6538ff562949
document keypress and mouse callback properties
Shai Ayal <shaiay@users.sourceforge.net>
parents:
9758
diff
changeset
|
1390 A cell array containing strings representing the modifiers pressed with |
10711
fbd7843974fa
Periodic grammar check of documentation files to ensure common format.
Rik <octave@nomad.inbox5.com>
parents:
10599
diff
changeset
|
1391 the key. Possible values are @code{"shift"}, @code{"alt"}, and |
10522
6538ff562949
document keypress and mouse callback properties
Shai Ayal <shaiay@users.sourceforge.net>
parents:
9758
diff
changeset
|
1392 @code{"control"}. |
6538ff562949
document keypress and mouse callback properties
Shai Ayal <shaiay@users.sourceforge.net>
parents:
9758
diff
changeset
|
1393 @end table |
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
1394 |
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
1395 @item menubar |
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
1396 |
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
1397 @item mincolormap |
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
1398 |
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
1399 @item name |
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
1400 |
6888 | 1401 @item nextplot |
6889 | 1402 May be one of |
14853
72b8b39e12be
doc: Periodic grammarcheck of documentation.
Rik <octave@nomad.inbox5.com>
parents:
14577
diff
changeset
|
1403 |
6889 | 1404 @table @code |
1405 @item "new" | |
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
1406 |
6889 | 1407 @item "add" |
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
1408 |
6889 | 1409 @item "replace" |
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
1410 |
6889 | 1411 @item "replacechildren" |
1412 @end table | |
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
1413 |
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
1414 @item numbertitle |
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
1415 |
6888 | 1416 @item paperorientation |
6889 | 1417 Indicates the orientation for printing. Either @code{"landscape"} or |
1418 @code{"portrait"}. | |
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
1419 |
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
1420 @item paperposition |
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
1421 |
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
1422 @item paperpositionmode |
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
1423 |
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
1424 @item papersize |
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
1425 |
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
1426 @item papertype |
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
1427 |
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
1428 @item paperunits |
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
1429 |
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
1430 @item pointer |
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
1431 |
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
1432 @item pointershapecdata |
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
1433 |
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
1434 @item pointershapehotspot |
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
1435 |
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
1436 @item position |
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
1437 |
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
1438 @item renderer |
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
1439 |
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
1440 @item renderermode |
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
1441 |
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
1442 @item resize |
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
1443 |
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
1444 @item resizefcn |
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
1445 |
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
1446 @item selected |
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
1447 |
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
1448 @item selectionhighlight |
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
1449 --- Values: "on," "off" |
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
1450 |
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
1451 @item selectiontype |
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
1452 |
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
1453 @item tag |
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
1454 |
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
1455 @item toolbar |
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
1456 |
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
1457 @item type |
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
1458 |
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
1459 @item units |
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
1460 |
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
1461 @item userdata |
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
1462 |
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
1463 @item visible |
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
1464 Either @code{"on"} or @code{"off"} to toggle display of the figure. |
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
1465 |
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
1466 @item windowbuttondownfcn |
10522
6538ff562949
document keypress and mouse callback properties
Shai Ayal <shaiay@users.sourceforge.net>
parents:
9758
diff
changeset
|
1467 See @code{"windowbuttonupfcn"} |
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
1468 |
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
1469 @item windowbuttonmotionfcn |
10522
6538ff562949
document keypress and mouse callback properties
Shai Ayal <shaiay@users.sourceforge.net>
parents:
9758
diff
changeset
|
1470 See @code{"windowbuttonupfcn"} |
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
1471 |
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
1472 @item windowbuttonupfcn |
10522
6538ff562949
document keypress and mouse callback properties
Shai Ayal <shaiay@users.sourceforge.net>
parents:
9758
diff
changeset
|
1473 With @code{"windowbuttondownfcn"} and @code{"windowbuttonmotionfcn"}, |
10711
fbd7843974fa
Periodic grammar check of documentation files to ensure common format.
Rik <octave@nomad.inbox5.com>
parents:
10599
diff
changeset
|
1474 The mouse callback functions. These callback functions get called when |
fbd7843974fa
Periodic grammar check of documentation files to ensure common format.
Rik <octave@nomad.inbox5.com>
parents:
10599
diff
changeset
|
1475 the mouse button is pressed, dragged, and released respectively. When |
10522
6538ff562949
document keypress and mouse callback properties
Shai Ayal <shaiay@users.sourceforge.net>
parents:
9758
diff
changeset
|
1476 these callback functions are called, the @code{"currentpoint"} property |
6538ff562949
document keypress and mouse callback properties
Shai Ayal <shaiay@users.sourceforge.net>
parents:
9758
diff
changeset
|
1477 holds the current coordinates of the cursor. |
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
1478 |
17099
a033fd3669c0
Alphabetize graphic properties and add properties missing from Matlab.
Rik <rik@octave.org>
parents:
17097
diff
changeset
|
1479 @item windowscrollwheelfcn |
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
1480 |
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
1481 @item windowstyle |
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
1482 |
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
1483 @item wvisual |
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
1484 |
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
1485 @item wvisualmode |
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
1486 |
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
1487 @item xdisplay |
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
1488 |
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
1489 @item xvisual |
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
1490 |
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
1491 @item xvisualmode |
6888 | 1492 @end table |
1493 | |
1494 @node Axes Properties | |
1495 @subsubsection Axes Properties | |
8071 | 1496 @cindex axes properties |
6888 | 1497 |
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
1498 The @code{axes} properties are: |
14853
72b8b39e12be
doc: Periodic grammarcheck of documentation.
Rik <octave@nomad.inbox5.com>
parents:
14577
diff
changeset
|
1499 |
6888 | 1500 @table @code |
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
1501 @item __modified__ |
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
1502 |
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
1503 @item __myhandle__ |
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
1504 |
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
1505 @item activepositionproperty |
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
1506 |
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
1507 @item alim |
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
1508 |
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
1509 @item alimmode |
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
1510 |
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
1511 @item ambientlightcolor |
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
1512 |
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
1513 @item beingdeleted |
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
1514 |
6888 | 1515 @item box |
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
1516 Box surrounding axes. |
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
1517 --- Values: "on," "off" |
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
1518 |
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
1519 @item busyaction |
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
1520 |
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
1521 @item buttondownfcn |
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
1522 |
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
1523 @item cameraposition |
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
1524 |
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
1525 @item camerapositionmode |
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
1526 |
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
1527 @item cameratarget |
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
1528 |
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
1529 @item cameratargetmode |
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
1530 |
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
1531 @item cameraupvector |
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
1532 |
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
1533 @item cameraupvectormode |
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
1534 |
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
1535 @item cameraviewangle |
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
1536 |
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
1537 @item cameraviewanglemode |
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
1538 |
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
1539 @item children |
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
1540 |
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
1541 @item clim |
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
1542 Two-element vector defining the limits for the c axis of |
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
1543 an image. See @code{pcolor} property. |
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
1544 Setting this property also forces the corresponding mode |
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
1545 property to be set to @code{"manual"}. |
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
1546 |
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
1547 @item climmode |
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
1548 Either @code{"manual"} or @code{"auto"}. |
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
1549 |
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
1550 @item clipping |
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
1551 |
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
1552 @item color |
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
1553 |
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
1554 @item colororder |
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
1555 |
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
1556 @item createfcn |
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
1557 |
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
1558 @item currentpoint |
10522
6538ff562949
document keypress and mouse callback properties
Shai Ayal <shaiay@users.sourceforge.net>
parents:
9758
diff
changeset
|
1559 Holds the coordinates of the point over which the mouse pointer was when |
10711
fbd7843974fa
Periodic grammar check of documentation files to ensure common format.
Rik <octave@nomad.inbox5.com>
parents:
10599
diff
changeset
|
1560 the mouse button was pressed. If a mouse callback function is defined, |
10522
6538ff562949
document keypress and mouse callback properties
Shai Ayal <shaiay@users.sourceforge.net>
parents:
9758
diff
changeset
|
1561 @code{"currentpoint"} holds the coordinates of the point over which the |
6538ff562949
document keypress and mouse callback properties
Shai Ayal <shaiay@users.sourceforge.net>
parents:
9758
diff
changeset
|
1562 mouse pointer is when the function gets called. |
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
1563 |
6888 | 1564 @item dataaspectratio |
6889 | 1565 A two-element vector specifying the relative height and width of the |
1566 data displayed in the axes. Setting @code{dataaspectratio} to @samp{1, | |
9209
923c7cb7f13f
Simplify TeXinfo files by eliminating redundant @iftex followed by @tex construction.
Rik <rdrider0-list@yahoo.com>
parents:
9088
diff
changeset
|
1567 2]} causes the length of one unit as displayed on the y-axis to be the |
923c7cb7f13f
Simplify TeXinfo files by eliminating redundant @iftex followed by @tex construction.
Rik <rdrider0-list@yahoo.com>
parents:
9088
diff
changeset
|
1568 same as the length of 2 units on the x-axis. Setting |
6889 | 1569 @code{dataaspectratio} also forces the @code{dataaspectratiomode} |
1570 property to be set to @code{"manual"}. | |
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
1571 |
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
1572 @item dataaspectratiomode |
6889 | 1573 Either @code{"manual"} or @code{"auto"}. |
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
1574 |
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
1575 @item deletefcn |
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
1576 |
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
1577 @item drawmode |
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
1578 |
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
1579 @item fontangle |
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
1580 |
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
1581 @item fontname |
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
1582 |
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
1583 @item fontsize |
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
1584 |
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
1585 @item fontunits |
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
1586 |
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
1587 @item fontweight |
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
1588 |
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
1589 @item gridlinestyle |
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
1590 |
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
1591 @item handlevisibility |
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
1592 |
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
1593 @item hittest |
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
1594 |
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
1595 @item interpreter |
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
1596 |
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
1597 @item interruptible |
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
1598 |
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
1599 @item layer |
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
1600 |
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
1601 @item linestyleorder |
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
1602 |
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
1603 @item linewidth |
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
1604 |
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
1605 @item minorgridlinestyle |
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
1606 |
6888 | 1607 @item nextplot |
6889 | 1608 May be one of |
14853
72b8b39e12be
doc: Periodic grammarcheck of documentation.
Rik <octave@nomad.inbox5.com>
parents:
14577
diff
changeset
|
1609 |
6889 | 1610 @table @code |
1611 @item "new" | |
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
1612 |
6889 | 1613 @item "add" |
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
1614 |
6889 | 1615 @item "replace" |
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
1616 |
6889 | 1617 @item "replacechildren" |
1618 @end table | |
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
1619 |
6888 | 1620 @item outerposition |
8071 | 1621 A vector specifying the position of the plot, including titles, axes and |
1622 legend. The four elements of the vector are the coordinates of the | |
1623 lower left corner and width and height of the plot, in units normalized | |
1624 to the width and height of the plot window. For example, @code{[0.2, | |
1625 0.3, 0.4, 0.5]} sets the lower left corner of the axes at @math{(0.2, | |
1626 0.3)} and the width and height to be 0.4 and 0.5 respectively. See also | |
1627 the @code{position} property. | |
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
1628 |
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
1629 @item parent |
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
1630 |
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
1631 @item plotboxaspectratio |
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
1632 |
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
1633 @item plotboxaspectratiomode |
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
1634 |
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
1635 @item position |
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
1636 A vector specifying the position of the plot, excluding titles, axes and |
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
1637 legend. The four elements of the vector are the coordinates of the |
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
1638 lower left corner and width and height of the plot, in units normalized |
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
1639 to the width and height of the plot window. For example, @code{[0.2, |
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
1640 0.3, 0.4, 0.5]} sets the lower left corner of the axes at @math{(0.2, |
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
1641 0.3)} and the width and height to be 0.4 and 0.5 respectively. See also |
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
1642 the @code{outerposition} property. |
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
1643 |
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
1644 @item projection |
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
1645 |
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
1646 @item selected |
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
1647 |
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
1648 @item selectionhighlight |
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
1649 |
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
1650 @item tag |
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
1651 |
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
1652 @item tickdir |
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
1653 |
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
1654 @item tickdirmode |
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
1655 |
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
1656 @item ticklength |
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
1657 |
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
1658 @item tightinset |
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
1659 |
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
1660 @item title |
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
1661 Index of text object for the axes title. |
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
1662 |
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
1663 @item type |
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
1664 |
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
1665 @item uicontextmenu |
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
1666 |
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
1667 @item units |
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
1668 |
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
1669 @item userdata |
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
1670 |
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
1671 @item view |
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
1672 A three element vector specifying the view point for three-dimensional plots. |
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
1673 |
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
1674 @item visible |
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
1675 Either @code{"on"} or @code{"off"} to toggle display of the axes. |
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
1676 |
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
1677 @item x_normrendertransform |
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
1678 |
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
1679 @item x_projectiontransform |
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
1680 |
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
1681 @item x_rendertransform |
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
1682 |
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
1683 @item x_viewporttransform |
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
1684 |
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
1685 @item x_viewtransform |
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
1686 |
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
1687 @item xaxislocation |
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
1688 Either @code{"top"} or @code{"bottom"}. |
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
1689 |
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
1690 @item xcolor |
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
1691 |
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
1692 @item xdir |
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
1693 Either @code{"forward"} or @code{"reverse"}. |
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
1694 |
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
1695 @item xgrid |
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
1696 Either @code{"on"} or @code{"off"} to toggle display of grid lines. |
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
1697 |
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
1698 @item xlabel |
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
1699 Indices to text objects for the axes labels. |
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
1700 |
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
1701 @item xlim |
9758
09da0bd91412
Periodic grammar check of Octave documentation files to ensure common format
Rik <rdrider0-list@yahoo.com>
parents:
9752
diff
changeset
|
1702 Two-element vector defining the limits for the x-axis. |
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
1703 Setting this property also forces the corresponding mode |
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
1704 property to be set to @code{"manual"}. |
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
1705 |
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
1706 @item xlimmode |
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
1707 Either @code{"manual"} or @code{"auto"}. |
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
1708 |
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
1709 @item xminorgrid |
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
1710 Either @code{"on"} or @code{"off"} to toggle display of minor grid lines. |
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
1711 |
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
1712 @item xminortick |
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
1713 |
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
1714 @item xscale |
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
1715 Either @code{"linear"} or @code{"log"}. |
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
1716 |
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
1717 @item xtick |
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
1718 Set position of tick marks. |
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
1719 Setting this property also forces the corresponding mode |
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
1720 property to be set to @code{"manual"}. |
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
1721 |
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
1722 @item xticklabel |
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
1723 Setting this property also forces the corresponding mode |
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
1724 property to be set to @code{"manual"}. |
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
1725 |
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
1726 @item xticklabelmode |
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
1727 Either @code{"manual"} or @code{"auto"}. |
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
1728 |
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
1729 @item xtickmode |
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
1730 Either @code{"manual"} or @code{"auto"}. |
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
1731 |
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
1732 @item yaxislocation |
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
1733 Either @code{"left"} or @code{"right"} |
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
1734 |
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
1735 @item ycolor |
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
1736 |
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
1737 @item ydir |
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
1738 Either @code{"forward"} or @code{"reverse"}. |
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
1739 |
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
1740 @item ygrid |
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
1741 Either @code{"on"} or @code{"off"} to toggle display of grid lines. |
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
1742 |
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
1743 @item ylabel |
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
1744 Indices to text objects for the axes labels. |
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
1745 |
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
1746 @item ylim |
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
1747 Two-element vectors defining the limits for the x, y, and z axes and the |
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
1748 Setting one of these properties also forces the corresponding mode |
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
1749 property to be set to @code{"manual"}. |
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
1750 |
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
1751 @item ylimmode |
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
1752 Either @code{"manual"} or @code{"auto"}. |
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
1753 |
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
1754 @item yminorgrid |
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
1755 Either @code{"on"} or @code{"off"} to toggle display of minor grid lines. |
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
1756 |
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
1757 @item yminortick |
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
1758 |
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
1759 @item yscale |
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
1760 Either @code{"linear"} or @code{"log"}. |
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
1761 |
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
1762 @item ytick |
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
1763 Set position of tick marks. |
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
1764 Setting this property also forces the corresponding mode |
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
1765 property to be set to @code{"manual"}. |
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
1766 |
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
1767 @item yticklabel |
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
1768 Setting this property also forces the corresponding mode |
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
1769 property to be set to @code{"manual"}. |
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
1770 |
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
1771 @item yticklabelmode |
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
1772 Either @code{"manual"} or @code{"auto"}. |
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
1773 |
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
1774 @item ytickmode |
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
1775 Either @code{"manual"} or @code{"auto"}. |
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
1776 |
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
1777 @item zcolor |
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
1778 |
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
1779 @item zdir |
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
1780 Either @code{"forward"} or @code{"reverse"}. |
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
1781 |
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
1782 @item zgrid |
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
1783 Either @code{"on"} or @code{"off"} to toggle display of grid lines. |
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
1784 |
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
1785 @item zlabel |
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
1786 Indices to text objects for the axes labels. |
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
1787 |
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
1788 @item zlim |
9758
09da0bd91412
Periodic grammar check of Octave documentation files to ensure common format
Rik <rdrider0-list@yahoo.com>
parents:
9752
diff
changeset
|
1789 Two-element vector defining the limits for z-axis. |
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
1790 Setting this property also forces the corresponding mode |
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
1791 property to be set to @code{"manual"}. |
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
1792 |
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
1793 @item zlimmode |
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
1794 Either @code{"manual"} or @code{"auto"}. |
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
1795 |
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
1796 @item zminorgrid |
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
1797 Either @code{"on"} or @code{"off"} to toggle display of minor grid lines. |
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
1798 |
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
1799 @item zminortick |
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
1800 |
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
1801 @item zscale |
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
1802 Either @code{"linear"} or @code{"log"}. |
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
1803 |
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
1804 @item ztick |
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
1805 Set position of tick marks. |
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
1806 Setting this property also forces the corresponding mode |
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
1807 property to be set to @code{"manual"}. |
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
1808 |
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
1809 @item zticklabel |
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
1810 Setting this property also forces the corresponding mode |
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
1811 property to be set to @code{"manual"}. |
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
1812 |
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
1813 @item zticklabelmode |
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
1814 Either @code{"manual"} or @code{"auto"}. |
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
1815 |
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
1816 @item ztickmode |
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
1817 Either @code{"manual"} or @code{"auto"}. |
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
1818 |
6888 | 1819 @end table |
1820 | |
1821 @node Line Properties | |
1822 @subsubsection Line Properties | |
8071 | 1823 @cindex line properties |
6888 | 1824 |
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
1825 The @code{line} properties are: |
14853
72b8b39e12be
doc: Periodic grammarcheck of documentation.
Rik <octave@nomad.inbox5.com>
parents:
14577
diff
changeset
|
1826 |
6888 | 1827 @table @code |
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
1828 @item __modified__ |
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
1829 |
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
1830 @item __myhandle__ |
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
1831 |
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
1832 @item beingdeleted |
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
1833 |
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
1834 @item busyaction |
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
1835 |
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
1836 @item buttondownfcn |
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
1837 |
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
1838 @item children |
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
1839 |
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
1840 @item clipping |
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
1841 |
6888 | 1842 @item color |
6889 | 1843 The RGB color of the line, or a color name. @xref{Colors}. |
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
1844 |
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
1845 @item createfcn |
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
1846 |
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
1847 @item deletefcn |
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
1848 |
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
1849 @item displayname |
13947
8ebff542d133
doc: Remove obsolete "keylabel" and replace by "displayname".
Ben Abbott <bpabbott@mac.com>
parents:
13931
diff
changeset
|
1850 The text of the legend entry corresponding to this line. |
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
1851 |
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
1852 @item erasemode |
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
1853 |
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
1854 @item handlevisibility |
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
1855 |
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
1856 @item hittest |
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
1857 |
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
1858 @item interpreter |
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
1859 |
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
1860 @item interruptible |
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
1861 |
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
1862 @item ldata |
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
1863 The lower errorbar in the y direction to be plotted. |
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
1864 |
17097
e7a059a9a644
doc: Use XREF as anchor prefix in documentation for clearer results in Info viewer.
Rik <rik@octave.org>
parents:
16923
diff
changeset
|
1865 @item linestyle |
6889 | 1866 @itemx linewidth |
1867 @xref{Line Styles}. | |
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
1868 |
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
1869 @item linewidth |
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
1870 |
6888 | 1871 @item marker |
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
1872 |
6888 | 1873 @item markeredgecolor |
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
1874 |
6888 | 1875 @item markerfacecolor |
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
1876 |
6888 | 1877 @item markersize |
6889 | 1878 @xref{Marker Styles}. |
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
1879 |
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
1880 @item parent |
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
1881 |
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
1882 @item selected |
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
1883 |
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
1884 @item selectionhighlight |
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
1885 |
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
1886 @item tag |
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
1887 |
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
1888 @item type |
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
1889 |
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
1890 @item udata |
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
1891 The upper errorbar in the y direction to be plotted. |
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
1892 |
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
1893 @item uicontextmenu |
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
1894 |
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
1895 @item userdata |
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
1896 |
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
1897 @item visible |
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
1898 |
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
1899 @item xdata |
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
1900 The data to be plotted. |
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
1901 |
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
1902 @item xdatasource |
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
1903 |
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
1904 @item xldata |
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
1905 The lower errorbar to be plotted. |
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
1906 |
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
1907 @item xlim |
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
1908 |
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
1909 @item xliminclude |
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
1910 |
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
1911 @item xudata |
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
1912 The upper errorbar to be plotted. |
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
1913 |
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
1914 @item ydata |
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
1915 The data to be plotted. |
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
1916 |
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
1917 @item ydatasource |
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
1918 |
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
1919 @item ylim |
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
1920 |
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
1921 @item yliminclude |
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
1922 |
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
1923 @item zdata |
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
1924 The data to be plotted. |
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
1925 |
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
1926 @item zdatasource |
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
1927 |
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
1928 @item zlim |
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
1929 |
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
1930 @item zliminclude |
6888 | 1931 @end table |
1932 | |
1933 @node Text Properties | |
1934 @subsubsection Text Properties | |
8071 | 1935 @cindex text properties |
6888 | 1936 |
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
1937 The @code{text} properties are: |
14853
72b8b39e12be
doc: Periodic grammarcheck of documentation.
Rik <octave@nomad.inbox5.com>
parents:
14577
diff
changeset
|
1938 |
6888 | 1939 @table @code |
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
1940 @item __modified__ |
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
1941 |
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
1942 @item __myhandle__ |
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
1943 |
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
1944 @item backgroundcolor |
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
1945 |
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
1946 @item beingdeleted |
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
1947 |
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
1948 @item busyaction |
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
1949 |
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
1950 @item buttondownfcn |
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
1951 |
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
1952 @item children |
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
1953 |
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
1954 @item clipping |
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
1955 |
6888 | 1956 @item color |
6889 | 1957 The color of the text. @xref{Colors}. |
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
1958 |
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
1959 @item createfcn |
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
1960 |
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
1961 @item deletefcn |
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
1962 |
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
1963 @item displayname |
13947
8ebff542d133
doc: Remove obsolete "keylabel" and replace by "displayname".
Ben Abbott <bpabbott@mac.com>
parents:
13931
diff
changeset
|
1964 The text of the legend entry corresponding to this line. |
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
1965 |
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
1966 @item edgecolor |
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
1967 |
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
1968 @item editing |
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
1969 |
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
1970 @item erasemode |
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
1971 |
7189 | 1972 @item fontangle |
9040
dbd0c77e575e
Cleanup documentation file plot.texi
Rik <rdrider0-list@yahoo.com>
parents:
9032
diff
changeset
|
1973 Flag whether the font is italic or normal. Valid values are 'normal', |
7189 | 1974 'italic' and 'oblique'. |
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
1975 |
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
1976 @item fontname |
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
1977 The font used for the text. |
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
1978 |
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
1979 @item fontsize |
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
1980 The size of the font, in points to use. |
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
1981 |
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
1982 @item fontunits |
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
1983 |
7189 | 1984 @item fontweight |
9040
dbd0c77e575e
Cleanup documentation file plot.texi
Rik <rdrider0-list@yahoo.com>
parents:
9032
diff
changeset
|
1985 Flag whether the font is bold, etc. Valid values are 'normal', 'bold', |
7189 | 1986 'demi' or 'light'. |
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
1987 |
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
1988 @item handlevisibility |
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
1989 |
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
1990 @item hittest |
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
1991 |
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
1992 @item horizontalalignment |
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
1993 May be @code{"left"}, @code{"center"}, or @code{"right"}. |
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
1994 |
7189 | 1995 @item interpreter |
9040
dbd0c77e575e
Cleanup documentation file plot.texi
Rik <rdrider0-list@yahoo.com>
parents:
9032
diff
changeset
|
1996 Determines how the text is rendered. Valid values are 'none', 'tex' or |
7189 | 1997 'latex'. |
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
1998 |
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
1999 @item interruptible |
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
2000 |
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
2001 @item linestyle |
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
2002 |
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
2003 @item linewidth |
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
2004 |
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
2005 @item margin |
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
2006 |
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
2007 @item parent |
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
2008 |
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
2009 @item position |
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
2010 The coordinates of the text object. |
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
2011 |
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
2012 @item rotation |
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
2013 The angle of rotation for the displayed text, measured in degrees. |
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
2014 |
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
2015 @item selected |
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
2016 |
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
2017 @item selectionhighlight |
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
2018 |
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
2019 @item string |
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
2020 The character string contained by the text object. |
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
2021 |
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
2022 @item tag |
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
2023 |
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
2024 @item type |
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
2025 |
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
2026 @item uicontextmenu |
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
2027 |
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
2028 @item units |
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
2029 May be @code{"normalized"} or @code{"graph"}. |
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
2030 |
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
2031 @item userdata |
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
2032 |
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
2033 @item verticalalignment |
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
2034 |
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
2035 @item visible |
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
2036 |
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
2037 @item xlim |
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
2038 |
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
2039 @item xliminclude |
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
2040 |
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
2041 @item ylim |
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
2042 |
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
2043 @item yliminclude |
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
2044 |
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
2045 @item zlim |
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
2046 |
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
2047 @item zliminclude |
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
2048 |
6888 | 2049 @end table |
2050 | |
2051 @node Image Properties | |
2052 @subsubsection Image Properties | |
8071 | 2053 @cindex image properties |
6888 | 2054 |
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
2055 The @code{image} properties are: |
14853
72b8b39e12be
doc: Periodic grammarcheck of documentation.
Rik <octave@nomad.inbox5.com>
parents:
14577
diff
changeset
|
2056 |
6888 | 2057 @table @code |
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
2058 @item __modified__ |
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
2059 |
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
2060 @item __myhandle__ |
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
2061 |
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
2062 @item beingdeleted |
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
2063 |
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
2064 @item busyaction |
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
2065 |
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
2066 @item buttondownfcn |
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
2067 |
6888 | 2068 @item cdata |
6889 | 2069 The data for the image. Each pixel of the image corresponds to an |
2070 element of @code{cdata}. The value of an element of @code{cdata} | |
2071 specifies the row-index into the colormap of the axes object containing | |
2072 the image. The color value found in the color map for the given index | |
2073 determines the color of the pixel. | |
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
2074 |
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
2075 @item cdatamapping |
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
2076 |
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
2077 @item children |
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
2078 |
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
2079 @item clim |
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
2080 |
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
2081 @item climinclude |
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
2082 |
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
2083 @item clipping |
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
2084 |
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
2085 @item createfcn |
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
2086 |
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
2087 @item deletefcn |
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
2088 |
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
2089 @item handlevisibility |
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
2090 |
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
2091 @item hittest |
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
2092 |
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
2093 @item interruptible |
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
2094 |
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
2095 @item parent |
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
2096 |
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
2097 @item selected |
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
2098 |
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
2099 @item selectionhighlight |
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
2100 |
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
2101 @item tag |
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
2102 |
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
2103 @item type |
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
2104 |
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
2105 @item uicontextmenu |
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
2106 |
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
2107 @item userdata |
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
2108 |
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
2109 @item visible |
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
2110 |
6889 | 2111 @item xdata |
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
2112 Two-element vector specifying the range of the x-coordinates for |
6889 | 2113 the image. |
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
2114 |
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
2115 @item xlim |
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
2116 |
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
2117 @item xliminclude |
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
2118 |
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
2119 @item ydata |
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
2120 Two-element vector specifying the range of the y-coordinates for |
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
2121 the image. |
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
2122 |
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
2123 @item ylim |
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
2124 |
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
2125 @item yliminclude |
6888 | 2126 @end table |
2127 | |
2128 @node Patch Properties | |
2129 @subsubsection Patch Properties | |
8071 | 2130 @cindex patch properties |
6888 | 2131 |
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
2132 The @code{patch} properties are: |
14853
72b8b39e12be
doc: Periodic grammarcheck of documentation.
Rik <octave@nomad.inbox5.com>
parents:
14577
diff
changeset
|
2133 |
6888 | 2134 @table @code |
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
2135 @item __modified__ |
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
2136 |
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
2137 @item __myhandle__ |
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
2138 |
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
2139 @item alim |
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
2140 |
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
2141 @item aliminclude |
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
2142 |
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
2143 @item alphadatamapping |
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
2144 |
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
2145 @item ambientstrength |
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
2146 |
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
2147 @item backfacelighting |
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
2148 |
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
2149 @item beingdeleted |
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
2150 |
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
2151 @item busyaction |
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
2152 |
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
2153 @item buttondownfcn |
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
2154 |
6888 | 2155 @item cdata |
6889 | 2156 Data defining the patch object. |
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
2157 |
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
2158 @item cdatamapping |
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
2159 |
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
2160 @item children |
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
2161 |
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
2162 @item clim |
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
2163 |
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
2164 @item climinclude |
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
2165 |
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
2166 @item clipping |
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
2167 |
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
2168 @item createfcn |
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
2169 |
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
2170 @item deletefcn |
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
2171 |
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
2172 @item diffusestrength |
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
2173 |
13947
8ebff542d133
doc: Remove obsolete "keylabel" and replace by "displayname".
Ben Abbott <bpabbott@mac.com>
parents:
13931
diff
changeset
|
2174 @item displayname |
8ebff542d133
doc: Remove obsolete "keylabel" and replace by "displayname".
Ben Abbott <bpabbott@mac.com>
parents:
13931
diff
changeset
|
2175 The text of the legend entry corresponding to this line. |
8ebff542d133
doc: Remove obsolete "keylabel" and replace by "displayname".
Ben Abbott <bpabbott@mac.com>
parents:
13931
diff
changeset
|
2176 |
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
2177 @item edgealpha |
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
2178 |
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
2179 @item edgecolor |
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
2180 The color of the line defining the patch. @xref{Colors}. |
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
2181 |
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
2182 @item edgelighting |
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
2183 |
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
2184 @item erasemode |
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
2185 |
6888 | 2186 @item facealpha |
6889 | 2187 A number in the range [0, 1] indicating the transparency of the patch. |
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
2188 |
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
2189 @item facecolor |
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
2190 The fill color of the patch. @xref{Colors}. |
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
2191 |
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
2192 @item facelighting |
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
2193 |
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
2194 @item faces |
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
2195 |
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
2196 @item facevertexalphadata |
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
2197 |
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
2198 @item facevertexcdata |
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
2199 |
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
2200 @item handlevisibility |
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
2201 |
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
2202 @item hittest |
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
2203 |
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
2204 @item interpreter |
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
2205 |
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
2206 @item interruptible |
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
2207 |
6888 | 2208 @item linestyle |
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
2209 @xref{Line Styles}. |
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
2210 |
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
2211 @item linewidth |
6889 | 2212 @xref{Line Styles}. |
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
2213 |
6888 | 2214 @item marker |
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
2215 @xref{Marker Styles}. |
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
2216 |
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
2217 @item markeredgecolor |
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
2218 @xref{Marker Styles}. |
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
2219 |
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
2220 @item markerfacecolor |
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
2221 @xref{Marker Styles}. |
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
2222 |
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
2223 @item markersize |
6889 | 2224 @xref{Marker Styles}. |
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
2225 |
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
2226 @item normalmode |
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
2227 |
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
2228 @item parent |
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
2229 |
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
2230 @item selected |
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
2231 |
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
2232 @item selectionhighlight |
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
2233 |
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
2234 @item specularcolorreflectance |
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
2235 |
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
2236 @item specularexponent |
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
2237 |
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
2238 @item specularstrength |
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
2239 |
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
2240 @item tag |
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
2241 |
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
2242 @item type |
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
2243 |
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
2244 @item uicontextmenu |
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
2245 |
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
2246 @item userdata |
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
2247 |
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
2248 @item vertexnormals |
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
2249 |
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
2250 @item vertices |
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
2251 |
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
2252 @item visible |
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
2253 |
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
2254 @item xdata |
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
2255 Data defining the patch object. |
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
2256 |
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
2257 @item xlim |
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
2258 |
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
2259 @item xliminclude |
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
2260 |
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
2261 @item ydata |
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
2262 Data defining the patch object. |
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
2263 |
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
2264 @item ylim |
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
2265 |
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
2266 @item yliminclude |
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
2267 |
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
2268 @item zdata |
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
2269 Data defining the patch object. |
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
2270 |
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
2271 @item zlim |
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
2272 |
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
2273 @item zliminclude |
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
2274 |
6888 | 2275 @end table |
2276 | |
2277 @node Surface Properties | |
2278 @subsubsection Surface Properties | |
8071 | 2279 @cindex surface properties |
6888 | 2280 |
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
2281 The @code{surface} properties are: |
14853
72b8b39e12be
doc: Periodic grammarcheck of documentation.
Rik <octave@nomad.inbox5.com>
parents:
14577
diff
changeset
|
2282 |
6888 | 2283 @table @code |
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
2284 @item __modified__ |
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
2285 |
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
2286 @item __myhandle__ |
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
2287 |
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
2288 @item alim |
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
2289 |
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
2290 @item aliminclude |
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
2291 |
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
2292 @item alphadata |
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
2293 |
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
2294 @item alphadatamapping |
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
2295 |
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
2296 @item ambientstrength |
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
2297 |
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
2298 @item backfacelighting |
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
2299 |
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
2300 @item beingdeleted |
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
2301 |
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
2302 @item busyaction |
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
2303 |
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
2304 @item buttondownfcn |
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
2305 |
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
2306 @item cdata |
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
2307 |
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
2308 @item cdatamapping |
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
2309 |
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
2310 @item cdatasource |
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
2311 |
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
2312 @item children |
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
2313 |
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
2314 @item clim |
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
2315 |
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
2316 @item climinclude |
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
2317 |
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
2318 @item clipping |
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
2319 |
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
2320 @item createfcn |
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
2321 |
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
2322 @item deletefcn |
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
2323 |
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
2324 @item diffusestrength |
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
2325 |
13947
8ebff542d133
doc: Remove obsolete "keylabel" and replace by "displayname".
Ben Abbott <bpabbott@mac.com>
parents:
13931
diff
changeset
|
2326 @item displayname |
8ebff542d133
doc: Remove obsolete "keylabel" and replace by "displayname".
Ben Abbott <bpabbott@mac.com>
parents:
13931
diff
changeset
|
2327 The text of the legend entry corresponding to this surface. |
8ebff542d133
doc: Remove obsolete "keylabel" and replace by "displayname".
Ben Abbott <bpabbott@mac.com>
parents:
13931
diff
changeset
|
2328 |
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
2329 @item edgealpha |
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
2330 |
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
2331 @item edgecolor |
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
2332 |
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
2333 @item edgelighting |
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
2334 |
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
2335 @item erasemode |
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
2336 |
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
2337 @item facealpha |
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
2338 |
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
2339 @item facecolor |
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
2340 |
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
2341 @item facelighting |
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
2342 |
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
2343 @item handlevisibility |
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
2344 |
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
2345 @item hittest |
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
2346 |
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
2347 @item interpreter |
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
2348 |
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
2349 @item interruptible |
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
2350 |
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
2351 @item linestyle |
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
2352 |
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
2353 @item linewidth |
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
2354 |
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
2355 @item marker |
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
2356 |
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
2357 @item markeredgecolor |
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
2358 |
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
2359 @item markerfacecolor |
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
2360 |
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
2361 @item markersize |
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
2362 |
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
2363 @item meshstyle |
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
2364 |
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
2365 @item normalmode |
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
2366 |
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
2367 @item parent |
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
2368 |
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
2369 @item selected |
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
2370 |
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
2371 @item selectionhighlight |
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
2372 |
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
2373 @item specularcolorreflectance |
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
2374 |
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
2375 @item specularexponent |
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
2376 |
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
2377 @item specularstrength |
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
2378 |
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
2379 @item tag |
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
2380 |
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
2381 @item type |
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
2382 |
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
2383 @item uicontextmenu |
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
2384 |
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
2385 @item userdata |
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
2386 |
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
2387 @item vertexnormals |
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
2388 |
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
2389 @item visible |
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
2390 |
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
2391 @item xdata |
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
2392 The data determining the surface. The @code{xdata} and @code{ydata} |
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
2393 elements are vectors and @code{zdata} must be a matrix. |
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
2394 |
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
2395 @item xdatasource |
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
2396 |
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
2397 @item xlim |
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
2398 |
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
2399 @item xliminclude |
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
2400 |
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
2401 @item ydata |
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
2402 The data determining the surface. The @code{xdata} and @code{ydata} |
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
2403 elements are vectors and @code{zdata} must be a matrix. |
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
2404 |
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
2405 @item ydatasource |
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
2406 |
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
2407 @item ylim |
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
2408 |
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
2409 @item yliminclude |
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
2410 |
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
2411 @item zdata |
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
2412 The data determining the surface. The @code{xdata} and @code{ydata} |
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
2413 elements are vectors and @code{zdata} must be a matrix. |
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
2414 |
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
2415 @item zdatasource |
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
2416 |
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
2417 @item zlim |
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
2418 |
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
2419 @item zliminclude |
6889 | 2420 @end table |
2421 | |
8070
3b53b25e2550
Add data sources and line series
David Bateman <dbateman@free.fr>
parents:
8057
diff
changeset
|
2422 @node Searching Properties |
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
2423 @subsection Searching Properties |
7984
bbaa5d7d0143
Some documentation updates
David Bateman <dbateman@free.fr>
parents:
7981
diff
changeset
|
2424 |
bbaa5d7d0143
Some documentation updates
David Bateman <dbateman@free.fr>
parents:
7981
diff
changeset
|
2425 @DOCSTRING(findobj) |
bbaa5d7d0143
Some documentation updates
David Bateman <dbateman@free.fr>
parents:
7981
diff
changeset
|
2426 |
bbaa5d7d0143
Some documentation updates
David Bateman <dbateman@free.fr>
parents:
7981
diff
changeset
|
2427 @DOCSTRING(findall) |
6891 | 2428 @node Managing Default Properties |
2429 @subsection Managing Default Properties | |
8071 | 2430 @cindex default graphics properties |
2431 @cindex graphics properties, default | |
6891 | 2432 |
6892 | 2433 Object properties have two classes of default values, @dfn{factory |
2434 defaults} (the initial values) and @dfn{user-defined defaults}, which | |
2435 may override the factory defaults. | |
6891 | 2436 |
2437 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
|
2438 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
|
2439 For example, setting the default @code{color} property of @code{line} |
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
|
2440 objects to "green", for the @code{root} object, will result in all |
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
|
2441 @code{line} objects inheriting the @code{color} "green" as the default |
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
|
2442 value. |
6891 | 2443 |
2444 @example | |
2445 set (0, "defaultlinecolor", "green"); | |
2446 @end example | |
2447 | |
2448 @noindent | |
2449 sets the default line color for all objects. The rule for constructing | |
2450 the property name to set a default value is | |
2451 | |
2452 @example | |
2453 default + @var{object-type} + @var{property-name} | |
2454 @end example | |
2455 | |
2456 This rule can lead to some strange looking names, for example | |
2457 @code{defaultlinelinewidth"} specifies the default @code{linewidth} | |
2458 property for @code{line} objects. | |
2459 | |
2460 The example above used the root figure object, 0, so the default | |
2461 property value will apply to all line objects. However, default values | |
2462 are hierarchical, so defaults set in a figure objects override those | |
2463 set in the root figure object. Likewise, defaults set in axes objects | |
2464 override those set in figure or root figure objects. For example, | |
2465 | |
2466 @example | |
2467 @group | |
2468 subplot (2, 1, 1); | |
2469 set (0, "defaultlinecolor", "red"); | |
2470 set (1, "defaultlinecolor", "green"); | |
2471 set (gca (), "defaultlinecolor", "blue"); | |
2472 line (1:10, rand (1, 10)); | |
2473 subplot (2, 1, 2); | |
2474 line (1:10, rand (1, 10)); | |
2475 figure (2) | |
2476 line (1:10, rand (1, 10)); | |
2477 @end group | |
2478 @end example | |
2479 | |
2480 @noindent | |
2481 produces two figures. The line in first subplot window of the first | |
2482 figure is blue because it inherits its color from its parent axes | |
2483 object. The line in the second subplot window of the first figure is | |
2484 green because it inherits its color from its parent figure object. The | |
2485 line in the second figure window is red because it inherits its color | |
2486 from the global root figure parent object. | |
2487 | |
2488 To remove a user-defined default setting, set the default property to | |
2489 the value @code{"remove"}. For example, | |
2490 | |
2491 @example | |
2492 set (gca (), "defaultlinecolor", "remove"); | |
2493 @end example | |
2494 | |
2495 @noindent | |
2496 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
|
2497 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
|
2498 function. |
9558ca33648d
Add functions reset, whitebg to documentation.
Rik <octave@nomad.inbox5.com>
parents:
11591
diff
changeset
|
2499 |
9558ca33648d
Add functions reset, whitebg to documentation.
Rik <octave@nomad.inbox5.com>
parents:
11591
diff
changeset
|
2500 @DOCSTRING(reset) |
6891 | 2501 |
2502 Getting the @code{"default"} property of an object returns a list of | |
2503 user-defined defaults set for the object. For example, | |
2504 | |
2505 @example | |
2506 get (gca (), "default"); | |
2507 @end example | |
2508 | |
2509 @noindent | |
2510 returns a list of user-defined default values for the current axes | |
2511 object. | |
2512 | |
2513 Factory default values are stored in the root figure object. The | |
2514 command | |
2515 | |
2516 @example | |
2517 get (0, "factory"); | |
2518 @end example | |
2519 | |
2520 @noindent | |
2521 returns a list of factory defaults. | |
2522 | |
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
2523 @node Advanced Plotting |
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
2524 @section Advanced Plotting |
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
2525 |
12525
d36266a54202
Add getappdata, setappdata, isappdata, rmappdata functions to documentation.
Rik <octave@nomad.inbox5.com>
parents:
12522
diff
changeset
|
2526 |
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
2527 @menu |
9676 | 2528 * Colors:: |
2529 * Line Styles:: | |
2530 * Marker Styles:: | |
2531 * Callbacks:: | |
12525
d36266a54202
Add getappdata, setappdata, isappdata, rmappdata functions to documentation.
Rik <octave@nomad.inbox5.com>
parents:
12522
diff
changeset
|
2532 * Application-defined Data:: |
9676 | 2533 * Object Groups:: |
11576
8ac9687dbe9f
rename backend to graphics_toolkit
John W. Eaton <jwe@octave.org>
parents:
11573
diff
changeset
|
2534 * Graphics Toolkits:: |
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
2535 @end menu |
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
2536 |
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
2537 |
6889 | 2538 @node Colors |
2539 @subsection Colors | |
8071 | 2540 @cindex graphics colors |
2541 @cindex colors, graphics | |
6889 | 2542 |
2543 Colors may be specified as RGB triplets with values ranging from zero to | |
2544 one, or by name. Recognized color names include @code{"blue"}, | |
2545 @code{"black"}, @code{"cyan"}, @code{"green"}, @code{"magenta"}, | |
2546 @code{"red"}, @code{"white"}, and @code{"yellow"}. | |
2547 | |
2548 @node Line Styles | |
2549 @subsection Line Styles | |
8071 | 2550 @cindex line styles, graphics |
2551 @cindex graphics line styles | |
2552 | |
7001 | 2553 Line styles are specified by the following properties: |
6889 | 2554 |
2555 @table @code | |
2556 @item linestyle | |
2557 May be one of | |
14853
72b8b39e12be
doc: Periodic grammarcheck of documentation.
Rik <octave@nomad.inbox5.com>
parents:
14577
diff
changeset
|
2558 |
6889 | 2559 @table @code |
2560 @item "-" | |
12690
e9e35a707721
doc: Add 'none' to list of plot linestyles.
Rik <octave@nomad.inbox5.com>
parents:
12607
diff
changeset
|
2561 Solid line. [default] |
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
2562 |
6889 | 2563 @item "--" |
12690
e9e35a707721
doc: Add 'none' to list of plot linestyles.
Rik <octave@nomad.inbox5.com>
parents:
12607
diff
changeset
|
2564 Dashed line. |
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
2565 |
6889 | 2566 @item ":" |
12690
e9e35a707721
doc: Add 'none' to list of plot linestyles.
Rik <octave@nomad.inbox5.com>
parents:
12607
diff
changeset
|
2567 Dotted line. |
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
2568 |
6889 | 2569 @item "-." |
2570 A dash-dot line. | |
12690
e9e35a707721
doc: Add 'none' to list of plot linestyles.
Rik <octave@nomad.inbox5.com>
parents:
12607
diff
changeset
|
2571 |
e9e35a707721
doc: Add 'none' to list of plot linestyles.
Rik <octave@nomad.inbox5.com>
parents:
12607
diff
changeset
|
2572 @item "none" |
e9e35a707721
doc: Add 'none' to list of plot linestyles.
Rik <octave@nomad.inbox5.com>
parents:
12607
diff
changeset
|
2573 No line. Points will still be marked using the current Marker Style. |
6889 | 2574 @end table |
2575 | |
2576 @item linewidth | |
2577 A number specifying the width of the line. The default is 1. A value | |
2578 of 2 is twice as wide as the default, etc. | |
2579 @end table | |
2580 | |
2581 @node Marker Styles | |
2582 @subsection Marker Styles | |
8071 | 2583 @cindex graphics marker styles |
2584 @cindex marker styles, graphics | |
2585 | |
7001 | 2586 Marker styles are specified by the following properties: |
14853
72b8b39e12be
doc: Periodic grammarcheck of documentation.
Rik <octave@nomad.inbox5.com>
parents:
14577
diff
changeset
|
2587 |
6889 | 2588 @table @code |
2589 @item marker | |
2590 A character indicating a plot marker to be place at each data point, or | |
2591 @code{"none"}, meaning no markers should be displayed. | |
2592 | |
16094
8899c785cc99
doc: Fix warnings associated with Texinfo 5.0 (bug #38392)
Rik <rik@octave.org>
parents:
16008
diff
changeset
|
2593 @item markeredgecolor |
6889 | 2594 The color of the edge around the marker, or @code{"auto"}, meaning that |
2595 the edge color is the same as the face color. @xref{Colors}. | |
2596 | |
16094
8899c785cc99
doc: Fix warnings associated with Texinfo 5.0 (bug #38392)
Rik <rik@octave.org>
parents:
16008
diff
changeset
|
2597 @item markerfacecolor |
6889 | 2598 The color of the marker, or @code{"none"} to indicate that the marker |
2599 should not be filled. @xref{Colors}. | |
2600 | |
16094
8899c785cc99
doc: Fix warnings associated with Texinfo 5.0 (bug #38392)
Rik <rik@octave.org>
parents:
16008
diff
changeset
|
2601 @item markersize |
6889 | 2602 A number specifying the size of the marker. The default is 1. A value |
2603 of 2 is twice as large as the default, etc. | |
6888 | 2604 @end table |
2605 | |
12607
2846ea58b288
colstyle.m: Add new function (bug #33063)
Rik <octave@nomad.inbox5.com>
parents:
12578
diff
changeset
|
2606 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
|
2607 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
|
2608 |
2846ea58b288
colstyle.m: Add new function (bug #33063)
Rik <octave@nomad.inbox5.com>
parents:
12578
diff
changeset
|
2609 @DOCSTRING(colstyle) |
2846ea58b288
colstyle.m: Add new function (bug #33063)
Rik <octave@nomad.inbox5.com>
parents:
12578
diff
changeset
|
2610 |
8056
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
2611 @node Callbacks |
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
2612 @subsection Callbacks |
8071 | 2613 @cindex callbacks |
8056
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
2614 |
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
2615 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
|
2616 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
|
2617 is |
8056
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
2618 |
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
2619 @example |
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
2620 @group |
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
2621 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
|
2622 @dots{} |
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
2623 endfunction |
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
2624 @end group |
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
2625 @end example |
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
2626 |
10846
a4f482e66b65
Grammarcheck more of the documentation.
Rik <octave@nomad.inbox5.com>
parents:
10828
diff
changeset
|
2627 @noindent |
8056
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
2628 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
|
2629 @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
|
2630 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
|
2631 @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
|
2632 |
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
2633 @example |
14856
c3fd61c59e9c
maint: Use Octave coding conventions for cuddling parentheses in doc directory
Rik <octave@nomad.inbox5.com>
parents:
14853
diff
changeset
|
2634 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
|
2635 @end example |
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
2636 |
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
2637 @noindent |
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
2638 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
|
2639 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
|
2640 |
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
2641 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
|
2642 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
|
2643 |
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
2644 @example |
9088
77e71f3da3d6
Fix documentation image printing under new development code
Rik <rdrider0-list@yahoo.com>
parents:
9040
diff
changeset
|
2645 @group |
8057 | 2646 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
|
2647 @dots{} |
8057 | 2648 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
|
2649 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
|
2650 endfunction |
9088
77e71f3da3d6
Fix documentation image printing under new development code
Rik <rdrider0-list@yahoo.com>
parents:
9040
diff
changeset
|
2651 @end group |
8056
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
2652 @end example |
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
2653 |
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
2654 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
|
2655 are |
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
2656 |
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
2657 @itemize @bullet |
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
2658 @item CreateFcn |
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
2659 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
|
2660 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
|
2661 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
|
2662 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
|
2663 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
|
2664 |
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
2665 @item DeleteFcn |
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
2666 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
|
2667 |
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
2668 @item ButtonDownFcn |
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
2669 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
|
2670 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
|
2671 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
|
2672 @end itemize |
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
2673 |
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
2674 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
|
2675 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
|
2676 functions. |
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
2677 |
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
2678 @DOCSTRING(gcbo) |
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
2679 |
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
2680 @DOCSTRING(gcbf) |
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
2681 |
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
2682 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
|
2683 function described below. |
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
2684 |
12525
d36266a54202
Add getappdata, setappdata, isappdata, rmappdata functions to documentation.
Rik <octave@nomad.inbox5.com>
parents:
12522
diff
changeset
|
2685 @node Application-defined Data |
d36266a54202
Add getappdata, setappdata, isappdata, rmappdata functions to documentation.
Rik <octave@nomad.inbox5.com>
parents:
12522
diff
changeset
|
2686 @subsection Application-defined Data |
12578
f5a780d675a1
Clean up operator and function indices in documentation.
Rik <octave@nomad.inbox5.com>
parents:
12577
diff
changeset
|
2687 @cindex application-defined data |
12525
d36266a54202
Add getappdata, setappdata, isappdata, rmappdata functions to documentation.
Rik <octave@nomad.inbox5.com>
parents:
12522
diff
changeset
|
2688 |
d36266a54202
Add getappdata, setappdata, isappdata, rmappdata functions to documentation.
Rik <octave@nomad.inbox5.com>
parents:
12522
diff
changeset
|
2689 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
|
2690 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
|
2691 will be completely ignored by Octave. |
d36266a54202
Add getappdata, setappdata, isappdata, rmappdata functions to documentation.
Rik <octave@nomad.inbox5.com>
parents:
12522
diff
changeset
|
2692 |
d36266a54202
Add getappdata, setappdata, isappdata, rmappdata functions to documentation.
Rik <octave@nomad.inbox5.com>
parents:
12522
diff
changeset
|
2693 @DOCSTRING(setappdata) |
d36266a54202
Add getappdata, setappdata, isappdata, rmappdata functions to documentation.
Rik <octave@nomad.inbox5.com>
parents:
12522
diff
changeset
|
2694 |
d36266a54202
Add getappdata, setappdata, isappdata, rmappdata functions to documentation.
Rik <octave@nomad.inbox5.com>
parents:
12522
diff
changeset
|
2695 @DOCSTRING(getappdata) |
d36266a54202
Add getappdata, setappdata, isappdata, rmappdata functions to documentation.
Rik <octave@nomad.inbox5.com>
parents:
12522
diff
changeset
|
2696 |
d36266a54202
Add getappdata, setappdata, isappdata, rmappdata functions to documentation.
Rik <octave@nomad.inbox5.com>
parents:
12522
diff
changeset
|
2697 @DOCSTRING(rmappdata) |
d36266a54202
Add getappdata, setappdata, isappdata, rmappdata functions to documentation.
Rik <octave@nomad.inbox5.com>
parents:
12522
diff
changeset
|
2698 |
d36266a54202
Add getappdata, setappdata, isappdata, rmappdata functions to documentation.
Rik <octave@nomad.inbox5.com>
parents:
12522
diff
changeset
|
2699 @DOCSTRING(isappdata) |
d36266a54202
Add getappdata, setappdata, isappdata, rmappdata functions to documentation.
Rik <octave@nomad.inbox5.com>
parents:
12522
diff
changeset
|
2700 |
8056
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
2701 @node Object Groups |
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
2702 @subsection Object Groups |
8071 | 2703 @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
|
2704 |
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
2705 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
|
2706 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
|
2707 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
|
2708 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
|
2709 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
|
2710 |
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
2711 @DOCSTRING(hggroup) |
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
2712 |
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
2713 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
|
2714 |
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
2715 @example |
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
2716 @group |
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
2717 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
|
2718 hg = hggroup (); |
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
2719 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
|
2720 hold on |
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
2721 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
|
2722 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
|
2723 @end group |
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
2724 @end example |
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
2725 |
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
2726 @noindent |
9040
dbd0c77e575e
Cleanup documentation file plot.texi
Rik <rdrider0-list@yahoo.com>
parents:
9032
diff
changeset
|
2727 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
|
2728 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
|
2729 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
|
2730 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
|
2731 function. |
8056
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
2732 |
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
2733 @DOCSTRING(addproperty) |
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
2734 |
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
2735 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
|
2736 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
|
2737 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
|
2738 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
|
2739 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
|
2740 |
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
2741 @DOCSTRING(addlistener) |
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
2742 |
8817
03b7f618ab3d
include docstrings for new functions in the manual
John W. Eaton <jwe@octave.org>
parents:
8519
diff
changeset
|
2743 @DOCSTRING(dellistener) |
03b7f618ab3d
include docstrings for new functions in the manual
John W. Eaton <jwe@octave.org>
parents:
8519
diff
changeset
|
2744 |
8056
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
2745 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
|
2746 |
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
2747 @example |
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
2748 @group |
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
2749 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
|
2750 hg = hggroup (); |
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
2751 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
|
2752 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
|
2753 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
|
2754 hold on |
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
2755 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
|
2756 |
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
2757 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
|
2758 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
|
2759 endfunction |
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
2760 @end group |
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
2761 @end example |
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
2762 |
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
2763 @noindent |
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
2764 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
|
2765 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
|
2766 @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
|
2767 |
3b53b25e2550
Add data sources and line series
David Bateman <dbateman@free.fr>
parents:
8057
diff
changeset
|
2768 @example |
3b53b25e2550
Add data sources and line series
David Bateman <dbateman@free.fr>
parents:
8057
diff
changeset
|
2769 @group |
3b53b25e2550
Add data sources and line series
David Bateman <dbateman@free.fr>
parents:
8057
diff
changeset
|
2770 x = 0:0.1:10; |
3b53b25e2550
Add data sources and line series
David Bateman <dbateman@free.fr>
parents:
8057
diff
changeset
|
2771 hg = hggroup (); |
3b53b25e2550
Add data sources and line series
David Bateman <dbateman@free.fr>
parents:
8057
diff
changeset
|
2772 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
|
2773 addproperty ("linestyle", hg, "linelinestyle", get (h, "linestyle")); |
3b53b25e2550
Add data sources and line series
David Bateman <dbateman@free.fr>
parents:
8057
diff
changeset
|
2774 hold on |
3b53b25e2550
Add data sources and line series
David Bateman <dbateman@free.fr>
parents:
8057
diff
changeset
|
2775 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
|
2776 hlink = linkprop ([hg, h1, h2], "color"); |
8070
3b53b25e2550
Add data sources and line series
David Bateman <dbateman@free.fr>
parents:
8057
diff
changeset
|
2777 @end group |
3b53b25e2550
Add data sources and line series
David Bateman <dbateman@free.fr>
parents:
8057
diff
changeset
|
2778 @end example |
3b53b25e2550
Add data sources and line series
David Bateman <dbateman@free.fr>
parents:
8057
diff
changeset
|
2779 |
3b53b25e2550
Add data sources and line series
David Bateman <dbateman@free.fr>
parents:
8057
diff
changeset
|
2780 @DOCSTRING(linkprop) |
8056
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
2781 |
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
2782 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
|
2783 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
|
2784 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
|
2785 |
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
2786 @itemize @bullet |
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
2787 @item group together multiple graphics objects, |
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
2788 |
8056
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
2789 @item create linked properties between different graphics objects, and |
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
2790 |
8056
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
2791 @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
|
2792 @end itemize |
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
2793 |
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
2794 @noindent |
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
2795 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
|
2796 @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
|
2797 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
|
2798 @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
|
2799 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
|
2800 example |
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
2801 |
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
2802 @example |
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
2803 @group |
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
2804 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
|
2805 get (h, "xdata") |
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
2806 @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
|
2807 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
|
2808 @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
|
2809 @end group |
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
2810 @end example |
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
2811 |
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
2812 @noindent |
9040
dbd0c77e575e
Cleanup documentation file plot.texi
Rik <rdrider0-list@yahoo.com>
parents:
9032
diff
changeset
|
2813 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
|
2814 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
|
2815 |
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
2816 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
|
2817 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
|
2818 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
|
2819 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
|
2820 member. |
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
2821 |
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
2822 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
|
2823 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
|
2824 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
|
2825 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
|
2826 corresponding hggroup elements. |
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
2827 |
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
2828 @menu |
11255
d682cd6669ac
Update info-based documentation menus to include new nodes.
Rik <octave@nomad.inbox5.com>
parents:
11254
diff
changeset
|
2829 * Data Sources in Object Groups:: |
d682cd6669ac
Update info-based documentation menus to include new nodes.
Rik <octave@nomad.inbox5.com>
parents:
11254
diff
changeset
|
2830 * Area Series:: |
d682cd6669ac
Update info-based documentation menus to include new nodes.
Rik <octave@nomad.inbox5.com>
parents:
11254
diff
changeset
|
2831 * Bar Series:: |
d682cd6669ac
Update info-based documentation menus to include new nodes.
Rik <octave@nomad.inbox5.com>
parents:
11254
diff
changeset
|
2832 * Contour Groups:: |
d682cd6669ac
Update info-based documentation menus to include new nodes.
Rik <octave@nomad.inbox5.com>
parents:
11254
diff
changeset
|
2833 * Error Bar Series:: |
d682cd6669ac
Update info-based documentation menus to include new nodes.
Rik <octave@nomad.inbox5.com>
parents:
11254
diff
changeset
|
2834 * Line Series:: |
d682cd6669ac
Update info-based documentation menus to include new nodes.
Rik <octave@nomad.inbox5.com>
parents:
11254
diff
changeset
|
2835 * Quiver Group:: |
d682cd6669ac
Update info-based documentation menus to include new nodes.
Rik <octave@nomad.inbox5.com>
parents:
11254
diff
changeset
|
2836 * Scatter Group:: |
d682cd6669ac
Update info-based documentation menus to include new nodes.
Rik <octave@nomad.inbox5.com>
parents:
11254
diff
changeset
|
2837 * Stair Group:: |
9676 | 2838 * Stem Series:: |
11255
d682cd6669ac
Update info-based documentation menus to include new nodes.
Rik <octave@nomad.inbox5.com>
parents:
11254
diff
changeset
|
2839 * Surface Group:: |
8056
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
2840 @end menu |
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
2841 |
11257
8d4c57258523
fix some menu problems in the manual
John W. Eaton <jwe@octave.org>
parents:
11255
diff
changeset
|
2842 @node Data Sources in Object Groups |
8d4c57258523
fix some menu problems in the manual
John W. Eaton <jwe@octave.org>
parents:
11255
diff
changeset
|
2843 @subsubsection Data Sources in Object Groups |
8071 | 2844 @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
|
2845 @anchor{XREFdatasources} |
9040
dbd0c77e575e
Cleanup documentation file plot.texi
Rik <rdrider0-list@yahoo.com>
parents:
9032
diff
changeset
|
2846 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
|
2847 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
|
2848 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
|
2849 function is called. |
8070
3b53b25e2550
Add data sources and line series
David Bateman <dbateman@free.fr>
parents:
8057
diff
changeset
|
2850 |
3b53b25e2550
Add data sources and line series
David Bateman <dbateman@free.fr>
parents:
8057
diff
changeset
|
2851 @DOCSTRING(refreshdata) |
3b53b25e2550
Add data sources and line series
David Bateman <dbateman@free.fr>
parents:
8057
diff
changeset
|
2852 |
17097
e7a059a9a644
doc: Use XREF as anchor prefix in documentation for clearer results in Info viewer.
Rik <rik@octave.org>
parents:
16923
diff
changeset
|
2853 @anchor{XREFlinkdata} |
8070
3b53b25e2550
Add data sources and line series
David Bateman <dbateman@free.fr>
parents:
8057
diff
changeset
|
2854 @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
|
2855 @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
|
2856 @c command |
8070
3b53b25e2550
Add data sources and line series
David Bateman <dbateman@free.fr>
parents:
8057
diff
changeset
|
2857 |
11257
8d4c57258523
fix some menu problems in the manual
John W. Eaton <jwe@octave.org>
parents:
11255
diff
changeset
|
2858 @node Area Series |
8d4c57258523
fix some menu problems in the manual
John W. Eaton <jwe@octave.org>
parents:
11255
diff
changeset
|
2859 @subsubsection Area Series |
8071 | 2860 @cindex series objects |
2861 @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
|
2862 |
9040
dbd0c77e575e
Cleanup documentation file plot.texi
Rik <rdrider0-list@yahoo.com>
parents:
9032
diff
changeset
|
2863 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
|
2864 @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
|
2865 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
|
2866 |
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
2867 @table @code |
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
2868 @item basevalue |
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
2869 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
|
2870 |
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
2871 @item linewidth |
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
2872 @itemx linestyle |
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
2873 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
|
2874 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
|
2875 |
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
2876 @item edgecolor |
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
2877 @itemx facecolor |
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
2878 The line and fill color of the patch objects making up the areas. |
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
2879 @xref{Colors}. |
8056
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
2880 |
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
2881 @item xdata |
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
2882 @itemx ydata |
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
2883 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
|
2884 @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
|
2885 function. |
8070
3b53b25e2550
Add data sources and line series
David Bateman <dbateman@free.fr>
parents:
8057
diff
changeset
|
2886 |
3b53b25e2550
Add data sources and line series
David Bateman <dbateman@free.fr>
parents:
8057
diff
changeset
|
2887 @item xdatasource |
3b53b25e2550
Add data sources and line series
David Bateman <dbateman@free.fr>
parents:
8057
diff
changeset
|
2888 @itemx ydatasource |
3b53b25e2550
Add data sources and line series
David Bateman <dbateman@free.fr>
parents:
8057
diff
changeset
|
2889 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
|
2890 @end table |
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
2891 |
11257
8d4c57258523
fix some menu problems in the manual
John W. Eaton <jwe@octave.org>
parents:
11255
diff
changeset
|
2892 @node Bar Series |
8d4c57258523
fix some menu problems in the manual
John W. Eaton <jwe@octave.org>
parents:
11255
diff
changeset
|
2893 @subsubsection Bar Series |
8071 | 2894 @cindex series objects |
2895 @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
|
2896 |
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
2897 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
|
2898 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
|
2899 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
|
2900 |
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
2901 @table @code |
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
2902 @item showbaseline |
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
2903 @itemx baseline |
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
2904 @itemx basevalue |
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
2905 The property @code{showbaseline} flags whether the baseline of the bar |
9040
dbd0c77e575e
Cleanup documentation file plot.texi
Rik <rdrider0-list@yahoo.com>
parents:
9032
diff
changeset
|
2906 series is displayed (default is "on"). The handle of the graphics object |
8056
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
2907 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
|
2908 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
|
2909 |
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
2910 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
|
2911 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
|
2912 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
|
2913 corresponding bar series. |
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
2914 |
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
2915 @item barwidth |
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
2916 @itemx barlayout |
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
2917 @itemx horizontal |
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
2918 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
|
2919 the @var{width} variable passed to @code{bar} or @var{barh}. Whether the |
8056
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
2920 bar series is "grouped" or "stacked" is determined by the |
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
2921 @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
|
2922 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
|
2923 |
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
2924 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
|
2925 the bar series. |
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
2926 |
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
2927 @item linewidth |
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
2928 @itemx linestyle |
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
2929 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
|
2930 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
|
2931 |
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
2932 @item edgecolor |
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
2933 @itemx facecolor |
9040
dbd0c77e575e
Cleanup documentation file plot.texi
Rik <rdrider0-list@yahoo.com>
parents:
9032
diff
changeset
|
2934 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
|
2935 |
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
2936 @item xdata |
9040
dbd0c77e575e
Cleanup documentation file plot.texi
Rik <rdrider0-list@yahoo.com>
parents:
9032
diff
changeset
|
2937 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
|
2938 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
|
2939 |
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
2940 @item ydata |
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
2941 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
|
2942 |
3b53b25e2550
Add data sources and line series
David Bateman <dbateman@free.fr>
parents:
8057
diff
changeset
|
2943 @item xdatasource |
3b53b25e2550
Add data sources and line series
David Bateman <dbateman@free.fr>
parents:
8057
diff
changeset
|
2944 @itemx ydatasource |
3b53b25e2550
Add data sources and line series
David Bateman <dbateman@free.fr>
parents:
8057
diff
changeset
|
2945 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
|
2946 @end table |
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
2947 |
11257
8d4c57258523
fix some menu problems in the manual
John W. Eaton <jwe@octave.org>
parents:
11255
diff
changeset
|
2948 @node Contour Groups |
8d4c57258523
fix some menu problems in the manual
John W. Eaton <jwe@octave.org>
parents:
11255
diff
changeset
|
2949 @subsubsection Contour Groups |
8071 | 2950 @cindex series objects |
2951 @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
|
2952 |
8289
ac7f334d9652
Add contour group objects and the clabel function
David Bateman <dbateman@free.fr>
parents:
8286
diff
changeset
|
2953 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
|
2954 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
|
2955 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
|
2956 group are |
ac7f334d9652
Add contour group objects and the clabel function
David Bateman <dbateman@free.fr>
parents:
8286
diff
changeset
|
2957 |
ac7f334d9652
Add contour group objects and the clabel function
David Bateman <dbateman@free.fr>
parents:
8286
diff
changeset
|
2958 @table @code |
ac7f334d9652
Add contour group objects and the clabel function
David Bateman <dbateman@free.fr>
parents:
8286
diff
changeset
|
2959 @item contourmatrix |
ac7f334d9652
Add contour group objects and the clabel function
David Bateman <dbateman@free.fr>
parents:
8286
diff
changeset
|
2960 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
|
2961 create the contours of the plot. |
ac7f334d9652
Add contour group objects and the clabel function
David Bateman <dbateman@free.fr>
parents:
8286
diff
changeset
|
2962 |
ac7f334d9652
Add contour group objects and the clabel function
David Bateman <dbateman@free.fr>
parents:
8286
diff
changeset
|
2963 @item fill |
ac7f334d9652
Add contour group objects and the clabel function
David Bateman <dbateman@free.fr>
parents:
8286
diff
changeset
|
2964 A radio property that can have the values "on" or "off" that flags whether the |
ac7f334d9652
Add contour group objects and the clabel function
David Bateman <dbateman@free.fr>
parents:
8286
diff
changeset
|
2965 contours to plot are to be filled. |
ac7f334d9652
Add contour group objects and the clabel function
David Bateman <dbateman@free.fr>
parents:
8286
diff
changeset
|
2966 |
ac7f334d9652
Add contour group objects and the clabel function
David Bateman <dbateman@free.fr>
parents:
8286
diff
changeset
|
2967 @item zlevelmode |
ac7f334d9652
Add contour group objects and the clabel function
David Bateman <dbateman@free.fr>
parents:
8286
diff
changeset
|
2968 @itemx zlevel |
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
2969 The radio property @code{zlevelmode} can have the values "none", "auto" or |
9040
dbd0c77e575e
Cleanup documentation file plot.texi
Rik <rdrider0-list@yahoo.com>
parents:
9032
diff
changeset
|
2970 "manual". When its value is "none" there is no z component to the plotted |
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
2971 contours. When its value is "auto" the z value of the plotted contours is |
9040
dbd0c77e575e
Cleanup documentation file plot.texi
Rik <rdrider0-list@yahoo.com>
parents:
9032
diff
changeset
|
2972 at the same value as the contour itself. If the value is "manual", then the |
8289
ac7f334d9652
Add contour group objects and the clabel function
David Bateman <dbateman@free.fr>
parents:
8286
diff
changeset
|
2973 z value at which to plot the contour is determined by the @code{zlevel} |
ac7f334d9652
Add contour group objects and the clabel function
David Bateman <dbateman@free.fr>
parents:
8286
diff
changeset
|
2974 property. |
ac7f334d9652
Add contour group objects and the clabel function
David Bateman <dbateman@free.fr>
parents:
8286
diff
changeset
|
2975 |
ac7f334d9652
Add contour group objects and the clabel function
David Bateman <dbateman@free.fr>
parents:
8286
diff
changeset
|
2976 @item levellistmode |
ac7f334d9652
Add contour group objects and the clabel function
David Bateman <dbateman@free.fr>
parents:
8286
diff
changeset
|
2977 @itemx levellist |
ac7f334d9652
Add contour group objects and the clabel function
David Bateman <dbateman@free.fr>
parents:
8286
diff
changeset
|
2978 @itemx levelstepmode |
ac7f334d9652
Add contour group objects and the clabel function
David Bateman <dbateman@free.fr>
parents:
8286
diff
changeset
|
2979 @itemx levelstep |
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
2980 If @code{levellistmode} is "manual", then the levels at which to plot the |
9040
dbd0c77e575e
Cleanup documentation file plot.texi
Rik <rdrider0-list@yahoo.com>
parents:
9032
diff
changeset
|
2981 contours is determined by @code{levellist}. If @code{levellistmode} is |
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
2982 set to "auto", then the distance between contours is determined by |
9040
dbd0c77e575e
Cleanup documentation file plot.texi
Rik <rdrider0-list@yahoo.com>
parents:
9032
diff
changeset
|
2983 @code{levelstep}. If both @code{levellistmode} and @code{levelstepmode} |
8289
ac7f334d9652
Add contour group objects and the clabel function
David Bateman <dbateman@free.fr>
parents:
8286
diff
changeset
|
2984 are set to "auto", then there are assumed to be 10 equal spaced contours. |
ac7f334d9652
Add contour group objects and the clabel function
David Bateman <dbateman@free.fr>
parents:
8286
diff
changeset
|
2985 |
ac7f334d9652
Add contour group objects and the clabel function
David Bateman <dbateman@free.fr>
parents:
8286
diff
changeset
|
2986 @item textlistmode |
ac7f334d9652
Add contour group objects and the clabel function
David Bateman <dbateman@free.fr>
parents:
8286
diff
changeset
|
2987 @itemx textlist |
ac7f334d9652
Add contour group objects and the clabel function
David Bateman <dbateman@free.fr>
parents:
8286
diff
changeset
|
2988 @itemx textstepmode |
ac7f334d9652
Add contour group objects and the clabel function
David Bateman <dbateman@free.fr>
parents:
8286
diff
changeset
|
2989 @itemx textstep |
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
2990 If @code{textlistmode} is "manual", then the labeled contours |
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
2991 is determined by @code{textlist}. If @code{textlistmode} is set to |
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
2992 "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
|
2993 @code{textstep}. If both @code{textlistmode} and @code{textstepmode} |
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
2994 are set to "auto", then there are assumed to be 10 equal spaced |
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
2995 labeled contours. |
8289
ac7f334d9652
Add contour group objects and the clabel function
David Bateman <dbateman@free.fr>
parents:
8286
diff
changeset
|
2996 |
ac7f334d9652
Add contour group objects and the clabel function
David Bateman <dbateman@free.fr>
parents:
8286
diff
changeset
|
2997 @item showtext |
ac7f334d9652
Add contour group objects and the clabel function
David Bateman <dbateman@free.fr>
parents:
8286
diff
changeset
|
2998 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
|
2999 |
ac7f334d9652
Add contour group objects and the clabel function
David Bateman <dbateman@free.fr>
parents:
8286
diff
changeset
|
3000 @item labelspacing |
ac7f334d9652
Add contour group objects and the clabel function
David Bateman <dbateman@free.fr>
parents:
8286
diff
changeset
|
3001 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
|
3002 |
ac7f334d9652
Add contour group objects and the clabel function
David Bateman <dbateman@free.fr>
parents:
8286
diff
changeset
|
3003 @item linewidth |
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
3004 |
8289
ac7f334d9652
Add contour group objects and the clabel function
David Bateman <dbateman@free.fr>
parents:
8286
diff
changeset
|
3005 @item linestyle |
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
3006 |
8289
ac7f334d9652
Add contour group objects and the clabel function
David Bateman <dbateman@free.fr>
parents:
8286
diff
changeset
|
3007 @item linecolor |
9040
dbd0c77e575e
Cleanup documentation file plot.texi
Rik <rdrider0-list@yahoo.com>
parents:
9032
diff
changeset
|
3008 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
|
3009 @code{linestyle} are similar to the corresponding properties for lines. The |
8297 | 3010 property @code{linecolor} is a color property (@pxref{Colors}), that can also |
9040
dbd0c77e575e
Cleanup documentation file plot.texi
Rik <rdrider0-list@yahoo.com>
parents:
9032
diff
changeset
|
3011 have the values of "none" or "auto". If @code{linecolor} is "none", then no |
dbd0c77e575e
Cleanup documentation file plot.texi
Rik <rdrider0-list@yahoo.com>
parents:
9032
diff
changeset
|
3012 contour line is drawn. If @code{linecolor} is "auto" then the line color is |
8289
ac7f334d9652
Add contour group objects and the clabel function
David Bateman <dbateman@free.fr>
parents:
8286
diff
changeset
|
3013 determined by the colormap. |
ac7f334d9652
Add contour group objects and the clabel function
David Bateman <dbateman@free.fr>
parents:
8286
diff
changeset
|
3014 |
ac7f334d9652
Add contour group objects and the clabel function
David Bateman <dbateman@free.fr>
parents:
8286
diff
changeset
|
3015 @item xdata |
ac7f334d9652
Add contour group objects and the clabel function
David Bateman <dbateman@free.fr>
parents:
8286
diff
changeset
|
3016 @itemx ydata |
ac7f334d9652
Add contour group objects and the clabel function
David Bateman <dbateman@free.fr>
parents:
8286
diff
changeset
|
3017 @itemx zdata |
ac7f334d9652
Add contour group objects and the clabel function
David Bateman <dbateman@free.fr>
parents:
8286
diff
changeset
|
3018 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
|
3019 |
ac7f334d9652
Add contour group objects and the clabel function
David Bateman <dbateman@free.fr>
parents:
8286
diff
changeset
|
3020 @item xdatasource |
ac7f334d9652
Add contour group objects and the clabel function
David Bateman <dbateman@free.fr>
parents:
8286
diff
changeset
|
3021 @itemx ydatasource |
ac7f334d9652
Add contour group objects and the clabel function
David Bateman <dbateman@free.fr>
parents:
8286
diff
changeset
|
3022 @itemx zdatasource |
ac7f334d9652
Add contour group objects and the clabel function
David Bateman <dbateman@free.fr>
parents:
8286
diff
changeset
|
3023 Data source variables. |
ac7f334d9652
Add contour group objects and the clabel function
David Bateman <dbateman@free.fr>
parents:
8286
diff
changeset
|
3024 @end table |
8056
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
3025 |
11257
8d4c57258523
fix some menu problems in the manual
John W. Eaton <jwe@octave.org>
parents:
11255
diff
changeset
|
3026 @node Error Bar Series |
8d4c57258523
fix some menu problems in the manual
John W. Eaton <jwe@octave.org>
parents:
11255
diff
changeset
|
3027 @subsubsection Error Bar Series |
8071 | 3028 @cindex series objects |
3029 @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
|
3030 |
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
3031 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
|
3032 @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
|
3033 the errorbars separately. The properties of the error bar series are |
8258 | 3034 |
3035 @table @code | |
3036 @item color | |
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
3037 The RGB color or color name of the line objects of the error bars. |
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
3038 @xref{Colors}. |
8258 | 3039 |
3040 @item linewidth | |
3041 @itemx linestyle | |
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
3042 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
|
3043 Styles}. |
8258 | 3044 |
3045 @item marker | |
3046 @itemx markeredgecolor | |
3047 @itemx markerfacecolor | |
3048 @itemx markersize | |
9040
dbd0c77e575e
Cleanup documentation file plot.texi
Rik <rdrider0-list@yahoo.com>
parents:
9032
diff
changeset
|
3049 The line and fill color of the markers on the error bars. @xref{Colors}. |
8258 | 3050 |
3051 @item xdata | |
3052 @itemx ydata | |
3053 @itemx ldata | |
3054 @itemx udata | |
3055 @itemx xldata | |
3056 @itemx xudata | |
3057 The original x, y, l, u, xl, xu data of the error bars. | |
3058 | |
3059 @item xdatasource | |
3060 @itemx ydatasource | |
3061 @itemx ldatasource | |
3062 @itemx udatasource | |
3063 @itemx xldatasource | |
3064 @itemx xudatasource | |
3065 Data source variables. | |
3066 @end table | |
3067 | |
11257
8d4c57258523
fix some menu problems in the manual
John W. Eaton <jwe@octave.org>
parents:
11255
diff
changeset
|
3068 @node Line Series |
8d4c57258523
fix some menu problems in the manual
John W. Eaton <jwe@octave.org>
parents:
11255
diff
changeset
|
3069 @subsubsection Line Series |
8071 | 3070 @cindex series objects |
3071 @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
|
3072 |
8257 | 3073 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
|
3074 functions and are of the type @code{line}. The properties of the |
8257 | 3075 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
|
3076 |
3b53b25e2550
Add data sources and line series
David Bateman <dbateman@free.fr>
parents:
8057
diff
changeset
|
3077 @table @code |
3b53b25e2550
Add data sources and line series
David Bateman <dbateman@free.fr>
parents:
8057
diff
changeset
|
3078 @item color |
9040
dbd0c77e575e
Cleanup documentation file plot.texi
Rik <rdrider0-list@yahoo.com>
parents:
9032
diff
changeset
|
3079 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
|
3080 |
3b53b25e2550
Add data sources and line series
David Bateman <dbateman@free.fr>
parents:
8057
diff
changeset
|
3081 @item linewidth |
3b53b25e2550
Add data sources and line series
David Bateman <dbateman@free.fr>
parents:
8057
diff
changeset
|
3082 @itemx linestyle |
9040
dbd0c77e575e
Cleanup documentation file plot.texi
Rik <rdrider0-list@yahoo.com>
parents:
9032
diff
changeset
|
3083 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
|
3084 |
3b53b25e2550
Add data sources and line series
David Bateman <dbateman@free.fr>
parents:
8057
diff
changeset
|
3085 @item marker |
3b53b25e2550
Add data sources and line series
David Bateman <dbateman@free.fr>
parents:
8057
diff
changeset
|
3086 @itemx markeredgecolor |
3b53b25e2550
Add data sources and line series
David Bateman <dbateman@free.fr>
parents:
8057
diff
changeset
|
3087 @itemx markerfacecolor |
3b53b25e2550
Add data sources and line series
David Bateman <dbateman@free.fr>
parents:
8057
diff
changeset
|
3088 @itemx markersize |
9040
dbd0c77e575e
Cleanup documentation file plot.texi
Rik <rdrider0-list@yahoo.com>
parents:
9032
diff
changeset
|
3089 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
|
3090 |
3b53b25e2550
Add data sources and line series
David Bateman <dbateman@free.fr>
parents:
8057
diff
changeset
|
3091 @item xdata |
3b53b25e2550
Add data sources and line series
David Bateman <dbateman@free.fr>
parents:
8057
diff
changeset
|
3092 @itemx ydata |
3b53b25e2550
Add data sources and line series
David Bateman <dbateman@free.fr>
parents:
8057
diff
changeset
|
3093 @itemx zdata |
8257 | 3094 The original x, y and z data. |
8070
3b53b25e2550
Add data sources and line series
David Bateman <dbateman@free.fr>
parents:
8057
diff
changeset
|
3095 |
3b53b25e2550
Add data sources and line series
David Bateman <dbateman@free.fr>
parents:
8057
diff
changeset
|
3096 @item xdatasource |
3b53b25e2550
Add data sources and line series
David Bateman <dbateman@free.fr>
parents:
8057
diff
changeset
|
3097 @itemx ydatasource |
3b53b25e2550
Add data sources and line series
David Bateman <dbateman@free.fr>
parents:
8057
diff
changeset
|
3098 @itemx zdatasource |
3b53b25e2550
Add data sources and line series
David Bateman <dbateman@free.fr>
parents:
8057
diff
changeset
|
3099 Data source variables. |
3b53b25e2550
Add data sources and line series
David Bateman <dbateman@free.fr>
parents:
8057
diff
changeset
|
3100 @end table |
8056
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
3101 |
11257
8d4c57258523
fix some menu problems in the manual
John W. Eaton <jwe@octave.org>
parents:
11255
diff
changeset
|
3102 @node Quiver Group |
8d4c57258523
fix some menu problems in the manual
John W. Eaton <jwe@octave.org>
parents:
11255
diff
changeset
|
3103 @subsubsection Quiver Group |
8071 | 3104 @cindex group objects |
3105 @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
|
3106 |
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
3107 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
|
3108 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
|
3109 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
|
3110 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
|
3111 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
|
3112 |
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
3113 @table @code |
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
3114 @item autoscale |
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
3115 @itemx autoscalefactor |
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
3116 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
|
3117 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
|
3118 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
|
3119 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
|
3120 |
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
3121 @item maxheadsize |
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
3122 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
|
3123 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
|
3124 |
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
3125 @item showarrowhead |
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
3126 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
|
3127 |
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
3128 @item color |
9040
dbd0c77e575e
Cleanup documentation file plot.texi
Rik <rdrider0-list@yahoo.com>
parents:
9032
diff
changeset
|
3129 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
|
3130 |
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
3131 @item linewidth |
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
3132 @itemx linestyle |
9040
dbd0c77e575e
Cleanup documentation file plot.texi
Rik <rdrider0-list@yahoo.com>
parents:
9032
diff
changeset
|
3133 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
|
3134 |
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
3135 @item marker |
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
3136 @itemx markerfacecolor |
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
3137 @itemx markersize |
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
3138 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
|
3139 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
|
3140 |
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
3141 @item xdata |
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
3142 @itemx ydata |
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
3143 @itemx zdata |
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
3144 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
|
3145 |
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
3146 @item udata |
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
3147 @itemx vdata |
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
3148 @itemx wdata |
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
3149 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
|
3150 |
3b53b25e2550
Add data sources and line series
David Bateman <dbateman@free.fr>
parents:
8057
diff
changeset
|
3151 @item xdatasource |
3b53b25e2550
Add data sources and line series
David Bateman <dbateman@free.fr>
parents:
8057
diff
changeset
|
3152 @itemx ydatasource |
3b53b25e2550
Add data sources and line series
David Bateman <dbateman@free.fr>
parents:
8057
diff
changeset
|
3153 @itemx zdatasource |
3b53b25e2550
Add data sources and line series
David Bateman <dbateman@free.fr>
parents:
8057
diff
changeset
|
3154 @itemx udatasource |
3b53b25e2550
Add data sources and line series
David Bateman <dbateman@free.fr>
parents:
8057
diff
changeset
|
3155 @itemx vdatasource |
3b53b25e2550
Add data sources and line series
David Bateman <dbateman@free.fr>
parents:
8057
diff
changeset
|
3156 @itemx wdatasource |
3b53b25e2550
Add data sources and line series
David Bateman <dbateman@free.fr>
parents:
8057
diff
changeset
|
3157 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
|
3158 @end table |
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
3159 |
11257
8d4c57258523
fix some menu problems in the manual
John W. Eaton <jwe@octave.org>
parents:
11255
diff
changeset
|
3160 @node Scatter Group |
8d4c57258523
fix some menu problems in the manual
John W. Eaton <jwe@octave.org>
parents:
11255
diff
changeset
|
3161 @subsubsection Scatter Group |
8071 | 3162 @cindex group objects |
3163 @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
|
3164 |
8257 | 3165 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
|
3166 functions. A single hggroup element contains as many children as there are |
8257 | 3167 points in the scatter plot, with each child representing one of the points. |
3168 The properties of the stem series are | |
3169 | |
3170 @table @code | |
3171 @item linewidth | |
9040
dbd0c77e575e
Cleanup documentation file plot.texi
Rik <rdrider0-list@yahoo.com>
parents:
9032
diff
changeset
|
3172 The line width of the line objects of the points. @xref{Line Styles}. |
8257 | 3173 |
3174 @item marker | |
3175 @itemx markeredgecolor | |
3176 @itemx markerfacecolor | |
9040
dbd0c77e575e
Cleanup documentation file plot.texi
Rik <rdrider0-list@yahoo.com>
parents:
9032
diff
changeset
|
3177 The line and fill color of the markers of the points. @xref{Colors}. |
8257 | 3178 |
3179 @item xdata | |
3180 @itemx ydata | |
3181 @itemx zdata | |
3182 The original x, y and z data of the stems. | |
3183 | |
3184 @item cdata | |
9040
dbd0c77e575e
Cleanup documentation file plot.texi
Rik <rdrider0-list@yahoo.com>
parents:
9032
diff
changeset
|
3185 The color data for the points of the plot. Each point can have a separate |
8257 | 3186 color, or a unique color can be specified. |
3187 | |
3188 @item sizedata | |
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
3189 The size data for the points of the plot. Each point can its own size or a |
8257 | 3190 unique size can be specified. |
3191 | |
3192 @item xdatasource | |
3193 @itemx ydatasource | |
3194 @itemx zdatasource | |
3195 @itemx cdatasource | |
3196 @itemx sizedatasource | |
3197 Data source variables. | |
3198 @end table | |
8056
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
3199 |
11257
8d4c57258523
fix some menu problems in the manual
John W. Eaton <jwe@octave.org>
parents:
11255
diff
changeset
|
3200 @node Stair Group |
8d4c57258523
fix some menu problems in the manual
John W. Eaton <jwe@octave.org>
parents:
11255
diff
changeset
|
3201 @subsubsection Stair Group |
8071 | 3202 @cindex group objects |
3203 @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
|
3204 |
9040
dbd0c77e575e
Cleanup documentation file plot.texi
Rik <rdrider0-list@yahoo.com>
parents:
9032
diff
changeset
|
3205 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
|
3206 @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
|
3207 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
|
3208 |
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
3209 @table @code |
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
3210 @item color |
9040
dbd0c77e575e
Cleanup documentation file plot.texi
Rik <rdrider0-list@yahoo.com>
parents:
9032
diff
changeset
|
3211 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
|
3212 |
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
3213 @item linewidth |
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
3214 @itemx linestyle |
9040
dbd0c77e575e
Cleanup documentation file plot.texi
Rik <rdrider0-list@yahoo.com>
parents:
9032
diff
changeset
|
3215 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
|
3216 |
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
3217 @item marker |
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
3218 @itemx markeredgecolor |
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
3219 @itemx markerfacecolor |
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
3220 @itemx markersize |
9040
dbd0c77e575e
Cleanup documentation file plot.texi
Rik <rdrider0-list@yahoo.com>
parents:
9032
diff
changeset
|
3221 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
|
3222 |
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
3223 @item xdata |
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
3224 @itemx ydata |
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
3225 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
|
3226 |
3b53b25e2550
Add data sources and line series
David Bateman <dbateman@free.fr>
parents:
8057
diff
changeset
|
3227 @item xdatasource |
3b53b25e2550
Add data sources and line series
David Bateman <dbateman@free.fr>
parents:
8057
diff
changeset
|
3228 @itemx ydatasource |
3b53b25e2550
Add data sources and line series
David Bateman <dbateman@free.fr>
parents:
8057
diff
changeset
|
3229 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
|
3230 @end table |
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
3231 |
8073 | 3232 @node Stem Series |
3233 @subsubsection Stem Series | |
3234 @cindex series objects | |
3235 @cindex stem series | |
3236 | |
8257 | 3237 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
|
3238 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
|
3239 as a child representing the stems. The properties of the stem series |
8257 | 3240 are |
3241 | |
3242 @table @code | |
3243 @item showbaseline | |
3244 @itemx baseline | |
3245 @itemx basevalue | |
3246 The property @code{showbaseline} flags whether the baseline of the | |
9040
dbd0c77e575e
Cleanup documentation file plot.texi
Rik <rdrider0-list@yahoo.com>
parents:
9032
diff
changeset
|
3247 stem series is displayed (default is "on"). The handle of the graphics |
8257 | 3248 object representing the baseline is given by the @code{baseline} |
3249 property and the y-value (or z-value for @code{stem3}) of the baseline | |
3250 by the @code{basevalue} property. | |
3251 | |
3252 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
|
3253 the stem series and to the baseline itself. Equally changes in the |
8257 | 3254 properties of the base line itself are propagated to the members of the |
3255 corresponding stem series. | |
3256 | |
3257 @item color | |
9040
dbd0c77e575e
Cleanup documentation file plot.texi
Rik <rdrider0-list@yahoo.com>
parents:
9032
diff
changeset
|
3258 The RGB color or color name of the line objects of the stems. @xref{Colors}. |
8257 | 3259 |
3260 @item linewidth | |
3261 @itemx linestyle | |
9040
dbd0c77e575e
Cleanup documentation file plot.texi
Rik <rdrider0-list@yahoo.com>
parents:
9032
diff
changeset
|
3262 The line width and style of the line objects of the stems. @xref{Line Styles}. |
8257 | 3263 |
3264 @item marker | |
3265 @itemx markeredgecolor | |
3266 @itemx markerfacecolor | |
3267 @itemx markersize | |
9040
dbd0c77e575e
Cleanup documentation file plot.texi
Rik <rdrider0-list@yahoo.com>
parents:
9032
diff
changeset
|
3268 The line and fill color of the markers on the stems. @xref{Colors}. |
8257 | 3269 |
3270 @item xdata | |
3271 @itemx ydata | |
3272 @itemx zdata | |
3273 The original x, y and z data of the stems. | |
3274 | |
3275 @item xdatasource | |
3276 @itemx ydatasource | |
3277 @itemx zdatasource | |
3278 Data source variables. | |
3279 @end table | |
8073 | 3280 |
11257
8d4c57258523
fix some menu problems in the manual
John W. Eaton <jwe@octave.org>
parents:
11255
diff
changeset
|
3281 @node Surface Group |
8d4c57258523
fix some menu problems in the manual
John W. Eaton <jwe@octave.org>
parents:
11255
diff
changeset
|
3282 @subsubsection Surface Group |
8071 | 3283 @cindex group objects |
3284 @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
|
3285 |
8257 | 3286 Surface group objects are created by the @code{surf} or @code{mesh} |
3287 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
|
3288 or @code{meshc} functions. The surface group is of the type @code{surface}. |
8257 | 3289 |
3290 The properties of the surface group are | |
3291 | |
3292 @table @code | |
3293 @item edgecolor | |
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
3294 |
8257 | 3295 @item facecolor |
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
3296 The RGB color or color name of the edges or faces of the surface. |
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
3297 @xref{Colors}. |
8257 | 3298 |
3299 @item linewidth | |
3300 @itemx linestyle | |
9040
dbd0c77e575e
Cleanup documentation file plot.texi
Rik <rdrider0-list@yahoo.com>
parents:
9032
diff
changeset
|
3301 The line width and style of the lines on the surface. @xref{Line Styles}. |
8257 | 3302 |
3303 @item marker | |
3304 @itemx markeredgecolor | |
3305 @itemx markerfacecolor | |
3306 @itemx markersize | |
9040
dbd0c77e575e
Cleanup documentation file plot.texi
Rik <rdrider0-list@yahoo.com>
parents:
9032
diff
changeset
|
3307 The line and fill color of the markers on the surface. @xref{Colors}. |
8257 | 3308 |
3309 @item xdata | |
3310 @itemx ydata | |
3311 @itemx zdata | |
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
3312 @itemx cdata |
8257 | 3313 The original x, y, z and c data. |
3314 | |
3315 @item xdatasource | |
3316 @itemx ydatasource | |
3317 @itemx zdatasource | |
3318 @itemx cdatasource | |
3319 Data source variables. | |
3320 @end table | |
8056
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
3321 |
11576
8ac9687dbe9f
rename backend to graphics_toolkit
John W. Eaton <jwe@octave.org>
parents:
11573
diff
changeset
|
3322 @node Graphics Toolkits |
8ac9687dbe9f
rename backend to graphics_toolkit
John W. Eaton <jwe@octave.org>
parents:
11573
diff
changeset
|
3323 @subsection Graphics Toolkits |
8ac9687dbe9f
rename backend to graphics_toolkit
John W. Eaton <jwe@octave.org>
parents:
11573
diff
changeset
|
3324 @cindex graphics toolkits |
8ac9687dbe9f
rename backend to graphics_toolkit
John W. Eaton <jwe@octave.org>
parents:
11573
diff
changeset
|
3325 @cindex toolkits, graphics |
8ac9687dbe9f
rename backend to graphics_toolkit
John W. Eaton <jwe@octave.org>
parents:
11573
diff
changeset
|
3326 |
8ac9687dbe9f
rename backend to graphics_toolkit
John W. Eaton <jwe@octave.org>
parents:
11573
diff
changeset
|
3327 @DOCSTRING(graphics_toolkit) |
8ac9687dbe9f
rename backend to graphics_toolkit
John W. Eaton <jwe@octave.org>
parents:
11573
diff
changeset
|
3328 |
8ac9687dbe9f
rename backend to graphics_toolkit
John W. Eaton <jwe@octave.org>
parents:
11573
diff
changeset
|
3329 @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
|
3330 |
14134
84f38aeb9f0e
doc: Add register_graphics_toolkit() and loaded_graphics_toolkits() to documentation
Rik <octave@nomad.inbox5.com>
parents:
13947
diff
changeset
|
3331 @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
|
3332 |
84f38aeb9f0e
doc: Add register_graphics_toolkit() and loaded_graphics_toolkits() to documentation
Rik <octave@nomad.inbox5.com>
parents:
13947
diff
changeset
|
3333 @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
|
3334 |
8056
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
3335 @menu |
12226
8cc154f45e37
Rename fltk_mouse_wheel_zoom, fltk_gui_mode functions to remove fltk_ prefix.
Rik <octave@nomad.inbox5.com>
parents:
12215
diff
changeset
|
3336 * 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
|
3337 @end menu |
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
3338 |
12226
8cc154f45e37
Rename fltk_mouse_wheel_zoom, fltk_gui_mode functions to remove fltk_ prefix.
Rik <octave@nomad.inbox5.com>
parents:
12215
diff
changeset
|
3339 @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
|
3340 @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
|
3341 @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
|
3342 |
8cc154f45e37
Rename fltk_mouse_wheel_zoom, fltk_gui_mode functions to remove fltk_ prefix.
Rik <octave@nomad.inbox5.com>
parents:
12215
diff
changeset
|
3343 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
|
3344 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
|
3345 graphics toolkit. |
3428 | 3346 |
3347 @DOCSTRING(gnuplot_binary) | |
12215
4ae2a74ed04c
Add fltk_gui_mode, fltk_mouse_wheel_zoom to documentation.
Rik <octave@nomad.inbox5.com>
parents:
12189
diff
changeset
|
3348 |
12226
8cc154f45e37
Rename fltk_mouse_wheel_zoom, fltk_gui_mode functions to remove fltk_ prefix.
Rik <octave@nomad.inbox5.com>
parents:
12215
diff
changeset
|
3349 @DOCSTRING(gui_mode) |
8cc154f45e37
Rename fltk_mouse_wheel_zoom, fltk_gui_mode functions to remove fltk_ prefix.
Rik <octave@nomad.inbox5.com>
parents:
12215
diff
changeset
|
3350 |
8cc154f45e37
Rename fltk_mouse_wheel_zoom, fltk_gui_mode functions to remove fltk_ prefix.
Rik <octave@nomad.inbox5.com>
parents:
12215
diff
changeset
|
3351 @DOCSTRING(mouse_wheel_zoom) |