annotate doc/interpreter/plot.txi @ 12690:e9e35a707721 stable

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