Mercurial > octave-nkf
annotate doc/interpreter/plot.txi @ 17281:bc924baa2c4e
doc: Add new @qcode macro for code samples which are quoted.
Macro handles options ("on") or properties ("position") more elegantly
than @code{"text"}.
* doc/interpreter/macros.texi: Add new @qcode macro.
* doc/interpreter/tips.txi: Add documentation about @qcode macro.
* doc/interpreter/basics.txi, doc/interpreter/container.txi,
doc/interpreter/emacs.txi, doc/interpreter/errors.txi,
doc/interpreter/eval.txi, doc/interpreter/expr.txi,
doc/interpreter/external.txi, doc/interpreter/func.txi,
doc/interpreter/grammar.txi, doc/interpreter/image.txi,
doc/interpreter/install.txi, doc/interpreter/interp.txi,
doc/interpreter/io.txi, doc/interpreter/matrix.txi,
doc/interpreter/numbers.txi, doc/interpreter/oop.txi,
doc/interpreter/package.txi, doc/interpreter/plot.txi,
doc/interpreter/quad.txi, doc/interpreter/sparse.txi,
doc/interpreter/strings.txi, doc/interpreter/system.txi,
doc/interpreter/vectorize.txi, libinterp/corefcn/balance.cc,
libinterp/corefcn/bitfcns.cc, libinterp/corefcn/cellfun.cc,
libinterp/corefcn/conv2.cc, libinterp/corefcn/data.cc,
libinterp/corefcn/debug.cc, libinterp/corefcn/defaults.cc,
libinterp/corefcn/dirfns.cc, libinterp/corefcn/dlmread.cc,
libinterp/corefcn/error.cc, libinterp/corefcn/file-io.cc,
libinterp/corefcn/find.cc, libinterp/corefcn/gammainc.cc,
libinterp/corefcn/graphics.cc, libinterp/corefcn/help.cc,
libinterp/corefcn/hex2num.cc, libinterp/corefcn/input.cc,
libinterp/corefcn/load-path.cc, libinterp/corefcn/load-save.cc,
libinterp/corefcn/ls-oct-ascii.cc, libinterp/corefcn/lu.cc,
libinterp/corefcn/luinc.cc, libinterp/corefcn/matrix_type.cc,
libinterp/corefcn/oct-hist.cc, libinterp/corefcn/pager.cc,
libinterp/corefcn/pr-output.cc, libinterp/corefcn/pt-jit.cc,
libinterp/corefcn/qz.cc, libinterp/corefcn/rand.cc,
libinterp/corefcn/regexp.cc, libinterp/corefcn/schur.cc,
libinterp/corefcn/sighandlers.cc, libinterp/corefcn/sparse.cc,
libinterp/corefcn/spparms.cc, libinterp/corefcn/str2double.cc,
libinterp/corefcn/svd.cc, libinterp/corefcn/symtab.cc,
libinterp/corefcn/syscalls.cc, libinterp/corefcn/toplev.cc,
libinterp/corefcn/tril.cc, libinterp/corefcn/typecast.cc,
libinterp/corefcn/utils.cc, libinterp/corefcn/variables.cc,
libinterp/dldfcn/__init_fltk__.cc, libinterp/dldfcn/chol.cc,
libinterp/dldfcn/colamd.cc, libinterp/dldfcn/fftw.cc, libinterp/dldfcn/qr.cc,
libinterp/dldfcn/symbfact.cc, libinterp/octave-value/ov-base.cc,
libinterp/octave-value/ov-fcn-handle.cc,
libinterp/octave-value/ov-fcn-inline.cc, libinterp/octave-value/ov-java.cc,
libinterp/octave-value/ov-range.cc, libinterp/octave-value/ov-struct.cc,
libinterp/octave-value/ov-usr-fcn.cc, libinterp/parse-tree/oct-parse.in.yy,
libinterp/parse-tree/pt-binop.cc, libinterp/parse-tree/pt-eval.cc,
libinterp/parse-tree/pt-mat.cc, scripts/@ftp/ftp.m,
scripts/deprecated/java_convert_matrix.m, scripts/deprecated/java_debug.m,
scripts/deprecated/java_unsigned_conversion.m, scripts/deprecated/shell_cmd.m,
scripts/general/dblquad.m, scripts/general/display.m,
scripts/general/genvarname.m, scripts/general/idivide.m,
scripts/general/interp1.m, scripts/general/interp2.m,
scripts/general/interp3.m, scripts/general/interpn.m, scripts/general/isa.m,
scripts/general/profexplore.m, scripts/general/profile.m,
scripts/general/quadgk.m, scripts/general/randi.m, scripts/general/structfun.m,
scripts/general/subsindex.m, scripts/general/triplequad.m,
scripts/geometry/griddata.m, scripts/geometry/griddata3.m,
scripts/geometry/griddatan.m, scripts/geometry/voronoi.m, scripts/help/help.m,
scripts/help/lookfor.m, scripts/image/cmpermute.m, scripts/image/colormap.m,
scripts/image/image.m, scripts/image/imagesc.m, scripts/image/imfinfo.m,
scripts/image/imformats.m, scripts/image/imread.m, scripts/image/imshow.m,
scripts/image/imwrite.m, scripts/image/ind2gray.m, scripts/image/lines.m,
scripts/image/rgb2ind.m, scripts/image/spinmap.m, scripts/io/dlmwrite.m,
scripts/io/strread.m, scripts/io/textread.m, scripts/io/textscan.m,
scripts/java/javaclasspath.m, scripts/java/usejava.m,
scripts/miscellaneous/bzip2.m, scripts/miscellaneous/computer.m,
scripts/miscellaneous/copyfile.m, scripts/miscellaneous/debug.m,
scripts/miscellaneous/dos.m, scripts/miscellaneous/edit.m,
scripts/miscellaneous/gzip.m, scripts/miscellaneous/license.m,
scripts/miscellaneous/mkoctfile.m, scripts/miscellaneous/movefile.m,
scripts/miscellaneous/parseparams.m, scripts/miscellaneous/unix.m,
scripts/optimization/fminbnd.m, scripts/optimization/fminsearch.m,
scripts/optimization/fminunc.m, scripts/optimization/fsolve.m,
scripts/optimization/fzero.m, scripts/optimization/glpk.m,
scripts/optimization/lsqnonneg.m, scripts/optimization/optimset.m,
scripts/optimization/pqpnonneg.m, scripts/pkg/pkg.m, scripts/plot/allchild.m,
scripts/plot/ancestor.m, scripts/plot/area.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/colorbar.m,
scripts/plot/daspect.m, scripts/plot/ezmesh.m, scripts/plot/ezmeshc.m,
scripts/plot/ezsurf.m, scripts/plot/ezsurfc.m, scripts/plot/findall.m,
scripts/plot/findobj.m, scripts/plot/gcbo.m, scripts/plot/gcf.m,
scripts/plot/gco.m, scripts/plot/grid.m, scripts/plot/guihandles.m,
scripts/plot/hdl2struct.m, scripts/plot/hidden.m, scripts/plot/hold.m,
scripts/plot/isonormals.m, scripts/plot/isosurface.m, scripts/plot/legend.m,
scripts/plot/mesh.m, scripts/plot/meshc.m, scripts/plot/meshz.m,
scripts/plot/newplot.m, scripts/plot/orient.m, scripts/plot/pareto.m,
scripts/plot/patch.m, scripts/plot/pbaspect.m, scripts/plot/pcolor.m,
scripts/plot/plot.m, scripts/plot/print.m,
scripts/plot/private/__add_default_menu__.m, scripts/plot/quiver.m,
scripts/plot/quiver3.m, scripts/plot/refreshdata.m, scripts/plot/saveas.m,
scripts/plot/scatter.m, scripts/plot/scatter3.m, scripts/plot/shading.m,
scripts/plot/shrinkfaces.m, scripts/plot/slice.m, scripts/plot/stem.m,
scripts/plot/stem3.m, scripts/plot/struct2hdl.m, scripts/plot/subplot.m,
scripts/plot/surf.m, scripts/plot/surfc.m, scripts/plot/surfl.m,
scripts/plot/tetramesh.m, scripts/plot/uigetfile.m, scripts/plot/uimenu.m,
scripts/plot/uiputfile.m, scripts/plot/waterfall.m, scripts/plot/whitebg.m,
scripts/plot/xlim.m, scripts/plot/ylim.m, scripts/plot/zlim.m,
scripts/polynomial/conv.m, scripts/polynomial/polyout.m,
scripts/polynomial/splinefit.m, scripts/set/ismember.m, scripts/set/powerset.m,
scripts/set/setdiff.m, scripts/set/union.m, scripts/set/unique.m,
scripts/signal/detrend.m, scripts/signal/filter2.m, scripts/signal/freqz.m,
scripts/signal/periodogram.m, scripts/signal/spectral_adf.m,
scripts/signal/spectral_xdf.m, scripts/sparse/eigs.m, scripts/sparse/svds.m,
scripts/specfun/legendre.m, scripts/special-matrix/gallery.m,
scripts/statistics/base/mean.m, scripts/statistics/base/moment.m,
scripts/statistics/tests/cor_test.m,
scripts/statistics/tests/kolmogorov_smirnov_test.m,
scripts/statistics/tests/kolmogorov_smirnov_test_2.m,
scripts/statistics/tests/kruskal_wallis_test.m,
scripts/statistics/tests/prop_test_2.m, scripts/statistics/tests/sign_test.m,
scripts/statistics/tests/t_test.m, scripts/statistics/tests/t_test_2.m,
scripts/statistics/tests/t_test_regression.m,
scripts/statistics/tests/u_test.m, scripts/statistics/tests/var_test.m,
scripts/statistics/tests/welch_test.m,
scripts/statistics/tests/wilcoxon_test.m, scripts/statistics/tests/z_test.m,
scripts/statistics/tests/z_test_2.m, scripts/strings/base2dec.m,
scripts/strings/index.m, scripts/strings/isstrprop.m,
scripts/strings/mat2str.m, scripts/strings/regexptranslate.m,
scripts/strings/rindex.m, scripts/strings/str2num.m, scripts/strings/strcat.m,
scripts/strings/strjust.m, scripts/strings/strmatch.m,
scripts/strings/validatestring.m, scripts/testfun/demo.m,
scripts/testfun/example.m, scripts/testfun/test.m, scripts/time/addtodate.m,
scripts/time/asctime.m, scripts/time/datestr.m, scripts/time/datetick.m,
scripts/time/weekday.m, scripts/ui/errordlg.m, scripts/ui/helpdlg.m,
scripts/ui/inputdlg.m, scripts/ui/listdlg.m, scripts/ui/msgbox.m,
scripts/ui/questdlg.m, scripts/ui/warndlg.m: Use new @qcode macro.
| author | Rik <rik@octave.org> |
|---|---|
| date | Mon, 19 Aug 2013 20:46:38 -0700 |
| parents | d6499c14021c |
| children | 710b3d5fe966 |
| 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 | |
|
17152
f2a8592b8fbd
doc: Shorten some long subsection names in Manual.
Rik <rik@octave.org>
parents:
17123
diff
changeset
|
25 * Introduction to Plotting:: |
|
f2a8592b8fbd
doc: Shorten some long subsection names in Manual.
Rik <rik@octave.org>
parents:
17123
diff
changeset
|
26 * High-Level Plotting:: |
|
f2a8592b8fbd
doc: Shorten some long subsection names in Manual.
Rik <rik@octave.org>
parents:
17123
diff
changeset
|
27 * Graphics Data Structures:: |
|
f2a8592b8fbd
doc: Shorten some long subsection names in Manual.
Rik <rik@octave.org>
parents:
17123
diff
changeset
|
28 * Advanced Plotting:: |
| 6888 | 29 @end menu |
| 30 | |
|
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
31 @node Introduction to Plotting |
|
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
32 @section Introduction to Plotting |
|
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
33 |
|
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
34 Earlier versions of Octave provided plotting through the use of |
|
9758
09da0bd91412
Periodic grammar check of Octave documentation files to ensure common format
Rik <rdrider0-list@yahoo.com>
parents:
9752
diff
changeset
|
35 gnuplot. This capability is still available. But, a newer plotting |
|
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
36 capability is provided by access to OpenGL@. Which plotting system |
|
17097
e7a059a9a644
doc: Use XREF as anchor prefix in documentation for clearer results in Info viewer.
Rik <rik@octave.org>
parents:
16923
diff
changeset
|
37 is used is controlled by the @code{graphics_toolkit} function. |
|
e7a059a9a644
doc: Use XREF as anchor prefix in documentation for clearer results in Info viewer.
Rik <rik@octave.org>
parents:
16923
diff
changeset
|
38 @xref{Graphics Toolkits}. |
|
11576
8ac9687dbe9f
rename backend to graphics_toolkit
John W. Eaton <jwe@octave.org>
parents:
11573
diff
changeset
|
39 |
|
8ac9687dbe9f
rename backend to graphics_toolkit
John W. Eaton <jwe@octave.org>
parents:
11573
diff
changeset
|
40 The function call @code{graphics_toolkit ("fltk")} selects the |
|
11591
1d13679b587e
Use @nospell macro on certain words in docstrings.
Rik <octave@nomad.inbox5.com>
parents:
11576
diff
changeset
|
41 FLTK/OpenGL system, and @code{graphics_toolkit ("gnuplot")} selects the |
|
11576
8ac9687dbe9f
rename backend to graphics_toolkit
John W. Eaton <jwe@octave.org>
parents:
11573
diff
changeset
|
42 gnuplot system. The two systems may be used selectively through the use |
|
8ac9687dbe9f
rename backend to graphics_toolkit
John W. Eaton <jwe@octave.org>
parents:
11573
diff
changeset
|
43 of the @code{graphics_toolkit} property of the graphics handle for each |
|
8ac9687dbe9f
rename backend to graphics_toolkit
John W. Eaton <jwe@octave.org>
parents:
11573
diff
changeset
|
44 figure. This is explained in @ref{Graphics Data Structures}. |
|
12577
562e40e3d5db
Add warning about single precision in FLTK.
Rik <octave@nomad.inbox5.com>
parents:
12529
diff
changeset
|
45 @strong{Caution:} The FLTK toolkit uses single precision variables internally |
|
562e40e3d5db
Add warning about single precision in FLTK.
Rik <octave@nomad.inbox5.com>
parents:
12529
diff
changeset
|
46 which limits the maximum value that can be displayed to approximately |
|
562e40e3d5db
Add warning about single precision in FLTK.
Rik <octave@nomad.inbox5.com>
parents:
12529
diff
changeset
|
47 @math{10^{38}}. If your data contains larger values you must use the gnuplot |
|
562e40e3d5db
Add warning about single precision in FLTK.
Rik <octave@nomad.inbox5.com>
parents:
12529
diff
changeset
|
48 toolkit which supports values up to @math{10^{308}}. |
|
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
49 |
|
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
50 @node High-Level Plotting |
|
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
51 @section High-Level Plotting |
|
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 | |
|
17152
f2a8592b8fbd
doc: Shorten some long subsection names in Manual.
Rik <rik@octave.org>
parents:
17123
diff
changeset
|
60 * Two-Dimensional Plots:: |
|
f2a8592b8fbd
doc: Shorten some long subsection names in Manual.
Rik <rik@octave.org>
parents:
17123
diff
changeset
|
61 * Three-Dimensional Plots:: |
|
f2a8592b8fbd
doc: Shorten some long subsection names in Manual.
Rik <rik@octave.org>
parents:
17123
diff
changeset
|
62 * Plot Annotations:: |
|
f2a8592b8fbd
doc: Shorten some long subsection names in Manual.
Rik <rik@octave.org>
parents:
17123
diff
changeset
|
63 * Multiple Plots on One Page:: |
|
f2a8592b8fbd
doc: Shorten some long subsection names in Manual.
Rik <rik@octave.org>
parents:
17123
diff
changeset
|
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:: |
|
17152
f2a8592b8fbd
doc: Shorten some long subsection names in Manual.
Rik <rik@octave.org>
parents:
17123
diff
changeset
|
67 * Printing and Saving Plots:: |
|
f2a8592b8fbd
doc: Shorten some long subsection names in Manual.
Rik <rik@octave.org>
parents:
17123
diff
changeset
|
68 * Interacting with Plots:: |
|
f2a8592b8fbd
doc: Shorten some long subsection names in Manual.
Rik <rik@octave.org>
parents:
17123
diff
changeset
|
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 |
|
17152
f2a8592b8fbd
doc: Shorten some long subsection names in Manual.
Rik <rik@octave.org>
parents:
17123
diff
changeset
|
76 * Axis Configuration:: |
|
f2a8592b8fbd
doc: Shorten some long subsection names in Manual.
Rik <rik@octave.org>
parents:
17123
diff
changeset
|
77 * Two-dimensional Function Plotting:: |
|
f2a8592b8fbd
doc: Shorten some long subsection names in Manual.
Rik <rik@octave.org>
parents:
17123
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:: |
|
17152
f2a8592b8fbd
doc: Shorten some long subsection names in Manual.
Rik <rik@octave.org>
parents:
17123
diff
changeset
|
401 * Three-dimensional Function Plotting:: |
|
f2a8592b8fbd
doc: Shorten some long subsection names in Manual.
Rik <rik@octave.org>
parents:
17123
diff
changeset
|
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 |
|
17281
bc924baa2c4e
doc: Add new @qcode macro for code samples which are quoted.
Rik <rik@octave.org>
parents:
17170
diff
changeset
|
591 the property @qcode{"interpreter"}, this property determines the manner in which |
|
9672
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 |
|
17281
bc924baa2c4e
doc: Add new @qcode macro for code samples which are quoted.
Rik <rik@octave.org>
parents:
17170
diff
changeset
|
593 is set to @qcode{"none"}, then no rendering occurs. At this point the |
|
bc924baa2c4e
doc: Add new @qcode macro for code samples which are quoted.
Rik <rik@octave.org>
parents:
17170
diff
changeset
|
594 @qcode{"latex"} option is not implemented and so the @qcode{"latex"} |
|
bc924baa2c4e
doc: Add new @qcode macro for code samples which are quoted.
Rik <rik@octave.org>
parents:
17170
diff
changeset
|
595 interpreter also does not interpret the text. |
|
bc924baa2c4e
doc: Add new @qcode macro for code samples which are quoted.
Rik <rik@octave.org>
parents:
17170
diff
changeset
|
596 |
|
bc924baa2c4e
doc: Add new @qcode macro for code samples which are quoted.
Rik <rik@octave.org>
parents:
17170
diff
changeset
|
597 The @qcode{"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 |
|
17281
bc924baa2c4e
doc: Add new @qcode macro for code samples which are quoted.
Rik <rik@octave.org>
parents:
17170
diff
changeset
|
621 where the character @qcode{'a'} will not appear in a bold font. Note that to |
|
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
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 |
|
17281
bc924baa2c4e
doc: Add new @qcode macro for code samples which are quoted.
Rik <rik@octave.org>
parents:
17170
diff
changeset
|
633 Finally, the superscript and subscripting can be controlled with the @qcode{'^'} |
|
bc924baa2c4e
doc: Add new @qcode macro for code samples which are quoted.
Rik <rik@octave.org>
parents:
17170
diff
changeset
|
634 and @qcode{'_'} characters. If the @qcode{'^'} or @qcode{'_'} is followed by a |
|
bc924baa2c4e
doc: Add new @qcode macro for code samples which are quoted.
Rik <rik@octave.org>
parents:
17170
diff
changeset
|
635 @{ character, then all of the block surrounded by the @{ @} pair is super- or |
|
bc924baa2c4e
doc: Add new @qcode macro for code samples which are quoted.
Rik <rik@octave.org>
parents:
17170
diff
changeset
|
636 sub-scripted. Without the @{ @} pair, only the character immediately following |
|
bc924baa2c4e
doc: Add new @qcode macro for code samples which are quoted.
Rik <rik@octave.org>
parents:
17170
diff
changeset
|
637 the @qcode{'^'} or @qcode{'_'} is super- or sub-scripted. |
|
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
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 | |
|
17152
f2a8592b8fbd
doc: Shorten some long subsection names in Manual.
Rik <rik@octave.org>
parents:
17123
diff
changeset
|
891 * Introduction to Graphics Structures:: |
|
f2a8592b8fbd
doc: Shorten some long subsection names in Manual.
Rik <rik@octave.org>
parents:
17123
diff
changeset
|
892 * Graphics Objects:: |
|
f2a8592b8fbd
doc: Shorten some long subsection names in Manual.
Rik <rik@octave.org>
parents:
17123
diff
changeset
|
893 * Graphics Object Properties:: |
|
f2a8592b8fbd
doc: Shorten some long subsection names in Manual.
Rik <rik@octave.org>
parents:
17123
diff
changeset
|
894 * Searching Properties:: |
|
f2a8592b8fbd
doc: Shorten some long subsection names in Manual.
Rik <rik@octave.org>
parents:
17123
diff
changeset
|
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 |
|
17281
bc924baa2c4e
doc: Add new @qcode macro for code samples which are quoted.
Rik <rik@octave.org>
parents:
17170
diff
changeset
|
953 For example, the property @qcode{"type"} of the graphics object pointed to by |
|
bc924baa2c4e
doc: Add new @qcode macro for code samples which are quoted.
Rik <rik@octave.org>
parents:
17170
diff
changeset
|
954 the 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 |
|
17281
bc924baa2c4e
doc: Add new @qcode macro for code samples which are quoted.
Rik <rik@octave.org>
parents:
17170
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 |
|
17123
bcada0a4f8a7
isaxes.m: New function to determine if object is axes handle.
Rik <rik@octave.org>
parents:
17122
diff
changeset
|
1085 To determine whether a variable is a graphics object index, or an index |
|
bcada0a4f8a7
isaxes.m: New function to determine if object is axes handle.
Rik <rik@octave.org>
parents:
17122
diff
changeset
|
1086 to an axes or figure, use the functions @code{ishandle}, @code{isaxes}, and |
|
bcada0a4f8a7
isaxes.m: New function to determine if object is axes handle.
Rik <rik@octave.org>
parents:
17122
diff
changeset
|
1087 @code{isfigure}. |
| 6888 | 1088 |
| 1089 @DOCSTRING(ishandle) | |
| 1090 | |
|
8817
03b7f618ab3d
include docstrings for new functions in the manual
John W. Eaton <jwe@octave.org>
parents:
8519
diff
changeset
|
1091 @DOCSTRING(ishghandle) |
|
03b7f618ab3d
include docstrings for new functions in the manual
John W. Eaton <jwe@octave.org>
parents:
8519
diff
changeset
|
1092 |
|
17123
bcada0a4f8a7
isaxes.m: New function to determine if object is axes handle.
Rik <rik@octave.org>
parents:
17122
diff
changeset
|
1093 @DOCSTRING(isaxes) |
|
bcada0a4f8a7
isaxes.m: New function to determine if object is axes handle.
Rik <rik@octave.org>
parents:
17122
diff
changeset
|
1094 |
| 6888 | 1095 @DOCSTRING(isfigure) |
| 1096 | |
| 1097 The function @code{gcf} returns an index to the current figure object, | |
| 1098 or creates one if none exists. Similarly, @code{gca} returns the | |
| 1099 current axes object, or creates one (and its parent figure object) if | |
| 1100 none exists. | |
| 1101 | |
| 1102 @DOCSTRING(gcf) | |
| 1103 | |
| 1104 @DOCSTRING(gca) | |
| 1105 | |
| 16808 | 1106 @DOCSTRING(gco) |
| 1107 | |
| 6888 | 1108 The @code{get} and @code{set} functions may be used to examine and set |
| 1109 properties for graphics objects. For example, | |
| 1110 | |
| 1111 @example | |
| 1112 @group | |
| 1113 get (0) | |
| 1114 @result{} ans = | |
| 1115 @{ | |
|
9316
c539ec5726e7
Update some of Advanced Plotting documentation.
Rik <rdrider0-list@yahoo.com>
parents:
9209
diff
changeset
|
1116 type = root |
| 6888 | 1117 currentfigure = [](0x0) |
| 1118 children = [](0x0) | |
| 1119 visible = on | |
|
10599
d0e0bb2ebebb
Remove tabs in .txi files causing problems with pdf formatting.
Rik <octave@nomad.inbox5.com>
parents:
10522
diff
changeset
|
1120 @dots{} |
| 6888 | 1121 @} |
| 1122 @end group | |
| 1123 @end example | |
| 1124 | |
| 1125 @noindent | |
| 1126 returns a structure containing all the properties of the root figure. | |
| 1127 As with all functions in Octave, the structure is returned by value, so | |
| 1128 modifying it will not modify the internal root figure plot object. To | |
| 1129 do that, you must use the @code{set} function. Also, note that in this | |
| 1130 case, the @code{currentfigure} property is empty, which indicates that | |
| 1131 there is no current figure window. | |
| 1132 | |
| 1133 The @code{get} function may also be used to find the value of a single | |
| 1134 property. For example, | |
| 1135 | |
| 1136 @example | |
| 1137 @group | |
| 1138 get (gca (), "xlim") | |
| 1139 @result{} [ 0 1 ] | |
| 1140 @end group | |
| 1141 @end example | |
| 1142 | |
| 1143 @noindent | |
| 1144 returns the range of the x-axis for the current axes object in the | |
| 1145 current figure. | |
| 1146 | |
| 1147 To set graphics object properties, use the set function. For example, | |
| 1148 | |
| 1149 @example | |
| 1150 set (gca (), "xlim", [-10, 10]); | |
| 1151 @end example | |
| 1152 | |
| 1153 @noindent | |
| 1154 sets the range of the x-axis for the current axes object in the current | |
| 1155 figure to @samp{[-10, 10]}. Additionally, calling set with a graphics | |
| 1156 object index as the only argument returns a structure containing the | |
| 1157 default values for all the properties for the given object type. For | |
| 1158 example, | |
| 1159 | |
| 1160 @example | |
| 1161 set (gca ()) | |
| 1162 @end example | |
| 1163 | |
| 1164 @noindent | |
| 1165 returns a structure containing the default property values for axes | |
| 1166 objects. | |
| 1167 | |
| 1168 @DOCSTRING(get) | |
| 1169 | |
| 1170 @DOCSTRING(set) | |
| 1171 | |
| 1172 @DOCSTRING(ancestor) | |
| 1173 | |
|
7984
bbaa5d7d0143
Some documentation updates
David Bateman <dbateman@free.fr>
parents:
7981
diff
changeset
|
1174 @DOCSTRING(allchild) |
|
bbaa5d7d0143
Some documentation updates
David Bateman <dbateman@free.fr>
parents:
7981
diff
changeset
|
1175 |
|
14577
447038c2dde8
Add findfigs.m docstring to plot.txi
Carnë Draug <carandraug+dev@gmail.com>
parents:
14574
diff
changeset
|
1176 @DOCSTRING(findfigs) |
|
447038c2dde8
Add findfigs.m docstring to plot.txi
Carnë Draug <carandraug+dev@gmail.com>
parents:
14574
diff
changeset
|
1177 |
|
16813
81e041f5633a
doc: Add copyobj, struct2hdl, hdl2struct to manual.
Rik <rik@octave.org>
parents:
16808
diff
changeset
|
1178 @cindex saving graphics objects |
|
81e041f5633a
doc: Add copyobj, struct2hdl, hdl2struct to manual.
Rik <rik@octave.org>
parents:
16808
diff
changeset
|
1179 |
|
81e041f5633a
doc: Add copyobj, struct2hdl, hdl2struct to manual.
Rik <rik@octave.org>
parents:
16808
diff
changeset
|
1180 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
|
1181 @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
|
1182 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
|
1183 as modifying a title or legend. |
|
81e041f5633a
doc: Add copyobj, struct2hdl, hdl2struct to manual.
Rik <rik@octave.org>
parents:
16808
diff
changeset
|
1184 |
|
81e041f5633a
doc: Add copyobj, struct2hdl, hdl2struct to manual.
Rik <rik@octave.org>
parents:
16808
diff
changeset
|
1185 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
|
1186 |
|
81e041f5633a
doc: Add copyobj, struct2hdl, hdl2struct to manual.
Rik <rik@octave.org>
parents:
16808
diff
changeset
|
1187 @example |
|
81e041f5633a
doc: Add copyobj, struct2hdl, hdl2struct to manual.
Rik <rik@octave.org>
parents:
16808
diff
changeset
|
1188 @group |
|
81e041f5633a
doc: Add copyobj, struct2hdl, hdl2struct to manual.
Rik <rik@octave.org>
parents:
16808
diff
changeset
|
1189 fig_struct = hdl2struct (gcf); |
|
81e041f5633a
doc: Add copyobj, struct2hdl, hdl2struct to manual.
Rik <rik@octave.org>
parents:
16808
diff
changeset
|
1190 save myplot.fig -struct fig_struct; |
|
81e041f5633a
doc: Add copyobj, struct2hdl, hdl2struct to manual.
Rik <rik@octave.org>
parents:
16808
diff
changeset
|
1191 @dots{} |
|
81e041f5633a
doc: Add copyobj, struct2hdl, hdl2struct to manual.
Rik <rik@octave.org>
parents:
16808
diff
changeset
|
1192 fig_struct = load ("myplot.fig"); |
|
81e041f5633a
doc: Add copyobj, struct2hdl, hdl2struct to manual.
Rik <rik@octave.org>
parents:
16808
diff
changeset
|
1193 struct2hdl (fig_struct); |
|
81e041f5633a
doc: Add copyobj, struct2hdl, hdl2struct to manual.
Rik <rik@octave.org>
parents:
16808
diff
changeset
|
1194 @end group |
|
81e041f5633a
doc: Add copyobj, struct2hdl, hdl2struct to manual.
Rik <rik@octave.org>
parents:
16808
diff
changeset
|
1195 @end example |
|
81e041f5633a
doc: Add copyobj, struct2hdl, hdl2struct to manual.
Rik <rik@octave.org>
parents:
16808
diff
changeset
|
1196 |
|
81e041f5633a
doc: Add copyobj, struct2hdl, hdl2struct to manual.
Rik <rik@octave.org>
parents:
16808
diff
changeset
|
1197 @DOCSTRING(hdl2struct) |
|
81e041f5633a
doc: Add copyobj, struct2hdl, hdl2struct to manual.
Rik <rik@octave.org>
parents:
16808
diff
changeset
|
1198 |
|
81e041f5633a
doc: Add copyobj, struct2hdl, hdl2struct to manual.
Rik <rik@octave.org>
parents:
16808
diff
changeset
|
1199 @DOCSTRING(struct2hdl) |
|
81e041f5633a
doc: Add copyobj, struct2hdl, hdl2struct to manual.
Rik <rik@octave.org>
parents:
16808
diff
changeset
|
1200 |
|
81e041f5633a
doc: Add copyobj, struct2hdl, hdl2struct to manual.
Rik <rik@octave.org>
parents:
16808
diff
changeset
|
1201 @DOCSTRING(copyobj) |
|
81e041f5633a
doc: Add copyobj, struct2hdl, hdl2struct to manual.
Rik <rik@octave.org>
parents:
16808
diff
changeset
|
1202 |
| 6888 | 1203 @node Graphics Object Properties |
| 1204 @subsection Graphics Object Properties | |
| 1205 @cindex graphics object properties | |
| 1206 | |
| 1207 @menu | |
|
17152
f2a8592b8fbd
doc: Shorten some long subsection names in Manual.
Rik <rik@octave.org>
parents:
17123
diff
changeset
|
1208 * Root Figure Properties:: |
|
f2a8592b8fbd
doc: Shorten some long subsection names in Manual.
Rik <rik@octave.org>
parents:
17123
diff
changeset
|
1209 * Figure Properties:: |
|
f2a8592b8fbd
doc: Shorten some long subsection names in Manual.
Rik <rik@octave.org>
parents:
17123
diff
changeset
|
1210 * Axes Properties:: |
|
f2a8592b8fbd
doc: Shorten some long subsection names in Manual.
Rik <rik@octave.org>
parents:
17123
diff
changeset
|
1211 * Line Properties:: |
|
f2a8592b8fbd
doc: Shorten some long subsection names in Manual.
Rik <rik@octave.org>
parents:
17123
diff
changeset
|
1212 * Text Properties:: |
|
f2a8592b8fbd
doc: Shorten some long subsection names in Manual.
Rik <rik@octave.org>
parents:
17123
diff
changeset
|
1213 * Image Properties:: |
|
f2a8592b8fbd
doc: Shorten some long subsection names in Manual.
Rik <rik@octave.org>
parents:
17123
diff
changeset
|
1214 * Patch Properties:: |
|
f2a8592b8fbd
doc: Shorten some long subsection names in Manual.
Rik <rik@octave.org>
parents:
17123
diff
changeset
|
1215 * Surface Properties:: |
| 6888 | 1216 @end menu |
| 1217 | |
|
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
1218 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
|
1219 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
|
1220 hierarchy. |
|
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
1221 |
| 6888 | 1222 @node Root Figure Properties |
| 1223 @subsubsection Root Figure Properties | |
|
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
1224 @cindex root figure properties |
|
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
1225 |
|
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
1226 The @code{root figure} properties are: |
|
14853
72b8b39e12be
doc: Periodic grammarcheck of documentation.
Rik <octave@nomad.inbox5.com>
parents:
14577
diff
changeset
|
1227 |
| 6888 | 1228 @table @code |
|
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
1229 @item __modified__ |
|
17281
bc924baa2c4e
doc: Add new @qcode macro for code samples which are quoted.
Rik <rik@octave.org>
parents:
17170
diff
changeset
|
1230 --- Values: @qcode{"on"}, @qcode{"off"} |
|
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
1231 |
|
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
1232 @item __myhandle__ |
|
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 beingdeleted |
|
17281
bc924baa2c4e
doc: Add new @qcode macro for code samples which are quoted.
Rik <rik@octave.org>
parents:
17170
diff
changeset
|
1235 --- Values: @qcode{"on"}, @qcode{"off"} |
|
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
1236 |
|
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
1237 @item busyaction |
|
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
1238 |
|
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
1239 @item buttondownfcn |
|
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
1240 |
|
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
1241 @item callbackobject |
|
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
1242 |
|
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
1243 @item children |
|
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 clipping |
|
17281
bc924baa2c4e
doc: Add new @qcode macro for code samples which are quoted.
Rik <rik@octave.org>
parents:
17170
diff
changeset
|
1246 --- Values: @qcode{"on"}, @qcode{"off"} |
|
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
1247 |
|
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
1248 @item createfcn |
|
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
1249 |
| 6888 | 1250 @item currentfigure |
|
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
1251 |
|
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
1252 @item deletefcn |
|
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 handlevisibility |
|
17281
bc924baa2c4e
doc: Add new @qcode macro for code samples which are quoted.
Rik <rik@octave.org>
parents:
17170
diff
changeset
|
1255 --- Values: @qcode{"on"}, @qcode{"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 hittest |
|
17281
bc924baa2c4e
doc: Add new @qcode macro for code samples which are quoted.
Rik <rik@octave.org>
parents:
17170
diff
changeset
|
1258 --- Values: @qcode{"on"}, @qcode{"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 interruptible |
|
17281
bc924baa2c4e
doc: Add new @qcode macro for code samples which are quoted.
Rik <rik@octave.org>
parents:
17170
diff
changeset
|
1261 --- Values: @qcode{"on"}, @qcode{"off"} |
|
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
1262 |
|
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
1263 @item parent |
|
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
1264 |
|
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
1265 @item screendepth |
|
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
1266 |
|
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
1267 @item screenpixelsperinch |
|
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
1268 |
|
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
1269 @item screensize |
|
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
1270 |
|
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
1271 @item selected |
|
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
1272 |
|
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
1273 @item selectionhighlight |
|
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
1274 |
|
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
1275 @item screendepth |
|
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
1276 |
|
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
1277 @item screenpixelsperinch |
|
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 showhiddenhandles |
|
17281
bc924baa2c4e
doc: Add new @qcode macro for code samples which are quoted.
Rik <rik@octave.org>
parents:
17170
diff
changeset
|
1280 --- Values: @qcode{"on"}, @qcode{"off"} |
|
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
1281 |
|
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
1282 @item tag |
|
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
1283 |
|
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
1284 @item type |
|
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
1285 |
|
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
1286 @item uicontextmenu |
|
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
1287 |
|
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
1288 @item units |
|
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
1289 |
|
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
1290 @item userdata |
|
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
1291 |
|
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
1292 @item visible |
| 6888 | 1293 @end table |
| 1294 | |
| 6889 | 1295 @node Figure Properties |
| 1296 @subsubsection Figure Properties | |
| 8071 | 1297 @cindex figure properties |
| 6888 | 1298 |
|
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
1299 The @code{figure} properties are: |
|
14853
72b8b39e12be
doc: Periodic grammarcheck of documentation.
Rik <octave@nomad.inbox5.com>
parents:
14577
diff
changeset
|
1300 |
| 6888 | 1301 @table @code |
|
11576
8ac9687dbe9f
rename backend to graphics_toolkit
John W. Eaton <jwe@octave.org>
parents:
11573
diff
changeset
|
1302 @item __graphics_toolkit__ |
|
8ac9687dbe9f
rename backend to graphics_toolkit
John W. Eaton <jwe@octave.org>
parents:
11573
diff
changeset
|
1303 --- The graphics toolkit currently in use. |
|
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
1304 |
|
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
1305 @item __enhanced__ |
|
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
1306 |
|
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
1307 @item __modified__ |
|
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
1308 |
|
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
1309 @item __myhandle__ |
|
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
1310 |
|
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
1311 @item __plot_stream__ |
|
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
1312 |
|
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
1313 @item alphamap |
|
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 beingdeleted |
|
17281
bc924baa2c4e
doc: Add new @qcode macro for code samples which are quoted.
Rik <rik@octave.org>
parents:
17170
diff
changeset
|
1316 --- Values: @qcode{"on"}, @qcode{"off"} |
|
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
1317 |
|
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
1318 @item busyaction |
|
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
1319 |
|
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
1320 @item buttondownfcn |
|
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 children |
|
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
1323 Handle to children. |
|
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 clipping |
|
17281
bc924baa2c4e
doc: Add new @qcode macro for code samples which are quoted.
Rik <rik@octave.org>
parents:
17170
diff
changeset
|
1326 --- Values: @qcode{"on"}, @qcode{"off"} |
|
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 closerequestfcn |
|
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
1329 --- Handle of function to call on close. |
|
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
1330 |
|
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
1331 @item color |
|
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 colormap |
|
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
1334 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
|
1335 |
|
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
1336 @item paperorientation |
|
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
1337 |
|
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
1338 @item createfcn |
|
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 currentaxes |
|
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
1341 Handle to graphics object of current axes. |
|
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
1342 |
|
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
1343 @item currentcharacter |
|
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
1344 |
|
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
1345 @item currentobject |
|
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
1346 |
|
10522
6538ff562949
document keypress and mouse callback properties
Shai Ayal <shaiay@users.sourceforge.net>
parents:
9758
diff
changeset
|
1347 @item currentpoint |
|
6538ff562949
document keypress and mouse callback properties
Shai Ayal <shaiay@users.sourceforge.net>
parents:
9758
diff
changeset
|
1348 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
|
1349 the mouse button was pressed. If a mouse callback function is defined, |
|
17281
bc924baa2c4e
doc: Add new @qcode macro for code samples which are quoted.
Rik <rik@octave.org>
parents:
17170
diff
changeset
|
1350 @qcode{"currentpoint"} holds the coordinates of the point over which the |
|
10522
6538ff562949
document keypress and mouse callback properties
Shai Ayal <shaiay@users.sourceforge.net>
parents:
9758
diff
changeset
|
1351 mouse pointer is when the function gets called. |
|
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
1352 |
|
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
1353 @item deletefcn |
|
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 dockcontrols |
|
17281
bc924baa2c4e
doc: Add new @qcode macro for code samples which are quoted.
Rik <rik@octave.org>
parents:
17170
diff
changeset
|
1356 --- Values: @qcode{"on"}, @qcode{"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 doublebuffer |
|
17281
bc924baa2c4e
doc: Add new @qcode macro for code samples which are quoted.
Rik <rik@octave.org>
parents:
17170
diff
changeset
|
1359 --- Values: @qcode{"on"}, @qcode{"off"} |
|
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
1360 |
|
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
1361 @item filename |
|
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 handlevisibility |
|
17281
bc924baa2c4e
doc: Add new @qcode macro for code samples which are quoted.
Rik <rik@octave.org>
parents:
17170
diff
changeset
|
1364 --- Values: @qcode{"on"}, @qcode{"off"} |
|
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
1365 |
|
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
1366 @item hittest |
|
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
1367 |
|
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
1368 @item integerhandle |
|
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 interruptible |
|
17281
bc924baa2c4e
doc: Add new @qcode macro for code samples which are quoted.
Rik <rik@octave.org>
parents:
17170
diff
changeset
|
1371 --- Values: @qcode{"on"}, @qcode{"off"} |
|
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
1372 |
|
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
1373 @item inverthardcopy |
|
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 keypressfcn |
|
17281
bc924baa2c4e
doc: Add new @qcode macro for code samples which are quoted.
Rik <rik@octave.org>
parents:
17170
diff
changeset
|
1376 see @qcode{"keypressfcn"} |
|
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
1377 |
|
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
1378 @item keyreleasefcn |
|
17281
bc924baa2c4e
doc: Add new @qcode macro for code samples which are quoted.
Rik <rik@octave.org>
parents:
17170
diff
changeset
|
1379 With @qcode{"keypressfcn"}, the keyboard callback functions. These |
|
10522
6538ff562949
document keypress and mouse callback properties
Shai Ayal <shaiay@users.sourceforge.net>
parents:
9758
diff
changeset
|
1380 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
|
1381 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
|
1382 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
|
1383 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
|
1384 |
|
10522
6538ff562949
document keypress and mouse callback properties
Shai Ayal <shaiay@users.sourceforge.net>
parents:
9758
diff
changeset
|
1385 @table @code |
|
6538ff562949
document keypress and mouse callback properties
Shai Ayal <shaiay@users.sourceforge.net>
parents:
9758
diff
changeset
|
1386 @item Character |
|
6538ff562949
document keypress and mouse callback properties
Shai Ayal <shaiay@users.sourceforge.net>
parents:
9758
diff
changeset
|
1387 The ASCII 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 Key |
|
6538ff562949
document keypress and mouse callback properties
Shai Ayal <shaiay@users.sourceforge.net>
parents:
9758
diff
changeset
|
1390 lowercase value of the key |
|
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
1391 |
|
10522
6538ff562949
document keypress and mouse callback properties
Shai Ayal <shaiay@users.sourceforge.net>
parents:
9758
diff
changeset
|
1392 @item Modifier |
|
6538ff562949
document keypress and mouse callback properties
Shai Ayal <shaiay@users.sourceforge.net>
parents:
9758
diff
changeset
|
1393 A cell array containing strings representing the modifiers pressed with |
|
17281
bc924baa2c4e
doc: Add new @qcode macro for code samples which are quoted.
Rik <rik@octave.org>
parents:
17170
diff
changeset
|
1394 the key. Possible values are @qcode{"shift"}, @qcode{"alt"}, and |
|
bc924baa2c4e
doc: Add new @qcode macro for code samples which are quoted.
Rik <rik@octave.org>
parents:
17170
diff
changeset
|
1395 @qcode{"control"}. |
|
10522
6538ff562949
document keypress and mouse callback properties
Shai Ayal <shaiay@users.sourceforge.net>
parents:
9758
diff
changeset
|
1396 @end table |
|
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
1397 |
|
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
1398 @item menubar |
|
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
1399 |
|
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
1400 @item mincolormap |
|
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
1401 |
|
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
1402 @item name |
|
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
1403 |
| 6888 | 1404 @item nextplot |
| 6889 | 1405 May be one of |
|
14853
72b8b39e12be
doc: Periodic grammarcheck of documentation.
Rik <octave@nomad.inbox5.com>
parents:
14577
diff
changeset
|
1406 |
|
17281
bc924baa2c4e
doc: Add new @qcode macro for code samples which are quoted.
Rik <rik@octave.org>
parents:
17170
diff
changeset
|
1407 @table @asis |
|
bc924baa2c4e
doc: Add new @qcode macro for code samples which are quoted.
Rik <rik@octave.org>
parents:
17170
diff
changeset
|
1408 @item @qcode{"new"} |
|
bc924baa2c4e
doc: Add new @qcode macro for code samples which are quoted.
Rik <rik@octave.org>
parents:
17170
diff
changeset
|
1409 |
|
bc924baa2c4e
doc: Add new @qcode macro for code samples which are quoted.
Rik <rik@octave.org>
parents:
17170
diff
changeset
|
1410 @item @qcode{"add"} |
|
bc924baa2c4e
doc: Add new @qcode macro for code samples which are quoted.
Rik <rik@octave.org>
parents:
17170
diff
changeset
|
1411 |
|
bc924baa2c4e
doc: Add new @qcode macro for code samples which are quoted.
Rik <rik@octave.org>
parents:
17170
diff
changeset
|
1412 @item @qcode{"replace"} |
|
bc924baa2c4e
doc: Add new @qcode macro for code samples which are quoted.
Rik <rik@octave.org>
parents:
17170
diff
changeset
|
1413 |
|
bc924baa2c4e
doc: Add new @qcode macro for code samples which are quoted.
Rik <rik@octave.org>
parents:
17170
diff
changeset
|
1414 @item @qcode{"replacechildren"} |
| 6889 | 1415 @end table |
|
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
1416 |
|
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
1417 @item numbertitle |
|
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
1418 |
| 6888 | 1419 @item paperorientation |
|
17281
bc924baa2c4e
doc: Add new @qcode macro for code samples which are quoted.
Rik <rik@octave.org>
parents:
17170
diff
changeset
|
1420 Indicates the orientation for printing. Either @qcode{"landscape"} or |
|
bc924baa2c4e
doc: Add new @qcode macro for code samples which are quoted.
Rik <rik@octave.org>
parents:
17170
diff
changeset
|
1421 @qcode{"portrait"}. |
|
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
1422 |
|
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
1423 @item paperposition |
|
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
1424 |
|
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
1425 @item paperpositionmode |
|
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
1426 |
|
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
1427 @item papersize |
|
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
1428 |
|
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
1429 @item papertype |
|
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
1430 |
|
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
1431 @item paperunits |
|
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
1432 |
|
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
1433 @item pointer |
|
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
1434 |
|
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
1435 @item pointershapecdata |
|
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
1436 |
|
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
1437 @item pointershapehotspot |
|
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
1438 |
|
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
1439 @item position |
|
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
1440 |
|
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
1441 @item renderer |
|
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
1442 |
|
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
1443 @item renderermode |
|
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
1444 |
|
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
1445 @item resize |
|
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
1446 |
|
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
1447 @item resizefcn |
|
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
1448 |
|
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
1449 @item selected |
|
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 selectionhighlight |
|
17281
bc924baa2c4e
doc: Add new @qcode macro for code samples which are quoted.
Rik <rik@octave.org>
parents:
17170
diff
changeset
|
1452 --- Values: @qcode{"on"}, @qcode{"off"} |
|
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
1453 |
|
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
1454 @item selectiontype |
|
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
1455 |
|
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
1456 @item tag |
|
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
1457 |
|
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
1458 @item toolbar |
|
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
1459 |
|
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
1460 @item type |
|
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
1461 |
|
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
1462 @item units |
|
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
1463 |
|
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
1464 @item userdata |
|
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 visible |
|
17281
bc924baa2c4e
doc: Add new @qcode macro for code samples which are quoted.
Rik <rik@octave.org>
parents:
17170
diff
changeset
|
1467 Either @qcode{"on"} or @qcode{"off"} to toggle display of the figure. |
|
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 windowbuttondownfcn |
|
17281
bc924baa2c4e
doc: Add new @qcode macro for code samples which are quoted.
Rik <rik@octave.org>
parents:
17170
diff
changeset
|
1470 See @qcode{"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 windowbuttonmotionfcn |
|
17281
bc924baa2c4e
doc: Add new @qcode macro for code samples which are quoted.
Rik <rik@octave.org>
parents:
17170
diff
changeset
|
1473 See @qcode{"windowbuttonupfcn"} |
|
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
1474 |
|
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
1475 @item windowbuttonupfcn |
|
17281
bc924baa2c4e
doc: Add new @qcode macro for code samples which are quoted.
Rik <rik@octave.org>
parents:
17170
diff
changeset
|
1476 With @qcode{"windowbuttondownfcn"} and @qcode{"windowbuttonmotionfcn"}, |
|
bc924baa2c4e
doc: Add new @qcode macro for code samples which are quoted.
Rik <rik@octave.org>
parents:
17170
diff
changeset
|
1477 the mouse callback functions. These callback functions get called when |
|
10711
fbd7843974fa
Periodic grammar check of documentation files to ensure common format.
Rik <octave@nomad.inbox5.com>
parents:
10599
diff
changeset
|
1478 the mouse button is pressed, dragged, and released respectively. When |
|
17281
bc924baa2c4e
doc: Add new @qcode macro for code samples which are quoted.
Rik <rik@octave.org>
parents:
17170
diff
changeset
|
1479 these callback functions are called, the @qcode{"currentpoint"} property |
|
10522
6538ff562949
document keypress and mouse callback properties
Shai Ayal <shaiay@users.sourceforge.net>
parents:
9758
diff
changeset
|
1480 holds the current coordinates of the cursor. |
|
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
1481 |
|
17099
a033fd3669c0
Alphabetize graphic properties and add properties missing from Matlab.
Rik <rik@octave.org>
parents:
17097
diff
changeset
|
1482 @item windowscrollwheelfcn |
|
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
1483 |
|
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
1484 @item windowstyle |
|
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
1485 |
|
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
1486 @item wvisual |
|
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
1487 |
|
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
1488 @item wvisualmode |
|
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
1489 |
|
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
1490 @item xdisplay |
|
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
1491 |
|
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
1492 @item xvisual |
|
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
1493 |
|
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
1494 @item xvisualmode |
| 6888 | 1495 @end table |
| 1496 | |
| 1497 @node Axes Properties | |
| 1498 @subsubsection Axes Properties | |
| 8071 | 1499 @cindex axes properties |
| 6888 | 1500 |
|
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
1501 The @code{axes} properties are: |
|
14853
72b8b39e12be
doc: Periodic grammarcheck of documentation.
Rik <octave@nomad.inbox5.com>
parents:
14577
diff
changeset
|
1502 |
| 6888 | 1503 @table @code |
|
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
1504 @item __modified__ |
|
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
1505 |
|
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
1506 @item __myhandle__ |
|
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
1507 |
|
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
1508 @item activepositionproperty |
|
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
1509 |
|
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
1510 @item alim |
|
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
1511 |
|
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
1512 @item alimmode |
|
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
1513 |
|
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
1514 @item ambientlightcolor |
|
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
1515 |
|
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
1516 @item beingdeleted |
|
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
1517 |
| 6888 | 1518 @item box |
|
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
1519 Box surrounding axes. |
|
17281
bc924baa2c4e
doc: Add new @qcode macro for code samples which are quoted.
Rik <rik@octave.org>
parents:
17170
diff
changeset
|
1520 --- Values: @qcode{"on"}, @qcode{"off"} |
|
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
1521 |
|
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
1522 @item busyaction |
|
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
1523 |
|
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
1524 @item buttondownfcn |
|
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
1525 |
|
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
1526 @item cameraposition |
|
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
1527 |
|
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
1528 @item camerapositionmode |
|
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
1529 |
|
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
1530 @item cameratarget |
|
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
1531 |
|
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
1532 @item cameratargetmode |
|
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
1533 |
|
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
1534 @item cameraupvector |
|
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
1535 |
|
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
1536 @item cameraupvectormode |
|
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
1537 |
|
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
1538 @item cameraviewangle |
|
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
1539 |
|
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
1540 @item cameraviewanglemode |
|
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
1541 |
|
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
1542 @item children |
|
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
1543 |
|
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
1544 @item clim |
|
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
1545 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
|
1546 an image. See @code{pcolor} property. |
|
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
1547 Setting this property also forces the corresponding mode |
|
17281
bc924baa2c4e
doc: Add new @qcode macro for code samples which are quoted.
Rik <rik@octave.org>
parents:
17170
diff
changeset
|
1548 property to be set to @qcode{"manual"}. |
|
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 climmode |
|
17281
bc924baa2c4e
doc: Add new @qcode macro for code samples which are quoted.
Rik <rik@octave.org>
parents:
17170
diff
changeset
|
1551 Either @qcode{"manual"} or @qcode{"auto"}. |
|
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
1552 |
|
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
1553 @item clipping |
|
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
1554 |
|
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
1555 @item color |
|
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
1556 |
|
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
1557 @item colororder |
|
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
1558 |
|
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
1559 @item createfcn |
|
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
1560 |
|
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
1561 @item currentpoint |
|
10522
6538ff562949
document keypress and mouse callback properties
Shai Ayal <shaiay@users.sourceforge.net>
parents:
9758
diff
changeset
|
1562 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
|
1563 the mouse button was pressed. If a mouse callback function is defined, |
|
17281
bc924baa2c4e
doc: Add new @qcode macro for code samples which are quoted.
Rik <rik@octave.org>
parents:
17170
diff
changeset
|
1564 @qcode{"currentpoint"} holds the coordinates of the point over which the |
|
10522
6538ff562949
document keypress and mouse callback properties
Shai Ayal <shaiay@users.sourceforge.net>
parents:
9758
diff
changeset
|
1565 mouse pointer is when the function gets called. |
|
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
1566 |
| 6888 | 1567 @item dataaspectratio |
| 6889 | 1568 A two-element vector specifying the relative height and width of the |
| 1569 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
|
1570 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
|
1571 same as the length of 2 units on the x-axis. Setting |
| 6889 | 1572 @code{dataaspectratio} also forces the @code{dataaspectratiomode} |
|
17281
bc924baa2c4e
doc: Add new @qcode macro for code samples which are quoted.
Rik <rik@octave.org>
parents:
17170
diff
changeset
|
1573 property to be set to @qcode{"manual"}. |
|
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 dataaspectratiomode |
|
17281
bc924baa2c4e
doc: Add new @qcode macro for code samples which are quoted.
Rik <rik@octave.org>
parents:
17170
diff
changeset
|
1576 Either @qcode{"manual"} or @qcode{"auto"}. |
|
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
1577 |
|
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
1578 @item deletefcn |
|
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
1579 |
|
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
1580 @item drawmode |
|
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
1581 |
|
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
1582 @item fontangle |
|
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
1583 |
|
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
1584 @item fontname |
|
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
1585 |
|
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
1586 @item fontsize |
|
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
1587 |
|
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
1588 @item fontunits |
|
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
1589 |
|
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
1590 @item fontweight |
|
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
1591 |
|
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
1592 @item gridlinestyle |
|
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
1593 |
|
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
1594 @item handlevisibility |
|
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
1595 |
|
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
1596 @item hittest |
|
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
1597 |
|
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
1598 @item interpreter |
|
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
1599 |
|
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
1600 @item interruptible |
|
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
1601 |
|
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
1602 @item layer |
|
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
1603 |
|
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
1604 @item linestyleorder |
|
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
1605 |
|
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
1606 @item linewidth |
|
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
1607 |
|
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
1608 @item minorgridlinestyle |
|
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
1609 |
| 6888 | 1610 @item nextplot |
| 6889 | 1611 May be one of |
|
14853
72b8b39e12be
doc: Periodic grammarcheck of documentation.
Rik <octave@nomad.inbox5.com>
parents:
14577
diff
changeset
|
1612 |
|
17281
bc924baa2c4e
doc: Add new @qcode macro for code samples which are quoted.
Rik <rik@octave.org>
parents:
17170
diff
changeset
|
1613 @table @asis |
|
bc924baa2c4e
doc: Add new @qcode macro for code samples which are quoted.
Rik <rik@octave.org>
parents:
17170
diff
changeset
|
1614 @item @qcode{"add"} |
|
bc924baa2c4e
doc: Add new @qcode macro for code samples which are quoted.
Rik <rik@octave.org>
parents:
17170
diff
changeset
|
1615 |
|
bc924baa2c4e
doc: Add new @qcode macro for code samples which are quoted.
Rik <rik@octave.org>
parents:
17170
diff
changeset
|
1616 @item @qcode{"replace"} |
|
bc924baa2c4e
doc: Add new @qcode macro for code samples which are quoted.
Rik <rik@octave.org>
parents:
17170
diff
changeset
|
1617 |
|
bc924baa2c4e
doc: Add new @qcode macro for code samples which are quoted.
Rik <rik@octave.org>
parents:
17170
diff
changeset
|
1618 @item @qcode{"replacechildren"} |
| 6889 | 1619 @end table |
|
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
1620 |
| 6888 | 1621 @item outerposition |
| 8071 | 1622 A vector specifying the position of the plot, including titles, axes and |
| 1623 legend. The four elements of the vector are the coordinates of the | |
| 1624 lower left corner and width and height of the plot, in units normalized | |
| 1625 to the width and height of the plot window. For example, @code{[0.2, | |
| 1626 0.3, 0.4, 0.5]} sets the lower left corner of the axes at @math{(0.2, | |
| 1627 0.3)} and the width and height to be 0.4 and 0.5 respectively. See also | |
| 1628 the @code{position} property. | |
|
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
1629 |
|
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
1630 @item parent |
|
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
1631 |
|
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
1632 @item plotboxaspectratio |
|
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
1633 |
|
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
1634 @item plotboxaspectratiomode |
|
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
1635 |
|
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
1636 @item position |
|
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
1637 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
|
1638 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
|
1639 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
|
1640 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
|
1641 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
|
1642 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
|
1643 the @code{outerposition} property. |
|
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
1644 |
|
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
1645 @item projection |
|
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
1646 |
|
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
1647 @item selected |
|
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
1648 |
|
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
1649 @item selectionhighlight |
|
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
1650 |
|
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
1651 @item tag |
|
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
1652 |
|
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
1653 @item tickdir |
|
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
1654 |
|
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
1655 @item tickdirmode |
|
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
1656 |
|
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
1657 @item ticklength |
|
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
1658 |
|
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
1659 @item tightinset |
|
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
1660 |
|
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
1661 @item title |
|
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
1662 Index of text object for the axes title. |
|
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
1663 |
|
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
1664 @item type |
|
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
1665 |
|
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
1666 @item uicontextmenu |
|
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
1667 |
|
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
1668 @item units |
|
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
1669 |
|
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
1670 @item userdata |
|
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
1671 |
|
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
1672 @item view |
|
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
1673 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
|
1674 |
|
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
1675 @item visible |
|
17281
bc924baa2c4e
doc: Add new @qcode macro for code samples which are quoted.
Rik <rik@octave.org>
parents:
17170
diff
changeset
|
1676 Either @qcode{"on"} or @qcode{"off"} to toggle display of the axes. |
|
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
1677 |
|
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
1678 @item x_normrendertransform |
|
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
1679 |
|
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
1680 @item x_projectiontransform |
|
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
1681 |
|
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
1682 @item x_rendertransform |
|
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
1683 |
|
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
1684 @item x_viewporttransform |
|
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
1685 |
|
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
1686 @item x_viewtransform |
|
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
1687 |
|
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
1688 @item xaxislocation |
|
17281
bc924baa2c4e
doc: Add new @qcode macro for code samples which are quoted.
Rik <rik@octave.org>
parents:
17170
diff
changeset
|
1689 Either @qcode{"top"} or @qcode{"bottom"}. |
|
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
1690 |
|
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
1691 @item xcolor |
|
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
1692 |
|
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
1693 @item xdir |
|
17281
bc924baa2c4e
doc: Add new @qcode macro for code samples which are quoted.
Rik <rik@octave.org>
parents:
17170
diff
changeset
|
1694 Either @qcode{"forward"} or @qcode{"reverse"}. |
|
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
1695 |
|
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
1696 @item xgrid |
|
17281
bc924baa2c4e
doc: Add new @qcode macro for code samples which are quoted.
Rik <rik@octave.org>
parents:
17170
diff
changeset
|
1697 Either @qcode{"on"} or @qcode{"off"} to toggle display of grid lines. |
|
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
1698 |
|
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
1699 @item xlabel |
|
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
1700 Indices to text objects for the axes labels. |
|
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
1701 |
|
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
1702 @item xlim |
|
9758
09da0bd91412
Periodic grammar check of Octave documentation files to ensure common format
Rik <rdrider0-list@yahoo.com>
parents:
9752
diff
changeset
|
1703 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
|
1704 Setting this property also forces the corresponding mode |
|
17281
bc924baa2c4e
doc: Add new @qcode macro for code samples which are quoted.
Rik <rik@octave.org>
parents:
17170
diff
changeset
|
1705 property to be set to @qcode{"manual"}. |
|
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
1706 |
|
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
1707 @item xlimmode |
|
17281
bc924baa2c4e
doc: Add new @qcode macro for code samples which are quoted.
Rik <rik@octave.org>
parents:
17170
diff
changeset
|
1708 Either @qcode{"manual"} or @qcode{"auto"}. |
|
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
1709 |
|
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
1710 @item xminorgrid |
|
17281
bc924baa2c4e
doc: Add new @qcode macro for code samples which are quoted.
Rik <rik@octave.org>
parents:
17170
diff
changeset
|
1711 Either @qcode{"on"} or @qcode{"off"} to toggle display of minor grid lines. |
|
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
1712 |
|
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
1713 @item xminortick |
|
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
1714 |
|
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
1715 @item xscale |
|
17281
bc924baa2c4e
doc: Add new @qcode macro for code samples which are quoted.
Rik <rik@octave.org>
parents:
17170
diff
changeset
|
1716 Either @qcode{"linear"} or @qcode{"log"}. |
|
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
1717 |
|
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
1718 @item xtick |
|
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
1719 Set position of tick marks. |
|
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
1720 Setting this property also forces the corresponding mode |
|
17281
bc924baa2c4e
doc: Add new @qcode macro for code samples which are quoted.
Rik <rik@octave.org>
parents:
17170
diff
changeset
|
1721 property to be set to @qcode{"manual"}. |
|
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
1722 |
|
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
1723 @item xticklabel |
|
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
1724 Setting this property also forces the corresponding mode |
|
17281
bc924baa2c4e
doc: Add new @qcode macro for code samples which are quoted.
Rik <rik@octave.org>
parents:
17170
diff
changeset
|
1725 property to be set to @qcode{"manual"}. |
|
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
1726 |
|
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
1727 @item xticklabelmode |
|
17281
bc924baa2c4e
doc: Add new @qcode macro for code samples which are quoted.
Rik <rik@octave.org>
parents:
17170
diff
changeset
|
1728 Either @qcode{"manual"} or @qcode{"auto"}. |
|
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
1729 |
|
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
1730 @item xtickmode |
|
17281
bc924baa2c4e
doc: Add new @qcode macro for code samples which are quoted.
Rik <rik@octave.org>
parents:
17170
diff
changeset
|
1731 Either @qcode{"manual"} or @qcode{"auto"}. |
|
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
1732 |
|
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
1733 @item yaxislocation |
|
17281
bc924baa2c4e
doc: Add new @qcode macro for code samples which are quoted.
Rik <rik@octave.org>
parents:
17170
diff
changeset
|
1734 Either @qcode{"left"} or @qcode{"right"} |
|
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
1735 |
|
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
1736 @item ycolor |
|
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
1737 |
|
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
1738 @item ydir |
|
17281
bc924baa2c4e
doc: Add new @qcode macro for code samples which are quoted.
Rik <rik@octave.org>
parents:
17170
diff
changeset
|
1739 Either @qcode{"forward"} or @qcode{"reverse"}. |
|
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
1740 |
|
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
1741 @item ygrid |
|
17281
bc924baa2c4e
doc: Add new @qcode macro for code samples which are quoted.
Rik <rik@octave.org>
parents:
17170
diff
changeset
|
1742 Either @qcode{"on"} or @qcode{"off"} to toggle display of grid lines. |
|
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
1743 |
|
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
1744 @item ylabel |
|
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
1745 Indices to text objects for the axes labels. |
|
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
1746 |
|
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
1747 @item ylim |
|
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
1748 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
|
1749 Setting one of these properties also forces the corresponding mode |
|
17281
bc924baa2c4e
doc: Add new @qcode macro for code samples which are quoted.
Rik <rik@octave.org>
parents:
17170
diff
changeset
|
1750 property to be set to @qcode{"manual"}. |
|
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
1751 |
|
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
1752 @item ylimmode |
|
17281
bc924baa2c4e
doc: Add new @qcode macro for code samples which are quoted.
Rik <rik@octave.org>
parents:
17170
diff
changeset
|
1753 Either @qcode{"manual"} or @qcode{"auto"}. |
|
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
1754 |
|
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
1755 @item yminorgrid |
|
17281
bc924baa2c4e
doc: Add new @qcode macro for code samples which are quoted.
Rik <rik@octave.org>
parents:
17170
diff
changeset
|
1756 Either @qcode{"on"} or @qcode{"off"} to toggle display of minor grid lines. |
|
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
1757 |
|
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
1758 @item yminortick |
|
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
1759 |
|
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
1760 @item yscale |
|
17281
bc924baa2c4e
doc: Add new @qcode macro for code samples which are quoted.
Rik <rik@octave.org>
parents:
17170
diff
changeset
|
1761 Either @qcode{"linear"} or @qcode{"log"}. |
|
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
1762 |
|
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
1763 @item ytick |
|
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
1764 Set position of tick marks. |
|
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
1765 Setting this property also forces the corresponding mode |
|
17281
bc924baa2c4e
doc: Add new @qcode macro for code samples which are quoted.
Rik <rik@octave.org>
parents:
17170
diff
changeset
|
1766 property to be set to @qcode{"manual"}. |
|
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
1767 |
|
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
1768 @item yticklabel |
|
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
1769 Setting this property also forces the corresponding mode |
|
17281
bc924baa2c4e
doc: Add new @qcode macro for code samples which are quoted.
Rik <rik@octave.org>
parents:
17170
diff
changeset
|
1770 property to be set to @qcode{"manual"}. |
|
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
1771 |
|
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
1772 @item yticklabelmode |
|
17281
bc924baa2c4e
doc: Add new @qcode macro for code samples which are quoted.
Rik <rik@octave.org>
parents:
17170
diff
changeset
|
1773 Either @qcode{"manual"} or @qcode{"auto"}. |
|
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
1774 |
|
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
1775 @item ytickmode |
|
17281
bc924baa2c4e
doc: Add new @qcode macro for code samples which are quoted.
Rik <rik@octave.org>
parents:
17170
diff
changeset
|
1776 Either @qcode{"manual"} or @qcode{"auto"}. |
|
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
1777 |
|
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
1778 @item zcolor |
|
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
1779 |
|
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
1780 @item zdir |
|
17281
bc924baa2c4e
doc: Add new @qcode macro for code samples which are quoted.
Rik <rik@octave.org>
parents:
17170
diff
changeset
|
1781 Either @qcode{"forward"} or @qcode{"reverse"}. |
|
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
1782 |
|
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
1783 @item zgrid |
|
17281
bc924baa2c4e
doc: Add new @qcode macro for code samples which are quoted.
Rik <rik@octave.org>
parents:
17170
diff
changeset
|
1784 Either @qcode{"on"} or @qcode{"off"} to toggle display of grid lines. |
|
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
1785 |
|
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
1786 @item zlabel |
|
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
1787 Indices to text objects for the axes labels. |
|
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
1788 |
|
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
1789 @item zlim |
|
9758
09da0bd91412
Periodic grammar check of Octave documentation files to ensure common format
Rik <rdrider0-list@yahoo.com>
parents:
9752
diff
changeset
|
1790 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
|
1791 Setting this property also forces the corresponding mode |
|
17281
bc924baa2c4e
doc: Add new @qcode macro for code samples which are quoted.
Rik <rik@octave.org>
parents:
17170
diff
changeset
|
1792 property to be set to @qcode{"manual"}. |
|
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
1793 |
|
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
1794 @item zlimmode |
|
17281
bc924baa2c4e
doc: Add new @qcode macro for code samples which are quoted.
Rik <rik@octave.org>
parents:
17170
diff
changeset
|
1795 Either @qcode{"manual"} or @qcode{"auto"}. |
|
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
1796 |
|
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
1797 @item zminorgrid |
|
17281
bc924baa2c4e
doc: Add new @qcode macro for code samples which are quoted.
Rik <rik@octave.org>
parents:
17170
diff
changeset
|
1798 Either @qcode{"on"} or @qcode{"off"} to toggle display of minor grid lines. |
|
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
1799 |
|
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
1800 @item zminortick |
|
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
1801 |
|
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
1802 @item zscale |
|
17281
bc924baa2c4e
doc: Add new @qcode macro for code samples which are quoted.
Rik <rik@octave.org>
parents:
17170
diff
changeset
|
1803 Either @qcode{"linear"} or @qcode{"log"}. |
|
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
1804 |
|
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
1805 @item ztick |
|
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
1806 Set position of tick marks. |
|
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
1807 Setting this property also forces the corresponding mode |
|
17281
bc924baa2c4e
doc: Add new @qcode macro for code samples which are quoted.
Rik <rik@octave.org>
parents:
17170
diff
changeset
|
1808 property to be set to @qcode{"manual"}. |
|
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
1809 |
|
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
1810 @item zticklabel |
|
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
1811 Setting this property also forces the corresponding mode |
|
17281
bc924baa2c4e
doc: Add new @qcode macro for code samples which are quoted.
Rik <rik@octave.org>
parents:
17170
diff
changeset
|
1812 property to be set to @qcode{"manual"}. |
|
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
1813 |
|
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
1814 @item zticklabelmode |
|
17281
bc924baa2c4e
doc: Add new @qcode macro for code samples which are quoted.
Rik <rik@octave.org>
parents:
17170
diff
changeset
|
1815 Either @qcode{"manual"} or @qcode{"auto"}. |
|
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
1816 |
|
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
1817 @item ztickmode |
|
17281
bc924baa2c4e
doc: Add new @qcode macro for code samples which are quoted.
Rik <rik@octave.org>
parents:
17170
diff
changeset
|
1818 Either @qcode{"manual"} or @qcode{"auto"}. |
|
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
1819 |
| 6888 | 1820 @end table |
| 1821 | |
| 1822 @node Line Properties | |
| 1823 @subsubsection Line Properties | |
| 8071 | 1824 @cindex line properties |
| 6888 | 1825 |
|
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
1826 The @code{line} properties are: |
|
14853
72b8b39e12be
doc: Periodic grammarcheck of documentation.
Rik <octave@nomad.inbox5.com>
parents:
14577
diff
changeset
|
1827 |
| 6888 | 1828 @table @code |
|
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
1829 @item __modified__ |
|
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
1830 |
|
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
1831 @item __myhandle__ |
|
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
1832 |
|
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
1833 @item beingdeleted |
|
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
1834 |
|
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
1835 @item busyaction |
|
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
1836 |
|
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
1837 @item buttondownfcn |
|
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
1838 |
|
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
1839 @item children |
|
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
1840 |
|
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
1841 @item clipping |
|
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
1842 |
| 6888 | 1843 @item color |
| 6889 | 1844 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
|
1845 |
|
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
1846 @item createfcn |
|
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
1847 |
|
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
1848 @item deletefcn |
|
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
1849 |
|
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
1850 @item displayname |
|
13947
8ebff542d133
doc: Remove obsolete "keylabel" and replace by "displayname".
Ben Abbott <bpabbott@mac.com>
parents:
13931
diff
changeset
|
1851 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
|
1852 |
|
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
1853 @item erasemode |
|
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
1854 |
|
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
1855 @item handlevisibility |
|
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
1856 |
|
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
1857 @item hittest |
|
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
1858 |
|
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
1859 @item interpreter |
|
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
1860 |
|
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
1861 @item interruptible |
|
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
1862 |
|
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
1863 @item ldata |
|
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
1864 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
|
1865 |
|
17097
e7a059a9a644
doc: Use XREF as anchor prefix in documentation for clearer results in Info viewer.
Rik <rik@octave.org>
parents:
16923
diff
changeset
|
1866 @item linestyle |
| 6889 | 1867 @itemx linewidth |
| 1868 @xref{Line Styles}. | |
|
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
1869 |
|
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
1870 @item linewidth |
|
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
1871 |
| 6888 | 1872 @item marker |
|
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
1873 |
| 6888 | 1874 @item markeredgecolor |
|
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
1875 |
| 6888 | 1876 @item markerfacecolor |
|
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
1877 |
| 6888 | 1878 @item markersize |
| 6889 | 1879 @xref{Marker Styles}. |
|
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
1880 |
|
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
1881 @item parent |
|
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
1882 |
|
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
1883 @item selected |
|
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
1884 |
|
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
1885 @item selectionhighlight |
|
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
1886 |
|
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
1887 @item tag |
|
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
1888 |
|
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
1889 @item type |
|
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
1890 |
|
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
1891 @item udata |
|
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
1892 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
|
1893 |
|
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
1894 @item uicontextmenu |
|
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
1895 |
|
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
1896 @item userdata |
|
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
1897 |
|
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
1898 @item visible |
|
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
1899 |
|
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
1900 @item xdata |
|
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
1901 The data to be plotted. |
|
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
1902 |
|
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
1903 @item xdatasource |
|
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
1904 |
|
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
1905 @item xldata |
|
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
1906 The lower errorbar to be plotted. |
|
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
1907 |
|
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
1908 @item xlim |
|
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
1909 |
|
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
1910 @item xliminclude |
|
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
1911 |
|
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
1912 @item xudata |
|
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
1913 The upper errorbar to be plotted. |
|
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
1914 |
|
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
1915 @item ydata |
|
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
1916 The data to be plotted. |
|
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
1917 |
|
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
1918 @item ydatasource |
|
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
1919 |
|
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
1920 @item ylim |
|
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
1921 |
|
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
1922 @item yliminclude |
|
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
1923 |
|
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
1924 @item zdata |
|
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
1925 The data to be plotted. |
|
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
1926 |
|
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
1927 @item zdatasource |
|
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
1928 |
|
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
1929 @item zlim |
|
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
1930 |
|
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
1931 @item zliminclude |
| 6888 | 1932 @end table |
| 1933 | |
| 1934 @node Text Properties | |
| 1935 @subsubsection Text Properties | |
| 8071 | 1936 @cindex text properties |
| 6888 | 1937 |
|
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
1938 The @code{text} properties are: |
|
14853
72b8b39e12be
doc: Periodic grammarcheck of documentation.
Rik <octave@nomad.inbox5.com>
parents:
14577
diff
changeset
|
1939 |
| 6888 | 1940 @table @code |
|
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
1941 @item __modified__ |
|
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
1942 |
|
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
1943 @item __myhandle__ |
|
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
1944 |
|
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
1945 @item backgroundcolor |
|
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
1946 |
|
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
1947 @item beingdeleted |
|
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
1948 |
|
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
1949 @item busyaction |
|
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
1950 |
|
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
1951 @item buttondownfcn |
|
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
1952 |
|
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
1953 @item children |
|
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
1954 |
|
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
1955 @item clipping |
|
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
1956 |
| 6888 | 1957 @item color |
| 6889 | 1958 The color of the text. @xref{Colors}. |
|
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
1959 |
|
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
1960 @item createfcn |
|
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
1961 |
|
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
1962 @item deletefcn |
|
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
1963 |
|
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
1964 @item displayname |
|
13947
8ebff542d133
doc: Remove obsolete "keylabel" and replace by "displayname".
Ben Abbott <bpabbott@mac.com>
parents:
13931
diff
changeset
|
1965 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
|
1966 |
|
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
1967 @item edgecolor |
|
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
1968 |
|
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
1969 @item editing |
|
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
1970 |
|
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
1971 @item erasemode |
|
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
1972 |
| 7189 | 1973 @item fontangle |
|
17281
bc924baa2c4e
doc: Add new @qcode macro for code samples which are quoted.
Rik <rik@octave.org>
parents:
17170
diff
changeset
|
1974 Flag whether the font is italic or normal. Valid values are @qcode{"normal"}, |
|
bc924baa2c4e
doc: Add new @qcode macro for code samples which are quoted.
Rik <rik@octave.org>
parents:
17170
diff
changeset
|
1975 @qcode{"italic"}, and @qcode{"oblique"}. |
|
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
1976 |
|
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
1977 @item fontname |
|
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
1978 The font used for the text. |
|
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
1979 |
|
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
1980 @item fontsize |
|
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
1981 The size of the font, in points to use. |
|
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
1982 |
|
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
1983 @item fontunits |
|
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
1984 |
| 7189 | 1985 @item fontweight |
|
17281
bc924baa2c4e
doc: Add new @qcode macro for code samples which are quoted.
Rik <rik@octave.org>
parents:
17170
diff
changeset
|
1986 Flag whether the font is bold, etc. Valid values are @qcode{"normal"}, |
|
bc924baa2c4e
doc: Add new @qcode macro for code samples which are quoted.
Rik <rik@octave.org>
parents:
17170
diff
changeset
|
1987 @qcode{"bold"}, @qcode{"demi"}, or @qcode{"light"}. |
|
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
1988 |
|
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
1989 @item handlevisibility |
|
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
1990 |
|
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
1991 @item hittest |
|
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
1992 |
|
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
1993 @item horizontalalignment |
|
17281
bc924baa2c4e
doc: Add new @qcode macro for code samples which are quoted.
Rik <rik@octave.org>
parents:
17170
diff
changeset
|
1994 May be @qcode{"left"}, @qcode{"center"}, or @qcode{"right"}. |
|
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
1995 |
| 7189 | 1996 @item interpreter |
|
17281
bc924baa2c4e
doc: Add new @qcode macro for code samples which are quoted.
Rik <rik@octave.org>
parents:
17170
diff
changeset
|
1997 Determines how the text is rendered. Valid values are @qcode{"none"}, |
|
bc924baa2c4e
doc: Add new @qcode macro for code samples which are quoted.
Rik <rik@octave.org>
parents:
17170
diff
changeset
|
1998 @qcode{"tex"}, or @qcode{"latex"}. |
|
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
1999 |
|
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
2000 @item interruptible |
|
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
2001 |
|
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
2002 @item linestyle |
|
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
2003 |
|
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
2004 @item linewidth |
|
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
2005 |
|
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
2006 @item margin |
|
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
2007 |
|
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
2008 @item parent |
|
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
2009 |
|
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
2010 @item position |
|
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
2011 The coordinates of the text object. |
|
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
2012 |
|
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
2013 @item rotation |
|
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
2014 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
|
2015 |
|
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
2016 @item selected |
|
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
2017 |
|
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
2018 @item selectionhighlight |
|
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
2019 |
|
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
2020 @item string |
|
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
2021 The character string contained by the text object. |
|
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
2022 |
|
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
2023 @item tag |
|
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
2024 |
|
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
2025 @item type |
|
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
2026 |
|
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
2027 @item uicontextmenu |
|
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
2028 |
|
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
2029 @item units |
|
17281
bc924baa2c4e
doc: Add new @qcode macro for code samples which are quoted.
Rik <rik@octave.org>
parents:
17170
diff
changeset
|
2030 May be @qcode{"normalized"} or @qcode{"graph"}. |
|
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
2031 |
|
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
2032 @item userdata |
|
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
2033 |
|
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
2034 @item verticalalignment |
|
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
2035 |
|
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
2036 @item visible |
|
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
2037 |
|
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
2038 @item xlim |
|
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
2039 |
|
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
2040 @item xliminclude |
|
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
2041 |
|
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
2042 @item ylim |
|
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
2043 |
|
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
2044 @item yliminclude |
|
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
2045 |
|
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
2046 @item zlim |
|
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
2047 |
|
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
2048 @item zliminclude |
|
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
2049 |
| 6888 | 2050 @end table |
| 2051 | |
| 2052 @node Image Properties | |
| 2053 @subsubsection Image Properties | |
| 8071 | 2054 @cindex image properties |
| 6888 | 2055 |
|
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
2056 The @code{image} properties are: |
|
14853
72b8b39e12be
doc: Periodic grammarcheck of documentation.
Rik <octave@nomad.inbox5.com>
parents:
14577
diff
changeset
|
2057 |
| 6888 | 2058 @table @code |
|
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
2059 @item __modified__ |
|
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
2060 |
|
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
2061 @item __myhandle__ |
|
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
2062 |
|
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
2063 @item beingdeleted |
|
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
2064 |
|
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
2065 @item busyaction |
|
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
2066 |
|
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
2067 @item buttondownfcn |
|
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
2068 |
| 6888 | 2069 @item cdata |
| 6889 | 2070 The data for the image. Each pixel of the image corresponds to an |
| 2071 element of @code{cdata}. The value of an element of @code{cdata} | |
| 2072 specifies the row-index into the colormap of the axes object containing | |
| 2073 the image. The color value found in the color map for the given index | |
| 2074 determines the color of the pixel. | |
|
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
2075 |
|
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
2076 @item cdatamapping |
|
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
2077 |
|
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
2078 @item children |
|
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
2079 |
|
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
2080 @item clim |
|
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
2081 |
|
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
2082 @item climinclude |
|
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
2083 |
|
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
2084 @item clipping |
|
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
2085 |
|
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
2086 @item createfcn |
|
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
2087 |
|
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
2088 @item deletefcn |
|
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
2089 |
|
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
2090 @item handlevisibility |
|
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
2091 |
|
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
2092 @item hittest |
|
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
2093 |
|
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
2094 @item interruptible |
|
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
2095 |
|
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
2096 @item parent |
|
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
2097 |
|
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
2098 @item selected |
|
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
2099 |
|
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
2100 @item selectionhighlight |
|
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
2101 |
|
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
2102 @item tag |
|
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
2103 |
|
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
2104 @item type |
|
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
2105 |
|
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
2106 @item uicontextmenu |
|
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
2107 |
|
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
2108 @item userdata |
|
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
2109 |
|
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
2110 @item visible |
|
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
2111 |
| 6889 | 2112 @item xdata |
|
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
2113 Two-element vector specifying the range of the x-coordinates for |
| 6889 | 2114 the image. |
|
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
2115 |
|
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
2116 @item xlim |
|
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
2117 |
|
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
2118 @item xliminclude |
|
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
2119 |
|
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
2120 @item ydata |
|
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
2121 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
|
2122 the image. |
|
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
2123 |
|
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
2124 @item ylim |
|
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
2125 |
|
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
2126 @item yliminclude |
| 6888 | 2127 @end table |
| 2128 | |
| 2129 @node Patch Properties | |
| 2130 @subsubsection Patch Properties | |
| 8071 | 2131 @cindex patch properties |
| 6888 | 2132 |
|
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
2133 The @code{patch} properties are: |
|
14853
72b8b39e12be
doc: Periodic grammarcheck of documentation.
Rik <octave@nomad.inbox5.com>
parents:
14577
diff
changeset
|
2134 |
| 6888 | 2135 @table @code |
|
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
2136 @item __modified__ |
|
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
2137 |
|
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
2138 @item __myhandle__ |
|
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
2139 |
|
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
2140 @item alim |
|
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
2141 |
|
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
2142 @item aliminclude |
|
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
2143 |
|
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
2144 @item alphadatamapping |
|
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
2145 |
|
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
2146 @item ambientstrength |
|
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
2147 |
|
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
2148 @item backfacelighting |
|
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
2149 |
|
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
2150 @item beingdeleted |
|
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
2151 |
|
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
2152 @item busyaction |
|
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
2153 |
|
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
2154 @item buttondownfcn |
|
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
2155 |
| 6888 | 2156 @item cdata |
| 6889 | 2157 Data defining the patch object. |
|
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
2158 |
|
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
2159 @item cdatamapping |
|
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
2160 |
|
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
2161 @item children |
|
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
2162 |
|
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
2163 @item clim |
|
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
2164 |
|
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
2165 @item climinclude |
|
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
2166 |
|
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
2167 @item clipping |
|
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
2168 |
|
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
2169 @item createfcn |
|
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
2170 |
|
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
2171 @item deletefcn |
|
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
2172 |
|
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
2173 @item diffusestrength |
|
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
2174 |
|
13947
8ebff542d133
doc: Remove obsolete "keylabel" and replace by "displayname".
Ben Abbott <bpabbott@mac.com>
parents:
13931
diff
changeset
|
2175 @item displayname |
|
8ebff542d133
doc: Remove obsolete "keylabel" and replace by "displayname".
Ben Abbott <bpabbott@mac.com>
parents:
13931
diff
changeset
|
2176 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
|
2177 |
|
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
2178 @item edgealpha |
|
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
2179 |
|
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
2180 @item edgecolor |
|
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
2181 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
|
2182 |
|
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
2183 @item edgelighting |
|
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
2184 |
|
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
2185 @item erasemode |
|
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
2186 |
| 6888 | 2187 @item facealpha |
| 6889 | 2188 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
|
2189 |
|
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
2190 @item facecolor |
|
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
2191 The fill color of the patch. @xref{Colors}. |
|
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
2192 |
|
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
2193 @item facelighting |
|
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
2194 |
|
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
2195 @item faces |
|
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
2196 |
|
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
2197 @item facevertexalphadata |
|
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
2198 |
|
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
2199 @item facevertexcdata |
|
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
2200 |
|
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
2201 @item handlevisibility |
|
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
2202 |
|
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
2203 @item hittest |
|
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
2204 |
|
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
2205 @item interpreter |
|
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
2206 |
|
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
2207 @item interruptible |
|
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
2208 |
| 6888 | 2209 @item linestyle |
|
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
2210 @xref{Line Styles}. |
|
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
2211 |
|
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
2212 @item linewidth |
| 6889 | 2213 @xref{Line Styles}. |
|
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
2214 |
| 6888 | 2215 @item marker |
|
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
2216 @xref{Marker Styles}. |
|
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
2217 |
|
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
2218 @item markeredgecolor |
|
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
2219 @xref{Marker Styles}. |
|
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
2220 |
|
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
2221 @item markerfacecolor |
|
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
2222 @xref{Marker Styles}. |
|
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
2223 |
|
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
2224 @item markersize |
| 6889 | 2225 @xref{Marker Styles}. |
|
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
2226 |
|
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
2227 @item normalmode |
|
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
2228 |
|
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
2229 @item parent |
|
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
2230 |
|
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
2231 @item selected |
|
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
2232 |
|
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
2233 @item selectionhighlight |
|
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
2234 |
|
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
2235 @item specularcolorreflectance |
|
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
2236 |
|
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
2237 @item specularexponent |
|
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
2238 |
|
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
2239 @item specularstrength |
|
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
2240 |
|
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
2241 @item tag |
|
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
2242 |
|
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
2243 @item type |
|
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
2244 |
|
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
2245 @item uicontextmenu |
|
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
2246 |
|
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
2247 @item userdata |
|
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
2248 |
|
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
2249 @item vertexnormals |
|
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
2250 |
|
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
2251 @item vertices |
|
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
2252 |
|
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
2253 @item visible |
|
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
2254 |
|
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
2255 @item xdata |
|
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
2256 Data defining the patch object. |
|
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
2257 |
|
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
2258 @item xlim |
|
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
2259 |
|
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
2260 @item xliminclude |
|
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
2261 |
|
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
2262 @item ydata |
|
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
2263 Data defining the patch object. |
|
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
2264 |
|
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
2265 @item ylim |
|
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
2266 |
|
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
2267 @item yliminclude |
|
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
2268 |
|
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
2269 @item zdata |
|
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
2270 Data defining the patch object. |
|
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
2271 |
|
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
2272 @item zlim |
|
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
2273 |
|
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
2274 @item zliminclude |
|
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
2275 |
| 6888 | 2276 @end table |
| 2277 | |
| 2278 @node Surface Properties | |
| 2279 @subsubsection Surface Properties | |
| 8071 | 2280 @cindex surface properties |
| 6888 | 2281 |
|
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
2282 The @code{surface} properties are: |
|
14853
72b8b39e12be
doc: Periodic grammarcheck of documentation.
Rik <octave@nomad.inbox5.com>
parents:
14577
diff
changeset
|
2283 |
| 6888 | 2284 @table @code |
|
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
2285 @item __modified__ |
|
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
2286 |
|
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
2287 @item __myhandle__ |
|
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
2288 |
|
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
2289 @item alim |
|
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
2290 |
|
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
2291 @item aliminclude |
|
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
2292 |
|
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
2293 @item alphadata |
|
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
2294 |
|
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
2295 @item alphadatamapping |
|
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
2296 |
|
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
2297 @item ambientstrength |
|
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
2298 |
|
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
2299 @item backfacelighting |
|
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
2300 |
|
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
2301 @item beingdeleted |
|
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
2302 |
|
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
2303 @item busyaction |
|
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
2304 |
|
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
2305 @item buttondownfcn |
|
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
2306 |
|
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
2307 @item cdata |
|
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
2308 |
|
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
2309 @item cdatamapping |
|
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
2310 |
|
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
2311 @item cdatasource |
|
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
2312 |
|
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
2313 @item children |
|
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
2314 |
|
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
2315 @item clim |
|
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
2316 |
|
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
2317 @item climinclude |
|
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
2318 |
|
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
2319 @item clipping |
|
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
2320 |
|
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
2321 @item createfcn |
|
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
2322 |
|
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
2323 @item deletefcn |
|
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
2324 |
|
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
2325 @item diffusestrength |
|
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
2326 |
|
13947
8ebff542d133
doc: Remove obsolete "keylabel" and replace by "displayname".
Ben Abbott <bpabbott@mac.com>
parents:
13931
diff
changeset
|
2327 @item displayname |
|
8ebff542d133
doc: Remove obsolete "keylabel" and replace by "displayname".
Ben Abbott <bpabbott@mac.com>
parents:
13931
diff
changeset
|
2328 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
|
2329 |
|
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
2330 @item edgealpha |
|
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
2331 |
|
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
2332 @item edgecolor |
|
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
2333 |
|
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
2334 @item edgelighting |
|
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
2335 |
|
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
2336 @item erasemode |
|
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
2337 |
|
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
2338 @item facealpha |
|
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
2339 |
|
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
2340 @item facecolor |
|
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
2341 |
|
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
2342 @item facelighting |
|
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
2343 |
|
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
2344 @item handlevisibility |
|
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
2345 |
|
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
2346 @item hittest |
|
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
2347 |
|
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
2348 @item interpreter |
|
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
2349 |
|
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
2350 @item interruptible |
|
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
2351 |
|
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
2352 @item linestyle |
|
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
2353 |
|
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
2354 @item linewidth |
|
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
2355 |
|
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
2356 @item marker |
|
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
2357 |
|
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
2358 @item markeredgecolor |
|
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
2359 |
|
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
2360 @item markerfacecolor |
|
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
2361 |
|
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
2362 @item markersize |
|
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
2363 |
|
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
2364 @item meshstyle |
|
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
2365 |
|
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
2366 @item normalmode |
|
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
2367 |
|
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
2368 @item parent |
|
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
2369 |
|
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
2370 @item selected |
|
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
2371 |
|
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
2372 @item selectionhighlight |
|
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
2373 |
|
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
2374 @item specularcolorreflectance |
|
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
2375 |
|
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
2376 @item specularexponent |
|
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
2377 |
|
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
2378 @item specularstrength |
|
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
2379 |
|
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
2380 @item tag |
|
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
2381 |
|
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
2382 @item type |
|
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
2383 |
|
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
2384 @item uicontextmenu |
|
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
2385 |
|
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
2386 @item userdata |
|
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
2387 |
|
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
2388 @item vertexnormals |
|
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
2389 |
|
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
2390 @item visible |
|
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
2391 |
|
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
2392 @item xdata |
|
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
2393 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
|
2394 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
|
2395 |
|
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
2396 @item xdatasource |
|
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
2397 |
|
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
2398 @item xlim |
|
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
2399 |
|
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
2400 @item xliminclude |
|
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
2401 |
|
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
2402 @item ydata |
|
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
2403 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
|
2404 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
|
2405 |
|
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
2406 @item ydatasource |
|
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
2407 |
|
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
2408 @item ylim |
|
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
2409 |
|
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
2410 @item yliminclude |
|
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
2411 |
|
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
2412 @item zdata |
|
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
2413 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
|
2414 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
|
2415 |
|
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
2416 @item zdatasource |
|
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
2417 |
|
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
2418 @item zlim |
|
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
2419 |
|
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
2420 @item zliminclude |
| 6889 | 2421 @end table |
| 2422 | |
|
8070
3b53b25e2550
Add data sources and line series
David Bateman <dbateman@free.fr>
parents:
8057
diff
changeset
|
2423 @node Searching Properties |
|
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
2424 @subsection Searching Properties |
|
7984
bbaa5d7d0143
Some documentation updates
David Bateman <dbateman@free.fr>
parents:
7981
diff
changeset
|
2425 |
|
bbaa5d7d0143
Some documentation updates
David Bateman <dbateman@free.fr>
parents:
7981
diff
changeset
|
2426 @DOCSTRING(findobj) |
|
bbaa5d7d0143
Some documentation updates
David Bateman <dbateman@free.fr>
parents:
7981
diff
changeset
|
2427 |
|
bbaa5d7d0143
Some documentation updates
David Bateman <dbateman@free.fr>
parents:
7981
diff
changeset
|
2428 @DOCSTRING(findall) |
| 6891 | 2429 @node Managing Default Properties |
| 2430 @subsection Managing Default Properties | |
| 8071 | 2431 @cindex default graphics properties |
| 2432 @cindex graphics properties, default | |
| 6891 | 2433 |
| 6892 | 2434 Object properties have two classes of default values, @dfn{factory |
| 2435 defaults} (the initial values) and @dfn{user-defined defaults}, which | |
| 2436 may override the factory defaults. | |
| 6891 | 2437 |
| 2438 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
|
2439 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
|
2440 For example, setting the default @code{color} property of @code{line} |
|
17281
bc924baa2c4e
doc: Add new @qcode macro for code samples which are quoted.
Rik <rik@octave.org>
parents:
17170
diff
changeset
|
2441 objects to @qcode{"green"}, for the @code{root} object, will result in all |
|
bc924baa2c4e
doc: Add new @qcode macro for code samples which are quoted.
Rik <rik@octave.org>
parents:
17170
diff
changeset
|
2442 @code{line} objects inheriting the @code{color} @qcode{"green"} as the default |
|
12610
bdf694af4aa5
plot.txi: Clarify that inheritance of default property values only applies to the named object type.
Ben Abbott <bpabbott@mac.com>
parents:
12578
diff
changeset
|
2443 value. |
| 6891 | 2444 |
| 2445 @example | |
| 2446 set (0, "defaultlinecolor", "green"); | |
| 2447 @end example | |
| 2448 | |
| 2449 @noindent | |
| 2450 sets the default line color for all objects. The rule for constructing | |
| 2451 the property name to set a default value is | |
| 2452 | |
| 2453 @example | |
| 2454 default + @var{object-type} + @var{property-name} | |
| 2455 @end example | |
| 2456 | |
| 2457 This rule can lead to some strange looking names, for example | |
| 2458 @code{defaultlinelinewidth"} specifies the default @code{linewidth} | |
| 2459 property for @code{line} objects. | |
| 2460 | |
| 2461 The example above used the root figure object, 0, so the default | |
| 2462 property value will apply to all line objects. However, default values | |
| 2463 are hierarchical, so defaults set in a figure objects override those | |
| 2464 set in the root figure object. Likewise, defaults set in axes objects | |
| 2465 override those set in figure or root figure objects. For example, | |
| 2466 | |
| 2467 @example | |
| 2468 @group | |
| 2469 subplot (2, 1, 1); | |
| 2470 set (0, "defaultlinecolor", "red"); | |
| 2471 set (1, "defaultlinecolor", "green"); | |
| 2472 set (gca (), "defaultlinecolor", "blue"); | |
| 2473 line (1:10, rand (1, 10)); | |
| 2474 subplot (2, 1, 2); | |
| 2475 line (1:10, rand (1, 10)); | |
| 2476 figure (2) | |
| 2477 line (1:10, rand (1, 10)); | |
| 2478 @end group | |
| 2479 @end example | |
| 2480 | |
| 2481 @noindent | |
| 2482 produces two figures. The line in first subplot window of the first | |
| 2483 figure is blue because it inherits its color from its parent axes | |
| 2484 object. The line in the second subplot window of the first figure is | |
| 2485 green because it inherits its color from its parent figure object. The | |
| 2486 line in the second figure window is red because it inherits its color | |
| 2487 from the global root figure parent object. | |
| 2488 | |
| 2489 To remove a user-defined default setting, set the default property to | |
|
17281
bc924baa2c4e
doc: Add new @qcode macro for code samples which are quoted.
Rik <rik@octave.org>
parents:
17170
diff
changeset
|
2490 the value @qcode{"remove"}. For example, |
| 6891 | 2491 |
| 2492 @example | |
| 2493 set (gca (), "defaultlinecolor", "remove"); | |
| 2494 @end example | |
| 2495 | |
| 2496 @noindent | |
| 2497 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
|
2498 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
|
2499 function. |
|
9558ca33648d
Add functions reset, whitebg to documentation.
Rik <octave@nomad.inbox5.com>
parents:
11591
diff
changeset
|
2500 |
|
9558ca33648d
Add functions reset, whitebg to documentation.
Rik <octave@nomad.inbox5.com>
parents:
11591
diff
changeset
|
2501 @DOCSTRING(reset) |
| 6891 | 2502 |
|
17281
bc924baa2c4e
doc: Add new @qcode macro for code samples which are quoted.
Rik <rik@octave.org>
parents:
17170
diff
changeset
|
2503 Getting the @qcode{"default"} property of an object returns a list of |
| 6891 | 2504 user-defined defaults set for the object. For example, |
| 2505 | |
| 2506 @example | |
| 2507 get (gca (), "default"); | |
| 2508 @end example | |
| 2509 | |
| 2510 @noindent | |
| 2511 returns a list of user-defined default values for the current axes | |
| 2512 object. | |
| 2513 | |
| 2514 Factory default values are stored in the root figure object. The | |
| 2515 command | |
| 2516 | |
| 2517 @example | |
| 2518 get (0, "factory"); | |
| 2519 @end example | |
| 2520 | |
| 2521 @noindent | |
| 2522 returns a list of factory defaults. | |
| 2523 | |
|
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
2524 @node Advanced Plotting |
|
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
2525 @section Advanced Plotting |
|
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
2526 |
|
12525
d36266a54202
Add getappdata, setappdata, isappdata, rmappdata functions to documentation.
Rik <octave@nomad.inbox5.com>
parents:
12522
diff
changeset
|
2527 |
|
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
2528 @menu |
|
17152
f2a8592b8fbd
doc: Shorten some long subsection names in Manual.
Rik <rik@octave.org>
parents:
17123
diff
changeset
|
2529 * Colors:: |
|
f2a8592b8fbd
doc: Shorten some long subsection names in Manual.
Rik <rik@octave.org>
parents:
17123
diff
changeset
|
2530 * Line Styles:: |
|
f2a8592b8fbd
doc: Shorten some long subsection names in Manual.
Rik <rik@octave.org>
parents:
17123
diff
changeset
|
2531 * Marker Styles:: |
|
f2a8592b8fbd
doc: Shorten some long subsection names in Manual.
Rik <rik@octave.org>
parents:
17123
diff
changeset
|
2532 * Callbacks:: |
|
12525
d36266a54202
Add getappdata, setappdata, isappdata, rmappdata functions to documentation.
Rik <octave@nomad.inbox5.com>
parents:
12522
diff
changeset
|
2533 * Application-defined Data:: |
|
17152
f2a8592b8fbd
doc: Shorten some long subsection names in Manual.
Rik <rik@octave.org>
parents:
17123
diff
changeset
|
2534 * Object Groups:: |
|
f2a8592b8fbd
doc: Shorten some long subsection names in Manual.
Rik <rik@octave.org>
parents:
17123
diff
changeset
|
2535 * Graphics Toolkits:: |
|
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
2536 @end menu |
|
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
2537 |
|
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
2538 |
| 6889 | 2539 @node Colors |
| 2540 @subsection Colors | |
| 8071 | 2541 @cindex graphics colors |
| 2542 @cindex colors, graphics | |
| 6889 | 2543 |
| 2544 Colors may be specified as RGB triplets with values ranging from zero to | |
|
17281
bc924baa2c4e
doc: Add new @qcode macro for code samples which are quoted.
Rik <rik@octave.org>
parents:
17170
diff
changeset
|
2545 one, or by name. Recognized color names include @qcode{"blue"}, |
|
bc924baa2c4e
doc: Add new @qcode macro for code samples which are quoted.
Rik <rik@octave.org>
parents:
17170
diff
changeset
|
2546 @qcode{"black"}, @qcode{"cyan"}, @qcode{"green"}, @qcode{"magenta"}, |
|
bc924baa2c4e
doc: Add new @qcode macro for code samples which are quoted.
Rik <rik@octave.org>
parents:
17170
diff
changeset
|
2547 @qcode{"red"}, @qcode{"white"}, and @qcode{"yellow"}. |
| 6889 | 2548 |
| 2549 @node Line Styles | |
| 2550 @subsection Line Styles | |
| 8071 | 2551 @cindex line styles, graphics |
| 2552 @cindex graphics line styles | |
| 2553 | |
| 7001 | 2554 Line styles are specified by the following properties: |
| 6889 | 2555 |
| 2556 @table @code | |
| 2557 @item linestyle | |
| 2558 May be one of | |
|
14853
72b8b39e12be
doc: Periodic grammarcheck of documentation.
Rik <octave@nomad.inbox5.com>
parents:
14577
diff
changeset
|
2559 |
| 6889 | 2560 @table @code |
| 2561 @item "-" | |
|
12690
e9e35a707721
doc: Add 'none' to list of plot linestyles.
Rik <octave@nomad.inbox5.com>
parents:
12607
diff
changeset
|
2562 Solid line. [default] |
|
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
2563 |
| 6889 | 2564 @item "--" |
|
12690
e9e35a707721
doc: Add 'none' to list of plot linestyles.
Rik <octave@nomad.inbox5.com>
parents:
12607
diff
changeset
|
2565 Dashed line. |
|
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
2566 |
| 6889 | 2567 @item ":" |
|
12690
e9e35a707721
doc: Add 'none' to list of plot linestyles.
Rik <octave@nomad.inbox5.com>
parents:
12607
diff
changeset
|
2568 Dotted line. |
|
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
2569 |
| 6889 | 2570 @item "-." |
| 2571 A dash-dot line. | |
|
12690
e9e35a707721
doc: Add 'none' to list of plot linestyles.
Rik <octave@nomad.inbox5.com>
parents:
12607
diff
changeset
|
2572 |
|
17281
bc924baa2c4e
doc: Add new @qcode macro for code samples which are quoted.
Rik <rik@octave.org>
parents:
17170
diff
changeset
|
2573 @item @qcode{"none"} |
|
12690
e9e35a707721
doc: Add 'none' to list of plot linestyles.
Rik <octave@nomad.inbox5.com>
parents:
12607
diff
changeset
|
2574 No line. Points will still be marked using the current Marker Style. |
| 6889 | 2575 @end table |
| 2576 | |
| 2577 @item linewidth | |
| 2578 A number specifying the width of the line. The default is 1. A value | |
| 2579 of 2 is twice as wide as the default, etc. | |
| 2580 @end table | |
| 2581 | |
| 2582 @node Marker Styles | |
| 2583 @subsection Marker Styles | |
| 8071 | 2584 @cindex graphics marker styles |
| 2585 @cindex marker styles, graphics | |
| 2586 | |
| 7001 | 2587 Marker styles are specified by the following properties: |
|
14853
72b8b39e12be
doc: Periodic grammarcheck of documentation.
Rik <octave@nomad.inbox5.com>
parents:
14577
diff
changeset
|
2588 |
| 6889 | 2589 @table @code |
| 2590 @item marker | |
| 2591 A character indicating a plot marker to be place at each data point, or | |
|
17281
bc924baa2c4e
doc: Add new @qcode macro for code samples which are quoted.
Rik <rik@octave.org>
parents:
17170
diff
changeset
|
2592 @qcode{"none"}, meaning no markers should be displayed. |
| 6889 | 2593 |
|
16094
8899c785cc99
doc: Fix warnings associated with Texinfo 5.0 (bug #38392)
Rik <rik@octave.org>
parents:
16008
diff
changeset
|
2594 @item markeredgecolor |
|
17281
bc924baa2c4e
doc: Add new @qcode macro for code samples which are quoted.
Rik <rik@octave.org>
parents:
17170
diff
changeset
|
2595 The color of the edge around the marker, or @qcode{"auto"}, meaning that |
| 6889 | 2596 the edge color is the same as the face color. @xref{Colors}. |
| 2597 | |
|
16094
8899c785cc99
doc: Fix warnings associated with Texinfo 5.0 (bug #38392)
Rik <rik@octave.org>
parents:
16008
diff
changeset
|
2598 @item markerfacecolor |
|
17281
bc924baa2c4e
doc: Add new @qcode macro for code samples which are quoted.
Rik <rik@octave.org>
parents:
17170
diff
changeset
|
2599 The color of the marker, or @qcode{"none"} to indicate that the marker |
| 6889 | 2600 should not be filled. @xref{Colors}. |
| 2601 | |
|
16094
8899c785cc99
doc: Fix warnings associated with Texinfo 5.0 (bug #38392)
Rik <rik@octave.org>
parents:
16008
diff
changeset
|
2602 @item markersize |
| 6889 | 2603 A number specifying the size of the marker. The default is 1. A value |
| 2604 of 2 is twice as large as the default, etc. | |
| 6888 | 2605 @end table |
| 2606 | |
|
12607
2846ea58b288
colstyle.m: Add new function (bug #33063)
Rik <octave@nomad.inbox5.com>
parents:
12578
diff
changeset
|
2607 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
|
2608 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
|
2609 |
|
2846ea58b288
colstyle.m: Add new function (bug #33063)
Rik <octave@nomad.inbox5.com>
parents:
12578
diff
changeset
|
2610 @DOCSTRING(colstyle) |
|
2846ea58b288
colstyle.m: Add new function (bug #33063)
Rik <octave@nomad.inbox5.com>
parents:
12578
diff
changeset
|
2611 |
|
8056
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
2612 @node Callbacks |
|
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
2613 @subsection Callbacks |
| 8071 | 2614 @cindex callbacks |
|
8056
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
2615 |
|
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
2616 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
|
2617 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
|
2618 is |
|
8056
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
2619 |
|
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
2620 @example |
|
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
2621 @group |
|
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
2622 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
|
2623 @dots{} |
|
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
2624 endfunction |
|
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
2625 @end group |
|
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
2626 @end example |
|
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
2627 |
|
10846
a4f482e66b65
Grammarcheck more of the documentation.
Rik <octave@nomad.inbox5.com>
parents:
10828
diff
changeset
|
2628 @noindent |
|
8056
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
2629 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
|
2630 @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
|
2631 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
|
2632 @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
|
2633 |
|
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
2634 @example |
|
14856
c3fd61c59e9c
maint: Use Octave coding conventions for cuddling parentheses in doc directory
Rik <octave@nomad.inbox5.com>
parents:
14853
diff
changeset
|
2635 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
|
2636 @end example |
|
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
2637 |
|
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
2638 @noindent |
|
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
2639 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
|
2640 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
|
2641 |
|
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
2642 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
|
2643 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
|
2644 |
|
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
2645 @example |
|
9088
77e71f3da3d6
Fix documentation image printing under new development code
Rik <rdrider0-list@yahoo.com>
parents:
9040
diff
changeset
|
2646 @group |
| 8057 | 2647 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
|
2648 @dots{} |
| 8057 | 2649 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
|
2650 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
|
2651 endfunction |
|
9088
77e71f3da3d6
Fix documentation image printing under new development code
Rik <rdrider0-list@yahoo.com>
parents:
9040
diff
changeset
|
2652 @end group |
|
8056
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
2653 @end example |
|
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
2654 |
|
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
2655 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
|
2656 are |
|
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
2657 |
|
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
2658 @itemize @bullet |
|
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
2659 @item CreateFcn |
|
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
2660 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
|
2661 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
|
2662 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
|
2663 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
|
2664 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
|
2665 |
|
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
2666 @item DeleteFcn |
|
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
2667 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
|
2668 |
|
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
2669 @item ButtonDownFcn |
|
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
2670 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
|
2671 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
|
2672 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
|
2673 @end itemize |
|
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
2674 |
|
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
2675 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
|
2676 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
|
2677 functions. |
|
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
2678 |
|
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
2679 @DOCSTRING(gcbo) |
|
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
2680 |
|
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
2681 @DOCSTRING(gcbf) |
|
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
2682 |
|
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
2683 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
|
2684 function described below. |
|
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
2685 |
|
12525
d36266a54202
Add getappdata, setappdata, isappdata, rmappdata functions to documentation.
Rik <octave@nomad.inbox5.com>
parents:
12522
diff
changeset
|
2686 @node Application-defined Data |
|
17152
f2a8592b8fbd
doc: Shorten some long subsection names in Manual.
Rik <rik@octave.org>
parents:
17123
diff
changeset
|
2687 @subsection Application-defined Data |
|
12578
f5a780d675a1
Clean up operator and function indices in documentation.
Rik <octave@nomad.inbox5.com>
parents:
12577
diff
changeset
|
2688 @cindex application-defined data |
|
12525
d36266a54202
Add getappdata, setappdata, isappdata, rmappdata functions to documentation.
Rik <octave@nomad.inbox5.com>
parents:
12522
diff
changeset
|
2689 |
|
d36266a54202
Add getappdata, setappdata, isappdata, rmappdata functions to documentation.
Rik <octave@nomad.inbox5.com>
parents:
12522
diff
changeset
|
2690 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
|
2691 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
|
2692 will be completely ignored by Octave. |
|
d36266a54202
Add getappdata, setappdata, isappdata, rmappdata functions to documentation.
Rik <octave@nomad.inbox5.com>
parents:
12522
diff
changeset
|
2693 |
|
d36266a54202
Add getappdata, setappdata, isappdata, rmappdata functions to documentation.
Rik <octave@nomad.inbox5.com>
parents:
12522
diff
changeset
|
2694 @DOCSTRING(setappdata) |
|
d36266a54202
Add getappdata, setappdata, isappdata, rmappdata functions to documentation.
Rik <octave@nomad.inbox5.com>
parents:
12522
diff
changeset
|
2695 |
|
d36266a54202
Add getappdata, setappdata, isappdata, rmappdata functions to documentation.
Rik <octave@nomad.inbox5.com>
parents:
12522
diff
changeset
|
2696 @DOCSTRING(getappdata) |
|
d36266a54202
Add getappdata, setappdata, isappdata, rmappdata functions to documentation.
Rik <octave@nomad.inbox5.com>
parents:
12522
diff
changeset
|
2697 |
|
d36266a54202
Add getappdata, setappdata, isappdata, rmappdata functions to documentation.
Rik <octave@nomad.inbox5.com>
parents:
12522
diff
changeset
|
2698 @DOCSTRING(rmappdata) |
|
d36266a54202
Add getappdata, setappdata, isappdata, rmappdata functions to documentation.
Rik <octave@nomad.inbox5.com>
parents:
12522
diff
changeset
|
2699 |
|
d36266a54202
Add getappdata, setappdata, isappdata, rmappdata functions to documentation.
Rik <octave@nomad.inbox5.com>
parents:
12522
diff
changeset
|
2700 @DOCSTRING(isappdata) |
|
d36266a54202
Add getappdata, setappdata, isappdata, rmappdata functions to documentation.
Rik <octave@nomad.inbox5.com>
parents:
12522
diff
changeset
|
2701 |
|
8056
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
2702 @node Object Groups |
|
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
2703 @subsection Object Groups |
| 8071 | 2704 @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
|
2705 |
|
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
2706 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
|
2707 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
|
2708 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
|
2709 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
|
2710 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
|
2711 |
|
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
2712 @DOCSTRING(hggroup) |
|
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
2713 |
|
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
2714 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
|
2715 |
|
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
2716 @example |
|
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
2717 @group |
|
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
2718 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
|
2719 hg = hggroup (); |
|
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
2720 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
|
2721 hold on |
|
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
2722 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
|
2723 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
|
2724 @end group |
|
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
2725 @end example |
|
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
2726 |
|
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
2727 @noindent |
|
9040
dbd0c77e575e
Cleanup documentation file plot.texi
Rik <rdrider0-list@yahoo.com>
parents:
9032
diff
changeset
|
2728 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
|
2729 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
|
2730 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
|
2731 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
|
2732 function. |
|
8056
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
2733 |
|
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
2734 @DOCSTRING(addproperty) |
|
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
2735 |
|
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
2736 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
|
2737 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
|
2738 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
|
2739 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
|
2740 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
|
2741 |
|
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
2742 @DOCSTRING(addlistener) |
|
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
2743 |
|
8817
03b7f618ab3d
include docstrings for new functions in the manual
John W. Eaton <jwe@octave.org>
parents:
8519
diff
changeset
|
2744 @DOCSTRING(dellistener) |
|
03b7f618ab3d
include docstrings for new functions in the manual
John W. Eaton <jwe@octave.org>
parents:
8519
diff
changeset
|
2745 |
|
8056
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
2746 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
|
2747 |
|
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
2748 @example |
|
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
2749 @group |
|
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
2750 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
|
2751 hg = hggroup (); |
|
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
2752 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
|
2753 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
|
2754 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
|
2755 hold on |
|
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
2756 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
|
2757 |
|
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
2758 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
|
2759 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
|
2760 endfunction |
|
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
2761 @end group |
|
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
2762 @end example |
|
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
2763 |
|
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
2764 @noindent |
|
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
2765 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
|
2766 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
|
2767 @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
|
2768 |
|
3b53b25e2550
Add data sources and line series
David Bateman <dbateman@free.fr>
parents:
8057
diff
changeset
|
2769 @example |
|
3b53b25e2550
Add data sources and line series
David Bateman <dbateman@free.fr>
parents:
8057
diff
changeset
|
2770 @group |
|
3b53b25e2550
Add data sources and line series
David Bateman <dbateman@free.fr>
parents:
8057
diff
changeset
|
2771 x = 0:0.1:10; |
|
3b53b25e2550
Add data sources and line series
David Bateman <dbateman@free.fr>
parents:
8057
diff
changeset
|
2772 hg = hggroup (); |
|
3b53b25e2550
Add data sources and line series
David Bateman <dbateman@free.fr>
parents:
8057
diff
changeset
|
2773 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
|
2774 addproperty ("linestyle", hg, "linelinestyle", get (h, "linestyle")); |
|
3b53b25e2550
Add data sources and line series
David Bateman <dbateman@free.fr>
parents:
8057
diff
changeset
|
2775 hold on |
|
3b53b25e2550
Add data sources and line series
David Bateman <dbateman@free.fr>
parents:
8057
diff
changeset
|
2776 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
|
2777 hlink = linkprop ([hg, h1, h2], "color"); |
|
8070
3b53b25e2550
Add data sources and line series
David Bateman <dbateman@free.fr>
parents:
8057
diff
changeset
|
2778 @end group |
|
3b53b25e2550
Add data sources and line series
David Bateman <dbateman@free.fr>
parents:
8057
diff
changeset
|
2779 @end example |
|
3b53b25e2550
Add data sources and line series
David Bateman <dbateman@free.fr>
parents:
8057
diff
changeset
|
2780 |
|
3b53b25e2550
Add data sources and line series
David Bateman <dbateman@free.fr>
parents:
8057
diff
changeset
|
2781 @DOCSTRING(linkprop) |
|
8056
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
2782 |
|
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
2783 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
|
2784 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
|
2785 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
|
2786 |
|
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
2787 @itemize @bullet |
|
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
2788 @item group together multiple graphics objects, |
|
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
2789 |
|
8056
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
2790 @item create linked properties between different graphics objects, and |
|
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
2791 |
|
8056
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
2792 @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
|
2793 @end itemize |
|
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
2794 |
|
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
2795 @noindent |
|
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
2796 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
|
2797 @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
|
2798 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
|
2799 @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
|
2800 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
|
2801 example |
|
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
2802 |
|
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
2803 @example |
|
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
2804 @group |
|
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
2805 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
|
2806 get (h, "xdata") |
|
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
2807 @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
|
2808 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
|
2809 @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
|
2810 @end group |
|
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
2811 @end example |
|
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
2812 |
|
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
2813 @noindent |
|
9040
dbd0c77e575e
Cleanup documentation file plot.texi
Rik <rdrider0-list@yahoo.com>
parents:
9032
diff
changeset
|
2814 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
|
2815 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
|
2816 |
|
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
2817 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
|
2818 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
|
2819 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
|
2820 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
|
2821 member. |
|
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
2822 |
|
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
2823 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
|
2824 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
|
2825 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
|
2826 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
|
2827 corresponding hggroup elements. |
|
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
2828 |
|
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
2829 @menu |
|
17152
f2a8592b8fbd
doc: Shorten some long subsection names in Manual.
Rik <rik@octave.org>
parents:
17123
diff
changeset
|
2830 * Data Sources in Object Groups:: |
|
f2a8592b8fbd
doc: Shorten some long subsection names in Manual.
Rik <rik@octave.org>
parents:
17123
diff
changeset
|
2831 * Area Series:: |
|
f2a8592b8fbd
doc: Shorten some long subsection names in Manual.
Rik <rik@octave.org>
parents:
17123
diff
changeset
|
2832 * Bar Series:: |
|
f2a8592b8fbd
doc: Shorten some long subsection names in Manual.
Rik <rik@octave.org>
parents:
17123
diff
changeset
|
2833 * Contour Groups:: |
|
f2a8592b8fbd
doc: Shorten some long subsection names in Manual.
Rik <rik@octave.org>
parents:
17123
diff
changeset
|
2834 * Error Bar Series:: |
|
f2a8592b8fbd
doc: Shorten some long subsection names in Manual.
Rik <rik@octave.org>
parents:
17123
diff
changeset
|
2835 * Line Series:: |
|
f2a8592b8fbd
doc: Shorten some long subsection names in Manual.
Rik <rik@octave.org>
parents:
17123
diff
changeset
|
2836 * Quiver Group:: |
|
f2a8592b8fbd
doc: Shorten some long subsection names in Manual.
Rik <rik@octave.org>
parents:
17123
diff
changeset
|
2837 * Scatter Group:: |
|
f2a8592b8fbd
doc: Shorten some long subsection names in Manual.
Rik <rik@octave.org>
parents:
17123
diff
changeset
|
2838 * Stair Group:: |
|
f2a8592b8fbd
doc: Shorten some long subsection names in Manual.
Rik <rik@octave.org>
parents:
17123
diff
changeset
|
2839 * Stem Series:: |
|
f2a8592b8fbd
doc: Shorten some long subsection names in Manual.
Rik <rik@octave.org>
parents:
17123
diff
changeset
|
2840 * Surface Group:: |
|
8056
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
2841 @end menu |
|
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
2842 |
|
11257
8d4c57258523
fix some menu problems in the manual
John W. Eaton <jwe@octave.org>
parents:
11255
diff
changeset
|
2843 @node Data Sources in Object Groups |
|
8d4c57258523
fix some menu problems in the manual
John W. Eaton <jwe@octave.org>
parents:
11255
diff
changeset
|
2844 @subsubsection Data Sources in Object Groups |
| 8071 | 2845 @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
|
2846 @anchor{XREFdatasources} |
|
9040
dbd0c77e575e
Cleanup documentation file plot.texi
Rik <rdrider0-list@yahoo.com>
parents:
9032
diff
changeset
|
2847 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
|
2848 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
|
2849 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
|
2850 function is called. |
|
8070
3b53b25e2550
Add data sources and line series
David Bateman <dbateman@free.fr>
parents:
8057
diff
changeset
|
2851 |
|
3b53b25e2550
Add data sources and line series
David Bateman <dbateman@free.fr>
parents:
8057
diff
changeset
|
2852 @DOCSTRING(refreshdata) |
|
3b53b25e2550
Add data sources and line series
David Bateman <dbateman@free.fr>
parents:
8057
diff
changeset
|
2853 |
|
17097
e7a059a9a644
doc: Use XREF as anchor prefix in documentation for clearer results in Info viewer.
Rik <rik@octave.org>
parents:
16923
diff
changeset
|
2854 @anchor{XREFlinkdata} |
|
8070
3b53b25e2550
Add data sources and line series
David Bateman <dbateman@free.fr>
parents:
8057
diff
changeset
|
2855 @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
|
2856 @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
|
2857 @c command |
|
8070
3b53b25e2550
Add data sources and line series
David Bateman <dbateman@free.fr>
parents:
8057
diff
changeset
|
2858 |
|
11257
8d4c57258523
fix some menu problems in the manual
John W. Eaton <jwe@octave.org>
parents:
11255
diff
changeset
|
2859 @node Area Series |
|
8d4c57258523
fix some menu problems in the manual
John W. Eaton <jwe@octave.org>
parents:
11255
diff
changeset
|
2860 @subsubsection Area Series |
| 8071 | 2861 @cindex series objects |
| 2862 @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
|
2863 |
|
9040
dbd0c77e575e
Cleanup documentation file plot.texi
Rik <rdrider0-list@yahoo.com>
parents:
9032
diff
changeset
|
2864 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
|
2865 @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
|
2866 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
|
2867 |
|
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
2868 @table @code |
|
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
2869 @item basevalue |
|
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
2870 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
|
2871 |
|
17170
d6499c14021c
doc: Periodic grammarcheck of documentation.
Rik <rik@octave.org>
parents:
17152
diff
changeset
|
2872 @item linewidth |
|
8056
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
2873 @itemx linestyle |
|
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
2874 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
|
2875 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
|
2876 |
|
17170
d6499c14021c
doc: Periodic grammarcheck of documentation.
Rik <rik@octave.org>
parents:
17152
diff
changeset
|
2877 @item edgecolor |
|
8056
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
2878 @itemx facecolor |
|
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
2879 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
|
2880 @xref{Colors}. |
|
8056
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
2881 |
|
17170
d6499c14021c
doc: Periodic grammarcheck of documentation.
Rik <rik@octave.org>
parents:
17152
diff
changeset
|
2882 @item xdata |
|
8056
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
2883 @itemx ydata |
|
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
2884 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
|
2885 @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
|
2886 function. |
|
8070
3b53b25e2550
Add data sources and line series
David Bateman <dbateman@free.fr>
parents:
8057
diff
changeset
|
2887 |
|
17170
d6499c14021c
doc: Periodic grammarcheck of documentation.
Rik <rik@octave.org>
parents:
17152
diff
changeset
|
2888 @item xdatasource |
|
8070
3b53b25e2550
Add data sources and line series
David Bateman <dbateman@free.fr>
parents:
8057
diff
changeset
|
2889 @itemx ydatasource |
|
3b53b25e2550
Add data sources and line series
David Bateman <dbateman@free.fr>
parents:
8057
diff
changeset
|
2890 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
|
2891 @end table |
|
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
2892 |
|
11257
8d4c57258523
fix some menu problems in the manual
John W. Eaton <jwe@octave.org>
parents:
11255
diff
changeset
|
2893 @node Bar Series |
|
8d4c57258523
fix some menu problems in the manual
John W. Eaton <jwe@octave.org>
parents:
11255
diff
changeset
|
2894 @subsubsection Bar Series |
| 8071 | 2895 @cindex series objects |
| 2896 @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
|
2897 |
|
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
2898 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
|
2899 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
|
2900 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
|
2901 |
|
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
2902 @table @code |
|
17170
d6499c14021c
doc: Periodic grammarcheck of documentation.
Rik <rik@octave.org>
parents:
17152
diff
changeset
|
2903 @item showbaseline |
|
8056
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
2904 @itemx baseline |
|
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
2905 @itemx basevalue |
|
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
2906 The property @code{showbaseline} flags whether the baseline of the bar |
|
17281
bc924baa2c4e
doc: Add new @qcode macro for code samples which are quoted.
Rik <rik@octave.org>
parents:
17170
diff
changeset
|
2907 series is displayed (default is @qcode{"on"}). The handle of the graphics |
|
bc924baa2c4e
doc: Add new @qcode macro for code samples which are quoted.
Rik <rik@octave.org>
parents:
17170
diff
changeset
|
2908 object representing the baseline is given by the @code{baseline} property and |
|
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
2909 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
|
2910 |
|
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
2911 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
|
2912 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
|
2913 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
|
2914 corresponding bar series. |
|
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
2915 |
|
17170
d6499c14021c
doc: Periodic grammarcheck of documentation.
Rik <rik@octave.org>
parents:
17152
diff
changeset
|
2916 @item barwidth |
|
8056
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
2917 @itemx barlayout |
|
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
2918 @itemx horizontal |
|
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
2919 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
|
2920 the @var{width} variable passed to @code{bar} or @var{barh}. Whether the |
|
17281
bc924baa2c4e
doc: Add new @qcode macro for code samples which are quoted.
Rik <rik@octave.org>
parents:
17170
diff
changeset
|
2921 bar series is @qcode{"grouped"} or @qcode{"stacked"} is determined by the |
|
8056
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
2922 @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
|
2923 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
|
2924 |
|
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
2925 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
|
2926 the bar series. |
|
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
2927 |
|
17170
d6499c14021c
doc: Periodic grammarcheck of documentation.
Rik <rik@octave.org>
parents:
17152
diff
changeset
|
2928 @item linewidth |
|
8056
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
2929 @itemx linestyle |
|
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
2930 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
|
2931 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
|
2932 |
|
17170
d6499c14021c
doc: Periodic grammarcheck of documentation.
Rik <rik@octave.org>
parents:
17152
diff
changeset
|
2933 @item edgecolor |
|
8056
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
2934 @itemx facecolor |
|
9040
dbd0c77e575e
Cleanup documentation file plot.texi
Rik <rdrider0-list@yahoo.com>
parents:
9032
diff
changeset
|
2935 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
|
2936 |
|
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
2937 @item xdata |
|
9040
dbd0c77e575e
Cleanup documentation file plot.texi
Rik <rdrider0-list@yahoo.com>
parents:
9032
diff
changeset
|
2938 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
|
2939 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
|
2940 |
|
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
2941 @item ydata |
|
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
2942 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
|
2943 |
|
17170
d6499c14021c
doc: Periodic grammarcheck of documentation.
Rik <rik@octave.org>
parents:
17152
diff
changeset
|
2944 @item xdatasource |
|
8070
3b53b25e2550
Add data sources and line series
David Bateman <dbateman@free.fr>
parents:
8057
diff
changeset
|
2945 @itemx ydatasource |
|
3b53b25e2550
Add data sources and line series
David Bateman <dbateman@free.fr>
parents:
8057
diff
changeset
|
2946 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
|
2947 @end table |
|
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
2948 |
|
11257
8d4c57258523
fix some menu problems in the manual
John W. Eaton <jwe@octave.org>
parents:
11255
diff
changeset
|
2949 @node Contour Groups |
|
8d4c57258523
fix some menu problems in the manual
John W. Eaton <jwe@octave.org>
parents:
11255
diff
changeset
|
2950 @subsubsection Contour Groups |
| 8071 | 2951 @cindex series objects |
| 2952 @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
|
2953 |
|
8289
ac7f334d9652
Add contour group objects and the clabel function
David Bateman <dbateman@free.fr>
parents:
8286
diff
changeset
|
2954 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
|
2955 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
|
2956 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
|
2957 group are |
|
ac7f334d9652
Add contour group objects and the clabel function
David Bateman <dbateman@free.fr>
parents:
8286
diff
changeset
|
2958 |
|
ac7f334d9652
Add contour group objects and the clabel function
David Bateman <dbateman@free.fr>
parents:
8286
diff
changeset
|
2959 @table @code |
|
ac7f334d9652
Add contour group objects and the clabel function
David Bateman <dbateman@free.fr>
parents:
8286
diff
changeset
|
2960 @item contourmatrix |
|
ac7f334d9652
Add contour group objects and the clabel function
David Bateman <dbateman@free.fr>
parents:
8286
diff
changeset
|
2961 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
|
2962 create the contours of the plot. |
|
ac7f334d9652
Add contour group objects and the clabel function
David Bateman <dbateman@free.fr>
parents:
8286
diff
changeset
|
2963 |
|
ac7f334d9652
Add contour group objects and the clabel function
David Bateman <dbateman@free.fr>
parents:
8286
diff
changeset
|
2964 @item fill |
|
17281
bc924baa2c4e
doc: Add new @qcode macro for code samples which are quoted.
Rik <rik@octave.org>
parents:
17170
diff
changeset
|
2965 A radio property that can have the values @qcode{"on"} or @qcode{"off"} that |
|
bc924baa2c4e
doc: Add new @qcode macro for code samples which are quoted.
Rik <rik@octave.org>
parents:
17170
diff
changeset
|
2966 flags whether the contours to plot are to be filled. |
|
8289
ac7f334d9652
Add contour group objects and the clabel function
David Bateman <dbateman@free.fr>
parents:
8286
diff
changeset
|
2967 |
|
17170
d6499c14021c
doc: Periodic grammarcheck of documentation.
Rik <rik@octave.org>
parents:
17152
diff
changeset
|
2968 @item zlevelmode |
|
8289
ac7f334d9652
Add contour group objects and the clabel function
David Bateman <dbateman@free.fr>
parents:
8286
diff
changeset
|
2969 @itemx zlevel |
|
17281
bc924baa2c4e
doc: Add new @qcode macro for code samples which are quoted.
Rik <rik@octave.org>
parents:
17170
diff
changeset
|
2970 The radio property @code{zlevelmode} can have the values @qcode{"none"}, |
|
bc924baa2c4e
doc: Add new @qcode macro for code samples which are quoted.
Rik <rik@octave.org>
parents:
17170
diff
changeset
|
2971 @qcode{"auto"}, or @qcode{"manual"}. When its value is @qcode{"none"} there is |
|
bc924baa2c4e
doc: Add new @qcode macro for code samples which are quoted.
Rik <rik@octave.org>
parents:
17170
diff
changeset
|
2972 no z component to the plotted contours. When its value is @qcode{"auto"} the z |
|
bc924baa2c4e
doc: Add new @qcode macro for code samples which are quoted.
Rik <rik@octave.org>
parents:
17170
diff
changeset
|
2973 value of the plotted contours is at the same value as the contour itself. If |
|
bc924baa2c4e
doc: Add new @qcode macro for code samples which are quoted.
Rik <rik@octave.org>
parents:
17170
diff
changeset
|
2974 the value is @qcode{"manual"}, then the z value at which to plot the contour is |
|
bc924baa2c4e
doc: Add new @qcode macro for code samples which are quoted.
Rik <rik@octave.org>
parents:
17170
diff
changeset
|
2975 determined by the @code{zlevel} property. |
|
8289
ac7f334d9652
Add contour group objects and the clabel function
David Bateman <dbateman@free.fr>
parents:
8286
diff
changeset
|
2976 |
|
17170
d6499c14021c
doc: Periodic grammarcheck of documentation.
Rik <rik@octave.org>
parents:
17152
diff
changeset
|
2977 @item levellistmode |
|
8289
ac7f334d9652
Add contour group objects and the clabel function
David Bateman <dbateman@free.fr>
parents:
8286
diff
changeset
|
2978 @itemx levellist |
|
ac7f334d9652
Add contour group objects and the clabel function
David Bateman <dbateman@free.fr>
parents:
8286
diff
changeset
|
2979 @itemx levelstepmode |
|
ac7f334d9652
Add contour group objects and the clabel function
David Bateman <dbateman@free.fr>
parents:
8286
diff
changeset
|
2980 @itemx levelstep |
|
17281
bc924baa2c4e
doc: Add new @qcode macro for code samples which are quoted.
Rik <rik@octave.org>
parents:
17170
diff
changeset
|
2981 If @code{levellistmode} is @qcode{"manual"}, then the levels at which to plot |
|
bc924baa2c4e
doc: Add new @qcode macro for code samples which are quoted.
Rik <rik@octave.org>
parents:
17170
diff
changeset
|
2982 the contours is determined by @code{levellist}. If @code{levellistmode} is set |
|
bc924baa2c4e
doc: Add new @qcode macro for code samples which are quoted.
Rik <rik@octave.org>
parents:
17170
diff
changeset
|
2983 to @qcode{"auto"}, then the distance between contours is determined by |
|
bc924baa2c4e
doc: Add new @qcode macro for code samples which are quoted.
Rik <rik@octave.org>
parents:
17170
diff
changeset
|
2984 @code{levelstep}. If both @code{levellistmode} and @code{levelstepmode} are |
|
bc924baa2c4e
doc: Add new @qcode macro for code samples which are quoted.
Rik <rik@octave.org>
parents:
17170
diff
changeset
|
2985 set to @qcode{"auto"}, then there are assumed to be 10 equal spaced contours. |
|
8289
ac7f334d9652
Add contour group objects and the clabel function
David Bateman <dbateman@free.fr>
parents:
8286
diff
changeset
|
2986 |
|
17170
d6499c14021c
doc: Periodic grammarcheck of documentation.
Rik <rik@octave.org>
parents:
17152
diff
changeset
|
2987 @item textlistmode |
|
8289
ac7f334d9652
Add contour group objects and the clabel function
David Bateman <dbateman@free.fr>
parents:
8286
diff
changeset
|
2988 @itemx textlist |
|
ac7f334d9652
Add contour group objects and the clabel function
David Bateman <dbateman@free.fr>
parents:
8286
diff
changeset
|
2989 @itemx textstepmode |
|
ac7f334d9652
Add contour group objects and the clabel function
David Bateman <dbateman@free.fr>
parents:
8286
diff
changeset
|
2990 @itemx textstep |
|
17281
bc924baa2c4e
doc: Add new @qcode macro for code samples which are quoted.
Rik <rik@octave.org>
parents:
17170
diff
changeset
|
2991 If @code{textlistmode} is @qcode{"manual"}, then the labeled contours |
|
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
2992 is determined by @code{textlist}. If @code{textlistmode} is set to |
|
17281
bc924baa2c4e
doc: Add new @qcode macro for code samples which are quoted.
Rik <rik@octave.org>
parents:
17170
diff
changeset
|
2993 @qcode{"auto"}, then the distance between labeled contours is determined by |
|
9040
dbd0c77e575e
Cleanup documentation file plot.texi
Rik <rdrider0-list@yahoo.com>
parents:
9032
diff
changeset
|
2994 @code{textstep}. If both @code{textlistmode} and @code{textstepmode} |
|
17281
bc924baa2c4e
doc: Add new @qcode macro for code samples which are quoted.
Rik <rik@octave.org>
parents:
17170
diff
changeset
|
2995 are set to @qcode{"auto"}, then there are assumed to be 10 equal spaced |
|
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
2996 labeled contours. |
|
8289
ac7f334d9652
Add contour group objects and the clabel function
David Bateman <dbateman@free.fr>
parents:
8286
diff
changeset
|
2997 |
|
ac7f334d9652
Add contour group objects and the clabel function
David Bateman <dbateman@free.fr>
parents:
8286
diff
changeset
|
2998 @item showtext |
|
ac7f334d9652
Add contour group objects and the clabel function
David Bateman <dbateman@free.fr>
parents:
8286
diff
changeset
|
2999 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
|
3000 |
|
ac7f334d9652
Add contour group objects and the clabel function
David Bateman <dbateman@free.fr>
parents:
8286
diff
changeset
|
3001 @item labelspacing |
|
ac7f334d9652
Add contour group objects and the clabel function
David Bateman <dbateman@free.fr>
parents:
8286
diff
changeset
|
3002 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
|
3003 |
|
ac7f334d9652
Add contour group objects and the clabel function
David Bateman <dbateman@free.fr>
parents:
8286
diff
changeset
|
3004 @item linewidth |
|
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
3005 |
|
8289
ac7f334d9652
Add contour group objects and the clabel function
David Bateman <dbateman@free.fr>
parents:
8286
diff
changeset
|
3006 @item linestyle |
|
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
3007 |
|
8289
ac7f334d9652
Add contour group objects and the clabel function
David Bateman <dbateman@free.fr>
parents:
8286
diff
changeset
|
3008 @item linecolor |
|
9040
dbd0c77e575e
Cleanup documentation file plot.texi
Rik <rdrider0-list@yahoo.com>
parents:
9032
diff
changeset
|
3009 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
|
3010 @code{linestyle} are similar to the corresponding properties for lines. The |
| 8297 | 3011 property @code{linecolor} is a color property (@pxref{Colors}), that can also |
|
17281
bc924baa2c4e
doc: Add new @qcode macro for code samples which are quoted.
Rik <rik@octave.org>
parents:
17170
diff
changeset
|
3012 have the values of @qcode{"none"} or @qcode{"auto"}. If @code{linecolor} is |
|
bc924baa2c4e
doc: Add new @qcode macro for code samples which are quoted.
Rik <rik@octave.org>
parents:
17170
diff
changeset
|
3013 @qcode{"none"}, then no contour line is drawn. If @code{linecolor} is |
|
bc924baa2c4e
doc: Add new @qcode macro for code samples which are quoted.
Rik <rik@octave.org>
parents:
17170
diff
changeset
|
3014 @qcode{"auto"} then the line color is determined by the colormap. |
|
8289
ac7f334d9652
Add contour group objects and the clabel function
David Bateman <dbateman@free.fr>
parents:
8286
diff
changeset
|
3015 |
|
17170
d6499c14021c
doc: Periodic grammarcheck of documentation.
Rik <rik@octave.org>
parents:
17152
diff
changeset
|
3016 @item xdata |
|
8289
ac7f334d9652
Add contour group objects and the clabel function
David Bateman <dbateman@free.fr>
parents:
8286
diff
changeset
|
3017 @itemx ydata |
|
ac7f334d9652
Add contour group objects and the clabel function
David Bateman <dbateman@free.fr>
parents:
8286
diff
changeset
|
3018 @itemx zdata |
|
ac7f334d9652
Add contour group objects and the clabel function
David Bateman <dbateman@free.fr>
parents:
8286
diff
changeset
|
3019 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
|
3020 |
|
17170
d6499c14021c
doc: Periodic grammarcheck of documentation.
Rik <rik@octave.org>
parents:
17152
diff
changeset
|
3021 @item xdatasource |
|
8289
ac7f334d9652
Add contour group objects and the clabel function
David Bateman <dbateman@free.fr>
parents:
8286
diff
changeset
|
3022 @itemx ydatasource |
|
ac7f334d9652
Add contour group objects and the clabel function
David Bateman <dbateman@free.fr>
parents:
8286
diff
changeset
|
3023 @itemx zdatasource |
|
ac7f334d9652
Add contour group objects and the clabel function
David Bateman <dbateman@free.fr>
parents:
8286
diff
changeset
|
3024 Data source variables. |
|
ac7f334d9652
Add contour group objects and the clabel function
David Bateman <dbateman@free.fr>
parents:
8286
diff
changeset
|
3025 @end table |
|
8056
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
3026 |
|
11257
8d4c57258523
fix some menu problems in the manual
John W. Eaton <jwe@octave.org>
parents:
11255
diff
changeset
|
3027 @node Error Bar Series |
|
8d4c57258523
fix some menu problems in the manual
John W. Eaton <jwe@octave.org>
parents:
11255
diff
changeset
|
3028 @subsubsection Error Bar Series |
| 8071 | 3029 @cindex series objects |
| 3030 @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
|
3031 |
|
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
3032 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
|
3033 @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
|
3034 the errorbars separately. The properties of the error bar series are |
| 8258 | 3035 |
| 3036 @table @code | |
| 3037 @item color | |
|
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
3038 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
|
3039 @xref{Colors}. |
| 8258 | 3040 |
|
17170
d6499c14021c
doc: Periodic grammarcheck of documentation.
Rik <rik@octave.org>
parents:
17152
diff
changeset
|
3041 @item linewidth |
| 8258 | 3042 @itemx linestyle |
|
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
3043 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
|
3044 Styles}. |
| 8258 | 3045 |
|
17170
d6499c14021c
doc: Periodic grammarcheck of documentation.
Rik <rik@octave.org>
parents:
17152
diff
changeset
|
3046 @item marker |
| 8258 | 3047 @itemx markeredgecolor |
| 3048 @itemx markerfacecolor | |
| 3049 @itemx markersize | |
|
9040
dbd0c77e575e
Cleanup documentation file plot.texi
Rik <rdrider0-list@yahoo.com>
parents:
9032
diff
changeset
|
3050 The line and fill color of the markers on the error bars. @xref{Colors}. |
| 8258 | 3051 |
|
17170
d6499c14021c
doc: Periodic grammarcheck of documentation.
Rik <rik@octave.org>
parents:
17152
diff
changeset
|
3052 @item xdata |
| 8258 | 3053 @itemx ydata |
| 3054 @itemx ldata | |
| 3055 @itemx udata | |
| 3056 @itemx xldata | |
| 3057 @itemx xudata | |
| 3058 The original x, y, l, u, xl, xu data of the error bars. | |
| 3059 | |
|
17170
d6499c14021c
doc: Periodic grammarcheck of documentation.
Rik <rik@octave.org>
parents:
17152
diff
changeset
|
3060 @item xdatasource |
| 8258 | 3061 @itemx ydatasource |
| 3062 @itemx ldatasource | |
| 3063 @itemx udatasource | |
| 3064 @itemx xldatasource | |
| 3065 @itemx xudatasource | |
| 3066 Data source variables. | |
| 3067 @end table | |
| 3068 | |
|
11257
8d4c57258523
fix some menu problems in the manual
John W. Eaton <jwe@octave.org>
parents:
11255
diff
changeset
|
3069 @node Line Series |
|
8d4c57258523
fix some menu problems in the manual
John W. Eaton <jwe@octave.org>
parents:
11255
diff
changeset
|
3070 @subsubsection Line Series |
| 8071 | 3071 @cindex series objects |
| 3072 @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
|
3073 |
| 8257 | 3074 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
|
3075 functions and are of the type @code{line}. The properties of the |
| 8257 | 3076 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
|
3077 |
|
3b53b25e2550
Add data sources and line series
David Bateman <dbateman@free.fr>
parents:
8057
diff
changeset
|
3078 @table @code |
|
3b53b25e2550
Add data sources and line series
David Bateman <dbateman@free.fr>
parents:
8057
diff
changeset
|
3079 @item color |
|
9040
dbd0c77e575e
Cleanup documentation file plot.texi
Rik <rdrider0-list@yahoo.com>
parents:
9032
diff
changeset
|
3080 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
|
3081 |
|
17170
d6499c14021c
doc: Periodic grammarcheck of documentation.
Rik <rik@octave.org>
parents:
17152
diff
changeset
|
3082 @item linewidth |
|
8070
3b53b25e2550
Add data sources and line series
David Bateman <dbateman@free.fr>
parents:
8057
diff
changeset
|
3083 @itemx linestyle |
|
9040
dbd0c77e575e
Cleanup documentation file plot.texi
Rik <rdrider0-list@yahoo.com>
parents:
9032
diff
changeset
|
3084 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
|
3085 |
|
17170
d6499c14021c
doc: Periodic grammarcheck of documentation.
Rik <rik@octave.org>
parents:
17152
diff
changeset
|
3086 @item marker |
|
8070
3b53b25e2550
Add data sources and line series
David Bateman <dbateman@free.fr>
parents:
8057
diff
changeset
|
3087 @itemx markeredgecolor |
|
3b53b25e2550
Add data sources and line series
David Bateman <dbateman@free.fr>
parents:
8057
diff
changeset
|
3088 @itemx markerfacecolor |
|
3b53b25e2550
Add data sources and line series
David Bateman <dbateman@free.fr>
parents:
8057
diff
changeset
|
3089 @itemx markersize |
|
9040
dbd0c77e575e
Cleanup documentation file plot.texi
Rik <rdrider0-list@yahoo.com>
parents:
9032
diff
changeset
|
3090 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
|
3091 |
|
17170
d6499c14021c
doc: Periodic grammarcheck of documentation.
Rik <rik@octave.org>
parents:
17152
diff
changeset
|
3092 @item xdata |
|
8070
3b53b25e2550
Add data sources and line series
David Bateman <dbateman@free.fr>
parents:
8057
diff
changeset
|
3093 @itemx ydata |
|
3b53b25e2550
Add data sources and line series
David Bateman <dbateman@free.fr>
parents:
8057
diff
changeset
|
3094 @itemx zdata |
| 8257 | 3095 The original x, y and z data. |
|
8070
3b53b25e2550
Add data sources and line series
David Bateman <dbateman@free.fr>
parents:
8057
diff
changeset
|
3096 |
|
17170
d6499c14021c
doc: Periodic grammarcheck of documentation.
Rik <rik@octave.org>
parents:
17152
diff
changeset
|
3097 @item xdatasource |
|
8070
3b53b25e2550
Add data sources and line series
David Bateman <dbateman@free.fr>
parents:
8057
diff
changeset
|
3098 @itemx ydatasource |
|
3b53b25e2550
Add data sources and line series
David Bateman <dbateman@free.fr>
parents:
8057
diff
changeset
|
3099 @itemx zdatasource |
|
3b53b25e2550
Add data sources and line series
David Bateman <dbateman@free.fr>
parents:
8057
diff
changeset
|
3100 Data source variables. |
|
3b53b25e2550
Add data sources and line series
David Bateman <dbateman@free.fr>
parents:
8057
diff
changeset
|
3101 @end table |
|
8056
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
3102 |
|
11257
8d4c57258523
fix some menu problems in the manual
John W. Eaton <jwe@octave.org>
parents:
11255
diff
changeset
|
3103 @node Quiver Group |
|
8d4c57258523
fix some menu problems in the manual
John W. Eaton <jwe@octave.org>
parents:
11255
diff
changeset
|
3104 @subsubsection Quiver Group |
| 8071 | 3105 @cindex group objects |
| 3106 @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
|
3107 |
|
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
3108 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
|
3109 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
|
3110 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
|
3111 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
|
3112 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
|
3113 |
|
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
3114 @table @code |
|
17170
d6499c14021c
doc: Periodic grammarcheck of documentation.
Rik <rik@octave.org>
parents:
17152
diff
changeset
|
3115 @item autoscale |
|
8056
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
3116 @itemx autoscalefactor |
|
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
3117 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
|
3118 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
|
3119 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
|
3120 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
|
3121 |
|
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
3122 @item maxheadsize |
|
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
3123 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
|
3124 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
|
3125 |
|
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
3126 @item showarrowhead |
|
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
3127 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
|
3128 |
|
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
3129 @item color |
|
9040
dbd0c77e575e
Cleanup documentation file plot.texi
Rik <rdrider0-list@yahoo.com>
parents:
9032
diff
changeset
|
3130 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
|
3131 |
|
17170
d6499c14021c
doc: Periodic grammarcheck of documentation.
Rik <rik@octave.org>
parents:
17152
diff
changeset
|
3132 @item linewidth |
|
8056
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
3133 @itemx linestyle |
|
9040
dbd0c77e575e
Cleanup documentation file plot.texi
Rik <rdrider0-list@yahoo.com>
parents:
9032
diff
changeset
|
3134 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
|
3135 |
|
17170
d6499c14021c
doc: Periodic grammarcheck of documentation.
Rik <rik@octave.org>
parents:
17152
diff
changeset
|
3136 @item marker |
|
8056
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
3137 @itemx markerfacecolor |
|
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
3138 @itemx markersize |
|
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
3139 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
|
3140 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
|
3141 |
|
17170
d6499c14021c
doc: Periodic grammarcheck of documentation.
Rik <rik@octave.org>
parents:
17152
diff
changeset
|
3142 @item xdata |
|
8056
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
3143 @itemx ydata |
|
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
3144 @itemx zdata |
|
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
3145 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
|
3146 |
|
17170
d6499c14021c
doc: Periodic grammarcheck of documentation.
Rik <rik@octave.org>
parents:
17152
diff
changeset
|
3147 @item udata |
|
8056
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
3148 @itemx vdata |
|
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
3149 @itemx wdata |
|
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
3150 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
|
3151 |
|
17170
d6499c14021c
doc: Periodic grammarcheck of documentation.
Rik <rik@octave.org>
parents:
17152
diff
changeset
|
3152 @item xdatasource |
|
8070
3b53b25e2550
Add data sources and line series
David Bateman <dbateman@free.fr>
parents:
8057
diff
changeset
|
3153 @itemx ydatasource |
|
3b53b25e2550
Add data sources and line series
David Bateman <dbateman@free.fr>
parents:
8057
diff
changeset
|
3154 @itemx zdatasource |
|
3b53b25e2550
Add data sources and line series
David Bateman <dbateman@free.fr>
parents:
8057
diff
changeset
|
3155 @itemx udatasource |
|
3b53b25e2550
Add data sources and line series
David Bateman <dbateman@free.fr>
parents:
8057
diff
changeset
|
3156 @itemx vdatasource |
|
3b53b25e2550
Add data sources and line series
David Bateman <dbateman@free.fr>
parents:
8057
diff
changeset
|
3157 @itemx wdatasource |
|
3b53b25e2550
Add data sources and line series
David Bateman <dbateman@free.fr>
parents:
8057
diff
changeset
|
3158 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
|
3159 @end table |
|
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
3160 |
|
11257
8d4c57258523
fix some menu problems in the manual
John W. Eaton <jwe@octave.org>
parents:
11255
diff
changeset
|
3161 @node Scatter Group |
|
8d4c57258523
fix some menu problems in the manual
John W. Eaton <jwe@octave.org>
parents:
11255
diff
changeset
|
3162 @subsubsection Scatter Group |
| 8071 | 3163 @cindex group objects |
| 3164 @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
|
3165 |
| 8257 | 3166 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
|
3167 functions. A single hggroup element contains as many children as there are |
| 8257 | 3168 points in the scatter plot, with each child representing one of the points. |
| 3169 The properties of the stem series are | |
| 3170 | |
| 3171 @table @code | |
| 3172 @item linewidth | |
|
9040
dbd0c77e575e
Cleanup documentation file plot.texi
Rik <rdrider0-list@yahoo.com>
parents:
9032
diff
changeset
|
3173 The line width of the line objects of the points. @xref{Line Styles}. |
| 8257 | 3174 |
|
17170
d6499c14021c
doc: Periodic grammarcheck of documentation.
Rik <rik@octave.org>
parents:
17152
diff
changeset
|
3175 @item marker |
| 8257 | 3176 @itemx markeredgecolor |
| 3177 @itemx markerfacecolor | |
|
9040
dbd0c77e575e
Cleanup documentation file plot.texi
Rik <rdrider0-list@yahoo.com>
parents:
9032
diff
changeset
|
3178 The line and fill color of the markers of the points. @xref{Colors}. |
| 8257 | 3179 |
|
17170
d6499c14021c
doc: Periodic grammarcheck of documentation.
Rik <rik@octave.org>
parents:
17152
diff
changeset
|
3180 @item xdata |
| 8257 | 3181 @itemx ydata |
| 3182 @itemx zdata | |
| 3183 The original x, y and z data of the stems. | |
| 3184 | |
| 3185 @item cdata | |
|
9040
dbd0c77e575e
Cleanup documentation file plot.texi
Rik <rdrider0-list@yahoo.com>
parents:
9032
diff
changeset
|
3186 The color data for the points of the plot. Each point can have a separate |
| 8257 | 3187 color, or a unique color can be specified. |
| 3188 | |
| 3189 @item sizedata | |
|
9672
43a07df0ed4c
document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents:
9316
diff
changeset
|
3190 The size data for the points of the plot. Each point can its own size or a |
| 8257 | 3191 unique size can be specified. |
| 3192 | |
|
17170
d6499c14021c
doc: Periodic grammarcheck of documentation.
Rik <rik@octave.org>
parents:
17152
diff
changeset
|
3193 @item xdatasource |
| 8257 | 3194 @itemx ydatasource |
| 3195 @itemx zdatasource | |
| 3196 @itemx cdatasource | |
| 3197 @itemx sizedatasource | |
| 3198 Data source variables. | |
| 3199 @end table | |
|
8056
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
3200 |
|
11257
8d4c57258523
fix some menu problems in the manual
John W. Eaton <jwe@octave.org>
parents:
11255
diff
changeset
|
3201 @node Stair Group |
|
8d4c57258523
fix some menu problems in the manual
John W. Eaton <jwe@octave.org>
parents:
11255
diff
changeset
|
3202 @subsubsection Stair Group |
| 8071 | 3203 @cindex group objects |
| 3204 @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
|
3205 |
|
9040
dbd0c77e575e
Cleanup documentation file plot.texi
Rik <rdrider0-list@yahoo.com>
parents:
9032
diff
changeset
|
3206 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
|
3207 @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
|
3208 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
|
3209 |
|
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
3210 @table @code |
|
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
3211 @item color |
|
9040
dbd0c77e575e
Cleanup documentation file plot.texi
Rik <rdrider0-list@yahoo.com>
parents:
9032
diff
changeset
|
3212 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
|
3213 |
|
17170
d6499c14021c
doc: Periodic grammarcheck of documentation.
Rik <rik@octave.org>
parents:
17152
diff
changeset
|
3214 @item linewidth |
|
8056
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
3215 @itemx linestyle |
|
9040
dbd0c77e575e
Cleanup documentation file plot.texi
Rik <rdrider0-list@yahoo.com>
parents:
9032
diff
changeset
|
3216 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
|
3217 |
|
17170
d6499c14021c
doc: Periodic grammarcheck of documentation.
Rik <rik@octave.org>
parents:
17152
diff
changeset
|
3218 @item marker |
|
8056
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
3219 @itemx markeredgecolor |
|
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
3220 @itemx markerfacecolor |
|
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
3221 @itemx markersize |
|
9040
dbd0c77e575e
Cleanup documentation file plot.texi
Rik <rdrider0-list@yahoo.com>
parents:
9032
diff
changeset
|
3222 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
|
3223 |
|
17170
d6499c14021c
doc: Periodic grammarcheck of documentation.
Rik <rik@octave.org>
parents:
17152
diff
changeset
|
3224 @item xdata |
|
8056
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
3225 @itemx ydata |
|
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
3226 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
|
3227 |
|
17170
d6499c14021c
doc: Periodic grammarcheck of documentation.
Rik <rik@octave.org>
parents:
17152
diff
changeset
|
3228 @item xdatasource |
|
8070
3b53b25e2550
Add data sources and line series
David Bateman <dbateman@free.fr>
parents:
8057
diff
changeset
|
3229 @itemx ydatasource |
|
3b53b25e2550
Add data sources and line series
David Bateman <dbateman@free.fr>
parents:
8057
diff
changeset
|
3230 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
|
3231 @end table |
|
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
3232 |
| 8073 | 3233 @node Stem Series |
| 3234 @subsubsection Stem Series | |
| 3235 @cindex series objects | |
| 3236 @cindex stem series | |
| 3237 | |
| 8257 | 3238 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
|
3239 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
|
3240 as a child representing the stems. The properties of the stem series |
| 8257 | 3241 are |
| 3242 | |
| 3243 @table @code | |
|
17170
d6499c14021c
doc: Periodic grammarcheck of documentation.
Rik <rik@octave.org>
parents:
17152
diff
changeset
|
3244 @item showbaseline |
| 8257 | 3245 @itemx baseline |
| 3246 @itemx basevalue | |
| 3247 The property @code{showbaseline} flags whether the baseline of the | |
|
17281
bc924baa2c4e
doc: Add new @qcode macro for code samples which are quoted.
Rik <rik@octave.org>
parents:
17170
diff
changeset
|
3248 stem series is displayed (default is @qcode{"on"}). The handle of the graphics |
| 8257 | 3249 object representing the baseline is given by the @code{baseline} |
| 3250 property and the y-value (or z-value for @code{stem3}) of the baseline | |
| 3251 by the @code{basevalue} property. | |
| 3252 | |
| 3253 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
|
3254 the stem series and to the baseline itself. Equally changes in the |
| 8257 | 3255 properties of the base line itself are propagated to the members of the |
| 3256 corresponding stem series. | |
| 3257 | |
| 3258 @item color | |
|
9040
dbd0c77e575e
Cleanup documentation file plot.texi
Rik <rdrider0-list@yahoo.com>
parents:
9032
diff
changeset
|
3259 The RGB color or color name of the line objects of the stems. @xref{Colors}. |
| 8257 | 3260 |
|
17170
d6499c14021c
doc: Periodic grammarcheck of documentation.
Rik <rik@octave.org>
parents:
17152
diff
changeset
|
3261 @item linewidth |
| 8257 | 3262 @itemx linestyle |
|
9040
dbd0c77e575e
Cleanup documentation file plot.texi
Rik <rdrider0-list@yahoo.com>
parents:
9032
diff
changeset
|
3263 The line width and style of the line objects of the stems. @xref{Line Styles}. |
| 8257 | 3264 |
|
17170
d6499c14021c
doc: Periodic grammarcheck of documentation.
Rik <rik@octave.org>
parents:
17152
diff
changeset
|
3265 @item marker |
| 8257 | 3266 @itemx markeredgecolor |
| 3267 @itemx markerfacecolor | |
| 3268 @itemx markersize | |
|
9040
dbd0c77e575e
Cleanup documentation file plot.texi
Rik <rdrider0-list@yahoo.com>
parents:
9032
diff
changeset
|
3269 The line and fill color of the markers on the stems. @xref{Colors}. |
| 8257 | 3270 |
|
17170
d6499c14021c
doc: Periodic grammarcheck of documentation.
Rik <rik@octave.org>
parents:
17152
diff
changeset
|
3271 @item xdata |
| 8257 | 3272 @itemx ydata |
| 3273 @itemx zdata | |
| 3274 The original x, y and z data of the stems. | |
| 3275 | |
|
17170
d6499c14021c
doc: Periodic grammarcheck of documentation.
Rik <rik@octave.org>
parents:
17152
diff
changeset
|
3276 @item xdatasource |
| 8257 | 3277 @itemx ydatasource |
| 3278 @itemx zdatasource | |
| 3279 Data source variables. | |
| 3280 @end table | |
| 8073 | 3281 |
|
11257
8d4c57258523
fix some menu problems in the manual
John W. Eaton <jwe@octave.org>
parents:
11255
diff
changeset
|
3282 @node Surface Group |
|
8d4c57258523
fix some menu problems in the manual
John W. Eaton <jwe@octave.org>
parents:
11255
diff
changeset
|
3283 @subsubsection Surface Group |
| 8071 | 3284 @cindex group objects |
| 3285 @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
|
3286 |
| 8257 | 3287 Surface group objects are created by the @code{surf} or @code{mesh} |
| 3288 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
|
3289 or @code{meshc} functions. The surface group is of the type @code{surface}. |
| 8257 | 3290 |
| 3291 The properties of the surface group are | |
| 3292 | |
| 3293 @table @code | |
| 3294 @item edgecolor | |
|
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
3295 |
| 8257 | 3296 @item facecolor |
|
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
3297 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
|
3298 @xref{Colors}. |
| 8257 | 3299 |
|
17170
d6499c14021c
doc: Periodic grammarcheck of documentation.
Rik <rik@octave.org>
parents:
17152
diff
changeset
|
3300 @item linewidth |
| 8257 | 3301 @itemx linestyle |
|
9040
dbd0c77e575e
Cleanup documentation file plot.texi
Rik <rdrider0-list@yahoo.com>
parents:
9032
diff
changeset
|
3302 The line width and style of the lines on the surface. @xref{Line Styles}. |
| 8257 | 3303 |
|
17170
d6499c14021c
doc: Periodic grammarcheck of documentation.
Rik <rik@octave.org>
parents:
17152
diff
changeset
|
3304 @item marker |
| 8257 | 3305 @itemx markeredgecolor |
| 3306 @itemx markerfacecolor | |
| 3307 @itemx markersize | |
|
9040
dbd0c77e575e
Cleanup documentation file plot.texi
Rik <rdrider0-list@yahoo.com>
parents:
9032
diff
changeset
|
3308 The line and fill color of the markers on the surface. @xref{Colors}. |
| 8257 | 3309 |
|
17170
d6499c14021c
doc: Periodic grammarcheck of documentation.
Rik <rik@octave.org>
parents:
17152
diff
changeset
|
3310 @item xdata |
| 8257 | 3311 @itemx ydata |
| 3312 @itemx zdata | |
|
10828
322f43e0e170
Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents:
10711
diff
changeset
|
3313 @itemx cdata |
| 8257 | 3314 The original x, y, z and c data. |
| 3315 | |
|
17170
d6499c14021c
doc: Periodic grammarcheck of documentation.
Rik <rik@octave.org>
parents:
17152
diff
changeset
|
3316 @item xdatasource |
| 8257 | 3317 @itemx ydatasource |
| 3318 @itemx zdatasource | |
| 3319 @itemx cdatasource | |
| 3320 Data source variables. | |
| 3321 @end table | |
|
8056
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
3322 |
|
11576
8ac9687dbe9f
rename backend to graphics_toolkit
John W. Eaton <jwe@octave.org>
parents:
11573
diff
changeset
|
3323 @node Graphics Toolkits |
|
8ac9687dbe9f
rename backend to graphics_toolkit
John W. Eaton <jwe@octave.org>
parents:
11573
diff
changeset
|
3324 @subsection Graphics Toolkits |
|
8ac9687dbe9f
rename backend to graphics_toolkit
John W. Eaton <jwe@octave.org>
parents:
11573
diff
changeset
|
3325 @cindex graphics toolkits |
|
8ac9687dbe9f
rename backend to graphics_toolkit
John W. Eaton <jwe@octave.org>
parents:
11573
diff
changeset
|
3326 @cindex toolkits, graphics |
|
8ac9687dbe9f
rename backend to graphics_toolkit
John W. Eaton <jwe@octave.org>
parents:
11573
diff
changeset
|
3327 |
|
8ac9687dbe9f
rename backend to graphics_toolkit
John W. Eaton <jwe@octave.org>
parents:
11573
diff
changeset
|
3328 @DOCSTRING(graphics_toolkit) |
|
8ac9687dbe9f
rename backend to graphics_toolkit
John W. Eaton <jwe@octave.org>
parents:
11573
diff
changeset
|
3329 |
|
8ac9687dbe9f
rename backend to graphics_toolkit
John W. Eaton <jwe@octave.org>
parents:
11573
diff
changeset
|
3330 @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
|
3331 |
|
14134
84f38aeb9f0e
doc: Add register_graphics_toolkit() and loaded_graphics_toolkits() to documentation
Rik <octave@nomad.inbox5.com>
parents:
13947
diff
changeset
|
3332 @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
|
3333 |
|
84f38aeb9f0e
doc: Add register_graphics_toolkit() and loaded_graphics_toolkits() to documentation
Rik <octave@nomad.inbox5.com>
parents:
13947
diff
changeset
|
3334 @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
|
3335 |
|
8056
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
3336 @menu |
|
17152
f2a8592b8fbd
doc: Shorten some long subsection names in Manual.
Rik <rik@octave.org>
parents:
17123
diff
changeset
|
3337 * 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
|
3338 @end menu |
|
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
8055
diff
changeset
|
3339 |
|
12226
8cc154f45e37
Rename fltk_mouse_wheel_zoom, fltk_gui_mode functions to remove fltk_ prefix.
Rik <octave@nomad.inbox5.com>
parents:
12215
diff
changeset
|
3340 @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
|
3341 @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
|
3342 @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
|
3343 |
|
8cc154f45e37
Rename fltk_mouse_wheel_zoom, fltk_gui_mode functions to remove fltk_ prefix.
Rik <octave@nomad.inbox5.com>
parents:
12215
diff
changeset
|
3344 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
|
3345 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
|
3346 graphics toolkit. |
| 3428 | 3347 |
| 3348 @DOCSTRING(gnuplot_binary) | |
|
12215
4ae2a74ed04c
Add fltk_gui_mode, fltk_mouse_wheel_zoom to documentation.
Rik <octave@nomad.inbox5.com>
parents:
12189
diff
changeset
|
3349 |
|
12226
8cc154f45e37
Rename fltk_mouse_wheel_zoom, fltk_gui_mode functions to remove fltk_ prefix.
Rik <octave@nomad.inbox5.com>
parents:
12215
diff
changeset
|
3350 @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
|
3351 |
|
8cc154f45e37
Rename fltk_mouse_wheel_zoom, fltk_gui_mode functions to remove fltk_ prefix.
Rik <octave@nomad.inbox5.com>
parents:
12215
diff
changeset
|
3352 @DOCSTRING(mouse_wheel_zoom) |