Mercurial > hg > octave-jordi

annotate doc/interpreter/plot.txi @ 16802:9302e92df412

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