annotate doc/interpreter/plot.txi @ 8071:b6e85fb238c1

doc fixes
author John W. Eaton <jwe@octave.org>
date Thu, 28 Aug 2008 15:08:43 -0400
parents 3b53b25e2550
children 8468140fd997
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
7018
fd42779a8428 [project @ 2007-10-13 00:52:12 by jwe]
jwe
parents: 7001
diff changeset
1 @c Copyright (C) 1996, 1997, 1999, 2000, 2002, 2003, 2004, 2005,
fd42779a8428 [project @ 2007-10-13 00:52:12 by jwe]
jwe
parents: 7001
diff changeset
2 @c 2006, 2007 John W. Eaton
fd42779a8428 [project @ 2007-10-13 00:52:12 by jwe]
jwe
parents: 7001
diff changeset
3 @c
fd42779a8428 [project @ 2007-10-13 00:52:12 by jwe]
jwe
parents: 7001
diff changeset
4 @c This file is part of Octave.
fd42779a8428 [project @ 2007-10-13 00:52:12 by jwe]
jwe
parents: 7001
diff changeset
5 @c
fd42779a8428 [project @ 2007-10-13 00:52:12 by jwe]
jwe
parents: 7001
diff changeset
6 @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
7 @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
8 @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
9 @c your option) any later version.
fd42779a8428 [project @ 2007-10-13 00:52:12 by jwe]
jwe
parents: 7001
diff changeset
10 @c
fd42779a8428 [project @ 2007-10-13 00:52:12 by jwe]
jwe
parents: 7001
diff changeset
11 @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
12 @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
13 @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
14 @c for more details.
fd42779a8428 [project @ 2007-10-13 00:52:12 by jwe]
jwe
parents: 7001
diff changeset
15 @c
fd42779a8428 [project @ 2007-10-13 00:52:12 by jwe]
jwe
parents: 7001
diff changeset
16 @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
17 @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
18 @c <http://www.gnu.org/licenses/>.
3294
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
19
4167
aae05d51353c [project @ 2002-11-12 02:52:50 by jwe]
jwe
parents: 3439
diff changeset
20 @node Plotting
3294
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
21 @chapter Plotting
6888
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
22 @cindex plotting
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
23 @cindex graphics
3294
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
24
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
25 @menu
6888
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
26 * Plotting Basics::
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
27 * Advanced Plotting::
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
28 @end menu
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
29
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
30 @node Plotting Basics
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
31 @section Plotting Basics
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
32
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
33 Octave makes it easy to create many different types of two- and
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
34 three-dimensional plots using a few high-level functions.
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
35
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
36 If you need finer control over graphics, see @ref{Advanced Plotting}.
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
37
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
38 @menu
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
39 * Two-Dimensional Plots::
3294
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
40 * Three-Dimensional Plotting::
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
41 * Plot Annotations::
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
42 * Multiple Plots on One Page::
3428
5b77cf82393c [project @ 2000-01-14 02:54:53 by jwe]
jwe
parents: 3368
diff changeset
43 * Multiple Plot Windows::
6888
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
44 * Printing Plots::
7984
bbaa5d7d0143 Some documentation updates
David Bateman <dbateman@free.fr>
parents: 7981
diff changeset
45 * Interacting with plots::
6888
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
46 * Test Plotting Functions::
3294
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
47 @end menu
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
48
6888
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
49 @node Two-Dimensional Plots
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
50 @subsection Two-Dimensional Plots
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
51
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
52 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
53 linear axes. For example,
3294
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
54
6888
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
55 @example
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
56 @group
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
57 x = -10:0.1:10;
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
58 plot (x, sin (x));
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
59 @end group
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
60 @end example
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
61
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
62 @noindent
6899
110c5782fe3b [project @ 2007-09-14 15:17:53 by jwe]
jwe
parents: 6892
diff changeset
63 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
64 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
65
6888
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
66 @float Figure,fig:plot
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
67 @image{plot,8cm}
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
68 @caption{Simple Two-Dimensional Plot.}
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
69 @end float
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
70
5134
0309b6722ee9 [project @ 2005-02-08 20:17:55 by jwe]
jwe
parents: 5016
diff changeset
71 @DOCSTRING(plot)
0309b6722ee9 [project @ 2005-02-08 20:17:55 by jwe]
jwe
parents: 5016
diff changeset
72
6888
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
73 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
74 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
75 both of the axes use log scales.
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
76
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
77 @DOCSTRING(semilogx)
6502
6ab0a8767780 [project @ 2007-04-06 03:32:06 by jwe]
jwe
parents: 6331
diff changeset
78
6888
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
79 @DOCSTRING(semilogy)
6502
6ab0a8767780 [project @ 2007-04-06 03:32:06 by jwe]
jwe
parents: 6331
diff changeset
80
6888
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
81 @DOCSTRING(loglog)
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
82
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
83 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
84 are useful for displaying discrete data. For example,
5134
0309b6722ee9 [project @ 2005-02-08 20:17:55 by jwe]
jwe
parents: 5016
diff changeset
85
6888
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
86 @example
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
87 @group
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
88 hist (randn (10000, 1), 30);
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
89 @end group
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
90 @end example
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 @noindent
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
93 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
94 shown in @ref{fig:hist}.
5134
0309b6722ee9 [project @ 2005-02-08 20:17:55 by jwe]
jwe
parents: 5016
diff changeset
95
6888
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
96 @float Figure,fig:hist
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
97 @image{hist,8cm}
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
98 @caption{Histogram.}
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
99 @end float
5134
0309b6722ee9 [project @ 2005-02-08 20:17:55 by jwe]
jwe
parents: 5016
diff changeset
100
0309b6722ee9 [project @ 2005-02-08 20:17:55 by jwe]
jwe
parents: 5016
diff changeset
101 @DOCSTRING(bar)
0309b6722ee9 [project @ 2005-02-08 20:17:55 by jwe]
jwe
parents: 5016
diff changeset
102
6877
ab11bdb09820 [project @ 2007-09-07 05:12:32 by jwe]
jwe
parents: 6788
diff changeset
103 @DOCSTRING(barh)
ab11bdb09820 [project @ 2007-09-07 05:12:32 by jwe]
jwe
parents: 6788
diff changeset
104
6888
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
105 @DOCSTRING(hist)
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
106
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
107 @DOCSTRING(stairs)
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
108
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
109 @DOCSTRING(stem)
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
110
7981
90413830b690 Document contourf
David Bateman <dbateman@free.fr>
parents: 7980
diff changeset
111 The @code{contour}, @code{contourf} and @code{contourc} functions
90413830b690 Document contourf
David Bateman <dbateman@free.fr>
parents: 7980
diff changeset
112 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
113
5134
0309b6722ee9 [project @ 2005-02-08 20:17:55 by jwe]
jwe
parents: 5016
diff changeset
114 @DOCSTRING(contour)
0309b6722ee9 [project @ 2005-02-08 20:17:55 by jwe]
jwe
parents: 5016
diff changeset
115
7981
90413830b690 Document contourf
David Bateman <dbateman@free.fr>
parents: 7980
diff changeset
116 @DOCSTRING(contourf)
90413830b690 Document contourf
David Bateman <dbateman@free.fr>
parents: 7980
diff changeset
117
6502
6ab0a8767780 [project @ 2007-04-06 03:32:06 by jwe]
jwe
parents: 6331
diff changeset
118 @DOCSTRING(contourc)
6ab0a8767780 [project @ 2007-04-06 03:32:06 by jwe]
jwe
parents: 6331
diff changeset
119
6888
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
120 The @code{errorbar}, @code{semilogxerr}, @code{semilogyerr}, and
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
121 @code{loglogerr} functions produces plots with error bar markers. For
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
122 example,
6877
ab11bdb09820 [project @ 2007-09-07 05:12:32 by jwe]
jwe
parents: 6788
diff changeset
123
6888
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
124 @example
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
125 x = 0:0.1:10;
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
126 y = sin (x);
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
127 yp = 0.1 .* randn (size (x));
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
128 ym = -0.1 .* randn (size (x));
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
129 errorbar (x, sin (x), ym, yp);
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
130 @end example
5134
0309b6722ee9 [project @ 2005-02-08 20:17:55 by jwe]
jwe
parents: 5016
diff changeset
131
6888
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
132 @noindent
6899
110c5782fe3b [project @ 2007-09-14 15:17:53 by jwe]
jwe
parents: 6892
diff changeset
133 produces the figure shown in @ref{fig:errorbar}.
6502
6ab0a8767780 [project @ 2007-04-06 03:32:06 by jwe]
jwe
parents: 6331
diff changeset
134
6888
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
135 @float Figure,fig:errorbar
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
136 @image{errorbar,8cm}
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
137 @caption{Errorbar plot.}
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
138 @end float
5134
0309b6722ee9 [project @ 2005-02-08 20:17:55 by jwe]
jwe
parents: 5016
diff changeset
139
0309b6722ee9 [project @ 2005-02-08 20:17:55 by jwe]
jwe
parents: 5016
diff changeset
140 @DOCSTRING(errorbar)
0309b6722ee9 [project @ 2005-02-08 20:17:55 by jwe]
jwe
parents: 5016
diff changeset
141
0309b6722ee9 [project @ 2005-02-08 20:17:55 by jwe]
jwe
parents: 5016
diff changeset
142 @DOCSTRING(semilogxerr)
0309b6722ee9 [project @ 2005-02-08 20:17:55 by jwe]
jwe
parents: 5016
diff changeset
143
0309b6722ee9 [project @ 2005-02-08 20:17:55 by jwe]
jwe
parents: 5016
diff changeset
144 @DOCSTRING(semilogyerr)
0309b6722ee9 [project @ 2005-02-08 20:17:55 by jwe]
jwe
parents: 5016
diff changeset
145
6888
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
146 @DOCSTRING(loglogerr)
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
147
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
148 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
149 polar coordinates. However, the display coordinates remain rectangular
6888
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
150 and linear. For example,
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
151
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
152 @example
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
153 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
154 @end example
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
155
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
156 @noindent
6899
110c5782fe3b [project @ 2007-09-14 15:17:53 by jwe]
jwe
parents: 6892
diff changeset
157 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
158
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
159 @float Figure,fig:polar
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
160 @image{polar,8cm}
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
161 @caption{Polar plot.}
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
162 @end float
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
163
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
164 @DOCSTRING(polar)
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
165
7120
a2174fb073d4 [project @ 2007-11-07 21:26:43 by jwe]
jwe
parents: 7018
diff changeset
166 @DOCSTRING(pie)
a2174fb073d4 [project @ 2007-11-07 21:26:43 by jwe]
jwe
parents: 7018
diff changeset
167
a2174fb073d4 [project @ 2007-11-07 21:26:43 by jwe]
jwe
parents: 7018
diff changeset
168 @DOCSTRING(quiver)
a2174fb073d4 [project @ 2007-11-07 21:26:43 by jwe]
jwe
parents: 7018
diff changeset
169
a2174fb073d4 [project @ 2007-11-07 21:26:43 by jwe]
jwe
parents: 7018
diff changeset
170 @DOCSTRING(pcolor)
a2174fb073d4 [project @ 2007-11-07 21:26:43 by jwe]
jwe
parents: 7018
diff changeset
171
7153
4246642e9f48 [project @ 2007-11-09 21:20:07 by dbateman]
dbateman
parents: 7120
diff changeset
172 @DOCSTRING(area)
4246642e9f48 [project @ 2007-11-09 21:20:07 by dbateman]
dbateman
parents: 7120
diff changeset
173
6888
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
174 The axis function may be used to change the axis limits of an existing
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
175 plot.
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
176
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
177 @DOCSTRING(axis)
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
178
7189
e8d953d03f6a [project @ 2007-11-26 20:42:09 by dbateman]
dbateman
parents: 7153
diff changeset
179 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
180 function.
e8d953d03f6a [project @ 2007-11-26 20:42:09 by dbateman]
dbateman
parents: 7153
diff changeset
181
e8d953d03f6a [project @ 2007-11-26 20:42:09 by dbateman]
dbateman
parents: 7153
diff changeset
182 @DOCSTRING(caxis)
e8d953d03f6a [project @ 2007-11-26 20:42:09 by dbateman]
dbateman
parents: 7153
diff changeset
183
7989
23c248d415b5 Various doc fixes. Readd cellidx
David Bateman <dbateman@free.fr>
parents: 7984
diff changeset
184 @menu
23c248d415b5 Various doc fixes. Readd cellidx
David Bateman <dbateman@free.fr>
parents: 7984
diff changeset
185 * Two-dimensional Function Plotting::
23c248d415b5 Various doc fixes. Readd cellidx
David Bateman <dbateman@free.fr>
parents: 7984
diff changeset
186 @end menu
23c248d415b5 Various doc fixes. Readd cellidx
David Bateman <dbateman@free.fr>
parents: 7984
diff changeset
187
7984
bbaa5d7d0143 Some documentation updates
David Bateman <dbateman@free.fr>
parents: 7981
diff changeset
188 @node Two-dimensional Function Plotting
bbaa5d7d0143 Some documentation updates
David Bateman <dbateman@free.fr>
parents: 7981
diff changeset
189 @subsubsection Two-dimensional Function Plotting
bbaa5d7d0143 Some documentation updates
David Bateman <dbateman@free.fr>
parents: 7981
diff changeset
190
bbaa5d7d0143 Some documentation updates
David Bateman <dbateman@free.fr>
parents: 7981
diff changeset
191 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
192 string defining the function without the user needing to explicitly
bbaa5d7d0143 Some documentation updates
David Bateman <dbateman@free.fr>
parents: 7981
diff changeset
193 create the data to be plotted. The function @code{fplot} also generates
bbaa5d7d0143 Some documentation updates
David Bateman <dbateman@free.fr>
parents: 7981
diff changeset
194 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
195 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
196 example,
bbaa5d7d0143 Some documentation updates
David Bateman <dbateman@free.fr>
parents: 7981
diff changeset
197
bbaa5d7d0143 Some documentation updates
David Bateman <dbateman@free.fr>
parents: 7981
diff changeset
198 @example
bbaa5d7d0143 Some documentation updates
David Bateman <dbateman@free.fr>
parents: 7981
diff changeset
199 @group
bbaa5d7d0143 Some documentation updates
David Bateman <dbateman@free.fr>
parents: 7981
diff changeset
200 fplot (@@sin, [-10, 10], 201);
bbaa5d7d0143 Some documentation updates
David Bateman <dbateman@free.fr>
parents: 7981
diff changeset
201 @end group
bbaa5d7d0143 Some documentation updates
David Bateman <dbateman@free.fr>
parents: 7981
diff changeset
202 @end example
bbaa5d7d0143 Some documentation updates
David Bateman <dbateman@free.fr>
parents: 7981
diff changeset
203
bbaa5d7d0143 Some documentation updates
David Bateman <dbateman@free.fr>
parents: 7981
diff changeset
204 @noindent
bbaa5d7d0143 Some documentation updates
David Bateman <dbateman@free.fr>
parents: 7981
diff changeset
205 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
206 legend displaying the name of the plotted function.
bbaa5d7d0143 Some documentation updates
David Bateman <dbateman@free.fr>
parents: 7981
diff changeset
207
bbaa5d7d0143 Some documentation updates
David Bateman <dbateman@free.fr>
parents: 7981
diff changeset
208 @DOCSTRING(fplot)
bbaa5d7d0143 Some documentation updates
David Bateman <dbateman@free.fr>
parents: 7981
diff changeset
209
bbaa5d7d0143 Some documentation updates
David Bateman <dbateman@free.fr>
parents: 7981
diff changeset
210 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
211 function include @code{ezplot}, @code{ezcontour}, @code{ezcontourf} and
8046
c4482fc30c7f Add the ezplot function
David Bateman <dbateman@free.fr>
parents: 7989
diff changeset
212 @code{ezpolar}.
c4482fc30c7f Add the ezplot function
David Bateman <dbateman@free.fr>
parents: 7989
diff changeset
213
c4482fc30c7f Add the ezplot function
David Bateman <dbateman@free.fr>
parents: 7989
diff changeset
214 @DOCSTRING(ezplot)
7984
bbaa5d7d0143 Some documentation updates
David Bateman <dbateman@free.fr>
parents: 7981
diff changeset
215
bbaa5d7d0143 Some documentation updates
David Bateman <dbateman@free.fr>
parents: 7981
diff changeset
216 @DOCSTRING(ezcontour)
bbaa5d7d0143 Some documentation updates
David Bateman <dbateman@free.fr>
parents: 7981
diff changeset
217
bbaa5d7d0143 Some documentation updates
David Bateman <dbateman@free.fr>
parents: 7981
diff changeset
218 @DOCSTRING(ezcontourf)
bbaa5d7d0143 Some documentation updates
David Bateman <dbateman@free.fr>
parents: 7981
diff changeset
219
bbaa5d7d0143 Some documentation updates
David Bateman <dbateman@free.fr>
parents: 7981
diff changeset
220 @DOCSTRING(ezpolar)
bbaa5d7d0143 Some documentation updates
David Bateman <dbateman@free.fr>
parents: 7981
diff changeset
221
5134
0309b6722ee9 [project @ 2005-02-08 20:17:55 by jwe]
jwe
parents: 5016
diff changeset
222 @node Three-Dimensional Plotting
6888
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
223 @subsection Three-Dimensional Plotting
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
224
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
225 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
226
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
227 @example
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
228 @group
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
229 tx = ty = linspace (-8, 8, 41)';
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
230 [xx, yy] = meshgrid (tx, ty);
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
231 r = sqrt (xx .^ 2 + yy .^ 2) + eps;
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
232 tz = sin (r) ./ r;
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
233 mesh (tx, ty, tz);
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
234 @end group
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
235 @end example
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
236
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
237 @noindent
6899
110c5782fe3b [project @ 2007-09-14 15:17:53 by jwe]
jwe
parents: 6892
diff changeset
238 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
239 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
240 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
241 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
242
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
243 @float Figure,fig:mesh
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
244 @image{mesh,8cm}
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
245 @caption{Mesh plot.}
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
246 @end float
5134
0309b6722ee9 [project @ 2005-02-08 20:17:55 by jwe]
jwe
parents: 5016
diff changeset
247
6888
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
248 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
249 plot of contours for the surface.
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
250
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
251 The @code{plot3} function displays arbitrary three-dimensional data,
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
252 without requiring it to form a surface. For example
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
253
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
254 @example
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
255 @group
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
256 t = 0:0.1:10*pi;
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
257 r = linspace (0, 1, numel (t));
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
258 z = linspace (0, 1, numel (t));
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
259 plot3 (r.*sin(t), r.*cos(t), z);
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
260 @end group
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
261 @end example
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
262
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
263 @noindent
6899
110c5782fe3b [project @ 2007-09-14 15:17:53 by jwe]
jwe
parents: 6892
diff changeset
264 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
265
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
266 @float Figure,fig:plot3
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
267 @image{plot3,8cm}
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
268 @caption{Three dimensional spiral.}
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
269 @end float
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
270
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
271 Finally, the @code{view} function changes the viewpoint for
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
272 three-dimensional plots.
5134
0309b6722ee9 [project @ 2005-02-08 20:17:55 by jwe]
jwe
parents: 5016
diff changeset
273
0309b6722ee9 [project @ 2005-02-08 20:17:55 by jwe]
jwe
parents: 5016
diff changeset
274 @DOCSTRING(mesh)
0309b6722ee9 [project @ 2005-02-08 20:17:55 by jwe]
jwe
parents: 5016
diff changeset
275
6788
c81a0f3f5a82 [project @ 2007-07-23 22:05:29 by dbateman]
dbateman
parents: 6778
diff changeset
276 @DOCSTRING(meshc)
c81a0f3f5a82 [project @ 2007-07-23 22:05:29 by dbateman]
dbateman
parents: 6778
diff changeset
277
7153
4246642e9f48 [project @ 2007-11-09 21:20:07 by dbateman]
dbateman
parents: 7120
diff changeset
278 @DOCSTRING(hidden)
4246642e9f48 [project @ 2007-11-09 21:20:07 by dbateman]
dbateman
parents: 7120
diff changeset
279
7120
a2174fb073d4 [project @ 2007-11-07 21:26:43 by jwe]
jwe
parents: 7018
diff changeset
280 @DOCSTRING(surf)
a2174fb073d4 [project @ 2007-11-07 21:26:43 by jwe]
jwe
parents: 7018
diff changeset
281
a2174fb073d4 [project @ 2007-11-07 21:26:43 by jwe]
jwe
parents: 7018
diff changeset
282 @DOCSTRING(surfc)
a2174fb073d4 [project @ 2007-11-07 21:26:43 by jwe]
jwe
parents: 7018
diff changeset
283
5134
0309b6722ee9 [project @ 2005-02-08 20:17:55 by jwe]
jwe
parents: 5016
diff changeset
284 @DOCSTRING(meshgrid)
0309b6722ee9 [project @ 2005-02-08 20:17:55 by jwe]
jwe
parents: 5016
diff changeset
285
6550
1b7a6061a05d [project @ 2007-04-20 07:40:26 by jwe]
jwe
parents: 6549
diff changeset
286 @DOCSTRING(ndgrid)
1b7a6061a05d [project @ 2007-04-20 07:40:26 by jwe]
jwe
parents: 6549
diff changeset
287
6888
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
288 @DOCSTRING(plot3)
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
289
6502
6ab0a8767780 [project @ 2007-04-06 03:32:06 by jwe]
jwe
parents: 6331
diff changeset
290 @DOCSTRING(view)
6ab0a8767780 [project @ 2007-04-06 03:32:06 by jwe]
jwe
parents: 6331
diff changeset
291
7120
a2174fb073d4 [project @ 2007-11-07 21:26:43 by jwe]
jwe
parents: 7018
diff changeset
292 @DOCSTRING(shading)
a2174fb073d4 [project @ 2007-11-07 21:26:43 by jwe]
jwe
parents: 7018
diff changeset
293
7989
23c248d415b5 Various doc fixes. Readd cellidx
David Bateman <dbateman@free.fr>
parents: 7984
diff changeset
294 @menu
23c248d415b5 Various doc fixes. Readd cellidx
David Bateman <dbateman@free.fr>
parents: 7984
diff changeset
295 * Three-dimensional Function Plotting::
23c248d415b5 Various doc fixes. Readd cellidx
David Bateman <dbateman@free.fr>
parents: 7984
diff changeset
296 @end menu
23c248d415b5 Various doc fixes. Readd cellidx
David Bateman <dbateman@free.fr>
parents: 7984
diff changeset
297
23c248d415b5 Various doc fixes. Readd cellidx
David Bateman <dbateman@free.fr>
parents: 7984
diff changeset
298 @node Three-dimensional Function Plotting
23c248d415b5 Various doc fixes. Readd cellidx
David Bateman <dbateman@free.fr>
parents: 7984
diff changeset
299 @subsubsection Three-dimensional Function Plotting
7984
bbaa5d7d0143 Some documentation updates
David Bateman <dbateman@free.fr>
parents: 7981
diff changeset
300
bbaa5d7d0143 Some documentation updates
David Bateman <dbateman@free.fr>
parents: 7981
diff changeset
301 @DOCSTRING(ezplot3)
bbaa5d7d0143 Some documentation updates
David Bateman <dbateman@free.fr>
parents: 7981
diff changeset
302
bbaa5d7d0143 Some documentation updates
David Bateman <dbateman@free.fr>
parents: 7981
diff changeset
303 @DOCSTRING(ezmesh)
bbaa5d7d0143 Some documentation updates
David Bateman <dbateman@free.fr>
parents: 7981
diff changeset
304
bbaa5d7d0143 Some documentation updates
David Bateman <dbateman@free.fr>
parents: 7981
diff changeset
305 @DOCSTRING(ezmeshc)
bbaa5d7d0143 Some documentation updates
David Bateman <dbateman@free.fr>
parents: 7981
diff changeset
306
bbaa5d7d0143 Some documentation updates
David Bateman <dbateman@free.fr>
parents: 7981
diff changeset
307 @DOCSTRING(ezsurf)
bbaa5d7d0143 Some documentation updates
David Bateman <dbateman@free.fr>
parents: 7981
diff changeset
308
bbaa5d7d0143 Some documentation updates
David Bateman <dbateman@free.fr>
parents: 7981
diff changeset
309 @DOCSTRING(ezsurfc)
bbaa5d7d0143 Some documentation updates
David Bateman <dbateman@free.fr>
parents: 7981
diff changeset
310
6888
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
311 @node Plot Annotations
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
312 @subsection Plot Annotations
6502
6ab0a8767780 [project @ 2007-04-06 03:32:06 by jwe]
jwe
parents: 6331
diff changeset
313
6888
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
314 You can add titles, axis labels, legends, and arbitrary text to an
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
315 existing plot. For example,
6877
ab11bdb09820 [project @ 2007-09-07 05:12:32 by jwe]
jwe
parents: 6788
diff changeset
316
6888
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
317 @example
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
318 @group
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
319 x = -10:0.1:10;
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
320 plot (x, sin (x));
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
321 title ("sin(x) for x = -10:0.1:10");
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
322 xlabel ("x");
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
323 ylabel ("sin (x)");
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
324 text (pi, 0.7, "arbitrary text");
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
325 legend ("sin (x)");
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
326 @end group
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
327 @end example
6502
6ab0a8767780 [project @ 2007-04-06 03:32:06 by jwe]
jwe
parents: 6331
diff changeset
328
6888
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
329 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
330 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
331 border lines are on.
5134
0309b6722ee9 [project @ 2005-02-08 20:17:55 by jwe]
jwe
parents: 5016
diff changeset
332
0309b6722ee9 [project @ 2005-02-08 20:17:55 by jwe]
jwe
parents: 5016
diff changeset
333 @DOCSTRING(title)
0309b6722ee9 [project @ 2005-02-08 20:17:55 by jwe]
jwe
parents: 5016
diff changeset
334
6502
6ab0a8767780 [project @ 2007-04-06 03:32:06 by jwe]
jwe
parents: 6331
diff changeset
335 @DOCSTRING(legend)
6ab0a8767780 [project @ 2007-04-06 03:32:06 by jwe]
jwe
parents: 6331
diff changeset
336
6ab0a8767780 [project @ 2007-04-06 03:32:06 by jwe]
jwe
parents: 6331
diff changeset
337 @DOCSTRING(text)
6ab0a8767780 [project @ 2007-04-06 03:32:06 by jwe]
jwe
parents: 6331
diff changeset
338
5134
0309b6722ee9 [project @ 2005-02-08 20:17:55 by jwe]
jwe
parents: 5016
diff changeset
339 @DOCSTRING(xlabel)
0309b6722ee9 [project @ 2005-02-08 20:17:55 by jwe]
jwe
parents: 5016
diff changeset
340
6502
6ab0a8767780 [project @ 2007-04-06 03:32:06 by jwe]
jwe
parents: 6331
diff changeset
341 @DOCSTRING(box)
6ab0a8767780 [project @ 2007-04-06 03:32:06 by jwe]
jwe
parents: 6331
diff changeset
342
6ab0a8767780 [project @ 2007-04-06 03:32:06 by jwe]
jwe
parents: 6331
diff changeset
343 @DOCSTRING(grid)
6ab0a8767780 [project @ 2007-04-06 03:32:06 by jwe]
jwe
parents: 6331
diff changeset
344
5134
0309b6722ee9 [project @ 2005-02-08 20:17:55 by jwe]
jwe
parents: 5016
diff changeset
345 @node Multiple Plots on One Page
6888
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
346 @subsection Multiple Plots on One Page
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
347
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
348 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
349 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
350 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
351 For example,
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
352
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
353 @example
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
354 @group
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
355 subplot (2, 1, 1)
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
356 fplot (@@sin, [-10, 10]);
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
357 subplot (2, 1, 2)
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
358 fplot (@@cos, [-10, 10]);
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
359 @end group
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
360 @end example
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
361
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
362 @noindent
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
363 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
364 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
365 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
366 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
367 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
368
0309b6722ee9 [project @ 2005-02-08 20:17:55 by jwe]
jwe
parents: 5016
diff changeset
369 @DOCSTRING(subplot)
0309b6722ee9 [project @ 2005-02-08 20:17:55 by jwe]
jwe
parents: 5016
diff changeset
370
0309b6722ee9 [project @ 2005-02-08 20:17:55 by jwe]
jwe
parents: 5016
diff changeset
371 @node Multiple Plot Windows
6888
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
372 @subsection Multiple Plot Windows
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
373
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
374 You can open multiple plot windows using the @code{figure} function.
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
375 For example
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
376
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
377 @example
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
378 figure (1);
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
379 fplot (@@sin, [-10, 10]);
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
380 figure (2);
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
381 fplot (@@cos, [-10, 10]);
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
382 @end example
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
383
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
384 @noindent
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
385 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
386 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
387
0309b6722ee9 [project @ 2005-02-08 20:17:55 by jwe]
jwe
parents: 5016
diff changeset
388 @DOCSTRING(figure)
0309b6722ee9 [project @ 2005-02-08 20:17:55 by jwe]
jwe
parents: 5016
diff changeset
389
6502
6ab0a8767780 [project @ 2007-04-06 03:32:06 by jwe]
jwe
parents: 6331
diff changeset
390 @node Printing Plots
6888
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
391 @subsection Printing Plots
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
392
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
393 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
394 formats. For example,
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
395
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
396 @example
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
397 print -deps foo.eps
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
398 @end example
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
399
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
400 @noindent
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
401 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
402 @file{foo.eps}.
6502
6ab0a8767780 [project @ 2007-04-06 03:32:06 by jwe]
jwe
parents: 6331
diff changeset
403
6ab0a8767780 [project @ 2007-04-06 03:32:06 by jwe]
jwe
parents: 6331
diff changeset
404 @DOCSTRING(print)
6ab0a8767780 [project @ 2007-04-06 03:32:06 by jwe]
jwe
parents: 6331
diff changeset
405
6ab0a8767780 [project @ 2007-04-06 03:32:06 by jwe]
jwe
parents: 6331
diff changeset
406 @DOCSTRING(orient)
5134
0309b6722ee9 [project @ 2005-02-08 20:17:55 by jwe]
jwe
parents: 5016
diff changeset
407
7984
bbaa5d7d0143 Some documentation updates
David Bateman <dbateman@free.fr>
parents: 7981
diff changeset
408 @node Interacting with plots
bbaa5d7d0143 Some documentation updates
David Bateman <dbateman@free.fr>
parents: 7981
diff changeset
409 @subsection Interacting with plots
bbaa5d7d0143 Some documentation updates
David Bateman <dbateman@free.fr>
parents: 7981
diff changeset
410
bbaa5d7d0143 Some documentation updates
David Bateman <dbateman@free.fr>
parents: 7981
diff changeset
411 The user can select points on a plot with the @code{ginput} function or
bbaa5d7d0143 Some documentation updates
David Bateman <dbateman@free.fr>
parents: 7981
diff changeset
412 selction the position at which to place text on the plot with the
bbaa5d7d0143 Some documentation updates
David Bateman <dbateman@free.fr>
parents: 7981
diff changeset
413 @code{gtext} function using the mouse.
bbaa5d7d0143 Some documentation updates
David Bateman <dbateman@free.fr>
parents: 7981
diff changeset
414
bbaa5d7d0143 Some documentation updates
David Bateman <dbateman@free.fr>
parents: 7981
diff changeset
415 @DOCSTRING(ginput)
bbaa5d7d0143 Some documentation updates
David Bateman <dbateman@free.fr>
parents: 7981
diff changeset
416
bbaa5d7d0143 Some documentation updates
David Bateman <dbateman@free.fr>
parents: 7981
diff changeset
417 @DOCSTRING(waitforbuttonpress)
bbaa5d7d0143 Some documentation updates
David Bateman <dbateman@free.fr>
parents: 7981
diff changeset
418
bbaa5d7d0143 Some documentation updates
David Bateman <dbateman@free.fr>
parents: 7981
diff changeset
419 @DOCSTRING(gtext)
bbaa5d7d0143 Some documentation updates
David Bateman <dbateman@free.fr>
parents: 7981
diff changeset
420
6788
c81a0f3f5a82 [project @ 2007-07-23 22:05:29 by dbateman]
dbateman
parents: 6778
diff changeset
421 @node Test Plotting Functions
6888
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
422 @subsection Test Plotting Functions
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
423
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
424 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
425 that plotting is working. Typing either @code{sombrero} or @code{peaks}
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
426 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
427
6877
ab11bdb09820 [project @ 2007-09-07 05:12:32 by jwe]
jwe
parents: 6788
diff changeset
428 @DOCSTRING(sombrero)
ab11bdb09820 [project @ 2007-09-07 05:12:32 by jwe]
jwe
parents: 6788
diff changeset
429
6788
c81a0f3f5a82 [project @ 2007-07-23 22:05:29 by dbateman]
dbateman
parents: 6778
diff changeset
430 @DOCSTRING(peaks)
c81a0f3f5a82 [project @ 2007-07-23 22:05:29 by dbateman]
dbateman
parents: 6778
diff changeset
431
6888
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
432 @node Advanced Plotting
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
433 @section Advanced Plotting
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
434
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
435 @menu
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
436 * Graphics Objects::
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
437 * Graphics Object Properties::
6891
e9921bb3d95b [project @ 2007-09-13 02:44:27 by jwe]
jwe
parents: 6889
diff changeset
438 * Managing Default Properties::
6889
ebff56d6b0a8 [project @ 2007-09-12 18:32:12 by jwe]
jwe
parents: 6888
diff changeset
439 * Colors::
ebff56d6b0a8 [project @ 2007-09-12 18:32:12 by jwe]
jwe
parents: 6888
diff changeset
440 * Line Styles::
ebff56d6b0a8 [project @ 2007-09-12 18:32:12 by jwe]
jwe
parents: 6888
diff changeset
441 * Marker Styles::
8056
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents: 8055
diff changeset
442 * Callbacks::
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents: 8055
diff changeset
443 * Object Groups::
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents: 8055
diff changeset
444 * Graphics backends::
6888
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
445 @end menu
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
446
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
447 @node Graphics Objects
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
448 @subsection Graphics Objects
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
449
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
450 Plots in Octave are constructed from the following @dfn{graphics
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
451 objects}. Each graphics object has a set of properties that define its
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
452 appearance and may also contain links to other graphics objects.
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
453 Graphics objects are only referenced by a numeric index, or @dfn{handle}.
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
454
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
455 @table @asis
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
456 @item root figure
8071
b6e85fb238c1 doc fixes
John W. Eaton <jwe@octave.org>
parents: 8070
diff changeset
457 @cindex root figure graphics object
b6e85fb238c1 doc fixes
John W. Eaton <jwe@octave.org>
parents: 8070
diff changeset
458 @cindex graphics object, root figure
6888
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
459 The parent of all figure objects. The index for the root figure is
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
460 defined to be 0.
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
461
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
462 @item figure
8071
b6e85fb238c1 doc fixes
John W. Eaton <jwe@octave.org>
parents: 8070
diff changeset
463 @cindex figure graphics object
b6e85fb238c1 doc fixes
John W. Eaton <jwe@octave.org>
parents: 8070
diff changeset
464 @cindex graphics object, figure
6888
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
465 A figure window.
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
466
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
467 @item axes
8071
b6e85fb238c1 doc fixes
John W. Eaton <jwe@octave.org>
parents: 8070
diff changeset
468 @cindex axes graphics object
b6e85fb238c1 doc fixes
John W. Eaton <jwe@octave.org>
parents: 8070
diff changeset
469 @cindex graphics object, axes
6888
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
470 An set of axes. This object is a child of a figure object and may be a
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
471 parent of line, text, image, patch, or surface objects.
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
472
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
473 @item line
8071
b6e85fb238c1 doc fixes
John W. Eaton <jwe@octave.org>
parents: 8070
diff changeset
474 @cindex line graphics object
b6e85fb238c1 doc fixes
John W. Eaton <jwe@octave.org>
parents: 8070
diff changeset
475 @cindex graphics object, line
6888
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
476 A line in two or three dimensions.
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
477
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
478 @item text
8071
b6e85fb238c1 doc fixes
John W. Eaton <jwe@octave.org>
parents: 8070
diff changeset
479 @cindex text graphics object
b6e85fb238c1 doc fixes
John W. Eaton <jwe@octave.org>
parents: 8070
diff changeset
480 @cindex graphics object, text
6888
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
481 Text annotations.
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
482
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
483 @item image
8071
b6e85fb238c1 doc fixes
John W. Eaton <jwe@octave.org>
parents: 8070
diff changeset
484 @cindex image graphics object
b6e85fb238c1 doc fixes
John W. Eaton <jwe@octave.org>
parents: 8070
diff changeset
485 @cindex graphics object, image
6888
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
486 A bitmap image.
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
487
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
488 @item patch
8071
b6e85fb238c1 doc fixes
John W. Eaton <jwe@octave.org>
parents: 8070
diff changeset
489 @cindex patch graphics object
b6e85fb238c1 doc fixes
John W. Eaton <jwe@octave.org>
parents: 8070
diff changeset
490 @cindex graphics object, patch
6888
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
491 A filled polygon, currently limited to two dimensions.
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
492
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
493 @item surface
8071
b6e85fb238c1 doc fixes
John W. Eaton <jwe@octave.org>
parents: 8070
diff changeset
494 @cindex surface graphics object
b6e85fb238c1 doc fixes
John W. Eaton <jwe@octave.org>
parents: 8070
diff changeset
495 @cindex graphics object, surface
6888
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
496 A three-dimensional surface.
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
497 @end table
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
498
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
499 To determine whether an object is a graphics object index or a figure
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
500 index, use the functions @code{ishandle} and @code{isfigure}.
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
501
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
502 @DOCSTRING(ishandle)
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
503
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
504 @DOCSTRING(isfigure)
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
505
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
506 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
507 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
508 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
509 none exists.
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
510
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
511 @DOCSTRING(gcf)
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
512
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
513 @DOCSTRING(gca)
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
514
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
515 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
516 properties for graphics objects. For example,
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
517
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
518 @example
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
519 @group
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
520 get (0)
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
521 @result{} ans =
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
522 @{
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
523 type = root figure
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
524 currentfigure = [](0x0)
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
525 children = [](0x0)
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
526 visible = on
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
527 @}
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
528 @end group
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
529 @end example
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
530
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
531 @noindent
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
532 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
533 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
534 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
535 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
536 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
537 there is no current figure window.
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
538
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
539 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
540 property. For example,
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
541
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
542 @example
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
543 @group
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
544 get (gca (), "xlim")
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
545 @result{} [ 0 1 ]
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
546 @end group
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
547 @end example
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
548
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
549 @noindent
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
550 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
551 current figure.
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
552
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
553 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
554
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
555 @example
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
556 set (gca (), "xlim", [-10, 10]);
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
557 @end example
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
558
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
559 @noindent
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
560 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
561 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
562 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
563 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
564 example,
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
565
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
566 @example
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
567 set (gca ())
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
568 @end example
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
569
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
570 @noindent
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
571 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
572 objects.
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
573
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
574 @DOCSTRING(get)
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
575
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
576 @DOCSTRING(set)
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
577
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
578 @DOCSTRING(ancestor)
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
579
7984
bbaa5d7d0143 Some documentation updates
David Bateman <dbateman@free.fr>
parents: 7981
diff changeset
580 @DOCSTRING(allchild)
bbaa5d7d0143 Some documentation updates
David Bateman <dbateman@free.fr>
parents: 7981
diff changeset
581
6888
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
582 You can create axes, line, and patch objects directly using the
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
583 @code{axes}, @code{line}, and @code{patch} functions. These objects
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
584 become children of the current axes object.
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
585
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
586 @DOCSTRING(axes)
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
587
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
588 @DOCSTRING(line)
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
589
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
590 @DOCSTRING(patch)
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
591
7120
a2174fb073d4 [project @ 2007-11-07 21:26:43 by jwe]
jwe
parents: 7018
diff changeset
592 @DOCSTRING(surface)
a2174fb073d4 [project @ 2007-11-07 21:26:43 by jwe]
jwe
parents: 7018
diff changeset
593
6888
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
594 By default, Octave refreshes the plot window when a prompt is printed,
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
595 or when waiting for input. To force an update at other times, call the
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
596 @code{drawnow} function.
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
597
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
598 @DOCSTRING(drawnow)
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
599
8070
3b53b25e2550 Add data sources and line series
David Bateman <dbateman@free.fr>
parents: 8057
diff changeset
600 Only figures that are modified will be updated. The @code{refresh}
3b53b25e2550 Add data sources and line series
David Bateman <dbateman@free.fr>
parents: 8057
diff changeset
601 function can also be to force an update of the current figure, even if
3b53b25e2550 Add data sources and line series
David Bateman <dbateman@free.fr>
parents: 8057
diff changeset
602 it is nor modified.
3b53b25e2550 Add data sources and line series
David Bateman <dbateman@free.fr>
parents: 8057
diff changeset
603
3b53b25e2550 Add data sources and line series
David Bateman <dbateman@free.fr>
parents: 8057
diff changeset
604 @DOCSTRING(refresh)
3b53b25e2550 Add data sources and line series
David Bateman <dbateman@free.fr>
parents: 8057
diff changeset
605
6888
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
606 Normally, high-level plot functions like @code{plot} or @code{mesh} call
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
607 @code{newplot} to initialize the state of the current axes so that the
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
608 next plot is drawn in a blank window with default property settings. To
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
609 have two plots superimposed over one another, call the @code{hold}
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
610 function. For example,
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
611
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
612 @example
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
613 @group
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
614 hold ("on");
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
615 x = -10:0.1:10;
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
616 plot (x, sin (x));
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
617 plot (x, cos (x));
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
618 hold ("off");
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
619 @end group
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
620 @end example
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
621
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
622 @noindent
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
623 displays sine and cosine waves on the same axes. If the hold state is
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
624 off, consecutive plotting commands like this will only display the last
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
625 plot.
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
626
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
627 @DOCSTRING(newplot)
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
628
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
629 @DOCSTRING(hold)
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
630
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
631 @DOCSTRING(ishold)
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
632
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
633 To clear the current figure, call the @code{clf} function. To bring it
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
634 to the top of the window stack, call the @code{shg} function. To delete
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
635 a graphics object, call @code{delete} on its index. To close the
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
636 figure window, call the @code{close} function.
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
637
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
638 @DOCSTRING(clf)
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
639
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
640 @DOCSTRING(shg)
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
641
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
642 @DOCSTRING(delete)
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
643
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
644 @DOCSTRING(close)
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
645
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
646 @DOCSTRING(closereq)
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
647
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
648 @node Graphics Object Properties
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
649 @subsection Graphics Object Properties
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
650 @cindex graphics object properties
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
651
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
652 @menu
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
653 * Root Figure Properties::
6889
ebff56d6b0a8 [project @ 2007-09-12 18:32:12 by jwe]
jwe
parents: 6888
diff changeset
654 * Figure Properties::
6888
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
655 * Axes Properties::
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
656 * Line Properties::
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
657 * Text Properties::
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
658 * Image Properties::
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
659 * Patch Properties::
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
660 * Surface Properties::
8070
3b53b25e2550 Add data sources and line series
David Bateman <dbateman@free.fr>
parents: 8057
diff changeset
661 * Searching Properties::
6888
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
662 @end menu
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
663
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
664 @node Root Figure Properties
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
665 @subsubsection Root Figure Properties
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
666
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
667 @table @code
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
668 @item currentfigure
6889
ebff56d6b0a8 [project @ 2007-09-12 18:32:12 by jwe]
jwe
parents: 6888
diff changeset
669 Index to graphics object for the current figure.
ebff56d6b0a8 [project @ 2007-09-12 18:32:12 by jwe]
jwe
parents: 6888
diff changeset
670
ebff56d6b0a8 [project @ 2007-09-12 18:32:12 by jwe]
jwe
parents: 6888
diff changeset
671 @c FIXME -- does this work?
ebff56d6b0a8 [project @ 2007-09-12 18:32:12 by jwe]
jwe
parents: 6888
diff changeset
672 @c @item visible
ebff56d6b0a8 [project @ 2007-09-12 18:32:12 by jwe]
jwe
parents: 6888
diff changeset
673 @c Either @code{"on"} or @code{"off"} to toggle display of figures.
6888
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
674 @end table
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
675
6889
ebff56d6b0a8 [project @ 2007-09-12 18:32:12 by jwe]
jwe
parents: 6888
diff changeset
676 @node Figure Properties
ebff56d6b0a8 [project @ 2007-09-12 18:32:12 by jwe]
jwe
parents: 6888
diff changeset
677 @subsubsection Figure Properties
8071
b6e85fb238c1 doc fixes
John W. Eaton <jwe@octave.org>
parents: 8070
diff changeset
678 @cindex figure properties
6888
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
679
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
680 @table @code
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
681 @item nextplot
6889
ebff56d6b0a8 [project @ 2007-09-12 18:32:12 by jwe]
jwe
parents: 6888
diff changeset
682 May be one of
ebff56d6b0a8 [project @ 2007-09-12 18:32:12 by jwe]
jwe
parents: 6888
diff changeset
683 @table @code
ebff56d6b0a8 [project @ 2007-09-12 18:32:12 by jwe]
jwe
parents: 6888
diff changeset
684 @item "new"
ebff56d6b0a8 [project @ 2007-09-12 18:32:12 by jwe]
jwe
parents: 6888
diff changeset
685 @item "add"
ebff56d6b0a8 [project @ 2007-09-12 18:32:12 by jwe]
jwe
parents: 6888
diff changeset
686 @item "replace"
ebff56d6b0a8 [project @ 2007-09-12 18:32:12 by jwe]
jwe
parents: 6888
diff changeset
687 @item "replacechildren"
ebff56d6b0a8 [project @ 2007-09-12 18:32:12 by jwe]
jwe
parents: 6888
diff changeset
688 @end table
ebff56d6b0a8 [project @ 2007-09-12 18:32:12 by jwe]
jwe
parents: 6888
diff changeset
689
6888
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
690 @item closerequestfcn
6889
ebff56d6b0a8 [project @ 2007-09-12 18:32:12 by jwe]
jwe
parents: 6888
diff changeset
691 Handle of function to call when a figure is closed.
ebff56d6b0a8 [project @ 2007-09-12 18:32:12 by jwe]
jwe
parents: 6888
diff changeset
692
6888
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
693 @item currentaxes
6889
ebff56d6b0a8 [project @ 2007-09-12 18:32:12 by jwe]
jwe
parents: 6888
diff changeset
694 Index to graphics object of current axes.
ebff56d6b0a8 [project @ 2007-09-12 18:32:12 by jwe]
jwe
parents: 6888
diff changeset
695
6888
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
696 @item colormap
6889
ebff56d6b0a8 [project @ 2007-09-12 18:32:12 by jwe]
jwe
parents: 6888
diff changeset
697 An N-by-3 matrix containing the color map for the current axes.
ebff56d6b0a8 [project @ 2007-09-12 18:32:12 by jwe]
jwe
parents: 6888
diff changeset
698
6888
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
699 @item visible
6889
ebff56d6b0a8 [project @ 2007-09-12 18:32:12 by jwe]
jwe
parents: 6888
diff changeset
700 Either @code{"on"} or @code{"off"} to toggle display of the figure.
ebff56d6b0a8 [project @ 2007-09-12 18:32:12 by jwe]
jwe
parents: 6888
diff changeset
701
6888
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
702 @item paperorientation
6889
ebff56d6b0a8 [project @ 2007-09-12 18:32:12 by jwe]
jwe
parents: 6888
diff changeset
703 Indicates the orientation for printing. Either @code{"landscape"} or
ebff56d6b0a8 [project @ 2007-09-12 18:32:12 by jwe]
jwe
parents: 6888
diff changeset
704 @code{"portrait"}.
6888
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
705 @end table
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
706
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
707 @node Axes Properties
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
708 @subsubsection Axes Properties
8071
b6e85fb238c1 doc fixes
John W. Eaton <jwe@octave.org>
parents: 8070
diff changeset
709 @cindex axes properties
6888
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
710
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
711 @table @code
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
712 @item position
8071
b6e85fb238c1 doc fixes
John W. Eaton <jwe@octave.org>
parents: 8070
diff changeset
713 A vector specifying the position of the plot, excluding titles, axes and
b6e85fb238c1 doc fixes
John W. Eaton <jwe@octave.org>
parents: 8070
diff changeset
714 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
715 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
716 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
717 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
718 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
719 the @code{outerposition} property.
6889
ebff56d6b0a8 [project @ 2007-09-12 18:32:12 by jwe]
jwe
parents: 6888
diff changeset
720
6888
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
721 @item title
6889
ebff56d6b0a8 [project @ 2007-09-12 18:32:12 by jwe]
jwe
parents: 6888
diff changeset
722 Index of text object for the axes title.
ebff56d6b0a8 [project @ 2007-09-12 18:32:12 by jwe]
jwe
parents: 6888
diff changeset
723
6888
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
724 @item box
6889
ebff56d6b0a8 [project @ 2007-09-12 18:32:12 by jwe]
jwe
parents: 6888
diff changeset
725 Either @code{"on"} or @code{"off"} to toggle display of the box around
ebff56d6b0a8 [project @ 2007-09-12 18:32:12 by jwe]
jwe
parents: 6888
diff changeset
726 the axes.
ebff56d6b0a8 [project @ 2007-09-12 18:32:12 by jwe]
jwe
parents: 6888
diff changeset
727
6888
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
728 @item key
6889
ebff56d6b0a8 [project @ 2007-09-12 18:32:12 by jwe]
jwe
parents: 6888
diff changeset
729 Either @code{"on"} or @code{"off"} to toggle display of the legend.
ebff56d6b0a8 [project @ 2007-09-12 18:32:12 by jwe]
jwe
parents: 6888
diff changeset
730 Note that this property is not compatible with @sc{Matlab} and may be
ebff56d6b0a8 [project @ 2007-09-12 18:32:12 by jwe]
jwe
parents: 6888
diff changeset
731 removed in a future version of Octave.
ebff56d6b0a8 [project @ 2007-09-12 18:32:12 by jwe]
jwe
parents: 6888
diff changeset
732
6888
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
733 @item keybox
6889
ebff56d6b0a8 [project @ 2007-09-12 18:32:12 by jwe]
jwe
parents: 6888
diff changeset
734 Either @code{"on"} or @code{"off"} to toggle display of a box around the
ebff56d6b0a8 [project @ 2007-09-12 18:32:12 by jwe]
jwe
parents: 6888
diff changeset
735 legend. Note that this property is not compatible with @sc{Matlab} and
ebff56d6b0a8 [project @ 2007-09-12 18:32:12 by jwe]
jwe
parents: 6888
diff changeset
736 may be removed in a future version of Octave.
ebff56d6b0a8 [project @ 2007-09-12 18:32:12 by jwe]
jwe
parents: 6888
diff changeset
737
6888
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
738 @item keypos
6889
ebff56d6b0a8 [project @ 2007-09-12 18:32:12 by jwe]
jwe
parents: 6888
diff changeset
739 An integer from 1 to 4 specifying the position of the legend. 1
ebff56d6b0a8 [project @ 2007-09-12 18:32:12 by jwe]
jwe
parents: 6888
diff changeset
740 indicates upper right corner, 2 indicates upper left, 3 indicates lower
ebff56d6b0a8 [project @ 2007-09-12 18:32:12 by jwe]
jwe
parents: 6888
diff changeset
741 left, and 4 indicates lower right. Note that this property is not
ebff56d6b0a8 [project @ 2007-09-12 18:32:12 by jwe]
jwe
parents: 6888
diff changeset
742 compatible with @sc{Matlab} and may be removed in a future version of
ebff56d6b0a8 [project @ 2007-09-12 18:32:12 by jwe]
jwe
parents: 6888
diff changeset
743 Octave.
ebff56d6b0a8 [project @ 2007-09-12 18:32:12 by jwe]
jwe
parents: 6888
diff changeset
744
6888
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
745 @item dataaspectratio
6889
ebff56d6b0a8 [project @ 2007-09-12 18:32:12 by jwe]
jwe
parents: 6888
diff changeset
746 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
747 data displayed in the axes. Setting @code{dataaspectratio} to @samp{1,
ebff56d6b0a8 [project @ 2007-09-12 18:32:12 by jwe]
jwe
parents: 6888
diff changeset
748 2]} causes the length of one unit as displayed on the y axis to be the
ebff56d6b0a8 [project @ 2007-09-12 18:32:12 by jwe]
jwe
parents: 6888
diff changeset
749 same as the length of 2 units on the x axis. Setting
ebff56d6b0a8 [project @ 2007-09-12 18:32:12 by jwe]
jwe
parents: 6888
diff changeset
750 @code{dataaspectratio} also forces the @code{dataaspectratiomode}
ebff56d6b0a8 [project @ 2007-09-12 18:32:12 by jwe]
jwe
parents: 6888
diff changeset
751 property to be set to @code{"manual"}.
ebff56d6b0a8 [project @ 2007-09-12 18:32:12 by jwe]
jwe
parents: 6888
diff changeset
752
6888
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
753 @item dataaspectratiomode
6889
ebff56d6b0a8 [project @ 2007-09-12 18:32:12 by jwe]
jwe
parents: 6888
diff changeset
754 Either @code{"manual"} or @code{"auto"}.
ebff56d6b0a8 [project @ 2007-09-12 18:32:12 by jwe]
jwe
parents: 6888
diff changeset
755
6888
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
756 @item xlim
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
757 @itemx ylim
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
758 @itemx zlim
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
759 @itemx clim
6889
ebff56d6b0a8 [project @ 2007-09-12 18:32:12 by jwe]
jwe
parents: 6888
diff changeset
760 Two-element vectors defining the limits for the x, y, and z axes and the
ebff56d6b0a8 [project @ 2007-09-12 18:32:12 by jwe]
jwe
parents: 6888
diff changeset
761 Setting one of these properties also forces the corresponding mode
ebff56d6b0a8 [project @ 2007-09-12 18:32:12 by jwe]
jwe
parents: 6888
diff changeset
762 property to be set to @code{"manual"}.
ebff56d6b0a8 [project @ 2007-09-12 18:32:12 by jwe]
jwe
parents: 6888
diff changeset
763
6888
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
764 @item xlimmode
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
765 @itemx ylimmode
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
766 @itemx zlimmode
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
767 @itemx climmode
6889
ebff56d6b0a8 [project @ 2007-09-12 18:32:12 by jwe]
jwe
parents: 6888
diff changeset
768 Either @code{"manual"} or @code{"auto"}.
ebff56d6b0a8 [project @ 2007-09-12 18:32:12 by jwe]
jwe
parents: 6888
diff changeset
769
6888
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
770 @item xlabel
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
771 @itemx ylabel
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
772 @itemx zlabel
6889
ebff56d6b0a8 [project @ 2007-09-12 18:32:12 by jwe]
jwe
parents: 6888
diff changeset
773 Indices to text objects for the axes labels.
ebff56d6b0a8 [project @ 2007-09-12 18:32:12 by jwe]
jwe
parents: 6888
diff changeset
774
6888
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
775 @item xgrid
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
776 @itemx ygrid
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
777 @itemx zgrid
6889
ebff56d6b0a8 [project @ 2007-09-12 18:32:12 by jwe]
jwe
parents: 6888
diff changeset
778 Either @code{"on"} or @code{"off"} to toggle display of grid lines.
ebff56d6b0a8 [project @ 2007-09-12 18:32:12 by jwe]
jwe
parents: 6888
diff changeset
779
6888
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
780 @item xminorgrid
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
781 @itemx yminorgrid
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
782 @itemx zminorgrid
6889
ebff56d6b0a8 [project @ 2007-09-12 18:32:12 by jwe]
jwe
parents: 6888
diff changeset
783 Either @code{"on"} or @code{"off"} to toggle display of minor grid lines.
ebff56d6b0a8 [project @ 2007-09-12 18:32:12 by jwe]
jwe
parents: 6888
diff changeset
784
6888
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
785 @item xtick
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
786 @itemx ytick
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
787 @itemx ztick
6889
ebff56d6b0a8 [project @ 2007-09-12 18:32:12 by jwe]
jwe
parents: 6888
diff changeset
788 Setting one of these properties also forces the corresponding mode
ebff56d6b0a8 [project @ 2007-09-12 18:32:12 by jwe]
jwe
parents: 6888
diff changeset
789 property to be set to @code{"manual"}.
ebff56d6b0a8 [project @ 2007-09-12 18:32:12 by jwe]
jwe
parents: 6888
diff changeset
790
6888
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
791 @item xtickmode
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
792 @itemx ytickmode
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
793 @itemx ztickmode
6889
ebff56d6b0a8 [project @ 2007-09-12 18:32:12 by jwe]
jwe
parents: 6888
diff changeset
794 Either @code{"manual"} or @code{"auto"}.
ebff56d6b0a8 [project @ 2007-09-12 18:32:12 by jwe]
jwe
parents: 6888
diff changeset
795
6888
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
796 @item xticklabel
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
797 @itemx yticklabel
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
798 @itemx zticklabel
6889
ebff56d6b0a8 [project @ 2007-09-12 18:32:12 by jwe]
jwe
parents: 6888
diff changeset
799 Setting one of these properties also forces the corresponding mode
ebff56d6b0a8 [project @ 2007-09-12 18:32:12 by jwe]
jwe
parents: 6888
diff changeset
800 property to be set to @code{"manual"}.
ebff56d6b0a8 [project @ 2007-09-12 18:32:12 by jwe]
jwe
parents: 6888
diff changeset
801
6888
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
802 @item xticklabelmode
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
803 @itemx yticklabelmode
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
804 @itemx zticklabelmode
6889
ebff56d6b0a8 [project @ 2007-09-12 18:32:12 by jwe]
jwe
parents: 6888
diff changeset
805 Either @code{"manual"} or @code{"auto"}.
ebff56d6b0a8 [project @ 2007-09-12 18:32:12 by jwe]
jwe
parents: 6888
diff changeset
806
6888
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
807 @item xscale
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
808 @itemx yscale
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
809 @itemx zscale
6889
ebff56d6b0a8 [project @ 2007-09-12 18:32:12 by jwe]
jwe
parents: 6888
diff changeset
810 Either @code{"linear"} or @code{"log"}.
ebff56d6b0a8 [project @ 2007-09-12 18:32:12 by jwe]
jwe
parents: 6888
diff changeset
811
6888
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
812 @item xdir
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
813 @itemx ydir
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
814 @itemx zdir
6889
ebff56d6b0a8 [project @ 2007-09-12 18:32:12 by jwe]
jwe
parents: 6888
diff changeset
815 Either @code{"forward"} or @code{"reverse"}.
ebff56d6b0a8 [project @ 2007-09-12 18:32:12 by jwe]
jwe
parents: 6888
diff changeset
816
6888
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
817 @item xaxislocation
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
818 @itemx yaxislocation
6889
ebff56d6b0a8 [project @ 2007-09-12 18:32:12 by jwe]
jwe
parents: 6888
diff changeset
819 Either @code{"top"} or @code{"bottom"} for the x axis and @code{"left"}
ebff56d6b0a8 [project @ 2007-09-12 18:32:12 by jwe]
jwe
parents: 6888
diff changeset
820 or @code{"right"} for the y axis.
ebff56d6b0a8 [project @ 2007-09-12 18:32:12 by jwe]
jwe
parents: 6888
diff changeset
821
6888
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
822 @item view
6889
ebff56d6b0a8 [project @ 2007-09-12 18:32:12 by jwe]
jwe
parents: 6888
diff changeset
823 A three element vector specifying the view point for three-dimensional plots.
ebff56d6b0a8 [project @ 2007-09-12 18:32:12 by jwe]
jwe
parents: 6888
diff changeset
824
6888
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
825 @item visible
6889
ebff56d6b0a8 [project @ 2007-09-12 18:32:12 by jwe]
jwe
parents: 6888
diff changeset
826 Either @code{"on"} or @code{"off"} to toggle display of the axes.
ebff56d6b0a8 [project @ 2007-09-12 18:32:12 by jwe]
jwe
parents: 6888
diff changeset
827
6888
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
828 @item nextplot
6889
ebff56d6b0a8 [project @ 2007-09-12 18:32:12 by jwe]
jwe
parents: 6888
diff changeset
829 May be one of
ebff56d6b0a8 [project @ 2007-09-12 18:32:12 by jwe]
jwe
parents: 6888
diff changeset
830 @table @code
ebff56d6b0a8 [project @ 2007-09-12 18:32:12 by jwe]
jwe
parents: 6888
diff changeset
831 @item "new"
ebff56d6b0a8 [project @ 2007-09-12 18:32:12 by jwe]
jwe
parents: 6888
diff changeset
832 @item "add"
ebff56d6b0a8 [project @ 2007-09-12 18:32:12 by jwe]
jwe
parents: 6888
diff changeset
833 @item "replace"
ebff56d6b0a8 [project @ 2007-09-12 18:32:12 by jwe]
jwe
parents: 6888
diff changeset
834 @item "replacechildren"
ebff56d6b0a8 [project @ 2007-09-12 18:32:12 by jwe]
jwe
parents: 6888
diff changeset
835 @end table
ebff56d6b0a8 [project @ 2007-09-12 18:32:12 by jwe]
jwe
parents: 6888
diff changeset
836
6888
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
837 @item outerposition
8071
b6e85fb238c1 doc fixes
John W. Eaton <jwe@octave.org>
parents: 8070
diff changeset
838 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
839 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
840 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
841 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
842 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
843 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
844 the @code{position} property.
6888
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
845 @end table
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
846
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
847 @node Line Properties
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
848 @subsubsection Line Properties
8071
b6e85fb238c1 doc fixes
John W. Eaton <jwe@octave.org>
parents: 8070
diff changeset
849 @cindex line properties
6888
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
850
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
851 @table @code
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
852 @itemx xdata
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
853 @itemx ydata
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
854 @itemx zdata
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
855 @itemx ldata
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
856 @itemx udata
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
857 @itemx xldata
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
858 @itemx xudata
6889
ebff56d6b0a8 [project @ 2007-09-12 18:32:12 by jwe]
jwe
parents: 6888
diff changeset
859 The data to be plotted. The @code{ldata} and @code{udata} elements are
ebff56d6b0a8 [project @ 2007-09-12 18:32:12 by jwe]
jwe
parents: 6888
diff changeset
860 for errobars in the y direction, and the @code{xldata} and @code{xudata}
ebff56d6b0a8 [project @ 2007-09-12 18:32:12 by jwe]
jwe
parents: 6888
diff changeset
861 elements are for errorbars in the x direction.
ebff56d6b0a8 [project @ 2007-09-12 18:32:12 by jwe]
jwe
parents: 6888
diff changeset
862
6888
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
863 @item color
6889
ebff56d6b0a8 [project @ 2007-09-12 18:32:12 by jwe]
jwe
parents: 6888
diff changeset
864 The RGB color of the line, or a color name. @xref{Colors}.
ebff56d6b0a8 [project @ 2007-09-12 18:32:12 by jwe]
jwe
parents: 6888
diff changeset
865
6888
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
866 @item linestyle
6889
ebff56d6b0a8 [project @ 2007-09-12 18:32:12 by jwe]
jwe
parents: 6888
diff changeset
867 @itemx linewidth
ebff56d6b0a8 [project @ 2007-09-12 18:32:12 by jwe]
jwe
parents: 6888
diff changeset
868 @xref{Line Styles}.
ebff56d6b0a8 [project @ 2007-09-12 18:32:12 by jwe]
jwe
parents: 6888
diff changeset
869
6888
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
870 @item marker
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
871 @item markeredgecolor
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
872 @item markerfacecolor
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
873 @item markersize
6889
ebff56d6b0a8 [project @ 2007-09-12 18:32:12 by jwe]
jwe
parents: 6888
diff changeset
874 @xref{Marker Styles}.
ebff56d6b0a8 [project @ 2007-09-12 18:32:12 by jwe]
jwe
parents: 6888
diff changeset
875
6888
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
876 @item keylabel
6889
ebff56d6b0a8 [project @ 2007-09-12 18:32:12 by jwe]
jwe
parents: 6888
diff changeset
877 The text of the legend entry corresponding to this line. Note that this
ebff56d6b0a8 [project @ 2007-09-12 18:32:12 by jwe]
jwe
parents: 6888
diff changeset
878 property is not compatible with @sc{Matlab} and may be removed in a
ebff56d6b0a8 [project @ 2007-09-12 18:32:12 by jwe]
jwe
parents: 6888
diff changeset
879 future version of Octave.
6888
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
880 @end table
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
881
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
882 @node Text Properties
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
883 @subsubsection Text Properties
8071
b6e85fb238c1 doc fixes
John W. Eaton <jwe@octave.org>
parents: 8070
diff changeset
884 @cindex text properties
6888
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
885
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
886 @table @code
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
887 @item string
6889
ebff56d6b0a8 [project @ 2007-09-12 18:32:12 by jwe]
jwe
parents: 6888
diff changeset
888 The character string contained by the text object.
ebff56d6b0a8 [project @ 2007-09-12 18:32:12 by jwe]
jwe
parents: 6888
diff changeset
889
6888
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
890 @item units
6889
ebff56d6b0a8 [project @ 2007-09-12 18:32:12 by jwe]
jwe
parents: 6888
diff changeset
891 May be @code{"normalized"} or @code{"graph"}.
ebff56d6b0a8 [project @ 2007-09-12 18:32:12 by jwe]
jwe
parents: 6888
diff changeset
892
6888
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
893 @item position
6889
ebff56d6b0a8 [project @ 2007-09-12 18:32:12 by jwe]
jwe
parents: 6888
diff changeset
894 The coordinates of the text object.
ebff56d6b0a8 [project @ 2007-09-12 18:32:12 by jwe]
jwe
parents: 6888
diff changeset
895
6888
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
896 @item rotation
6889
ebff56d6b0a8 [project @ 2007-09-12 18:32:12 by jwe]
jwe
parents: 6888
diff changeset
897 The angle of rotation for the displayed text, measured in degrees.
ebff56d6b0a8 [project @ 2007-09-12 18:32:12 by jwe]
jwe
parents: 6888
diff changeset
898
6888
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
899 @item horizontalalignment
6889
ebff56d6b0a8 [project @ 2007-09-12 18:32:12 by jwe]
jwe
parents: 6888
diff changeset
900 May be @code{"left"}, @code{"center"}, or @code{"right"}.
ebff56d6b0a8 [project @ 2007-09-12 18:32:12 by jwe]
jwe
parents: 6888
diff changeset
901
6888
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
902 @item color
6889
ebff56d6b0a8 [project @ 2007-09-12 18:32:12 by jwe]
jwe
parents: 6888
diff changeset
903 The color of the text. @xref{Colors}.
7189
e8d953d03f6a [project @ 2007-11-26 20:42:09 by dbateman]
dbateman
parents: 7153
diff changeset
904
e8d953d03f6a [project @ 2007-11-26 20:42:09 by dbateman]
dbateman
parents: 7153
diff changeset
905 @item fontname
e8d953d03f6a [project @ 2007-11-26 20:42:09 by dbateman]
dbateman
parents: 7153
diff changeset
906 The font used for the text.
e8d953d03f6a [project @ 2007-11-26 20:42:09 by dbateman]
dbateman
parents: 7153
diff changeset
907
e8d953d03f6a [project @ 2007-11-26 20:42:09 by dbateman]
dbateman
parents: 7153
diff changeset
908 @item fontsize
e8d953d03f6a [project @ 2007-11-26 20:42:09 by dbateman]
dbateman
parents: 7153
diff changeset
909 The size of the font, in points to use.
e8d953d03f6a [project @ 2007-11-26 20:42:09 by dbateman]
dbateman
parents: 7153
diff changeset
910
e8d953d03f6a [project @ 2007-11-26 20:42:09 by dbateman]
dbateman
parents: 7153
diff changeset
911 @item fontangle
e8d953d03f6a [project @ 2007-11-26 20:42:09 by dbateman]
dbateman
parents: 7153
diff changeset
912 Flag whether the font is italic or normal. Valid values are 'normal',
e8d953d03f6a [project @ 2007-11-26 20:42:09 by dbateman]
dbateman
parents: 7153
diff changeset
913 'italic' and 'oblique'.
e8d953d03f6a [project @ 2007-11-26 20:42:09 by dbateman]
dbateman
parents: 7153
diff changeset
914
e8d953d03f6a [project @ 2007-11-26 20:42:09 by dbateman]
dbateman
parents: 7153
diff changeset
915 @item fontweight
e8d953d03f6a [project @ 2007-11-26 20:42:09 by dbateman]
dbateman
parents: 7153
diff changeset
916 Flag whether the font is bold, etc. Valid values are 'normal', 'bold',
e8d953d03f6a [project @ 2007-11-26 20:42:09 by dbateman]
dbateman
parents: 7153
diff changeset
917 'demi' or 'light'.
e8d953d03f6a [project @ 2007-11-26 20:42:09 by dbateman]
dbateman
parents: 7153
diff changeset
918
e8d953d03f6a [project @ 2007-11-26 20:42:09 by dbateman]
dbateman
parents: 7153
diff changeset
919 @item interpreter
e8d953d03f6a [project @ 2007-11-26 20:42:09 by dbateman]
dbateman
parents: 7153
diff changeset
920 Determines how the text is rendered. Valid values are 'none', 'tex' or
e8d953d03f6a [project @ 2007-11-26 20:42:09 by dbateman]
dbateman
parents: 7153
diff changeset
921 'latex'.
6888
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
922 @end table
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
923
7189
e8d953d03f6a [project @ 2007-11-26 20:42:09 by dbateman]
dbateman
parents: 7153
diff changeset
924 All text objects, including titles, labels, legends, and text, include
e8d953d03f6a [project @ 2007-11-26 20:42:09 by dbateman]
dbateman
parents: 7153
diff changeset
925 the property 'interpreter', this property determines the manner in which
e8d953d03f6a [project @ 2007-11-26 20:42:09 by dbateman]
dbateman
parents: 7153
diff changeset
926 special control sequences in the text are rendered. If the interpreter
e8d953d03f6a [project @ 2007-11-26 20:42:09 by dbateman]
dbateman
parents: 7153
diff changeset
927 is set to 'none', then no rendering occurs. At this point the 'latex'
e8d953d03f6a [project @ 2007-11-26 20:42:09 by dbateman]
dbateman
parents: 7153
diff changeset
928 option is not implemented and so the 'latex' interpreter also does not
e8d953d03f6a [project @ 2007-11-26 20:42:09 by dbateman]
dbateman
parents: 7153
diff changeset
929 interpret the text.
e8d953d03f6a [project @ 2007-11-26 20:42:09 by dbateman]
dbateman
parents: 7153
diff changeset
930
e8d953d03f6a [project @ 2007-11-26 20:42:09 by dbateman]
dbateman
parents: 7153
diff changeset
931 The 'tex' option implements a subset of @sc{TeX} functionality in the
e8d953d03f6a [project @ 2007-11-26 20:42:09 by dbateman]
dbateman
parents: 7153
diff changeset
932 rendering of the text. This allows the insertion of special characters
e8d953d03f6a [project @ 2007-11-26 20:42:09 by dbateman]
dbateman
parents: 7153
diff changeset
933 such as Greek or mathematical symbols within the text. The special
e8d953d03f6a [project @ 2007-11-26 20:42:09 by dbateman]
dbateman
parents: 7153
diff changeset
934 characters are also inserted with a code starting with the back-slash
e8d953d03f6a [project @ 2007-11-26 20:42:09 by dbateman]
dbateman
parents: 7153
diff changeset
935 (\) character, as in the table @ref{tab:extended}.
e8d953d03f6a [project @ 2007-11-26 20:42:09 by dbateman]
dbateman
parents: 7153
diff changeset
936
e8d953d03f6a [project @ 2007-11-26 20:42:09 by dbateman]
dbateman
parents: 7153
diff changeset
937 In addition, the formating of the text can be changed within the string
e8d953d03f6a [project @ 2007-11-26 20:42:09 by dbateman]
dbateman
parents: 7153
diff changeset
938 with the codes
e8d953d03f6a [project @ 2007-11-26 20:42:09 by dbateman]
dbateman
parents: 7153
diff changeset
939
e8d953d03f6a [project @ 2007-11-26 20:42:09 by dbateman]
dbateman
parents: 7153
diff changeset
940 @multitable @columnfractions .2 .2 .6 .2
e8d953d03f6a [project @ 2007-11-26 20:42:09 by dbateman]
dbateman
parents: 7153
diff changeset
941 @item @tab \bf @tab Bold font @tab
e8d953d03f6a [project @ 2007-11-26 20:42:09 by dbateman]
dbateman
parents: 7153
diff changeset
942 @item @tab \it @tab Italic font @tab
e8d953d03f6a [project @ 2007-11-26 20:42:09 by dbateman]
dbateman
parents: 7153
diff changeset
943 @item @tab \sl @tab Oblique Font @tab
e8d953d03f6a [project @ 2007-11-26 20:42:09 by dbateman]
dbateman
parents: 7153
diff changeset
944 @item @tab \rm @tab Normal font @tab
e8d953d03f6a [project @ 2007-11-26 20:42:09 by dbateman]
dbateman
parents: 7153
diff changeset
945 @end multitable
e8d953d03f6a [project @ 2007-11-26 20:42:09 by dbateman]
dbateman
parents: 7153
diff changeset
946
e8d953d03f6a [project @ 2007-11-26 20:42:09 by dbateman]
dbateman
parents: 7153
diff changeset
947 These are be used in conjunction with the @{ and @} characters to limit
e8d953d03f6a [project @ 2007-11-26 20:42:09 by dbateman]
dbateman
parents: 7153
diff changeset
948 the change in the font to part of the string. For example
e8d953d03f6a [project @ 2007-11-26 20:42:09 by dbateman]
dbateman
parents: 7153
diff changeset
949
e8d953d03f6a [project @ 2007-11-26 20:42:09 by dbateman]
dbateman
parents: 7153
diff changeset
950 @example
e8d953d03f6a [project @ 2007-11-26 20:42:09 by dbateman]
dbateman
parents: 7153
diff changeset
951 xlabel ('@{\bf H@} = a @{\bf V@}')
e8d953d03f6a [project @ 2007-11-26 20:42:09 by dbateman]
dbateman
parents: 7153
diff changeset
952 @end example
e8d953d03f6a [project @ 2007-11-26 20:42:09 by dbateman]
dbateman
parents: 7153
diff changeset
953
e8d953d03f6a [project @ 2007-11-26 20:42:09 by dbateman]
dbateman
parents: 7153
diff changeset
954 where the character 'a' will not appear in a bold font. Note that to
e8d953d03f6a [project @ 2007-11-26 20:42:09 by dbateman]
dbateman
parents: 7153
diff changeset
955 avoid having Octave interpret the backslash characters in the strings,
e8d953d03f6a [project @ 2007-11-26 20:42:09 by dbateman]
dbateman
parents: 7153
diff changeset
956 the strings should be in single quotes.
e8d953d03f6a [project @ 2007-11-26 20:42:09 by dbateman]
dbateman
parents: 7153
diff changeset
957
e8d953d03f6a [project @ 2007-11-26 20:42:09 by dbateman]
dbateman
parents: 7153
diff changeset
958 It is also possible to change the fontname and size within the text
e8d953d03f6a [project @ 2007-11-26 20:42:09 by dbateman]
dbateman
parents: 7153
diff changeset
959
e8d953d03f6a [project @ 2007-11-26 20:42:09 by dbateman]
dbateman
parents: 7153
diff changeset
960 @multitable @columnfractions .1 .4 .6 .1
e8d953d03f6a [project @ 2007-11-26 20:42:09 by dbateman]
dbateman
parents: 7153
diff changeset
961 @item @tab \fontname@{@var{fontname}@} @tab Specify the font to use @tab
e8d953d03f6a [project @ 2007-11-26 20:42:09 by dbateman]
dbateman
parents: 7153
diff changeset
962 @item @tab \fontsize@{@var{size}@} @tab Specify the size of the font to
e8d953d03f6a [project @ 2007-11-26 20:42:09 by dbateman]
dbateman
parents: 7153
diff changeset
963 use @tab
e8d953d03f6a [project @ 2007-11-26 20:42:09 by dbateman]
dbateman
parents: 7153
diff changeset
964 @end multitable
e8d953d03f6a [project @ 2007-11-26 20:42:09 by dbateman]
dbateman
parents: 7153
diff changeset
965
e8d953d03f6a [project @ 2007-11-26 20:42:09 by dbateman]
dbateman
parents: 7153
diff changeset
966 Finally, the superscript and subscripting can be controlled with the '^'
e8d953d03f6a [project @ 2007-11-26 20:42:09 by dbateman]
dbateman
parents: 7153
diff changeset
967 and '_' characters. If the '^' or '_' is followed by a @{ character,
e8d953d03f6a [project @ 2007-11-26 20:42:09 by dbateman]
dbateman
parents: 7153
diff changeset
968 then all of the block surrounded by the @{ @} pair is super- or
e8d953d03f6a [project @ 2007-11-26 20:42:09 by dbateman]
dbateman
parents: 7153
diff changeset
969 sub-scripted. Without the @{ @} pair, only the character immediately
e8d953d03f6a [project @ 2007-11-26 20:42:09 by dbateman]
dbateman
parents: 7153
diff changeset
970 following the '^' or '_' is super- or sub-scripted.
e8d953d03f6a [project @ 2007-11-26 20:42:09 by dbateman]
dbateman
parents: 7153
diff changeset
971
e8d953d03f6a [project @ 2007-11-26 20:42:09 by dbateman]
dbateman
parents: 7153
diff changeset
972 @float Table,tab:extended
e8d953d03f6a [project @ 2007-11-26 20:42:09 by dbateman]
dbateman
parents: 7153
diff changeset
973 @iftex
e8d953d03f6a [project @ 2007-11-26 20:42:09 by dbateman]
dbateman
parents: 7153
diff changeset
974 @tex
e8d953d03f6a [project @ 2007-11-26 20:42:09 by dbateman]
dbateman
parents: 7153
diff changeset
975 \vskip 6pt
e8d953d03f6a [project @ 2007-11-26 20:42:09 by dbateman]
dbateman
parents: 7153
diff changeset
976 {\hbox to \hsize {\hfill\vbox{\offinterlineskip \tabskip=0pt
e8d953d03f6a [project @ 2007-11-26 20:42:09 by dbateman]
dbateman
parents: 7153
diff changeset
977 \halign{
e8d953d03f6a [project @ 2007-11-26 20:42:09 by dbateman]
dbateman
parents: 7153
diff changeset
978 \vrule height2.0ex depth1.ex width 0.6pt #\tabskip=0.3em &
e8d953d03f6a [project @ 2007-11-26 20:42:09 by dbateman]
dbateman
parents: 7153
diff changeset
979 # \hfil & \vrule # & # \hfil & # \vrule &
e8d953d03f6a [project @ 2007-11-26 20:42:09 by dbateman]
dbateman
parents: 7153
diff changeset
980 # \hfil & \vrule # & # \hfil & # \vrule &
e8d953d03f6a [project @ 2007-11-26 20:42:09 by dbateman]
dbateman
parents: 7153
diff changeset
981 # \hfil & \vrule # & # \hfil & # \vrule
e8d953d03f6a [project @ 2007-11-26 20:42:09 by dbateman]
dbateman
parents: 7153
diff changeset
982 width 0.6pt \tabskip=0pt\cr
e8d953d03f6a [project @ 2007-11-26 20:42:09 by dbateman]
dbateman
parents: 7153
diff changeset
983 \noalign{\hrule height 0.6pt}
e8d953d03f6a [project @ 2007-11-26 20:42:09 by dbateman]
dbateman
parents: 7153
diff changeset
984 & Code && Sym && Code && Sym && Code && Sym &\cr
e8d953d03f6a [project @ 2007-11-26 20:42:09 by dbateman]
dbateman
parents: 7153
diff changeset
985 \noalign{\hrule}
7608
49810341db91 Correct typos in __go_draw_axes__.m and update Manual
godfrey@qss.Stanford.EDU
parents: 7189
diff changeset
986 & $\backslash$forall && $\forall$
49810341db91 Correct typos in __go_draw_axes__.m and update Manual
godfrey@qss.Stanford.EDU
parents: 7189
diff changeset
987 && $\backslash$exists && $\exists$
49810341db91 Correct typos in __go_draw_axes__.m and update Manual
godfrey@qss.Stanford.EDU
parents: 7189
diff changeset
988 && $\backslash$ni && $\ni$ &\cr
49810341db91 Correct typos in __go_draw_axes__.m and update Manual
godfrey@qss.Stanford.EDU
parents: 7189
diff changeset
989 & $\backslash$cong && $\cong$
49810341db91 Correct typos in __go_draw_axes__.m and update Manual
godfrey@qss.Stanford.EDU
parents: 7189
diff changeset
990 && $\backslash$Delta && $\Delta$
49810341db91 Correct typos in __go_draw_axes__.m and update Manual
godfrey@qss.Stanford.EDU
parents: 7189
diff changeset
991 && $\backslash$Phi && $\Phi$ &\cr
49810341db91 Correct typos in __go_draw_axes__.m and update Manual
godfrey@qss.Stanford.EDU
parents: 7189
diff changeset
992 & $\backslash$Gamma && $\Gamma$
49810341db91 Correct typos in __go_draw_axes__.m and update Manual
godfrey@qss.Stanford.EDU
parents: 7189
diff changeset
993 && $\backslash$vartheta && $\vartheta$
49810341db91 Correct typos in __go_draw_axes__.m and update Manual
godfrey@qss.Stanford.EDU
parents: 7189
diff changeset
994 && $\backslash$Lambda && $\Lambda$ &\cr
49810341db91 Correct typos in __go_draw_axes__.m and update Manual
godfrey@qss.Stanford.EDU
parents: 7189
diff changeset
995 & $\backslash$Pi && $\Pi$
49810341db91 Correct typos in __go_draw_axes__.m and update Manual
godfrey@qss.Stanford.EDU
parents: 7189
diff changeset
996 && $\backslash$Theta && $\Theta$
49810341db91 Correct typos in __go_draw_axes__.m and update Manual
godfrey@qss.Stanford.EDU
parents: 7189
diff changeset
997 && $\backslash$Sigma && $\Sigma$ &\cr
49810341db91 Correct typos in __go_draw_axes__.m and update Manual
godfrey@qss.Stanford.EDU
parents: 7189
diff changeset
998 & $\backslash$varsigma && $\varsigma$
49810341db91 Correct typos in __go_draw_axes__.m and update Manual
godfrey@qss.Stanford.EDU
parents: 7189
diff changeset
999 && $\backslash$Omega && $\Omega$
49810341db91 Correct typos in __go_draw_axes__.m and update Manual
godfrey@qss.Stanford.EDU
parents: 7189
diff changeset
1000 && $\backslash$Xi && $\Xi$ &\cr
49810341db91 Correct typos in __go_draw_axes__.m and update Manual
godfrey@qss.Stanford.EDU
parents: 7189
diff changeset
1001 & $\backslash$Psi && $\Psi$
49810341db91 Correct typos in __go_draw_axes__.m and update Manual
godfrey@qss.Stanford.EDU
parents: 7189
diff changeset
1002 && $\backslash$perp && $\perp$
49810341db91 Correct typos in __go_draw_axes__.m and update Manual
godfrey@qss.Stanford.EDU
parents: 7189
diff changeset
1003 && $\backslash$alpha && $\alpha$ &\cr
49810341db91 Correct typos in __go_draw_axes__.m and update Manual
godfrey@qss.Stanford.EDU
parents: 7189
diff changeset
1004 & $\backslash$beta && $\beta$
49810341db91 Correct typos in __go_draw_axes__.m and update Manual
godfrey@qss.Stanford.EDU
parents: 7189
diff changeset
1005 && $\backslash$chi && $\chi$
49810341db91 Correct typos in __go_draw_axes__.m and update Manual
godfrey@qss.Stanford.EDU
parents: 7189
diff changeset
1006 && $\backslash$delta && $\delta$ &\cr
49810341db91 Correct typos in __go_draw_axes__.m and update Manual
godfrey@qss.Stanford.EDU
parents: 7189
diff changeset
1007 & $\backslash$epsilon && $\epsilon$
49810341db91 Correct typos in __go_draw_axes__.m and update Manual
godfrey@qss.Stanford.EDU
parents: 7189
diff changeset
1008 && $\backslash$phi && $\phi$
49810341db91 Correct typos in __go_draw_axes__.m and update Manual
godfrey@qss.Stanford.EDU
parents: 7189
diff changeset
1009 && $\backslash$gamma && $\gamma$ &\cr
49810341db91 Correct typos in __go_draw_axes__.m and update Manual
godfrey@qss.Stanford.EDU
parents: 7189
diff changeset
1010 & $\backslash$eta && $\eta$
49810341db91 Correct typos in __go_draw_axes__.m and update Manual
godfrey@qss.Stanford.EDU
parents: 7189
diff changeset
1011 && $\backslash$iota && $\iota$
49810341db91 Correct typos in __go_draw_axes__.m and update Manual
godfrey@qss.Stanford.EDU
parents: 7189
diff changeset
1012 && $\backslash$varphi && $\varphi$ &\cr
49810341db91 Correct typos in __go_draw_axes__.m and update Manual
godfrey@qss.Stanford.EDU
parents: 7189
diff changeset
1013 & $\backslash$kappa && $\kappa$
49810341db91 Correct typos in __go_draw_axes__.m and update Manual
godfrey@qss.Stanford.EDU
parents: 7189
diff changeset
1014 && $\backslash$lambda && $\lambda$
49810341db91 Correct typos in __go_draw_axes__.m and update Manual
godfrey@qss.Stanford.EDU
parents: 7189
diff changeset
1015 && $\backslash$mu && $\mu$ &\cr
49810341db91 Correct typos in __go_draw_axes__.m and update Manual
godfrey@qss.Stanford.EDU
parents: 7189
diff changeset
1016 & $\backslash$nu && $\nu$
49810341db91 Correct typos in __go_draw_axes__.m and update Manual
godfrey@qss.Stanford.EDU
parents: 7189
diff changeset
1017 && $\backslash$o && $\o$
49810341db91 Correct typos in __go_draw_axes__.m and update Manual
godfrey@qss.Stanford.EDU
parents: 7189
diff changeset
1018 && $\backslash$pi && $\pi$ &\cr
49810341db91 Correct typos in __go_draw_axes__.m and update Manual
godfrey@qss.Stanford.EDU
parents: 7189
diff changeset
1019 & $\backslash$theta && $\theta$
49810341db91 Correct typos in __go_draw_axes__.m and update Manual
godfrey@qss.Stanford.EDU
parents: 7189
diff changeset
1020 && $\backslash$rho && $\rho$
49810341db91 Correct typos in __go_draw_axes__.m and update Manual
godfrey@qss.Stanford.EDU
parents: 7189
diff changeset
1021 && $\backslash$sigma && $\sigma$ &\cr
49810341db91 Correct typos in __go_draw_axes__.m and update Manual
godfrey@qss.Stanford.EDU
parents: 7189
diff changeset
1022 & $\backslash$tau && $\tau$
49810341db91 Correct typos in __go_draw_axes__.m and update Manual
godfrey@qss.Stanford.EDU
parents: 7189
diff changeset
1023 && $\backslash$upsilon && $\upsilon$
49810341db91 Correct typos in __go_draw_axes__.m and update Manual
godfrey@qss.Stanford.EDU
parents: 7189
diff changeset
1024 && $\backslash$varpi && $\varpi$ &\cr
49810341db91 Correct typos in __go_draw_axes__.m and update Manual
godfrey@qss.Stanford.EDU
parents: 7189
diff changeset
1025 & $\backslash$omega && $\omega$
49810341db91 Correct typos in __go_draw_axes__.m and update Manual
godfrey@qss.Stanford.EDU
parents: 7189
diff changeset
1026 && $\backslash$xi && $\xi$
49810341db91 Correct typos in __go_draw_axes__.m and update Manual
godfrey@qss.Stanford.EDU
parents: 7189
diff changeset
1027 && $\backslash$psi && $\psi$ &\cr
49810341db91 Correct typos in __go_draw_axes__.m and update Manual
godfrey@qss.Stanford.EDU
parents: 7189
diff changeset
1028 & $\backslash$zeta && $\zeta$
49810341db91 Correct typos in __go_draw_axes__.m and update Manual
godfrey@qss.Stanford.EDU
parents: 7189
diff changeset
1029 && $\backslash$sim && $\sim$
49810341db91 Correct typos in __go_draw_axes__.m and update Manual
godfrey@qss.Stanford.EDU
parents: 7189
diff changeset
1030 && $\backslash$Upsilon && $\Upsilon$ &\cr
49810341db91 Correct typos in __go_draw_axes__.m and update Manual
godfrey@qss.Stanford.EDU
parents: 7189
diff changeset
1031 & $\backslash$prime && $\prime$
49810341db91 Correct typos in __go_draw_axes__.m and update Manual
godfrey@qss.Stanford.EDU
parents: 7189
diff changeset
1032 && $\backslash$leq && $\leq$
49810341db91 Correct typos in __go_draw_axes__.m and update Manual
godfrey@qss.Stanford.EDU
parents: 7189
diff changeset
1033 && $\backslash$infty && $\infty$ &\cr
49810341db91 Correct typos in __go_draw_axes__.m and update Manual
godfrey@qss.Stanford.EDU
parents: 7189
diff changeset
1034 & $\backslash$clubsuit && $\clubsuit$
49810341db91 Correct typos in __go_draw_axes__.m and update Manual
godfrey@qss.Stanford.EDU
parents: 7189
diff changeset
1035 && $\backslash$diamondsuit && $\diamondsuit$
49810341db91 Correct typos in __go_draw_axes__.m and update Manual
godfrey@qss.Stanford.EDU
parents: 7189
diff changeset
1036 && $\backslash$heartsuit && $\heartsuit$ &\cr
49810341db91 Correct typos in __go_draw_axes__.m and update Manual
godfrey@qss.Stanford.EDU
parents: 7189
diff changeset
1037 & $\backslash$spadesuit && $\spadesuit$
49810341db91 Correct typos in __go_draw_axes__.m and update Manual
godfrey@qss.Stanford.EDU
parents: 7189
diff changeset
1038 && $\backslash$leftrightarrow && $\leftrightarrow$
49810341db91 Correct typos in __go_draw_axes__.m and update Manual
godfrey@qss.Stanford.EDU
parents: 7189
diff changeset
1039 && $\backslash$leftarrow && $\leftarrow$ &\cr
49810341db91 Correct typos in __go_draw_axes__.m and update Manual
godfrey@qss.Stanford.EDU
parents: 7189
diff changeset
1040 & $\backslash$uparrow && $\uparrow$
49810341db91 Correct typos in __go_draw_axes__.m and update Manual
godfrey@qss.Stanford.EDU
parents: 7189
diff changeset
1041 && $\backslash$rightarrow && $\rightarrow$
49810341db91 Correct typos in __go_draw_axes__.m and update Manual
godfrey@qss.Stanford.EDU
parents: 7189
diff changeset
1042 && $\backslash$downarrow && $\downarrow$ &\cr
49810341db91 Correct typos in __go_draw_axes__.m and update Manual
godfrey@qss.Stanford.EDU
parents: 7189
diff changeset
1043 & $\backslash$circ && $\circ$
49810341db91 Correct typos in __go_draw_axes__.m and update Manual
godfrey@qss.Stanford.EDU
parents: 7189
diff changeset
1044 && $\backslash$pm && $\pm$
49810341db91 Correct typos in __go_draw_axes__.m and update Manual
godfrey@qss.Stanford.EDU
parents: 7189
diff changeset
1045 && $\backslash$geq && $\geq$ &\cr
49810341db91 Correct typos in __go_draw_axes__.m and update Manual
godfrey@qss.Stanford.EDU
parents: 7189
diff changeset
1046 & $\backslash$times && $\times$
49810341db91 Correct typos in __go_draw_axes__.m and update Manual
godfrey@qss.Stanford.EDU
parents: 7189
diff changeset
1047 && $\backslash$propto && $\propto$
49810341db91 Correct typos in __go_draw_axes__.m and update Manual
godfrey@qss.Stanford.EDU
parents: 7189
diff changeset
1048 && $\backslash$partial && $\partial$ &\cr
49810341db91 Correct typos in __go_draw_axes__.m and update Manual
godfrey@qss.Stanford.EDU
parents: 7189
diff changeset
1049 & $\backslash$bullet && $\bullet$
49810341db91 Correct typos in __go_draw_axes__.m and update Manual
godfrey@qss.Stanford.EDU
parents: 7189
diff changeset
1050 && $\backslash$div && $\div$
49810341db91 Correct typos in __go_draw_axes__.m and update Manual
godfrey@qss.Stanford.EDU
parents: 7189
diff changeset
1051 && $\backslash$neq && $\neq$ &\cr
49810341db91 Correct typos in __go_draw_axes__.m and update Manual
godfrey@qss.Stanford.EDU
parents: 7189
diff changeset
1052 & $\backslash$equiv && $\equiv$
49810341db91 Correct typos in __go_draw_axes__.m and update Manual
godfrey@qss.Stanford.EDU
parents: 7189
diff changeset
1053 && $\backslash$approx && $\approx$
49810341db91 Correct typos in __go_draw_axes__.m and update Manual
godfrey@qss.Stanford.EDU
parents: 7189
diff changeset
1054 && $\backslash$ldots && $\ldots$ &\cr
49810341db91 Correct typos in __go_draw_axes__.m and update Manual
godfrey@qss.Stanford.EDU
parents: 7189
diff changeset
1055 & $\backslash$mid && $\mid$
49810341db91 Correct typos in __go_draw_axes__.m and update Manual
godfrey@qss.Stanford.EDU
parents: 7189
diff changeset
1056 && $\backslash$aleph && $\aleph$
49810341db91 Correct typos in __go_draw_axes__.m and update Manual
godfrey@qss.Stanford.EDU
parents: 7189
diff changeset
1057 && $\backslash$Im && $\Im$ &\cr
49810341db91 Correct typos in __go_draw_axes__.m and update Manual
godfrey@qss.Stanford.EDU
parents: 7189
diff changeset
1058 & $\backslash$Re && $\Re$
49810341db91 Correct typos in __go_draw_axes__.m and update Manual
godfrey@qss.Stanford.EDU
parents: 7189
diff changeset
1059 && $\backslash$wp && $\wp$
49810341db91 Correct typos in __go_draw_axes__.m and update Manual
godfrey@qss.Stanford.EDU
parents: 7189
diff changeset
1060 && $\backslash$otimes && $\otimes$ &\cr
49810341db91 Correct typos in __go_draw_axes__.m and update Manual
godfrey@qss.Stanford.EDU
parents: 7189
diff changeset
1061 & $\backslash$oplus && $\oplus$
49810341db91 Correct typos in __go_draw_axes__.m and update Manual
godfrey@qss.Stanford.EDU
parents: 7189
diff changeset
1062 && $\backslash$oslash && $\oslash$
49810341db91 Correct typos in __go_draw_axes__.m and update Manual
godfrey@qss.Stanford.EDU
parents: 7189
diff changeset
1063 && $\backslash$cap && $\cap$ &\cr
49810341db91 Correct typos in __go_draw_axes__.m and update Manual
godfrey@qss.Stanford.EDU
parents: 7189
diff changeset
1064 & $\backslash$cup && $\cup$
49810341db91 Correct typos in __go_draw_axes__.m and update Manual
godfrey@qss.Stanford.EDU
parents: 7189
diff changeset
1065 && $\backslash$supset && $\supset$
49810341db91 Correct typos in __go_draw_axes__.m and update Manual
godfrey@qss.Stanford.EDU
parents: 7189
diff changeset
1066 && $\backslash$supseteq && $\supseteq$ &\cr
49810341db91 Correct typos in __go_draw_axes__.m and update Manual
godfrey@qss.Stanford.EDU
parents: 7189
diff changeset
1067 & $\backslash$subset && $\subset$
49810341db91 Correct typos in __go_draw_axes__.m and update Manual
godfrey@qss.Stanford.EDU
parents: 7189
diff changeset
1068 && $\backslash$subseteq && $\subseteq$
49810341db91 Correct typos in __go_draw_axes__.m and update Manual
godfrey@qss.Stanford.EDU
parents: 7189
diff changeset
1069 && $\backslash$in && $\in$ &\cr
49810341db91 Correct typos in __go_draw_axes__.m and update Manual
godfrey@qss.Stanford.EDU
parents: 7189
diff changeset
1070 & $\backslash$notin && $\notin$
49810341db91 Correct typos in __go_draw_axes__.m and update Manual
godfrey@qss.Stanford.EDU
parents: 7189
diff changeset
1071 && $\backslash$angle && $\angle$
49810341db91 Correct typos in __go_draw_axes__.m and update Manual
godfrey@qss.Stanford.EDU
parents: 7189
diff changeset
1072 && $\backslash$bigtriangledown && $\bigtriangledown$ &\cr
49810341db91 Correct typos in __go_draw_axes__.m and update Manual
godfrey@qss.Stanford.EDU
parents: 7189
diff changeset
1073 & $\backslash$langle && $\langle$
49810341db91 Correct typos in __go_draw_axes__.m and update Manual
godfrey@qss.Stanford.EDU
parents: 7189
diff changeset
1074 && $\backslash$rangle && $\rangle$
49810341db91 Correct typos in __go_draw_axes__.m and update Manual
godfrey@qss.Stanford.EDU
parents: 7189
diff changeset
1075 && $\backslash$nabla && $\nabla$ &\cr
49810341db91 Correct typos in __go_draw_axes__.m and update Manual
godfrey@qss.Stanford.EDU
parents: 7189
diff changeset
1076 & $\backslash$prod && $\prod$
49810341db91 Correct typos in __go_draw_axes__.m and update Manual
godfrey@qss.Stanford.EDU
parents: 7189
diff changeset
1077 && $\backslash$surd && $\surd$
49810341db91 Correct typos in __go_draw_axes__.m and update Manual
godfrey@qss.Stanford.EDU
parents: 7189
diff changeset
1078 && $\backslash$cdot && $\cdot$ &\cr
49810341db91 Correct typos in __go_draw_axes__.m and update Manual
godfrey@qss.Stanford.EDU
parents: 7189
diff changeset
1079 & $\backslash$neg && $\neg$
49810341db91 Correct typos in __go_draw_axes__.m and update Manual
godfrey@qss.Stanford.EDU
parents: 7189
diff changeset
1080 && $\backslash$wedge && $\wedge$
49810341db91 Correct typos in __go_draw_axes__.m and update Manual
godfrey@qss.Stanford.EDU
parents: 7189
diff changeset
1081 && $\backslash$vee && $\vee$ &\cr
49810341db91 Correct typos in __go_draw_axes__.m and update Manual
godfrey@qss.Stanford.EDU
parents: 7189
diff changeset
1082 & $\backslash$Leftrightarrow && $\Leftrightarrow$
49810341db91 Correct typos in __go_draw_axes__.m and update Manual
godfrey@qss.Stanford.EDU
parents: 7189
diff changeset
1083 && $\backslash$Leftarrow && $\Leftarrow$
49810341db91 Correct typos in __go_draw_axes__.m and update Manual
godfrey@qss.Stanford.EDU
parents: 7189
diff changeset
1084 && $\backslash$Uparrow && $\Uparrow$ &\cr
49810341db91 Correct typos in __go_draw_axes__.m and update Manual
godfrey@qss.Stanford.EDU
parents: 7189
diff changeset
1085 & $\backslash$Rightarrow && $\Rightarrow$
49810341db91 Correct typos in __go_draw_axes__.m and update Manual
godfrey@qss.Stanford.EDU
parents: 7189
diff changeset
1086 && $\backslash$Downarrow && $\Downarrow$
49810341db91 Correct typos in __go_draw_axes__.m and update Manual
godfrey@qss.Stanford.EDU
parents: 7189
diff changeset
1087 && $\backslash$diamond && $\diamond$ &\cr
49810341db91 Correct typos in __go_draw_axes__.m and update Manual
godfrey@qss.Stanford.EDU
parents: 7189
diff changeset
1088 & $\backslash$copyright && $\copyright$
49810341db91 Correct typos in __go_draw_axes__.m and update Manual
godfrey@qss.Stanford.EDU
parents: 7189
diff changeset
1089 && $\backslash$rfloor && $\rfloor$
49810341db91 Correct typos in __go_draw_axes__.m and update Manual
godfrey@qss.Stanford.EDU
parents: 7189
diff changeset
1090 && $\backslash$lceil && $\lceil$ &\cr
49810341db91 Correct typos in __go_draw_axes__.m and update Manual
godfrey@qss.Stanford.EDU
parents: 7189
diff changeset
1091 & $\backslash$lfloor && $\lfloor$
49810341db91 Correct typos in __go_draw_axes__.m and update Manual
godfrey@qss.Stanford.EDU
parents: 7189
diff changeset
1092 && $\backslash$rceil && $\rceil$
49810341db91 Correct typos in __go_draw_axes__.m and update Manual
godfrey@qss.Stanford.EDU
parents: 7189
diff changeset
1093 && $\backslash$int && $\int$ &\cr
7189
e8d953d03f6a [project @ 2007-11-26 20:42:09 by dbateman]
dbateman
parents: 7153
diff changeset
1094 \noalign{\hrule height 0.6pt}
e8d953d03f6a [project @ 2007-11-26 20:42:09 by dbateman]
dbateman
parents: 7153
diff changeset
1095 }}\hfill}}
e8d953d03f6a [project @ 2007-11-26 20:42:09 by dbateman]
dbateman
parents: 7153
diff changeset
1096 @end tex
e8d953d03f6a [project @ 2007-11-26 20:42:09 by dbateman]
dbateman
parents: 7153
diff changeset
1097 @end iftex
e8d953d03f6a [project @ 2007-11-26 20:42:09 by dbateman]
dbateman
parents: 7153
diff changeset
1098 @ifnottex
e8d953d03f6a [project @ 2007-11-26 20:42:09 by dbateman]
dbateman
parents: 7153
diff changeset
1099 @multitable @columnfractions .125 .25 .25 .25 .125
7608
49810341db91 Correct typos in __go_draw_axes__.m and update Manual
godfrey@qss.Stanford.EDU
parents: 7189
diff changeset
1100 @item @tab \forall @tab \exists @tab \ni @tab
49810341db91 Correct typos in __go_draw_axes__.m and update Manual
godfrey@qss.Stanford.EDU
parents: 7189
diff changeset
1101 @item @tab \cong @tab \Delta @tab \Phi @tab
49810341db91 Correct typos in __go_draw_axes__.m and update Manual
godfrey@qss.Stanford.EDU
parents: 7189
diff changeset
1102 @item @tab \Gamma @tab \vartheta @tab \Lambda @tab
49810341db91 Correct typos in __go_draw_axes__.m and update Manual
godfrey@qss.Stanford.EDU
parents: 7189
diff changeset
1103 @item @tab \Pi @tab \Theta @tab \Sigma @tab
49810341db91 Correct typos in __go_draw_axes__.m and update Manual
godfrey@qss.Stanford.EDU
parents: 7189
diff changeset
1104 @item @tab \varsigma @tab \Omega @tab \Xi @tab
49810341db91 Correct typos in __go_draw_axes__.m and update Manual
godfrey@qss.Stanford.EDU
parents: 7189
diff changeset
1105 @item @tab \Psi @tab \perp @tab \alpha @tab
49810341db91 Correct typos in __go_draw_axes__.m and update Manual
godfrey@qss.Stanford.EDU
parents: 7189
diff changeset
1106 @item @tab \beta @tab \chi @tab \delta @tab
49810341db91 Correct typos in __go_draw_axes__.m and update Manual
godfrey@qss.Stanford.EDU
parents: 7189
diff changeset
1107 @item @tab \epsilon @tab \phi @tab \gamma @tab
49810341db91 Correct typos in __go_draw_axes__.m and update Manual
godfrey@qss.Stanford.EDU
parents: 7189
diff changeset
1108 @item @tab \eta @tab \iota @tab \varphi @tab
49810341db91 Correct typos in __go_draw_axes__.m and update Manual
godfrey@qss.Stanford.EDU
parents: 7189
diff changeset
1109 @item @tab \kappa @tab \lambda @tab \mu @tab
49810341db91 Correct typos in __go_draw_axes__.m and update Manual
godfrey@qss.Stanford.EDU
parents: 7189
diff changeset
1110 @item @tab \nu @tab \o @tab \pi @tab
49810341db91 Correct typos in __go_draw_axes__.m and update Manual
godfrey@qss.Stanford.EDU
parents: 7189
diff changeset
1111 @item @tab \theta @tab \rho @tab \sigma @tab
49810341db91 Correct typos in __go_draw_axes__.m and update Manual
godfrey@qss.Stanford.EDU
parents: 7189
diff changeset
1112 @item @tab \tau @tab \upsilon @tab \varpi @tab
49810341db91 Correct typos in __go_draw_axes__.m and update Manual
godfrey@qss.Stanford.EDU
parents: 7189
diff changeset
1113 @item @tab \omega @tab \xi @tab \psi @tab
49810341db91 Correct typos in __go_draw_axes__.m and update Manual
godfrey@qss.Stanford.EDU
parents: 7189
diff changeset
1114 @item @tab \zeta @tab \sim @tab \Upsilon @tab
49810341db91 Correct typos in __go_draw_axes__.m and update Manual
godfrey@qss.Stanford.EDU
parents: 7189
diff changeset
1115 @item @tab \prime @tab \leq @tab \infty @tab
49810341db91 Correct typos in __go_draw_axes__.m and update Manual
godfrey@qss.Stanford.EDU
parents: 7189
diff changeset
1116 @item @tab \clubsuit @tab \diamondsuit @tab \heartsuit @tab
49810341db91 Correct typos in __go_draw_axes__.m and update Manual
godfrey@qss.Stanford.EDU
parents: 7189
diff changeset
1117 @item @tab \spadesuit @tab \leftrightarrow @tab \leftarrow @tab
49810341db91 Correct typos in __go_draw_axes__.m and update Manual
godfrey@qss.Stanford.EDU
parents: 7189
diff changeset
1118 @item @tab \uparrow @tab \rightarrow @tab \downarrow @tab
49810341db91 Correct typos in __go_draw_axes__.m and update Manual
godfrey@qss.Stanford.EDU
parents: 7189
diff changeset
1119 @item @tab \circ @tab \pm @tab \geq @tab
49810341db91 Correct typos in __go_draw_axes__.m and update Manual
godfrey@qss.Stanford.EDU
parents: 7189
diff changeset
1120 @item @tab \times @tab \propto @tab \partial @tab
49810341db91 Correct typos in __go_draw_axes__.m and update Manual
godfrey@qss.Stanford.EDU
parents: 7189
diff changeset
1121 @item @tab \bullet @tab \div @tab \neq @tab
49810341db91 Correct typos in __go_draw_axes__.m and update Manual
godfrey@qss.Stanford.EDU
parents: 7189
diff changeset
1122 @item @tab \equiv @tab \approx @tab \ldots @tab
49810341db91 Correct typos in __go_draw_axes__.m and update Manual
godfrey@qss.Stanford.EDU
parents: 7189
diff changeset
1123 @item @tab \mid @tab \aleph @tab \Im @tab
49810341db91 Correct typos in __go_draw_axes__.m and update Manual
godfrey@qss.Stanford.EDU
parents: 7189
diff changeset
1124 @item @tab \Re @tab \wp @tab \otimes @tab
49810341db91 Correct typos in __go_draw_axes__.m and update Manual
godfrey@qss.Stanford.EDU
parents: 7189
diff changeset
1125 @item @tab \oplus @tab \oslash @tab \cap @tab
49810341db91 Correct typos in __go_draw_axes__.m and update Manual
godfrey@qss.Stanford.EDU
parents: 7189
diff changeset
1126 @item @tab \cup @tab \supset @tab \supseteq @tab
49810341db91 Correct typos in __go_draw_axes__.m and update Manual
godfrey@qss.Stanford.EDU
parents: 7189
diff changeset
1127 @item @tab \subset @tab \subseteq @tab \in @tab
49810341db91 Correct typos in __go_draw_axes__.m and update Manual
godfrey@qss.Stanford.EDU
parents: 7189
diff changeset
1128 @item @tab \notin @tab \angle @tab \bigrightriangledown @tab
49810341db91 Correct typos in __go_draw_axes__.m and update Manual
godfrey@qss.Stanford.EDU
parents: 7189
diff changeset
1129 @item @tab \langle @tab \rangle @tab \nabla @tab
49810341db91 Correct typos in __go_draw_axes__.m and update Manual
godfrey@qss.Stanford.EDU
parents: 7189
diff changeset
1130 @item @tab \prod @tab \surd @tab \cdot @tab
49810341db91 Correct typos in __go_draw_axes__.m and update Manual
godfrey@qss.Stanford.EDU
parents: 7189
diff changeset
1131 @item @tab \neg @tab \wedge @tab \vee @tab
49810341db91 Correct typos in __go_draw_axes__.m and update Manual
godfrey@qss.Stanford.EDU
parents: 7189
diff changeset
1132 @item @tab \Leftrightarrow @tab \Leftarrow @tab \Uparrow @tab
49810341db91 Correct typos in __go_draw_axes__.m and update Manual
godfrey@qss.Stanford.EDU
parents: 7189
diff changeset
1133 @item @tab \Rightarrow @tab \Downarrow @tab \diamond @tab
49810341db91 Correct typos in __go_draw_axes__.m and update Manual
godfrey@qss.Stanford.EDU
parents: 7189
diff changeset
1134 @item @tab \copyright @tab \lfloor @tab \lceil @tab
49810341db91 Correct typos in __go_draw_axes__.m and update Manual
godfrey@qss.Stanford.EDU
parents: 7189
diff changeset
1135 @item @tab \rfloor @tab \rceil @tab \int @tab
7189
e8d953d03f6a [project @ 2007-11-26 20:42:09 by dbateman]
dbateman
parents: 7153
diff changeset
1136 @end multitable
e8d953d03f6a [project @ 2007-11-26 20:42:09 by dbateman]
dbateman
parents: 7153
diff changeset
1137 @end ifnottex
e8d953d03f6a [project @ 2007-11-26 20:42:09 by dbateman]
dbateman
parents: 7153
diff changeset
1138 @caption{Available special characters in @sc{TeX} mode}
e8d953d03f6a [project @ 2007-11-26 20:42:09 by dbateman]
dbateman
parents: 7153
diff changeset
1139 @end float
e8d953d03f6a [project @ 2007-11-26 20:42:09 by dbateman]
dbateman
parents: 7153
diff changeset
1140
e8d953d03f6a [project @ 2007-11-26 20:42:09 by dbateman]
dbateman
parents: 7153
diff changeset
1141 A complete example showing the capabilities of the extended text is
e8d953d03f6a [project @ 2007-11-26 20:42:09 by dbateman]
dbateman
parents: 7153
diff changeset
1142
e8d953d03f6a [project @ 2007-11-26 20:42:09 by dbateman]
dbateman
parents: 7153
diff changeset
1143 @example
e8d953d03f6a [project @ 2007-11-26 20:42:09 by dbateman]
dbateman
parents: 7153
diff changeset
1144 @group
e8d953d03f6a [project @ 2007-11-26 20:42:09 by dbateman]
dbateman
parents: 7153
diff changeset
1145 x = 0:0.01:3;
e8d953d03f6a [project @ 2007-11-26 20:42:09 by dbateman]
dbateman
parents: 7153
diff changeset
1146 plot(x,erf(x));
e8d953d03f6a [project @ 2007-11-26 20:42:09 by dbateman]
dbateman
parents: 7153
diff changeset
1147 hold on;
e8d953d03f6a [project @ 2007-11-26 20:42:09 by dbateman]
dbateman
parents: 7153
diff changeset
1148 plot(x,x,"r");
e8d953d03f6a [project @ 2007-11-26 20:42:09 by dbateman]
dbateman
parents: 7153
diff changeset
1149 axis([0, 3, 0, 1]);
e8d953d03f6a [project @ 2007-11-26 20:42:09 by dbateman]
dbateman
parents: 7153
diff changeset
1150 text(0.65, 0.6175, strcat('\leftarrow x = @{2/\surd\pi',
e8d953d03f6a [project @ 2007-11-26 20:42:09 by dbateman]
dbateman
parents: 7153
diff changeset
1151 ' @{\fontsize@{16@}\int_@{\fontsize@{8@}0@}^@{\fontsize@{8@}x@}@}',
e8d953d03f6a [project @ 2007-11-26 20:42:09 by dbateman]
dbateman
parents: 7153
diff changeset
1152 ' e^@{-t^2@} dt@} = 0.6175'))
e8d953d03f6a [project @ 2007-11-26 20:42:09 by dbateman]
dbateman
parents: 7153
diff changeset
1153 @end group
e8d953d03f6a [project @ 2007-11-26 20:42:09 by dbateman]
dbateman
parents: 7153
diff changeset
1154 @end example
e8d953d03f6a [project @ 2007-11-26 20:42:09 by dbateman]
dbateman
parents: 7153
diff changeset
1155
e8d953d03f6a [project @ 2007-11-26 20:42:09 by dbateman]
dbateman
parents: 7153
diff changeset
1156 @ifnotinfo
e8d953d03f6a [project @ 2007-11-26 20:42:09 by dbateman]
dbateman
parents: 7153
diff changeset
1157 @noindent
e8d953d03f6a [project @ 2007-11-26 20:42:09 by dbateman]
dbateman
parents: 7153
diff changeset
1158 The result of which can be seen in @ref{fig:extendedtext}
e8d953d03f6a [project @ 2007-11-26 20:42:09 by dbateman]
dbateman
parents: 7153
diff changeset
1159
e8d953d03f6a [project @ 2007-11-26 20:42:09 by dbateman]
dbateman
parents: 7153
diff changeset
1160 @float Figure,fig:extendedtext
e8d953d03f6a [project @ 2007-11-26 20:42:09 by dbateman]
dbateman
parents: 7153
diff changeset
1161 @image{extended,8cm}
e8d953d03f6a [project @ 2007-11-26 20:42:09 by dbateman]
dbateman
parents: 7153
diff changeset
1162 @caption{Example of inclusion of text with the @sc{TeX} interpreter}
e8d953d03f6a [project @ 2007-11-26 20:42:09 by dbateman]
dbateman
parents: 7153
diff changeset
1163 @end float
e8d953d03f6a [project @ 2007-11-26 20:42:09 by dbateman]
dbateman
parents: 7153
diff changeset
1164 @end ifnotinfo
e8d953d03f6a [project @ 2007-11-26 20:42:09 by dbateman]
dbateman
parents: 7153
diff changeset
1165
6888
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
1166 @node Image Properties
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
1167 @subsubsection Image Properties
8071
b6e85fb238c1 doc fixes
John W. Eaton <jwe@octave.org>
parents: 8070
diff changeset
1168 @cindex image properties
6888
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
1169
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
1170 @table @code
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
1171 @item cdata
6889
ebff56d6b0a8 [project @ 2007-09-12 18:32:12 by jwe]
jwe
parents: 6888
diff changeset
1172 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
1173 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
1174 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
1175 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
1176 determines the color of the pixel.
ebff56d6b0a8 [project @ 2007-09-12 18:32:12 by jwe]
jwe
parents: 6888
diff changeset
1177
ebff56d6b0a8 [project @ 2007-09-12 18:32:12 by jwe]
jwe
parents: 6888
diff changeset
1178 @item xdata
6888
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
1179 @itemx ydata
7001
8b0cfeb06365 [project @ 2007-10-10 18:02:59 by jwe]
jwe
parents: 6899
diff changeset
1180 Two-element vectors specifying the range of the x- and y- coordinates for
6889
ebff56d6b0a8 [project @ 2007-09-12 18:32:12 by jwe]
jwe
parents: 6888
diff changeset
1181 the image.
6888
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
1182 @end table
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
1183
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
1184 @node Patch Properties
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
1185 @subsubsection Patch Properties
8071
b6e85fb238c1 doc fixes
John W. Eaton <jwe@octave.org>
parents: 8070
diff changeset
1186 @cindex patch properties
6888
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
1187
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
1188 @table @code
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
1189 @item cdata
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
1190 @itemx xdata
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
1191 @itemx ydata
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
1192 @itemx zdata
6889
ebff56d6b0a8 [project @ 2007-09-12 18:32:12 by jwe]
jwe
parents: 6888
diff changeset
1193 Data defining the patch object.
ebff56d6b0a8 [project @ 2007-09-12 18:32:12 by jwe]
jwe
parents: 6888
diff changeset
1194
6888
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
1195 @item facecolor
6889
ebff56d6b0a8 [project @ 2007-09-12 18:32:12 by jwe]
jwe
parents: 6888
diff changeset
1196 The fill color of the patch. @xref{Colors}.
ebff56d6b0a8 [project @ 2007-09-12 18:32:12 by jwe]
jwe
parents: 6888
diff changeset
1197
6888
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
1198 @item facealpha
6889
ebff56d6b0a8 [project @ 2007-09-12 18:32:12 by jwe]
jwe
parents: 6888
diff changeset
1199 A number in the range [0, 1] indicating the transparency of the patch.
ebff56d6b0a8 [project @ 2007-09-12 18:32:12 by jwe]
jwe
parents: 6888
diff changeset
1200
6888
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
1201 @item edgecolor
6889
ebff56d6b0a8 [project @ 2007-09-12 18:32:12 by jwe]
jwe
parents: 6888
diff changeset
1202 The color of the line defining the patch. @xref{Colors}.
ebff56d6b0a8 [project @ 2007-09-12 18:32:12 by jwe]
jwe
parents: 6888
diff changeset
1203
6888
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
1204 @item linestyle
6889
ebff56d6b0a8 [project @ 2007-09-12 18:32:12 by jwe]
jwe
parents: 6888
diff changeset
1205 @itemx linewidth
ebff56d6b0a8 [project @ 2007-09-12 18:32:12 by jwe]
jwe
parents: 6888
diff changeset
1206 @xref{Line Styles}.
ebff56d6b0a8 [project @ 2007-09-12 18:32:12 by jwe]
jwe
parents: 6888
diff changeset
1207
6888
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
1208 @item marker
6889
ebff56d6b0a8 [project @ 2007-09-12 18:32:12 by jwe]
jwe
parents: 6888
diff changeset
1209 @itemx markeredgecolor
ebff56d6b0a8 [project @ 2007-09-12 18:32:12 by jwe]
jwe
parents: 6888
diff changeset
1210 @itemx markerfacecolor
ebff56d6b0a8 [project @ 2007-09-12 18:32:12 by jwe]
jwe
parents: 6888
diff changeset
1211 @itemx markersize
ebff56d6b0a8 [project @ 2007-09-12 18:32:12 by jwe]
jwe
parents: 6888
diff changeset
1212 @xref{Marker Styles}.
6888
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
1213 @end table
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
1214
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
1215 @node Surface Properties
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
1216 @subsubsection Surface Properties
8071
b6e85fb238c1 doc fixes
John W. Eaton <jwe@octave.org>
parents: 8070
diff changeset
1217 @cindex surface properties
6888
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
1218
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
1219 @table @code
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
1220 @item xdata
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
1221 @itemx ydata
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
1222 @itemx zdata
6889
ebff56d6b0a8 [project @ 2007-09-12 18:32:12 by jwe]
jwe
parents: 6888
diff changeset
1223 The data determining the surface. The @code{xdata} and @code{ydata}
ebff56d6b0a8 [project @ 2007-09-12 18:32:12 by jwe]
jwe
parents: 6888
diff changeset
1224 elements are vectors and @code{zdata} must be a matrix.
ebff56d6b0a8 [project @ 2007-09-12 18:32:12 by jwe]
jwe
parents: 6888
diff changeset
1225
6888
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
1226 @item keylabel
6889
ebff56d6b0a8 [project @ 2007-09-12 18:32:12 by jwe]
jwe
parents: 6888
diff changeset
1227 The text of the legend entry corresponding to this surface. Note that
ebff56d6b0a8 [project @ 2007-09-12 18:32:12 by jwe]
jwe
parents: 6888
diff changeset
1228 this property is not compatible with @sc{Matlab} and may be removed in a
ebff56d6b0a8 [project @ 2007-09-12 18:32:12 by jwe]
jwe
parents: 6888
diff changeset
1229 future version of Octave.
ebff56d6b0a8 [project @ 2007-09-12 18:32:12 by jwe]
jwe
parents: 6888
diff changeset
1230 @end table
ebff56d6b0a8 [project @ 2007-09-12 18:32:12 by jwe]
jwe
parents: 6888
diff changeset
1231
8070
3b53b25e2550 Add data sources and line series
David Bateman <dbateman@free.fr>
parents: 8057
diff changeset
1232 @node Searching Properties
3b53b25e2550 Add data sources and line series
David Bateman <dbateman@free.fr>
parents: 8057
diff changeset
1233 @subsubsection Searching Properties
7984
bbaa5d7d0143 Some documentation updates
David Bateman <dbateman@free.fr>
parents: 7981
diff changeset
1234
bbaa5d7d0143 Some documentation updates
David Bateman <dbateman@free.fr>
parents: 7981
diff changeset
1235 @DOCSTRING(findobj)
bbaa5d7d0143 Some documentation updates
David Bateman <dbateman@free.fr>
parents: 7981
diff changeset
1236
bbaa5d7d0143 Some documentation updates
David Bateman <dbateman@free.fr>
parents: 7981
diff changeset
1237 @DOCSTRING(findall)
bbaa5d7d0143 Some documentation updates
David Bateman <dbateman@free.fr>
parents: 7981
diff changeset
1238
bbaa5d7d0143 Some documentation updates
David Bateman <dbateman@free.fr>
parents: 7981
diff changeset
1239
6891
e9921bb3d95b [project @ 2007-09-13 02:44:27 by jwe]
jwe
parents: 6889
diff changeset
1240 @node Managing Default Properties
e9921bb3d95b [project @ 2007-09-13 02:44:27 by jwe]
jwe
parents: 6889
diff changeset
1241 @subsection Managing Default Properties
8071
b6e85fb238c1 doc fixes
John W. Eaton <jwe@octave.org>
parents: 8070
diff changeset
1242 @cindex default graphics properties
b6e85fb238c1 doc fixes
John W. Eaton <jwe@octave.org>
parents: 8070
diff changeset
1243 @cindex graphics properties, default
6891
e9921bb3d95b [project @ 2007-09-13 02:44:27 by jwe]
jwe
parents: 6889
diff changeset
1244
6892
29fa8673d8d1 [project @ 2007-09-13 07:36:52 by jwe]
jwe
parents: 6891
diff changeset
1245 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
1246 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
1247 may override the factory defaults.
6891
e9921bb3d95b [project @ 2007-09-13 02:44:27 by jwe]
jwe
parents: 6889
diff changeset
1248
e9921bb3d95b [project @ 2007-09-13 02:44:27 by jwe]
jwe
parents: 6889
diff changeset
1249 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
1250 parent objects and apply to child objects. For example,
e9921bb3d95b [project @ 2007-09-13 02:44:27 by jwe]
jwe
parents: 6889
diff changeset
1251
e9921bb3d95b [project @ 2007-09-13 02:44:27 by jwe]
jwe
parents: 6889
diff changeset
1252 @example
e9921bb3d95b [project @ 2007-09-13 02:44:27 by jwe]
jwe
parents: 6889
diff changeset
1253 set (0, "defaultlinecolor", "green");
e9921bb3d95b [project @ 2007-09-13 02:44:27 by jwe]
jwe
parents: 6889
diff changeset
1254 @end example
e9921bb3d95b [project @ 2007-09-13 02:44:27 by jwe]
jwe
parents: 6889
diff changeset
1255
e9921bb3d95b [project @ 2007-09-13 02:44:27 by jwe]
jwe
parents: 6889
diff changeset
1256 @noindent
e9921bb3d95b [project @ 2007-09-13 02:44:27 by jwe]
jwe
parents: 6889
diff changeset
1257 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
1258 the property name to set a default value is
e9921bb3d95b [project @ 2007-09-13 02:44:27 by jwe]
jwe
parents: 6889
diff changeset
1259
e9921bb3d95b [project @ 2007-09-13 02:44:27 by jwe]
jwe
parents: 6889
diff changeset
1260 @example
e9921bb3d95b [project @ 2007-09-13 02:44:27 by jwe]
jwe
parents: 6889
diff changeset
1261 default + @var{object-type} + @var{property-name}
e9921bb3d95b [project @ 2007-09-13 02:44:27 by jwe]
jwe
parents: 6889
diff changeset
1262 @end example
e9921bb3d95b [project @ 2007-09-13 02:44:27 by jwe]
jwe
parents: 6889
diff changeset
1263
e9921bb3d95b [project @ 2007-09-13 02:44:27 by jwe]
jwe
parents: 6889
diff changeset
1264 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
1265 @code{defaultlinelinewidth"} specifies the default @code{linewidth}
e9921bb3d95b [project @ 2007-09-13 02:44:27 by jwe]
jwe
parents: 6889
diff changeset
1266 property for @code{line} objects.
e9921bb3d95b [project @ 2007-09-13 02:44:27 by jwe]
jwe
parents: 6889
diff changeset
1267
e9921bb3d95b [project @ 2007-09-13 02:44:27 by jwe]
jwe
parents: 6889
diff changeset
1268 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
1269 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
1270 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
1271 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
1272 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
1273
e9921bb3d95b [project @ 2007-09-13 02:44:27 by jwe]
jwe
parents: 6889
diff changeset
1274 @example
e9921bb3d95b [project @ 2007-09-13 02:44:27 by jwe]
jwe
parents: 6889
diff changeset
1275 @group
e9921bb3d95b [project @ 2007-09-13 02:44:27 by jwe]
jwe
parents: 6889
diff changeset
1276 subplot (2, 1, 1);
e9921bb3d95b [project @ 2007-09-13 02:44:27 by jwe]
jwe
parents: 6889
diff changeset
1277 set (0, "defaultlinecolor", "red");
e9921bb3d95b [project @ 2007-09-13 02:44:27 by jwe]
jwe
parents: 6889
diff changeset
1278 set (1, "defaultlinecolor", "green");
e9921bb3d95b [project @ 2007-09-13 02:44:27 by jwe]
jwe
parents: 6889
diff changeset
1279 set (gca (), "defaultlinecolor", "blue");
e9921bb3d95b [project @ 2007-09-13 02:44:27 by jwe]
jwe
parents: 6889
diff changeset
1280 line (1:10, rand (1, 10));
e9921bb3d95b [project @ 2007-09-13 02:44:27 by jwe]
jwe
parents: 6889
diff changeset
1281 subplot (2, 1, 2);
e9921bb3d95b [project @ 2007-09-13 02:44:27 by jwe]
jwe
parents: 6889
diff changeset
1282 line (1:10, rand (1, 10));
e9921bb3d95b [project @ 2007-09-13 02:44:27 by jwe]
jwe
parents: 6889
diff changeset
1283 figure (2)
e9921bb3d95b [project @ 2007-09-13 02:44:27 by jwe]
jwe
parents: 6889
diff changeset
1284 line (1:10, rand (1, 10));
e9921bb3d95b [project @ 2007-09-13 02:44:27 by jwe]
jwe
parents: 6889
diff changeset
1285 @end group
e9921bb3d95b [project @ 2007-09-13 02:44:27 by jwe]
jwe
parents: 6889
diff changeset
1286 @end example
e9921bb3d95b [project @ 2007-09-13 02:44:27 by jwe]
jwe
parents: 6889
diff changeset
1287
e9921bb3d95b [project @ 2007-09-13 02:44:27 by jwe]
jwe
parents: 6889
diff changeset
1288 @noindent
e9921bb3d95b [project @ 2007-09-13 02:44:27 by jwe]
jwe
parents: 6889
diff changeset
1289 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
1290 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
1291 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
1292 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
1293 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
1294 from the global root figure parent object.
e9921bb3d95b [project @ 2007-09-13 02:44:27 by jwe]
jwe
parents: 6889
diff changeset
1295
e9921bb3d95b [project @ 2007-09-13 02:44:27 by jwe]
jwe
parents: 6889
diff changeset
1296 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
1297 the value @code{"remove"}. For example,
e9921bb3d95b [project @ 2007-09-13 02:44:27 by jwe]
jwe
parents: 6889
diff changeset
1298
e9921bb3d95b [project @ 2007-09-13 02:44:27 by jwe]
jwe
parents: 6889
diff changeset
1299 @example
e9921bb3d95b [project @ 2007-09-13 02:44:27 by jwe]
jwe
parents: 6889
diff changeset
1300 set (gca (), "defaultlinecolor", "remove");
e9921bb3d95b [project @ 2007-09-13 02:44:27 by jwe]
jwe
parents: 6889
diff changeset
1301 @end example
e9921bb3d95b [project @ 2007-09-13 02:44:27 by jwe]
jwe
parents: 6889
diff changeset
1302
e9921bb3d95b [project @ 2007-09-13 02:44:27 by jwe]
jwe
parents: 6889
diff changeset
1303 @noindent
e9921bb3d95b [project @ 2007-09-13 02:44:27 by jwe]
jwe
parents: 6889
diff changeset
1304 removes the user-defined default line color setting from the current axes
e9921bb3d95b [project @ 2007-09-13 02:44:27 by jwe]
jwe
parents: 6889
diff changeset
1305 object.
e9921bb3d95b [project @ 2007-09-13 02:44:27 by jwe]
jwe
parents: 6889
diff changeset
1306
e9921bb3d95b [project @ 2007-09-13 02:44:27 by jwe]
jwe
parents: 6889
diff changeset
1307 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
1308 user-defined defaults set for the object. For example,
e9921bb3d95b [project @ 2007-09-13 02:44:27 by jwe]
jwe
parents: 6889
diff changeset
1309
e9921bb3d95b [project @ 2007-09-13 02:44:27 by jwe]
jwe
parents: 6889
diff changeset
1310 @example
e9921bb3d95b [project @ 2007-09-13 02:44:27 by jwe]
jwe
parents: 6889
diff changeset
1311 get (gca (), "default");
e9921bb3d95b [project @ 2007-09-13 02:44:27 by jwe]
jwe
parents: 6889
diff changeset
1312 @end example
e9921bb3d95b [project @ 2007-09-13 02:44:27 by jwe]
jwe
parents: 6889
diff changeset
1313
e9921bb3d95b [project @ 2007-09-13 02:44:27 by jwe]
jwe
parents: 6889
diff changeset
1314 @noindent
e9921bb3d95b [project @ 2007-09-13 02:44:27 by jwe]
jwe
parents: 6889
diff changeset
1315 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
1316 object.
e9921bb3d95b [project @ 2007-09-13 02:44:27 by jwe]
jwe
parents: 6889
diff changeset
1317
e9921bb3d95b [project @ 2007-09-13 02:44:27 by jwe]
jwe
parents: 6889
diff changeset
1318 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
1319 command
e9921bb3d95b [project @ 2007-09-13 02:44:27 by jwe]
jwe
parents: 6889
diff changeset
1320
e9921bb3d95b [project @ 2007-09-13 02:44:27 by jwe]
jwe
parents: 6889
diff changeset
1321 @example
e9921bb3d95b [project @ 2007-09-13 02:44:27 by jwe]
jwe
parents: 6889
diff changeset
1322 get (0, "factory");
e9921bb3d95b [project @ 2007-09-13 02:44:27 by jwe]
jwe
parents: 6889
diff changeset
1323 @end example
e9921bb3d95b [project @ 2007-09-13 02:44:27 by jwe]
jwe
parents: 6889
diff changeset
1324
e9921bb3d95b [project @ 2007-09-13 02:44:27 by jwe]
jwe
parents: 6889
diff changeset
1325 @noindent
e9921bb3d95b [project @ 2007-09-13 02:44:27 by jwe]
jwe
parents: 6889
diff changeset
1326 returns a list of factory defaults.
e9921bb3d95b [project @ 2007-09-13 02:44:27 by jwe]
jwe
parents: 6889
diff changeset
1327
6889
ebff56d6b0a8 [project @ 2007-09-12 18:32:12 by jwe]
jwe
parents: 6888
diff changeset
1328 @node Colors
ebff56d6b0a8 [project @ 2007-09-12 18:32:12 by jwe]
jwe
parents: 6888
diff changeset
1329 @subsection Colors
8071
b6e85fb238c1 doc fixes
John W. Eaton <jwe@octave.org>
parents: 8070
diff changeset
1330 @cindex graphics colors
b6e85fb238c1 doc fixes
John W. Eaton <jwe@octave.org>
parents: 8070
diff changeset
1331 @cindex colors, graphics
6889
ebff56d6b0a8 [project @ 2007-09-12 18:32:12 by jwe]
jwe
parents: 6888
diff changeset
1332
ebff56d6b0a8 [project @ 2007-09-12 18:32:12 by jwe]
jwe
parents: 6888
diff changeset
1333 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
1334 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
1335 @code{"black"}, @code{"cyan"}, @code{"green"}, @code{"magenta"},
ebff56d6b0a8 [project @ 2007-09-12 18:32:12 by jwe]
jwe
parents: 6888
diff changeset
1336 @code{"red"}, @code{"white"}, and @code{"yellow"}.
ebff56d6b0a8 [project @ 2007-09-12 18:32:12 by jwe]
jwe
parents: 6888
diff changeset
1337
ebff56d6b0a8 [project @ 2007-09-12 18:32:12 by jwe]
jwe
parents: 6888
diff changeset
1338 @node Line Styles
ebff56d6b0a8 [project @ 2007-09-12 18:32:12 by jwe]
jwe
parents: 6888
diff changeset
1339 @subsection Line Styles
8071
b6e85fb238c1 doc fixes
John W. Eaton <jwe@octave.org>
parents: 8070
diff changeset
1340 @cindex line styles, graphics
b6e85fb238c1 doc fixes
John W. Eaton <jwe@octave.org>
parents: 8070
diff changeset
1341 @cindex graphics line styles
b6e85fb238c1 doc fixes
John W. Eaton <jwe@octave.org>
parents: 8070
diff changeset
1342
7001
8b0cfeb06365 [project @ 2007-10-10 18:02:59 by jwe]
jwe
parents: 6899
diff changeset
1343 Line styles are specified by the following properties:
6889
ebff56d6b0a8 [project @ 2007-09-12 18:32:12 by jwe]
jwe
parents: 6888
diff changeset
1344
ebff56d6b0a8 [project @ 2007-09-12 18:32:12 by jwe]
jwe
parents: 6888
diff changeset
1345 @table @code
ebff56d6b0a8 [project @ 2007-09-12 18:32:12 by jwe]
jwe
parents: 6888
diff changeset
1346 @item linestyle
ebff56d6b0a8 [project @ 2007-09-12 18:32:12 by jwe]
jwe
parents: 6888
diff changeset
1347 May be one of
ebff56d6b0a8 [project @ 2007-09-12 18:32:12 by jwe]
jwe
parents: 6888
diff changeset
1348 @table @code
ebff56d6b0a8 [project @ 2007-09-12 18:32:12 by jwe]
jwe
parents: 6888
diff changeset
1349 @item "-"
ebff56d6b0a8 [project @ 2007-09-12 18:32:12 by jwe]
jwe
parents: 6888
diff changeset
1350 Solid lines.
ebff56d6b0a8 [project @ 2007-09-12 18:32:12 by jwe]
jwe
parents: 6888
diff changeset
1351 @item "--"
ebff56d6b0a8 [project @ 2007-09-12 18:32:12 by jwe]
jwe
parents: 6888
diff changeset
1352 Dashed lines.
ebff56d6b0a8 [project @ 2007-09-12 18:32:12 by jwe]
jwe
parents: 6888
diff changeset
1353 @item ":"
ebff56d6b0a8 [project @ 2007-09-12 18:32:12 by jwe]
jwe
parents: 6888
diff changeset
1354 Points.
ebff56d6b0a8 [project @ 2007-09-12 18:32:12 by jwe]
jwe
parents: 6888
diff changeset
1355 @item "-."
ebff56d6b0a8 [project @ 2007-09-12 18:32:12 by jwe]
jwe
parents: 6888
diff changeset
1356 A dash-dot line.
ebff56d6b0a8 [project @ 2007-09-12 18:32:12 by jwe]
jwe
parents: 6888
diff changeset
1357 @end table
ebff56d6b0a8 [project @ 2007-09-12 18:32:12 by jwe]
jwe
parents: 6888
diff changeset
1358
ebff56d6b0a8 [project @ 2007-09-12 18:32:12 by jwe]
jwe
parents: 6888
diff changeset
1359 @item linewidth
ebff56d6b0a8 [project @ 2007-09-12 18:32:12 by jwe]
jwe
parents: 6888
diff changeset
1360 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
1361 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
1362 @end table
ebff56d6b0a8 [project @ 2007-09-12 18:32:12 by jwe]
jwe
parents: 6888
diff changeset
1363
ebff56d6b0a8 [project @ 2007-09-12 18:32:12 by jwe]
jwe
parents: 6888
diff changeset
1364 @node Marker Styles
ebff56d6b0a8 [project @ 2007-09-12 18:32:12 by jwe]
jwe
parents: 6888
diff changeset
1365 @subsection Marker Styles
8071
b6e85fb238c1 doc fixes
John W. Eaton <jwe@octave.org>
parents: 8070
diff changeset
1366 @cindex graphics marker styles
b6e85fb238c1 doc fixes
John W. Eaton <jwe@octave.org>
parents: 8070
diff changeset
1367 @cindex marker styles, graphics
b6e85fb238c1 doc fixes
John W. Eaton <jwe@octave.org>
parents: 8070
diff changeset
1368
7001
8b0cfeb06365 [project @ 2007-10-10 18:02:59 by jwe]
jwe
parents: 6899
diff changeset
1369 Marker styles are specified by the following properties:
6889
ebff56d6b0a8 [project @ 2007-09-12 18:32:12 by jwe]
jwe
parents: 6888
diff changeset
1370 @table @code
ebff56d6b0a8 [project @ 2007-09-12 18:32:12 by jwe]
jwe
parents: 6888
diff changeset
1371 @item marker
ebff56d6b0a8 [project @ 2007-09-12 18:32:12 by jwe]
jwe
parents: 6888
diff changeset
1372 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
1373 @code{"none"}, meaning no markers should be displayed.
ebff56d6b0a8 [project @ 2007-09-12 18:32:12 by jwe]
jwe
parents: 6888
diff changeset
1374
ebff56d6b0a8 [project @ 2007-09-12 18:32:12 by jwe]
jwe
parents: 6888
diff changeset
1375 @itemx markeredgecolor
ebff56d6b0a8 [project @ 2007-09-12 18:32:12 by jwe]
jwe
parents: 6888
diff changeset
1376 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
1377 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
1378
ebff56d6b0a8 [project @ 2007-09-12 18:32:12 by jwe]
jwe
parents: 6888
diff changeset
1379 @itemx markerfacecolor
ebff56d6b0a8 [project @ 2007-09-12 18:32:12 by jwe]
jwe
parents: 6888
diff changeset
1380 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
1381 should not be filled. @xref{Colors}.
ebff56d6b0a8 [project @ 2007-09-12 18:32:12 by jwe]
jwe
parents: 6888
diff changeset
1382
ebff56d6b0a8 [project @ 2007-09-12 18:32:12 by jwe]
jwe
parents: 6888
diff changeset
1383 @itemx markersize
ebff56d6b0a8 [project @ 2007-09-12 18:32:12 by jwe]
jwe
parents: 6888
diff changeset
1384 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
1385 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
1386 @end table
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
1387
8056
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents: 8055
diff changeset
1388 @node Callbacks
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents: 8055
diff changeset
1389 @subsection Callbacks
8071
b6e85fb238c1 doc fixes
John W. Eaton <jwe@octave.org>
parents: 8070
diff changeset
1390 @cindex callbacks
8056
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents: 8055
diff changeset
1391
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents: 8055
diff changeset
1392 Callback functions can be associated with graphics objects and triggered
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents: 8055
diff changeset
1393 after certain events occur. The basic structure of all callback function
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents: 8055
diff changeset
1394 is
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents: 8055
diff changeset
1395
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents: 8055
diff changeset
1396 @example
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents: 8055
diff changeset
1397 @group
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents: 8055
diff changeset
1398 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
1399 @dots{}
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents: 8055
diff changeset
1400 endfunction
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents: 8055
diff changeset
1401 @end group
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents: 8055
diff changeset
1402 @end example
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents: 8055
diff changeset
1403
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents: 8055
diff changeset
1404 where @code{src} gives a handle to the source of the callback, and
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents: 8055
diff changeset
1405 @code{code} gives some event specific data. This can then be associated
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents: 8055
diff changeset
1406 with an object either at the objects creation or later with the
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents: 8055
diff changeset
1407 @code{set} function. For example
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents: 8055
diff changeset
1408
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents: 8055
diff changeset
1409 @example
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents: 8055
diff changeset
1410 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
1411 @end example
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents: 8055
diff changeset
1412
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents: 8055
diff changeset
1413 @noindent
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents: 8055
diff changeset
1414 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
1415 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
1416
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents: 8055
diff changeset
1417 Additional user arguments can be passed to callback functions, and will
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents: 8055
diff changeset
1418 be passed after the 2 default arguments. For example
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents: 8055
diff changeset
1419
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents: 8055
diff changeset
1420 @example
8057
David Bateman <dbateman@free.fr>
parents: 8056
diff changeset
1421 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
1422 @dots{}
8057
David Bateman <dbateman@free.fr>
parents: 8056
diff changeset
1423 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
1424 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
1425 endfunction
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents: 8055
diff changeset
1426 @end example
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents: 8055
diff changeset
1427
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents: 8055
diff changeset
1428 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
1429 are
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents: 8055
diff changeset
1430
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents: 8055
diff changeset
1431 @itemize @bullet
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents: 8055
diff changeset
1432 @item CreateFcn
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents: 8055
diff changeset
1433 This is the callback that is called at the moment of the objects
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents: 8055
diff changeset
1434 creation. It is not called if the object is altered in any way, and so
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents: 8055
diff changeset
1435 it only makes sense to define this callback in the function call that
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents: 8055
diff changeset
1436 defines the object. Callbacks that are added to @code{CreateFcn} later with
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents: 8055
diff changeset
1437 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
1438
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents: 8055
diff changeset
1439 @item DeleteFcn
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents: 8055
diff changeset
1440 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
1441
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents: 8055
diff changeset
1442 @item ButtonDownFcn
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents: 8055
diff changeset
1443 This is the callback that is called if a mouse button is pressed while
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents: 8055
diff changeset
1444 the pointer is over this object. Note, that the gnuplot interface does
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents: 8055
diff changeset
1445 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
1446 @end itemize
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents: 8055
diff changeset
1447
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents: 8055
diff changeset
1448 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
1449 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
1450 functions.
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents: 8055
diff changeset
1451
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents: 8055
diff changeset
1452 @DOCSTRING(gcbo)
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents: 8055
diff changeset
1453
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents: 8055
diff changeset
1454 @DOCSTRING(gcbf)
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents: 8055
diff changeset
1455
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents: 8055
diff changeset
1456 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
1457 function described below.
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents: 8055
diff changeset
1458
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents: 8055
diff changeset
1459 @node Object Groups
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents: 8055
diff changeset
1460 @subsection Object Groups
8071
b6e85fb238c1 doc fixes
John W. Eaton <jwe@octave.org>
parents: 8070
diff changeset
1461 @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
1462
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents: 8055
diff changeset
1463 A number of Octave high level plot functions return groups of other
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents: 8055
diff changeset
1464 graphics objects or they return graphics objects that are have their
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents: 8055
diff changeset
1465 properties linked in such a way that changes to one of the properties
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents: 8055
diff changeset
1466 results in changes in the others. A graphic object that groups other
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents: 8055
diff changeset
1467 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
1468
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents: 8055
diff changeset
1469 @DOCSTRING(hggroup)
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents: 8055
diff changeset
1470
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents: 8055
diff changeset
1471 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
1472
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents: 8055
diff changeset
1473 @example
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents: 8055
diff changeset
1474 @group
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents: 8055
diff changeset
1475 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
1476 hg = hggroup ();
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents: 8055
diff changeset
1477 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
1478 hold on
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents: 8055
diff changeset
1479 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
1480 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
1481 @end group
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents: 8055
diff changeset
1482 @end example
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents: 8055
diff changeset
1483
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents: 8055
diff changeset
1484 @noindent
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents: 8055
diff changeset
1485 which groups the two plots into a single object and contols their
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents: 8055
diff changeset
1486 visiblity directly. The default properties of an @code{hggroup} are
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents: 8055
diff changeset
1487 the same as the set of common properties for the other graphics
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents: 8055
diff changeset
1488 objects. Additional properties can be added with the @code{addproperty}
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents: 8055
diff changeset
1489 function.
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents: 8055
diff changeset
1490
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents: 8055
diff changeset
1491 @DOCSTRING(addproperty)
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents: 8055
diff changeset
1492
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents: 8055
diff changeset
1493 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
1494 other property of either the children of the group, or any other
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents: 8055
diff changeset
1495 graphics object. Add so to control the way in which this newly added
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents: 8055
diff changeset
1496 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
1497 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
1498
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents: 8055
diff changeset
1499 @DOCSTRING(addlistener)
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents: 8055
diff changeset
1500
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents: 8055
diff changeset
1501 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
1502
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents: 8055
diff changeset
1503 @example
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents: 8055
diff changeset
1504 @group
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents: 8055
diff changeset
1505 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
1506 hg = hggroup ();
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents: 8055
diff changeset
1507 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
1508 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
1509 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
1510 hold on
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents: 8055
diff changeset
1511 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
1512
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents: 8055
diff changeset
1513 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
1514 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
1515 endfunction
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents: 8055
diff changeset
1516 @end group
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents: 8055
diff changeset
1517 @end example
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents: 8055
diff changeset
1518
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents: 8055
diff changeset
1519 @noindent
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents: 8055
diff changeset
1520 that adds a @code{linestyle} property to the @code{hggroup} and
8070
3b53b25e2550 Add data sources and line series
David Bateman <dbateman@free.fr>
parents: 8057
diff changeset
1521 propagating any changes its its value to the children of the group. The
3b53b25e2550 Add data sources and line series
David Bateman <dbateman@free.fr>
parents: 8057
diff changeset
1522 @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
1523
3b53b25e2550 Add data sources and line series
David Bateman <dbateman@free.fr>
parents: 8057
diff changeset
1524 @example
3b53b25e2550 Add data sources and line series
David Bateman <dbateman@free.fr>
parents: 8057
diff changeset
1525 @group
3b53b25e2550 Add data sources and line series
David Bateman <dbateman@free.fr>
parents: 8057
diff changeset
1526 x = 0:0.1:10;
3b53b25e2550 Add data sources and line series
David Bateman <dbateman@free.fr>
parents: 8057
diff changeset
1527 hg = hggroup ();
3b53b25e2550 Add data sources and line series
David Bateman <dbateman@free.fr>
parents: 8057
diff changeset
1528 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
1529 addproperty ("linestyle", hg, "linelinestyle", get (h, "linestyle"));
3b53b25e2550 Add data sources and line series
David Bateman <dbateman@free.fr>
parents: 8057
diff changeset
1530 hold on
3b53b25e2550 Add data sources and line series
David Bateman <dbateman@free.fr>
parents: 8057
diff changeset
1531 h2 = plot (x, cos (x), "color", [0, 1, 0], "parent", hg);
3b53b25e2550 Add data sources and line series
David Bateman <dbateman@free.fr>
parents: 8057
diff changeset
1532 hlink = linkprop ([hg, h1, h2], "color");
3b53b25e2550 Add data sources and line series
David Bateman <dbateman@free.fr>
parents: 8057
diff changeset
1533 @end group
3b53b25e2550 Add data sources and line series
David Bateman <dbateman@free.fr>
parents: 8057
diff changeset
1534 @end example
3b53b25e2550 Add data sources and line series
David Bateman <dbateman@free.fr>
parents: 8057
diff changeset
1535
3b53b25e2550 Add data sources and line series
David Bateman <dbateman@free.fr>
parents: 8057
diff changeset
1536 @DOCSTRING(linkprop)
8056
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents: 8055
diff changeset
1537
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents: 8055
diff changeset
1538 These capabilities are used in a number of basic graphics objects.
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents: 8055
diff changeset
1539 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
1540 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
1541
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents: 8055
diff changeset
1542 @itemize @bullet
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents: 8055
diff changeset
1543 @item group together multiple graphics objects,
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents: 8055
diff changeset
1544 @item create linked properties between different graphics objects, and
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents: 8055
diff changeset
1545 @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
1546 @end itemize
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents: 8055
diff changeset
1547
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents: 8055
diff changeset
1548 @noindent
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents: 8055
diff changeset
1549 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
1550 @code{hggroup} of the stem series contains two line objects representing
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents: 8055
diff changeset
1551 the body and head of the stem. The @code{ydata} property of the
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents: 8055
diff changeset
1552 @code{hggroup} of the stem series represents the head of the stem,
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents: 8055
diff changeset
1553 whereas the body of the stem is between the baseline and this value. For
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents: 8055
diff changeset
1554 example
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents: 8055
diff changeset
1555
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents: 8055
diff changeset
1556 @example
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents: 8055
diff changeset
1557 @group
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents: 8055
diff changeset
1558 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
1559 get (h, "xdata")
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents: 8055
diff changeset
1560 @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
1561 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
1562 @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
1563 @end group
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents: 8055
diff changeset
1564 @end example
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents: 8055
diff changeset
1565
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents: 8055
diff changeset
1566 @noindent
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents: 8055
diff changeset
1567 shows the the difference between the @code{xdata} of the @code{hggroup}
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents: 8055
diff changeset
1568 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
1569
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents: 8055
diff changeset
1570 The basic properties of such group objects is that they consist of one
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents: 8055
diff changeset
1571 or more linked @code{hggroup}, and that changes in certain properties of
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents: 8055
diff changeset
1572 these groups are propagated to other members of the group. Whereas,
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents: 8055
diff changeset
1573 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
1574 member.
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents: 8055
diff changeset
1575
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents: 8055
diff changeset
1576 In addition the members of the group can also be linked to other
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents: 8055
diff changeset
1577 graphics objects through callback functions. For example the baseline of
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents: 8055
diff changeset
1578 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
1579 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
1580 corresponding hggroup elements.
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents: 8055
diff changeset
1581
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents: 8055
diff changeset
1582 @menu
8070
3b53b25e2550 Add data sources and line series
David Bateman <dbateman@free.fr>
parents: 8057
diff changeset
1583 * Data sources in object groups::
8056
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents: 8055
diff changeset
1584 * Area series::
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents: 8055
diff changeset
1585 * Bar series::
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents: 8055
diff changeset
1586 * Contour groups::
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents: 8055
diff changeset
1587 * Error bar series::
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents: 8055
diff changeset
1588 * Line series::
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents: 8055
diff changeset
1589 * Quiver group::
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents: 8055
diff changeset
1590 * Scatter group::
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents: 8055
diff changeset
1591 * Stair group::
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents: 8055
diff changeset
1592 * Stem Series::
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents: 8055
diff changeset
1593 * Surface group::
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents: 8055
diff changeset
1594 @end menu
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents: 8055
diff changeset
1595
8070
3b53b25e2550 Add data sources and line series
David Bateman <dbateman@free.fr>
parents: 8057
diff changeset
1596 @node Data sources in object groups
3b53b25e2550 Add data sources and line series
David Bateman <dbateman@free.fr>
parents: 8057
diff changeset
1597 @subsubsection Data sources in object groups
8071
b6e85fb238c1 doc fixes
John W. Eaton <jwe@octave.org>
parents: 8070
diff changeset
1598 @cindex data sources in object groups
8070
3b53b25e2550 Add data sources and line series
David Bateman <dbateman@free.fr>
parents: 8057
diff changeset
1599
3b53b25e2550 Add data sources and line series
David Bateman <dbateman@free.fr>
parents: 8057
diff changeset
1600 All of the group objects contain data source parameters. There are
3b53b25e2550 Add data sources and line series
David Bateman <dbateman@free.fr>
parents: 8057
diff changeset
1601 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
1602 the relevant data property of the group when the @code{refreshdata}
3b53b25e2550 Add data sources and line series
David Bateman <dbateman@free.fr>
parents: 8057
diff changeset
1603 function is called.
3b53b25e2550 Add data sources and line series
David Bateman <dbateman@free.fr>
parents: 8057
diff changeset
1604
3b53b25e2550 Add data sources and line series
David Bateman <dbateman@free.fr>
parents: 8057
diff changeset
1605 @DOCSTRING(refreshdata)
3b53b25e2550 Add data sources and line series
David Bateman <dbateman@free.fr>
parents: 8057
diff changeset
1606
3b53b25e2550 Add data sources and line series
David Bateman <dbateman@free.fr>
parents: 8057
diff changeset
1607 @c add the description of the linkdata function here when it is written
3b53b25e2550 Add data sources and line series
David Bateman <dbateman@free.fr>
parents: 8057
diff changeset
1608
8056
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents: 8055
diff changeset
1609 @node Area series
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents: 8055
diff changeset
1610 @subsubsection Area series
8071
b6e85fb238c1 doc fixes
John W. Eaton <jwe@octave.org>
parents: 8070
diff changeset
1611 @cindex series objects
b6e85fb238c1 doc fixes
John W. Eaton <jwe@octave.org>
parents: 8070
diff changeset
1612 @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
1613
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents: 8055
diff changeset
1614 Area series objects are created by the @code{area} function. Each of the
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents: 8055
diff changeset
1615 @code{hggroup} elements contains a single patch object. The properties
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents: 8055
diff changeset
1616 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
1617
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents: 8055
diff changeset
1618 @table @code
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents: 8055
diff changeset
1619 @item basevalue
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents: 8055
diff changeset
1620 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
1621
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents: 8055
diff changeset
1622 @item linewidth
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents: 8055
diff changeset
1623 @itemx linestyle
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents: 8055
diff changeset
1624 The line width and style of the edge of the patch objects making up the
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents: 8055
diff changeset
1625 areas. @xref{Line Styles}.
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents: 8055
diff changeset
1626
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents: 8055
diff changeset
1627 @item edgecolor
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents: 8055
diff changeset
1628 @itemx facecolor
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents: 8055
diff changeset
1629 The line and fill color of the patch objects making up the areas. @xref{Colors}.
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents: 8055
diff changeset
1630
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents: 8055
diff changeset
1631 @item xdata
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents: 8055
diff changeset
1632 @itemx ydata
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents: 8055
diff changeset
1633 The x and y coordinates of the original columns of the data passed to
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents: 8055
diff changeset
1634 @code{area} prior to the cummulative summation used in the @code{area}
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents: 8055
diff changeset
1635 function.
8070
3b53b25e2550 Add data sources and line series
David Bateman <dbateman@free.fr>
parents: 8057
diff changeset
1636
3b53b25e2550 Add data sources and line series
David Bateman <dbateman@free.fr>
parents: 8057
diff changeset
1637 @item xdatasource
3b53b25e2550 Add data sources and line series
David Bateman <dbateman@free.fr>
parents: 8057
diff changeset
1638 @itemx ydatasource
3b53b25e2550 Add data sources and line series
David Bateman <dbateman@free.fr>
parents: 8057
diff changeset
1639 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
1640 @end table
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents: 8055
diff changeset
1641
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents: 8055
diff changeset
1642 @node Bar series
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents: 8055
diff changeset
1643 @subsubsection Bar series
8071
b6e85fb238c1 doc fixes
John W. Eaton <jwe@octave.org>
parents: 8070
diff changeset
1644 @cindex series objects
b6e85fb238c1 doc fixes
John W. Eaton <jwe@octave.org>
parents: 8070
diff changeset
1645 @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
1646
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents: 8055
diff changeset
1647 Bar series objects are created by the @code{bar} or @code{barh}
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents: 8055
diff changeset
1648 functions. Each @code{hgrroup} element contains a single patch object.
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents: 8055
diff changeset
1649 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
1650
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents: 8055
diff changeset
1651 @table @code
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents: 8055
diff changeset
1652 @item showbaseline
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents: 8055
diff changeset
1653 @itemx baseline
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents: 8055
diff changeset
1654 @itemx basevalue
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents: 8055
diff changeset
1655 The property @code{showbaseline} flags whether the baseline of the bar
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents: 8055
diff changeset
1656 series is displayed (default is "on"). The handle of the graphics object
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents: 8055
diff changeset
1657 representing the baseline is given by the @code{baseline} property and
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents: 8055
diff changeset
1658 the y-value of the baseline by the @code{basevalue} property.
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents: 8055
diff changeset
1659
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents: 8055
diff changeset
1660 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
1661 the bar series and to the baseline itself. Equally changes in the
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents: 8055
diff changeset
1662 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
1663 corresponding bar series.
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents: 8055
diff changeset
1664
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents: 8055
diff changeset
1665 @item barwidth
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents: 8055
diff changeset
1666 @itemx barlayout
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents: 8055
diff changeset
1667 @itemx horizontal
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents: 8055
diff changeset
1668 The property @code{barwidth} is the width of the bar corresponding to
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents: 8055
diff changeset
1669 the @var{width} variable passed to @code{bar} or @var{barh}. Whether the
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents: 8055
diff changeset
1670 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
1671 @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
1672 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
1673
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents: 8055
diff changeset
1674 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
1675 the bar series.
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents: 8055
diff changeset
1676
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents: 8055
diff changeset
1677 @item linewidth
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents: 8055
diff changeset
1678 @itemx linestyle
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents: 8055
diff changeset
1679 The line width and style of the edge of the patch objects making up the
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents: 8055
diff changeset
1680 bars. @xref{Line Styles}.
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents: 8055
diff changeset
1681
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents: 8055
diff changeset
1682 @item edgecolor
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents: 8055
diff changeset
1683 @itemx facecolor
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents: 8055
diff changeset
1684 The line and fill color of the patch objects making up the bars. @xref{Colors}.
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents: 8055
diff changeset
1685
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents: 8055
diff changeset
1686 @item xdata
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents: 8055
diff changeset
1687 The nominal x positions of the bars. Changes in this property and
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents: 8055
diff changeset
1688 propagated to the other members of the bar series.
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents: 8055
diff changeset
1689
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents: 8055
diff changeset
1690 @item ydata
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents: 8055
diff changeset
1691 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
1692
3b53b25e2550 Add data sources and line series
David Bateman <dbateman@free.fr>
parents: 8057
diff changeset
1693 @item xdatasource
3b53b25e2550 Add data sources and line series
David Bateman <dbateman@free.fr>
parents: 8057
diff changeset
1694 @itemx ydatasource
3b53b25e2550 Add data sources and line series
David Bateman <dbateman@free.fr>
parents: 8057
diff changeset
1695 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
1696 @end table
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents: 8055
diff changeset
1697
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents: 8055
diff changeset
1698 @node Contour groups
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents: 8055
diff changeset
1699 @subsubsection Contour groups
8071
b6e85fb238c1 doc fixes
John W. Eaton <jwe@octave.org>
parents: 8070
diff changeset
1700 @cindex series objects
b6e85fb238c1 doc fixes
John W. Eaton <jwe@octave.org>
parents: 8070
diff changeset
1701 @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
1702
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents: 8055
diff changeset
1703 TO BE WRITTEN
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents: 8055
diff changeset
1704
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents: 8055
diff changeset
1705 @node Error bar series
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents: 8055
diff changeset
1706 @subsubsection Error bar series
8071
b6e85fb238c1 doc fixes
John W. Eaton <jwe@octave.org>
parents: 8070
diff changeset
1707 @cindex series objects
b6e85fb238c1 doc fixes
John W. Eaton <jwe@octave.org>
parents: 8070
diff changeset
1708 @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
1709
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents: 8055
diff changeset
1710 TO BE WRITTEN
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents: 8055
diff changeset
1711
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents: 8055
diff changeset
1712 @node Line series
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents: 8055
diff changeset
1713 @subsubsection Line series
8071
b6e85fb238c1 doc fixes
John W. Eaton <jwe@octave.org>
parents: 8070
diff changeset
1714 @cindex series objects
b6e85fb238c1 doc fixes
John W. Eaton <jwe@octave.org>
parents: 8070
diff changeset
1715 @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
1716
8070
3b53b25e2550 Add data sources and line series
David Bateman <dbateman@free.fr>
parents: 8057
diff changeset
1717 line series objects are created by the @code{plot} and @code{plot3}
3b53b25e2550 Add data sources and line series
David Bateman <dbateman@free.fr>
parents: 8057
diff changeset
1718 functions. Each @code{hggroup} element of the series contains a single
3b53b25e2550 Add data sources and line series
David Bateman <dbateman@free.fr>
parents: 8057
diff changeset
1719 line object as a child representing the stair. The properties of the
3b53b25e2550 Add data sources and line series
David Bateman <dbateman@free.fr>
parents: 8057
diff changeset
1720 line series are a one-to-one reflection of the children line object, and
3b53b25e2550 Add data sources and line series
David Bateman <dbateman@free.fr>
parents: 8057
diff changeset
1721 so the line series is only useful for its ability to add data sources to
3b53b25e2550 Add data sources and line series
David Bateman <dbateman@free.fr>
parents: 8057
diff changeset
1722 the group object.
3b53b25e2550 Add data sources and line series
David Bateman <dbateman@free.fr>
parents: 8057
diff changeset
1723
3b53b25e2550 Add data sources and line series
David Bateman <dbateman@free.fr>
parents: 8057
diff changeset
1724 The properties of the line series are
3b53b25e2550 Add data sources and line series
David Bateman <dbateman@free.fr>
parents: 8057
diff changeset
1725
3b53b25e2550 Add data sources and line series
David Bateman <dbateman@free.fr>
parents: 8057
diff changeset
1726 @table @code
3b53b25e2550 Add data sources and line series
David Bateman <dbateman@free.fr>
parents: 8057
diff changeset
1727 @item color
3b53b25e2550 Add data sources and line series
David Bateman <dbateman@free.fr>
parents: 8057
diff changeset
1728 The RGB color or color name of the line objects of the stairs. @xref{Colors}.
3b53b25e2550 Add data sources and line series
David Bateman <dbateman@free.fr>
parents: 8057
diff changeset
1729
3b53b25e2550 Add data sources and line series
David Bateman <dbateman@free.fr>
parents: 8057
diff changeset
1730 @item linewidth
3b53b25e2550 Add data sources and line series
David Bateman <dbateman@free.fr>
parents: 8057
diff changeset
1731 @itemx linestyle
3b53b25e2550 Add data sources and line series
David Bateman <dbateman@free.fr>
parents: 8057
diff changeset
1732 The line width and style of the line objects of the stairs. @xref{Line Styles}.
3b53b25e2550 Add data sources and line series
David Bateman <dbateman@free.fr>
parents: 8057
diff changeset
1733
3b53b25e2550 Add data sources and line series
David Bateman <dbateman@free.fr>
parents: 8057
diff changeset
1734 @item marker
3b53b25e2550 Add data sources and line series
David Bateman <dbateman@free.fr>
parents: 8057
diff changeset
1735 @itemx markeredgecolor
3b53b25e2550 Add data sources and line series
David Bateman <dbateman@free.fr>
parents: 8057
diff changeset
1736 @itemx markerfacecolor
3b53b25e2550 Add data sources and line series
David Bateman <dbateman@free.fr>
parents: 8057
diff changeset
1737 @itemx markersize
3b53b25e2550 Add data sources and line series
David Bateman <dbateman@free.fr>
parents: 8057
diff changeset
1738 The line and fill color of the markers on the stairs. @xref{Colors}.
3b53b25e2550 Add data sources and line series
David Bateman <dbateman@free.fr>
parents: 8057
diff changeset
1739
3b53b25e2550 Add data sources and line series
David Bateman <dbateman@free.fr>
parents: 8057
diff changeset
1740 @item xdata
3b53b25e2550 Add data sources and line series
David Bateman <dbateman@free.fr>
parents: 8057
diff changeset
1741 @itemx ydata
3b53b25e2550 Add data sources and line series
David Bateman <dbateman@free.fr>
parents: 8057
diff changeset
1742 @itemx zdata
3b53b25e2550 Add data sources and line series
David Bateman <dbateman@free.fr>
parents: 8057
diff changeset
1743 The original x, y and z data of the stairs.
3b53b25e2550 Add data sources and line series
David Bateman <dbateman@free.fr>
parents: 8057
diff changeset
1744
3b53b25e2550 Add data sources and line series
David Bateman <dbateman@free.fr>
parents: 8057
diff changeset
1745 @item xdatasource
3b53b25e2550 Add data sources and line series
David Bateman <dbateman@free.fr>
parents: 8057
diff changeset
1746 @itemx ydatasource
3b53b25e2550 Add data sources and line series
David Bateman <dbateman@free.fr>
parents: 8057
diff changeset
1747 @itemx zdatasource
3b53b25e2550 Add data sources and line series
David Bateman <dbateman@free.fr>
parents: 8057
diff changeset
1748 Data source variables.
3b53b25e2550 Add data sources and line series
David Bateman <dbateman@free.fr>
parents: 8057
diff changeset
1749 @end table
8056
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents: 8055
diff changeset
1750
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents: 8055
diff changeset
1751 @node Quiver group
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents: 8055
diff changeset
1752 @subsubsection Quiver group
8071
b6e85fb238c1 doc fixes
John W. Eaton <jwe@octave.org>
parents: 8070
diff changeset
1753 @cindex group objects
b6e85fb238c1 doc fixes
John W. Eaton <jwe@octave.org>
parents: 8070
diff changeset
1754 @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
1755
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents: 8055
diff changeset
1756 Quiver series objects are created by the @code{quiver} or @code{quiver3}
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents: 8055
diff changeset
1757 functions. Each @code{hggroup} element of the series contains three line
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents: 8055
diff changeset
1758 objects as children representing the body and head of the arrow,
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents: 8055
diff changeset
1759 together with a marker as the point of original of the arrows. The
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents: 8055
diff changeset
1760 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
1761
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents: 8055
diff changeset
1762 @table @code
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents: 8055
diff changeset
1763 @item autoscale
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents: 8055
diff changeset
1764 @itemx autoscalefactor
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents: 8055
diff changeset
1765 Flag whether the length of the arrows is scaled or defined directly from
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents: 8055
diff changeset
1766 the @var{u}, @var{v} and @var{w} data. If the arrow length is falgged
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents: 8055
diff changeset
1767 as being scaled by the @code{autoscale} property, then the length of the
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents: 8055
diff changeset
1768 autoscaled arrow is controlled by the @code{autoscalefactor}.
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents: 8055
diff changeset
1769
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents: 8055
diff changeset
1770 @item maxheadsize
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents: 8055
diff changeset
1771 This property controls the size of the head of the arrows in the quiver
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents: 8055
diff changeset
1772 series. The default value is 0.2.
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents: 8055
diff changeset
1773
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents: 8055
diff changeset
1774 @item showarrowhead
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents: 8055
diff changeset
1775 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
1776
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents: 8055
diff changeset
1777 @item color
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents: 8055
diff changeset
1778 The RGB color or color name of the line objects of the quiver. @xref{Colors}.
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents: 8055
diff changeset
1779
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents: 8055
diff changeset
1780 @item linewidth
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents: 8055
diff changeset
1781 @itemx linestyle
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents: 8055
diff changeset
1782 The line width and style of the line objects of the quiver. @xref{Line Styles}.
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents: 8055
diff changeset
1783
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents: 8055
diff changeset
1784 @item marker
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents: 8055
diff changeset
1785 @itemx markerfacecolor
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents: 8055
diff changeset
1786 @itemx markersize
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents: 8055
diff changeset
1787 The line and fill color of the marker objects at the original of the
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents: 8055
diff changeset
1788 arrows. @xref{Colors}.
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents: 8055
diff changeset
1789
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents: 8055
diff changeset
1790 @item xdata
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents: 8055
diff changeset
1791 @itemx ydata
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents: 8055
diff changeset
1792 @itemx zdata
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents: 8055
diff changeset
1793 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
1794
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents: 8055
diff changeset
1795 @item udata
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents: 8055
diff changeset
1796 @itemx vdata
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents: 8055
diff changeset
1797 @itemx wdata
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents: 8055
diff changeset
1798 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
1799
3b53b25e2550 Add data sources and line series
David Bateman <dbateman@free.fr>
parents: 8057
diff changeset
1800 @item xdatasource
3b53b25e2550 Add data sources and line series
David Bateman <dbateman@free.fr>
parents: 8057
diff changeset
1801 @itemx ydatasource
3b53b25e2550 Add data sources and line series
David Bateman <dbateman@free.fr>
parents: 8057
diff changeset
1802 @itemx zdatasource
3b53b25e2550 Add data sources and line series
David Bateman <dbateman@free.fr>
parents: 8057
diff changeset
1803 @itemx udatasource
3b53b25e2550 Add data sources and line series
David Bateman <dbateman@free.fr>
parents: 8057
diff changeset
1804 @itemx vdatasource
3b53b25e2550 Add data sources and line series
David Bateman <dbateman@free.fr>
parents: 8057
diff changeset
1805 @itemx wdatasource
3b53b25e2550 Add data sources and line series
David Bateman <dbateman@free.fr>
parents: 8057
diff changeset
1806 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
1807 @end table
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents: 8055
diff changeset
1808
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents: 8055
diff changeset
1809 @node Scatter group
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents: 8055
diff changeset
1810 @subsubsection Scatter group
8071
b6e85fb238c1 doc fixes
John W. Eaton <jwe@octave.org>
parents: 8070
diff changeset
1811 @cindex group objects
b6e85fb238c1 doc fixes
John W. Eaton <jwe@octave.org>
parents: 8070
diff changeset
1812 @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
1813
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents: 8055
diff changeset
1814 TO BE WRITTEN
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents: 8055
diff changeset
1815
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents: 8055
diff changeset
1816 @node Stair group
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents: 8055
diff changeset
1817 @subsubsection Stair group
8071
b6e85fb238c1 doc fixes
John W. Eaton <jwe@octave.org>
parents: 8070
diff changeset
1818 @cindex group objects
b6e85fb238c1 doc fixes
John W. Eaton <jwe@octave.org>
parents: 8070
diff changeset
1819 @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
1820
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents: 8055
diff changeset
1821 Stair series objects are created by the @code{stair} function. Each
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents: 8055
diff changeset
1822 @code{hggroup} element of the series contains a single line object as a
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents: 8055
diff changeset
1823 child representing the stair. The properties of the stair series are
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents: 8055
diff changeset
1824
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents: 8055
diff changeset
1825 @table @code
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents: 8055
diff changeset
1826 @item color
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents: 8055
diff changeset
1827 The RGB color or color name of the line objects of the stairs. @xref{Colors}.
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents: 8055
diff changeset
1828
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents: 8055
diff changeset
1829 @item linewidth
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents: 8055
diff changeset
1830 @itemx linestyle
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents: 8055
diff changeset
1831 The line width and style of the line objects of the stairs. @xref{Line Styles}.
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents: 8055
diff changeset
1832
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents: 8055
diff changeset
1833 @item marker
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents: 8055
diff changeset
1834 @itemx markeredgecolor
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents: 8055
diff changeset
1835 @itemx markerfacecolor
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents: 8055
diff changeset
1836 @itemx markersize
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents: 8055
diff changeset
1837 The line and fill color of the markers on the stairs. @xref{Colors}.
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents: 8055
diff changeset
1838
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents: 8055
diff changeset
1839 @item xdata
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents: 8055
diff changeset
1840 @itemx ydata
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents: 8055
diff changeset
1841 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
1842
3b53b25e2550 Add data sources and line series
David Bateman <dbateman@free.fr>
parents: 8057
diff changeset
1843 @item xdatasource
3b53b25e2550 Add data sources and line series
David Bateman <dbateman@free.fr>
parents: 8057
diff changeset
1844 @itemx ydatasource
3b53b25e2550 Add data sources and line series
David Bateman <dbateman@free.fr>
parents: 8057
diff changeset
1845 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
1846 @end table
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents: 8055
diff changeset
1847
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents: 8055
diff changeset
1848 @node Surface group
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents: 8055
diff changeset
1849 @subsubsection Surface group
8071
b6e85fb238c1 doc fixes
John W. Eaton <jwe@octave.org>
parents: 8070
diff changeset
1850 @cindex group objects
b6e85fb238c1 doc fixes
John W. Eaton <jwe@octave.org>
parents: 8070
diff changeset
1851 @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
1852
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents: 8055
diff changeset
1853 TO BE WRITTEN
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents: 8055
diff changeset
1854
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents: 8055
diff changeset
1855 @node Graphics backends
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents: 8055
diff changeset
1856 @subsection Graphics backends
8071
b6e85fb238c1 doc fixes
John W. Eaton <jwe@octave.org>
parents: 8070
diff changeset
1857 @cindex graphics backends
b6e85fb238c1 doc fixes
John W. Eaton <jwe@octave.org>
parents: 8070
diff changeset
1858 @cindex backends, graphics
8056
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents: 8055
diff changeset
1859
8070
3b53b25e2550 Add data sources and line series
David Bateman <dbateman@free.fr>
parents: 8057
diff changeset
1860 @DOCSTRING(backends)
3b53b25e2550 Add data sources and line series
David Bateman <dbateman@free.fr>
parents: 8057
diff changeset
1861
8056
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents: 8055
diff changeset
1862 @DOCSTRING(available_backends)
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents: 8055
diff changeset
1863
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents: 8055
diff changeset
1864 @menu
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents: 8055
diff changeset
1865 * Interaction with gnuplot::
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents: 8055
diff changeset
1866 @end menu
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents: 8055
diff changeset
1867
4167
aae05d51353c [project @ 2002-11-12 02:52:50 by jwe]
jwe
parents: 3439
diff changeset
1868 @node Interaction with gnuplot
8056
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents: 8055
diff changeset
1869 @subsubsection Interaction with @code{gnuplot}
8071
b6e85fb238c1 doc fixes
John W. Eaton <jwe@octave.org>
parents: 8070
diff changeset
1870 @cindex gnuplot interaction
3428
5b77cf82393c [project @ 2000-01-14 02:54:53 by jwe]
jwe
parents: 3368
diff changeset
1871
5b77cf82393c [project @ 2000-01-14 02:54:53 by jwe]
jwe
parents: 3368
diff changeset
1872 @DOCSTRING(gnuplot_binary)
5b77cf82393c [project @ 2000-01-14 02:54:53 by jwe]
jwe
parents: 3368
diff changeset
1873
6331
9e3e58d914ca [project @ 2007-02-20 08:00:34 by jwe]
jwe
parents: 5775
diff changeset
1874 @DOCSTRING(gnuplot_use_title_option)
8056
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents: 8055
diff changeset
1875