annotate doc/interpreter/plot.txi @ 8519:68aa5abfd136

Trivial doc fixes
author sh@sh-laptop
date Thu, 15 Jan 2009 00:28:42 -0500
parents f34ab2b433e8
children 03b7f618ab3d
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
8347
fa78cb8d8a5c corrections for typos
Brian Gough<bjg@network-theory.co.uk>
parents: 8325
diff changeset
121 @code{loglogerr} functions produce plots with error bar markers. For
6888
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
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
8429
f34ab2b433e8 One word missing from int8 help string.
Francesco Potortì <pot@gnu.org>
parents: 8428
diff changeset
175 plot and various other axis properties, such as the aspect ratio and the
f34ab2b433e8 One word missing from int8 help string.
Francesco Potortì <pot@gnu.org>
parents: 8428
diff changeset
176 appearance of tic marks.
6888
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
177
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
178 @DOCSTRING(axis)
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
179
7189
e8d953d03f6a [project @ 2007-11-26 20:42:09 by dbateman]
dbateman
parents: 7153
diff changeset
180 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
181 function.
e8d953d03f6a [project @ 2007-11-26 20:42:09 by dbateman]
dbateman
parents: 7153
diff changeset
182
e8d953d03f6a [project @ 2007-11-26 20:42:09 by dbateman]
dbateman
parents: 7153
diff changeset
183 @DOCSTRING(caxis)
e8d953d03f6a [project @ 2007-11-26 20:42:09 by dbateman]
dbateman
parents: 7153
diff changeset
184
7989
23c248d415b5 Various doc fixes. Readd cellidx
David Bateman <dbateman@free.fr>
parents: 7984
diff changeset
185 @menu
23c248d415b5 Various doc fixes. Readd cellidx
David Bateman <dbateman@free.fr>
parents: 7984
diff changeset
186 * Two-dimensional Function Plotting::
23c248d415b5 Various doc fixes. Readd cellidx
David Bateman <dbateman@free.fr>
parents: 7984
diff changeset
187 @end menu
23c248d415b5 Various doc fixes. Readd cellidx
David Bateman <dbateman@free.fr>
parents: 7984
diff changeset
188
7984
bbaa5d7d0143 Some documentation updates
David Bateman <dbateman@free.fr>
parents: 7981
diff changeset
189 @node Two-dimensional Function Plotting
bbaa5d7d0143 Some documentation updates
David Bateman <dbateman@free.fr>
parents: 7981
diff changeset
190 @subsubsection Two-dimensional Function Plotting
bbaa5d7d0143 Some documentation updates
David Bateman <dbateman@free.fr>
parents: 7981
diff changeset
191
bbaa5d7d0143 Some documentation updates
David Bateman <dbateman@free.fr>
parents: 7981
diff changeset
192 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
193 string defining the function without the user needing to explicitly
bbaa5d7d0143 Some documentation updates
David Bateman <dbateman@free.fr>
parents: 7981
diff changeset
194 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
195 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
196 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
197 example,
bbaa5d7d0143 Some documentation updates
David Bateman <dbateman@free.fr>
parents: 7981
diff changeset
198
bbaa5d7d0143 Some documentation updates
David Bateman <dbateman@free.fr>
parents: 7981
diff changeset
199 @example
bbaa5d7d0143 Some documentation updates
David Bateman <dbateman@free.fr>
parents: 7981
diff changeset
200 @group
bbaa5d7d0143 Some documentation updates
David Bateman <dbateman@free.fr>
parents: 7981
diff changeset
201 fplot (@@sin, [-10, 10], 201);
bbaa5d7d0143 Some documentation updates
David Bateman <dbateman@free.fr>
parents: 7981
diff changeset
202 @end group
bbaa5d7d0143 Some documentation updates
David Bateman <dbateman@free.fr>
parents: 7981
diff changeset
203 @end example
bbaa5d7d0143 Some documentation updates
David Bateman <dbateman@free.fr>
parents: 7981
diff changeset
204
bbaa5d7d0143 Some documentation updates
David Bateman <dbateman@free.fr>
parents: 7981
diff changeset
205 @noindent
bbaa5d7d0143 Some documentation updates
David Bateman <dbateman@free.fr>
parents: 7981
diff changeset
206 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
207 legend displaying the name of the plotted function.
bbaa5d7d0143 Some documentation updates
David Bateman <dbateman@free.fr>
parents: 7981
diff changeset
208
bbaa5d7d0143 Some documentation updates
David Bateman <dbateman@free.fr>
parents: 7981
diff changeset
209 @DOCSTRING(fplot)
bbaa5d7d0143 Some documentation updates
David Bateman <dbateman@free.fr>
parents: 7981
diff changeset
210
bbaa5d7d0143 Some documentation updates
David Bateman <dbateman@free.fr>
parents: 7981
diff changeset
211 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
212 function include @code{ezplot}, @code{ezcontour}, @code{ezcontourf} and
8046
c4482fc30c7f Add the ezplot function
David Bateman <dbateman@free.fr>
parents: 7989
diff changeset
213 @code{ezpolar}.
c4482fc30c7f Add the ezplot function
David Bateman <dbateman@free.fr>
parents: 7989
diff changeset
214
c4482fc30c7f Add the ezplot function
David Bateman <dbateman@free.fr>
parents: 7989
diff changeset
215 @DOCSTRING(ezplot)
7984
bbaa5d7d0143 Some documentation updates
David Bateman <dbateman@free.fr>
parents: 7981
diff changeset
216
bbaa5d7d0143 Some documentation updates
David Bateman <dbateman@free.fr>
parents: 7981
diff changeset
217 @DOCSTRING(ezcontour)
bbaa5d7d0143 Some documentation updates
David Bateman <dbateman@free.fr>
parents: 7981
diff changeset
218
bbaa5d7d0143 Some documentation updates
David Bateman <dbateman@free.fr>
parents: 7981
diff changeset
219 @DOCSTRING(ezcontourf)
bbaa5d7d0143 Some documentation updates
David Bateman <dbateman@free.fr>
parents: 7981
diff changeset
220
bbaa5d7d0143 Some documentation updates
David Bateman <dbateman@free.fr>
parents: 7981
diff changeset
221 @DOCSTRING(ezpolar)
bbaa5d7d0143 Some documentation updates
David Bateman <dbateman@free.fr>
parents: 7981
diff changeset
222
5134
0309b6722ee9 [project @ 2005-02-08 20:17:55 by jwe]
jwe
parents: 5016
diff changeset
223 @node Three-Dimensional Plotting
6888
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
224 @subsection Three-Dimensional Plotting
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
225
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
226 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
227
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
228 @example
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
229 @group
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
230 tx = ty = linspace (-8, 8, 41)';
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
231 [xx, yy] = meshgrid (tx, ty);
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
232 r = sqrt (xx .^ 2 + yy .^ 2) + eps;
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
233 tz = sin (r) ./ r;
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
234 mesh (tx, ty, tz);
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
235 @end group
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
236 @end example
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
237
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
238 @noindent
6899
110c5782fe3b [project @ 2007-09-14 15:17:53 by jwe]
jwe
parents: 6892
diff changeset
239 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
240 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
241 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
242 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
243
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
244 @float Figure,fig:mesh
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
245 @image{mesh,8cm}
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
246 @caption{Mesh plot.}
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
247 @end float
5134
0309b6722ee9 [project @ 2005-02-08 20:17:55 by jwe]
jwe
parents: 5016
diff changeset
248
6888
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
249 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
250 plot of contours for the surface.
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
251
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
252 The @code{plot3} function displays arbitrary three-dimensional data,
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
253 without requiring it to form a surface. For example
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
254
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
255 @example
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
256 @group
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
257 t = 0:0.1:10*pi;
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
258 r = linspace (0, 1, numel (t));
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
259 z = linspace (0, 1, numel (t));
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
260 plot3 (r.*sin(t), r.*cos(t), z);
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
261 @end group
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
262 @end example
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
263
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
264 @noindent
6899
110c5782fe3b [project @ 2007-09-14 15:17:53 by jwe]
jwe
parents: 6892
diff changeset
265 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
266
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
267 @float Figure,fig:plot3
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
268 @image{plot3,8cm}
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
269 @caption{Three dimensional spiral.}
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
270 @end float
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
271
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
272 Finally, the @code{view} function changes the viewpoint for
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
273 three-dimensional plots.
5134
0309b6722ee9 [project @ 2005-02-08 20:17:55 by jwe]
jwe
parents: 5016
diff changeset
274
0309b6722ee9 [project @ 2005-02-08 20:17:55 by jwe]
jwe
parents: 5016
diff changeset
275 @DOCSTRING(mesh)
0309b6722ee9 [project @ 2005-02-08 20:17:55 by jwe]
jwe
parents: 5016
diff changeset
276
6788
c81a0f3f5a82 [project @ 2007-07-23 22:05:29 by dbateman]
dbateman
parents: 6778
diff changeset
277 @DOCSTRING(meshc)
c81a0f3f5a82 [project @ 2007-07-23 22:05:29 by dbateman]
dbateman
parents: 6778
diff changeset
278
7153
4246642e9f48 [project @ 2007-11-09 21:20:07 by dbateman]
dbateman
parents: 7120
diff changeset
279 @DOCSTRING(hidden)
4246642e9f48 [project @ 2007-11-09 21:20:07 by dbateman]
dbateman
parents: 7120
diff changeset
280
7120
a2174fb073d4 [project @ 2007-11-07 21:26:43 by jwe]
jwe
parents: 7018
diff changeset
281 @DOCSTRING(surf)
a2174fb073d4 [project @ 2007-11-07 21:26:43 by jwe]
jwe
parents: 7018
diff changeset
282
a2174fb073d4 [project @ 2007-11-07 21:26:43 by jwe]
jwe
parents: 7018
diff changeset
283 @DOCSTRING(surfc)
a2174fb073d4 [project @ 2007-11-07 21:26:43 by jwe]
jwe
parents: 7018
diff changeset
284
5134
0309b6722ee9 [project @ 2005-02-08 20:17:55 by jwe]
jwe
parents: 5016
diff changeset
285 @DOCSTRING(meshgrid)
0309b6722ee9 [project @ 2005-02-08 20:17:55 by jwe]
jwe
parents: 5016
diff changeset
286
6550
1b7a6061a05d [project @ 2007-04-20 07:40:26 by jwe]
jwe
parents: 6549
diff changeset
287 @DOCSTRING(ndgrid)
1b7a6061a05d [project @ 2007-04-20 07:40:26 by jwe]
jwe
parents: 6549
diff changeset
288
6888
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
289 @DOCSTRING(plot3)
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
290
6502
6ab0a8767780 [project @ 2007-04-06 03:32:06 by jwe]
jwe
parents: 6331
diff changeset
291 @DOCSTRING(view)
6ab0a8767780 [project @ 2007-04-06 03:32:06 by jwe]
jwe
parents: 6331
diff changeset
292
7120
a2174fb073d4 [project @ 2007-11-07 21:26:43 by jwe]
jwe
parents: 7018
diff changeset
293 @DOCSTRING(shading)
a2174fb073d4 [project @ 2007-11-07 21:26:43 by jwe]
jwe
parents: 7018
diff changeset
294
7989
23c248d415b5 Various doc fixes. Readd cellidx
David Bateman <dbateman@free.fr>
parents: 7984
diff changeset
295 @menu
23c248d415b5 Various doc fixes. Readd cellidx
David Bateman <dbateman@free.fr>
parents: 7984
diff changeset
296 * Three-dimensional Function Plotting::
23c248d415b5 Various doc fixes. Readd cellidx
David Bateman <dbateman@free.fr>
parents: 7984
diff changeset
297 @end menu
23c248d415b5 Various doc fixes. Readd cellidx
David Bateman <dbateman@free.fr>
parents: 7984
diff changeset
298
23c248d415b5 Various doc fixes. Readd cellidx
David Bateman <dbateman@free.fr>
parents: 7984
diff changeset
299 @node Three-dimensional Function Plotting
23c248d415b5 Various doc fixes. Readd cellidx
David Bateman <dbateman@free.fr>
parents: 7984
diff changeset
300 @subsubsection Three-dimensional Function Plotting
7984
bbaa5d7d0143 Some documentation updates
David Bateman <dbateman@free.fr>
parents: 7981
diff changeset
301
bbaa5d7d0143 Some documentation updates
David Bateman <dbateman@free.fr>
parents: 7981
diff changeset
302 @DOCSTRING(ezplot3)
bbaa5d7d0143 Some documentation updates
David Bateman <dbateman@free.fr>
parents: 7981
diff changeset
303
bbaa5d7d0143 Some documentation updates
David Bateman <dbateman@free.fr>
parents: 7981
diff changeset
304 @DOCSTRING(ezmesh)
bbaa5d7d0143 Some documentation updates
David Bateman <dbateman@free.fr>
parents: 7981
diff changeset
305
bbaa5d7d0143 Some documentation updates
David Bateman <dbateman@free.fr>
parents: 7981
diff changeset
306 @DOCSTRING(ezmeshc)
bbaa5d7d0143 Some documentation updates
David Bateman <dbateman@free.fr>
parents: 7981
diff changeset
307
bbaa5d7d0143 Some documentation updates
David Bateman <dbateman@free.fr>
parents: 7981
diff changeset
308 @DOCSTRING(ezsurf)
bbaa5d7d0143 Some documentation updates
David Bateman <dbateman@free.fr>
parents: 7981
diff changeset
309
bbaa5d7d0143 Some documentation updates
David Bateman <dbateman@free.fr>
parents: 7981
diff changeset
310 @DOCSTRING(ezsurfc)
bbaa5d7d0143 Some documentation updates
David Bateman <dbateman@free.fr>
parents: 7981
diff changeset
311
6888
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
312 @node Plot Annotations
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
313 @subsection Plot Annotations
6502
6ab0a8767780 [project @ 2007-04-06 03:32:06 by jwe]
jwe
parents: 6331
diff changeset
314
6888
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
315 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
316 existing plot. For example,
6877
ab11bdb09820 [project @ 2007-09-07 05:12:32 by jwe]
jwe
parents: 6788
diff changeset
317
6888
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
318 @example
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
319 @group
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
320 x = -10:0.1:10;
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
321 plot (x, sin (x));
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
322 title ("sin(x) for x = -10:0.1:10");
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
323 xlabel ("x");
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
324 ylabel ("sin (x)");
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
325 text (pi, 0.7, "arbitrary text");
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
326 legend ("sin (x)");
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
327 @end group
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
328 @end example
6502
6ab0a8767780 [project @ 2007-04-06 03:32:06 by jwe]
jwe
parents: 6331
diff changeset
329
6888
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
330 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
331 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
332 border lines are on.
5134
0309b6722ee9 [project @ 2005-02-08 20:17:55 by jwe]
jwe
parents: 5016
diff changeset
333
0309b6722ee9 [project @ 2005-02-08 20:17:55 by jwe]
jwe
parents: 5016
diff changeset
334 @DOCSTRING(title)
0309b6722ee9 [project @ 2005-02-08 20:17:55 by jwe]
jwe
parents: 5016
diff changeset
335
6502
6ab0a8767780 [project @ 2007-04-06 03:32:06 by jwe]
jwe
parents: 6331
diff changeset
336 @DOCSTRING(legend)
6ab0a8767780 [project @ 2007-04-06 03:32:06 by jwe]
jwe
parents: 6331
diff changeset
337
6ab0a8767780 [project @ 2007-04-06 03:32:06 by jwe]
jwe
parents: 6331
diff changeset
338 @DOCSTRING(text)
6ab0a8767780 [project @ 2007-04-06 03:32:06 by jwe]
jwe
parents: 6331
diff changeset
339
8428
ee1bc8aa226b Add cross reference from Plot Annotations to Text Properties.
Francesco Potortì <pot@gnu.org>
parents: 8347
diff changeset
340 See @ref{Text Properties} for the properties that you can set.
ee1bc8aa226b Add cross reference from Plot Annotations to Text Properties.
Francesco Potortì <pot@gnu.org>
parents: 8347
diff changeset
341
8286
6f2d95255911 fix @seealso references to point to existing anchors
Thorsten Meyer <thorsten.meyier@gmx.de>
parents: 8261
diff changeset
342 @anchor{doc-ylabel}
6f2d95255911 fix @seealso references to point to existing anchors
Thorsten Meyer <thorsten.meyier@gmx.de>
parents: 8261
diff changeset
343 @anchor{doc-zlabel}
5134
0309b6722ee9 [project @ 2005-02-08 20:17:55 by jwe]
jwe
parents: 5016
diff changeset
344 @DOCSTRING(xlabel)
0309b6722ee9 [project @ 2005-02-08 20:17:55 by jwe]
jwe
parents: 5016
diff changeset
345
6502
6ab0a8767780 [project @ 2007-04-06 03:32:06 by jwe]
jwe
parents: 6331
diff changeset
346 @DOCSTRING(box)
6ab0a8767780 [project @ 2007-04-06 03:32:06 by jwe]
jwe
parents: 6331
diff changeset
347
6ab0a8767780 [project @ 2007-04-06 03:32:06 by jwe]
jwe
parents: 6331
diff changeset
348 @DOCSTRING(grid)
6ab0a8767780 [project @ 2007-04-06 03:32:06 by jwe]
jwe
parents: 6331
diff changeset
349
8089
0ec09255515a add colorbar docstring to the manual
John W. Eaton <jwe@octave.org>
parents: 8073
diff changeset
350 @DOCSTRING(colorbar)
0ec09255515a add colorbar docstring to the manual
John W. Eaton <jwe@octave.org>
parents: 8073
diff changeset
351
5134
0309b6722ee9 [project @ 2005-02-08 20:17:55 by jwe]
jwe
parents: 5016
diff changeset
352 @node Multiple Plots on One Page
6888
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
353 @subsection Multiple Plots on One Page
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
354
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
355 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
356 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
357 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
358 For example,
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
359
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
360 @example
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
361 @group
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
362 subplot (2, 1, 1)
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
363 fplot (@@sin, [-10, 10]);
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
364 subplot (2, 1, 2)
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
365 fplot (@@cos, [-10, 10]);
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
366 @end group
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
367 @end example
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
368
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
369 @noindent
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
370 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
371 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
372 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
373 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
374 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
375
0309b6722ee9 [project @ 2005-02-08 20:17:55 by jwe]
jwe
parents: 5016
diff changeset
376 @DOCSTRING(subplot)
0309b6722ee9 [project @ 2005-02-08 20:17:55 by jwe]
jwe
parents: 5016
diff changeset
377
0309b6722ee9 [project @ 2005-02-08 20:17:55 by jwe]
jwe
parents: 5016
diff changeset
378 @node Multiple Plot Windows
6888
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
379 @subsection Multiple Plot Windows
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
380
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
381 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
382 For 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 @example
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
385 figure (1);
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
386 fplot (@@sin, [-10, 10]);
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
387 figure (2);
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
388 fplot (@@cos, [-10, 10]);
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
389 @end example
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
390
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
391 @noindent
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
392 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
393 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
394
0309b6722ee9 [project @ 2005-02-08 20:17:55 by jwe]
jwe
parents: 5016
diff changeset
395 @DOCSTRING(figure)
0309b6722ee9 [project @ 2005-02-08 20:17:55 by jwe]
jwe
parents: 5016
diff changeset
396
6502
6ab0a8767780 [project @ 2007-04-06 03:32:06 by jwe]
jwe
parents: 6331
diff changeset
397 @node Printing Plots
6888
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
398 @subsection Printing Plots
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 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
401 formats. For example,
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
402
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
403 @example
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
404 print -deps foo.eps
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
405 @end example
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
406
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
407 @noindent
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
408 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
409 @file{foo.eps}.
6502
6ab0a8767780 [project @ 2007-04-06 03:32:06 by jwe]
jwe
parents: 6331
diff changeset
410
6ab0a8767780 [project @ 2007-04-06 03:32:06 by jwe]
jwe
parents: 6331
diff changeset
411 @DOCSTRING(print)
6ab0a8767780 [project @ 2007-04-06 03:32:06 by jwe]
jwe
parents: 6331
diff changeset
412
6ab0a8767780 [project @ 2007-04-06 03:32:06 by jwe]
jwe
parents: 6331
diff changeset
413 @DOCSTRING(orient)
5134
0309b6722ee9 [project @ 2005-02-08 20:17:55 by jwe]
jwe
parents: 5016
diff changeset
414
7984
bbaa5d7d0143 Some documentation updates
David Bateman <dbateman@free.fr>
parents: 7981
diff changeset
415 @node Interacting with plots
bbaa5d7d0143 Some documentation updates
David Bateman <dbateman@free.fr>
parents: 7981
diff changeset
416 @subsection Interacting with plots
bbaa5d7d0143 Some documentation updates
David Bateman <dbateman@free.fr>
parents: 7981
diff changeset
417
bbaa5d7d0143 Some documentation updates
David Bateman <dbateman@free.fr>
parents: 7981
diff changeset
418 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
419 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
420 @code{gtext} function using the mouse.
bbaa5d7d0143 Some documentation updates
David Bateman <dbateman@free.fr>
parents: 7981
diff changeset
421
bbaa5d7d0143 Some documentation updates
David Bateman <dbateman@free.fr>
parents: 7981
diff changeset
422 @DOCSTRING(ginput)
bbaa5d7d0143 Some documentation updates
David Bateman <dbateman@free.fr>
parents: 7981
diff changeset
423
bbaa5d7d0143 Some documentation updates
David Bateman <dbateman@free.fr>
parents: 7981
diff changeset
424 @DOCSTRING(waitforbuttonpress)
bbaa5d7d0143 Some documentation updates
David Bateman <dbateman@free.fr>
parents: 7981
diff changeset
425
bbaa5d7d0143 Some documentation updates
David Bateman <dbateman@free.fr>
parents: 7981
diff changeset
426 @DOCSTRING(gtext)
bbaa5d7d0143 Some documentation updates
David Bateman <dbateman@free.fr>
parents: 7981
diff changeset
427
6788
c81a0f3f5a82 [project @ 2007-07-23 22:05:29 by dbateman]
dbateman
parents: 6778
diff changeset
428 @node Test Plotting Functions
6888
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
429 @subsection Test Plotting Functions
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
430
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
431 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
432 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
433 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
434
6877
ab11bdb09820 [project @ 2007-09-07 05:12:32 by jwe]
jwe
parents: 6788
diff changeset
435 @DOCSTRING(sombrero)
ab11bdb09820 [project @ 2007-09-07 05:12:32 by jwe]
jwe
parents: 6788
diff changeset
436
6788
c81a0f3f5a82 [project @ 2007-07-23 22:05:29 by dbateman]
dbateman
parents: 6778
diff changeset
437 @DOCSTRING(peaks)
c81a0f3f5a82 [project @ 2007-07-23 22:05:29 by dbateman]
dbateman
parents: 6778
diff changeset
438
6888
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
439 @node Advanced Plotting
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
440 @section Advanced Plotting
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
441
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
442 @menu
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
443 * Graphics Objects::
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
444 * Graphics Object Properties::
6891
e9921bb3d95b [project @ 2007-09-13 02:44:27 by jwe]
jwe
parents: 6889
diff changeset
445 * Managing Default Properties::
6889
ebff56d6b0a8 [project @ 2007-09-12 18:32:12 by jwe]
jwe
parents: 6888
diff changeset
446 * Colors::
ebff56d6b0a8 [project @ 2007-09-12 18:32:12 by jwe]
jwe
parents: 6888
diff changeset
447 * Line Styles::
ebff56d6b0a8 [project @ 2007-09-12 18:32:12 by jwe]
jwe
parents: 6888
diff changeset
448 * Marker Styles::
8056
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents: 8055
diff changeset
449 * Callbacks::
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents: 8055
diff changeset
450 * Object Groups::
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents: 8055
diff changeset
451 * Graphics backends::
6888
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
452 @end menu
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
453
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
454 @node Graphics Objects
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
455 @subsection Graphics Objects
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
456
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
457 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
458 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
459 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
460 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
461
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
462 @table @asis
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
463 @item root figure
8071
b6e85fb238c1 doc fixes
John W. Eaton <jwe@octave.org>
parents: 8070
diff changeset
464 @cindex root figure graphics object
b6e85fb238c1 doc fixes
John W. Eaton <jwe@octave.org>
parents: 8070
diff changeset
465 @cindex graphics object, root figure
6888
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
466 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
467 defined to be 0.
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
468
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
469 @item figure
8071
b6e85fb238c1 doc fixes
John W. Eaton <jwe@octave.org>
parents: 8070
diff changeset
470 @cindex figure graphics object
b6e85fb238c1 doc fixes
John W. Eaton <jwe@octave.org>
parents: 8070
diff changeset
471 @cindex graphics object, figure
6888
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
472 A figure window.
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
473
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
474 @item axes
8071
b6e85fb238c1 doc fixes
John W. Eaton <jwe@octave.org>
parents: 8070
diff changeset
475 @cindex axes graphics object
b6e85fb238c1 doc fixes
John W. Eaton <jwe@octave.org>
parents: 8070
diff changeset
476 @cindex graphics object, axes
6888
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
477 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
478 parent of line, text, image, patch, or surface objects.
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
479
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
480 @item line
8071
b6e85fb238c1 doc fixes
John W. Eaton <jwe@octave.org>
parents: 8070
diff changeset
481 @cindex line graphics object
b6e85fb238c1 doc fixes
John W. Eaton <jwe@octave.org>
parents: 8070
diff changeset
482 @cindex graphics object, line
6888
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
483 A line in two or three dimensions.
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
484
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
485 @item text
8071
b6e85fb238c1 doc fixes
John W. Eaton <jwe@octave.org>
parents: 8070
diff changeset
486 @cindex text graphics object
b6e85fb238c1 doc fixes
John W. Eaton <jwe@octave.org>
parents: 8070
diff changeset
487 @cindex graphics object, text
6888
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
488 Text annotations.
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
489
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
490 @item image
8071
b6e85fb238c1 doc fixes
John W. Eaton <jwe@octave.org>
parents: 8070
diff changeset
491 @cindex image graphics object
b6e85fb238c1 doc fixes
John W. Eaton <jwe@octave.org>
parents: 8070
diff changeset
492 @cindex graphics object, image
6888
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
493 A bitmap image.
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
494
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
495 @item patch
8071
b6e85fb238c1 doc fixes
John W. Eaton <jwe@octave.org>
parents: 8070
diff changeset
496 @cindex patch graphics object
b6e85fb238c1 doc fixes
John W. Eaton <jwe@octave.org>
parents: 8070
diff changeset
497 @cindex graphics object, patch
6888
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
498 A filled polygon, currently limited to two dimensions.
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
499
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
500 @item surface
8071
b6e85fb238c1 doc fixes
John W. Eaton <jwe@octave.org>
parents: 8070
diff changeset
501 @cindex surface graphics object
b6e85fb238c1 doc fixes
John W. Eaton <jwe@octave.org>
parents: 8070
diff changeset
502 @cindex graphics object, surface
6888
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
503 A three-dimensional surface.
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
504 @end table
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 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
507 index, use the functions @code{ishandle} and @code{isfigure}.
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
508
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
509 @DOCSTRING(ishandle)
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(isfigure)
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 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
514 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
515 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
516 none exists.
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 @DOCSTRING(gcf)
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
519
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
520 @DOCSTRING(gca)
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
521
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
522 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
523 properties for graphics objects. For example,
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
524
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
525 @example
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
526 @group
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
527 get (0)
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
528 @result{} ans =
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
529 @{
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
530 type = root figure
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
531 currentfigure = [](0x0)
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
532 children = [](0x0)
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
533 visible = on
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
534 @}
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
535 @end group
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
536 @end example
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
537
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
538 @noindent
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
539 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
540 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
541 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
542 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
543 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
544 there is no current figure window.
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
545
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
546 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
547 property. For 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 @example
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
550 @group
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
551 get (gca (), "xlim")
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
552 @result{} [ 0 1 ]
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
553 @end group
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
554 @end example
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
555
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
556 @noindent
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
557 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
558 current figure.
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
559
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
560 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
561
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
562 @example
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
563 set (gca (), "xlim", [-10, 10]);
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
564 @end 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 @noindent
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
567 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
568 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
569 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
570 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
571 example,
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
572
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
573 @example
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
574 set (gca ())
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
575 @end example
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
576
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
577 @noindent
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
578 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
579 objects.
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
580
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
581 @DOCSTRING(get)
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
582
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
583 @DOCSTRING(set)
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
584
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
585 @DOCSTRING(ancestor)
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
586
7984
bbaa5d7d0143 Some documentation updates
David Bateman <dbateman@free.fr>
parents: 7981
diff changeset
587 @DOCSTRING(allchild)
bbaa5d7d0143 Some documentation updates
David Bateman <dbateman@free.fr>
parents: 7981
diff changeset
588
6888
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
589 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
590 @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
591 become children of the current axes object.
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
592
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
593 @DOCSTRING(axes)
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
594
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
595 @DOCSTRING(line)
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
596
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
597 @DOCSTRING(patch)
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
598
7120
a2174fb073d4 [project @ 2007-11-07 21:26:43 by jwe]
jwe
parents: 7018
diff changeset
599 @DOCSTRING(surface)
a2174fb073d4 [project @ 2007-11-07 21:26:43 by jwe]
jwe
parents: 7018
diff changeset
600
6888
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
601 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
602 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
603 @code{drawnow} function.
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
604
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
605 @DOCSTRING(drawnow)
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
606
8070
3b53b25e2550 Add data sources and line series
David Bateman <dbateman@free.fr>
parents: 8057
diff changeset
607 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
608 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
609 it is nor modified.
3b53b25e2550 Add data sources and line series
David Bateman <dbateman@free.fr>
parents: 8057
diff changeset
610
3b53b25e2550 Add data sources and line series
David Bateman <dbateman@free.fr>
parents: 8057
diff changeset
611 @DOCSTRING(refresh)
3b53b25e2550 Add data sources and line series
David Bateman <dbateman@free.fr>
parents: 8057
diff changeset
612
6888
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
613 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
614 @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
615 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
616 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
617 function. For example,
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
618
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
619 @example
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
620 @group
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
621 hold ("on");
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
622 x = -10:0.1:10;
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
623 plot (x, sin (x));
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
624 plot (x, cos (x));
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
625 hold ("off");
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
626 @end group
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
627 @end example
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 @noindent
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
630 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
631 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
632 plot.
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
633
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
634 @DOCSTRING(newplot)
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
635
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
636 @DOCSTRING(hold)
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(ishold)
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
639
8286
6f2d95255911 fix @seealso references to point to existing anchors
Thorsten Meyer <thorsten.meyier@gmx.de>
parents: 8261
diff changeset
640 To clear the current figure, call the @code{clf} function. To clear the
6f2d95255911 fix @seealso references to point to existing anchors
Thorsten Meyer <thorsten.meyier@gmx.de>
parents: 8261
diff changeset
641 current axis, call the @code{cla} function. To bring the current fingure
6888
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
642 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
643 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
644 figure window, call the @code{close} function.
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(clf)
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
647
8286
6f2d95255911 fix @seealso references to point to existing anchors
Thorsten Meyer <thorsten.meyier@gmx.de>
parents: 8261
diff changeset
648 @DOCSTRING(cla)
6f2d95255911 fix @seealso references to point to existing anchors
Thorsten Meyer <thorsten.meyier@gmx.de>
parents: 8261
diff changeset
649
6888
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
650 @DOCSTRING(shg)
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 @DOCSTRING(delete)
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
653
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
654 @DOCSTRING(close)
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
655
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
656 @DOCSTRING(closereq)
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
657
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
658 @node Graphics Object Properties
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
659 @subsection Graphics Object Properties
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
660 @cindex graphics object properties
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
661
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
662 @menu
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
663 * Root Figure Properties::
6889
ebff56d6b0a8 [project @ 2007-09-12 18:32:12 by jwe]
jwe
parents: 6888
diff changeset
664 * Figure Properties::
6888
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
665 * Axes Properties::
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
666 * Line Properties::
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
667 * Text Properties::
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
668 * Image Properties::
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
669 * Patch Properties::
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
670 * Surface Properties::
8070
3b53b25e2550 Add data sources and line series
David Bateman <dbateman@free.fr>
parents: 8057
diff changeset
671 * Searching Properties::
6888
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
672 @end menu
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
673
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
674 @node Root Figure Properties
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
675 @subsubsection Root Figure Properties
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
676
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
677 @table @code
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
678 @item currentfigure
6889
ebff56d6b0a8 [project @ 2007-09-12 18:32:12 by jwe]
jwe
parents: 6888
diff changeset
679 Index to graphics object for the current figure.
ebff56d6b0a8 [project @ 2007-09-12 18:32:12 by jwe]
jwe
parents: 6888
diff changeset
680
ebff56d6b0a8 [project @ 2007-09-12 18:32:12 by jwe]
jwe
parents: 6888
diff changeset
681 @c FIXME -- does this work?
ebff56d6b0a8 [project @ 2007-09-12 18:32:12 by jwe]
jwe
parents: 6888
diff changeset
682 @c @item visible
ebff56d6b0a8 [project @ 2007-09-12 18:32:12 by jwe]
jwe
parents: 6888
diff changeset
683 @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
684 @end table
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
685
6889
ebff56d6b0a8 [project @ 2007-09-12 18:32:12 by jwe]
jwe
parents: 6888
diff changeset
686 @node Figure Properties
ebff56d6b0a8 [project @ 2007-09-12 18:32:12 by jwe]
jwe
parents: 6888
diff changeset
687 @subsubsection Figure Properties
8071
b6e85fb238c1 doc fixes
John W. Eaton <jwe@octave.org>
parents: 8070
diff changeset
688 @cindex figure properties
6888
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
689
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
690 @table @code
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
691 @item nextplot
6889
ebff56d6b0a8 [project @ 2007-09-12 18:32:12 by jwe]
jwe
parents: 6888
diff changeset
692 May be one of
ebff56d6b0a8 [project @ 2007-09-12 18:32:12 by jwe]
jwe
parents: 6888
diff changeset
693 @table @code
ebff56d6b0a8 [project @ 2007-09-12 18:32:12 by jwe]
jwe
parents: 6888
diff changeset
694 @item "new"
ebff56d6b0a8 [project @ 2007-09-12 18:32:12 by jwe]
jwe
parents: 6888
diff changeset
695 @item "add"
ebff56d6b0a8 [project @ 2007-09-12 18:32:12 by jwe]
jwe
parents: 6888
diff changeset
696 @item "replace"
ebff56d6b0a8 [project @ 2007-09-12 18:32:12 by jwe]
jwe
parents: 6888
diff changeset
697 @item "replacechildren"
ebff56d6b0a8 [project @ 2007-09-12 18:32:12 by jwe]
jwe
parents: 6888
diff changeset
698 @end table
ebff56d6b0a8 [project @ 2007-09-12 18:32:12 by jwe]
jwe
parents: 6888
diff changeset
699
6888
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
700 @item closerequestfcn
6889
ebff56d6b0a8 [project @ 2007-09-12 18:32:12 by jwe]
jwe
parents: 6888
diff changeset
701 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
702
6888
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
703 @item currentaxes
6889
ebff56d6b0a8 [project @ 2007-09-12 18:32:12 by jwe]
jwe
parents: 6888
diff changeset
704 Index to graphics object of current axes.
ebff56d6b0a8 [project @ 2007-09-12 18:32:12 by jwe]
jwe
parents: 6888
diff changeset
705
6888
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
706 @item colormap
6889
ebff56d6b0a8 [project @ 2007-09-12 18:32:12 by jwe]
jwe
parents: 6888
diff changeset
707 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
708
6888
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
709 @item visible
6889
ebff56d6b0a8 [project @ 2007-09-12 18:32:12 by jwe]
jwe
parents: 6888
diff changeset
710 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
711
6888
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
712 @item paperorientation
6889
ebff56d6b0a8 [project @ 2007-09-12 18:32:12 by jwe]
jwe
parents: 6888
diff changeset
713 Indicates the orientation for printing. Either @code{"landscape"} or
ebff56d6b0a8 [project @ 2007-09-12 18:32:12 by jwe]
jwe
parents: 6888
diff changeset
714 @code{"portrait"}.
6888
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
715 @end table
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
716
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
717 @node Axes Properties
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
718 @subsubsection Axes Properties
8071
b6e85fb238c1 doc fixes
John W. Eaton <jwe@octave.org>
parents: 8070
diff changeset
719 @cindex axes properties
6888
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
720
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
721 @table @code
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
722 @item position
8071
b6e85fb238c1 doc fixes
John W. Eaton <jwe@octave.org>
parents: 8070
diff changeset
723 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
724 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
725 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
726 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
727 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
728 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
729 the @code{outerposition} property.
6889
ebff56d6b0a8 [project @ 2007-09-12 18:32:12 by jwe]
jwe
parents: 6888
diff changeset
730
6888
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
731 @item title
6889
ebff56d6b0a8 [project @ 2007-09-12 18:32:12 by jwe]
jwe
parents: 6888
diff changeset
732 Index of text object for the axes title.
ebff56d6b0a8 [project @ 2007-09-12 18:32:12 by jwe]
jwe
parents: 6888
diff changeset
733
6888
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
734 @item box
6889
ebff56d6b0a8 [project @ 2007-09-12 18:32:12 by jwe]
jwe
parents: 6888
diff changeset
735 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
736 the axes.
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 key
6889
ebff56d6b0a8 [project @ 2007-09-12 18:32:12 by jwe]
jwe
parents: 6888
diff changeset
739 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
740 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
741 removed in a future version of Octave.
ebff56d6b0a8 [project @ 2007-09-12 18:32:12 by jwe]
jwe
parents: 6888
diff changeset
742
6888
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
743 @item keybox
6889
ebff56d6b0a8 [project @ 2007-09-12 18:32:12 by jwe]
jwe
parents: 6888
diff changeset
744 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
745 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
746 may be removed in a future version of Octave.
ebff56d6b0a8 [project @ 2007-09-12 18:32:12 by jwe]
jwe
parents: 6888
diff changeset
747
6888
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
748 @item keypos
6889
ebff56d6b0a8 [project @ 2007-09-12 18:32:12 by jwe]
jwe
parents: 6888
diff changeset
749 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
750 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
751 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
752 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
753 Octave.
ebff56d6b0a8 [project @ 2007-09-12 18:32:12 by jwe]
jwe
parents: 6888
diff changeset
754
6888
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
755 @item dataaspectratio
6889
ebff56d6b0a8 [project @ 2007-09-12 18:32:12 by jwe]
jwe
parents: 6888
diff changeset
756 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
757 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
758 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
759 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
760 @code{dataaspectratio} also forces the @code{dataaspectratiomode}
ebff56d6b0a8 [project @ 2007-09-12 18:32:12 by jwe]
jwe
parents: 6888
diff changeset
761 property to be set to @code{"manual"}.
ebff56d6b0a8 [project @ 2007-09-12 18:32:12 by jwe]
jwe
parents: 6888
diff changeset
762
6888
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
763 @item dataaspectratiomode
6889
ebff56d6b0a8 [project @ 2007-09-12 18:32:12 by jwe]
jwe
parents: 6888
diff changeset
764 Either @code{"manual"} or @code{"auto"}.
ebff56d6b0a8 [project @ 2007-09-12 18:32:12 by jwe]
jwe
parents: 6888
diff changeset
765
6888
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
766 @item xlim
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
767 @itemx ylim
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
768 @itemx zlim
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
769 @itemx clim
6889
ebff56d6b0a8 [project @ 2007-09-12 18:32:12 by jwe]
jwe
parents: 6888
diff changeset
770 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
771 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
772 property to be set to @code{"manual"}.
ebff56d6b0a8 [project @ 2007-09-12 18:32:12 by jwe]
jwe
parents: 6888
diff changeset
773
6888
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
774 @item xlimmode
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
775 @itemx ylimmode
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
776 @itemx zlimmode
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
777 @itemx climmode
6889
ebff56d6b0a8 [project @ 2007-09-12 18:32:12 by jwe]
jwe
parents: 6888
diff changeset
778 Either @code{"manual"} or @code{"auto"}.
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 xlabel
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
781 @itemx ylabel
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
782 @itemx zlabel
6889
ebff56d6b0a8 [project @ 2007-09-12 18:32:12 by jwe]
jwe
parents: 6888
diff changeset
783 Indices to text objects for the axes labels.
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 xgrid
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
786 @itemx ygrid
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
787 @itemx zgrid
6889
ebff56d6b0a8 [project @ 2007-09-12 18:32:12 by jwe]
jwe
parents: 6888
diff changeset
788 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
789
6888
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
790 @item xminorgrid
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
791 @itemx yminorgrid
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
792 @itemx zminorgrid
6889
ebff56d6b0a8 [project @ 2007-09-12 18:32:12 by jwe]
jwe
parents: 6888
diff changeset
793 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
794
6888
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
795 @item xtick
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
796 @itemx ytick
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
797 @itemx ztick
6889
ebff56d6b0a8 [project @ 2007-09-12 18:32:12 by jwe]
jwe
parents: 6888
diff changeset
798 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
799 property to be set to @code{"manual"}.
ebff56d6b0a8 [project @ 2007-09-12 18:32:12 by jwe]
jwe
parents: 6888
diff changeset
800
6888
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
801 @item xtickmode
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
802 @itemx ytickmode
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
803 @itemx ztickmode
6889
ebff56d6b0a8 [project @ 2007-09-12 18:32:12 by jwe]
jwe
parents: 6888
diff changeset
804 Either @code{"manual"} or @code{"auto"}.
ebff56d6b0a8 [project @ 2007-09-12 18:32:12 by jwe]
jwe
parents: 6888
diff changeset
805
6888
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
806 @item xticklabel
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
807 @itemx yticklabel
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
808 @itemx zticklabel
6889
ebff56d6b0a8 [project @ 2007-09-12 18:32:12 by jwe]
jwe
parents: 6888
diff changeset
809 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
810 property to be set to @code{"manual"}.
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 xticklabelmode
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
813 @itemx yticklabelmode
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
814 @itemx zticklabelmode
6889
ebff56d6b0a8 [project @ 2007-09-12 18:32:12 by jwe]
jwe
parents: 6888
diff changeset
815 Either @code{"manual"} or @code{"auto"}.
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 xscale
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
818 @itemx yscale
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
819 @itemx zscale
6889
ebff56d6b0a8 [project @ 2007-09-12 18:32:12 by jwe]
jwe
parents: 6888
diff changeset
820 Either @code{"linear"} or @code{"log"}.
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 xdir
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
823 @itemx ydir
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
824 @itemx zdir
6889
ebff56d6b0a8 [project @ 2007-09-12 18:32:12 by jwe]
jwe
parents: 6888
diff changeset
825 Either @code{"forward"} or @code{"reverse"}.
ebff56d6b0a8 [project @ 2007-09-12 18:32:12 by jwe]
jwe
parents: 6888
diff changeset
826
6888
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
827 @item xaxislocation
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
828 @itemx yaxislocation
6889
ebff56d6b0a8 [project @ 2007-09-12 18:32:12 by jwe]
jwe
parents: 6888
diff changeset
829 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
830 or @code{"right"} for the y axis.
ebff56d6b0a8 [project @ 2007-09-12 18:32:12 by jwe]
jwe
parents: 6888
diff changeset
831
6888
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
832 @item view
6889
ebff56d6b0a8 [project @ 2007-09-12 18:32:12 by jwe]
jwe
parents: 6888
diff changeset
833 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
834
6888
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
835 @item visible
6889
ebff56d6b0a8 [project @ 2007-09-12 18:32:12 by jwe]
jwe
parents: 6888
diff changeset
836 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
837
6888
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
838 @item nextplot
6889
ebff56d6b0a8 [project @ 2007-09-12 18:32:12 by jwe]
jwe
parents: 6888
diff changeset
839 May be one of
ebff56d6b0a8 [project @ 2007-09-12 18:32:12 by jwe]
jwe
parents: 6888
diff changeset
840 @table @code
ebff56d6b0a8 [project @ 2007-09-12 18:32:12 by jwe]
jwe
parents: 6888
diff changeset
841 @item "new"
ebff56d6b0a8 [project @ 2007-09-12 18:32:12 by jwe]
jwe
parents: 6888
diff changeset
842 @item "add"
ebff56d6b0a8 [project @ 2007-09-12 18:32:12 by jwe]
jwe
parents: 6888
diff changeset
843 @item "replace"
ebff56d6b0a8 [project @ 2007-09-12 18:32:12 by jwe]
jwe
parents: 6888
diff changeset
844 @item "replacechildren"
ebff56d6b0a8 [project @ 2007-09-12 18:32:12 by jwe]
jwe
parents: 6888
diff changeset
845 @end table
ebff56d6b0a8 [project @ 2007-09-12 18:32:12 by jwe]
jwe
parents: 6888
diff changeset
846
6888
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
847 @item outerposition
8071
b6e85fb238c1 doc fixes
John W. Eaton <jwe@octave.org>
parents: 8070
diff changeset
848 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
849 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
850 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
851 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
852 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
853 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
854 the @code{position} property.
6888
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
855 @end table
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
856
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
857 @node Line Properties
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
858 @subsubsection Line Properties
8071
b6e85fb238c1 doc fixes
John W. Eaton <jwe@octave.org>
parents: 8070
diff changeset
859 @cindex line properties
6888
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
860
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
861 @table @code
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
862 @itemx xdata
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
863 @itemx ydata
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
864 @itemx zdata
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
865 @itemx ldata
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
866 @itemx udata
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
867 @itemx xldata
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
868 @itemx xudata
6889
ebff56d6b0a8 [project @ 2007-09-12 18:32:12 by jwe]
jwe
parents: 6888
diff changeset
869 The data to be plotted. The @code{ldata} and @code{udata} elements are
8325
b93ac0586e4b spelling corrections
Brian Gough<bjg@network-theory.co.uk>
parents: 8297
diff changeset
870 for errorbars in the y direction, and the @code{xldata} and @code{xudata}
6889
ebff56d6b0a8 [project @ 2007-09-12 18:32:12 by jwe]
jwe
parents: 6888
diff changeset
871 elements are for errorbars in the x direction.
ebff56d6b0a8 [project @ 2007-09-12 18:32:12 by jwe]
jwe
parents: 6888
diff changeset
872
6888
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
873 @item color
6889
ebff56d6b0a8 [project @ 2007-09-12 18:32:12 by jwe]
jwe
parents: 6888
diff changeset
874 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
875
6888
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
876 @item linestyle
6889
ebff56d6b0a8 [project @ 2007-09-12 18:32:12 by jwe]
jwe
parents: 6888
diff changeset
877 @itemx linewidth
ebff56d6b0a8 [project @ 2007-09-12 18:32:12 by jwe]
jwe
parents: 6888
diff changeset
878 @xref{Line Styles}.
ebff56d6b0a8 [project @ 2007-09-12 18:32:12 by jwe]
jwe
parents: 6888
diff changeset
879
6888
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
880 @item marker
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
881 @item markeredgecolor
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
882 @item markerfacecolor
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
883 @item markersize
6889
ebff56d6b0a8 [project @ 2007-09-12 18:32:12 by jwe]
jwe
parents: 6888
diff changeset
884 @xref{Marker Styles}.
ebff56d6b0a8 [project @ 2007-09-12 18:32:12 by jwe]
jwe
parents: 6888
diff changeset
885
6888
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
886 @item keylabel
6889
ebff56d6b0a8 [project @ 2007-09-12 18:32:12 by jwe]
jwe
parents: 6888
diff changeset
887 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
888 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
889 future version of Octave.
6888
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
890 @end table
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
891
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
892 @node Text Properties
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
893 @subsubsection Text Properties
8071
b6e85fb238c1 doc fixes
John W. Eaton <jwe@octave.org>
parents: 8070
diff changeset
894 @cindex text properties
6888
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
895
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
896 @table @code
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
897 @item string
6889
ebff56d6b0a8 [project @ 2007-09-12 18:32:12 by jwe]
jwe
parents: 6888
diff changeset
898 The character string contained by the text object.
ebff56d6b0a8 [project @ 2007-09-12 18:32:12 by jwe]
jwe
parents: 6888
diff changeset
899
6888
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
900 @item units
6889
ebff56d6b0a8 [project @ 2007-09-12 18:32:12 by jwe]
jwe
parents: 6888
diff changeset
901 May be @code{"normalized"} or @code{"graph"}.
ebff56d6b0a8 [project @ 2007-09-12 18:32:12 by jwe]
jwe
parents: 6888
diff changeset
902
6888
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
903 @item position
6889
ebff56d6b0a8 [project @ 2007-09-12 18:32:12 by jwe]
jwe
parents: 6888
diff changeset
904 The coordinates of the text object.
ebff56d6b0a8 [project @ 2007-09-12 18:32:12 by jwe]
jwe
parents: 6888
diff changeset
905
6888
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
906 @item rotation
6889
ebff56d6b0a8 [project @ 2007-09-12 18:32:12 by jwe]
jwe
parents: 6888
diff changeset
907 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
908
6888
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
909 @item horizontalalignment
6889
ebff56d6b0a8 [project @ 2007-09-12 18:32:12 by jwe]
jwe
parents: 6888
diff changeset
910 May be @code{"left"}, @code{"center"}, or @code{"right"}.
ebff56d6b0a8 [project @ 2007-09-12 18:32:12 by jwe]
jwe
parents: 6888
diff changeset
911
6888
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
912 @item color
6889
ebff56d6b0a8 [project @ 2007-09-12 18:32:12 by jwe]
jwe
parents: 6888
diff changeset
913 The color of the text. @xref{Colors}.
7189
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 fontname
e8d953d03f6a [project @ 2007-11-26 20:42:09 by dbateman]
dbateman
parents: 7153
diff changeset
916 The font used for the text.
e8d953d03f6a [project @ 2007-11-26 20:42:09 by dbateman]
dbateman
parents: 7153
diff changeset
917
e8d953d03f6a [project @ 2007-11-26 20:42:09 by dbateman]
dbateman
parents: 7153
diff changeset
918 @item fontsize
e8d953d03f6a [project @ 2007-11-26 20:42:09 by dbateman]
dbateman
parents: 7153
diff changeset
919 The size of the font, in points to use.
e8d953d03f6a [project @ 2007-11-26 20:42:09 by dbateman]
dbateman
parents: 7153
diff changeset
920
e8d953d03f6a [project @ 2007-11-26 20:42:09 by dbateman]
dbateman
parents: 7153
diff changeset
921 @item fontangle
e8d953d03f6a [project @ 2007-11-26 20:42:09 by dbateman]
dbateman
parents: 7153
diff changeset
922 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
923 'italic' and 'oblique'.
e8d953d03f6a [project @ 2007-11-26 20:42:09 by dbateman]
dbateman
parents: 7153
diff changeset
924
e8d953d03f6a [project @ 2007-11-26 20:42:09 by dbateman]
dbateman
parents: 7153
diff changeset
925 @item fontweight
e8d953d03f6a [project @ 2007-11-26 20:42:09 by dbateman]
dbateman
parents: 7153
diff changeset
926 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
927 'demi' or 'light'.
e8d953d03f6a [project @ 2007-11-26 20:42:09 by dbateman]
dbateman
parents: 7153
diff changeset
928
e8d953d03f6a [project @ 2007-11-26 20:42:09 by dbateman]
dbateman
parents: 7153
diff changeset
929 @item interpreter
e8d953d03f6a [project @ 2007-11-26 20:42:09 by dbateman]
dbateman
parents: 7153
diff changeset
930 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
931 'latex'.
6888
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
932 @end table
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
933
7189
e8d953d03f6a [project @ 2007-11-26 20:42:09 by dbateman]
dbateman
parents: 7153
diff changeset
934 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
935 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
936 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
937 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
938 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
939 interpret the text.
e8d953d03f6a [project @ 2007-11-26 20:42:09 by dbateman]
dbateman
parents: 7153
diff changeset
940
e8d953d03f6a [project @ 2007-11-26 20:42:09 by dbateman]
dbateman
parents: 7153
diff changeset
941 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
942 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
943 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
944 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
945 (\) character, as in the table @ref{tab:extended}.
e8d953d03f6a [project @ 2007-11-26 20:42:09 by dbateman]
dbateman
parents: 7153
diff changeset
946
8325
b93ac0586e4b spelling corrections
Brian Gough<bjg@network-theory.co.uk>
parents: 8297
diff changeset
947 In addition, the formatting of the text can be changed within the string
7189
e8d953d03f6a [project @ 2007-11-26 20:42:09 by dbateman]
dbateman
parents: 7153
diff changeset
948 with the codes
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 @multitable @columnfractions .2 .2 .6 .2
e8d953d03f6a [project @ 2007-11-26 20:42:09 by dbateman]
dbateman
parents: 7153
diff changeset
951 @item @tab \bf @tab Bold font @tab
e8d953d03f6a [project @ 2007-11-26 20:42:09 by dbateman]
dbateman
parents: 7153
diff changeset
952 @item @tab \it @tab Italic font @tab
e8d953d03f6a [project @ 2007-11-26 20:42:09 by dbateman]
dbateman
parents: 7153
diff changeset
953 @item @tab \sl @tab Oblique Font @tab
e8d953d03f6a [project @ 2007-11-26 20:42:09 by dbateman]
dbateman
parents: 7153
diff changeset
954 @item @tab \rm @tab Normal font @tab
e8d953d03f6a [project @ 2007-11-26 20:42:09 by dbateman]
dbateman
parents: 7153
diff changeset
955 @end multitable
e8d953d03f6a [project @ 2007-11-26 20:42:09 by dbateman]
dbateman
parents: 7153
diff changeset
956
e8d953d03f6a [project @ 2007-11-26 20:42:09 by dbateman]
dbateman
parents: 7153
diff changeset
957 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
958 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
959
e8d953d03f6a [project @ 2007-11-26 20:42:09 by dbateman]
dbateman
parents: 7153
diff changeset
960 @example
e8d953d03f6a [project @ 2007-11-26 20:42:09 by dbateman]
dbateman
parents: 7153
diff changeset
961 xlabel ('@{\bf H@} = a @{\bf V@}')
e8d953d03f6a [project @ 2007-11-26 20:42:09 by dbateman]
dbateman
parents: 7153
diff changeset
962 @end example
e8d953d03f6a [project @ 2007-11-26 20:42:09 by dbateman]
dbateman
parents: 7153
diff changeset
963
e8d953d03f6a [project @ 2007-11-26 20:42:09 by dbateman]
dbateman
parents: 7153
diff changeset
964 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
965 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
966 the strings should be in single quotes.
e8d953d03f6a [project @ 2007-11-26 20:42:09 by dbateman]
dbateman
parents: 7153
diff changeset
967
e8d953d03f6a [project @ 2007-11-26 20:42:09 by dbateman]
dbateman
parents: 7153
diff changeset
968 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
969
e8d953d03f6a [project @ 2007-11-26 20:42:09 by dbateman]
dbateman
parents: 7153
diff changeset
970 @multitable @columnfractions .1 .4 .6 .1
e8d953d03f6a [project @ 2007-11-26 20:42:09 by dbateman]
dbateman
parents: 7153
diff changeset
971 @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
972 @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
973 use @tab
e8d953d03f6a [project @ 2007-11-26 20:42:09 by dbateman]
dbateman
parents: 7153
diff changeset
974 @end multitable
e8d953d03f6a [project @ 2007-11-26 20:42:09 by dbateman]
dbateman
parents: 7153
diff changeset
975
e8d953d03f6a [project @ 2007-11-26 20:42:09 by dbateman]
dbateman
parents: 7153
diff changeset
976 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
977 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
978 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
979 sub-scripted. Without the @{ @} pair, only the character immediately
e8d953d03f6a [project @ 2007-11-26 20:42:09 by dbateman]
dbateman
parents: 7153
diff changeset
980 following the '^' or '_' is super- or sub-scripted.
e8d953d03f6a [project @ 2007-11-26 20:42:09 by dbateman]
dbateman
parents: 7153
diff changeset
981
e8d953d03f6a [project @ 2007-11-26 20:42:09 by dbateman]
dbateman
parents: 7153
diff changeset
982 @float Table,tab:extended
e8d953d03f6a [project @ 2007-11-26 20:42:09 by dbateman]
dbateman
parents: 7153
diff changeset
983 @iftex
e8d953d03f6a [project @ 2007-11-26 20:42:09 by dbateman]
dbateman
parents: 7153
diff changeset
984 @tex
e8d953d03f6a [project @ 2007-11-26 20:42:09 by dbateman]
dbateman
parents: 7153
diff changeset
985 \vskip 6pt
e8d953d03f6a [project @ 2007-11-26 20:42:09 by dbateman]
dbateman
parents: 7153
diff changeset
986 {\hbox to \hsize {\hfill\vbox{\offinterlineskip \tabskip=0pt
e8d953d03f6a [project @ 2007-11-26 20:42:09 by dbateman]
dbateman
parents: 7153
diff changeset
987 \halign{
e8d953d03f6a [project @ 2007-11-26 20:42:09 by dbateman]
dbateman
parents: 7153
diff changeset
988 \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
989 # \hfil & \vrule # & # \hfil & # \vrule &
e8d953d03f6a [project @ 2007-11-26 20:42:09 by dbateman]
dbateman
parents: 7153
diff changeset
990 # \hfil & \vrule # & # \hfil & # \vrule &
e8d953d03f6a [project @ 2007-11-26 20:42:09 by dbateman]
dbateman
parents: 7153
diff changeset
991 # \hfil & \vrule # & # \hfil & # \vrule
e8d953d03f6a [project @ 2007-11-26 20:42:09 by dbateman]
dbateman
parents: 7153
diff changeset
992 width 0.6pt \tabskip=0pt\cr
e8d953d03f6a [project @ 2007-11-26 20:42:09 by dbateman]
dbateman
parents: 7153
diff changeset
993 \noalign{\hrule height 0.6pt}
e8d953d03f6a [project @ 2007-11-26 20:42:09 by dbateman]
dbateman
parents: 7153
diff changeset
994 & Code && Sym && Code && Sym && Code && Sym &\cr
e8d953d03f6a [project @ 2007-11-26 20:42:09 by dbateman]
dbateman
parents: 7153
diff changeset
995 \noalign{\hrule}
7608
49810341db91 Correct typos in __go_draw_axes__.m and update Manual
godfrey@qss.Stanford.EDU
parents: 7189
diff changeset
996 & $\backslash$forall && $\forall$
49810341db91 Correct typos in __go_draw_axes__.m and update Manual
godfrey@qss.Stanford.EDU
parents: 7189
diff changeset
997 && $\backslash$exists && $\exists$
49810341db91 Correct typos in __go_draw_axes__.m and update Manual
godfrey@qss.Stanford.EDU
parents: 7189
diff changeset
998 && $\backslash$ni && $\ni$ &\cr
49810341db91 Correct typos in __go_draw_axes__.m and update Manual
godfrey@qss.Stanford.EDU
parents: 7189
diff changeset
999 & $\backslash$cong && $\cong$
49810341db91 Correct typos in __go_draw_axes__.m and update Manual
godfrey@qss.Stanford.EDU
parents: 7189
diff changeset
1000 && $\backslash$Delta && $\Delta$
49810341db91 Correct typos in __go_draw_axes__.m and update Manual
godfrey@qss.Stanford.EDU
parents: 7189
diff changeset
1001 && $\backslash$Phi && $\Phi$ &\cr
49810341db91 Correct typos in __go_draw_axes__.m and update Manual
godfrey@qss.Stanford.EDU
parents: 7189
diff changeset
1002 & $\backslash$Gamma && $\Gamma$
49810341db91 Correct typos in __go_draw_axes__.m and update Manual
godfrey@qss.Stanford.EDU
parents: 7189
diff changeset
1003 && $\backslash$vartheta && $\vartheta$
49810341db91 Correct typos in __go_draw_axes__.m and update Manual
godfrey@qss.Stanford.EDU
parents: 7189
diff changeset
1004 && $\backslash$Lambda && $\Lambda$ &\cr
49810341db91 Correct typos in __go_draw_axes__.m and update Manual
godfrey@qss.Stanford.EDU
parents: 7189
diff changeset
1005 & $\backslash$Pi && $\Pi$
49810341db91 Correct typos in __go_draw_axes__.m and update Manual
godfrey@qss.Stanford.EDU
parents: 7189
diff changeset
1006 && $\backslash$Theta && $\Theta$
49810341db91 Correct typos in __go_draw_axes__.m and update Manual
godfrey@qss.Stanford.EDU
parents: 7189
diff changeset
1007 && $\backslash$Sigma && $\Sigma$ &\cr
49810341db91 Correct typos in __go_draw_axes__.m and update Manual
godfrey@qss.Stanford.EDU
parents: 7189
diff changeset
1008 & $\backslash$varsigma && $\varsigma$
49810341db91 Correct typos in __go_draw_axes__.m and update Manual
godfrey@qss.Stanford.EDU
parents: 7189
diff changeset
1009 && $\backslash$Omega && $\Omega$
49810341db91 Correct typos in __go_draw_axes__.m and update Manual
godfrey@qss.Stanford.EDU
parents: 7189
diff changeset
1010 && $\backslash$Xi && $\Xi$ &\cr
49810341db91 Correct typos in __go_draw_axes__.m and update Manual
godfrey@qss.Stanford.EDU
parents: 7189
diff changeset
1011 & $\backslash$Psi && $\Psi$
49810341db91 Correct typos in __go_draw_axes__.m and update Manual
godfrey@qss.Stanford.EDU
parents: 7189
diff changeset
1012 && $\backslash$perp && $\perp$
49810341db91 Correct typos in __go_draw_axes__.m and update Manual
godfrey@qss.Stanford.EDU
parents: 7189
diff changeset
1013 && $\backslash$alpha && $\alpha$ &\cr
49810341db91 Correct typos in __go_draw_axes__.m and update Manual
godfrey@qss.Stanford.EDU
parents: 7189
diff changeset
1014 & $\backslash$beta && $\beta$
49810341db91 Correct typos in __go_draw_axes__.m and update Manual
godfrey@qss.Stanford.EDU
parents: 7189
diff changeset
1015 && $\backslash$chi && $\chi$
49810341db91 Correct typos in __go_draw_axes__.m and update Manual
godfrey@qss.Stanford.EDU
parents: 7189
diff changeset
1016 && $\backslash$delta && $\delta$ &\cr
49810341db91 Correct typos in __go_draw_axes__.m and update Manual
godfrey@qss.Stanford.EDU
parents: 7189
diff changeset
1017 & $\backslash$epsilon && $\epsilon$
49810341db91 Correct typos in __go_draw_axes__.m and update Manual
godfrey@qss.Stanford.EDU
parents: 7189
diff changeset
1018 && $\backslash$phi && $\phi$
49810341db91 Correct typos in __go_draw_axes__.m and update Manual
godfrey@qss.Stanford.EDU
parents: 7189
diff changeset
1019 && $\backslash$gamma && $\gamma$ &\cr
49810341db91 Correct typos in __go_draw_axes__.m and update Manual
godfrey@qss.Stanford.EDU
parents: 7189
diff changeset
1020 & $\backslash$eta && $\eta$
49810341db91 Correct typos in __go_draw_axes__.m and update Manual
godfrey@qss.Stanford.EDU
parents: 7189
diff changeset
1021 && $\backslash$iota && $\iota$
49810341db91 Correct typos in __go_draw_axes__.m and update Manual
godfrey@qss.Stanford.EDU
parents: 7189
diff changeset
1022 && $\backslash$varphi && $\varphi$ &\cr
49810341db91 Correct typos in __go_draw_axes__.m and update Manual
godfrey@qss.Stanford.EDU
parents: 7189
diff changeset
1023 & $\backslash$kappa && $\kappa$
49810341db91 Correct typos in __go_draw_axes__.m and update Manual
godfrey@qss.Stanford.EDU
parents: 7189
diff changeset
1024 && $\backslash$lambda && $\lambda$
49810341db91 Correct typos in __go_draw_axes__.m and update Manual
godfrey@qss.Stanford.EDU
parents: 7189
diff changeset
1025 && $\backslash$mu && $\mu$ &\cr
49810341db91 Correct typos in __go_draw_axes__.m and update Manual
godfrey@qss.Stanford.EDU
parents: 7189
diff changeset
1026 & $\backslash$nu && $\nu$
49810341db91 Correct typos in __go_draw_axes__.m and update Manual
godfrey@qss.Stanford.EDU
parents: 7189
diff changeset
1027 && $\backslash$o && $\o$
49810341db91 Correct typos in __go_draw_axes__.m and update Manual
godfrey@qss.Stanford.EDU
parents: 7189
diff changeset
1028 && $\backslash$pi && $\pi$ &\cr
49810341db91 Correct typos in __go_draw_axes__.m and update Manual
godfrey@qss.Stanford.EDU
parents: 7189
diff changeset
1029 & $\backslash$theta && $\theta$
49810341db91 Correct typos in __go_draw_axes__.m and update Manual
godfrey@qss.Stanford.EDU
parents: 7189
diff changeset
1030 && $\backslash$rho && $\rho$
49810341db91 Correct typos in __go_draw_axes__.m and update Manual
godfrey@qss.Stanford.EDU
parents: 7189
diff changeset
1031 && $\backslash$sigma && $\sigma$ &\cr
49810341db91 Correct typos in __go_draw_axes__.m and update Manual
godfrey@qss.Stanford.EDU
parents: 7189
diff changeset
1032 & $\backslash$tau && $\tau$
49810341db91 Correct typos in __go_draw_axes__.m and update Manual
godfrey@qss.Stanford.EDU
parents: 7189
diff changeset
1033 && $\backslash$upsilon && $\upsilon$
49810341db91 Correct typos in __go_draw_axes__.m and update Manual
godfrey@qss.Stanford.EDU
parents: 7189
diff changeset
1034 && $\backslash$varpi && $\varpi$ &\cr
49810341db91 Correct typos in __go_draw_axes__.m and update Manual
godfrey@qss.Stanford.EDU
parents: 7189
diff changeset
1035 & $\backslash$omega && $\omega$
49810341db91 Correct typos in __go_draw_axes__.m and update Manual
godfrey@qss.Stanford.EDU
parents: 7189
diff changeset
1036 && $\backslash$xi && $\xi$
49810341db91 Correct typos in __go_draw_axes__.m and update Manual
godfrey@qss.Stanford.EDU
parents: 7189
diff changeset
1037 && $\backslash$psi && $\psi$ &\cr
49810341db91 Correct typos in __go_draw_axes__.m and update Manual
godfrey@qss.Stanford.EDU
parents: 7189
diff changeset
1038 & $\backslash$zeta && $\zeta$
49810341db91 Correct typos in __go_draw_axes__.m and update Manual
godfrey@qss.Stanford.EDU
parents: 7189
diff changeset
1039 && $\backslash$sim && $\sim$
49810341db91 Correct typos in __go_draw_axes__.m and update Manual
godfrey@qss.Stanford.EDU
parents: 7189
diff changeset
1040 && $\backslash$Upsilon && $\Upsilon$ &\cr
49810341db91 Correct typos in __go_draw_axes__.m and update Manual
godfrey@qss.Stanford.EDU
parents: 7189
diff changeset
1041 & $\backslash$prime && $\prime$
49810341db91 Correct typos in __go_draw_axes__.m and update Manual
godfrey@qss.Stanford.EDU
parents: 7189
diff changeset
1042 && $\backslash$leq && $\leq$
49810341db91 Correct typos in __go_draw_axes__.m and update Manual
godfrey@qss.Stanford.EDU
parents: 7189
diff changeset
1043 && $\backslash$infty && $\infty$ &\cr
49810341db91 Correct typos in __go_draw_axes__.m and update Manual
godfrey@qss.Stanford.EDU
parents: 7189
diff changeset
1044 & $\backslash$clubsuit && $\clubsuit$
49810341db91 Correct typos in __go_draw_axes__.m and update Manual
godfrey@qss.Stanford.EDU
parents: 7189
diff changeset
1045 && $\backslash$diamondsuit && $\diamondsuit$
49810341db91 Correct typos in __go_draw_axes__.m and update Manual
godfrey@qss.Stanford.EDU
parents: 7189
diff changeset
1046 && $\backslash$heartsuit && $\heartsuit$ &\cr
49810341db91 Correct typos in __go_draw_axes__.m and update Manual
godfrey@qss.Stanford.EDU
parents: 7189
diff changeset
1047 & $\backslash$spadesuit && $\spadesuit$
49810341db91 Correct typos in __go_draw_axes__.m and update Manual
godfrey@qss.Stanford.EDU
parents: 7189
diff changeset
1048 && $\backslash$leftrightarrow && $\leftrightarrow$
49810341db91 Correct typos in __go_draw_axes__.m and update Manual
godfrey@qss.Stanford.EDU
parents: 7189
diff changeset
1049 && $\backslash$leftarrow && $\leftarrow$ &\cr
49810341db91 Correct typos in __go_draw_axes__.m and update Manual
godfrey@qss.Stanford.EDU
parents: 7189
diff changeset
1050 & $\backslash$uparrow && $\uparrow$
49810341db91 Correct typos in __go_draw_axes__.m and update Manual
godfrey@qss.Stanford.EDU
parents: 7189
diff changeset
1051 && $\backslash$rightarrow && $\rightarrow$
49810341db91 Correct typos in __go_draw_axes__.m and update Manual
godfrey@qss.Stanford.EDU
parents: 7189
diff changeset
1052 && $\backslash$downarrow && $\downarrow$ &\cr
49810341db91 Correct typos in __go_draw_axes__.m and update Manual
godfrey@qss.Stanford.EDU
parents: 7189
diff changeset
1053 & $\backslash$circ && $\circ$
49810341db91 Correct typos in __go_draw_axes__.m and update Manual
godfrey@qss.Stanford.EDU
parents: 7189
diff changeset
1054 && $\backslash$pm && $\pm$
49810341db91 Correct typos in __go_draw_axes__.m and update Manual
godfrey@qss.Stanford.EDU
parents: 7189
diff changeset
1055 && $\backslash$geq && $\geq$ &\cr
49810341db91 Correct typos in __go_draw_axes__.m and update Manual
godfrey@qss.Stanford.EDU
parents: 7189
diff changeset
1056 & $\backslash$times && $\times$
49810341db91 Correct typos in __go_draw_axes__.m and update Manual
godfrey@qss.Stanford.EDU
parents: 7189
diff changeset
1057 && $\backslash$propto && $\propto$
49810341db91 Correct typos in __go_draw_axes__.m and update Manual
godfrey@qss.Stanford.EDU
parents: 7189
diff changeset
1058 && $\backslash$partial && $\partial$ &\cr
49810341db91 Correct typos in __go_draw_axes__.m and update Manual
godfrey@qss.Stanford.EDU
parents: 7189
diff changeset
1059 & $\backslash$bullet && $\bullet$
49810341db91 Correct typos in __go_draw_axes__.m and update Manual
godfrey@qss.Stanford.EDU
parents: 7189
diff changeset
1060 && $\backslash$div && $\div$
49810341db91 Correct typos in __go_draw_axes__.m and update Manual
godfrey@qss.Stanford.EDU
parents: 7189
diff changeset
1061 && $\backslash$neq && $\neq$ &\cr
49810341db91 Correct typos in __go_draw_axes__.m and update Manual
godfrey@qss.Stanford.EDU
parents: 7189
diff changeset
1062 & $\backslash$equiv && $\equiv$
49810341db91 Correct typos in __go_draw_axes__.m and update Manual
godfrey@qss.Stanford.EDU
parents: 7189
diff changeset
1063 && $\backslash$approx && $\approx$
49810341db91 Correct typos in __go_draw_axes__.m and update Manual
godfrey@qss.Stanford.EDU
parents: 7189
diff changeset
1064 && $\backslash$ldots && $\ldots$ &\cr
49810341db91 Correct typos in __go_draw_axes__.m and update Manual
godfrey@qss.Stanford.EDU
parents: 7189
diff changeset
1065 & $\backslash$mid && $\mid$
49810341db91 Correct typos in __go_draw_axes__.m and update Manual
godfrey@qss.Stanford.EDU
parents: 7189
diff changeset
1066 && $\backslash$aleph && $\aleph$
49810341db91 Correct typos in __go_draw_axes__.m and update Manual
godfrey@qss.Stanford.EDU
parents: 7189
diff changeset
1067 && $\backslash$Im && $\Im$ &\cr
49810341db91 Correct typos in __go_draw_axes__.m and update Manual
godfrey@qss.Stanford.EDU
parents: 7189
diff changeset
1068 & $\backslash$Re && $\Re$
49810341db91 Correct typos in __go_draw_axes__.m and update Manual
godfrey@qss.Stanford.EDU
parents: 7189
diff changeset
1069 && $\backslash$wp && $\wp$
49810341db91 Correct typos in __go_draw_axes__.m and update Manual
godfrey@qss.Stanford.EDU
parents: 7189
diff changeset
1070 && $\backslash$otimes && $\otimes$ &\cr
49810341db91 Correct typos in __go_draw_axes__.m and update Manual
godfrey@qss.Stanford.EDU
parents: 7189
diff changeset
1071 & $\backslash$oplus && $\oplus$
49810341db91 Correct typos in __go_draw_axes__.m and update Manual
godfrey@qss.Stanford.EDU
parents: 7189
diff changeset
1072 && $\backslash$oslash && $\oslash$
49810341db91 Correct typos in __go_draw_axes__.m and update Manual
godfrey@qss.Stanford.EDU
parents: 7189
diff changeset
1073 && $\backslash$cap && $\cap$ &\cr
49810341db91 Correct typos in __go_draw_axes__.m and update Manual
godfrey@qss.Stanford.EDU
parents: 7189
diff changeset
1074 & $\backslash$cup && $\cup$
49810341db91 Correct typos in __go_draw_axes__.m and update Manual
godfrey@qss.Stanford.EDU
parents: 7189
diff changeset
1075 && $\backslash$supset && $\supset$
49810341db91 Correct typos in __go_draw_axes__.m and update Manual
godfrey@qss.Stanford.EDU
parents: 7189
diff changeset
1076 && $\backslash$supseteq && $\supseteq$ &\cr
49810341db91 Correct typos in __go_draw_axes__.m and update Manual
godfrey@qss.Stanford.EDU
parents: 7189
diff changeset
1077 & $\backslash$subset && $\subset$
49810341db91 Correct typos in __go_draw_axes__.m and update Manual
godfrey@qss.Stanford.EDU
parents: 7189
diff changeset
1078 && $\backslash$subseteq && $\subseteq$
49810341db91 Correct typos in __go_draw_axes__.m and update Manual
godfrey@qss.Stanford.EDU
parents: 7189
diff changeset
1079 && $\backslash$in && $\in$ &\cr
49810341db91 Correct typos in __go_draw_axes__.m and update Manual
godfrey@qss.Stanford.EDU
parents: 7189
diff changeset
1080 & $\backslash$notin && $\notin$
49810341db91 Correct typos in __go_draw_axes__.m and update Manual
godfrey@qss.Stanford.EDU
parents: 7189
diff changeset
1081 && $\backslash$angle && $\angle$
49810341db91 Correct typos in __go_draw_axes__.m and update Manual
godfrey@qss.Stanford.EDU
parents: 7189
diff changeset
1082 && $\backslash$bigtriangledown && $\bigtriangledown$ &\cr
49810341db91 Correct typos in __go_draw_axes__.m and update Manual
godfrey@qss.Stanford.EDU
parents: 7189
diff changeset
1083 & $\backslash$langle && $\langle$
49810341db91 Correct typos in __go_draw_axes__.m and update Manual
godfrey@qss.Stanford.EDU
parents: 7189
diff changeset
1084 && $\backslash$rangle && $\rangle$
49810341db91 Correct typos in __go_draw_axes__.m and update Manual
godfrey@qss.Stanford.EDU
parents: 7189
diff changeset
1085 && $\backslash$nabla && $\nabla$ &\cr
49810341db91 Correct typos in __go_draw_axes__.m and update Manual
godfrey@qss.Stanford.EDU
parents: 7189
diff changeset
1086 & $\backslash$prod && $\prod$
49810341db91 Correct typos in __go_draw_axes__.m and update Manual
godfrey@qss.Stanford.EDU
parents: 7189
diff changeset
1087 && $\backslash$surd && $\surd$
49810341db91 Correct typos in __go_draw_axes__.m and update Manual
godfrey@qss.Stanford.EDU
parents: 7189
diff changeset
1088 && $\backslash$cdot && $\cdot$ &\cr
49810341db91 Correct typos in __go_draw_axes__.m and update Manual
godfrey@qss.Stanford.EDU
parents: 7189
diff changeset
1089 & $\backslash$neg && $\neg$
49810341db91 Correct typos in __go_draw_axes__.m and update Manual
godfrey@qss.Stanford.EDU
parents: 7189
diff changeset
1090 && $\backslash$wedge && $\wedge$
49810341db91 Correct typos in __go_draw_axes__.m and update Manual
godfrey@qss.Stanford.EDU
parents: 7189
diff changeset
1091 && $\backslash$vee && $\vee$ &\cr
49810341db91 Correct typos in __go_draw_axes__.m and update Manual
godfrey@qss.Stanford.EDU
parents: 7189
diff changeset
1092 & $\backslash$Leftrightarrow && $\Leftrightarrow$
49810341db91 Correct typos in __go_draw_axes__.m and update Manual
godfrey@qss.Stanford.EDU
parents: 7189
diff changeset
1093 && $\backslash$Leftarrow && $\Leftarrow$
49810341db91 Correct typos in __go_draw_axes__.m and update Manual
godfrey@qss.Stanford.EDU
parents: 7189
diff changeset
1094 && $\backslash$Uparrow && $\Uparrow$ &\cr
49810341db91 Correct typos in __go_draw_axes__.m and update Manual
godfrey@qss.Stanford.EDU
parents: 7189
diff changeset
1095 & $\backslash$Rightarrow && $\Rightarrow$
49810341db91 Correct typos in __go_draw_axes__.m and update Manual
godfrey@qss.Stanford.EDU
parents: 7189
diff changeset
1096 && $\backslash$Downarrow && $\Downarrow$
49810341db91 Correct typos in __go_draw_axes__.m and update Manual
godfrey@qss.Stanford.EDU
parents: 7189
diff changeset
1097 && $\backslash$diamond && $\diamond$ &\cr
49810341db91 Correct typos in __go_draw_axes__.m and update Manual
godfrey@qss.Stanford.EDU
parents: 7189
diff changeset
1098 & $\backslash$copyright && $\copyright$
49810341db91 Correct typos in __go_draw_axes__.m and update Manual
godfrey@qss.Stanford.EDU
parents: 7189
diff changeset
1099 && $\backslash$rfloor && $\rfloor$
49810341db91 Correct typos in __go_draw_axes__.m and update Manual
godfrey@qss.Stanford.EDU
parents: 7189
diff changeset
1100 && $\backslash$lceil && $\lceil$ &\cr
49810341db91 Correct typos in __go_draw_axes__.m and update Manual
godfrey@qss.Stanford.EDU
parents: 7189
diff changeset
1101 & $\backslash$lfloor && $\lfloor$
49810341db91 Correct typos in __go_draw_axes__.m and update Manual
godfrey@qss.Stanford.EDU
parents: 7189
diff changeset
1102 && $\backslash$rceil && $\rceil$
49810341db91 Correct typos in __go_draw_axes__.m and update Manual
godfrey@qss.Stanford.EDU
parents: 7189
diff changeset
1103 && $\backslash$int && $\int$ &\cr
7189
e8d953d03f6a [project @ 2007-11-26 20:42:09 by dbateman]
dbateman
parents: 7153
diff changeset
1104 \noalign{\hrule height 0.6pt}
e8d953d03f6a [project @ 2007-11-26 20:42:09 by dbateman]
dbateman
parents: 7153
diff changeset
1105 }}\hfill}}
e8d953d03f6a [project @ 2007-11-26 20:42:09 by dbateman]
dbateman
parents: 7153
diff changeset
1106 @end tex
e8d953d03f6a [project @ 2007-11-26 20:42:09 by dbateman]
dbateman
parents: 7153
diff changeset
1107 @end iftex
e8d953d03f6a [project @ 2007-11-26 20:42:09 by dbateman]
dbateman
parents: 7153
diff changeset
1108 @ifnottex
e8d953d03f6a [project @ 2007-11-26 20:42:09 by dbateman]
dbateman
parents: 7153
diff changeset
1109 @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
1110 @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
1111 @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
1112 @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
1113 @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
1114 @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
1115 @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
1116 @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
1117 @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
1118 @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
1119 @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
1120 @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
1121 @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
1122 @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
1123 @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
1124 @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
1125 @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
1126 @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
1127 @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
1128 @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
1129 @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
1130 @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
1131 @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
1132 @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
1133 @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
1134 @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
1135 @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
1136 @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
1137 @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
1138 @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
1139 @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
1140 @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
1141 @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
1142 @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
1143 @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
1144 @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
1145 @item @tab \rfloor @tab \rceil @tab \int @tab
7189
e8d953d03f6a [project @ 2007-11-26 20:42:09 by dbateman]
dbateman
parents: 7153
diff changeset
1146 @end multitable
e8d953d03f6a [project @ 2007-11-26 20:42:09 by dbateman]
dbateman
parents: 7153
diff changeset
1147 @end ifnottex
e8d953d03f6a [project @ 2007-11-26 20:42:09 by dbateman]
dbateman
parents: 7153
diff changeset
1148 @caption{Available special characters in @sc{TeX} mode}
e8d953d03f6a [project @ 2007-11-26 20:42:09 by dbateman]
dbateman
parents: 7153
diff changeset
1149 @end float
e8d953d03f6a [project @ 2007-11-26 20:42:09 by dbateman]
dbateman
parents: 7153
diff changeset
1150
e8d953d03f6a [project @ 2007-11-26 20:42:09 by dbateman]
dbateman
parents: 7153
diff changeset
1151 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
1152
e8d953d03f6a [project @ 2007-11-26 20:42:09 by dbateman]
dbateman
parents: 7153
diff changeset
1153 @example
e8d953d03f6a [project @ 2007-11-26 20:42:09 by dbateman]
dbateman
parents: 7153
diff changeset
1154 @group
e8d953d03f6a [project @ 2007-11-26 20:42:09 by dbateman]
dbateman
parents: 7153
diff changeset
1155 x = 0:0.01:3;
e8d953d03f6a [project @ 2007-11-26 20:42:09 by dbateman]
dbateman
parents: 7153
diff changeset
1156 plot(x,erf(x));
e8d953d03f6a [project @ 2007-11-26 20:42:09 by dbateman]
dbateman
parents: 7153
diff changeset
1157 hold on;
e8d953d03f6a [project @ 2007-11-26 20:42:09 by dbateman]
dbateman
parents: 7153
diff changeset
1158 plot(x,x,"r");
e8d953d03f6a [project @ 2007-11-26 20:42:09 by dbateman]
dbateman
parents: 7153
diff changeset
1159 axis([0, 3, 0, 1]);
e8d953d03f6a [project @ 2007-11-26 20:42:09 by dbateman]
dbateman
parents: 7153
diff changeset
1160 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
1161 ' @{\fontsize@{16@}\int_@{\fontsize@{8@}0@}^@{\fontsize@{8@}x@}@}',
e8d953d03f6a [project @ 2007-11-26 20:42:09 by dbateman]
dbateman
parents: 7153
diff changeset
1162 ' e^@{-t^2@} dt@} = 0.6175'))
e8d953d03f6a [project @ 2007-11-26 20:42:09 by dbateman]
dbateman
parents: 7153
diff changeset
1163 @end group
e8d953d03f6a [project @ 2007-11-26 20:42:09 by dbateman]
dbateman
parents: 7153
diff changeset
1164 @end example
e8d953d03f6a [project @ 2007-11-26 20:42:09 by dbateman]
dbateman
parents: 7153
diff changeset
1165
e8d953d03f6a [project @ 2007-11-26 20:42:09 by dbateman]
dbateman
parents: 7153
diff changeset
1166 @ifnotinfo
e8d953d03f6a [project @ 2007-11-26 20:42:09 by dbateman]
dbateman
parents: 7153
diff changeset
1167 @noindent
e8d953d03f6a [project @ 2007-11-26 20:42:09 by dbateman]
dbateman
parents: 7153
diff changeset
1168 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
1169
e8d953d03f6a [project @ 2007-11-26 20:42:09 by dbateman]
dbateman
parents: 7153
diff changeset
1170 @float Figure,fig:extendedtext
e8d953d03f6a [project @ 2007-11-26 20:42:09 by dbateman]
dbateman
parents: 7153
diff changeset
1171 @image{extended,8cm}
e8d953d03f6a [project @ 2007-11-26 20:42:09 by dbateman]
dbateman
parents: 7153
diff changeset
1172 @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
1173 @end float
e8d953d03f6a [project @ 2007-11-26 20:42:09 by dbateman]
dbateman
parents: 7153
diff changeset
1174 @end ifnotinfo
e8d953d03f6a [project @ 2007-11-26 20:42:09 by dbateman]
dbateman
parents: 7153
diff changeset
1175
6888
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
1176 @node Image Properties
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
1177 @subsubsection Image Properties
8071
b6e85fb238c1 doc fixes
John W. Eaton <jwe@octave.org>
parents: 8070
diff changeset
1178 @cindex image properties
6888
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
1179
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
1180 @table @code
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
1181 @item cdata
6889
ebff56d6b0a8 [project @ 2007-09-12 18:32:12 by jwe]
jwe
parents: 6888
diff changeset
1182 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
1183 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
1184 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
1185 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
1186 determines the color of the pixel.
ebff56d6b0a8 [project @ 2007-09-12 18:32:12 by jwe]
jwe
parents: 6888
diff changeset
1187
ebff56d6b0a8 [project @ 2007-09-12 18:32:12 by jwe]
jwe
parents: 6888
diff changeset
1188 @item xdata
6888
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
1189 @itemx ydata
7001
8b0cfeb06365 [project @ 2007-10-10 18:02:59 by jwe]
jwe
parents: 6899
diff changeset
1190 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
1191 the image.
6888
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
1192 @end table
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
1193
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
1194 @node Patch Properties
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
1195 @subsubsection Patch Properties
8071
b6e85fb238c1 doc fixes
John W. Eaton <jwe@octave.org>
parents: 8070
diff changeset
1196 @cindex patch properties
6888
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
1197
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
1198 @table @code
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
1199 @item cdata
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
1200 @itemx xdata
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
1201 @itemx ydata
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
1202 @itemx zdata
6889
ebff56d6b0a8 [project @ 2007-09-12 18:32:12 by jwe]
jwe
parents: 6888
diff changeset
1203 Data defining the patch object.
ebff56d6b0a8 [project @ 2007-09-12 18:32:12 by jwe]
jwe
parents: 6888
diff changeset
1204
6888
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
1205 @item facecolor
6889
ebff56d6b0a8 [project @ 2007-09-12 18:32:12 by jwe]
jwe
parents: 6888
diff changeset
1206 The fill color of the patch. @xref{Colors}.
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 facealpha
6889
ebff56d6b0a8 [project @ 2007-09-12 18:32:12 by jwe]
jwe
parents: 6888
diff changeset
1209 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
1210
6888
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
1211 @item edgecolor
6889
ebff56d6b0a8 [project @ 2007-09-12 18:32:12 by jwe]
jwe
parents: 6888
diff changeset
1212 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
1213
6888
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
1214 @item linestyle
6889
ebff56d6b0a8 [project @ 2007-09-12 18:32:12 by jwe]
jwe
parents: 6888
diff changeset
1215 @itemx linewidth
ebff56d6b0a8 [project @ 2007-09-12 18:32:12 by jwe]
jwe
parents: 6888
diff changeset
1216 @xref{Line Styles}.
ebff56d6b0a8 [project @ 2007-09-12 18:32:12 by jwe]
jwe
parents: 6888
diff changeset
1217
6888
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
1218 @item marker
6889
ebff56d6b0a8 [project @ 2007-09-12 18:32:12 by jwe]
jwe
parents: 6888
diff changeset
1219 @itemx markeredgecolor
ebff56d6b0a8 [project @ 2007-09-12 18:32:12 by jwe]
jwe
parents: 6888
diff changeset
1220 @itemx markerfacecolor
ebff56d6b0a8 [project @ 2007-09-12 18:32:12 by jwe]
jwe
parents: 6888
diff changeset
1221 @itemx markersize
ebff56d6b0a8 [project @ 2007-09-12 18:32:12 by jwe]
jwe
parents: 6888
diff changeset
1222 @xref{Marker Styles}.
6888
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
1223 @end table
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
1224
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
1225 @node Surface Properties
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
1226 @subsubsection Surface Properties
8071
b6e85fb238c1 doc fixes
John W. Eaton <jwe@octave.org>
parents: 8070
diff changeset
1227 @cindex surface properties
6888
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
1228
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
1229 @table @code
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
1230 @item xdata
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
1231 @itemx ydata
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
1232 @itemx zdata
6889
ebff56d6b0a8 [project @ 2007-09-12 18:32:12 by jwe]
jwe
parents: 6888
diff changeset
1233 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
1234 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
1235
6888
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
1236 @item keylabel
6889
ebff56d6b0a8 [project @ 2007-09-12 18:32:12 by jwe]
jwe
parents: 6888
diff changeset
1237 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
1238 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
1239 future version of Octave.
ebff56d6b0a8 [project @ 2007-09-12 18:32:12 by jwe]
jwe
parents: 6888
diff changeset
1240 @end table
ebff56d6b0a8 [project @ 2007-09-12 18:32:12 by jwe]
jwe
parents: 6888
diff changeset
1241
8070
3b53b25e2550 Add data sources and line series
David Bateman <dbateman@free.fr>
parents: 8057
diff changeset
1242 @node Searching Properties
3b53b25e2550 Add data sources and line series
David Bateman <dbateman@free.fr>
parents: 8057
diff changeset
1243 @subsubsection Searching Properties
7984
bbaa5d7d0143 Some documentation updates
David Bateman <dbateman@free.fr>
parents: 7981
diff changeset
1244
bbaa5d7d0143 Some documentation updates
David Bateman <dbateman@free.fr>
parents: 7981
diff changeset
1245 @DOCSTRING(findobj)
bbaa5d7d0143 Some documentation updates
David Bateman <dbateman@free.fr>
parents: 7981
diff changeset
1246
bbaa5d7d0143 Some documentation updates
David Bateman <dbateman@free.fr>
parents: 7981
diff changeset
1247 @DOCSTRING(findall)
bbaa5d7d0143 Some documentation updates
David Bateman <dbateman@free.fr>
parents: 7981
diff changeset
1248
bbaa5d7d0143 Some documentation updates
David Bateman <dbateman@free.fr>
parents: 7981
diff changeset
1249
6891
e9921bb3d95b [project @ 2007-09-13 02:44:27 by jwe]
jwe
parents: 6889
diff changeset
1250 @node Managing Default Properties
e9921bb3d95b [project @ 2007-09-13 02:44:27 by jwe]
jwe
parents: 6889
diff changeset
1251 @subsection Managing Default Properties
8071
b6e85fb238c1 doc fixes
John W. Eaton <jwe@octave.org>
parents: 8070
diff changeset
1252 @cindex default graphics properties
b6e85fb238c1 doc fixes
John W. Eaton <jwe@octave.org>
parents: 8070
diff changeset
1253 @cindex graphics properties, default
6891
e9921bb3d95b [project @ 2007-09-13 02:44:27 by jwe]
jwe
parents: 6889
diff changeset
1254
6892
29fa8673d8d1 [project @ 2007-09-13 07:36:52 by jwe]
jwe
parents: 6891
diff changeset
1255 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
1256 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
1257 may override the factory defaults.
6891
e9921bb3d95b [project @ 2007-09-13 02:44:27 by jwe]
jwe
parents: 6889
diff changeset
1258
e9921bb3d95b [project @ 2007-09-13 02:44:27 by jwe]
jwe
parents: 6889
diff changeset
1259 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
1260 parent objects and apply to child objects. For example,
e9921bb3d95b [project @ 2007-09-13 02:44:27 by jwe]
jwe
parents: 6889
diff changeset
1261
e9921bb3d95b [project @ 2007-09-13 02:44:27 by jwe]
jwe
parents: 6889
diff changeset
1262 @example
e9921bb3d95b [project @ 2007-09-13 02:44:27 by jwe]
jwe
parents: 6889
diff changeset
1263 set (0, "defaultlinecolor", "green");
e9921bb3d95b [project @ 2007-09-13 02:44:27 by jwe]
jwe
parents: 6889
diff changeset
1264 @end example
e9921bb3d95b [project @ 2007-09-13 02:44:27 by jwe]
jwe
parents: 6889
diff changeset
1265
e9921bb3d95b [project @ 2007-09-13 02:44:27 by jwe]
jwe
parents: 6889
diff changeset
1266 @noindent
e9921bb3d95b [project @ 2007-09-13 02:44:27 by jwe]
jwe
parents: 6889
diff changeset
1267 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
1268 the property name to set a default value is
e9921bb3d95b [project @ 2007-09-13 02:44:27 by jwe]
jwe
parents: 6889
diff changeset
1269
e9921bb3d95b [project @ 2007-09-13 02:44:27 by jwe]
jwe
parents: 6889
diff changeset
1270 @example
e9921bb3d95b [project @ 2007-09-13 02:44:27 by jwe]
jwe
parents: 6889
diff changeset
1271 default + @var{object-type} + @var{property-name}
e9921bb3d95b [project @ 2007-09-13 02:44:27 by jwe]
jwe
parents: 6889
diff changeset
1272 @end 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 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
1275 @code{defaultlinelinewidth"} specifies the default @code{linewidth}
e9921bb3d95b [project @ 2007-09-13 02:44:27 by jwe]
jwe
parents: 6889
diff changeset
1276 property for @code{line} objects.
e9921bb3d95b [project @ 2007-09-13 02:44:27 by jwe]
jwe
parents: 6889
diff changeset
1277
e9921bb3d95b [project @ 2007-09-13 02:44:27 by jwe]
jwe
parents: 6889
diff changeset
1278 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
1279 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
1280 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
1281 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
1282 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
1283
e9921bb3d95b [project @ 2007-09-13 02:44:27 by jwe]
jwe
parents: 6889
diff changeset
1284 @example
e9921bb3d95b [project @ 2007-09-13 02:44:27 by jwe]
jwe
parents: 6889
diff changeset
1285 @group
e9921bb3d95b [project @ 2007-09-13 02:44:27 by jwe]
jwe
parents: 6889
diff changeset
1286 subplot (2, 1, 1);
e9921bb3d95b [project @ 2007-09-13 02:44:27 by jwe]
jwe
parents: 6889
diff changeset
1287 set (0, "defaultlinecolor", "red");
e9921bb3d95b [project @ 2007-09-13 02:44:27 by jwe]
jwe
parents: 6889
diff changeset
1288 set (1, "defaultlinecolor", "green");
e9921bb3d95b [project @ 2007-09-13 02:44:27 by jwe]
jwe
parents: 6889
diff changeset
1289 set (gca (), "defaultlinecolor", "blue");
e9921bb3d95b [project @ 2007-09-13 02:44:27 by jwe]
jwe
parents: 6889
diff changeset
1290 line (1:10, rand (1, 10));
e9921bb3d95b [project @ 2007-09-13 02:44:27 by jwe]
jwe
parents: 6889
diff changeset
1291 subplot (2, 1, 2);
e9921bb3d95b [project @ 2007-09-13 02:44:27 by jwe]
jwe
parents: 6889
diff changeset
1292 line (1:10, rand (1, 10));
e9921bb3d95b [project @ 2007-09-13 02:44:27 by jwe]
jwe
parents: 6889
diff changeset
1293 figure (2)
e9921bb3d95b [project @ 2007-09-13 02:44:27 by jwe]
jwe
parents: 6889
diff changeset
1294 line (1:10, rand (1, 10));
e9921bb3d95b [project @ 2007-09-13 02:44:27 by jwe]
jwe
parents: 6889
diff changeset
1295 @end group
e9921bb3d95b [project @ 2007-09-13 02:44:27 by jwe]
jwe
parents: 6889
diff changeset
1296 @end example
e9921bb3d95b [project @ 2007-09-13 02:44:27 by jwe]
jwe
parents: 6889
diff changeset
1297
e9921bb3d95b [project @ 2007-09-13 02:44:27 by jwe]
jwe
parents: 6889
diff changeset
1298 @noindent
e9921bb3d95b [project @ 2007-09-13 02:44:27 by jwe]
jwe
parents: 6889
diff changeset
1299 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
1300 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
1301 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
1302 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
1303 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
1304 from the global root figure parent object.
e9921bb3d95b [project @ 2007-09-13 02:44:27 by jwe]
jwe
parents: 6889
diff changeset
1305
e9921bb3d95b [project @ 2007-09-13 02:44:27 by jwe]
jwe
parents: 6889
diff changeset
1306 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
1307 the value @code{"remove"}. For example,
e9921bb3d95b [project @ 2007-09-13 02:44:27 by jwe]
jwe
parents: 6889
diff changeset
1308
e9921bb3d95b [project @ 2007-09-13 02:44:27 by jwe]
jwe
parents: 6889
diff changeset
1309 @example
e9921bb3d95b [project @ 2007-09-13 02:44:27 by jwe]
jwe
parents: 6889
diff changeset
1310 set (gca (), "defaultlinecolor", "remove");
e9921bb3d95b [project @ 2007-09-13 02:44:27 by jwe]
jwe
parents: 6889
diff changeset
1311 @end example
e9921bb3d95b [project @ 2007-09-13 02:44:27 by jwe]
jwe
parents: 6889
diff changeset
1312
e9921bb3d95b [project @ 2007-09-13 02:44:27 by jwe]
jwe
parents: 6889
diff changeset
1313 @noindent
e9921bb3d95b [project @ 2007-09-13 02:44:27 by jwe]
jwe
parents: 6889
diff changeset
1314 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
1315 object.
e9921bb3d95b [project @ 2007-09-13 02:44:27 by jwe]
jwe
parents: 6889
diff changeset
1316
e9921bb3d95b [project @ 2007-09-13 02:44:27 by jwe]
jwe
parents: 6889
diff changeset
1317 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
1318 user-defined defaults set for the object. For example,
e9921bb3d95b [project @ 2007-09-13 02:44:27 by jwe]
jwe
parents: 6889
diff changeset
1319
e9921bb3d95b [project @ 2007-09-13 02:44:27 by jwe]
jwe
parents: 6889
diff changeset
1320 @example
e9921bb3d95b [project @ 2007-09-13 02:44:27 by jwe]
jwe
parents: 6889
diff changeset
1321 get (gca (), "default");
e9921bb3d95b [project @ 2007-09-13 02:44:27 by jwe]
jwe
parents: 6889
diff changeset
1322 @end example
e9921bb3d95b [project @ 2007-09-13 02:44:27 by jwe]
jwe
parents: 6889
diff changeset
1323
e9921bb3d95b [project @ 2007-09-13 02:44:27 by jwe]
jwe
parents: 6889
diff changeset
1324 @noindent
e9921bb3d95b [project @ 2007-09-13 02:44:27 by jwe]
jwe
parents: 6889
diff changeset
1325 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
1326 object.
e9921bb3d95b [project @ 2007-09-13 02:44:27 by jwe]
jwe
parents: 6889
diff changeset
1327
e9921bb3d95b [project @ 2007-09-13 02:44:27 by jwe]
jwe
parents: 6889
diff changeset
1328 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
1329 command
e9921bb3d95b [project @ 2007-09-13 02:44:27 by jwe]
jwe
parents: 6889
diff changeset
1330
e9921bb3d95b [project @ 2007-09-13 02:44:27 by jwe]
jwe
parents: 6889
diff changeset
1331 @example
e9921bb3d95b [project @ 2007-09-13 02:44:27 by jwe]
jwe
parents: 6889
diff changeset
1332 get (0, "factory");
e9921bb3d95b [project @ 2007-09-13 02:44:27 by jwe]
jwe
parents: 6889
diff changeset
1333 @end example
e9921bb3d95b [project @ 2007-09-13 02:44:27 by jwe]
jwe
parents: 6889
diff changeset
1334
e9921bb3d95b [project @ 2007-09-13 02:44:27 by jwe]
jwe
parents: 6889
diff changeset
1335 @noindent
e9921bb3d95b [project @ 2007-09-13 02:44:27 by jwe]
jwe
parents: 6889
diff changeset
1336 returns a list of factory defaults.
e9921bb3d95b [project @ 2007-09-13 02:44:27 by jwe]
jwe
parents: 6889
diff changeset
1337
6889
ebff56d6b0a8 [project @ 2007-09-12 18:32:12 by jwe]
jwe
parents: 6888
diff changeset
1338 @node Colors
ebff56d6b0a8 [project @ 2007-09-12 18:32:12 by jwe]
jwe
parents: 6888
diff changeset
1339 @subsection Colors
8071
b6e85fb238c1 doc fixes
John W. Eaton <jwe@octave.org>
parents: 8070
diff changeset
1340 @cindex graphics colors
b6e85fb238c1 doc fixes
John W. Eaton <jwe@octave.org>
parents: 8070
diff changeset
1341 @cindex colors, graphics
6889
ebff56d6b0a8 [project @ 2007-09-12 18:32:12 by jwe]
jwe
parents: 6888
diff changeset
1342
ebff56d6b0a8 [project @ 2007-09-12 18:32:12 by jwe]
jwe
parents: 6888
diff changeset
1343 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
1344 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
1345 @code{"black"}, @code{"cyan"}, @code{"green"}, @code{"magenta"},
ebff56d6b0a8 [project @ 2007-09-12 18:32:12 by jwe]
jwe
parents: 6888
diff changeset
1346 @code{"red"}, @code{"white"}, and @code{"yellow"}.
ebff56d6b0a8 [project @ 2007-09-12 18:32:12 by jwe]
jwe
parents: 6888
diff changeset
1347
ebff56d6b0a8 [project @ 2007-09-12 18:32:12 by jwe]
jwe
parents: 6888
diff changeset
1348 @node Line Styles
ebff56d6b0a8 [project @ 2007-09-12 18:32:12 by jwe]
jwe
parents: 6888
diff changeset
1349 @subsection Line Styles
8071
b6e85fb238c1 doc fixes
John W. Eaton <jwe@octave.org>
parents: 8070
diff changeset
1350 @cindex line styles, graphics
b6e85fb238c1 doc fixes
John W. Eaton <jwe@octave.org>
parents: 8070
diff changeset
1351 @cindex graphics line styles
b6e85fb238c1 doc fixes
John W. Eaton <jwe@octave.org>
parents: 8070
diff changeset
1352
7001
8b0cfeb06365 [project @ 2007-10-10 18:02:59 by jwe]
jwe
parents: 6899
diff changeset
1353 Line styles are specified by the following properties:
6889
ebff56d6b0a8 [project @ 2007-09-12 18:32:12 by jwe]
jwe
parents: 6888
diff changeset
1354
ebff56d6b0a8 [project @ 2007-09-12 18:32:12 by jwe]
jwe
parents: 6888
diff changeset
1355 @table @code
ebff56d6b0a8 [project @ 2007-09-12 18:32:12 by jwe]
jwe
parents: 6888
diff changeset
1356 @item linestyle
ebff56d6b0a8 [project @ 2007-09-12 18:32:12 by jwe]
jwe
parents: 6888
diff changeset
1357 May be one of
ebff56d6b0a8 [project @ 2007-09-12 18:32:12 by jwe]
jwe
parents: 6888
diff changeset
1358 @table @code
ebff56d6b0a8 [project @ 2007-09-12 18:32:12 by jwe]
jwe
parents: 6888
diff changeset
1359 @item "-"
ebff56d6b0a8 [project @ 2007-09-12 18:32:12 by jwe]
jwe
parents: 6888
diff changeset
1360 Solid lines.
ebff56d6b0a8 [project @ 2007-09-12 18:32:12 by jwe]
jwe
parents: 6888
diff changeset
1361 @item "--"
ebff56d6b0a8 [project @ 2007-09-12 18:32:12 by jwe]
jwe
parents: 6888
diff changeset
1362 Dashed lines.
ebff56d6b0a8 [project @ 2007-09-12 18:32:12 by jwe]
jwe
parents: 6888
diff changeset
1363 @item ":"
ebff56d6b0a8 [project @ 2007-09-12 18:32:12 by jwe]
jwe
parents: 6888
diff changeset
1364 Points.
ebff56d6b0a8 [project @ 2007-09-12 18:32:12 by jwe]
jwe
parents: 6888
diff changeset
1365 @item "-."
ebff56d6b0a8 [project @ 2007-09-12 18:32:12 by jwe]
jwe
parents: 6888
diff changeset
1366 A dash-dot line.
ebff56d6b0a8 [project @ 2007-09-12 18:32:12 by jwe]
jwe
parents: 6888
diff changeset
1367 @end table
ebff56d6b0a8 [project @ 2007-09-12 18:32:12 by jwe]
jwe
parents: 6888
diff changeset
1368
ebff56d6b0a8 [project @ 2007-09-12 18:32:12 by jwe]
jwe
parents: 6888
diff changeset
1369 @item linewidth
ebff56d6b0a8 [project @ 2007-09-12 18:32:12 by jwe]
jwe
parents: 6888
diff changeset
1370 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
1371 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
1372 @end table
ebff56d6b0a8 [project @ 2007-09-12 18:32:12 by jwe]
jwe
parents: 6888
diff changeset
1373
ebff56d6b0a8 [project @ 2007-09-12 18:32:12 by jwe]
jwe
parents: 6888
diff changeset
1374 @node Marker Styles
ebff56d6b0a8 [project @ 2007-09-12 18:32:12 by jwe]
jwe
parents: 6888
diff changeset
1375 @subsection Marker Styles
8071
b6e85fb238c1 doc fixes
John W. Eaton <jwe@octave.org>
parents: 8070
diff changeset
1376 @cindex graphics marker styles
b6e85fb238c1 doc fixes
John W. Eaton <jwe@octave.org>
parents: 8070
diff changeset
1377 @cindex marker styles, graphics
b6e85fb238c1 doc fixes
John W. Eaton <jwe@octave.org>
parents: 8070
diff changeset
1378
7001
8b0cfeb06365 [project @ 2007-10-10 18:02:59 by jwe]
jwe
parents: 6899
diff changeset
1379 Marker styles are specified by the following properties:
6889
ebff56d6b0a8 [project @ 2007-09-12 18:32:12 by jwe]
jwe
parents: 6888
diff changeset
1380 @table @code
ebff56d6b0a8 [project @ 2007-09-12 18:32:12 by jwe]
jwe
parents: 6888
diff changeset
1381 @item marker
ebff56d6b0a8 [project @ 2007-09-12 18:32:12 by jwe]
jwe
parents: 6888
diff changeset
1382 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
1383 @code{"none"}, meaning no markers should be displayed.
ebff56d6b0a8 [project @ 2007-09-12 18:32:12 by jwe]
jwe
parents: 6888
diff changeset
1384
ebff56d6b0a8 [project @ 2007-09-12 18:32:12 by jwe]
jwe
parents: 6888
diff changeset
1385 @itemx markeredgecolor
ebff56d6b0a8 [project @ 2007-09-12 18:32:12 by jwe]
jwe
parents: 6888
diff changeset
1386 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
1387 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
1388
ebff56d6b0a8 [project @ 2007-09-12 18:32:12 by jwe]
jwe
parents: 6888
diff changeset
1389 @itemx markerfacecolor
ebff56d6b0a8 [project @ 2007-09-12 18:32:12 by jwe]
jwe
parents: 6888
diff changeset
1390 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
1391 should not be filled. @xref{Colors}.
ebff56d6b0a8 [project @ 2007-09-12 18:32:12 by jwe]
jwe
parents: 6888
diff changeset
1392
ebff56d6b0a8 [project @ 2007-09-12 18:32:12 by jwe]
jwe
parents: 6888
diff changeset
1393 @itemx markersize
ebff56d6b0a8 [project @ 2007-09-12 18:32:12 by jwe]
jwe
parents: 6888
diff changeset
1394 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
1395 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
1396 @end table
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
1397
8056
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents: 8055
diff changeset
1398 @node Callbacks
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents: 8055
diff changeset
1399 @subsection Callbacks
8071
b6e85fb238c1 doc fixes
John W. Eaton <jwe@octave.org>
parents: 8070
diff changeset
1400 @cindex callbacks
8056
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents: 8055
diff changeset
1401
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents: 8055
diff changeset
1402 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
1403 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
1404 is
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents: 8055
diff changeset
1405
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents: 8055
diff changeset
1406 @example
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents: 8055
diff changeset
1407 @group
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents: 8055
diff changeset
1408 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
1409 @dots{}
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents: 8055
diff changeset
1410 endfunction
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents: 8055
diff changeset
1411 @end group
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents: 8055
diff changeset
1412 @end example
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents: 8055
diff changeset
1413
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents: 8055
diff changeset
1414 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
1415 @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
1416 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
1417 @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
1418
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents: 8055
diff changeset
1419 @example
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents: 8055
diff changeset
1420 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
1421 @end example
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents: 8055
diff changeset
1422
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents: 8055
diff changeset
1423 @noindent
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents: 8055
diff changeset
1424 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
1425 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
1426
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents: 8055
diff changeset
1427 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
1428 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
1429
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents: 8055
diff changeset
1430 @example
8057
David Bateman <dbateman@free.fr>
parents: 8056
diff changeset
1431 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
1432 @dots{}
8057
David Bateman <dbateman@free.fr>
parents: 8056
diff changeset
1433 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
1434 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
1435 endfunction
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents: 8055
diff changeset
1436 @end example
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents: 8055
diff changeset
1437
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents: 8055
diff changeset
1438 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
1439 are
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents: 8055
diff changeset
1440
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents: 8055
diff changeset
1441 @itemize @bullet
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents: 8055
diff changeset
1442 @item CreateFcn
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 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
1444 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
1445 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
1446 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
1447 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
1448
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents: 8055
diff changeset
1449 @item DeleteFcn
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents: 8055
diff changeset
1450 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
1451
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents: 8055
diff changeset
1452 @item ButtonDownFcn
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents: 8055
diff changeset
1453 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
1454 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
1455 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
1456 @end itemize
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents: 8055
diff changeset
1457
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents: 8055
diff changeset
1458 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
1459 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
1460 functions.
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents: 8055
diff changeset
1461
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents: 8055
diff changeset
1462 @DOCSTRING(gcbo)
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents: 8055
diff changeset
1463
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents: 8055
diff changeset
1464 @DOCSTRING(gcbf)
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents: 8055
diff changeset
1465
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents: 8055
diff changeset
1466 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
1467 function described below.
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 @node Object Groups
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents: 8055
diff changeset
1470 @subsection Object Groups
8071
b6e85fb238c1 doc fixes
John W. Eaton <jwe@octave.org>
parents: 8070
diff changeset
1471 @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
1472
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents: 8055
diff changeset
1473 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
1474 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
1475 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
1476 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
1477 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
1478
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents: 8055
diff changeset
1479 @DOCSTRING(hggroup)
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents: 8055
diff changeset
1480
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents: 8055
diff changeset
1481 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
1482
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents: 8055
diff changeset
1483 @example
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents: 8055
diff changeset
1484 @group
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents: 8055
diff changeset
1485 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
1486 hg = hggroup ();
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents: 8055
diff changeset
1487 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
1488 hold on
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents: 8055
diff changeset
1489 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
1490 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
1491 @end group
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents: 8055
diff changeset
1492 @end example
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents: 8055
diff changeset
1493
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents: 8055
diff changeset
1494 @noindent
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents: 8055
diff changeset
1495 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
1496 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
1497 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
1498 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
1499 function.
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 @DOCSTRING(addproperty)
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 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
1504 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
1505 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
1506 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
1507 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
1508
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents: 8055
diff changeset
1509 @DOCSTRING(addlistener)
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents: 8055
diff changeset
1510
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents: 8055
diff changeset
1511 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
1512
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents: 8055
diff changeset
1513 @example
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents: 8055
diff changeset
1514 @group
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents: 8055
diff changeset
1515 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
1516 hg = hggroup ();
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents: 8055
diff changeset
1517 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
1518 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
1519 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
1520 hold on
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents: 8055
diff changeset
1521 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
1522
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents: 8055
diff changeset
1523 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
1524 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
1525 endfunction
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents: 8055
diff changeset
1526 @end group
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents: 8055
diff changeset
1527 @end example
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents: 8055
diff changeset
1528
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents: 8055
diff changeset
1529 @noindent
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents: 8055
diff changeset
1530 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
1531 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
1532 @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
1533
3b53b25e2550 Add data sources and line series
David Bateman <dbateman@free.fr>
parents: 8057
diff changeset
1534 @example
3b53b25e2550 Add data sources and line series
David Bateman <dbateman@free.fr>
parents: 8057
diff changeset
1535 @group
3b53b25e2550 Add data sources and line series
David Bateman <dbateman@free.fr>
parents: 8057
diff changeset
1536 x = 0:0.1:10;
3b53b25e2550 Add data sources and line series
David Bateman <dbateman@free.fr>
parents: 8057
diff changeset
1537 hg = hggroup ();
3b53b25e2550 Add data sources and line series
David Bateman <dbateman@free.fr>
parents: 8057
diff changeset
1538 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
1539 addproperty ("linestyle", hg, "linelinestyle", get (h, "linestyle"));
3b53b25e2550 Add data sources and line series
David Bateman <dbateman@free.fr>
parents: 8057
diff changeset
1540 hold on
3b53b25e2550 Add data sources and line series
David Bateman <dbateman@free.fr>
parents: 8057
diff changeset
1541 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
1542 hlink = linkprop ([hg, h1, h2], "color");
3b53b25e2550 Add data sources and line series
David Bateman <dbateman@free.fr>
parents: 8057
diff changeset
1543 @end group
3b53b25e2550 Add data sources and line series
David Bateman <dbateman@free.fr>
parents: 8057
diff changeset
1544 @end example
3b53b25e2550 Add data sources and line series
David Bateman <dbateman@free.fr>
parents: 8057
diff changeset
1545
3b53b25e2550 Add data sources and line series
David Bateman <dbateman@free.fr>
parents: 8057
diff changeset
1546 @DOCSTRING(linkprop)
8056
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 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
1549 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
1550 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
1551
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents: 8055
diff changeset
1552 @itemize @bullet
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents: 8055
diff changeset
1553 @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
1554 @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
1555 @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
1556 @end itemize
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents: 8055
diff changeset
1557
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents: 8055
diff changeset
1558 @noindent
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents: 8055
diff changeset
1559 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
1560 @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
1561 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
1562 @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
1563 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
1564 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 @example
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents: 8055
diff changeset
1567 @group
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents: 8055
diff changeset
1568 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
1569 get (h, "xdata")
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents: 8055
diff changeset
1570 @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
1571 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
1572 @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
1573 @end group
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents: 8055
diff changeset
1574 @end example
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 @noindent
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents: 8055
diff changeset
1577 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
1578 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
1579
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents: 8055
diff changeset
1580 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
1581 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
1582 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
1583 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
1584 member.
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents: 8055
diff changeset
1585
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents: 8055
diff changeset
1586 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
1587 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
1588 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
1589 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
1590 corresponding hggroup elements.
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents: 8055
diff changeset
1591
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents: 8055
diff changeset
1592 @menu
8070
3b53b25e2550 Add data sources and line series
David Bateman <dbateman@free.fr>
parents: 8057
diff changeset
1593 * 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
1594 * Area series::
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents: 8055
diff changeset
1595 * Bar series::
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents: 8055
diff changeset
1596 * Contour groups::
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents: 8055
diff changeset
1597 * Error bar series::
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents: 8055
diff changeset
1598 * Line series::
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents: 8055
diff changeset
1599 * Quiver group::
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents: 8055
diff changeset
1600 * Scatter group::
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents: 8055
diff changeset
1601 * Stair group::
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents: 8055
diff changeset
1602 * Stem Series::
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents: 8055
diff changeset
1603 * Surface group::
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents: 8055
diff changeset
1604 @end menu
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents: 8055
diff changeset
1605
8070
3b53b25e2550 Add data sources and line series
David Bateman <dbateman@free.fr>
parents: 8057
diff changeset
1606 @node Data sources in object groups
3b53b25e2550 Add data sources and line series
David Bateman <dbateman@free.fr>
parents: 8057
diff changeset
1607 @subsubsection Data sources in object groups
8071
b6e85fb238c1 doc fixes
John W. Eaton <jwe@octave.org>
parents: 8070
diff changeset
1608 @cindex data sources in object groups
8070
3b53b25e2550 Add data sources and line series
David Bateman <dbateman@free.fr>
parents: 8057
diff changeset
1609
3b53b25e2550 Add data sources and line series
David Bateman <dbateman@free.fr>
parents: 8057
diff changeset
1610 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
1611 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
1612 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
1613 function is called.
3b53b25e2550 Add data sources and line series
David Bateman <dbateman@free.fr>
parents: 8057
diff changeset
1614
3b53b25e2550 Add data sources and line series
David Bateman <dbateman@free.fr>
parents: 8057
diff changeset
1615 @DOCSTRING(refreshdata)
3b53b25e2550 Add data sources and line series
David Bateman <dbateman@free.fr>
parents: 8057
diff changeset
1616
8286
6f2d95255911 fix @seealso references to point to existing anchors
Thorsten Meyer <thorsten.meyier@gmx.de>
parents: 8261
diff changeset
1617 @anchor{doc-linkdata}
8070
3b53b25e2550 Add data sources and line series
David Bateman <dbateman@free.fr>
parents: 8057
diff changeset
1618 @c add the description of the linkdata function here when it is written
8286
6f2d95255911 fix @seealso references to point to existing anchors
Thorsten Meyer <thorsten.meyier@gmx.de>
parents: 8261
diff changeset
1619 @c remove the explicit anchor when you add the corresponding @DOCSTRING
6f2d95255911 fix @seealso references to point to existing anchors
Thorsten Meyer <thorsten.meyier@gmx.de>
parents: 8261
diff changeset
1620 @c command
8070
3b53b25e2550 Add data sources and line series
David Bateman <dbateman@free.fr>
parents: 8057
diff changeset
1621
8056
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents: 8055
diff changeset
1622 @node Area series
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents: 8055
diff changeset
1623 @subsubsection Area series
8071
b6e85fb238c1 doc fixes
John W. Eaton <jwe@octave.org>
parents: 8070
diff changeset
1624 @cindex series objects
b6e85fb238c1 doc fixes
John W. Eaton <jwe@octave.org>
parents: 8070
diff changeset
1625 @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
1626
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents: 8055
diff changeset
1627 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
1628 @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
1629 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
1630
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents: 8055
diff changeset
1631 @table @code
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents: 8055
diff changeset
1632 @item basevalue
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents: 8055
diff changeset
1633 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
1634
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents: 8055
diff changeset
1635 @item linewidth
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents: 8055
diff changeset
1636 @itemx linestyle
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents: 8055
diff changeset
1637 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
1638 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
1639
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents: 8055
diff changeset
1640 @item edgecolor
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents: 8055
diff changeset
1641 @itemx facecolor
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents: 8055
diff changeset
1642 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
1643
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents: 8055
diff changeset
1644 @item xdata
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents: 8055
diff changeset
1645 @itemx ydata
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents: 8055
diff changeset
1646 The x and y coordinates of the original columns of the data passed to
8325
b93ac0586e4b spelling corrections
Brian Gough<bjg@network-theory.co.uk>
parents: 8297
diff changeset
1647 @code{area} prior to the cumulative summation used in the @code{area}
8056
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents: 8055
diff changeset
1648 function.
8070
3b53b25e2550 Add data sources and line series
David Bateman <dbateman@free.fr>
parents: 8057
diff changeset
1649
3b53b25e2550 Add data sources and line series
David Bateman <dbateman@free.fr>
parents: 8057
diff changeset
1650 @item xdatasource
3b53b25e2550 Add data sources and line series
David Bateman <dbateman@free.fr>
parents: 8057
diff changeset
1651 @itemx ydatasource
3b53b25e2550 Add data sources and line series
David Bateman <dbateman@free.fr>
parents: 8057
diff changeset
1652 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
1653 @end table
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents: 8055
diff changeset
1654
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents: 8055
diff changeset
1655 @node Bar series
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents: 8055
diff changeset
1656 @subsubsection Bar series
8071
b6e85fb238c1 doc fixes
John W. Eaton <jwe@octave.org>
parents: 8070
diff changeset
1657 @cindex series objects
b6e85fb238c1 doc fixes
John W. Eaton <jwe@octave.org>
parents: 8070
diff changeset
1658 @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
1659
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents: 8055
diff changeset
1660 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
1661 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
1662 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
1663
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents: 8055
diff changeset
1664 @table @code
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents: 8055
diff changeset
1665 @item showbaseline
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents: 8055
diff changeset
1666 @itemx baseline
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents: 8055
diff changeset
1667 @itemx basevalue
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{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
1669 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
1670 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
1671 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
1672
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents: 8055
diff changeset
1673 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
1674 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
1675 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
1676 corresponding bar series.
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents: 8055
diff changeset
1677
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents: 8055
diff changeset
1678 @item barwidth
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents: 8055
diff changeset
1679 @itemx barlayout
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents: 8055
diff changeset
1680 @itemx horizontal
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents: 8055
diff changeset
1681 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
1682 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
1683 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
1684 @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
1685 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
1686
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents: 8055
diff changeset
1687 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
1688 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 linewidth
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents: 8055
diff changeset
1691 @itemx linestyle
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents: 8055
diff changeset
1692 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
1693 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
1694
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents: 8055
diff changeset
1695 @item edgecolor
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents: 8055
diff changeset
1696 @itemx facecolor
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents: 8055
diff changeset
1697 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
1698
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents: 8055
diff changeset
1699 @item xdata
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents: 8055
diff changeset
1700 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
1701 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
1702
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents: 8055
diff changeset
1703 @item ydata
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents: 8055
diff changeset
1704 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
1705
3b53b25e2550 Add data sources and line series
David Bateman <dbateman@free.fr>
parents: 8057
diff changeset
1706 @item xdatasource
3b53b25e2550 Add data sources and line series
David Bateman <dbateman@free.fr>
parents: 8057
diff changeset
1707 @itemx ydatasource
3b53b25e2550 Add data sources and line series
David Bateman <dbateman@free.fr>
parents: 8057
diff changeset
1708 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
1709 @end table
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents: 8055
diff changeset
1710
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents: 8055
diff changeset
1711 @node Contour groups
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents: 8055
diff changeset
1712 @subsubsection Contour groups
8071
b6e85fb238c1 doc fixes
John W. Eaton <jwe@octave.org>
parents: 8070
diff changeset
1713 @cindex series objects
b6e85fb238c1 doc fixes
John W. Eaton <jwe@octave.org>
parents: 8070
diff changeset
1714 @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
1715
8289
ac7f334d9652 Add contour group objects and the clabel function
David Bateman <dbateman@free.fr>
parents: 8286
diff changeset
1716 Contour group objects are created by the @code{contour}, @code{contourf}
ac7f334d9652 Add contour group objects and the clabel function
David Bateman <dbateman@free.fr>
parents: 8286
diff changeset
1717 and @code{contour3} functions. The are equally one of the handles returned
ac7f334d9652 Add contour group objects and the clabel function
David Bateman <dbateman@free.fr>
parents: 8286
diff changeset
1718 by the @code{surfc} and @code{meshc} functions. The properties of the contour
ac7f334d9652 Add contour group objects and the clabel function
David Bateman <dbateman@free.fr>
parents: 8286
diff changeset
1719 group are
ac7f334d9652 Add contour group objects and the clabel function
David Bateman <dbateman@free.fr>
parents: 8286
diff changeset
1720
ac7f334d9652 Add contour group objects and the clabel function
David Bateman <dbateman@free.fr>
parents: 8286
diff changeset
1721 @table @code
ac7f334d9652 Add contour group objects and the clabel function
David Bateman <dbateman@free.fr>
parents: 8286
diff changeset
1722 @item contourmatrix
ac7f334d9652 Add contour group objects and the clabel function
David Bateman <dbateman@free.fr>
parents: 8286
diff changeset
1723 A read only property that contains the data return by @code{contourc} used to
ac7f334d9652 Add contour group objects and the clabel function
David Bateman <dbateman@free.fr>
parents: 8286
diff changeset
1724 create the contours of the plot.
ac7f334d9652 Add contour group objects and the clabel function
David Bateman <dbateman@free.fr>
parents: 8286
diff changeset
1725
ac7f334d9652 Add contour group objects and the clabel function
David Bateman <dbateman@free.fr>
parents: 8286
diff changeset
1726 @item fill
ac7f334d9652 Add contour group objects and the clabel function
David Bateman <dbateman@free.fr>
parents: 8286
diff changeset
1727 A radio property that can have the values "on" or "off" that flags whether the
ac7f334d9652 Add contour group objects and the clabel function
David Bateman <dbateman@free.fr>
parents: 8286
diff changeset
1728 contours to plot are to be filled.
ac7f334d9652 Add contour group objects and the clabel function
David Bateman <dbateman@free.fr>
parents: 8286
diff changeset
1729
ac7f334d9652 Add contour group objects and the clabel function
David Bateman <dbateman@free.fr>
parents: 8286
diff changeset
1730 @item zlevelmode
ac7f334d9652 Add contour group objects and the clabel function
David Bateman <dbateman@free.fr>
parents: 8286
diff changeset
1731 @itemx zlevel
ac7f334d9652 Add contour group objects and the clabel function
David Bateman <dbateman@free.fr>
parents: 8286
diff changeset
1732 The radio property @code{zlevelmode} can have the values "none", "auto" or
ac7f334d9652 Add contour group objects and the clabel function
David Bateman <dbateman@free.fr>
parents: 8286
diff changeset
1733 "manual". When its value is "none" there is no z component to the plotted
ac7f334d9652 Add contour group objects and the clabel function
David Bateman <dbateman@free.fr>
parents: 8286
diff changeset
1734 contours. When its value is "auto" the z value of the plotted contours is
ac7f334d9652 Add contour group objects and the clabel function
David Bateman <dbateman@free.fr>
parents: 8286
diff changeset
1735 at the same value as the contour itself. If the value is "manual", then the
ac7f334d9652 Add contour group objects and the clabel function
David Bateman <dbateman@free.fr>
parents: 8286
diff changeset
1736 z value at which to plot the contour is determined by the @code{zlevel}
ac7f334d9652 Add contour group objects and the clabel function
David Bateman <dbateman@free.fr>
parents: 8286
diff changeset
1737 property.
ac7f334d9652 Add contour group objects and the clabel function
David Bateman <dbateman@free.fr>
parents: 8286
diff changeset
1738
ac7f334d9652 Add contour group objects and the clabel function
David Bateman <dbateman@free.fr>
parents: 8286
diff changeset
1739 @item levellistmode
ac7f334d9652 Add contour group objects and the clabel function
David Bateman <dbateman@free.fr>
parents: 8286
diff changeset
1740 @itemx levellist
ac7f334d9652 Add contour group objects and the clabel function
David Bateman <dbateman@free.fr>
parents: 8286
diff changeset
1741 @itemx levelstepmode
ac7f334d9652 Add contour group objects and the clabel function
David Bateman <dbateman@free.fr>
parents: 8286
diff changeset
1742 @itemx levelstep
ac7f334d9652 Add contour group objects and the clabel function
David Bateman <dbateman@free.fr>
parents: 8286
diff changeset
1743 If @code{levellistmode} is "manual", then the levels at whch to plot the
ac7f334d9652 Add contour group objects and the clabel function
David Bateman <dbateman@free.fr>
parents: 8286
diff changeset
1744 contours is determined by @code{levellist}. If @code{levellistmode} is
ac7f334d9652 Add contour group objects and the clabel function
David Bateman <dbateman@free.fr>
parents: 8286
diff changeset
1745 set to "auto", then the distance between contours is determined by
ac7f334d9652 Add contour group objects and the clabel function
David Bateman <dbateman@free.fr>
parents: 8286
diff changeset
1746 @code{levelstep}. If both @code{levellistmode} and @code{levelstepmode}
ac7f334d9652 Add contour group objects and the clabel function
David Bateman <dbateman@free.fr>
parents: 8286
diff changeset
1747 are set to "auto", then there are assumed to be 10 equal spaced contours.
ac7f334d9652 Add contour group objects and the clabel function
David Bateman <dbateman@free.fr>
parents: 8286
diff changeset
1748
ac7f334d9652 Add contour group objects and the clabel function
David Bateman <dbateman@free.fr>
parents: 8286
diff changeset
1749 @item textlistmode
ac7f334d9652 Add contour group objects and the clabel function
David Bateman <dbateman@free.fr>
parents: 8286
diff changeset
1750 @itemx textlist
ac7f334d9652 Add contour group objects and the clabel function
David Bateman <dbateman@free.fr>
parents: 8286
diff changeset
1751 @itemx textstepmode
ac7f334d9652 Add contour group objects and the clabel function
David Bateman <dbateman@free.fr>
parents: 8286
diff changeset
1752 @itemx textstep
ac7f334d9652 Add contour group objects and the clabel function
David Bateman <dbateman@free.fr>
parents: 8286
diff changeset
1753 If @code{textlistmode} is "manual", then the labelled contours
ac7f334d9652 Add contour group objects and the clabel function
David Bateman <dbateman@free.fr>
parents: 8286
diff changeset
1754 is determined by @code{textlist}. If @code{textlistmode} is set to
ac7f334d9652 Add contour group objects and the clabel function
David Bateman <dbateman@free.fr>
parents: 8286
diff changeset
1755 "auto", then the distance between labelled contours is determined by
ac7f334d9652 Add contour group objects and the clabel function
David Bateman <dbateman@free.fr>
parents: 8286
diff changeset
1756 @code{textstep}. If both @code{textlistmode} and @code{textstepmode}
ac7f334d9652 Add contour group objects and the clabel function
David Bateman <dbateman@free.fr>
parents: 8286
diff changeset
1757 are set to "auto", then there are assumed to be 10 equal spaced
ac7f334d9652 Add contour group objects and the clabel function
David Bateman <dbateman@free.fr>
parents: 8286
diff changeset
1758 labelled contours.
ac7f334d9652 Add contour group objects and the clabel function
David Bateman <dbateman@free.fr>
parents: 8286
diff changeset
1759
ac7f334d9652 Add contour group objects and the clabel function
David Bateman <dbateman@free.fr>
parents: 8286
diff changeset
1760 @item showtext
ac7f334d9652 Add contour group objects and the clabel function
David Bateman <dbateman@free.fr>
parents: 8286
diff changeset
1761 Flag whether the contour labels are shown or not.
ac7f334d9652 Add contour group objects and the clabel function
David Bateman <dbateman@free.fr>
parents: 8286
diff changeset
1762
ac7f334d9652 Add contour group objects and the clabel function
David Bateman <dbateman@free.fr>
parents: 8286
diff changeset
1763 @item labelspacing
ac7f334d9652 Add contour group objects and the clabel function
David Bateman <dbateman@free.fr>
parents: 8286
diff changeset
1764 The distance between labels on a single contour in points.
ac7f334d9652 Add contour group objects and the clabel function
David Bateman <dbateman@free.fr>
parents: 8286
diff changeset
1765
ac7f334d9652 Add contour group objects and the clabel function
David Bateman <dbateman@free.fr>
parents: 8286
diff changeset
1766 @item linewidth
ac7f334d9652 Add contour group objects and the clabel function
David Bateman <dbateman@free.fr>
parents: 8286
diff changeset
1767 @item linestyle
ac7f334d9652 Add contour group objects and the clabel function
David Bateman <dbateman@free.fr>
parents: 8286
diff changeset
1768 @item linecolor
ac7f334d9652 Add contour group objects and the clabel function
David Bateman <dbateman@free.fr>
parents: 8286
diff changeset
1769 The properties of the contour lines. The properties @code{linewidth} and
ac7f334d9652 Add contour group objects and the clabel function
David Bateman <dbateman@free.fr>
parents: 8286
diff changeset
1770 @code{linestyle} are similar to the correponding properties for lines. The
8297
dc62132651db doc fixes
John W. Eaton <jwe@octave.org>
parents: 8289
diff changeset
1771 property @code{linecolor} is a color property (@pxref{Colors}), that can also
8289
ac7f334d9652 Add contour group objects and the clabel function
David Bateman <dbateman@free.fr>
parents: 8286
diff changeset
1772 have the values of "none" or "auto". If @code{linecolor} is "none", then no
ac7f334d9652 Add contour group objects and the clabel function
David Bateman <dbateman@free.fr>
parents: 8286
diff changeset
1773 contour line is drawn. If @code{linecolor} is "auto" then the line color is
ac7f334d9652 Add contour group objects and the clabel function
David Bateman <dbateman@free.fr>
parents: 8286
diff changeset
1774 determined by the colormap.
ac7f334d9652 Add contour group objects and the clabel function
David Bateman <dbateman@free.fr>
parents: 8286
diff changeset
1775
ac7f334d9652 Add contour group objects and the clabel function
David Bateman <dbateman@free.fr>
parents: 8286
diff changeset
1776 @item xdata
ac7f334d9652 Add contour group objects and the clabel function
David Bateman <dbateman@free.fr>
parents: 8286
diff changeset
1777 @itemx ydata
ac7f334d9652 Add contour group objects and the clabel function
David Bateman <dbateman@free.fr>
parents: 8286
diff changeset
1778 @itemx zdata
ac7f334d9652 Add contour group objects and the clabel function
David Bateman <dbateman@free.fr>
parents: 8286
diff changeset
1779 The original x, y, and z data of the contour lines.
ac7f334d9652 Add contour group objects and the clabel function
David Bateman <dbateman@free.fr>
parents: 8286
diff changeset
1780
ac7f334d9652 Add contour group objects and the clabel function
David Bateman <dbateman@free.fr>
parents: 8286
diff changeset
1781 @item xdatasource
ac7f334d9652 Add contour group objects and the clabel function
David Bateman <dbateman@free.fr>
parents: 8286
diff changeset
1782 @itemx ydatasource
ac7f334d9652 Add contour group objects and the clabel function
David Bateman <dbateman@free.fr>
parents: 8286
diff changeset
1783 @itemx zdatasource
ac7f334d9652 Add contour group objects and the clabel function
David Bateman <dbateman@free.fr>
parents: 8286
diff changeset
1784 Data source variables.
ac7f334d9652 Add contour group objects and the clabel function
David Bateman <dbateman@free.fr>
parents: 8286
diff changeset
1785 @end table
8056
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents: 8055
diff changeset
1786
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents: 8055
diff changeset
1787 @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
1788 @subsubsection Error bar series
8071
b6e85fb238c1 doc fixes
John W. Eaton <jwe@octave.org>
parents: 8070
diff changeset
1789 @cindex series objects
b6e85fb238c1 doc fixes
John W. Eaton <jwe@octave.org>
parents: 8070
diff changeset
1790 @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
1791
8258
2b408bbd8904 Add error bar series
David Bateman <dbateman@free.fr>
parents: 8257
diff changeset
1792 Error bar series are created by the @code{errorbar} function. Each
2b408bbd8904 Add error bar series
David Bateman <dbateman@free.fr>
parents: 8257
diff changeset
1793 @code{hgrroup} element contains two line objects represnting the data and
2b408bbd8904 Add error bar series
David Bateman <dbateman@free.fr>
parents: 8257
diff changeset
1794 the errorbars separately. The properties of the error bar series are
2b408bbd8904 Add error bar series
David Bateman <dbateman@free.fr>
parents: 8257
diff changeset
1795
2b408bbd8904 Add error bar series
David Bateman <dbateman@free.fr>
parents: 8257
diff changeset
1796 @table @code
2b408bbd8904 Add error bar series
David Bateman <dbateman@free.fr>
parents: 8257
diff changeset
1797 @item color
2b408bbd8904 Add error bar series
David Bateman <dbateman@free.fr>
parents: 8257
diff changeset
1798 The RGB color or color name of the line objects of the error bars. @xref{Colors}.
2b408bbd8904 Add error bar series
David Bateman <dbateman@free.fr>
parents: 8257
diff changeset
1799
2b408bbd8904 Add error bar series
David Bateman <dbateman@free.fr>
parents: 8257
diff changeset
1800 @item linewidth
2b408bbd8904 Add error bar series
David Bateman <dbateman@free.fr>
parents: 8257
diff changeset
1801 @itemx linestyle
2b408bbd8904 Add error bar series
David Bateman <dbateman@free.fr>
parents: 8257
diff changeset
1802 The line width and style of the line objects of the error bars. @xref{Line Styles}.
2b408bbd8904 Add error bar series
David Bateman <dbateman@free.fr>
parents: 8257
diff changeset
1803
2b408bbd8904 Add error bar series
David Bateman <dbateman@free.fr>
parents: 8257
diff changeset
1804 @item marker
2b408bbd8904 Add error bar series
David Bateman <dbateman@free.fr>
parents: 8257
diff changeset
1805 @itemx markeredgecolor
2b408bbd8904 Add error bar series
David Bateman <dbateman@free.fr>
parents: 8257
diff changeset
1806 @itemx markerfacecolor
2b408bbd8904 Add error bar series
David Bateman <dbateman@free.fr>
parents: 8257
diff changeset
1807 @itemx markersize
2b408bbd8904 Add error bar series
David Bateman <dbateman@free.fr>
parents: 8257
diff changeset
1808 The line and fill color of the markers on the error bars. @xref{Colors}.
2b408bbd8904 Add error bar series
David Bateman <dbateman@free.fr>
parents: 8257
diff changeset
1809
2b408bbd8904 Add error bar series
David Bateman <dbateman@free.fr>
parents: 8257
diff changeset
1810 @item xdata
2b408bbd8904 Add error bar series
David Bateman <dbateman@free.fr>
parents: 8257
diff changeset
1811 @itemx ydata
2b408bbd8904 Add error bar series
David Bateman <dbateman@free.fr>
parents: 8257
diff changeset
1812 @itemx ldata
2b408bbd8904 Add error bar series
David Bateman <dbateman@free.fr>
parents: 8257
diff changeset
1813 @itemx udata
2b408bbd8904 Add error bar series
David Bateman <dbateman@free.fr>
parents: 8257
diff changeset
1814 @itemx xldata
2b408bbd8904 Add error bar series
David Bateman <dbateman@free.fr>
parents: 8257
diff changeset
1815 @itemx xudata
2b408bbd8904 Add error bar series
David Bateman <dbateman@free.fr>
parents: 8257
diff changeset
1816 The original x, y, l, u, xl, xu data of the error bars.
2b408bbd8904 Add error bar series
David Bateman <dbateman@free.fr>
parents: 8257
diff changeset
1817
2b408bbd8904 Add error bar series
David Bateman <dbateman@free.fr>
parents: 8257
diff changeset
1818 @item xdatasource
2b408bbd8904 Add error bar series
David Bateman <dbateman@free.fr>
parents: 8257
diff changeset
1819 @itemx ydatasource
2b408bbd8904 Add error bar series
David Bateman <dbateman@free.fr>
parents: 8257
diff changeset
1820 @itemx ldatasource
2b408bbd8904 Add error bar series
David Bateman <dbateman@free.fr>
parents: 8257
diff changeset
1821 @itemx udatasource
2b408bbd8904 Add error bar series
David Bateman <dbateman@free.fr>
parents: 8257
diff changeset
1822 @itemx xldatasource
2b408bbd8904 Add error bar series
David Bateman <dbateman@free.fr>
parents: 8257
diff changeset
1823 @itemx xudatasource
2b408bbd8904 Add error bar series
David Bateman <dbateman@free.fr>
parents: 8257
diff changeset
1824 Data source variables.
2b408bbd8904 Add error bar series
David Bateman <dbateman@free.fr>
parents: 8257
diff changeset
1825 @end table
2b408bbd8904 Add error bar series
David Bateman <dbateman@free.fr>
parents: 8257
diff changeset
1826
8056
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents: 8055
diff changeset
1827 @node Line series
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents: 8055
diff changeset
1828 @subsubsection Line series
8071
b6e85fb238c1 doc fixes
John W. Eaton <jwe@octave.org>
parents: 8070
diff changeset
1829 @cindex series objects
b6e85fb238c1 doc fixes
John W. Eaton <jwe@octave.org>
parents: 8070
diff changeset
1830 @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
1831
8257
79c874fe5100 More plot object updates
David Bateman <dbateman@free.fr>
parents: 8089
diff changeset
1832 Line series objects are created by the @code{plot} and @code{plot3}
79c874fe5100 More plot object updates
David Bateman <dbateman@free.fr>
parents: 8089
diff changeset
1833 functions and are of the type @code{line}. The properties of the
79c874fe5100 More plot object updates
David Bateman <dbateman@free.fr>
parents: 8089
diff changeset
1834 line series with the ability to add data sources.
8070
3b53b25e2550 Add data sources and line series
David Bateman <dbateman@free.fr>
parents: 8057
diff changeset
1835
3b53b25e2550 Add data sources and line series
David Bateman <dbateman@free.fr>
parents: 8057
diff changeset
1836 @table @code
3b53b25e2550 Add data sources and line series
David Bateman <dbateman@free.fr>
parents: 8057
diff changeset
1837 @item color
8257
79c874fe5100 More plot object updates
David Bateman <dbateman@free.fr>
parents: 8089
diff changeset
1838 The RGB color or color name of the line objects. @xref{Colors}.
8070
3b53b25e2550 Add data sources and line series
David Bateman <dbateman@free.fr>
parents: 8057
diff changeset
1839
3b53b25e2550 Add data sources and line series
David Bateman <dbateman@free.fr>
parents: 8057
diff changeset
1840 @item linewidth
3b53b25e2550 Add data sources and line series
David Bateman <dbateman@free.fr>
parents: 8057
diff changeset
1841 @itemx linestyle
8257
79c874fe5100 More plot object updates
David Bateman <dbateman@free.fr>
parents: 8089
diff changeset
1842 The line width and style of the line objects. @xref{Line Styles}.
8070
3b53b25e2550 Add data sources and line series
David Bateman <dbateman@free.fr>
parents: 8057
diff changeset
1843
3b53b25e2550 Add data sources and line series
David Bateman <dbateman@free.fr>
parents: 8057
diff changeset
1844 @item marker
3b53b25e2550 Add data sources and line series
David Bateman <dbateman@free.fr>
parents: 8057
diff changeset
1845 @itemx markeredgecolor
3b53b25e2550 Add data sources and line series
David Bateman <dbateman@free.fr>
parents: 8057
diff changeset
1846 @itemx markerfacecolor
3b53b25e2550 Add data sources and line series
David Bateman <dbateman@free.fr>
parents: 8057
diff changeset
1847 @itemx markersize
8257
79c874fe5100 More plot object updates
David Bateman <dbateman@free.fr>
parents: 8089
diff changeset
1848 The line and fill color of the markers. @xref{Colors}.
8070
3b53b25e2550 Add data sources and line series
David Bateman <dbateman@free.fr>
parents: 8057
diff changeset
1849
3b53b25e2550 Add data sources and line series
David Bateman <dbateman@free.fr>
parents: 8057
diff changeset
1850 @item xdata
3b53b25e2550 Add data sources and line series
David Bateman <dbateman@free.fr>
parents: 8057
diff changeset
1851 @itemx ydata
3b53b25e2550 Add data sources and line series
David Bateman <dbateman@free.fr>
parents: 8057
diff changeset
1852 @itemx zdata
8257
79c874fe5100 More plot object updates
David Bateman <dbateman@free.fr>
parents: 8089
diff changeset
1853 The original x, y and z data.
8070
3b53b25e2550 Add data sources and line series
David Bateman <dbateman@free.fr>
parents: 8057
diff changeset
1854
3b53b25e2550 Add data sources and line series
David Bateman <dbateman@free.fr>
parents: 8057
diff changeset
1855 @item xdatasource
3b53b25e2550 Add data sources and line series
David Bateman <dbateman@free.fr>
parents: 8057
diff changeset
1856 @itemx ydatasource
3b53b25e2550 Add data sources and line series
David Bateman <dbateman@free.fr>
parents: 8057
diff changeset
1857 @itemx zdatasource
3b53b25e2550 Add data sources and line series
David Bateman <dbateman@free.fr>
parents: 8057
diff changeset
1858 Data source variables.
3b53b25e2550 Add data sources and line series
David Bateman <dbateman@free.fr>
parents: 8057
diff changeset
1859 @end table
8056
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents: 8055
diff changeset
1860
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents: 8055
diff changeset
1861 @node Quiver group
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents: 8055
diff changeset
1862 @subsubsection Quiver group
8071
b6e85fb238c1 doc fixes
John W. Eaton <jwe@octave.org>
parents: 8070
diff changeset
1863 @cindex group objects
b6e85fb238c1 doc fixes
John W. Eaton <jwe@octave.org>
parents: 8070
diff changeset
1864 @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
1865
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents: 8055
diff changeset
1866 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
1867 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
1868 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
1869 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
1870 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
1871
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents: 8055
diff changeset
1872 @table @code
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents: 8055
diff changeset
1873 @item autoscale
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents: 8055
diff changeset
1874 @itemx autoscalefactor
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents: 8055
diff changeset
1875 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
1876 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
1877 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
1878 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
1879
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents: 8055
diff changeset
1880 @item maxheadsize
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents: 8055
diff changeset
1881 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
1882 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
1883
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents: 8055
diff changeset
1884 @item showarrowhead
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents: 8055
diff changeset
1885 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
1886
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents: 8055
diff changeset
1887 @item color
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents: 8055
diff changeset
1888 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
1889
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents: 8055
diff changeset
1890 @item linewidth
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents: 8055
diff changeset
1891 @itemx linestyle
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents: 8055
diff changeset
1892 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
1893
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents: 8055
diff changeset
1894 @item marker
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents: 8055
diff changeset
1895 @itemx markerfacecolor
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents: 8055
diff changeset
1896 @itemx markersize
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents: 8055
diff changeset
1897 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
1898 arrows. @xref{Colors}.
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents: 8055
diff changeset
1899
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents: 8055
diff changeset
1900 @item xdata
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents: 8055
diff changeset
1901 @itemx ydata
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents: 8055
diff changeset
1902 @itemx zdata
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents: 8055
diff changeset
1903 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
1904
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents: 8055
diff changeset
1905 @item udata
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents: 8055
diff changeset
1906 @itemx vdata
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents: 8055
diff changeset
1907 @itemx wdata
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents: 8055
diff changeset
1908 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
1909
3b53b25e2550 Add data sources and line series
David Bateman <dbateman@free.fr>
parents: 8057
diff changeset
1910 @item xdatasource
3b53b25e2550 Add data sources and line series
David Bateman <dbateman@free.fr>
parents: 8057
diff changeset
1911 @itemx ydatasource
3b53b25e2550 Add data sources and line series
David Bateman <dbateman@free.fr>
parents: 8057
diff changeset
1912 @itemx zdatasource
3b53b25e2550 Add data sources and line series
David Bateman <dbateman@free.fr>
parents: 8057
diff changeset
1913 @itemx udatasource
3b53b25e2550 Add data sources and line series
David Bateman <dbateman@free.fr>
parents: 8057
diff changeset
1914 @itemx vdatasource
3b53b25e2550 Add data sources and line series
David Bateman <dbateman@free.fr>
parents: 8057
diff changeset
1915 @itemx wdatasource
3b53b25e2550 Add data sources and line series
David Bateman <dbateman@free.fr>
parents: 8057
diff changeset
1916 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
1917 @end table
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents: 8055
diff changeset
1918
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents: 8055
diff changeset
1919 @node Scatter group
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents: 8055
diff changeset
1920 @subsubsection Scatter group
8071
b6e85fb238c1 doc fixes
John W. Eaton <jwe@octave.org>
parents: 8070
diff changeset
1921 @cindex group objects
b6e85fb238c1 doc fixes
John W. Eaton <jwe@octave.org>
parents: 8070
diff changeset
1922 @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
1923
8257
79c874fe5100 More plot object updates
David Bateman <dbateman@free.fr>
parents: 8089
diff changeset
1924 Scatter series objects are created by the @code{scatter} or @code{scatter3}
79c874fe5100 More plot object updates
David Bateman <dbateman@free.fr>
parents: 8089
diff changeset
1925 functions. A single hggroup element contains as many children as there are
79c874fe5100 More plot object updates
David Bateman <dbateman@free.fr>
parents: 8089
diff changeset
1926 points in the scatter plot, with each child representing one of the points.
79c874fe5100 More plot object updates
David Bateman <dbateman@free.fr>
parents: 8089
diff changeset
1927 The properties of the stem series are
79c874fe5100 More plot object updates
David Bateman <dbateman@free.fr>
parents: 8089
diff changeset
1928
79c874fe5100 More plot object updates
David Bateman <dbateman@free.fr>
parents: 8089
diff changeset
1929 @table @code
79c874fe5100 More plot object updates
David Bateman <dbateman@free.fr>
parents: 8089
diff changeset
1930 @item linewidth
79c874fe5100 More plot object updates
David Bateman <dbateman@free.fr>
parents: 8089
diff changeset
1931 The line width of the line objects of the points. @xref{Line Styles}.
79c874fe5100 More plot object updates
David Bateman <dbateman@free.fr>
parents: 8089
diff changeset
1932
79c874fe5100 More plot object updates
David Bateman <dbateman@free.fr>
parents: 8089
diff changeset
1933 @item marker
79c874fe5100 More plot object updates
David Bateman <dbateman@free.fr>
parents: 8089
diff changeset
1934 @itemx markeredgecolor
79c874fe5100 More plot object updates
David Bateman <dbateman@free.fr>
parents: 8089
diff changeset
1935 @itemx markerfacecolor
79c874fe5100 More plot object updates
David Bateman <dbateman@free.fr>
parents: 8089
diff changeset
1936 The line and fill color of the markers of the points. @xref{Colors}.
79c874fe5100 More plot object updates
David Bateman <dbateman@free.fr>
parents: 8089
diff changeset
1937
79c874fe5100 More plot object updates
David Bateman <dbateman@free.fr>
parents: 8089
diff changeset
1938 @item xdata
79c874fe5100 More plot object updates
David Bateman <dbateman@free.fr>
parents: 8089
diff changeset
1939 @itemx ydata
79c874fe5100 More plot object updates
David Bateman <dbateman@free.fr>
parents: 8089
diff changeset
1940 @itemx zdata
79c874fe5100 More plot object updates
David Bateman <dbateman@free.fr>
parents: 8089
diff changeset
1941 The original x, y and z data of the stems.
79c874fe5100 More plot object updates
David Bateman <dbateman@free.fr>
parents: 8089
diff changeset
1942
79c874fe5100 More plot object updates
David Bateman <dbateman@free.fr>
parents: 8089
diff changeset
1943 @item cdata
79c874fe5100 More plot object updates
David Bateman <dbateman@free.fr>
parents: 8089
diff changeset
1944 The color data for the points of the plot. Each point can have a separate
79c874fe5100 More plot object updates
David Bateman <dbateman@free.fr>
parents: 8089
diff changeset
1945 color, or a unique color can be specified.
79c874fe5100 More plot object updates
David Bateman <dbateman@free.fr>
parents: 8089
diff changeset
1946
79c874fe5100 More plot object updates
David Bateman <dbateman@free.fr>
parents: 8089
diff changeset
1947 @item sizedata
79c874fe5100 More plot object updates
David Bateman <dbateman@free.fr>
parents: 8089
diff changeset
1948 The size data for the points of the plot. Each point can its own size or a
79c874fe5100 More plot object updates
David Bateman <dbateman@free.fr>
parents: 8089
diff changeset
1949 unique size can be specified.
79c874fe5100 More plot object updates
David Bateman <dbateman@free.fr>
parents: 8089
diff changeset
1950
79c874fe5100 More plot object updates
David Bateman <dbateman@free.fr>
parents: 8089
diff changeset
1951 @item xdatasource
79c874fe5100 More plot object updates
David Bateman <dbateman@free.fr>
parents: 8089
diff changeset
1952 @itemx ydatasource
79c874fe5100 More plot object updates
David Bateman <dbateman@free.fr>
parents: 8089
diff changeset
1953 @itemx zdatasource
79c874fe5100 More plot object updates
David Bateman <dbateman@free.fr>
parents: 8089
diff changeset
1954 @itemx cdatasource
79c874fe5100 More plot object updates
David Bateman <dbateman@free.fr>
parents: 8089
diff changeset
1955 @itemx sizedatasource
79c874fe5100 More plot object updates
David Bateman <dbateman@free.fr>
parents: 8089
diff changeset
1956 Data source variables.
79c874fe5100 More plot object updates
David Bateman <dbateman@free.fr>
parents: 8089
diff changeset
1957 @end table
8056
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents: 8055
diff changeset
1958
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents: 8055
diff changeset
1959 @node Stair group
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents: 8055
diff changeset
1960 @subsubsection Stair group
8071
b6e85fb238c1 doc fixes
John W. Eaton <jwe@octave.org>
parents: 8070
diff changeset
1961 @cindex group objects
b6e85fb238c1 doc fixes
John W. Eaton <jwe@octave.org>
parents: 8070
diff changeset
1962 @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
1963
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents: 8055
diff changeset
1964 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
1965 @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
1966 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
1967
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents: 8055
diff changeset
1968 @table @code
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents: 8055
diff changeset
1969 @item color
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents: 8055
diff changeset
1970 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
1971
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents: 8055
diff changeset
1972 @item linewidth
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents: 8055
diff changeset
1973 @itemx linestyle
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents: 8055
diff changeset
1974 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
1975
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents: 8055
diff changeset
1976 @item marker
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents: 8055
diff changeset
1977 @itemx markeredgecolor
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents: 8055
diff changeset
1978 @itemx markerfacecolor
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents: 8055
diff changeset
1979 @itemx markersize
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents: 8055
diff changeset
1980 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
1981
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents: 8055
diff changeset
1982 @item xdata
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents: 8055
diff changeset
1983 @itemx ydata
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents: 8055
diff changeset
1984 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
1985
3b53b25e2550 Add data sources and line series
David Bateman <dbateman@free.fr>
parents: 8057
diff changeset
1986 @item xdatasource
3b53b25e2550 Add data sources and line series
David Bateman <dbateman@free.fr>
parents: 8057
diff changeset
1987 @itemx ydatasource
3b53b25e2550 Add data sources and line series
David Bateman <dbateman@free.fr>
parents: 8057
diff changeset
1988 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
1989 @end table
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents: 8055
diff changeset
1990
8073
8468140fd997 doc fix
John W. Eaton <jwe@octave.org>
parents: 8071
diff changeset
1991 @node Stem Series
8468140fd997 doc fix
John W. Eaton <jwe@octave.org>
parents: 8071
diff changeset
1992 @subsubsection Stem Series
8468140fd997 doc fix
John W. Eaton <jwe@octave.org>
parents: 8071
diff changeset
1993 @cindex series objects
8468140fd997 doc fix
John W. Eaton <jwe@octave.org>
parents: 8071
diff changeset
1994 @cindex stem series
8468140fd997 doc fix
John W. Eaton <jwe@octave.org>
parents: 8071
diff changeset
1995
8257
79c874fe5100 More plot object updates
David Bateman <dbateman@free.fr>
parents: 8089
diff changeset
1996 Stem series objects are created by the @code{stem} or @code{stem3}
79c874fe5100 More plot object updates
David Bateman <dbateman@free.fr>
parents: 8089
diff changeset
1997 functions. Each @code{hgrroup} element contains a single line object
79c874fe5100 More plot object updates
David Bateman <dbateman@free.fr>
parents: 8089
diff changeset
1998 as a child respresenting the stems. The properties of the stem series
79c874fe5100 More plot object updates
David Bateman <dbateman@free.fr>
parents: 8089
diff changeset
1999 are
79c874fe5100 More plot object updates
David Bateman <dbateman@free.fr>
parents: 8089
diff changeset
2000
79c874fe5100 More plot object updates
David Bateman <dbateman@free.fr>
parents: 8089
diff changeset
2001 @table @code
79c874fe5100 More plot object updates
David Bateman <dbateman@free.fr>
parents: 8089
diff changeset
2002 @item showbaseline
79c874fe5100 More plot object updates
David Bateman <dbateman@free.fr>
parents: 8089
diff changeset
2003 @itemx baseline
79c874fe5100 More plot object updates
David Bateman <dbateman@free.fr>
parents: 8089
diff changeset
2004 @itemx basevalue
79c874fe5100 More plot object updates
David Bateman <dbateman@free.fr>
parents: 8089
diff changeset
2005 The property @code{showbaseline} flags whether the baseline of the
79c874fe5100 More plot object updates
David Bateman <dbateman@free.fr>
parents: 8089
diff changeset
2006 stem series is displayed (default is "on"). The handle of the graphics
79c874fe5100 More plot object updates
David Bateman <dbateman@free.fr>
parents: 8089
diff changeset
2007 object representing the baseline is given by the @code{baseline}
79c874fe5100 More plot object updates
David Bateman <dbateman@free.fr>
parents: 8089
diff changeset
2008 property and the y-value (or z-value for @code{stem3}) of the baseline
79c874fe5100 More plot object updates
David Bateman <dbateman@free.fr>
parents: 8089
diff changeset
2009 by the @code{basevalue} property.
79c874fe5100 More plot object updates
David Bateman <dbateman@free.fr>
parents: 8089
diff changeset
2010
79c874fe5100 More plot object updates
David Bateman <dbateman@free.fr>
parents: 8089
diff changeset
2011 Changes to any of these property are propagated to the other members of
79c874fe5100 More plot object updates
David Bateman <dbateman@free.fr>
parents: 8089
diff changeset
2012 the stem series and to the baseline itself. Equally changes in the
79c874fe5100 More plot object updates
David Bateman <dbateman@free.fr>
parents: 8089
diff changeset
2013 properties of the base line itself are propagated to the members of the
79c874fe5100 More plot object updates
David Bateman <dbateman@free.fr>
parents: 8089
diff changeset
2014 corresponding stem series.
79c874fe5100 More plot object updates
David Bateman <dbateman@free.fr>
parents: 8089
diff changeset
2015
79c874fe5100 More plot object updates
David Bateman <dbateman@free.fr>
parents: 8089
diff changeset
2016 @item color
79c874fe5100 More plot object updates
David Bateman <dbateman@free.fr>
parents: 8089
diff changeset
2017 The RGB color or color name of the line objects of the stems. @xref{Colors}.
79c874fe5100 More plot object updates
David Bateman <dbateman@free.fr>
parents: 8089
diff changeset
2018
79c874fe5100 More plot object updates
David Bateman <dbateman@free.fr>
parents: 8089
diff changeset
2019 @item linewidth
79c874fe5100 More plot object updates
David Bateman <dbateman@free.fr>
parents: 8089
diff changeset
2020 @itemx linestyle
79c874fe5100 More plot object updates
David Bateman <dbateman@free.fr>
parents: 8089
diff changeset
2021 The line width and style of the line objects of the stems. @xref{Line Styles}.
79c874fe5100 More plot object updates
David Bateman <dbateman@free.fr>
parents: 8089
diff changeset
2022
79c874fe5100 More plot object updates
David Bateman <dbateman@free.fr>
parents: 8089
diff changeset
2023 @item marker
79c874fe5100 More plot object updates
David Bateman <dbateman@free.fr>
parents: 8089
diff changeset
2024 @itemx markeredgecolor
79c874fe5100 More plot object updates
David Bateman <dbateman@free.fr>
parents: 8089
diff changeset
2025 @itemx markerfacecolor
79c874fe5100 More plot object updates
David Bateman <dbateman@free.fr>
parents: 8089
diff changeset
2026 @itemx markersize
79c874fe5100 More plot object updates
David Bateman <dbateman@free.fr>
parents: 8089
diff changeset
2027 The line and fill color of the markers on the stems. @xref{Colors}.
79c874fe5100 More plot object updates
David Bateman <dbateman@free.fr>
parents: 8089
diff changeset
2028
79c874fe5100 More plot object updates
David Bateman <dbateman@free.fr>
parents: 8089
diff changeset
2029 @item xdata
79c874fe5100 More plot object updates
David Bateman <dbateman@free.fr>
parents: 8089
diff changeset
2030 @itemx ydata
79c874fe5100 More plot object updates
David Bateman <dbateman@free.fr>
parents: 8089
diff changeset
2031 @itemx zdata
79c874fe5100 More plot object updates
David Bateman <dbateman@free.fr>
parents: 8089
diff changeset
2032 The original x, y and z data of the stems.
79c874fe5100 More plot object updates
David Bateman <dbateman@free.fr>
parents: 8089
diff changeset
2033
79c874fe5100 More plot object updates
David Bateman <dbateman@free.fr>
parents: 8089
diff changeset
2034 @item xdatasource
79c874fe5100 More plot object updates
David Bateman <dbateman@free.fr>
parents: 8089
diff changeset
2035 @itemx ydatasource
79c874fe5100 More plot object updates
David Bateman <dbateman@free.fr>
parents: 8089
diff changeset
2036 @itemx zdatasource
79c874fe5100 More plot object updates
David Bateman <dbateman@free.fr>
parents: 8089
diff changeset
2037 Data source variables.
79c874fe5100 More plot object updates
David Bateman <dbateman@free.fr>
parents: 8089
diff changeset
2038 @end table
8073
8468140fd997 doc fix
John W. Eaton <jwe@octave.org>
parents: 8071
diff changeset
2039
8056
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents: 8055
diff changeset
2040 @node Surface group
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents: 8055
diff changeset
2041 @subsubsection Surface group
8071
b6e85fb238c1 doc fixes
John W. Eaton <jwe@octave.org>
parents: 8070
diff changeset
2042 @cindex group objects
b6e85fb238c1 doc fixes
John W. Eaton <jwe@octave.org>
parents: 8070
diff changeset
2043 @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
2044
8257
79c874fe5100 More plot object updates
David Bateman <dbateman@free.fr>
parents: 8089
diff changeset
2045 Surface group objects are created by the @code{surf} or @code{mesh}
79c874fe5100 More plot object updates
David Bateman <dbateman@free.fr>
parents: 8089
diff changeset
2046 functions, but are equally one of the handles returned by the @code{surfc}
79c874fe5100 More plot object updates
David Bateman <dbateman@free.fr>
parents: 8089
diff changeset
2047 or @code{meshc} functions. The surface group is of the type @code{surface}.
79c874fe5100 More plot object updates
David Bateman <dbateman@free.fr>
parents: 8089
diff changeset
2048
79c874fe5100 More plot object updates
David Bateman <dbateman@free.fr>
parents: 8089
diff changeset
2049 The properties of the surface group are
79c874fe5100 More plot object updates
David Bateman <dbateman@free.fr>
parents: 8089
diff changeset
2050
79c874fe5100 More plot object updates
David Bateman <dbateman@free.fr>
parents: 8089
diff changeset
2051 @table @code
79c874fe5100 More plot object updates
David Bateman <dbateman@free.fr>
parents: 8089
diff changeset
2052 @item edgecolor
79c874fe5100 More plot object updates
David Bateman <dbateman@free.fr>
parents: 8089
diff changeset
2053 @item facecolor
79c874fe5100 More plot object updates
David Bateman <dbateman@free.fr>
parents: 8089
diff changeset
2054 The RGB color or color name of the edges or faces of the surface. @xref{Colors}.
79c874fe5100 More plot object updates
David Bateman <dbateman@free.fr>
parents: 8089
diff changeset
2055
79c874fe5100 More plot object updates
David Bateman <dbateman@free.fr>
parents: 8089
diff changeset
2056 @item linewidth
79c874fe5100 More plot object updates
David Bateman <dbateman@free.fr>
parents: 8089
diff changeset
2057 @itemx linestyle
79c874fe5100 More plot object updates
David Bateman <dbateman@free.fr>
parents: 8089
diff changeset
2058 The line width and style of the lines on the surface. @xref{Line Styles}.
79c874fe5100 More plot object updates
David Bateman <dbateman@free.fr>
parents: 8089
diff changeset
2059
79c874fe5100 More plot object updates
David Bateman <dbateman@free.fr>
parents: 8089
diff changeset
2060 @item marker
79c874fe5100 More plot object updates
David Bateman <dbateman@free.fr>
parents: 8089
diff changeset
2061 @itemx markeredgecolor
79c874fe5100 More plot object updates
David Bateman <dbateman@free.fr>
parents: 8089
diff changeset
2062 @itemx markerfacecolor
79c874fe5100 More plot object updates
David Bateman <dbateman@free.fr>
parents: 8089
diff changeset
2063 @itemx markersize
79c874fe5100 More plot object updates
David Bateman <dbateman@free.fr>
parents: 8089
diff changeset
2064 The line and fill color of the markers on the surface. @xref{Colors}.
79c874fe5100 More plot object updates
David Bateman <dbateman@free.fr>
parents: 8089
diff changeset
2065
79c874fe5100 More plot object updates
David Bateman <dbateman@free.fr>
parents: 8089
diff changeset
2066 @item xdata
79c874fe5100 More plot object updates
David Bateman <dbateman@free.fr>
parents: 8089
diff changeset
2067 @itemx ydata
79c874fe5100 More plot object updates
David Bateman <dbateman@free.fr>
parents: 8089
diff changeset
2068 @itemx zdata
79c874fe5100 More plot object updates
David Bateman <dbateman@free.fr>
parents: 8089
diff changeset
2069 @item cdata
79c874fe5100 More plot object updates
David Bateman <dbateman@free.fr>
parents: 8089
diff changeset
2070 The original x, y, z and c data.
79c874fe5100 More plot object updates
David Bateman <dbateman@free.fr>
parents: 8089
diff changeset
2071
79c874fe5100 More plot object updates
David Bateman <dbateman@free.fr>
parents: 8089
diff changeset
2072 @item xdatasource
79c874fe5100 More plot object updates
David Bateman <dbateman@free.fr>
parents: 8089
diff changeset
2073 @itemx ydatasource
79c874fe5100 More plot object updates
David Bateman <dbateman@free.fr>
parents: 8089
diff changeset
2074 @itemx zdatasource
79c874fe5100 More plot object updates
David Bateman <dbateman@free.fr>
parents: 8089
diff changeset
2075 @itemx cdatasource
79c874fe5100 More plot object updates
David Bateman <dbateman@free.fr>
parents: 8089
diff changeset
2076 Data source variables.
79c874fe5100 More plot object updates
David Bateman <dbateman@free.fr>
parents: 8089
diff changeset
2077 @end table
8056
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents: 8055
diff changeset
2078
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents: 8055
diff changeset
2079 @node Graphics backends
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents: 8055
diff changeset
2080 @subsection Graphics backends
8071
b6e85fb238c1 doc fixes
John W. Eaton <jwe@octave.org>
parents: 8070
diff changeset
2081 @cindex graphics backends
b6e85fb238c1 doc fixes
John W. Eaton <jwe@octave.org>
parents: 8070
diff changeset
2082 @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
2083
8519
68aa5abfd136 Trivial doc fixes
sh@sh-laptop
parents: 8429
diff changeset
2084 @DOCSTRING(backend)
8070
3b53b25e2550 Add data sources and line series
David Bateman <dbateman@free.fr>
parents: 8057
diff changeset
2085
8056
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents: 8055
diff changeset
2086 @DOCSTRING(available_backends)
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents: 8055
diff changeset
2087
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents: 8055
diff changeset
2088 @menu
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents: 8055
diff changeset
2089 * Interaction with gnuplot::
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents: 8055
diff changeset
2090 @end menu
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents: 8055
diff changeset
2091
4167
aae05d51353c [project @ 2002-11-12 02:52:50 by jwe]
jwe
parents: 3439
diff changeset
2092 @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
2093 @subsubsection Interaction with @code{gnuplot}
8071
b6e85fb238c1 doc fixes
John W. Eaton <jwe@octave.org>
parents: 8070
diff changeset
2094 @cindex gnuplot interaction
3428
5b77cf82393c [project @ 2000-01-14 02:54:53 by jwe]
jwe
parents: 3368
diff changeset
2095
5b77cf82393c [project @ 2000-01-14 02:54:53 by jwe]
jwe
parents: 3368
diff changeset
2096 @DOCSTRING(gnuplot_binary)