Mercurial > octave

annotate doc/interpreter/plot.txi @ 31833:c5fa6a6ba7af stable

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
doc: Refer to OCTAVE_HOME in section about graphics renderer. * doc/interpreter/plot.txi (Hardware vs Software Rendering): Refer to output of OCTAVE_HOME to locate the opengl32.dll file. Thanks to N. Jankowski for noticing.
author Markus Mützel <markus.muetzel@gmx.de>
date Thu, 16 Feb 2023 09:30:32 +0100
parents d4693c66e7c9
children a4506463f341
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
31706
597f3ee61a48 update Octave Project Developers copyright for the new year
John W. Eaton <jwe@octave.org>
parents: 31596
diff changeset
1 @c Copyright (C) 1996-2023 The Octave Project Developers
7018
fd42779a8428 [project @ 2007-10-13 00:52:12 by jwe]
jwe
parents: 7001
diff changeset
2 @c
fd42779a8428 [project @ 2007-10-13 00:52:12 by jwe]
jwe
parents: 7001
diff changeset
3 @c This file is part of Octave.
fd42779a8428 [project @ 2007-10-13 00:52:12 by jwe]
jwe
parents: 7001
diff changeset
4 @c
24534
194eb4bd202b maint: Update punctuation for GPL v3 license text.
Rik <rik@octave.org>
parents: 24462
diff changeset
5 @c Octave is free software: you can redistribute it and/or modify it
22755
3a2b891d0b33 maint: Standardize Copyright formatting.
Rik <rik@octave.org>
parents: 22665
diff changeset
6 @c under the terms of the GNU General Public License as published by
24534
194eb4bd202b maint: Update punctuation for GPL v3 license text.
Rik <rik@octave.org>
parents: 24462
diff changeset
7 @c the Free Software Foundation, either version 3 of the License, or
22755
3a2b891d0b33 maint: Standardize Copyright formatting.
Rik <rik@octave.org>
parents: 22665
diff changeset
8 @c (at your option) any later version.
9672
43a07df0ed4c document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents: 9316
diff changeset
9 @c
22755
3a2b891d0b33 maint: Standardize Copyright formatting.
Rik <rik@octave.org>
parents: 22665
diff changeset
10 @c Octave is distributed in the hope that it will be useful, but
3a2b891d0b33 maint: Standardize Copyright formatting.
Rik <rik@octave.org>
parents: 22665
diff changeset
11 @c WITHOUT ANY WARRANTY; without even the implied warranty of
3a2b891d0b33 maint: Standardize Copyright formatting.
Rik <rik@octave.org>
parents: 22665
diff changeset
12 @c MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
3a2b891d0b33 maint: Standardize Copyright formatting.
Rik <rik@octave.org>
parents: 22665
diff changeset
13 @c GNU General Public License for more details.
9672
43a07df0ed4c document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents: 9316
diff changeset
14 @c
7018
fd42779a8428 [project @ 2007-10-13 00:52:12 by jwe]
jwe
parents: 7001
diff changeset
15 @c You should have received a copy of the GNU General Public License
fd42779a8428 [project @ 2007-10-13 00:52:12 by jwe]
jwe
parents: 7001
diff changeset
16 @c along with Octave; see the file COPYING. If not, see
24534
194eb4bd202b maint: Update punctuation for GPL v3 license text.
Rik <rik@octave.org>
parents: 24462
diff changeset
17 @c <https://www.gnu.org/licenses/>.
3294
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
18
4167
aae05d51353c [project @ 2002-11-12 02:52:50 by jwe]
jwe
parents: 3439
diff changeset
19 @node Plotting
3294
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
20 @chapter Plotting
6888
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
21 @cindex plotting
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
22 @cindex graphics
3294
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
23
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
24 @menu
17152
f2a8592b8fbd doc: Shorten some long subsection names in Manual.
Rik <rik@octave.org>
parents: 17123
diff changeset
25 * Introduction to Plotting::
f2a8592b8fbd doc: Shorten some long subsection names in Manual.
Rik <rik@octave.org>
parents: 17123
diff changeset
26 * High-Level Plotting::
f2a8592b8fbd doc: Shorten some long subsection names in Manual.
Rik <rik@octave.org>
parents: 17123
diff changeset
27 * Graphics Data Structures::
f2a8592b8fbd doc: Shorten some long subsection names in Manual.
Rik <rik@octave.org>
parents: 17123
diff changeset
28 * Advanced Plotting::
6888
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
29 @end menu
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
30
9672
43a07df0ed4c document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents: 9316
diff changeset
31 @node Introduction to Plotting
43a07df0ed4c document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents: 9316
diff changeset
32 @section Introduction to Plotting
43a07df0ed4c document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents: 9316
diff changeset
33
29010
16b14c431348 doc: Clarify nature and limitations of gnuplot graphics toolkit (bug #59370).
Markus Mützel <markus.muetzel@gmx.de>
parents: 28733
diff changeset
34 Earlier versions of Octave provided plotting through the use of gnuplot. This
16b14c431348 doc: Clarify nature and limitations of gnuplot graphics toolkit (bug #59370).
Markus Mützel <markus.muetzel@gmx.de>
parents: 28733
diff changeset
35 capability is still available. But, newer versions of Octave offer more modern
16b14c431348 doc: Clarify nature and limitations of gnuplot graphics toolkit (bug #59370).
Markus Mützel <markus.muetzel@gmx.de>
parents: 28733
diff changeset
36 plotting capabilities using OpenGL@. Which plotting system is used is
16b14c431348 doc: Clarify nature and limitations of gnuplot graphics toolkit (bug #59370).
Markus Mützel <markus.muetzel@gmx.de>
parents: 28733
diff changeset
37 controlled by the @code{graphics_toolkit} function. @xref{Graphics Toolkits}.
16b14c431348 doc: Clarify nature and limitations of gnuplot graphics toolkit (bug #59370).
Markus Mützel <markus.muetzel@gmx.de>
parents: 28733
diff changeset
38
16b14c431348 doc: Clarify nature and limitations of gnuplot graphics toolkit (bug #59370).
Markus Mützel <markus.muetzel@gmx.de>
parents: 28733
diff changeset
39 The function call @code{graphics_toolkit ("qt")} selects the Qt/OpenGL system,
16b14c431348 doc: Clarify nature and limitations of gnuplot graphics toolkit (bug #59370).
Markus Mützel <markus.muetzel@gmx.de>
parents: 28733
diff changeset
40 @code{graphics_toolkit ("fltk")} selects the FLTK/OpenGL system, and
16b14c431348 doc: Clarify nature and limitations of gnuplot graphics toolkit (bug #59370).
Markus Mützel <markus.muetzel@gmx.de>
parents: 28733
diff changeset
41 @code{graphics_toolkit ("gnuplot")} selects the gnuplot system. The three
16b14c431348 doc: Clarify nature and limitations of gnuplot graphics toolkit (bug #59370).
Markus Mützel <markus.muetzel@gmx.de>
parents: 28733
diff changeset
42 systems may be used selectively through the use of the @code{graphics_toolkit}
16b14c431348 doc: Clarify nature and limitations of gnuplot graphics toolkit (bug #59370).
Markus Mützel <markus.muetzel@gmx.de>
parents: 28733
diff changeset
43 property of the graphics handle for each figure. This is explained in
16b14c431348 doc: Clarify nature and limitations of gnuplot graphics toolkit (bug #59370).
Markus Mützel <markus.muetzel@gmx.de>
parents: 28733
diff changeset
44 @ref{Graphics Data Structures}.
16b14c431348 doc: Clarify nature and limitations of gnuplot graphics toolkit (bug #59370).
Markus Mützel <markus.muetzel@gmx.de>
parents: 28733
diff changeset
45
16b14c431348 doc: Clarify nature and limitations of gnuplot graphics toolkit (bug #59370).
Markus Mützel <markus.muetzel@gmx.de>
parents: 28733
diff changeset
46 @strong{Caution:} The OpenGL-based toolkits use single precision variables
16b14c431348 doc: Clarify nature and limitations of gnuplot graphics toolkit (bug #59370).
Markus Mützel <markus.muetzel@gmx.de>
parents: 28733
diff changeset
47 internally which limits the maximum value that can be displayed to
16b14c431348 doc: Clarify nature and limitations of gnuplot graphics toolkit (bug #59370).
Markus Mützel <markus.muetzel@gmx.de>
parents: 28733
diff changeset
48 approximately @math{10^{38}}. If your data contains larger values you must use
16b14c431348 doc: Clarify nature and limitations of gnuplot graphics toolkit (bug #59370).
Markus Mützel <markus.muetzel@gmx.de>
parents: 28733
diff changeset
49 the gnuplot toolkit which supports values up to @math{10^{308}}. Similarly,
16b14c431348 doc: Clarify nature and limitations of gnuplot graphics toolkit (bug #59370).
Markus Mützel <markus.muetzel@gmx.de>
parents: 28733
diff changeset
50 single precision variables can accurately represent only 6-9 base10 digits. If
16b14c431348 doc: Clarify nature and limitations of gnuplot graphics toolkit (bug #59370).
Markus Mützel <markus.muetzel@gmx.de>
parents: 28733
diff changeset
51 your data contains very fine differences (approximately 1e-8) these cannot be
16b14c431348 doc: Clarify nature and limitations of gnuplot graphics toolkit (bug #59370).
Markus Mützel <markus.muetzel@gmx.de>
parents: 28733
diff changeset
52 resolved with the OpenGL-based graphics toolkits and the gnuplot toolkit
16b14c431348 doc: Clarify nature and limitations of gnuplot graphics toolkit (bug #59370).
Markus Mützel <markus.muetzel@gmx.de>
parents: 28733
diff changeset
53 is required.
16b14c431348 doc: Clarify nature and limitations of gnuplot graphics toolkit (bug #59370).
Markus Mützel <markus.muetzel@gmx.de>
parents: 28733
diff changeset
54
16b14c431348 doc: Clarify nature and limitations of gnuplot graphics toolkit (bug #59370).
Markus Mützel <markus.muetzel@gmx.de>
parents: 28733
diff changeset
55 @strong{Note:} The gnuplot graphics toolkit uses the third party program
16b14c431348 doc: Clarify nature and limitations of gnuplot graphics toolkit (bug #59370).
Markus Mützel <markus.muetzel@gmx.de>
parents: 28733
diff changeset
56 gnuplot for plotting. The communication from Octave to gnuplot is done via a
16b14c431348 doc: Clarify nature and limitations of gnuplot graphics toolkit (bug #59370).
Markus Mützel <markus.muetzel@gmx.de>
parents: 28733
diff changeset
57 one-way pipe. This has implications for performance and functionality.
16b14c431348 doc: Clarify nature and limitations of gnuplot graphics toolkit (bug #59370).
Markus Mützel <markus.muetzel@gmx.de>
parents: 28733
diff changeset
58 Performance is significantly slower because the entire data set, which could
16b14c431348 doc: Clarify nature and limitations of gnuplot graphics toolkit (bug #59370).
Markus Mützel <markus.muetzel@gmx.de>
parents: 28733
diff changeset
59 be many megabytes, must be passed to gnuplot over the pipe. Functionality
16b14c431348 doc: Clarify nature and limitations of gnuplot graphics toolkit (bug #59370).
Markus Mützel <markus.muetzel@gmx.de>
parents: 28733
diff changeset
60 is negatively affected because the pipe is one-way from Octave to gnuplot.
16b14c431348 doc: Clarify nature and limitations of gnuplot graphics toolkit (bug #59370).
Markus Mützel <markus.muetzel@gmx.de>
parents: 28733
diff changeset
61 Octave has no way of knowing about user interactions with the plot window (be
16b14c431348 doc: Clarify nature and limitations of gnuplot graphics toolkit (bug #59370).
Markus Mützel <markus.muetzel@gmx.de>
parents: 28733
diff changeset
62 it resizing, moving, closing, or anything else). It is recommended not to
16b14c431348 doc: Clarify nature and limitations of gnuplot graphics toolkit (bug #59370).
Markus Mützel <markus.muetzel@gmx.de>
parents: 28733
diff changeset
63 interact with (or close) a gnuplot window if you will access the figure from
16b14c431348 doc: Clarify nature and limitations of gnuplot graphics toolkit (bug #59370).
Markus Mützel <markus.muetzel@gmx.de>
parents: 28733
diff changeset
64 Octave later on.
9672
43a07df0ed4c document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents: 9316
diff changeset
65
43a07df0ed4c document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents: 9316
diff changeset
66 @node High-Level Plotting
43a07df0ed4c document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents: 9316
diff changeset
67 @section High-Level Plotting
18330
200851c87444 Edits to Manual and indicies
Michael Godfrey <michaeldgodfrey@gmail.com>
parents: 17957
diff changeset
68 @cindex plotting, high-level
9672
43a07df0ed4c document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents: 9316
diff changeset
69
43a07df0ed4c document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents: 9316
diff changeset
70 Octave provides simple means to create many different types of two- and
43a07df0ed4c document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents: 9316
diff changeset
71 three-dimensional plots using high-level functions.
43a07df0ed4c document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents: 9316
diff changeset
72
43a07df0ed4c document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents: 9316
diff changeset
73 If you need more detailed control, see @ref{Graphics Data Structures}
43a07df0ed4c document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents: 9316
diff changeset
74 and @ref{Advanced Plotting}.
6888
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
75
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
76 @menu
17152
f2a8592b8fbd doc: Shorten some long subsection names in Manual.
Rik <rik@octave.org>
parents: 17123
diff changeset
77 * Two-Dimensional Plots::
f2a8592b8fbd doc: Shorten some long subsection names in Manual.
Rik <rik@octave.org>
parents: 17123
diff changeset
78 * Three-Dimensional Plots::
f2a8592b8fbd doc: Shorten some long subsection names in Manual.
Rik <rik@octave.org>
parents: 17123
diff changeset
79 * Plot Annotations::
f2a8592b8fbd doc: Shorten some long subsection names in Manual.
Rik <rik@octave.org>
parents: 17123
diff changeset
80 * Multiple Plots on One Page::
f2a8592b8fbd doc: Shorten some long subsection names in Manual.
Rik <rik@octave.org>
parents: 17123
diff changeset
81 * Multiple Plot Windows::
19081
d59d052c9858 rotate.m: new function
John W. Eaton <jwe@octave.org>
parents: 19078
diff changeset
82 * Manipulation of Plot Objects::
16096
9720ecf8d257 Fix additional warning associated with Texinfo 5.0 (bug #38392)
Rik <rik@octave.org>
parents: 16094
diff changeset
83 * Manipulation of Plot Windows::
31574
05a1b9a60efa doc: Avoid use of formatting Texinfo macros (e.g., @code) inside @menu, @xref macros.
Rik <rik@octave.org>
parents: 30564
diff changeset
84 * Use of the "interpreter" Property::
17152
f2a8592b8fbd doc: Shorten some long subsection names in Manual.
Rik <rik@octave.org>
parents: 17123
diff changeset
85 * Printing and Saving Plots::
f2a8592b8fbd doc: Shorten some long subsection names in Manual.
Rik <rik@octave.org>
parents: 17123
diff changeset
86 * Interacting with Plots::
f2a8592b8fbd doc: Shorten some long subsection names in Manual.
Rik <rik@octave.org>
parents: 17123
diff changeset
87 * Test Plotting Functions::
3294
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
88 @end menu
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
89
6888
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
90 @node Two-Dimensional Plots
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
91 @subsection Two-Dimensional Plots
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
92
12526
f8ea3eabcb85 Add daspect, pbaspect functions to documentation.
Rik <octave@nomad.inbox5.com>
parents: 12525
diff changeset
93 @menu
17152
f2a8592b8fbd doc: Shorten some long subsection names in Manual.
Rik <rik@octave.org>
parents: 17123
diff changeset
94 * Axis Configuration::
f2a8592b8fbd doc: Shorten some long subsection names in Manual.
Rik <rik@octave.org>
parents: 17123
diff changeset
95 * Two-dimensional Function Plotting::
f2a8592b8fbd doc: Shorten some long subsection names in Manual.
Rik <rik@octave.org>
parents: 17123
diff changeset
96 * Two-dimensional Geometric Shapes::
12526
f8ea3eabcb85 Add daspect, pbaspect functions to documentation.
Rik <octave@nomad.inbox5.com>
parents: 12525
diff changeset
97 @end menu
f8ea3eabcb85 Add daspect, pbaspect functions to documentation.
Rik <octave@nomad.inbox5.com>
parents: 12525
diff changeset
98
6888
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
99 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
100 linear axes. For example,
3294
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe]
jwe
parents:
diff changeset
101
6888
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
102 @example
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
103 @group
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
104 x = -10:0.1:10;
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
105 plot (x, sin (x));
23214
76a894168fe5 doc: provide complete examples in plotting documentation (bug #44263)
Michael D. Godfrey <michaeldgodfrey@gmail.com>
parents: 23205
diff changeset
106 xlabel ("x");
76a894168fe5 doc: provide complete examples in plotting documentation (bug #44263)
Michael D. Godfrey <michaeldgodfrey@gmail.com>
parents: 23205
diff changeset
107 ylabel ("sin (x)");
76a894168fe5 doc: provide complete examples in plotting documentation (bug #44263)
Michael D. Godfrey <michaeldgodfrey@gmail.com>
parents: 23205
diff changeset
108 title ("Simple 2-D Plot");
6888
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
109 @end group
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
110 @end example
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
111
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
112 @noindent
6899
110c5782fe3b [project @ 2007-09-14 15:17:53 by jwe]
jwe
parents: 6892
diff changeset
113 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
114 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
115
6888
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
116 @float Figure,fig:plot
9088
77e71f3da3d6 Fix documentation image printing under new development code
Rik <rdrider0-list@yahoo.com>
parents: 9040
diff changeset
117 @center @image{plot,4in}
6888
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
118 @caption{Simple Two-Dimensional Plot.}
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
119 @end float
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
120
5134
0309b6722ee9 [project @ 2005-02-08 20:17:55 by jwe]
jwe
parents: 5016
diff changeset
121 @DOCSTRING(plot)
0309b6722ee9 [project @ 2005-02-08 20:17:55 by jwe]
jwe
parents: 5016
diff changeset
122
8817
03b7f618ab3d include docstrings for new functions in the manual
John W. Eaton <jwe@octave.org>
parents: 8519
diff changeset
123 The @code{plotyy} function may be used to create a plot with two
03b7f618ab3d include docstrings for new functions in the manual
John W. Eaton <jwe@octave.org>
parents: 8519
diff changeset
124 independent y axes.
03b7f618ab3d include docstrings for new functions in the manual
John W. Eaton <jwe@octave.org>
parents: 8519
diff changeset
125
03b7f618ab3d include docstrings for new functions in the manual
John W. Eaton <jwe@octave.org>
parents: 8519
diff changeset
126 @DOCSTRING(plotyy)
03b7f618ab3d include docstrings for new functions in the manual
John W. Eaton <jwe@octave.org>
parents: 8519
diff changeset
127
6888
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
128 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
129 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
130 both of the axes use log scales.
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
131
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
132 @DOCSTRING(semilogx)
6502
6ab0a8767780 [project @ 2007-04-06 03:32:06 by jwe]
jwe
parents: 6331
diff changeset
133
6888
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
134 @DOCSTRING(semilogy)
6502
6ab0a8767780 [project @ 2007-04-06 03:32:06 by jwe]
jwe
parents: 6331
diff changeset
135
6888
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
136 @DOCSTRING(loglog)
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
137
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
138 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
139 are useful for displaying discrete data. For example,
5134
0309b6722ee9 [project @ 2005-02-08 20:17:55 by jwe]
jwe
parents: 5016
diff changeset
140
6888
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
141 @example
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
142 @group
23214
76a894168fe5 doc: provide complete examples in plotting documentation (bug #44263)
Michael D. Godfrey <michaeldgodfrey@gmail.com>
parents: 23205
diff changeset
143 randn ("state", 1);
6888
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
144 hist (randn (10000, 1), 30);
23214
76a894168fe5 doc: provide complete examples in plotting documentation (bug #44263)
Michael D. Godfrey <michaeldgodfrey@gmail.com>
parents: 23205
diff changeset
145 xlabel ("Value");
76a894168fe5 doc: provide complete examples in plotting documentation (bug #44263)
Michael D. Godfrey <michaeldgodfrey@gmail.com>
parents: 23205
diff changeset
146 ylabel ("Count");
76a894168fe5 doc: provide complete examples in plotting documentation (bug #44263)
Michael D. Godfrey <michaeldgodfrey@gmail.com>
parents: 23205
diff changeset
147 title ("Histogram of 10,000 normally distributed random numbers");
6888
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
148 @end group
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
149 @end example
5134
0309b6722ee9 [project @ 2005-02-08 20:17:55 by jwe]
jwe
parents: 5016
diff changeset
150
6888
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
151 @noindent
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
152 produces the histogram of 10,000 normally distributed random numbers
23217
893d99338cc8 doc: Reword manual section on numeric constants for clarity.
Rik <rik@octave.org>
parents: 23214
diff changeset
153 shown in @ref{fig:hist}. Note that, @code{randn ("state", 1);}, initializes
893d99338cc8 doc: Reword manual section on numeric constants for clarity.
Rik <rik@octave.org>
parents: 23214
diff changeset
154 the random number generator for @code{randn} to a known value so that the
893d99338cc8 doc: Reword manual section on numeric constants for clarity.
Rik <rik@octave.org>
parents: 23214
diff changeset
155 returned values are reproducible; This guarantees that the figure produced
893d99338cc8 doc: Reword manual section on numeric constants for clarity.
Rik <rik@octave.org>
parents: 23214
diff changeset
156 is identical to the one in this manual.
5134
0309b6722ee9 [project @ 2005-02-08 20:17:55 by jwe]
jwe
parents: 5016
diff changeset
157
6888
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
158 @float Figure,fig:hist
9088
77e71f3da3d6 Fix documentation image printing under new development code
Rik <rdrider0-list@yahoo.com>
parents: 9040
diff changeset
159 @center @image{hist,4in}
6888
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
160 @caption{Histogram.}
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
161 @end float
5134
0309b6722ee9 [project @ 2005-02-08 20:17:55 by jwe]
jwe
parents: 5016
diff changeset
162
0309b6722ee9 [project @ 2005-02-08 20:17:55 by jwe]
jwe
parents: 5016
diff changeset
163 @DOCSTRING(bar)
0309b6722ee9 [project @ 2005-02-08 20:17:55 by jwe]
jwe
parents: 5016
diff changeset
164
6877
ab11bdb09820 [project @ 2007-09-07 05:12:32 by jwe]
jwe
parents: 6788
diff changeset
165 @DOCSTRING(barh)
ab11bdb09820 [project @ 2007-09-07 05:12:32 by jwe]
jwe
parents: 6788
diff changeset
166
6888
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
167 @DOCSTRING(hist)
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
168
16008
6f567476e6f0 Add stemleaf and printd to the manual
Michael Godfrey <michaeldgodfrey@gmail.com>
parents: 14856
diff changeset
169 @DOCSTRING(stemleaf)
6f567476e6f0 Add stemleaf and printd to the manual
Michael Godfrey <michaeldgodfrey@gmail.com>
parents: 14856
diff changeset
170
6f567476e6f0 Add stemleaf and printd to the manual
Michael Godfrey <michaeldgodfrey@gmail.com>
parents: 14856
diff changeset
171 @DOCSTRING(printd)
6f567476e6f0 Add stemleaf and printd to the manual
Michael Godfrey <michaeldgodfrey@gmail.com>
parents: 14856
diff changeset
172
6888
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
173 @DOCSTRING(stairs)
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
174
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
175 @DOCSTRING(stem)
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
176
8817
03b7f618ab3d include docstrings for new functions in the manual
John W. Eaton <jwe@octave.org>
parents: 8519
diff changeset
177 @DOCSTRING(stem3)
03b7f618ab3d include docstrings for new functions in the manual
John W. Eaton <jwe@octave.org>
parents: 8519
diff changeset
178
03b7f618ab3d include docstrings for new functions in the manual
John W. Eaton <jwe@octave.org>
parents: 8519
diff changeset
179 @DOCSTRING(scatter)
03b7f618ab3d include docstrings for new functions in the manual
John W. Eaton <jwe@octave.org>
parents: 8519
diff changeset
180
03b7f618ab3d include docstrings for new functions in the manual
John W. Eaton <jwe@octave.org>
parents: 8519
diff changeset
181 @DOCSTRING(plotmatrix)
03b7f618ab3d include docstrings for new functions in the manual
John W. Eaton <jwe@octave.org>
parents: 8519
diff changeset
182
03b7f618ab3d include docstrings for new functions in the manual
John W. Eaton <jwe@octave.org>
parents: 8519
diff changeset
183 @DOCSTRING(pareto)
03b7f618ab3d include docstrings for new functions in the manual
John W. Eaton <jwe@octave.org>
parents: 8519
diff changeset
184
03b7f618ab3d include docstrings for new functions in the manual
John W. Eaton <jwe@octave.org>
parents: 8519
diff changeset
185 @DOCSTRING(rose)
03b7f618ab3d include docstrings for new functions in the manual
John W. Eaton <jwe@octave.org>
parents: 8519
diff changeset
186
7981
90413830b690 Document contourf
David Bateman <dbateman@free.fr>
parents: 7980
diff changeset
187 The @code{contour}, @code{contourf} and @code{contourc} functions
9209
923c7cb7f13f Simplify TeXinfo files by eliminating redundant @iftex followed by @tex construction.
Rik <rdrider0-list@yahoo.com>
parents: 9088
diff changeset
188 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
189
5134
0309b6722ee9 [project @ 2005-02-08 20:17:55 by jwe]
jwe
parents: 5016
diff changeset
190 @DOCSTRING(contour)
0309b6722ee9 [project @ 2005-02-08 20:17:55 by jwe]
jwe
parents: 5016
diff changeset
191
7981
90413830b690 Document contourf
David Bateman <dbateman@free.fr>
parents: 7980
diff changeset
192 @DOCSTRING(contourf)
90413830b690 Document contourf
David Bateman <dbateman@free.fr>
parents: 7980
diff changeset
193
6502
6ab0a8767780 [project @ 2007-04-06 03:32:06 by jwe]
jwe
parents: 6331
diff changeset
194 @DOCSTRING(contourc)
6ab0a8767780 [project @ 2007-04-06 03:32:06 by jwe]
jwe
parents: 6331
diff changeset
195
8817
03b7f618ab3d include docstrings for new functions in the manual
John W. Eaton <jwe@octave.org>
parents: 8519
diff changeset
196 @DOCSTRING(contour3)
03b7f618ab3d include docstrings for new functions in the manual
John W. Eaton <jwe@octave.org>
parents: 8519
diff changeset
197
6888
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
198 The @code{errorbar}, @code{semilogxerr}, @code{semilogyerr}, and
8347
fa78cb8d8a5c corrections for typos
Brian Gough<bjg@network-theory.co.uk>
parents: 8325
diff changeset
199 @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
200 example,
6877
ab11bdb09820 [project @ 2007-09-07 05:12:32 by jwe]
jwe
parents: 6788
diff changeset
201
6888
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
202 @example
9088
77e71f3da3d6 Fix documentation image printing under new development code
Rik <rdrider0-list@yahoo.com>
parents: 9040
diff changeset
203 @group
23214
76a894168fe5 doc: provide complete examples in plotting documentation (bug #44263)
Michael D. Godfrey <michaeldgodfrey@gmail.com>
parents: 23205
diff changeset
204 rand ("state", 2);
6888
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
205 x = 0:0.1:10;
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
206 y = sin (x);
21155
8b1e030d3d4f doc: Correct example errobar code and plot (bug #46972).
Rik <rik@octave.org>
parents: 19795
diff changeset
207 lerr = 0.1 .* rand (size (x));
8b1e030d3d4f doc: Correct example errobar code and plot (bug #46972).
Rik <rik@octave.org>
parents: 19795
diff changeset
208 uerr = 0.1 .* rand (size (x));
8b1e030d3d4f doc: Correct example errobar code and plot (bug #46972).
Rik <rik@octave.org>
parents: 19795
diff changeset
209 errorbar (x, y, lerr, uerr);
23214
76a894168fe5 doc: provide complete examples in plotting documentation (bug #44263)
Michael D. Godfrey <michaeldgodfrey@gmail.com>
parents: 23205
diff changeset
210 axis ([0, 10, -1.1, 1.1]);
76a894168fe5 doc: provide complete examples in plotting documentation (bug #44263)
Michael D. Godfrey <michaeldgodfrey@gmail.com>
parents: 23205
diff changeset
211 xlabel ("x");
76a894168fe5 doc: provide complete examples in plotting documentation (bug #44263)
Michael D. Godfrey <michaeldgodfrey@gmail.com>
parents: 23205
diff changeset
212 ylabel ("sin (x)");
76a894168fe5 doc: provide complete examples in plotting documentation (bug #44263)
Michael D. Godfrey <michaeldgodfrey@gmail.com>
parents: 23205
diff changeset
213 title ("Errorbar plot of sin (x)");
9088
77e71f3da3d6 Fix documentation image printing under new development code
Rik <rdrider0-list@yahoo.com>
parents: 9040
diff changeset
214 @end group
6888
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
215 @end example
5134
0309b6722ee9 [project @ 2005-02-08 20:17:55 by jwe]
jwe
parents: 5016
diff changeset
216
6888
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
217 @noindent
6899
110c5782fe3b [project @ 2007-09-14 15:17:53 by jwe]
jwe
parents: 6892
diff changeset
218 produces the figure shown in @ref{fig:errorbar}.
6502
6ab0a8767780 [project @ 2007-04-06 03:32:06 by jwe]
jwe
parents: 6331
diff changeset
219
6888
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
220 @float Figure,fig:errorbar
9088
77e71f3da3d6 Fix documentation image printing under new development code
Rik <rdrider0-list@yahoo.com>
parents: 9040
diff changeset
221 @center @image{errorbar,4in}
6888
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
222 @caption{Errorbar plot.}
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
223 @end float
5134
0309b6722ee9 [project @ 2005-02-08 20:17:55 by jwe]
jwe
parents: 5016
diff changeset
224
0309b6722ee9 [project @ 2005-02-08 20:17:55 by jwe]
jwe
parents: 5016
diff changeset
225 @DOCSTRING(errorbar)
0309b6722ee9 [project @ 2005-02-08 20:17:55 by jwe]
jwe
parents: 5016
diff changeset
226
0309b6722ee9 [project @ 2005-02-08 20:17:55 by jwe]
jwe
parents: 5016
diff changeset
227 @DOCSTRING(semilogxerr)
0309b6722ee9 [project @ 2005-02-08 20:17:55 by jwe]
jwe
parents: 5016
diff changeset
228
0309b6722ee9 [project @ 2005-02-08 20:17:55 by jwe]
jwe
parents: 5016
diff changeset
229 @DOCSTRING(semilogyerr)
0309b6722ee9 [project @ 2005-02-08 20:17:55 by jwe]
jwe
parents: 5016
diff changeset
230
6888
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
231 @DOCSTRING(loglogerr)
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
232
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
233 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
234 polar coordinates. However, the display coordinates remain rectangular
6888
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
235 and linear. For example,
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
236
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
237 @example
23565
3a730821e4a2 doc: Peridoc grammarcheck of documentation.
Rik <rik@octave.org>
parents: 23563
diff changeset
238 @group
6888
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
239 polar (0:0.1:10*pi, 0:0.1:10*pi);
23214
76a894168fe5 doc: provide complete examples in plotting documentation (bug #44263)
Michael D. Godfrey <michaeldgodfrey@gmail.com>
parents: 23205
diff changeset
240 title ("Example polar plot from 0 to 10*pi");
23565
3a730821e4a2 doc: Peridoc grammarcheck of documentation.
Rik <rik@octave.org>
parents: 23563
diff changeset
241 @end group
6888
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
242 @end example
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 @noindent
6899
110c5782fe3b [project @ 2007-09-14 15:17:53 by jwe]
jwe
parents: 6892
diff changeset
245 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
246
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
247 @float Figure,fig:polar
9088
77e71f3da3d6 Fix documentation image printing under new development code
Rik <rdrider0-list@yahoo.com>
parents: 9040
diff changeset
248 @center @image{polar,4in}
6888
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
249 @caption{Polar plot.}
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
250 @end float
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 @DOCSTRING(polar)
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
253
7120
a2174fb073d4 [project @ 2007-11-07 21:26:43 by jwe]
jwe
parents: 7018
diff changeset
254 @DOCSTRING(pie)
a2174fb073d4 [project @ 2007-11-07 21:26:43 by jwe]
jwe
parents: 7018
diff changeset
255
11330
4f399d91eb32 add pie3 to plot functions
Kai Habel <kai.habel@gmx.de>
parents: 11257
diff changeset
256 @DOCSTRING(pie3)
4f399d91eb32 add pie3 to plot functions
Kai Habel <kai.habel@gmx.de>
parents: 11257
diff changeset
257
7120
a2174fb073d4 [project @ 2007-11-07 21:26:43 by jwe]
jwe
parents: 7018
diff changeset
258 @DOCSTRING(quiver)
a2174fb073d4 [project @ 2007-11-07 21:26:43 by jwe]
jwe
parents: 7018
diff changeset
259
8817
03b7f618ab3d include docstrings for new functions in the manual
John W. Eaton <jwe@octave.org>
parents: 8519
diff changeset
260 @DOCSTRING(quiver3)
03b7f618ab3d include docstrings for new functions in the manual
John W. Eaton <jwe@octave.org>
parents: 8519
diff changeset
261
28386
8a9a041db1dc Add "streamribbon" function (patch #9916).
Markus Meisinger <chloros2@gmx.de>
parents: 28286
diff changeset
262 @DOCSTRING(streamribbon)
8a9a041db1dc Add "streamribbon" function (patch #9916).
Markus Meisinger <chloros2@gmx.de>
parents: 28286
diff changeset
263
28136
23f667483fab Add Matlab compatible "streamtube" function (bug #57471).
Markus Meisinger <chloros2@gmx.de>
parents: 28135
diff changeset
264 @DOCSTRING(streamtube)
23f667483fab Add Matlab compatible "streamtube" function (bug #57471).
Markus Meisinger <chloros2@gmx.de>
parents: 28135
diff changeset
265
28135
695bb31e565b Rename "streamtube" to "ostreamtube" (bug #57471).
Markus Meisinger <chloros2@gmx.de>
parents: 27796
diff changeset
266 @DOCSTRING(ostreamtube)
27759
992e702ef0d7 Add stream* functions (patch #9859).
Markus Meisinger <chloros2@gmx.de>
parents: 27423
diff changeset
267
992e702ef0d7 Add stream* functions (patch #9859).
Markus Meisinger <chloros2@gmx.de>
parents: 27423
diff changeset
268 @DOCSTRING(streamline)
992e702ef0d7 Add stream* functions (patch #9859).
Markus Meisinger <chloros2@gmx.de>
parents: 27423
diff changeset
269
992e702ef0d7 Add stream* functions (patch #9859).
Markus Meisinger <chloros2@gmx.de>
parents: 27423
diff changeset
270 @DOCSTRING(stream2)
992e702ef0d7 Add stream* functions (patch #9859).
Markus Meisinger <chloros2@gmx.de>
parents: 27423
diff changeset
271
992e702ef0d7 Add stream* functions (patch #9859).
Markus Meisinger <chloros2@gmx.de>
parents: 27423
diff changeset
272 @DOCSTRING(stream3)
992e702ef0d7 Add stream* functions (patch #9859).
Markus Meisinger <chloros2@gmx.de>
parents: 27423
diff changeset
273
8817
03b7f618ab3d include docstrings for new functions in the manual
John W. Eaton <jwe@octave.org>
parents: 8519
diff changeset
274 @DOCSTRING(compass)
03b7f618ab3d include docstrings for new functions in the manual
John W. Eaton <jwe@octave.org>
parents: 8519
diff changeset
275
03b7f618ab3d include docstrings for new functions in the manual
John W. Eaton <jwe@octave.org>
parents: 8519
diff changeset
276 @DOCSTRING(feather)
03b7f618ab3d include docstrings for new functions in the manual
John W. Eaton <jwe@octave.org>
parents: 8519
diff changeset
277
7120
a2174fb073d4 [project @ 2007-11-07 21:26:43 by jwe]
jwe
parents: 7018
diff changeset
278 @DOCSTRING(pcolor)
a2174fb073d4 [project @ 2007-11-07 21:26:43 by jwe]
jwe
parents: 7018
diff changeset
279
7153
4246642e9f48 [project @ 2007-11-09 21:20:07 by dbateman]
dbateman
parents: 7120
diff changeset
280 @DOCSTRING(area)
4246642e9f48 [project @ 2007-11-09 21:20:07 by dbateman]
dbateman
parents: 7120
diff changeset
281
19460
78c0241306b5 Add documentation about when to use newplot (bug #40289).
Rik <rik@octave.org>
parents: 19405
diff changeset
282 @DOCSTRING(fill)
78c0241306b5 Add documentation about when to use newplot (bug #40289).
Rik <rik@octave.org>
parents: 19405
diff changeset
283
29395
4d747b196935 fill3.m: Add new function.
Markus Mützel <markus.muetzel@gmx.de>
parents: 29122
diff changeset
284 @DOCSTRING(fill3)
4d747b196935 fill3.m: Add new function.
Markus Mützel <markus.muetzel@gmx.de>
parents: 29122
diff changeset
285
8817
03b7f618ab3d include docstrings for new functions in the manual
John W. Eaton <jwe@octave.org>
parents: 8519
diff changeset
286 @DOCSTRING(comet)
03b7f618ab3d include docstrings for new functions in the manual
John W. Eaton <jwe@octave.org>
parents: 8519
diff changeset
287
11382
ed74d1fbdc2f comet3: new function
John W. Eaton <jwe@octave.org>
parents: 11380
diff changeset
288 @DOCSTRING(comet3)
ed74d1fbdc2f comet3: new function
John W. Eaton <jwe@octave.org>
parents: 11380
diff changeset
289
12526
f8ea3eabcb85 Add daspect, pbaspect functions to documentation.
Rik <octave@nomad.inbox5.com>
parents: 12525
diff changeset
290 @node Axis Configuration
f8ea3eabcb85 Add daspect, pbaspect functions to documentation.
Rik <octave@nomad.inbox5.com>
parents: 12525
diff changeset
291 @subsubsection Axis Configuration
f8ea3eabcb85 Add daspect, pbaspect functions to documentation.
Rik <octave@nomad.inbox5.com>
parents: 12525
diff changeset
292
6888
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
293 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
294 plot and various other axis properties, such as the aspect ratio and the
25857
c3c9c8533a86 Document that high level graphics functions redefine axes properties (bug #49400).
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents: 25585
diff changeset
295 appearance of tic marks. By default, high level plotting functions such as
c3c9c8533a86 Document that high level graphics functions redefine axes properties (bug #49400).
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents: 25585
diff changeset
296 @code{plot} reset axes properties. Any customization of properties, for
c3c9c8533a86 Document that high level graphics functions redefine axes properties (bug #49400).
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents: 25585
diff changeset
297 example by calling @code{axis}, @code{xlim}, etc., should happen after the plot
c3c9c8533a86 Document that high level graphics functions redefine axes properties (bug #49400).
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents: 25585
diff changeset
298 is done or, alternatively, after calling the @ref{XREFhold, ,hold function}.
6888
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
299
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
300 @DOCSTRING(axis)
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
301
7189
e8d953d03f6a [project @ 2007-11-26 20:42:09 by dbateman]
dbateman
parents: 7153
diff changeset
302 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
303 function.
e8d953d03f6a [project @ 2007-11-26 20:42:09 by dbateman]
dbateman
parents: 7153
diff changeset
304
e8d953d03f6a [project @ 2007-11-26 20:42:09 by dbateman]
dbateman
parents: 7153
diff changeset
305 @DOCSTRING(caxis)
e8d953d03f6a [project @ 2007-11-26 20:42:09 by dbateman]
dbateman
parents: 7153
diff changeset
306
8817
03b7f618ab3d include docstrings for new functions in the manual
John W. Eaton <jwe@octave.org>
parents: 8519
diff changeset
307 The @code{xlim}, @code{ylim}, and @code{zlim} functions may be used to
03b7f618ab3d include docstrings for new functions in the manual
John W. Eaton <jwe@octave.org>
parents: 8519
diff changeset
308 get or set individual axis limits. Each has the same form.
03b7f618ab3d include docstrings for new functions in the manual
John W. Eaton <jwe@octave.org>
parents: 8519
diff changeset
309
17122
eaab03308c0b doc: Rewrite docstrings for most plot functions.
Rik <rik@octave.org>
parents: 17099
diff changeset
310 @c Add cross-references and function index entries for other limit functions.
17097
e7a059a9a644 doc: Use XREF as anchor prefix in documentation for clearer results in Info viewer.
Rik <rik@octave.org>
parents: 16923
diff changeset
311 @anchor{XREFylim}
e7a059a9a644 doc: Use XREF as anchor prefix in documentation for clearer results in Info viewer.
Rik <rik@octave.org>
parents: 16923
diff changeset
312 @anchor{XREFzlim}
17122
eaab03308c0b doc: Rewrite docstrings for most plot functions.
Rik <rik@octave.org>
parents: 17099
diff changeset
313 @findex ylim
eaab03308c0b doc: Rewrite docstrings for most plot functions.
Rik <rik@octave.org>
parents: 17099
diff changeset
314 @findex zlim
8817
03b7f618ab3d include docstrings for new functions in the manual
John W. Eaton <jwe@octave.org>
parents: 8519
diff changeset
315 @DOCSTRING(xlim)
03b7f618ab3d include docstrings for new functions in the manual
John W. Eaton <jwe@octave.org>
parents: 8519
diff changeset
316
24050
a03bb64031da Implement missing axis tick and label functions (bug #51839).
Nicholas R. Jankowski <jankowskin@asme.org>
parents: 24025
diff changeset
317 The @code{xticks}, @code{yticks}, @code{zticks}, @code{rticks}, and
a03bb64031da Implement missing axis tick and label functions (bug #51839).
Nicholas R. Jankowski <jankowskin@asme.org>
parents: 24025
diff changeset
318 @code{thetaticks} functions may be used to get or set the tick mark locations
24208
eec262017c6a maint: Strip trailing whitespace from source files.
John W. Eaton <jwe@octave.org>
parents: 24182
diff changeset
319 and modes on the respective axis. Each has the same form, although mode
25003
2365c2661b3c doc: Spellcheck documentation ahead of 4.4 release.
Rik <rik@octave.org>
parents: 24987
diff changeset
320 options are not currently available for @code{rticks}, and @code{thetaticks}.
24050
a03bb64031da Implement missing axis tick and label functions (bug #51839).
Nicholas R. Jankowski <jankowskin@asme.org>
parents: 24025
diff changeset
321
a03bb64031da Implement missing axis tick and label functions (bug #51839).
Nicholas R. Jankowski <jankowskin@asme.org>
parents: 24025
diff changeset
322 @c FIXME: Update this section if polarplot and polar axes changes change the
a03bb64031da Implement missing axis tick and label functions (bug #51839).
Nicholas R. Jankowski <jankowskin@asme.org>
parents: 24025
diff changeset
323 @c associated axis properties.
a03bb64031da Implement missing axis tick and label functions (bug #51839).
Nicholas R. Jankowski <jankowskin@asme.org>
parents: 24025
diff changeset
324 @anchor{XREFyticks}
a03bb64031da Implement missing axis tick and label functions (bug #51839).
Nicholas R. Jankowski <jankowskin@asme.org>
parents: 24025
diff changeset
325 @anchor{XREFzticks}
a03bb64031da Implement missing axis tick and label functions (bug #51839).
Nicholas R. Jankowski <jankowskin@asme.org>
parents: 24025
diff changeset
326 @anchor{XREFrticks}
a03bb64031da Implement missing axis tick and label functions (bug #51839).
Nicholas R. Jankowski <jankowskin@asme.org>
parents: 24025
diff changeset
327 @anchor{XREFthetaticks}
a03bb64031da Implement missing axis tick and label functions (bug #51839).
Nicholas R. Jankowski <jankowskin@asme.org>
parents: 24025
diff changeset
328 @findex yticks
a03bb64031da Implement missing axis tick and label functions (bug #51839).
Nicholas R. Jankowski <jankowskin@asme.org>
parents: 24025
diff changeset
329 @findex zticks
a03bb64031da Implement missing axis tick and label functions (bug #51839).
Nicholas R. Jankowski <jankowskin@asme.org>
parents: 24025
diff changeset
330 @findex rticks
a03bb64031da Implement missing axis tick and label functions (bug #51839).
Nicholas R. Jankowski <jankowskin@asme.org>
parents: 24025
diff changeset
331 @findex thetaticks
a03bb64031da Implement missing axis tick and label functions (bug #51839).
Nicholas R. Jankowski <jankowskin@asme.org>
parents: 24025
diff changeset
332 @DOCSTRING(xticks)
a03bb64031da Implement missing axis tick and label functions (bug #51839).
Nicholas R. Jankowski <jankowskin@asme.org>
parents: 24025
diff changeset
333
a03bb64031da Implement missing axis tick and label functions (bug #51839).
Nicholas R. Jankowski <jankowskin@asme.org>
parents: 24025
diff changeset
334 The @code{xticklabels}, @code{yticklabels}, and @code{zticklabels} functions
a03bb64031da Implement missing axis tick and label functions (bug #51839).
Nicholas R. Jankowski <jankowskin@asme.org>
parents: 24025
diff changeset
335 may be used to get or set the label assigned to each tick location and the
24208
eec262017c6a maint: Strip trailing whitespace from source files.
John W. Eaton <jwe@octave.org>
parents: 24182
diff changeset
336 labeling mode on the respective axis. Each has the same form.
24050
a03bb64031da Implement missing axis tick and label functions (bug #51839).
Nicholas R. Jankowski <jankowskin@asme.org>
parents: 24025
diff changeset
337
a03bb64031da Implement missing axis tick and label functions (bug #51839).
Nicholas R. Jankowski <jankowskin@asme.org>
parents: 24025
diff changeset
338 @c FIXME: Update this section if polarplot and polar axes changes change the
a03bb64031da Implement missing axis tick and label functions (bug #51839).
Nicholas R. Jankowski <jankowskin@asme.org>
parents: 24025
diff changeset
339 @c associated axis properties.
a03bb64031da Implement missing axis tick and label functions (bug #51839).
Nicholas R. Jankowski <jankowskin@asme.org>
parents: 24025
diff changeset
340 @c Matlab also implements rticklabels and thetaticklabels.
a03bb64031da Implement missing axis tick and label functions (bug #51839).
Nicholas R. Jankowski <jankowskin@asme.org>
parents: 24025
diff changeset
341 @anchor{XREFyticklabels}
a03bb64031da Implement missing axis tick and label functions (bug #51839).
Nicholas R. Jankowski <jankowskin@asme.org>
parents: 24025
diff changeset
342 @anchor{XREFzticklabels}
a03bb64031da Implement missing axis tick and label functions (bug #51839).
Nicholas R. Jankowski <jankowskin@asme.org>
parents: 24025
diff changeset
343 @findex yticklabels
a03bb64031da Implement missing axis tick and label functions (bug #51839).
Nicholas R. Jankowski <jankowskin@asme.org>
parents: 24025
diff changeset
344 @findex zticklabels
a03bb64031da Implement missing axis tick and label functions (bug #51839).
Nicholas R. Jankowski <jankowskin@asme.org>
parents: 24025
diff changeset
345 @DOCSTRING(xticklabels)
a03bb64031da Implement missing axis tick and label functions (bug #51839).
Nicholas R. Jankowski <jankowskin@asme.org>
parents: 24025
diff changeset
346
29024
447beb85551d Add ytickangle and ztickangle functions (bug #59067)
Rik <rik@octave.org>
parents: 29011
diff changeset
347 The @code{xtickangle}, @code{ytickangle}, and @code{ztickangle} functions
447beb85551d Add ytickangle and ztickangle functions (bug #59067)
Rik <rik@octave.org>
parents: 29011
diff changeset
348 may be used to get or set the rotation angle of labels for the respective axis.
447beb85551d Add ytickangle and ztickangle functions (bug #59067)
Rik <rik@octave.org>
parents: 29011
diff changeset
349 Each has the same form.
447beb85551d Add ytickangle and ztickangle functions (bug #59067)
Rik <rik@octave.org>
parents: 29011
diff changeset
350
447beb85551d Add ytickangle and ztickangle functions (bug #59067)
Rik <rik@octave.org>
parents: 29011
diff changeset
351 @anchor{XREFytickangle}
447beb85551d Add ytickangle and ztickangle functions (bug #59067)
Rik <rik@octave.org>
parents: 29011
diff changeset
352 @anchor{XREFztickangle}
447beb85551d Add ytickangle and ztickangle functions (bug #59067)
Rik <rik@octave.org>
parents: 29011
diff changeset
353 @findex ytickangle
447beb85551d Add ytickangle and ztickangle functions (bug #59067)
Rik <rik@octave.org>
parents: 29011
diff changeset
354 @findex ztickangle
447beb85551d Add ytickangle and ztickangle functions (bug #59067)
Rik <rik@octave.org>
parents: 29011
diff changeset
355 @DOCSTRING(xtickangle)
447beb85551d Add ytickangle and ztickangle functions (bug #59067)
Rik <rik@octave.org>
parents: 29011
diff changeset
356
7984
bbaa5d7d0143 Some documentation updates
David Bateman <dbateman@free.fr>
parents: 7981
diff changeset
357 @node Two-dimensional Function Plotting
bbaa5d7d0143 Some documentation updates
David Bateman <dbateman@free.fr>
parents: 7981
diff changeset
358 @subsubsection Two-dimensional Function Plotting
18330
200851c87444 Edits to Manual and indicies
Michael Godfrey <michaeldgodfrey@gmail.com>
parents: 17957
diff changeset
359 @cindex plotting, two-dimensional functions
200851c87444 Edits to Manual and indicies
Michael Godfrey <michaeldgodfrey@gmail.com>
parents: 17957
diff changeset
360
28427
7a8c69c4eb55 convert obsolete octave_fcn_inline object to @inline class
John W. Eaton <jwe@octave.org>
parents: 28136
diff changeset
361 Octave can plot a function from a function handle or string defining the
7a8c69c4eb55 convert obsolete octave_fcn_inline object to @inline class
John W. Eaton <jwe@octave.org>
parents: 28136
diff changeset
362 function without the user needing to explicitly create the data to be
7a8c69c4eb55 convert obsolete octave_fcn_inline object to @inline class
John W. Eaton <jwe@octave.org>
parents: 28136
diff changeset
363 plotted. The function @code{fplot} also generates two-dimensional plots
7a8c69c4eb55 convert obsolete octave_fcn_inline object to @inline class
John W. Eaton <jwe@octave.org>
parents: 28136
diff changeset
364 with linear axes using a function name and limits for the range of the
7a8c69c4eb55 convert obsolete octave_fcn_inline object to @inline class
John W. Eaton <jwe@octave.org>
parents: 28136
diff changeset
365 x-coordinate instead of the x and y data. For example,
7984
bbaa5d7d0143 Some documentation updates
David Bateman <dbateman@free.fr>
parents: 7981
diff changeset
366
bbaa5d7d0143 Some documentation updates
David Bateman <dbateman@free.fr>
parents: 7981
diff changeset
367 @example
bbaa5d7d0143 Some documentation updates
David Bateman <dbateman@free.fr>
parents: 7981
diff changeset
368 @group
bbaa5d7d0143 Some documentation updates
David Bateman <dbateman@free.fr>
parents: 7981
diff changeset
369 fplot (@@sin, [-10, 10], 201);
bbaa5d7d0143 Some documentation updates
David Bateman <dbateman@free.fr>
parents: 7981
diff changeset
370 @end group
bbaa5d7d0143 Some documentation updates
David Bateman <dbateman@free.fr>
parents: 7981
diff changeset
371 @end example
bbaa5d7d0143 Some documentation updates
David Bateman <dbateman@free.fr>
parents: 7981
diff changeset
372
bbaa5d7d0143 Some documentation updates
David Bateman <dbateman@free.fr>
parents: 7981
diff changeset
373 @noindent
bbaa5d7d0143 Some documentation updates
David Bateman <dbateman@free.fr>
parents: 7981
diff changeset
374 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
375 legend displaying the name of the plotted function.
bbaa5d7d0143 Some documentation updates
David Bateman <dbateman@free.fr>
parents: 7981
diff changeset
376
bbaa5d7d0143 Some documentation updates
David Bateman <dbateman@free.fr>
parents: 7981
diff changeset
377 @DOCSTRING(fplot)
bbaa5d7d0143 Some documentation updates
David Bateman <dbateman@free.fr>
parents: 7981
diff changeset
378
bbaa5d7d0143 Some documentation updates
David Bateman <dbateman@free.fr>
parents: 7981
diff changeset
379 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
380 function include @code{ezplot}, @code{ezcontour}, @code{ezcontourf} and
8046
c4482fc30c7f Add the ezplot function
David Bateman <dbateman@free.fr>
parents: 7989
diff changeset
381 @code{ezpolar}.
c4482fc30c7f Add the ezplot function
David Bateman <dbateman@free.fr>
parents: 7989
diff changeset
382
c4482fc30c7f Add the ezplot function
David Bateman <dbateman@free.fr>
parents: 7989
diff changeset
383 @DOCSTRING(ezplot)
7984
bbaa5d7d0143 Some documentation updates
David Bateman <dbateman@free.fr>
parents: 7981
diff changeset
384
bbaa5d7d0143 Some documentation updates
David Bateman <dbateman@free.fr>
parents: 7981
diff changeset
385 @DOCSTRING(ezcontour)
bbaa5d7d0143 Some documentation updates
David Bateman <dbateman@free.fr>
parents: 7981
diff changeset
386
bbaa5d7d0143 Some documentation updates
David Bateman <dbateman@free.fr>
parents: 7981
diff changeset
387 @DOCSTRING(ezcontourf)
bbaa5d7d0143 Some documentation updates
David Bateman <dbateman@free.fr>
parents: 7981
diff changeset
388
bbaa5d7d0143 Some documentation updates
David Bateman <dbateman@free.fr>
parents: 7981
diff changeset
389 @DOCSTRING(ezpolar)
bbaa5d7d0143 Some documentation updates
David Bateman <dbateman@free.fr>
parents: 7981
diff changeset
390
12761
13bcd62824a7 doc: Add documentation for gmres, rectangle to manual
Rik <octave@nomad.inbox5.com>
parents: 12690
diff changeset
391 @node Two-dimensional Geometric Shapes
13bcd62824a7 doc: Add documentation for gmres, rectangle to manual
Rik <octave@nomad.inbox5.com>
parents: 12690
diff changeset
392 @subsubsection Two-dimensional Geometric Shapes
13bcd62824a7 doc: Add documentation for gmres, rectangle to manual
Rik <octave@nomad.inbox5.com>
parents: 12690
diff changeset
393
13bcd62824a7 doc: Add documentation for gmres, rectangle to manual
Rik <octave@nomad.inbox5.com>
parents: 12690
diff changeset
394 @DOCSTRING(rectangle)
13bcd62824a7 doc: Add documentation for gmres, rectangle to manual
Rik <octave@nomad.inbox5.com>
parents: 12690
diff changeset
395
12526
f8ea3eabcb85 Add daspect, pbaspect functions to documentation.
Rik <octave@nomad.inbox5.com>
parents: 12525
diff changeset
396 @node Three-Dimensional Plots
f8ea3eabcb85 Add daspect, pbaspect functions to documentation.
Rik <octave@nomad.inbox5.com>
parents: 12525
diff changeset
397 @subsection Three-Dimensional Plots
18330
200851c87444 Edits to Manual and indicies
Michael Godfrey <michaeldgodfrey@gmail.com>
parents: 17957
diff changeset
398 @cindex plotting, three-dimensional
6888
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 function @code{mesh} produces mesh surface plots. For example,
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
401
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
402 @example
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
403 @group
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
404 tx = ty = linspace (-8, 8, 41)';
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
405 [xx, yy] = meshgrid (tx, ty);
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
406 r = sqrt (xx .^ 2 + yy .^ 2) + eps;
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
407 tz = sin (r) ./ r;
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
408 mesh (tx, ty, tz);
23214
76a894168fe5 doc: provide complete examples in plotting documentation (bug #44263)
Michael D. Godfrey <michaeldgodfrey@gmail.com>
parents: 23205
diff changeset
409 xlabel ("tx");
76a894168fe5 doc: provide complete examples in plotting documentation (bug #44263)
Michael D. Godfrey <michaeldgodfrey@gmail.com>
parents: 23205
diff changeset
410 ylabel ("ty");
76a894168fe5 doc: provide complete examples in plotting documentation (bug #44263)
Michael D. Godfrey <michaeldgodfrey@gmail.com>
parents: 23205
diff changeset
411 zlabel ("tz");
76a894168fe5 doc: provide complete examples in plotting documentation (bug #44263)
Michael D. Godfrey <michaeldgodfrey@gmail.com>
parents: 23205
diff changeset
412 title ("3-D Sombrero plot");
6888
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
413 @end group
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
414 @end example
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
415
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
416 @noindent
6899
110c5782fe3b [project @ 2007-09-14 15:17:53 by jwe]
jwe
parents: 6892
diff changeset
417 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
418 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
419 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
420 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
421
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
422 @float Figure,fig:mesh
9088
77e71f3da3d6 Fix documentation image printing under new development code
Rik <rdrider0-list@yahoo.com>
parents: 9040
diff changeset
423 @center @image{mesh,4in}
6888
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
424 @caption{Mesh plot.}
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
425 @end float
5134
0309b6722ee9 [project @ 2005-02-08 20:17:55 by jwe]
jwe
parents: 5016
diff changeset
426
6888
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
427 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
428 plot of contours for the surface.
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
429
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
430 The @code{plot3} function displays arbitrary three-dimensional data,
10828
322f43e0e170 Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents: 10711
diff changeset
431 without requiring it to form a surface. For example,
6888
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
432
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
433 @example
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
434 @group
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
435 t = 0:0.1:10*pi;
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
436 r = linspace (0, 1, numel (t));
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
437 z = linspace (0, 1, numel (t));
23214
76a894168fe5 doc: provide complete examples in plotting documentation (bug #44263)
Michael D. Godfrey <michaeldgodfrey@gmail.com>
parents: 23205
diff changeset
438 plot3 (r.*sin (t), r.*cos (t), z);
76a894168fe5 doc: provide complete examples in plotting documentation (bug #44263)
Michael D. Godfrey <michaeldgodfrey@gmail.com>
parents: 23205
diff changeset
439 xlabel ("r.*sin (t)");
76a894168fe5 doc: provide complete examples in plotting documentation (bug #44263)
Michael D. Godfrey <michaeldgodfrey@gmail.com>
parents: 23205
diff changeset
440 ylabel ("r.*cos (t)");
76a894168fe5 doc: provide complete examples in plotting documentation (bug #44263)
Michael D. Godfrey <michaeldgodfrey@gmail.com>
parents: 23205
diff changeset
441 zlabel ("z");
76a894168fe5 doc: provide complete examples in plotting documentation (bug #44263)
Michael D. Godfrey <michaeldgodfrey@gmail.com>
parents: 23205
diff changeset
442 title ("plot3 display of 3-D helix");
6888
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
443 @end group
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
444 @end example
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
445
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
446 @noindent
6899
110c5782fe3b [project @ 2007-09-14 15:17:53 by jwe]
jwe
parents: 6892
diff changeset
447 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
448
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
449 @float Figure,fig:plot3
9088
77e71f3da3d6 Fix documentation image printing under new development code
Rik <rdrider0-list@yahoo.com>
parents: 9040
diff changeset
450 @center @image{plot3,4in}
10828
322f43e0e170 Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents: 10711
diff changeset
451 @caption{Three-dimensional spiral.}
6888
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
452 @end float
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 Finally, the @code{view} function changes the viewpoint for
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
455 three-dimensional plots.
5134
0309b6722ee9 [project @ 2005-02-08 20:17:55 by jwe]
jwe
parents: 5016
diff changeset
456
0309b6722ee9 [project @ 2005-02-08 20:17:55 by jwe]
jwe
parents: 5016
diff changeset
457 @DOCSTRING(mesh)
0309b6722ee9 [project @ 2005-02-08 20:17:55 by jwe]
jwe
parents: 5016
diff changeset
458
6788
c81a0f3f5a82 [project @ 2007-07-23 22:05:29 by dbateman]
dbateman
parents: 6778
diff changeset
459 @DOCSTRING(meshc)
c81a0f3f5a82 [project @ 2007-07-23 22:05:29 by dbateman]
dbateman
parents: 6778
diff changeset
460
8817
03b7f618ab3d include docstrings for new functions in the manual
John W. Eaton <jwe@octave.org>
parents: 8519
diff changeset
461 @DOCSTRING(meshz)
03b7f618ab3d include docstrings for new functions in the manual
John W. Eaton <jwe@octave.org>
parents: 8519
diff changeset
462
7153
4246642e9f48 [project @ 2007-11-09 21:20:07 by dbateman]
dbateman
parents: 7120
diff changeset
463 @DOCSTRING(hidden)
4246642e9f48 [project @ 2007-11-09 21:20:07 by dbateman]
dbateman
parents: 7120
diff changeset
464
7120
a2174fb073d4 [project @ 2007-11-07 21:26:43 by jwe]
jwe
parents: 7018
diff changeset
465 @DOCSTRING(surf)
a2174fb073d4 [project @ 2007-11-07 21:26:43 by jwe]
jwe
parents: 7018
diff changeset
466
a2174fb073d4 [project @ 2007-11-07 21:26:43 by jwe]
jwe
parents: 7018
diff changeset
467 @DOCSTRING(surfc)
a2174fb073d4 [project @ 2007-11-07 21:26:43 by jwe]
jwe
parents: 7018
diff changeset
468
8817
03b7f618ab3d include docstrings for new functions in the manual
John W. Eaton <jwe@octave.org>
parents: 8519
diff changeset
469 @DOCSTRING(surfl)
03b7f618ab3d include docstrings for new functions in the manual
John W. Eaton <jwe@octave.org>
parents: 8519
diff changeset
470
03b7f618ab3d include docstrings for new functions in the manual
John W. Eaton <jwe@octave.org>
parents: 8519
diff changeset
471 @DOCSTRING(surfnorm)
03b7f618ab3d include docstrings for new functions in the manual
John W. Eaton <jwe@octave.org>
parents: 8519
diff changeset
472
12529
0579a13f29a1 Add isocolors, isonormals, isosurface functions to documentation.
Rik <octave@nomad.inbox5.com>
parents: 12526
diff changeset
473 @DOCSTRING(isosurface)
0579a13f29a1 Add isocolors, isonormals, isosurface functions to documentation.
Rik <octave@nomad.inbox5.com>
parents: 12526
diff changeset
474
0579a13f29a1 Add isocolors, isonormals, isosurface functions to documentation.
Rik <octave@nomad.inbox5.com>
parents: 12526
diff changeset
475 @DOCSTRING(isonormals)
0579a13f29a1 Add isocolors, isonormals, isosurface functions to documentation.
Rik <octave@nomad.inbox5.com>
parents: 12526
diff changeset
476
22278
3fe6663808cc Add function "isocaps" (patch #8872)
Markus Mützel <markus.muetzel@gmx.de>
parents: 22247
diff changeset
477 @DOCSTRING(isocaps)
3fe6663808cc Add function "isocaps" (patch #8872)
Markus Mützel <markus.muetzel@gmx.de>
parents: 22247
diff changeset
478
12529
0579a13f29a1 Add isocolors, isonormals, isosurface functions to documentation.
Rik <octave@nomad.inbox5.com>
parents: 12526
diff changeset
479 @DOCSTRING(isocolors)
0579a13f29a1 Add isocolors, isonormals, isosurface functions to documentation.
Rik <octave@nomad.inbox5.com>
parents: 12526
diff changeset
480
22142
62208397b99e Add function "smooth3" (patch #8864).
Markus Muetzel <markus.muetzel@gmx.de>
parents: 22140
diff changeset
481 @DOCSTRING(smooth3)
62208397b99e Add function "smooth3" (patch #8864).
Markus Muetzel <markus.muetzel@gmx.de>
parents: 22140
diff changeset
482
22231
01ba6ebc52e4 Add function "reducevolume" (patch #8856).
Markus Muetzel <markus.muetzel@gmx.de>
parents: 22142
diff changeset
483 @DOCSTRING(reducevolume)
01ba6ebc52e4 Add function "reducevolume" (patch #8856).
Markus Muetzel <markus.muetzel@gmx.de>
parents: 22142
diff changeset
484
22243
654de580bdb3 Add function "reducepatch" (patch #8912)
Markus Muetzel <markus.muetzel@gmx.de>
parents: 22231
diff changeset
485 @DOCSTRING(reducepatch)
654de580bdb3 Add function "reducepatch" (patch #8912)
Markus Muetzel <markus.muetzel@gmx.de>
parents: 22231
diff changeset
486
14574
9546bb28648c New Function, shrinkfaces.m
Martin Helm <martin@mhelm.de>
parents: 14456
diff changeset
487 @DOCSTRING(shrinkfaces)
9546bb28648c New Function, shrinkfaces.m
Martin Helm <martin@mhelm.de>
parents: 14456
diff changeset
488
8817
03b7f618ab3d include docstrings for new functions in the manual
John W. Eaton <jwe@octave.org>
parents: 8519
diff changeset
489 @DOCSTRING(diffuse)
03b7f618ab3d include docstrings for new functions in the manual
John W. Eaton <jwe@octave.org>
parents: 8519
diff changeset
490
03b7f618ab3d include docstrings for new functions in the manual
John W. Eaton <jwe@octave.org>
parents: 8519
diff changeset
491 @DOCSTRING(specular)
03b7f618ab3d include docstrings for new functions in the manual
John W. Eaton <jwe@octave.org>
parents: 8519
diff changeset
492
22140
18eae417ffec Add function "lighting" (patch #9040).
Markus Muetzel <markus.muetzel@gmx.de>
parents: 22106
diff changeset
493 @DOCSTRING(lighting)
18eae417ffec Add function "lighting" (patch #9040).
Markus Muetzel <markus.muetzel@gmx.de>
parents: 22106
diff changeset
494
22247
c8fc60a183a3 Add function material. (patch #9013)
Markus Muetzel <markus.muetzel@gmx.de>
parents: 22243
diff changeset
495 @DOCSTRING(material)
c8fc60a183a3 Add function material. (patch #9013)
Markus Muetzel <markus.muetzel@gmx.de>
parents: 22243
diff changeset
496
22288
57fded74ee22 Add camlight function (patch #9014).
Colin Macdonald <cbm@m.fsf.org>
parents: 22278
diff changeset
497 @DOCSTRING(camlight)
57fded74ee22 Add camlight function (patch #9014).
Colin Macdonald <cbm@m.fsf.org>
parents: 22278
diff changeset
498
26545
aea4e66eb331 New function lightangle (bug #55446).
Guillaume Flandin
parents: 26376
diff changeset
499 @DOCSTRING(lightangle)
aea4e66eb331 New function lightangle (bug #55446).
Guillaume Flandin
parents: 26376
diff changeset
500
5134
0309b6722ee9 [project @ 2005-02-08 20:17:55 by jwe]
jwe
parents: 5016
diff changeset
501 @DOCSTRING(meshgrid)
0309b6722ee9 [project @ 2005-02-08 20:17:55 by jwe]
jwe
parents: 5016
diff changeset
502
6550
1b7a6061a05d [project @ 2007-04-20 07:40:26 by jwe]
jwe
parents: 6549
diff changeset
503 @DOCSTRING(ndgrid)
1b7a6061a05d [project @ 2007-04-20 07:40:26 by jwe]
jwe
parents: 6549
diff changeset
504
6888
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
505 @DOCSTRING(plot3)
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
506
6502
6ab0a8767780 [project @ 2007-04-06 03:32:06 by jwe]
jwe
parents: 6331
diff changeset
507 @DOCSTRING(view)
6ab0a8767780 [project @ 2007-04-06 03:32:06 by jwe]
jwe
parents: 6331
diff changeset
508
24136
141e6e16d900 Add function camlookat (patch #9049).
Colin Macdonald <cbm@m.fsf.org>
parents: 24132
diff changeset
509 @DOCSTRING(camlookat)
141e6e16d900 Add function camlookat (patch #9049).
Colin Macdonald <cbm@m.fsf.org>
parents: 24132
diff changeset
510
24128
5ce4dfe5d906 Add basic camera set/get functions (patch #9046).
Colin Macdonald <cbm@m.fsf.org>
parents: 24050
diff changeset
511 @DOCSTRING(campos)
5ce4dfe5d906 Add basic camera set/get functions (patch #9046).
Colin Macdonald <cbm@m.fsf.org>
parents: 24050
diff changeset
512
24132
4e97a92d16c0 Add function camorbit (patch #9049).
Colin Macdonald <cbm@m.fsf.org>
parents: 24129
diff changeset
513 @DOCSTRING(camorbit)
4e97a92d16c0 Add function camorbit (patch #9049).
Colin Macdonald <cbm@m.fsf.org>
parents: 24129
diff changeset
514
24129
f80dc6db9d18 Add camzoom and camroll functions (patch #9049).
Colin Macdonald <cbm@m.fsf.org>
parents: 24128
diff changeset
515 @DOCSTRING(camroll)
f80dc6db9d18 Add camzoom and camroll functions (patch #9049).
Colin Macdonald <cbm@m.fsf.org>
parents: 24128
diff changeset
516
24128
5ce4dfe5d906 Add basic camera set/get functions (patch #9046).
Colin Macdonald <cbm@m.fsf.org>
parents: 24050
diff changeset
517 @DOCSTRING(camtarget)
5ce4dfe5d906 Add basic camera set/get functions (patch #9046).
Colin Macdonald <cbm@m.fsf.org>
parents: 24050
diff changeset
518
5ce4dfe5d906 Add basic camera set/get functions (patch #9046).
Colin Macdonald <cbm@m.fsf.org>
parents: 24050
diff changeset
519 @DOCSTRING(camup)
5ce4dfe5d906 Add basic camera set/get functions (patch #9046).
Colin Macdonald <cbm@m.fsf.org>
parents: 24050
diff changeset
520
5ce4dfe5d906 Add basic camera set/get functions (patch #9046).
Colin Macdonald <cbm@m.fsf.org>
parents: 24050
diff changeset
521 @DOCSTRING(camva)
5ce4dfe5d906 Add basic camera set/get functions (patch #9046).
Colin Macdonald <cbm@m.fsf.org>
parents: 24050
diff changeset
522
24129
f80dc6db9d18 Add camzoom and camroll functions (patch #9049).
Colin Macdonald <cbm@m.fsf.org>
parents: 24128
diff changeset
523 @DOCSTRING(camzoom)
f80dc6db9d18 Add camzoom and camroll functions (patch #9049).
Colin Macdonald <cbm@m.fsf.org>
parents: 24128
diff changeset
524
8817
03b7f618ab3d include docstrings for new functions in the manual
John W. Eaton <jwe@octave.org>
parents: 8519
diff changeset
525 @DOCSTRING(slice)
03b7f618ab3d include docstrings for new functions in the manual
John W. Eaton <jwe@octave.org>
parents: 8519
diff changeset
526
03b7f618ab3d include docstrings for new functions in the manual
John W. Eaton <jwe@octave.org>
parents: 8519
diff changeset
527 @DOCSTRING(ribbon)
03b7f618ab3d include docstrings for new functions in the manual
John W. Eaton <jwe@octave.org>
parents: 8519
diff changeset
528
7120
a2174fb073d4 [project @ 2007-11-07 21:26:43 by jwe]
jwe
parents: 7018
diff changeset
529 @DOCSTRING(shading)
a2174fb073d4 [project @ 2007-11-07 21:26:43 by jwe]
jwe
parents: 7018
diff changeset
530
9672
43a07df0ed4c document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents: 9316
diff changeset
531 @DOCSTRING(scatter3)
43a07df0ed4c document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents: 9316
diff changeset
532
16563
34a9a4e48f9b New function waterfall
Mike Miller <mtmiller@ieee.org>
parents: 16137
diff changeset
533 @DOCSTRING(waterfall)
34a9a4e48f9b New function waterfall
Mike Miller <mtmiller@ieee.org>
parents: 16137
diff changeset
534
7989
23c248d415b5 Various doc fixes. Readd cellidx
David Bateman <dbateman@free.fr>
parents: 7984
diff changeset
535 @menu
12526
f8ea3eabcb85 Add daspect, pbaspect functions to documentation.
Rik <octave@nomad.inbox5.com>
parents: 12525
diff changeset
536 * Aspect Ratio::
17152
f2a8592b8fbd doc: Shorten some long subsection names in Manual.
Rik <rik@octave.org>
parents: 17123
diff changeset
537 * Three-dimensional Function Plotting::
f2a8592b8fbd doc: Shorten some long subsection names in Manual.
Rik <rik@octave.org>
parents: 17123
diff changeset
538 * Three-dimensional Geometric Shapes::
7989
23c248d415b5 Various doc fixes. Readd cellidx
David Bateman <dbateman@free.fr>
parents: 7984
diff changeset
539 @end menu
23c248d415b5 Various doc fixes. Readd cellidx
David Bateman <dbateman@free.fr>
parents: 7984
diff changeset
540
12526
f8ea3eabcb85 Add daspect, pbaspect functions to documentation.
Rik <octave@nomad.inbox5.com>
parents: 12525
diff changeset
541 @node Aspect Ratio
f8ea3eabcb85 Add daspect, pbaspect functions to documentation.
Rik <octave@nomad.inbox5.com>
parents: 12525
diff changeset
542 @subsubsection Aspect Ratio
f8ea3eabcb85 Add daspect, pbaspect functions to documentation.
Rik <octave@nomad.inbox5.com>
parents: 12525
diff changeset
543
f8ea3eabcb85 Add daspect, pbaspect functions to documentation.
Rik <octave@nomad.inbox5.com>
parents: 12525
diff changeset
544 For three-dimensional plots the aspect ratio can be set for data with
17469
710b3d5fe966 improve interpreter tex Tables
Michael Godfrey <michaeldgodfrey@gmail.com>
parents: 17281
diff changeset
545 @code{daspect} and for the plot box with @code{pbaspect}.
17097
e7a059a9a644 doc: Use XREF as anchor prefix in documentation for clearer results in Info viewer.
Rik <rik@octave.org>
parents: 16923
diff changeset
546 @xref{Axis Configuration}, for controlling the x-, y-, and z-limits for
12526
f8ea3eabcb85 Add daspect, pbaspect functions to documentation.
Rik <octave@nomad.inbox5.com>
parents: 12525
diff changeset
547 plotting.
f8ea3eabcb85 Add daspect, pbaspect functions to documentation.
Rik <octave@nomad.inbox5.com>
parents: 12525
diff changeset
548
f8ea3eabcb85 Add daspect, pbaspect functions to documentation.
Rik <octave@nomad.inbox5.com>
parents: 12525
diff changeset
549 @DOCSTRING(daspect)
f8ea3eabcb85 Add daspect, pbaspect functions to documentation.
Rik <octave@nomad.inbox5.com>
parents: 12525
diff changeset
550
f8ea3eabcb85 Add daspect, pbaspect functions to documentation.
Rik <octave@nomad.inbox5.com>
parents: 12525
diff changeset
551 @DOCSTRING(pbaspect)
f8ea3eabcb85 Add daspect, pbaspect functions to documentation.
Rik <octave@nomad.inbox5.com>
parents: 12525
diff changeset
552
7989
23c248d415b5 Various doc fixes. Readd cellidx
David Bateman <dbateman@free.fr>
parents: 7984
diff changeset
553 @node Three-dimensional Function Plotting
23c248d415b5 Various doc fixes. Readd cellidx
David Bateman <dbateman@free.fr>
parents: 7984
diff changeset
554 @subsubsection Three-dimensional Function Plotting
7984
bbaa5d7d0143 Some documentation updates
David Bateman <dbateman@free.fr>
parents: 7981
diff changeset
555
bbaa5d7d0143 Some documentation updates
David Bateman <dbateman@free.fr>
parents: 7981
diff changeset
556 @DOCSTRING(ezplot3)
bbaa5d7d0143 Some documentation updates
David Bateman <dbateman@free.fr>
parents: 7981
diff changeset
557
bbaa5d7d0143 Some documentation updates
David Bateman <dbateman@free.fr>
parents: 7981
diff changeset
558 @DOCSTRING(ezmesh)
bbaa5d7d0143 Some documentation updates
David Bateman <dbateman@free.fr>
parents: 7981
diff changeset
559
bbaa5d7d0143 Some documentation updates
David Bateman <dbateman@free.fr>
parents: 7981
diff changeset
560 @DOCSTRING(ezmeshc)
bbaa5d7d0143 Some documentation updates
David Bateman <dbateman@free.fr>
parents: 7981
diff changeset
561
bbaa5d7d0143 Some documentation updates
David Bateman <dbateman@free.fr>
parents: 7981
diff changeset
562 @DOCSTRING(ezsurf)
bbaa5d7d0143 Some documentation updates
David Bateman <dbateman@free.fr>
parents: 7981
diff changeset
563
bbaa5d7d0143 Some documentation updates
David Bateman <dbateman@free.fr>
parents: 7981
diff changeset
564 @DOCSTRING(ezsurfc)
bbaa5d7d0143 Some documentation updates
David Bateman <dbateman@free.fr>
parents: 7981
diff changeset
565
8817
03b7f618ab3d include docstrings for new functions in the manual
John W. Eaton <jwe@octave.org>
parents: 8519
diff changeset
566 @node Three-dimensional Geometric Shapes
03b7f618ab3d include docstrings for new functions in the manual
John W. Eaton <jwe@octave.org>
parents: 8519
diff changeset
567 @subsubsection Three-dimensional Geometric Shapes
03b7f618ab3d include docstrings for new functions in the manual
John W. Eaton <jwe@octave.org>
parents: 8519
diff changeset
568
03b7f618ab3d include docstrings for new functions in the manual
John W. Eaton <jwe@octave.org>
parents: 8519
diff changeset
569 @DOCSTRING(cylinder)
03b7f618ab3d include docstrings for new functions in the manual
John W. Eaton <jwe@octave.org>
parents: 8519
diff changeset
570
03b7f618ab3d include docstrings for new functions in the manual
John W. Eaton <jwe@octave.org>
parents: 8519
diff changeset
571 @DOCSTRING(sphere)
03b7f618ab3d include docstrings for new functions in the manual
John W. Eaton <jwe@octave.org>
parents: 8519
diff changeset
572
03b7f618ab3d include docstrings for new functions in the manual
John W. Eaton <jwe@octave.org>
parents: 8519
diff changeset
573 @DOCSTRING(ellipsoid)
03b7f618ab3d include docstrings for new functions in the manual
John W. Eaton <jwe@octave.org>
parents: 8519
diff changeset
574
6888
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
575 @node Plot Annotations
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
576 @subsection Plot Annotations
6502
6ab0a8767780 [project @ 2007-04-06 03:32:06 by jwe]
jwe
parents: 6331
diff changeset
577
6888
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
578 You can add titles, axis labels, legends, and arbitrary text to an
10828
322f43e0e170 Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents: 10711
diff changeset
579 existing plot. For example:
6877
ab11bdb09820 [project @ 2007-09-07 05:12:32 by jwe]
jwe
parents: 6788
diff changeset
580
6888
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
581 @example
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
582 @group
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
583 x = -10:0.1:10;
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
584 plot (x, sin (x));
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
585 title ("sin(x) for x = -10:0.1:10");
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
586 xlabel ("x");
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
587 ylabel ("sin (x)");
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
588 text (pi, 0.7, "arbitrary text");
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
589 legend ("sin (x)");
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
590 @end group
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
591 @end example
6502
6ab0a8767780 [project @ 2007-04-06 03:32:06 by jwe]
jwe
parents: 6331
diff changeset
592
6888
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
593 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
594 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
595 border lines are on.
5134
0309b6722ee9 [project @ 2005-02-08 20:17:55 by jwe]
jwe
parents: 5016
diff changeset
596
19795
ca7599ae464d doc: Grammarcheck documentation ahead of 4.0 release.
Rik <rik@octave.org>
parents: 19777
diff changeset
597 Finally, arrows, text and rectangular or elliptic boxes can be added to
ca7599ae464d doc: Grammarcheck documentation ahead of 4.0 release.
Rik <rik@octave.org>
parents: 19777
diff changeset
598 highlight parts of a plot using the @code{annotation} function. Those objects
ca7599ae464d doc: Grammarcheck documentation ahead of 4.0 release.
Rik <rik@octave.org>
parents: 19777
diff changeset
599 are drawn in an invisible axes, on top of every other axes.
19741
b8e4104a8f55 Add the annotation function (bug #43282)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents: 19697
diff changeset
600
5134
0309b6722ee9 [project @ 2005-02-08 20:17:55 by jwe]
jwe
parents: 5016
diff changeset
601 @DOCSTRING(title)
0309b6722ee9 [project @ 2005-02-08 20:17:55 by jwe]
jwe
parents: 5016
diff changeset
602
6502
6ab0a8767780 [project @ 2007-04-06 03:32:06 by jwe]
jwe
parents: 6331
diff changeset
603 @DOCSTRING(legend)
6ab0a8767780 [project @ 2007-04-06 03:32:06 by jwe]
jwe
parents: 6331
diff changeset
604
6ab0a8767780 [project @ 2007-04-06 03:32:06 by jwe]
jwe
parents: 6331
diff changeset
605 @DOCSTRING(text)
6ab0a8767780 [project @ 2007-04-06 03:32:06 by jwe]
jwe
parents: 6331
diff changeset
606
24025
1187ad4865fc doc: add index entries for ylabel and zlabel
Mike Miller <mtmiller@octave.org>
parents: 23906
diff changeset
607 @c Add cross-references and function index entries for other label functions.
17097
e7a059a9a644 doc: Use XREF as anchor prefix in documentation for clearer results in Info viewer.
Rik <rik@octave.org>
parents: 16923
diff changeset
608 @anchor{XREFylabel}
e7a059a9a644 doc: Use XREF as anchor prefix in documentation for clearer results in Info viewer.
Rik <rik@octave.org>
parents: 16923
diff changeset
609 @anchor{XREFzlabel}
24025
1187ad4865fc doc: add index entries for ylabel and zlabel
Mike Miller <mtmiller@octave.org>
parents: 23906
diff changeset
610 @findex ylabel
1187ad4865fc doc: add index entries for ylabel and zlabel
Mike Miller <mtmiller@octave.org>
parents: 23906
diff changeset
611 @findex zlabel
5134
0309b6722ee9 [project @ 2005-02-08 20:17:55 by jwe]
jwe
parents: 5016
diff changeset
612 @DOCSTRING(xlabel)
0309b6722ee9 [project @ 2005-02-08 20:17:55 by jwe]
jwe
parents: 5016
diff changeset
613
8817
03b7f618ab3d include docstrings for new functions in the manual
John W. Eaton <jwe@octave.org>
parents: 8519
diff changeset
614 @DOCSTRING(clabel)
03b7f618ab3d include docstrings for new functions in the manual
John W. Eaton <jwe@octave.org>
parents: 8519
diff changeset
615
6502
6ab0a8767780 [project @ 2007-04-06 03:32:06 by jwe]
jwe
parents: 6331
diff changeset
616 @DOCSTRING(box)
6ab0a8767780 [project @ 2007-04-06 03:32:06 by jwe]
jwe
parents: 6331
diff changeset
617
6ab0a8767780 [project @ 2007-04-06 03:32:06 by jwe]
jwe
parents: 6331
diff changeset
618 @DOCSTRING(grid)
6ab0a8767780 [project @ 2007-04-06 03:32:06 by jwe]
jwe
parents: 6331
diff changeset
619
8089
0ec09255515a add colorbar docstring to the manual
John W. Eaton <jwe@octave.org>
parents: 8073
diff changeset
620 @DOCSTRING(colorbar)
0ec09255515a add colorbar docstring to the manual
John W. Eaton <jwe@octave.org>
parents: 8073
diff changeset
621
19741
b8e4104a8f55 Add the annotation function (bug #43282)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents: 19697
diff changeset
622 @DOCSTRING(annotation)
b8e4104a8f55 Add the annotation function (bug #43282)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents: 19697
diff changeset
623
5134
0309b6722ee9 [project @ 2005-02-08 20:17:55 by jwe]
jwe
parents: 5016
diff changeset
624 @node Multiple Plots on One Page
6888
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
625 @subsection Multiple Plots on One Page
18330
200851c87444 Edits to Manual and indicies
Michael Godfrey <michaeldgodfrey@gmail.com>
parents: 17957
diff changeset
626 @cindex plotting, multiple plots per figure
6888
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
627
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
628 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
629 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
630 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
631 For example,
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
632
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
633 @example
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
634 @group
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
635 subplot (2, 1, 1)
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
636 fplot (@@sin, [-10, 10]);
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
637 subplot (2, 1, 2)
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
638 fplot (@@cos, [-10, 10]);
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
639 @end group
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
640 @end example
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
641
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
642 @noindent
23089
b19287c4e74a doc: Reword documentation about subplots in 15.2.4 (bug #50148).
Rik <rik@octave.org>
parents: 22959
diff changeset
643 creates a figure with two separate axes, one displaying a sine wave and the
b19287c4e74a doc: Reword documentation about subplots in 15.2.4 (bug #50148).
Rik <rik@octave.org>
parents: 22959
diff changeset
644 other a cosine wave. The first call to subplot divides the figure into two
b19287c4e74a doc: Reword documentation about subplots in 15.2.4 (bug #50148).
Rik <rik@octave.org>
parents: 22959
diff changeset
645 plotting areas (two rows and one column) and makes the first plot area active.
b19287c4e74a doc: Reword documentation about subplots in 15.2.4 (bug #50148).
Rik <rik@octave.org>
parents: 22959
diff changeset
646 The grid of plot areas created by @code{subplot} is numbered in row-major order
b19287c4e74a doc: Reword documentation about subplots in 15.2.4 (bug #50148).
Rik <rik@octave.org>
parents: 22959
diff changeset
647 (left to right, top to bottom). After plotting a sine wave, the next call to
b19287c4e74a doc: Reword documentation about subplots in 15.2.4 (bug #50148).
Rik <rik@octave.org>
parents: 22959
diff changeset
648 subplot activates the second subplot area, but does not re-partition the
b19287c4e74a doc: Reword documentation about subplots in 15.2.4 (bug #50148).
Rik <rik@octave.org>
parents: 22959
diff changeset
649 figure.
5134
0309b6722ee9 [project @ 2005-02-08 20:17:55 by jwe]
jwe
parents: 5016
diff changeset
650
0309b6722ee9 [project @ 2005-02-08 20:17:55 by jwe]
jwe
parents: 5016
diff changeset
651 @DOCSTRING(subplot)
0309b6722ee9 [project @ 2005-02-08 20:17:55 by jwe]
jwe
parents: 5016
diff changeset
652
0309b6722ee9 [project @ 2005-02-08 20:17:55 by jwe]
jwe
parents: 5016
diff changeset
653 @node Multiple Plot Windows
6888
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
654 @subsection Multiple Plot Windows
18330
200851c87444 Edits to Manual and indicies
Michael Godfrey <michaeldgodfrey@gmail.com>
parents: 17957
diff changeset
655 @cindex plotting, multiple plot windows
6888
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
656
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
657 You can open multiple plot windows using the @code{figure} function.
10828
322f43e0e170 Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents: 10711
diff changeset
658 For example,
6888
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
659
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
660 @example
9088
77e71f3da3d6 Fix documentation image printing under new development code
Rik <rdrider0-list@yahoo.com>
parents: 9040
diff changeset
661 @group
6888
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
662 figure (1);
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
663 fplot (@@sin, [-10, 10]);
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
664 figure (2);
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
665 fplot (@@cos, [-10, 10]);
9088
77e71f3da3d6 Fix documentation image printing under new development code
Rik <rdrider0-list@yahoo.com>
parents: 9040
diff changeset
666 @end group
6888
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
667 @end example
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
668
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
669 @noindent
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
670 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
671 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
672
0309b6722ee9 [project @ 2005-02-08 20:17:55 by jwe]
jwe
parents: 5016
diff changeset
673 @DOCSTRING(figure)
16096
9720ecf8d257 Fix additional warning associated with Texinfo 5.0 (bug #38392)
Rik <rik@octave.org>
parents: 16094
diff changeset
674
19081
d59d052c9858 rotate.m: new function
John W. Eaton <jwe@octave.org>
parents: 19078
diff changeset
675 @node Manipulation of Plot Objects
d59d052c9858 rotate.m: new function
John W. Eaton <jwe@octave.org>
parents: 19078
diff changeset
676 @subsection Manipulation of Plot Objects
d59d052c9858 rotate.m: new function
John W. Eaton <jwe@octave.org>
parents: 19078
diff changeset
677 @cindex plotting, object manipulation
d59d052c9858 rotate.m: new function
John W. Eaton <jwe@octave.org>
parents: 19078
diff changeset
678
19090
4e5fae88065f add pan docstring to the manual
John W. Eaton <jwe@octave.org>
parents: 19089
diff changeset
679 @DOCSTRING(pan)
4e5fae88065f add pan docstring to the manual
John W. Eaton <jwe@octave.org>
parents: 19089
diff changeset
680
19081
d59d052c9858 rotate.m: new function
John W. Eaton <jwe@octave.org>
parents: 19078
diff changeset
681 @DOCSTRING(rotate)
d59d052c9858 rotate.m: new function
John W. Eaton <jwe@octave.org>
parents: 19078
diff changeset
682
19088
99aec089e8c3 add rotate3d docstring to the manual
John W. Eaton <jwe@octave.org>
parents: 19081
diff changeset
683 @DOCSTRING(rotate3d)
99aec089e8c3 add rotate3d docstring to the manual
John W. Eaton <jwe@octave.org>
parents: 19081
diff changeset
684
19089
8a6f87637c16 hg new function, zoom
John W. Eaton <jwe@octave.org>
parents: 19088
diff changeset
685 @DOCSTRING(zoom)
8a6f87637c16 hg new function, zoom
John W. Eaton <jwe@octave.org>
parents: 19088
diff changeset
686
16096
9720ecf8d257 Fix additional warning associated with Texinfo 5.0 (bug #38392)
Rik <rik@octave.org>
parents: 16094
diff changeset
687 @node Manipulation of Plot Windows
9720ecf8d257 Fix additional warning associated with Texinfo 5.0 (bug #38392)
Rik <rik@octave.org>
parents: 16094
diff changeset
688 @subsection Manipulation of Plot Windows
18330
200851c87444 Edits to Manual and indicies
Michael Godfrey <michaeldgodfrey@gmail.com>
parents: 17957
diff changeset
689 @cindex plotting, window manipulation
9672
43a07df0ed4c document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents: 9316
diff changeset
690
43a07df0ed4c document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents: 9316
diff changeset
691 By default, Octave refreshes the plot window when a prompt is printed,
43a07df0ed4c document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents: 9316
diff changeset
692 or when waiting for input. The
43a07df0ed4c document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents: 9316
diff changeset
693 @code{drawnow} function is used to cause a plot window to be updated.
43a07df0ed4c document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents: 9316
diff changeset
694
43a07df0ed4c document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents: 9316
diff changeset
695 @DOCSTRING(drawnow)
43a07df0ed4c document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents: 9316
diff changeset
696
43a07df0ed4c document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents: 9316
diff changeset
697 Only figures that are modified will be updated. The @code{refresh}
19257
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents: 19152
diff changeset
698 function can also be used to cause an update of the current figure, even if
9672
43a07df0ed4c document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents: 9316
diff changeset
699 it is not modified.
43a07df0ed4c document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents: 9316
diff changeset
700
43a07df0ed4c document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents: 9316
diff changeset
701 @DOCSTRING(refresh)
43a07df0ed4c document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents: 9316
diff changeset
702
43a07df0ed4c document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents: 9316
diff changeset
703 Normally, high-level plot functions like @code{plot} or @code{mesh} call
25857
c3c9c8533a86 Document that high level graphics functions redefine axes properties (bug #49400).
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents: 25585
diff changeset
704 @code{newplot} to determine whether the state of the target axes should be
c3c9c8533a86 Document that high level graphics functions redefine axes properties (bug #49400).
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents: 25585
diff changeset
705 initialized (the default) or if subsequent plots should be drawn on top of
c3c9c8533a86 Document that high level graphics functions redefine axes properties (bug #49400).
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents: 25585
diff changeset
706 previous ones. To have two plots drawn over one another, use the @code{hold}
c3c9c8533a86 Document that high level graphics functions redefine axes properties (bug #49400).
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents: 25585
diff changeset
707 function or manually change the axes @ref{XREFaxesnextplot, ,nextplot}
c3c9c8533a86 Document that high level graphics functions redefine axes properties (bug #49400).
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents: 25585
diff changeset
708 property. For example,
9672
43a07df0ed4c document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents: 9316
diff changeset
709
43a07df0ed4c document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents: 9316
diff changeset
710 @example
43a07df0ed4c document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents: 9316
diff changeset
711 @group
43a07df0ed4c document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents: 9316
diff changeset
712 hold on;
43a07df0ed4c document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents: 9316
diff changeset
713 x = -10:0.1:10;
43a07df0ed4c document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents: 9316
diff changeset
714 plot (x, sin (x));
43a07df0ed4c document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents: 9316
diff changeset
715 plot (x, cos (x));
43a07df0ed4c document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents: 9316
diff changeset
716 hold off;
43a07df0ed4c document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents: 9316
diff changeset
717 @end group
43a07df0ed4c document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents: 9316
diff changeset
718 @end example
43a07df0ed4c document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents: 9316
diff changeset
719
43a07df0ed4c document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents: 9316
diff changeset
720 @noindent
43a07df0ed4c document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents: 9316
diff changeset
721 displays sine and cosine waves on the same axes. If the hold state is
43a07df0ed4c document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents: 9316
diff changeset
722 off, consecutive plotting commands like this will only display the last
43a07df0ed4c document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents: 9316
diff changeset
723 plot.
43a07df0ed4c document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents: 9316
diff changeset
724
43a07df0ed4c document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents: 9316
diff changeset
725 @DOCSTRING(newplot)
43a07df0ed4c document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents: 9316
diff changeset
726
43a07df0ed4c document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents: 9316
diff changeset
727 @DOCSTRING(hold)
43a07df0ed4c document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents: 9316
diff changeset
728
43a07df0ed4c document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents: 9316
diff changeset
729 @DOCSTRING(ishold)
43a07df0ed4c document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents: 9316
diff changeset
730 To clear the current figure, call the @code{clf} function. To clear the
43a07df0ed4c document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents: 9316
diff changeset
731 current axis, call the @code{cla} function. To bring the current figure
43a07df0ed4c document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents: 9316
diff changeset
732 to the top of the window stack, call the @code{shg} function. To delete
43a07df0ed4c document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents: 9316
diff changeset
733 a graphics object, call @code{delete} on its index. To close the
43a07df0ed4c document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents: 9316
diff changeset
734 figure window, call the @code{close} function.
43a07df0ed4c document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents: 9316
diff changeset
735
43a07df0ed4c document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents: 9316
diff changeset
736 @DOCSTRING(clf)
43a07df0ed4c document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents: 9316
diff changeset
737
43a07df0ed4c document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents: 9316
diff changeset
738 @DOCSTRING(cla)
43a07df0ed4c document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents: 9316
diff changeset
739
43a07df0ed4c document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents: 9316
diff changeset
740 @DOCSTRING(shg)
43a07df0ed4c document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents: 9316
diff changeset
741
43a07df0ed4c document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents: 9316
diff changeset
742 @DOCSTRING(delete)
43a07df0ed4c document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents: 9316
diff changeset
743
43a07df0ed4c document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents: 9316
diff changeset
744 @DOCSTRING(close)
43a07df0ed4c document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents: 9316
diff changeset
745
43a07df0ed4c document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents: 9316
diff changeset
746 @DOCSTRING(closereq)
43a07df0ed4c document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents: 9316
diff changeset
747
31574
05a1b9a60efa doc: Avoid use of formatting Texinfo macros (e.g., @code) inside @menu, @xref macros.
Rik <rik@octave.org>
parents: 30564
diff changeset
748 @node Use of the "interpreter" Property
05a1b9a60efa doc: Avoid use of formatting Texinfo macros (e.g., @code) inside @menu, @xref macros.
Rik <rik@octave.org>
parents: 30564
diff changeset
749 @subsection Use of the "interpreter" Property
9672
43a07df0ed4c document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents: 9316
diff changeset
750
29470
2ae4764180c6 Initial implementation of a LaTeX interpreter (bug #59546).
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents: 29455
diff changeset
751 @code{text} (such as titles, labels, legend item) and @code{axes} objects
31574
05a1b9a60efa doc: Avoid use of formatting Texinfo macros (e.g., @code) inside @menu, @xref macros.
Rik <rik@octave.org>
parents: 30564
diff changeset
752 feature an @ref{XREFtextinterpreter,,@qcode{"interpreter}} and a
05a1b9a60efa doc: Avoid use of formatting Texinfo macros (e.g., @code) inside @menu, @xref macros.
Rik <rik@octave.org>
parents: 30564
diff changeset
753 @ref{XREFaxesticklabelinterpreter,,@qcode{"ticklabelinterpreter"}} property
05a1b9a60efa doc: Avoid use of formatting Texinfo macros (e.g., @code) inside @menu, @xref macros.
Rik <rik@octave.org>
parents: 30564
diff changeset
754 respectively. It determines the manner in which special control sequences in
05a1b9a60efa doc: Avoid use of formatting Texinfo macros (e.g., @code) inside @menu, @xref macros.
Rik <rik@octave.org>
parents: 30564
diff changeset
755 the text are rendered.
19011
c4ffcc961f3c Document that "tex" interpreter only works with gnuplot for printing (bug #42340).
Rik <rik@octave.org>
parents: 18844
diff changeset
756
c4ffcc961f3c Document that "tex" interpreter only works with gnuplot for printing (bug #42340).
Rik <rik@octave.org>
parents: 18844
diff changeset
757 The interpreter property can take three values: @qcode{"none"}, @qcode{"tex"},
29470
2ae4764180c6 Initial implementation of a LaTeX interpreter (bug #59546).
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents: 29455
diff changeset
758 @qcode{"latex"}.
2ae4764180c6 Initial implementation of a LaTeX interpreter (bug #59546).
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents: 29455
diff changeset
759
2ae4764180c6 Initial implementation of a LaTeX interpreter (bug #59546).
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents: 29455
diff changeset
760 @menu
31574
05a1b9a60efa doc: Avoid use of formatting Texinfo macros (e.g., @code) inside @menu, @xref macros.
Rik <rik@octave.org>
parents: 30564
diff changeset
761 * "none" interpreter::
05a1b9a60efa doc: Avoid use of formatting Texinfo macros (e.g., @code) inside @menu, @xref macros.
Rik <rik@octave.org>
parents: 30564
diff changeset
762 * "tex" interpreter::
05a1b9a60efa doc: Avoid use of formatting Texinfo macros (e.g., @code) inside @menu, @xref macros.
Rik <rik@octave.org>
parents: 30564
diff changeset
763 * "latex" interpreter::
29470
2ae4764180c6 Initial implementation of a LaTeX interpreter (bug #59546).
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents: 29455
diff changeset
764 @end menu
2ae4764180c6 Initial implementation of a LaTeX interpreter (bug #59546).
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents: 29455
diff changeset
765
31574
05a1b9a60efa doc: Avoid use of formatting Texinfo macros (e.g., @code) inside @menu, @xref macros.
Rik <rik@octave.org>
parents: 30564
diff changeset
766 @node "none" interpreter
05a1b9a60efa doc: Avoid use of formatting Texinfo macros (e.g., @code) inside @menu, @xref macros.
Rik <rik@octave.org>
parents: 30564
diff changeset
767 @subsubsection "none" interpreter
05a1b9a60efa doc: Avoid use of formatting Texinfo macros (e.g., @code) inside @menu, @xref macros.
Rik <rik@octave.org>
parents: 30564
diff changeset
768
29470
2ae4764180c6 Initial implementation of a LaTeX interpreter (bug #59546).
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents: 29455
diff changeset
769 If the interpreter is set to @qcode{"none"} then no special
19011
c4ffcc961f3c Document that "tex" interpreter only works with gnuplot for printing (bug #42340).
Rik <rik@octave.org>
parents: 18844
diff changeset
770 rendering occurs---the displayed text is a verbatim copy of the specified text.
29470
2ae4764180c6 Initial implementation of a LaTeX interpreter (bug #59546).
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents: 29455
diff changeset
771
31574
05a1b9a60efa doc: Avoid use of formatting Texinfo macros (e.g., @code) inside @menu, @xref macros.
Rik <rik@octave.org>
parents: 30564
diff changeset
772 @node "tex" interpreter
05a1b9a60efa doc: Avoid use of formatting Texinfo macros (e.g., @code) inside @menu, @xref macros.
Rik <rik@octave.org>
parents: 30564
diff changeset
773 @subsubsection "tex" interpreter
05a1b9a60efa doc: Avoid use of formatting Texinfo macros (e.g., @code) inside @menu, @xref macros.
Rik <rik@octave.org>
parents: 30564
diff changeset
774
29470
2ae4764180c6 Initial implementation of a LaTeX interpreter (bug #59546).
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents: 29455
diff changeset
775 The @qcode{"tex"} interpreter implements a subset of @TeX{} functionality when
18844
77d5e7661b8e doc: Update wording on using TeX interpreter in plotting.
Rik <rik@octave.org>
parents: 18330
diff changeset
776 rendering text. This allows the insertion of special glyphs such as Greek
21769
7496bd7265d9 doc: Document syntax for specifying color when using Tex interpreter (bug #47907).
Rik <rik@octave.org>
parents: 21155
diff changeset
777 characters or mathematical symbols. Special characters are inserted by using
7496bd7265d9 doc: Document syntax for specifying color when using Tex interpreter (bug #47907).
Rik <rik@octave.org>
parents: 21155
diff changeset
778 a backslash (\) character followed by a code, as shown in @ref{tab:extended}.
19011
c4ffcc961f3c Document that "tex" interpreter only works with gnuplot for printing (bug #42340).
Rik <rik@octave.org>
parents: 18844
diff changeset
779
21769
7496bd7265d9 doc: Document syntax for specifying color when using Tex interpreter (bug #47907).
Rik <rik@octave.org>
parents: 21155
diff changeset
780 Besides special glyphs, the formatting of the text can be changed within the
19011
c4ffcc961f3c Document that "tex" interpreter only works with gnuplot for printing (bug #42340).
Rik <rik@octave.org>
parents: 18844
diff changeset
781 string by using the codes
9672
43a07df0ed4c document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents: 9316
diff changeset
782
43a07df0ed4c document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents: 9316
diff changeset
783 @multitable @columnfractions .2 .2 .6 .2
43a07df0ed4c document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents: 9316
diff changeset
784 @item @tab \bf @tab Bold font @tab
43a07df0ed4c document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents: 9316
diff changeset
785 @item @tab \it @tab Italic font @tab
43a07df0ed4c document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents: 9316
diff changeset
786 @item @tab \sl @tab Oblique Font @tab
43a07df0ed4c document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents: 9316
diff changeset
787 @item @tab \rm @tab Normal font @tab
43a07df0ed4c document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents: 9316
diff changeset
788 @end multitable
43a07df0ed4c document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents: 9316
diff changeset
789
19011
c4ffcc961f3c Document that "tex" interpreter only works with gnuplot for printing (bug #42340).
Rik <rik@octave.org>
parents: 18844
diff changeset
790 These codes may be used in conjunction with the @{ and @} characters to limit
21769
7496bd7265d9 doc: Document syntax for specifying color when using Tex interpreter (bug #47907).
Rik <rik@octave.org>
parents: 21155
diff changeset
791 the change to a part of the string. For example,
9672
43a07df0ed4c document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents: 9316
diff changeset
792
43a07df0ed4c document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents: 9316
diff changeset
793 @example
43a07df0ed4c document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents: 9316
diff changeset
794 xlabel ('@{\bf H@} = a @{\bf V@}')
43a07df0ed4c document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents: 9316
diff changeset
795 @end example
43a07df0ed4c document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents: 9316
diff changeset
796
10846
a4f482e66b65 Grammarcheck more of the documentation.
Rik <octave@nomad.inbox5.com>
parents: 10828
diff changeset
797 @noindent
21769
7496bd7265d9 doc: Document syntax for specifying color when using Tex interpreter (bug #47907).
Rik <rik@octave.org>
parents: 21155
diff changeset
798 where the character @qcode{'a'} will not appear in bold font. Note that to
7496bd7265d9 doc: Document syntax for specifying color when using Tex interpreter (bug #47907).
Rik <rik@octave.org>
parents: 21155
diff changeset
799 avoid having Octave interpret the backslash character in the strings,
7496bd7265d9 doc: Document syntax for specifying color when using Tex interpreter (bug #47907).
Rik <rik@octave.org>
parents: 21155
diff changeset
800 the strings themselves should be in single quotes.
9672
43a07df0ed4c document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents: 9316
diff changeset
801
43a07df0ed4c document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents: 9316
diff changeset
802 It is also possible to change the fontname and size within the text
43a07df0ed4c document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents: 9316
diff changeset
803
43a07df0ed4c document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents: 9316
diff changeset
804 @multitable @columnfractions .1 .4 .6 .1
43a07df0ed4c document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents: 9316
diff changeset
805 @item @tab \fontname@{@var{fontname}@} @tab Specify the font to use @tab
43a07df0ed4c document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents: 9316
diff changeset
806 @item @tab \fontsize@{@var{size}@} @tab Specify the size of the font to
43a07df0ed4c document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents: 9316
diff changeset
807 use @tab
43a07df0ed4c document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents: 9316
diff changeset
808 @end multitable
43a07df0ed4c document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents: 9316
diff changeset
809
21769
7496bd7265d9 doc: Document syntax for specifying color when using Tex interpreter (bug #47907).
Rik <rik@octave.org>
parents: 21155
diff changeset
810 The color of the text may also be changed inline using either a string (e.g.,
23906
3b81ef7b562c doc: Explain how to form correct strings for "latex" interpreter mode.
Rik <rik@octave.org>
parents: 23903
diff changeset
811 "red") or numerically with a Red-Green-Blue (RGB) specification (e.g.,
21769
7496bd7265d9 doc: Document syntax for specifying color when using Tex interpreter (bug #47907).
Rik <rik@octave.org>
parents: 21155
diff changeset
812 [1 0 0], also red).
7496bd7265d9 doc: Document syntax for specifying color when using Tex interpreter (bug #47907).
Rik <rik@octave.org>
parents: 21155
diff changeset
813
7496bd7265d9 doc: Document syntax for specifying color when using Tex interpreter (bug #47907).
Rik <rik@octave.org>
parents: 21155
diff changeset
814 @multitable @columnfractions .1 .4 .6 .1
7496bd7265d9 doc: Document syntax for specifying color when using Tex interpreter (bug #47907).
Rik <rik@octave.org>
parents: 21155
diff changeset
815 @item @tab \color@{@var{color}@} @tab Specify the color as a string @tab
7496bd7265d9 doc: Document syntax for specifying color when using Tex interpreter (bug #47907).
Rik <rik@octave.org>
parents: 21155
diff changeset
816 @item @tab \color[rgb]@{@var{R} @var{G} @var{B}@} @tab Specify the color
7496bd7265d9 doc: Document syntax for specifying color when using Tex interpreter (bug #47907).
Rik <rik@octave.org>
parents: 21155
diff changeset
817 numerically @tab
7496bd7265d9 doc: Document syntax for specifying color when using Tex interpreter (bug #47907).
Rik <rik@octave.org>
parents: 21155
diff changeset
818 @end multitable
7496bd7265d9 doc: Document syntax for specifying color when using Tex interpreter (bug #47907).
Rik <rik@octave.org>
parents: 21155
diff changeset
819
18844
77d5e7661b8e doc: Update wording on using TeX interpreter in plotting.
Rik <rik@octave.org>
parents: 18330
diff changeset
820 Finally, superscripting and subscripting can be controlled with the @qcode{'^'}
17281
bc924baa2c4e doc: Add new @qcode macro for code samples which are quoted.
Rik <rik@octave.org>
parents: 17170
diff changeset
821 and @qcode{'_'} characters. If the @qcode{'^'} or @qcode{'_'} is followed by a
23906
3b81ef7b562c doc: Explain how to form correct strings for "latex" interpreter mode.
Rik <rik@octave.org>
parents: 23903
diff changeset
822 @{ character, then all of the block surrounded by the @w{@{ @}} pair is
3b81ef7b562c doc: Explain how to form correct strings for "latex" interpreter mode.
Rik <rik@octave.org>
parents: 23903
diff changeset
823 superscripted or subscripted. Without the @w{@{ @}} pair, only the character
21769
7496bd7265d9 doc: Document syntax for specifying color when using Tex interpreter (bug #47907).
Rik <rik@octave.org>
parents: 21155
diff changeset
824 immediately following the @qcode{'^'} or @qcode{'_'} is changed.
9672
43a07df0ed4c document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents: 9316
diff changeset
825
43a07df0ed4c document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents: 9316
diff changeset
826 @float Table,tab:extended
43a07df0ed4c document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents: 9316
diff changeset
827 @tex
43a07df0ed4c document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents: 9316
diff changeset
828 \vskip 6pt
17521
3670ce8da1a0 doc: improve format of table 15.1 for TeX characters.
Michael Godfrey <michaeldgodfrey@gmail.com>
parents: 17469
diff changeset
829 \newdimen\cola \cola=78pt
3670ce8da1a0 doc: improve format of table 15.1 for TeX characters.
Michael Godfrey <michaeldgodfrey@gmail.com>
parents: 17469
diff changeset
830 \newdimen\colb \colb=78pt
3670ce8da1a0 doc: improve format of table 15.1 for TeX characters.
Michael Godfrey <michaeldgodfrey@gmail.com>
parents: 17469
diff changeset
831 \newdimen\colc \colc=78pt
3670ce8da1a0 doc: improve format of table 15.1 for TeX characters.
Michael Godfrey <michaeldgodfrey@gmail.com>
parents: 17469
diff changeset
832 \def\symtable#1#2#3{
3670ce8da1a0 doc: improve format of table 15.1 for TeX characters.
Michael Godfrey <michaeldgodfrey@gmail.com>
parents: 17469
diff changeset
833 \hbox to \hsize {\hfill\vbox{\offinterlineskip \tabskip=0pt
17469
710b3d5fe966 improve interpreter tex Tables
Michael Godfrey <michaeldgodfrey@gmail.com>
parents: 17281
diff changeset
834 \hskip36pt #1
710b3d5fe966 improve interpreter tex Tables
Michael Godfrey <michaeldgodfrey@gmail.com>
parents: 17281
diff changeset
835 \vskip6pt
9672
43a07df0ed4c document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents: 9316
diff changeset
836 \halign{
17469
710b3d5fe966 improve interpreter tex Tables
Michael Godfrey <michaeldgodfrey@gmail.com>
parents: 17281
diff changeset
837 \vrule height2.0ex depth1.ex width 0.6pt #2\tabskip=0.3em &
710b3d5fe966 improve interpreter tex Tables
Michael Godfrey <michaeldgodfrey@gmail.com>
parents: 17281
diff changeset
838 #2 \hfil & \vrule #2 & #2 \hfil & #2 \vrule &
710b3d5fe966 improve interpreter tex Tables
Michael Godfrey <michaeldgodfrey@gmail.com>
parents: 17281
diff changeset
839 #2 \hfil & \vrule #2 & #2 \hfil & #2 \vrule &
710b3d5fe966 improve interpreter tex Tables
Michael Godfrey <michaeldgodfrey@gmail.com>
parents: 17281
diff changeset
840 #2 \hfil & \vrule #2 & #2 \hfil & #2 \vrule
9672
43a07df0ed4c document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents: 9316
diff changeset
841 width 0.6pt \tabskip=0pt\cr
43a07df0ed4c document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents: 9316
diff changeset
842 \noalign{\hrule height 0.6pt}
43a07df0ed4c document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents: 9316
diff changeset
843 & Code && Sym && Code && Sym && Code && Sym &\cr
43a07df0ed4c document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents: 9316
diff changeset
844 \noalign{\hrule}
17469
710b3d5fe966 improve interpreter tex Tables
Michael Godfrey <michaeldgodfrey@gmail.com>
parents: 17281
diff changeset
845 #3
9672
43a07df0ed4c document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents: 9316
diff changeset
846 \noalign{\hrule height 0.6pt}
17469
710b3d5fe966 improve interpreter tex Tables
Michael Godfrey <michaeldgodfrey@gmail.com>
parents: 17281
diff changeset
847 }
710b3d5fe966 improve interpreter tex Tables
Michael Godfrey <michaeldgodfrey@gmail.com>
parents: 17281
diff changeset
848 }\hfill}}
17521
3670ce8da1a0 doc: improve format of table 15.1 for TeX characters.
Michael Godfrey <michaeldgodfrey@gmail.com>
parents: 17469
diff changeset
849 \hoffset72pt
17469
710b3d5fe966 improve interpreter tex Tables
Michael Godfrey <michaeldgodfrey@gmail.com>
parents: 17281
diff changeset
850 \symtable{Greek Lowercase Letters} {#}
17521
3670ce8da1a0 doc: improve format of table 15.1 for TeX characters.
Michael Godfrey <michaeldgodfrey@gmail.com>
parents: 17469
diff changeset
851 {& \hbox to \cola{$\backslash$alpha } && $\alpha$
3670ce8da1a0 doc: improve format of table 15.1 for TeX characters.
Michael Godfrey <michaeldgodfrey@gmail.com>
parents: 17469
diff changeset
852 && \hbox to \colb{$\backslash$beta } && $\beta$
3670ce8da1a0 doc: improve format of table 15.1 for TeX characters.
Michael Godfrey <michaeldgodfrey@gmail.com>
parents: 17469
diff changeset
853 && \hbox to \colc{$\backslash$gamma} && $\gamma$ &\cr
17469
710b3d5fe966 improve interpreter tex Tables
Michael Godfrey <michaeldgodfrey@gmail.com>
parents: 17281
diff changeset
854 & $\backslash$delta && $\delta$
710b3d5fe966 improve interpreter tex Tables
Michael Godfrey <michaeldgodfrey@gmail.com>
parents: 17281
diff changeset
855 && $\backslash$epsilon && $\epsilon$
710b3d5fe966 improve interpreter tex Tables
Michael Godfrey <michaeldgodfrey@gmail.com>
parents: 17281
diff changeset
856 && $\backslash$zeta && $\zeta$ &\cr
710b3d5fe966 improve interpreter tex Tables
Michael Godfrey <michaeldgodfrey@gmail.com>
parents: 17281
diff changeset
857 & $\backslash$eta && $\eta$
710b3d5fe966 improve interpreter tex Tables
Michael Godfrey <michaeldgodfrey@gmail.com>
parents: 17281
diff changeset
858 && $\backslash$theta && $\theta$
710b3d5fe966 improve interpreter tex Tables
Michael Godfrey <michaeldgodfrey@gmail.com>
parents: 17281
diff changeset
859 && $\backslash$vartheta && $\vartheta$ &\cr
710b3d5fe966 improve interpreter tex Tables
Michael Godfrey <michaeldgodfrey@gmail.com>
parents: 17281
diff changeset
860 & $\backslash$iota && $\iota$
710b3d5fe966 improve interpreter tex Tables
Michael Godfrey <michaeldgodfrey@gmail.com>
parents: 17281
diff changeset
861 && $\backslash$kappa && $\kappa$
710b3d5fe966 improve interpreter tex Tables
Michael Godfrey <michaeldgodfrey@gmail.com>
parents: 17281
diff changeset
862 && $\backslash$lambda && $\lambda$ &\cr
710b3d5fe966 improve interpreter tex Tables
Michael Godfrey <michaeldgodfrey@gmail.com>
parents: 17281
diff changeset
863 & $\backslash$mu && $\mu$
710b3d5fe966 improve interpreter tex Tables
Michael Godfrey <michaeldgodfrey@gmail.com>
parents: 17281
diff changeset
864 && $\backslash$nu && $\nu$
710b3d5fe966 improve interpreter tex Tables
Michael Godfrey <michaeldgodfrey@gmail.com>
parents: 17281
diff changeset
865 && $\backslash$xi && $\xi$ &\cr
710b3d5fe966 improve interpreter tex Tables
Michael Godfrey <michaeldgodfrey@gmail.com>
parents: 17281
diff changeset
866 & $\backslash$o && $o$
710b3d5fe966 improve interpreter tex Tables
Michael Godfrey <michaeldgodfrey@gmail.com>
parents: 17281
diff changeset
867 && $\backslash$pi && $\pi$
710b3d5fe966 improve interpreter tex Tables
Michael Godfrey <michaeldgodfrey@gmail.com>
parents: 17281
diff changeset
868 && $\backslash$varpi && $\varpi$ &\cr
710b3d5fe966 improve interpreter tex Tables
Michael Godfrey <michaeldgodfrey@gmail.com>
parents: 17281
diff changeset
869 & $\backslash$rho && $\rho$
710b3d5fe966 improve interpreter tex Tables
Michael Godfrey <michaeldgodfrey@gmail.com>
parents: 17281
diff changeset
870 && $\backslash$sigma && $\sigma$
710b3d5fe966 improve interpreter tex Tables
Michael Godfrey <michaeldgodfrey@gmail.com>
parents: 17281
diff changeset
871 && $\backslash$varsigma && $\varsigma$ &\cr
710b3d5fe966 improve interpreter tex Tables
Michael Godfrey <michaeldgodfrey@gmail.com>
parents: 17281
diff changeset
872 & $\backslash$tau && $\tau$
710b3d5fe966 improve interpreter tex Tables
Michael Godfrey <michaeldgodfrey@gmail.com>
parents: 17281
diff changeset
873 && $\backslash$upsilon && $\upsilon$
710b3d5fe966 improve interpreter tex Tables
Michael Godfrey <michaeldgodfrey@gmail.com>
parents: 17281
diff changeset
874 && $\backslash$phi && $\phi$ &\cr
710b3d5fe966 improve interpreter tex Tables
Michael Godfrey <michaeldgodfrey@gmail.com>
parents: 17281
diff changeset
875 & $\backslash$chi && $\chi$
710b3d5fe966 improve interpreter tex Tables
Michael Godfrey <michaeldgodfrey@gmail.com>
parents: 17281
diff changeset
876 && $\backslash$psi && $\psi$
710b3d5fe966 improve interpreter tex Tables
Michael Godfrey <michaeldgodfrey@gmail.com>
parents: 17281
diff changeset
877 && $\backslash$omega && $\omega$ &\cr}
710b3d5fe966 improve interpreter tex Tables
Michael Godfrey <michaeldgodfrey@gmail.com>
parents: 17281
diff changeset
878 \vskip12pt
710b3d5fe966 improve interpreter tex Tables
Michael Godfrey <michaeldgodfrey@gmail.com>
parents: 17281
diff changeset
879 \symtable{Greek Uppercase Letters} {#}
17521
3670ce8da1a0 doc: improve format of table 15.1 for TeX characters.
Michael Godfrey <michaeldgodfrey@gmail.com>
parents: 17469
diff changeset
880 {& \hbox to \cola{$\backslash$Gamma} && $\Gamma$
3670ce8da1a0 doc: improve format of table 15.1 for TeX characters.
Michael Godfrey <michaeldgodfrey@gmail.com>
parents: 17469
diff changeset
881 && \hbox to \colb{$\backslash$Delta} && $\Delta$
3670ce8da1a0 doc: improve format of table 15.1 for TeX characters.
Michael Godfrey <michaeldgodfrey@gmail.com>
parents: 17469
diff changeset
882 && \hbox to \colc{$\backslash$Theta} && $\Theta$ &\cr
17469
710b3d5fe966 improve interpreter tex Tables
Michael Godfrey <michaeldgodfrey@gmail.com>
parents: 17281
diff changeset
883 & $\backslash$Lambda && $\Lambda$
710b3d5fe966 improve interpreter tex Tables
Michael Godfrey <michaeldgodfrey@gmail.com>
parents: 17281
diff changeset
884 && $\backslash$Xi && $\Xi$
710b3d5fe966 improve interpreter tex Tables
Michael Godfrey <michaeldgodfrey@gmail.com>
parents: 17281
diff changeset
885 && $\backslash$Pi && $\Pi$ &\cr
710b3d5fe966 improve interpreter tex Tables
Michael Godfrey <michaeldgodfrey@gmail.com>
parents: 17281
diff changeset
886 & $\backslash$Sigma && $\Sigma$
710b3d5fe966 improve interpreter tex Tables
Michael Godfrey <michaeldgodfrey@gmail.com>
parents: 17281
diff changeset
887 && $\backslash$Upsilon && $\Upsilon$
710b3d5fe966 improve interpreter tex Tables
Michael Godfrey <michaeldgodfrey@gmail.com>
parents: 17281
diff changeset
888 && $\backslash$Phi && $\Phi$ &\cr
710b3d5fe966 improve interpreter tex Tables
Michael Godfrey <michaeldgodfrey@gmail.com>
parents: 17281
diff changeset
889 & $\backslash$Psi && $\Psi$
710b3d5fe966 improve interpreter tex Tables
Michael Godfrey <michaeldgodfrey@gmail.com>
parents: 17281
diff changeset
890 && $\backslash$Omega && $\Omega$
710b3d5fe966 improve interpreter tex Tables
Michael Godfrey <michaeldgodfrey@gmail.com>
parents: 17281
diff changeset
891 && && &\cr}
710b3d5fe966 improve interpreter tex Tables
Michael Godfrey <michaeldgodfrey@gmail.com>
parents: 17281
diff changeset
892 \vskip12pt
710b3d5fe966 improve interpreter tex Tables
Michael Godfrey <michaeldgodfrey@gmail.com>
parents: 17281
diff changeset
893 \symtable{Misc Symbols Type Ord} {#}
17521
3670ce8da1a0 doc: improve format of table 15.1 for TeX characters.
Michael Godfrey <michaeldgodfrey@gmail.com>
parents: 17469
diff changeset
894 {& \hbox to \cola{$\backslash$aleph} && $\aleph$
3670ce8da1a0 doc: improve format of table 15.1 for TeX characters.
Michael Godfrey <michaeldgodfrey@gmail.com>
parents: 17469
diff changeset
895 && \hbox to \colb{$\backslash$wp} && $\wp$
3670ce8da1a0 doc: improve format of table 15.1 for TeX characters.
Michael Godfrey <michaeldgodfrey@gmail.com>
parents: 17469
diff changeset
896 && \hbox to \colc{$\backslash$Re} && $\Re$ &\cr
17469
710b3d5fe966 improve interpreter tex Tables
Michael Godfrey <michaeldgodfrey@gmail.com>
parents: 17281
diff changeset
897 & $\backslash$Im && $\Im$
710b3d5fe966 improve interpreter tex Tables
Michael Godfrey <michaeldgodfrey@gmail.com>
parents: 17281
diff changeset
898 && $\backslash$partial && $\partial$
710b3d5fe966 improve interpreter tex Tables
Michael Godfrey <michaeldgodfrey@gmail.com>
parents: 17281
diff changeset
899 && $\backslash$infty && $\infty$ &\cr
710b3d5fe966 improve interpreter tex Tables
Michael Godfrey <michaeldgodfrey@gmail.com>
parents: 17281
diff changeset
900 & $\backslash$prime && $\prime$
710b3d5fe966 improve interpreter tex Tables
Michael Godfrey <michaeldgodfrey@gmail.com>
parents: 17281
diff changeset
901 && $\backslash$nabla && $\nabla$
710b3d5fe966 improve interpreter tex Tables
Michael Godfrey <michaeldgodfrey@gmail.com>
parents: 17281
diff changeset
902 && $\backslash$surd && $\surd$ &\cr
710b3d5fe966 improve interpreter tex Tables
Michael Godfrey <michaeldgodfrey@gmail.com>
parents: 17281
diff changeset
903 & $\backslash$angle && $\angle$
710b3d5fe966 improve interpreter tex Tables
Michael Godfrey <michaeldgodfrey@gmail.com>
parents: 17281
diff changeset
904 && $\backslash$forall && $\forall$
710b3d5fe966 improve interpreter tex Tables
Michael Godfrey <michaeldgodfrey@gmail.com>
parents: 17281
diff changeset
905 && $\backslash$exists && $\exists$ &\cr
710b3d5fe966 improve interpreter tex Tables
Michael Godfrey <michaeldgodfrey@gmail.com>
parents: 17281
diff changeset
906 & $\backslash$neg && $\neg$
710b3d5fe966 improve interpreter tex Tables
Michael Godfrey <michaeldgodfrey@gmail.com>
parents: 17281
diff changeset
907 && $\backslash$clubsuit && $\clubsuit$
710b3d5fe966 improve interpreter tex Tables
Michael Godfrey <michaeldgodfrey@gmail.com>
parents: 17281
diff changeset
908 && $\backslash$diamondsuit && $\diamondsuit$ &\cr
710b3d5fe966 improve interpreter tex Tables
Michael Godfrey <michaeldgodfrey@gmail.com>
parents: 17281
diff changeset
909 & $\backslash$heartsuit && $\heartsuit$
710b3d5fe966 improve interpreter tex Tables
Michael Godfrey <michaeldgodfrey@gmail.com>
parents: 17281
diff changeset
910 && $\backslash$spadesuit && $\spadesuit$
710b3d5fe966 improve interpreter tex Tables
Michael Godfrey <michaeldgodfrey@gmail.com>
parents: 17281
diff changeset
911 && && &\cr}
710b3d5fe966 improve interpreter tex Tables
Michael Godfrey <michaeldgodfrey@gmail.com>
parents: 17281
diff changeset
912 \vskip12pt
710b3d5fe966 improve interpreter tex Tables
Michael Godfrey <michaeldgodfrey@gmail.com>
parents: 17281
diff changeset
913 \symtable{``Large'' Operators} {#}
17521
3670ce8da1a0 doc: improve format of table 15.1 for TeX characters.
Michael Godfrey <michaeldgodfrey@gmail.com>
parents: 17469
diff changeset
914 {& \hbox to \cola{$\backslash$int} && $\int$
3670ce8da1a0 doc: improve format of table 15.1 for TeX characters.
Michael Godfrey <michaeldgodfrey@gmail.com>
parents: 17469
diff changeset
915 && \hbox to \colb{} &&
3670ce8da1a0 doc: improve format of table 15.1 for TeX characters.
Michael Godfrey <michaeldgodfrey@gmail.com>
parents: 17469
diff changeset
916 && \hbox to \colc{} && &\cr}
17469
710b3d5fe966 improve interpreter tex Tables
Michael Godfrey <michaeldgodfrey@gmail.com>
parents: 17281
diff changeset
917 \vskip12pt
710b3d5fe966 improve interpreter tex Tables
Michael Godfrey <michaeldgodfrey@gmail.com>
parents: 17281
diff changeset
918 \symtable{Binary operators} {#}
17521
3670ce8da1a0 doc: improve format of table 15.1 for TeX characters.
Michael Godfrey <michaeldgodfrey@gmail.com>
parents: 17469
diff changeset
919 {& \hbox to \cola{$\backslash$pm} && $\pm$
3670ce8da1a0 doc: improve format of table 15.1 for TeX characters.
Michael Godfrey <michaeldgodfrey@gmail.com>
parents: 17469
diff changeset
920 && \hbox to \colb{$\backslash$cdot} && $\cdot$
3670ce8da1a0 doc: improve format of table 15.1 for TeX characters.
Michael Godfrey <michaeldgodfrey@gmail.com>
parents: 17469
diff changeset
921 && \hbox to \colc{$\backslash$times} && $\times$ &\cr
17469
710b3d5fe966 improve interpreter tex Tables
Michael Godfrey <michaeldgodfrey@gmail.com>
parents: 17281
diff changeset
922 & $\backslash$ast && $\ast$
710b3d5fe966 improve interpreter tex Tables
Michael Godfrey <michaeldgodfrey@gmail.com>
parents: 17281
diff changeset
923 && $\backslash$circ && $\circ$
710b3d5fe966 improve interpreter tex Tables
Michael Godfrey <michaeldgodfrey@gmail.com>
parents: 17281
diff changeset
924 && $\backslash$bullet && $\bullet$ &\cr
710b3d5fe966 improve interpreter tex Tables
Michael Godfrey <michaeldgodfrey@gmail.com>
parents: 17281
diff changeset
925 & $\backslash$div && $\div$
710b3d5fe966 improve interpreter tex Tables
Michael Godfrey <michaeldgodfrey@gmail.com>
parents: 17281
diff changeset
926 && $\backslash$cap && $\cap$
710b3d5fe966 improve interpreter tex Tables
Michael Godfrey <michaeldgodfrey@gmail.com>
parents: 17281
diff changeset
927 && $\backslash$cup && $\cup$ &\cr
710b3d5fe966 improve interpreter tex Tables
Michael Godfrey <michaeldgodfrey@gmail.com>
parents: 17281
diff changeset
928 & $\backslash$vee && $\vee$
710b3d5fe966 improve interpreter tex Tables
Michael Godfrey <michaeldgodfrey@gmail.com>
parents: 17281
diff changeset
929 && $\backslash$wedge && $\wedge$
710b3d5fe966 improve interpreter tex Tables
Michael Godfrey <michaeldgodfrey@gmail.com>
parents: 17281
diff changeset
930 && $\backslash$oplus && $\oplus$ &\cr
710b3d5fe966 improve interpreter tex Tables
Michael Godfrey <michaeldgodfrey@gmail.com>
parents: 17281
diff changeset
931 & $\backslash$otimes && $\otimes$
710b3d5fe966 improve interpreter tex Tables
Michael Godfrey <michaeldgodfrey@gmail.com>
parents: 17281
diff changeset
932 && $\backslash$oslash && $\oslash$
710b3d5fe966 improve interpreter tex Tables
Michael Godfrey <michaeldgodfrey@gmail.com>
parents: 17281
diff changeset
933 && && &\cr}
9672
43a07df0ed4c document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents: 9316
diff changeset
934 @end tex
43a07df0ed4c document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents: 9316
diff changeset
935 @ifnottex
17469
710b3d5fe966 improve interpreter tex Tables
Michael Godfrey <michaeldgodfrey@gmail.com>
parents: 17281
diff changeset
936 @multitable @columnfractions .25 .25 .25 .25
710b3d5fe966 improve interpreter tex Tables
Michael Godfrey <michaeldgodfrey@gmail.com>
parents: 17281
diff changeset
937 @item Greek Lowercase Letters
710b3d5fe966 improve interpreter tex Tables
Michael Godfrey <michaeldgodfrey@gmail.com>
parents: 17281
diff changeset
938 @item @tab \alpha @tab \beta @tab \gamma
710b3d5fe966 improve interpreter tex Tables
Michael Godfrey <michaeldgodfrey@gmail.com>
parents: 17281
diff changeset
939 @item @tab \delta @tab \epsilon @tab \zeta
710b3d5fe966 improve interpreter tex Tables
Michael Godfrey <michaeldgodfrey@gmail.com>
parents: 17281
diff changeset
940 @item @tab \eta @tab \theta @tab \vartheta
710b3d5fe966 improve interpreter tex Tables
Michael Godfrey <michaeldgodfrey@gmail.com>
parents: 17281
diff changeset
941 @item @tab \iota @tab \kappa @tab \lambda
710b3d5fe966 improve interpreter tex Tables
Michael Godfrey <michaeldgodfrey@gmail.com>
parents: 17281
diff changeset
942 @item @tab \mu @tab \nu @tab \xi
710b3d5fe966 improve interpreter tex Tables
Michael Godfrey <michaeldgodfrey@gmail.com>
parents: 17281
diff changeset
943 @item @tab \o @tab \pi @tab \varpi
710b3d5fe966 improve interpreter tex Tables
Michael Godfrey <michaeldgodfrey@gmail.com>
parents: 17281
diff changeset
944 @item @tab \rho @tab \sigma @tab \varsigma
710b3d5fe966 improve interpreter tex Tables
Michael Godfrey <michaeldgodfrey@gmail.com>
parents: 17281
diff changeset
945 @item @tab \tau @tab \upsilon @tab \phi
710b3d5fe966 improve interpreter tex Tables
Michael Godfrey <michaeldgodfrey@gmail.com>
parents: 17281
diff changeset
946 @item @tab \chi @tab \psi @tab \omega
710b3d5fe966 improve interpreter tex Tables
Michael Godfrey <michaeldgodfrey@gmail.com>
parents: 17281
diff changeset
947 @item Greek Uppercase Letters
710b3d5fe966 improve interpreter tex Tables
Michael Godfrey <michaeldgodfrey@gmail.com>
parents: 17281
diff changeset
948 @item @tab \Gamma @tab \Delta @tab \Theta
710b3d5fe966 improve interpreter tex Tables
Michael Godfrey <michaeldgodfrey@gmail.com>
parents: 17281
diff changeset
949 @item @tab \Lambda @tab \Xi @tab \Pi
710b3d5fe966 improve interpreter tex Tables
Michael Godfrey <michaeldgodfrey@gmail.com>
parents: 17281
diff changeset
950 @item @tab \Sigma @tab \Upsilon @tab \Phi
710b3d5fe966 improve interpreter tex Tables
Michael Godfrey <michaeldgodfrey@gmail.com>
parents: 17281
diff changeset
951 @item @tab \Psi @tab \Omega @tab
710b3d5fe966 improve interpreter tex Tables
Michael Godfrey <michaeldgodfrey@gmail.com>
parents: 17281
diff changeset
952 @item Misc Symbols Type Ord
710b3d5fe966 improve interpreter tex Tables
Michael Godfrey <michaeldgodfrey@gmail.com>
parents: 17281
diff changeset
953 @item @tab \aleph @tab \wp @tab \Re
710b3d5fe966 improve interpreter tex Tables
Michael Godfrey <michaeldgodfrey@gmail.com>
parents: 17281
diff changeset
954 @item @tab \Im @tab \partial @tab \infty
710b3d5fe966 improve interpreter tex Tables
Michael Godfrey <michaeldgodfrey@gmail.com>
parents: 17281
diff changeset
955 @item @tab \prime @tab \nabla @tab \surd
710b3d5fe966 improve interpreter tex Tables
Michael Godfrey <michaeldgodfrey@gmail.com>
parents: 17281
diff changeset
956 @item @tab \angle @tab \forall @tab \exists
710b3d5fe966 improve interpreter tex Tables
Michael Godfrey <michaeldgodfrey@gmail.com>
parents: 17281
diff changeset
957 @item @tab \neg @tab \clubsuit @tab \diamondsuit
710b3d5fe966 improve interpreter tex Tables
Michael Godfrey <michaeldgodfrey@gmail.com>
parents: 17281
diff changeset
958 @item @tab \heartsuit @tab \spadesuit @tab
710b3d5fe966 improve interpreter tex Tables
Michael Godfrey <michaeldgodfrey@gmail.com>
parents: 17281
diff changeset
959 @item ``Large'' Operators
710b3d5fe966 improve interpreter tex Tables
Michael Godfrey <michaeldgodfrey@gmail.com>
parents: 17281
diff changeset
960 @item @tab \int
710b3d5fe966 improve interpreter tex Tables
Michael Godfrey <michaeldgodfrey@gmail.com>
parents: 17281
diff changeset
961 @item Binary Operators
710b3d5fe966 improve interpreter tex Tables
Michael Godfrey <michaeldgodfrey@gmail.com>
parents: 17281
diff changeset
962 @item @tab \pm @tab \cdot @tab \times
710b3d5fe966 improve interpreter tex Tables
Michael Godfrey <michaeldgodfrey@gmail.com>
parents: 17281
diff changeset
963 @item @tab \ast @tab \circ @tab \bullet
710b3d5fe966 improve interpreter tex Tables
Michael Godfrey <michaeldgodfrey@gmail.com>
parents: 17281
diff changeset
964 @item @tab \div @tab \cap @tab \cup
710b3d5fe966 improve interpreter tex Tables
Michael Godfrey <michaeldgodfrey@gmail.com>
parents: 17281
diff changeset
965 @item @tab \vee @tab \wedge @tab \oplus
710b3d5fe966 improve interpreter tex Tables
Michael Godfrey <michaeldgodfrey@gmail.com>
parents: 17281
diff changeset
966 @item @tab \otimes @tab \oslash @tab
710b3d5fe966 improve interpreter tex Tables
Michael Godfrey <michaeldgodfrey@gmail.com>
parents: 17281
diff changeset
967 @item Relations
710b3d5fe966 improve interpreter tex Tables
Michael Godfrey <michaeldgodfrey@gmail.com>
parents: 17281
diff changeset
968 @item @tab \leq @tab \subset @tab \subseteq
710b3d5fe966 improve interpreter tex Tables
Michael Godfrey <michaeldgodfrey@gmail.com>
parents: 17281
diff changeset
969 @item @tab \in @tab \geq @tab \supset
710b3d5fe966 improve interpreter tex Tables
Michael Godfrey <michaeldgodfrey@gmail.com>
parents: 17281
diff changeset
970 @item @tab \supseteq @tab \ni @tab \mid
710b3d5fe966 improve interpreter tex Tables
Michael Godfrey <michaeldgodfrey@gmail.com>
parents: 17281
diff changeset
971 @item @tab \equiv @tab \sim @tab \approx
710b3d5fe966 improve interpreter tex Tables
Michael Godfrey <michaeldgodfrey@gmail.com>
parents: 17281
diff changeset
972 @item @tab \cong @tab \propto @tab \perp
710b3d5fe966 improve interpreter tex Tables
Michael Godfrey <michaeldgodfrey@gmail.com>
parents: 17281
diff changeset
973 @item Arrows
710b3d5fe966 improve interpreter tex Tables
Michael Godfrey <michaeldgodfrey@gmail.com>
parents: 17281
diff changeset
974 @item @tab \leftarrow @tab \Leftarrow @tab \rightarrow
710b3d5fe966 improve interpreter tex Tables
Michael Godfrey <michaeldgodfrey@gmail.com>
parents: 17281
diff changeset
975 @item @tab \Rightarrow @tab \leftrightarrow @tab \uparrow
710b3d5fe966 improve interpreter tex Tables
Michael Godfrey <michaeldgodfrey@gmail.com>
parents: 17281
diff changeset
976 @item @tab \downarrow @tab @tab
710b3d5fe966 improve interpreter tex Tables
Michael Godfrey <michaeldgodfrey@gmail.com>
parents: 17281
diff changeset
977 @item Openings and Closings
710b3d5fe966 improve interpreter tex Tables
Michael Godfrey <michaeldgodfrey@gmail.com>
parents: 17281
diff changeset
978 @item @tab \lfloor @tab \langle @tab \lceil
710b3d5fe966 improve interpreter tex Tables
Michael Godfrey <michaeldgodfrey@gmail.com>
parents: 17281
diff changeset
979 @item @tab \rfloor @tab \rangle @tab \rceil
710b3d5fe966 improve interpreter tex Tables
Michael Godfrey <michaeldgodfrey@gmail.com>
parents: 17281
diff changeset
980 @item Alternate Names
710b3d5fe966 improve interpreter tex Tables
Michael Godfrey <michaeldgodfrey@gmail.com>
parents: 17281
diff changeset
981 @item @tab \neq
710b3d5fe966 improve interpreter tex Tables
Michael Godfrey <michaeldgodfrey@gmail.com>
parents: 17281
diff changeset
982 @item Other
710b3d5fe966 improve interpreter tex Tables
Michael Godfrey <michaeldgodfrey@gmail.com>
parents: 17281
diff changeset
983 @item @tab \ldots @tab \0 @tab \copyright
710b3d5fe966 improve interpreter tex Tables
Michael Godfrey <michaeldgodfrey@gmail.com>
parents: 17281
diff changeset
984 @item @tab \deg
9672
43a07df0ed4c document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents: 9316
diff changeset
985 @end multitable
43a07df0ed4c document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents: 9316
diff changeset
986 @end ifnottex
9758
09da0bd91412 Periodic grammar check of Octave documentation files to ensure common format
Rik <rdrider0-list@yahoo.com>
parents: 9752
diff changeset
987 @caption{Available special characters in @TeX{} mode}
9672
43a07df0ed4c document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents: 9316
diff changeset
988 @end float
17469
710b3d5fe966 improve interpreter tex Tables
Michael Godfrey <michaeldgodfrey@gmail.com>
parents: 17281
diff changeset
989 @float
710b3d5fe966 improve interpreter tex Tables
Michael Godfrey <michaeldgodfrey@gmail.com>
parents: 17281
diff changeset
990 @tex
710b3d5fe966 improve interpreter tex Tables
Michael Godfrey <michaeldgodfrey@gmail.com>
parents: 17281
diff changeset
991 \vskip 6pt
17521
3670ce8da1a0 doc: improve format of table 15.1 for TeX characters.
Michael Godfrey <michaeldgodfrey@gmail.com>
parents: 17469
diff changeset
992 \newdimen\cola \cola=78pt
3670ce8da1a0 doc: improve format of table 15.1 for TeX characters.
Michael Godfrey <michaeldgodfrey@gmail.com>
parents: 17469
diff changeset
993 \newdimen\colb \colb=78pt
3670ce8da1a0 doc: improve format of table 15.1 for TeX characters.
Michael Godfrey <michaeldgodfrey@gmail.com>
parents: 17469
diff changeset
994 \newdimen\colc \colc=78pt
17469
710b3d5fe966 improve interpreter tex Tables
Michael Godfrey <michaeldgodfrey@gmail.com>
parents: 17281
diff changeset
995 \def\symtable#1#2#3{\hbox to \hsize {\hfill\vbox{\offinterlineskip \tabskip=0pt
710b3d5fe966 improve interpreter tex Tables
Michael Godfrey <michaeldgodfrey@gmail.com>
parents: 17281
diff changeset
996 \hskip36pt #1
710b3d5fe966 improve interpreter tex Tables
Michael Godfrey <michaeldgodfrey@gmail.com>
parents: 17281
diff changeset
997 \vskip6pt
710b3d5fe966 improve interpreter tex Tables
Michael Godfrey <michaeldgodfrey@gmail.com>
parents: 17281
diff changeset
998 \halign{
710b3d5fe966 improve interpreter tex Tables
Michael Godfrey <michaeldgodfrey@gmail.com>
parents: 17281
diff changeset
999 \vrule height2.0ex depth1.ex width 0.6pt #2\tabskip=0.3em &
710b3d5fe966 improve interpreter tex Tables
Michael Godfrey <michaeldgodfrey@gmail.com>
parents: 17281
diff changeset
1000 #2 \hfil & \vrule #2 & #2 \hfil & #2 \vrule &
710b3d5fe966 improve interpreter tex Tables
Michael Godfrey <michaeldgodfrey@gmail.com>
parents: 17281
diff changeset
1001 #2 \hfil & \vrule #2 & #2 \hfil & #2 \vrule &
710b3d5fe966 improve interpreter tex Tables
Michael Godfrey <michaeldgodfrey@gmail.com>
parents: 17281
diff changeset
1002 #2 \hfil & \vrule #2 & #2 \hfil & #2 \vrule
710b3d5fe966 improve interpreter tex Tables
Michael Godfrey <michaeldgodfrey@gmail.com>
parents: 17281
diff changeset
1003 width 0.6pt \tabskip=0pt\cr
710b3d5fe966 improve interpreter tex Tables
Michael Godfrey <michaeldgodfrey@gmail.com>
parents: 17281
diff changeset
1004 \noalign{\hrule height 0.6pt}
710b3d5fe966 improve interpreter tex Tables
Michael Godfrey <michaeldgodfrey@gmail.com>
parents: 17281
diff changeset
1005 & Code && Sym && Code && Sym && Code && Sym &\cr
710b3d5fe966 improve interpreter tex Tables
Michael Godfrey <michaeldgodfrey@gmail.com>
parents: 17281
diff changeset
1006 \noalign{\hrule}
710b3d5fe966 improve interpreter tex Tables
Michael Godfrey <michaeldgodfrey@gmail.com>
parents: 17281
diff changeset
1007 #3
710b3d5fe966 improve interpreter tex Tables
Michael Godfrey <michaeldgodfrey@gmail.com>
parents: 17281
diff changeset
1008 \noalign{\hrule height 0.6pt}
710b3d5fe966 improve interpreter tex Tables
Michael Godfrey <michaeldgodfrey@gmail.com>
parents: 17281
diff changeset
1009 }
710b3d5fe966 improve interpreter tex Tables
Michael Godfrey <michaeldgodfrey@gmail.com>
parents: 17281
diff changeset
1010 }\hfill}}
17521
3670ce8da1a0 doc: improve format of table 15.1 for TeX characters.
Michael Godfrey <michaeldgodfrey@gmail.com>
parents: 17469
diff changeset
1011 \hoffset72pt
3670ce8da1a0 doc: improve format of table 15.1 for TeX characters.
Michael Godfrey <michaeldgodfrey@gmail.com>
parents: 17469
diff changeset
1012 \vskip12pt
17469
710b3d5fe966 improve interpreter tex Tables
Michael Godfrey <michaeldgodfrey@gmail.com>
parents: 17281
diff changeset
1013 \symtable{Relations} {#}
17521
3670ce8da1a0 doc: improve format of table 15.1 for TeX characters.
Michael Godfrey <michaeldgodfrey@gmail.com>
parents: 17469
diff changeset
1014 {& \hbox to \cola{$\backslash$leq} && $\leq$
3670ce8da1a0 doc: improve format of table 15.1 for TeX characters.
Michael Godfrey <michaeldgodfrey@gmail.com>
parents: 17469
diff changeset
1015 && \hbox to \colb{$\backslash$subset} && $\subset$
3670ce8da1a0 doc: improve format of table 15.1 for TeX characters.
Michael Godfrey <michaeldgodfrey@gmail.com>
parents: 17469
diff changeset
1016 && \hbox to \colc{$\backslash$subseteq} && $\subseteq$ &\cr
17469
710b3d5fe966 improve interpreter tex Tables
Michael Godfrey <michaeldgodfrey@gmail.com>
parents: 17281
diff changeset
1017 & $\backslash$in && $\in$
710b3d5fe966 improve interpreter tex Tables
Michael Godfrey <michaeldgodfrey@gmail.com>
parents: 17281
diff changeset
1018 && $\backslash$geq && $\geq$
710b3d5fe966 improve interpreter tex Tables
Michael Godfrey <michaeldgodfrey@gmail.com>
parents: 17281
diff changeset
1019 && $\backslash$supset && $\supset$ &\cr
710b3d5fe966 improve interpreter tex Tables
Michael Godfrey <michaeldgodfrey@gmail.com>
parents: 17281
diff changeset
1020 & $\backslash$supseteq && $\supseteq$
710b3d5fe966 improve interpreter tex Tables
Michael Godfrey <michaeldgodfrey@gmail.com>
parents: 17281
diff changeset
1021 && $\backslash$ni && $\ni$
710b3d5fe966 improve interpreter tex Tables
Michael Godfrey <michaeldgodfrey@gmail.com>
parents: 17281
diff changeset
1022 && $\backslash$mid && $\mid$ &\cr
710b3d5fe966 improve interpreter tex Tables
Michael Godfrey <michaeldgodfrey@gmail.com>
parents: 17281
diff changeset
1023 & $\backslash$equiv && $\equiv$
710b3d5fe966 improve interpreter tex Tables
Michael Godfrey <michaeldgodfrey@gmail.com>
parents: 17281
diff changeset
1024 && $\backslash$sim && $\sim$
710b3d5fe966 improve interpreter tex Tables
Michael Godfrey <michaeldgodfrey@gmail.com>
parents: 17281
diff changeset
1025 && $\backslash$approx && $\approx$ &\cr
710b3d5fe966 improve interpreter tex Tables
Michael Godfrey <michaeldgodfrey@gmail.com>
parents: 17281
diff changeset
1026 & $\backslash$cong && $\cong$
710b3d5fe966 improve interpreter tex Tables
Michael Godfrey <michaeldgodfrey@gmail.com>
parents: 17281
diff changeset
1027 && $\backslash$propto && $\propto$
710b3d5fe966 improve interpreter tex Tables
Michael Godfrey <michaeldgodfrey@gmail.com>
parents: 17281
diff changeset
1028 && $\backslash$perp && $\perp$ &\cr}
17521
3670ce8da1a0 doc: improve format of table 15.1 for TeX characters.
Michael Godfrey <michaeldgodfrey@gmail.com>
parents: 17469
diff changeset
1029 \vskip12pt
17469
710b3d5fe966 improve interpreter tex Tables
Michael Godfrey <michaeldgodfrey@gmail.com>
parents: 17281
diff changeset
1030 \symtable{Arrows} {#}
17521
3670ce8da1a0 doc: improve format of table 15.1 for TeX characters.
Michael Godfrey <michaeldgodfrey@gmail.com>
parents: 17469
diff changeset
1031 {& \hbox to \cola{$\backslash$leftarrow} && $\leftarrow$
3670ce8da1a0 doc: improve format of table 15.1 for TeX characters.
Michael Godfrey <michaeldgodfrey@gmail.com>
parents: 17469
diff changeset
1032 && \hbox to \colb{$\backslash$Leftarrow} && $\Leftarrow$
3670ce8da1a0 doc: improve format of table 15.1 for TeX characters.
Michael Godfrey <michaeldgodfrey@gmail.com>
parents: 17469
diff changeset
1033 && \hbox to \colc{$\backslash$rightarrow} && $\rightarrow$ &\cr
17469
710b3d5fe966 improve interpreter tex Tables
Michael Godfrey <michaeldgodfrey@gmail.com>
parents: 17281
diff changeset
1034 & $\backslash$Rightarrow && $\Rightarrow$
710b3d5fe966 improve interpreter tex Tables
Michael Godfrey <michaeldgodfrey@gmail.com>
parents: 17281
diff changeset
1035 && $\backslash$leftrightarrow && $\leftrightarrow$
710b3d5fe966 improve interpreter tex Tables
Michael Godfrey <michaeldgodfrey@gmail.com>
parents: 17281
diff changeset
1036 && $\backslash$uparrow && $\uparrow$ &\cr
710b3d5fe966 improve interpreter tex Tables
Michael Godfrey <michaeldgodfrey@gmail.com>
parents: 17281
diff changeset
1037 & $\backslash$downarrow && $\downarrow$
19593
446c46af4b42 strip trailing whitespace from most source files
John W. Eaton <jwe@octave.org>
parents: 19011
diff changeset
1038 && &&
17469
710b3d5fe966 improve interpreter tex Tables
Michael Godfrey <michaeldgodfrey@gmail.com>
parents: 17281
diff changeset
1039 && && &\cr}
710b3d5fe966 improve interpreter tex Tables
Michael Godfrey <michaeldgodfrey@gmail.com>
parents: 17281
diff changeset
1040 \vskip12pt
710b3d5fe966 improve interpreter tex Tables
Michael Godfrey <michaeldgodfrey@gmail.com>
parents: 17281
diff changeset
1041 \symtable{Openings and Closings} {#}
17521
3670ce8da1a0 doc: improve format of table 15.1 for TeX characters.
Michael Godfrey <michaeldgodfrey@gmail.com>
parents: 17469
diff changeset
1042 {& \hbox to \cola{$\backslash$lfloor } && $\lfloor$
3670ce8da1a0 doc: improve format of table 15.1 for TeX characters.
Michael Godfrey <michaeldgodfrey@gmail.com>
parents: 17469
diff changeset
1043 && \hbox to \colb{$\backslash$langle } && $\langle$
3670ce8da1a0 doc: improve format of table 15.1 for TeX characters.
Michael Godfrey <michaeldgodfrey@gmail.com>
parents: 17469
diff changeset
1044 && \hbox to \colc{$\backslash$lceil } && $\lceil$ &\cr
17469
710b3d5fe966 improve interpreter tex Tables
Michael Godfrey <michaeldgodfrey@gmail.com>
parents: 17281
diff changeset
1045 & $\backslash$rfloor && $\rfloor$
710b3d5fe966 improve interpreter tex Tables
Michael Godfrey <michaeldgodfrey@gmail.com>
parents: 17281
diff changeset
1046 && $\backslash$rangle && $\rangle$
710b3d5fe966 improve interpreter tex Tables
Michael Godfrey <michaeldgodfrey@gmail.com>
parents: 17281
diff changeset
1047 && $\backslash$rceil && $\rceil$ &\cr}
710b3d5fe966 improve interpreter tex Tables
Michael Godfrey <michaeldgodfrey@gmail.com>
parents: 17281
diff changeset
1048 \vskip12pt
710b3d5fe966 improve interpreter tex Tables
Michael Godfrey <michaeldgodfrey@gmail.com>
parents: 17281
diff changeset
1049 \symtable{Alternate Names} {#}
17521
3670ce8da1a0 doc: improve format of table 15.1 for TeX characters.
Michael Godfrey <michaeldgodfrey@gmail.com>
parents: 17469
diff changeset
1050 {& \hbox to \cola{$\backslash$neq} && $\neq$
19593
446c46af4b42 strip trailing whitespace from most source files
John W. Eaton <jwe@octave.org>
parents: 19011
diff changeset
1051 && \hbox to \colb{} &&
17521
3670ce8da1a0 doc: improve format of table 15.1 for TeX characters.
Michael Godfrey <michaeldgodfrey@gmail.com>
parents: 17469
diff changeset
1052 && \hbox to \colc{} && &\cr}
17469
710b3d5fe966 improve interpreter tex Tables
Michael Godfrey <michaeldgodfrey@gmail.com>
parents: 17281
diff changeset
1053 \vskip12pt
710b3d5fe966 improve interpreter tex Tables
Michael Godfrey <michaeldgodfrey@gmail.com>
parents: 17281
diff changeset
1054 \symtable{Other (not in Appendix F Tables)} {#}
17521
3670ce8da1a0 doc: improve format of table 15.1 for TeX characters.
Michael Godfrey <michaeldgodfrey@gmail.com>
parents: 17469
diff changeset
1055 {& \hbox to \cola{$\backslash$ldots} && $\ldots$
3670ce8da1a0 doc: improve format of table 15.1 for TeX characters.
Michael Godfrey <michaeldgodfrey@gmail.com>
parents: 17469
diff changeset
1056 && \hbox to \colb{$\backslash$0} && $\oslash$
3670ce8da1a0 doc: improve format of table 15.1 for TeX characters.
Michael Godfrey <michaeldgodfrey@gmail.com>
parents: 17469
diff changeset
1057 && \hbox to \colc{$\backslash$copyright} && $\copyright$ &\cr
17524
797545fa86d0 plot.txi: fix \deg in TeX symbol table.
Michael Godfrey <michaeldgodfrey@gmail.com>
parents: 17521
diff changeset
1058 & $\backslash$deg && $^\circ$
19593
446c46af4b42 strip trailing whitespace from most source files
John W. Eaton <jwe@octave.org>
parents: 19011
diff changeset
1059 && &&
17469
710b3d5fe966 improve interpreter tex Tables
Michael Godfrey <michaeldgodfrey@gmail.com>
parents: 17281
diff changeset
1060 && && &\cr}
710b3d5fe966 improve interpreter tex Tables
Michael Godfrey <michaeldgodfrey@gmail.com>
parents: 17281
diff changeset
1061 \vskip12pt
710b3d5fe966 improve interpreter tex Tables
Michael Godfrey <michaeldgodfrey@gmail.com>
parents: 17281
diff changeset
1062 \hskip36pt Table 15.1: Available special characters in \TeX\ mode (cont.)
710b3d5fe966 improve interpreter tex Tables
Michael Godfrey <michaeldgodfrey@gmail.com>
parents: 17281
diff changeset
1063 @end tex
710b3d5fe966 improve interpreter tex Tables
Michael Godfrey <michaeldgodfrey@gmail.com>
parents: 17281
diff changeset
1064 @end float
9672
43a07df0ed4c document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents: 9316
diff changeset
1065
29470
2ae4764180c6 Initial implementation of a LaTeX interpreter (bug #59546).
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents: 29455
diff changeset
1066 @strong{Caution: Degree Symbol}
24181
379efee40924 doc: Update manual to explain \deg and \circ symbols (bug #52287).
Rik <rik@octave.org>
parents: 23219
diff changeset
1067 @cindex Degree Symbol
379efee40924 doc: Update manual to explain \deg and \circ symbols (bug #52287).
Rik <rik@octave.org>
parents: 23219
diff changeset
1068
379efee40924 doc: Update manual to explain \deg and \circ symbols (bug #52287).
Rik <rik@octave.org>
parents: 23219
diff changeset
1069 Conformance to both @TeX{} and @sc{matlab} with respect to the @code{\circ}
379efee40924 doc: Update manual to explain \deg and \circ symbols (bug #52287).
Rik <rik@octave.org>
parents: 23219
diff changeset
1070 symbol is impossible. While @TeX{} translates this symbol to @w{Unicode 2218}
379efee40924 doc: Update manual to explain \deg and \circ symbols (bug #52287).
Rik <rik@octave.org>
parents: 23219
diff changeset
1071 (U+2218), @sc{matlab} maps this to @w{Unicode 00B0} (U+00B0) instead. Octave
379efee40924 doc: Update manual to explain \deg and \circ symbols (bug #52287).
Rik <rik@octave.org>
parents: 23219
diff changeset
1072 has chosen to follow the @TeX{} specification, but has added the additional
379efee40924 doc: Update manual to explain \deg and \circ symbols (bug #52287).
Rik <rik@octave.org>
parents: 23219
diff changeset
1073 symbol @code{\deg} which maps to the degree symbol (U+00B0).
379efee40924 doc: Update manual to explain \deg and \circ symbols (bug #52287).
Rik <rik@octave.org>
parents: 23219
diff changeset
1074
31574
05a1b9a60efa doc: Avoid use of formatting Texinfo macros (e.g., @code) inside @menu, @xref macros.
Rik <rik@octave.org>
parents: 30564
diff changeset
1075 @node "latex" interpreter
05a1b9a60efa doc: Avoid use of formatting Texinfo macros (e.g., @code) inside @menu, @xref macros.
Rik <rik@octave.org>
parents: 30564
diff changeset
1076 @subsubsection "latex" interpreter
05a1b9a60efa doc: Avoid use of formatting Texinfo macros (e.g., @code) inside @menu, @xref macros.
Rik <rik@octave.org>
parents: 30564
diff changeset
1077
30355
6a6efd7bb3ec doc: grammarcheck texi files of Octave manual ahead of 7.1 release
Rik <rik@octave.org>
parents: 29670
diff changeset
1078 The @qcode{"latex"} interpreter only works if an external @LaTeX{} tool chain
6a6efd7bb3ec doc: grammarcheck texi files of Octave manual ahead of 7.1 release
Rik <rik@octave.org>
parents: 29670
diff changeset
1079 is present. Three binaries are needed: @code{latex}, @code{dvipng}, and
29470
2ae4764180c6 Initial implementation of a LaTeX interpreter (bug #59546).
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents: 29455
diff changeset
1080 @code{dvisvgm}. If those binaries are installed but not on the path, one can
2ae4764180c6 Initial implementation of a LaTeX interpreter (bug #59546).
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents: 29455
diff changeset
1081 still provide their respective path using the following environment variables:
30355
6a6efd7bb3ec doc: grammarcheck texi files of Octave manual ahead of 7.1 release
Rik <rik@octave.org>
parents: 29670
diff changeset
1082 @w{@env{OCTAVE_LATEX_BINARY}}, @w{@env{OCTAVE_DVIPNG_BINARY}}, and
6a6efd7bb3ec doc: grammarcheck texi files of Octave manual ahead of 7.1 release
Rik <rik@octave.org>
parents: 29670
diff changeset
1083 @w{@env{OCTAVE_DVISVG_BINARY}}.
29470
2ae4764180c6 Initial implementation of a LaTeX interpreter (bug #59546).
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents: 29455
diff changeset
1084
2ae4764180c6 Initial implementation of a LaTeX interpreter (bug #59546).
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents: 29455
diff changeset
1085 Note that Octave does not parse or validate the text strings when in
2ae4764180c6 Initial implementation of a LaTeX interpreter (bug #59546).
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents: 29455
diff changeset
1086 @qcode{"latex"} mode---it is the responsibility of the programmer to generate
2ae4764180c6 Initial implementation of a LaTeX interpreter (bug #59546).
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents: 29455
diff changeset
1087 valid strings which may include wrapping sections that should appear in Math
2ae4764180c6 Initial implementation of a LaTeX interpreter (bug #59546).
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents: 29455
diff changeset
1088 mode with @qcode{'$'} characters.
30355
6a6efd7bb3ec doc: grammarcheck texi files of Octave manual ahead of 7.1 release
Rik <rik@octave.org>
parents: 29670
diff changeset
1089 See, for example, @url{https://www.latex-project.org/help/documentation/} for
6a6efd7bb3ec doc: grammarcheck texi files of Octave manual ahead of 7.1 release
Rik <rik@octave.org>
parents: 29670
diff changeset
1090 documentation about @LaTeX{} typesetting.
29470
2ae4764180c6 Initial implementation of a LaTeX interpreter (bug #59546).
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents: 29455
diff changeset
1091
2ae4764180c6 Initial implementation of a LaTeX interpreter (bug #59546).
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents: 29455
diff changeset
1092 For debugging purpose, a convenience environment variable,
30355
6a6efd7bb3ec doc: grammarcheck texi files of Octave manual ahead of 7.1 release
Rik <rik@octave.org>
parents: 29670
diff changeset
1093 @w{@env{OCTAVE_LATEX_DEBUG_FLAG}}, can be set to trigger more verbose output
6a6efd7bb3ec doc: grammarcheck texi files of Octave manual ahead of 7.1 release
Rik <rik@octave.org>
parents: 29670
diff changeset
1094 when Octave fails to have a given text compiled by an external @LaTeX{} engine.
6a6efd7bb3ec doc: grammarcheck texi files of Octave manual ahead of 7.1 release
Rik <rik@octave.org>
parents: 29670
diff changeset
1095 For example, @qcode{"x^2"} is not a valid @LaTeX{} string and the following
6a6efd7bb3ec doc: grammarcheck texi files of Octave manual ahead of 7.1 release
Rik <rik@octave.org>
parents: 29670
diff changeset
1096 example should fail
29470
2ae4764180c6 Initial implementation of a LaTeX interpreter (bug #59546).
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents: 29455
diff changeset
1097
2ae4764180c6 Initial implementation of a LaTeX interpreter (bug #59546).
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents: 29455
diff changeset
1098 @example
2ae4764180c6 Initial implementation of a LaTeX interpreter (bug #59546).
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents: 29455
diff changeset
1099 @group
2ae4764180c6 Initial implementation of a LaTeX interpreter (bug #59546).
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents: 29455
diff changeset
1100 setenv ("OCTAVE_LATEX_DEBUG_FLAG", "1")
2ae4764180c6 Initial implementation of a LaTeX interpreter (bug #59546).
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents: 29455
diff changeset
1101 x = 1:10;
2ae4764180c6 Initial implementation of a LaTeX interpreter (bug #59546).
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents: 29455
diff changeset
1102 plot (x, x.^2)
2ae4764180c6 Initial implementation of a LaTeX interpreter (bug #59546).
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents: 29455
diff changeset
1103 title ("x^2", "interpreter", "latex")
2ae4764180c6 Initial implementation of a LaTeX interpreter (bug #59546).
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents: 29455
diff changeset
1104 @end group
2ae4764180c6 Initial implementation of a LaTeX interpreter (bug #59546).
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents: 29455
diff changeset
1105 @end example
2ae4764180c6 Initial implementation of a LaTeX interpreter (bug #59546).
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents: 29455
diff changeset
1106
30355
6a6efd7bb3ec doc: grammarcheck texi files of Octave manual ahead of 7.1 release
Rik <rik@octave.org>
parents: 29670
diff changeset
1107 Searching the terminal output you should find some helpful info about the
6a6efd7bb3ec doc: grammarcheck texi files of Octave manual ahead of 7.1 release
Rik <rik@octave.org>
parents: 29670
diff changeset
1108 origin of the failure:
29470
2ae4764180c6 Initial implementation of a LaTeX interpreter (bug #59546).
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents: 29455
diff changeset
1109
2ae4764180c6 Initial implementation of a LaTeX interpreter (bug #59546).
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents: 29455
diff changeset
1110 @example
2ae4764180c6 Initial implementation of a LaTeX interpreter (bug #59546).
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents: 29455
diff changeset
1111 @group
2ae4764180c6 Initial implementation of a LaTeX interpreter (bug #59546).
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents: 29455
diff changeset
1112 ...
2ae4764180c6 Initial implementation of a LaTeX interpreter (bug #59546).
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents: 29455
diff changeset
1113 No file default.aux.
2ae4764180c6 Initial implementation of a LaTeX interpreter (bug #59546).
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents: 29455
diff changeset
1114 ! Missing $ inserted.
2ae4764180c6 Initial implementation of a LaTeX interpreter (bug #59546).
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents: 29455
diff changeset
1115 <inserted text>
2ae4764180c6 Initial implementation of a LaTeX interpreter (bug #59546).
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents: 29455
diff changeset
1116 $
2ae4764180c6 Initial implementation of a LaTeX interpreter (bug #59546).
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents: 29455
diff changeset
1117 l.6 x^
2ae4764180c6 Initial implementation of a LaTeX interpreter (bug #59546).
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents: 29455
diff changeset
1118 2
2ae4764180c6 Initial implementation of a LaTeX interpreter (bug #59546).
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents: 29455
diff changeset
1119 ! Missing $ inserted.
2ae4764180c6 Initial implementation of a LaTeX interpreter (bug #59546).
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents: 29455
diff changeset
1120 ...
2ae4764180c6 Initial implementation of a LaTeX interpreter (bug #59546).
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents: 29455
diff changeset
1121 @end group
2ae4764180c6 Initial implementation of a LaTeX interpreter (bug #59546).
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents: 29455
diff changeset
1122 @end example
2ae4764180c6 Initial implementation of a LaTeX interpreter (bug #59546).
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents: 29455
diff changeset
1123
30355
6a6efd7bb3ec doc: grammarcheck texi files of Octave manual ahead of 7.1 release
Rik <rik@octave.org>
parents: 29670
diff changeset
1124 If no usable @LaTeX{} tool chain is found at the first text rendering, using
29470
2ae4764180c6 Initial implementation of a LaTeX interpreter (bug #59546).
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents: 29455
diff changeset
1125 the @qcode{"latex"} interpreter is equivalent to @qcode{"none"}.
2ae4764180c6 Initial implementation of a LaTeX interpreter (bug #59546).
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents: 29455
diff changeset
1126
11254
31f8534eb055 Add reference to new saveas function in printed manual.
Rik <octave@nomad.inbox5.com>
parents: 10846
diff changeset
1127 @node Printing and Saving Plots
31f8534eb055 Add reference to new saveas function in printed manual.
Rik <octave@nomad.inbox5.com>
parents: 10846
diff changeset
1128 @subsection Printing and Saving Plots
18330
200851c87444 Edits to Manual and indicies
Michael Godfrey <michaeldgodfrey@gmail.com>
parents: 17957
diff changeset
1129 @cindex plotting, saving and printing plots
9672
43a07df0ed4c document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents: 9316
diff changeset
1130 @cindex printing plots
11254
31f8534eb055 Add reference to new saveas function in printed manual.
Rik <octave@nomad.inbox5.com>
parents: 10846
diff changeset
1131 @cindex saving plots
6888
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
1132
14456
05635e4c605a Improve documentation for print().
Ben Abbott <bpabbott@mac.com>
parents: 14138
diff changeset
1133 The @code{print} command allows you to send plots to you printer and
05635e4c605a Improve documentation for print().
Ben Abbott <bpabbott@mac.com>
parents: 14138
diff changeset
1134 to save plots in a variety of formats. For example,
05635e4c605a Improve documentation for print().
Ben Abbott <bpabbott@mac.com>
parents: 14138
diff changeset
1135
05635e4c605a Improve documentation for print().
Ben Abbott <bpabbott@mac.com>
parents: 14138
diff changeset
1136 @example
05635e4c605a Improve documentation for print().
Ben Abbott <bpabbott@mac.com>
parents: 14138
diff changeset
1137 print -dpsc
05635e4c605a Improve documentation for print().
Ben Abbott <bpabbott@mac.com>
parents: 14138
diff changeset
1138 @end example
05635e4c605a Improve documentation for print().
Ben Abbott <bpabbott@mac.com>
parents: 14138
diff changeset
1139
05635e4c605a Improve documentation for print().
Ben Abbott <bpabbott@mac.com>
parents: 14138
diff changeset
1140 @noindent
14853
72b8b39e12be doc: Periodic grammarcheck of documentation.
Rik <octave@nomad.inbox5.com>
parents: 14577
diff changeset
1141 prints the current figure to a color PostScript printer. And,
6888
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
1142
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
1143 @example
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
1144 print -deps foo.eps
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
1145 @end example
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
1146
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
1147 @noindent
14456
05635e4c605a Improve documentation for print().
Ben Abbott <bpabbott@mac.com>
parents: 14138
diff changeset
1148 saves the current figure to an encapsulated PostScript file called
6888
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
1149 @file{foo.eps}.
6502
6ab0a8767780 [project @ 2007-04-06 03:32:06 by jwe]
jwe
parents: 6331
diff changeset
1150
23903
a08e277f985f doc: Update production of figure 15.7 (--pdflatexstandalone usage) in the manual (bug #32617).
Rik <rik@octave.org>
parents: 23565
diff changeset
1151 The current graphic toolkits produce very similar graphic displays, but differ
a08e277f985f doc: Update production of figure 15.7 (--pdflatexstandalone usage) in the manual (bug #32617).
Rik <rik@octave.org>
parents: 23565
diff changeset
1152 in their capability to display unusual text and in their ability to print
a08e277f985f doc: Update production of figure 15.7 (--pdflatexstandalone usage) in the manual (bug #32617).
Rik <rik@octave.org>
parents: 23565
diff changeset
1153 such text. In general, the @qcode{"tex"} interpreter (default) is the best
a08e277f985f doc: Update production of figure 15.7 (--pdflatexstandalone usage) in the manual (bug #32617).
Rik <rik@octave.org>
parents: 23565
diff changeset
1154 all-around performer for both on-screen display and printing. However, for the
a08e277f985f doc: Update production of figure 15.7 (--pdflatexstandalone usage) in the manual (bug #32617).
Rik <rik@octave.org>
parents: 23565
diff changeset
1155 reproduction of complicated text formulas the @qcode{"latex"} interpreter is
30355
6a6efd7bb3ec doc: grammarcheck texi files of Octave manual ahead of 7.1 release
Rik <rik@octave.org>
parents: 29670
diff changeset
1156 preferred. When printing with the @option{-painters} renderer, the default for
29470
2ae4764180c6 Initial implementation of a LaTeX interpreter (bug #59546).
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents: 29455
diff changeset
1157 all vector formats, two options may be considered:
30355
6a6efd7bb3ec doc: grammarcheck texi files of Octave manual ahead of 7.1 release
Rik <rik@octave.org>
parents: 29670
diff changeset
1158
29470
2ae4764180c6 Initial implementation of a LaTeX interpreter (bug #59546).
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents: 29455
diff changeset
1159 @itemize @bullet
2ae4764180c6 Initial implementation of a LaTeX interpreter (bug #59546).
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents: 29455
diff changeset
1160 @item
30355
6a6efd7bb3ec doc: grammarcheck texi files of Octave manual ahead of 7.1 release
Rik <rik@octave.org>
parents: 29670
diff changeset
1161 Use the @option{-svgconvert} option to allow for rendering @LaTeX{} formulas.
6a6efd7bb3ec doc: grammarcheck texi files of Octave manual ahead of 7.1 release
Rik <rik@octave.org>
parents: 29670
diff changeset
1162 Note that the glyph are rendered as path and the original textual info are
6a6efd7bb3ec doc: grammarcheck texi files of Octave manual ahead of 7.1 release
Rik <rik@octave.org>
parents: 29670
diff changeset
1163 lost.
6a6efd7bb3ec doc: grammarcheck texi files of Octave manual ahead of 7.1 release
Rik <rik@octave.org>
parents: 29670
diff changeset
1164
29470
2ae4764180c6 Initial implementation of a LaTeX interpreter (bug #59546).
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents: 29455
diff changeset
1165 @item
30355
6a6efd7bb3ec doc: grammarcheck texi files of Octave manual ahead of 7.1 release
Rik <rik@octave.org>
parents: 29670
diff changeset
1166 Use one of the @option{-d*latex*} devices to produce a .tex file (plus
6a6efd7bb3ec doc: grammarcheck texi files of Octave manual ahead of 7.1 release
Rik <rik@octave.org>
parents: 29670
diff changeset
1167 supporting .eps or .pdf files) to be further processed by an external @LaTeX{}
6a6efd7bb3ec doc: grammarcheck texi files of Octave manual ahead of 7.1 release
Rik <rik@octave.org>
parents: 29670
diff changeset
1168 engine. Note that the @code{print} function will first set the interpreter of
6a6efd7bb3ec doc: grammarcheck texi files of Octave manual ahead of 7.1 release
Rik <rik@octave.org>
parents: 29670
diff changeset
1169 all strings to @qcode{"latex"}, which means all strings must be valid @LaTeX{}
6a6efd7bb3ec doc: grammarcheck texi files of Octave manual ahead of 7.1 release
Rik <rik@octave.org>
parents: 29670
diff changeset
1170 strings.
29470
2ae4764180c6 Initial implementation of a LaTeX interpreter (bug #59546).
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents: 29455
diff changeset
1171 @end itemize
20315
b9d4ccf4291c Use FLTK for creating plots for Manual.
Michael D. Godfrey <michaeldgodfrey@gmail.com>
parents: 20287
diff changeset
1172
b9d4ccf4291c Use FLTK for creating plots for Manual.
Michael D. Godfrey <michaeldgodfrey@gmail.com>
parents: 20287
diff changeset
1173 A complete example showing the capabilities of text printing using the
21122
dba88797f69f doc: Periodic grammarcheck of documentation.
Rik <rik@octave.org>
parents: 20719
diff changeset
1174 @option{-dpdflatexstandalone} option is:
20315
b9d4ccf4291c Use FLTK for creating plots for Manual.
Michael D. Godfrey <michaeldgodfrey@gmail.com>
parents: 20287
diff changeset
1175
b9d4ccf4291c Use FLTK for creating plots for Manual.
Michael D. Godfrey <michaeldgodfrey@gmail.com>
parents: 20287
diff changeset
1176 @example
b9d4ccf4291c Use FLTK for creating plots for Manual.
Michael D. Godfrey <michaeldgodfrey@gmail.com>
parents: 20287
diff changeset
1177 @group
b9d4ccf4291c Use FLTK for creating plots for Manual.
Michael D. Godfrey <michaeldgodfrey@gmail.com>
parents: 20287
diff changeset
1178 x = 0:0.01:3;
b9d4ccf4291c Use FLTK for creating plots for Manual.
Michael D. Godfrey <michaeldgodfrey@gmail.com>
parents: 20287
diff changeset
1179 hf = figure ();
b9d4ccf4291c Use FLTK for creating plots for Manual.
Michael D. Godfrey <michaeldgodfrey@gmail.com>
parents: 20287
diff changeset
1180 plot (x, erf (x));
b9d4ccf4291c Use FLTK for creating plots for Manual.
Michael D. Godfrey <michaeldgodfrey@gmail.com>
parents: 20287
diff changeset
1181 hold on;
b9d4ccf4291c Use FLTK for creating plots for Manual.
Michael D. Godfrey <michaeldgodfrey@gmail.com>
parents: 20287
diff changeset
1182 plot (x, x, "r");
b9d4ccf4291c Use FLTK for creating plots for Manual.
Michael D. Godfrey <michaeldgodfrey@gmail.com>
parents: 20287
diff changeset
1183 axis ([0, 3, 0, 1]);
26577
ae1542fb58ba documentation: Avoid some overfull lines in the PDF manual.
Markus Mützel <markus.muetzel@gmx.de>
parents: 26376
diff changeset
1184 text (0.65, 0.6175, ...
26949
86f439ba2d47 doc: Improve example code for using -pdflatexstandalone (bug #55945).
Rik <rik@octave.org>
parents: 26878
diff changeset
1185 ['$\displaystyle\leftarrow x = @{2 \over \sqrt@{\pi@}@}' ...
26577
ae1542fb58ba documentation: Avoid some overfull lines in the PDF manual.
Markus Mützel <markus.muetzel@gmx.de>
parents: 26376
diff changeset
1186 '\int_@{0@}^@{x@} e^@{-t^2@} dt = 0.6175$'],
23903
a08e277f985f doc: Update production of figure 15.7 (--pdflatexstandalone usage) in the manual (bug #32617).
Rik <rik@octave.org>
parents: 23565
diff changeset
1187 "interpreter", "latex");
20315
b9d4ccf4291c Use FLTK for creating plots for Manual.
Michael D. Godfrey <michaeldgodfrey@gmail.com>
parents: 20287
diff changeset
1188 xlabel ("x");
b9d4ccf4291c Use FLTK for creating plots for Manual.
Michael D. Godfrey <michaeldgodfrey@gmail.com>
parents: 20287
diff changeset
1189 ylabel ("erf (x)");
b9d4ccf4291c Use FLTK for creating plots for Manual.
Michael D. Godfrey <michaeldgodfrey@gmail.com>
parents: 20287
diff changeset
1190 title ("erf (x) with text annotation");
26949
86f439ba2d47 doc: Improve example code for using -pdflatexstandalone (bug #55945).
Rik <rik@octave.org>
parents: 26878
diff changeset
1191 print (hf, "plot15_7", "-dpdflatexstandalone");
20315
b9d4ccf4291c Use FLTK for creating plots for Manual.
Michael D. Godfrey <michaeldgodfrey@gmail.com>
parents: 20287
diff changeset
1192 system ("pdflatex plot15_7");
23903
a08e277f985f doc: Update production of figure 15.7 (--pdflatexstandalone usage) in the manual (bug #32617).
Rik <rik@octave.org>
parents: 23565
diff changeset
1193 open plot15_7.pdf
20315
b9d4ccf4291c Use FLTK for creating plots for Manual.
Michael D. Godfrey <michaeldgodfrey@gmail.com>
parents: 20287
diff changeset
1194 @end group
b9d4ccf4291c Use FLTK for creating plots for Manual.
Michael D. Godfrey <michaeldgodfrey@gmail.com>
parents: 20287
diff changeset
1195 @end example
b9d4ccf4291c Use FLTK for creating plots for Manual.
Michael D. Godfrey <michaeldgodfrey@gmail.com>
parents: 20287
diff changeset
1196
b9d4ccf4291c Use FLTK for creating plots for Manual.
Michael D. Godfrey <michaeldgodfrey@gmail.com>
parents: 20287
diff changeset
1197 @ifnotinfo
b9d4ccf4291c Use FLTK for creating plots for Manual.
Michael D. Godfrey <michaeldgodfrey@gmail.com>
parents: 20287
diff changeset
1198 @noindent
20322
03c88436ad8c Correctly generate figure 15.7 of the Manual.
Rik <rik@octave.org>
parents: 20315
diff changeset
1199 The result of this example can be seen in @ref{fig:extendedtext}
20315
b9d4ccf4291c Use FLTK for creating plots for Manual.
Michael D. Godfrey <michaeldgodfrey@gmail.com>
parents: 20287
diff changeset
1200
b9d4ccf4291c Use FLTK for creating plots for Manual.
Michael D. Godfrey <michaeldgodfrey@gmail.com>
parents: 20287
diff changeset
1201 @float Figure,fig:extendedtext
b9d4ccf4291c Use FLTK for creating plots for Manual.
Michael D. Godfrey <michaeldgodfrey@gmail.com>
parents: 20287
diff changeset
1202 @center @image{extended,4in}
21122
dba88797f69f doc: Periodic grammarcheck of documentation.
Rik <rik@octave.org>
parents: 20719
diff changeset
1203 @caption{Example of inclusion of text with use of @option{-dpdflatexstandalone}}
20315
b9d4ccf4291c Use FLTK for creating plots for Manual.
Michael D. Godfrey <michaeldgodfrey@gmail.com>
parents: 20287
diff changeset
1204 @end float
b9d4ccf4291c Use FLTK for creating plots for Manual.
Michael D. Godfrey <michaeldgodfrey@gmail.com>
parents: 20287
diff changeset
1205 @end ifnotinfo
19011
c4ffcc961f3c Document that "tex" interpreter only works with gnuplot for printing (bug #42340).
Rik <rik@octave.org>
parents: 18844
diff changeset
1206
6502
6ab0a8767780 [project @ 2007-04-06 03:32:06 by jwe]
jwe
parents: 6331
diff changeset
1207 @DOCSTRING(print)
6ab0a8767780 [project @ 2007-04-06 03:32:06 by jwe]
jwe
parents: 6331
diff changeset
1208
11254
31f8534eb055 Add reference to new saveas function in printed manual.
Rik <octave@nomad.inbox5.com>
parents: 10846
diff changeset
1209 @DOCSTRING(saveas)
31f8534eb055 Add reference to new saveas function in printed manual.
Rik <octave@nomad.inbox5.com>
parents: 10846
diff changeset
1210
6502
6ab0a8767780 [project @ 2007-04-06 03:32:06 by jwe]
jwe
parents: 6331
diff changeset
1211 @DOCSTRING(orient)
5134
0309b6722ee9 [project @ 2005-02-08 20:17:55 by jwe]
jwe
parents: 5016
diff changeset
1212
18580
13c80c3e9660 Add new functions hgsave and hgload (bug #39532).
Massimiliano Fasi <mogrob.sanit@gmail.com> and Rik <rik@octave.org>
parents: 18487
diff changeset
1213 @code{print} and @code{saveas} are used when work on a plot has finished
13c80c3e9660 Add new functions hgsave and hgload (bug #39532).
Massimiliano Fasi <mogrob.sanit@gmail.com> and Rik <rik@octave.org>
parents: 18487
diff changeset
1214 and the output must be in a publication-ready format. During intermediate
13c80c3e9660 Add new functions hgsave and hgload (bug #39532).
Massimiliano Fasi <mogrob.sanit@gmail.com> and Rik <rik@octave.org>
parents: 18487
diff changeset
1215 stages it is often better to save the graphics object and all of its
13c80c3e9660 Add new functions hgsave and hgload (bug #39532).
Massimiliano Fasi <mogrob.sanit@gmail.com> and Rik <rik@octave.org>
parents: 18487
diff changeset
1216 associated information so that changes---to colors, axis limits, marker styles,
13c80c3e9660 Add new functions hgsave and hgload (bug #39532).
Massimiliano Fasi <mogrob.sanit@gmail.com> and Rik <rik@octave.org>
parents: 18487
diff changeset
1217 etc.---can be made easily from within Octave. The @code{hgsave}/@code{hgload}
13c80c3e9660 Add new functions hgsave and hgload (bug #39532).
Massimiliano Fasi <mogrob.sanit@gmail.com> and Rik <rik@octave.org>
parents: 18487
diff changeset
1218 commands can be used to save and re-create a graphics object.
13c80c3e9660 Add new functions hgsave and hgload (bug #39532).
Massimiliano Fasi <mogrob.sanit@gmail.com> and Rik <rik@octave.org>
parents: 18487
diff changeset
1219
13c80c3e9660 Add new functions hgsave and hgload (bug #39532).
Massimiliano Fasi <mogrob.sanit@gmail.com> and Rik <rik@octave.org>
parents: 18487
diff changeset
1220 @DOCSTRING(hgsave)
13c80c3e9660 Add new functions hgsave and hgload (bug #39532).
Massimiliano Fasi <mogrob.sanit@gmail.com> and Rik <rik@octave.org>
parents: 18487
diff changeset
1221
13c80c3e9660 Add new functions hgsave and hgload (bug #39532).
Massimiliano Fasi <mogrob.sanit@gmail.com> and Rik <rik@octave.org>
parents: 18487
diff changeset
1222 @DOCSTRING(hgload)
13c80c3e9660 Add new functions hgsave and hgload (bug #39532).
Massimiliano Fasi <mogrob.sanit@gmail.com> and Rik <rik@octave.org>
parents: 18487
diff changeset
1223
25973
c9ae077dedd1 New function openfig.m (bug #44670)
Guillaume Flandin <guillaume.offline@gmail.com>
parents: 25971
diff changeset
1224 @DOCSTRING(openfig)
c9ae077dedd1 New function openfig.m (bug #44670)
Guillaume Flandin <guillaume.offline@gmail.com>
parents: 25971
diff changeset
1225
25971
456523d3cb4a savefig: new function
Guillaume Flandin <guillaume.offline@gmail.com>
parents: 25946
diff changeset
1226 @DOCSTRING(savefig)
456523d3cb4a savefig: new function
Guillaume Flandin <guillaume.offline@gmail.com>
parents: 25946
diff changeset
1227
11254
31f8534eb055 Add reference to new saveas function in printed manual.
Rik <octave@nomad.inbox5.com>
parents: 10846
diff changeset
1228 @node Interacting with Plots
31f8534eb055 Add reference to new saveas function in printed manual.
Rik <octave@nomad.inbox5.com>
parents: 10846
diff changeset
1229 @subsection Interacting with Plots
7984
bbaa5d7d0143 Some documentation updates
David Bateman <dbateman@free.fr>
parents: 7981
diff changeset
1230
bbaa5d7d0143 Some documentation updates
David Bateman <dbateman@free.fr>
parents: 7981
diff changeset
1231 The user can select points on a plot with the @code{ginput} function or
20593
3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents: 20381
diff changeset
1232 select the position at which to place text on the plot with the
20715
5b7643257978 Remove trailing whitespace at end of lines.
Rik <rik@octave.org>
parents: 20593
diff changeset
1233 @code{gtext} function using the mouse.
7984
bbaa5d7d0143 Some documentation updates
David Bateman <dbateman@free.fr>
parents: 7981
diff changeset
1234
bbaa5d7d0143 Some documentation updates
David Bateman <dbateman@free.fr>
parents: 7981
diff changeset
1235 @DOCSTRING(ginput)
bbaa5d7d0143 Some documentation updates
David Bateman <dbateman@free.fr>
parents: 7981
diff changeset
1236
bbaa5d7d0143 Some documentation updates
David Bateman <dbateman@free.fr>
parents: 7981
diff changeset
1237 @DOCSTRING(waitforbuttonpress)
bbaa5d7d0143 Some documentation updates
David Bateman <dbateman@free.fr>
parents: 7981
diff changeset
1238
bbaa5d7d0143 Some documentation updates
David Bateman <dbateman@free.fr>
parents: 7981
diff changeset
1239 @DOCSTRING(gtext)
bbaa5d7d0143 Some documentation updates
David Bateman <dbateman@free.fr>
parents: 7981
diff changeset
1240
20719
d903cccb8de8 doc: Periodic spellcheck of documentation.
Rik <rik@octave.org>
parents: 20715
diff changeset
1241 More sophisticated user interaction mechanisms can be obtained using the
d903cccb8de8 doc: Periodic spellcheck of documentation.
Rik <rik@octave.org>
parents: 20715
diff changeset
1242 @nospell{ui*} family of functions, @pxref{UI Elements}.
12522
33bbae85769a Add uimenu, uigetdir, uigetfile, and uiputfile to documentation.
Rik <octave@nomad.inbox5.com>
parents: 12226
diff changeset
1243
6788
c81a0f3f5a82 [project @ 2007-07-23 22:05:29 by dbateman]
dbateman
parents: 6778
diff changeset
1244 @node Test Plotting Functions
6888
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
1245 @subsection Test Plotting Functions
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
1246
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
1247 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
1248 that plotting is working. Typing either @code{sombrero} or @code{peaks}
9209
923c7cb7f13f Simplify TeXinfo files by eliminating redundant @iftex followed by @tex construction.
Rik <rdrider0-list@yahoo.com>
parents: 9088
diff changeset
1249 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
1250
6877
ab11bdb09820 [project @ 2007-09-07 05:12:32 by jwe]
jwe
parents: 6788
diff changeset
1251 @DOCSTRING(sombrero)
ab11bdb09820 [project @ 2007-09-07 05:12:32 by jwe]
jwe
parents: 6788
diff changeset
1252
6788
c81a0f3f5a82 [project @ 2007-07-23 22:05:29 by dbateman]
dbateman
parents: 6778
diff changeset
1253 @DOCSTRING(peaks)
9672
43a07df0ed4c document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents: 9316
diff changeset
1254 @node Graphics Data Structures
43a07df0ed4c document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents: 9316
diff changeset
1255 @section Graphics Data Structures
43a07df0ed4c document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents: 9316
diff changeset
1256 @cindex graphics data structures
6888
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
1257
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
1258 @menu
17152
f2a8592b8fbd doc: Shorten some long subsection names in Manual.
Rik <rik@octave.org>
parents: 17123
diff changeset
1259 * Introduction to Graphics Structures::
f2a8592b8fbd doc: Shorten some long subsection names in Manual.
Rik <rik@octave.org>
parents: 17123
diff changeset
1260 * Graphics Objects::
f2a8592b8fbd doc: Shorten some long subsection names in Manual.
Rik <rik@octave.org>
parents: 17123
diff changeset
1261 * Graphics Object Properties::
f2a8592b8fbd doc: Shorten some long subsection names in Manual.
Rik <rik@octave.org>
parents: 17123
diff changeset
1262 * Searching Properties::
f2a8592b8fbd doc: Shorten some long subsection names in Manual.
Rik <rik@octave.org>
parents: 17123
diff changeset
1263 * Managing Default Properties::
6888
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
1264 @end menu
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
1265
9672
43a07df0ed4c document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents: 9316
diff changeset
1266 @node Introduction to Graphics Structures
43a07df0ed4c document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents: 9316
diff changeset
1267 @subsection Introduction to Graphics Structures
43a07df0ed4c document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents: 9316
diff changeset
1268 @cindex introduction to graphics structures
43a07df0ed4c document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents: 9316
diff changeset
1269
10846
a4f482e66b65 Grammarcheck more of the documentation.
Rik <octave@nomad.inbox5.com>
parents: 10828
diff changeset
1270 The graphics functions use pointers, which are of class graphics_handle, in
19460
78c0241306b5 Add documentation about when to use newplot (bug #40289).
Rik <rik@octave.org>
parents: 19405
diff changeset
1271 order to address the data structures which control visual display. A
78c0241306b5 Add documentation about when to use newplot (bug #40289).
Rik <rik@octave.org>
parents: 19405
diff changeset
1272 graphics handle may point to any one of a number of different base object
28286
496735a910c1 Add graphics object "scatter" (bug #58282).
Markus Mützel <markus.muetzel@gmx.de>
parents: 28136
diff changeset
1273 types. These objects are the graphics data structures themselves. The
19460
78c0241306b5 Add documentation about when to use newplot (bug #40289).
Rik <rik@octave.org>
parents: 19405
diff changeset
1274 primitive graphic object types are: @code{figure}, @code{axes}, @code{line},
28286
496735a910c1 Add graphics object "scatter" (bug #58282).
Markus Mützel <markus.muetzel@gmx.de>
parents: 28136
diff changeset
1275 @code{text}, @code{patch}, @code{scatter}, @code{surface}, @code{text},
496735a910c1 Add graphics object "scatter" (bug #58282).
Markus Mützel <markus.muetzel@gmx.de>
parents: 28136
diff changeset
1276 @code{image}, and @code{light}.
496735a910c1 Add graphics object "scatter" (bug #58282).
Markus Mützel <markus.muetzel@gmx.de>
parents: 28136
diff changeset
1277
496735a910c1 Add graphics object "scatter" (bug #58282).
Markus Mützel <markus.muetzel@gmx.de>
parents: 28136
diff changeset
1278 Each of these objects has a function by the same name, and each of these
19460
78c0241306b5 Add documentation about when to use newplot (bug #40289).
Rik <rik@octave.org>
parents: 19405
diff changeset
1279 functions returns a graphics handle pointing to an object of the corresponding
28286
496735a910c1 Add graphics object "scatter" (bug #58282).
Markus Mützel <markus.muetzel@gmx.de>
parents: 28136
diff changeset
1280 type.
496735a910c1 Add graphics object "scatter" (bug #58282).
Markus Mützel <markus.muetzel@gmx.de>
parents: 28136
diff changeset
1281
496735a910c1 Add graphics object "scatter" (bug #58282).
Markus Mützel <markus.muetzel@gmx.de>
parents: 28136
diff changeset
1282 In addition, there are several functions which operate on properties of the
496735a910c1 Add graphics object "scatter" (bug #58282).
Markus Mützel <markus.muetzel@gmx.de>
parents: 28136
diff changeset
1283 graphics objects and which also return handles. This includes but is not
28753
e82484e1b2f6 doc: grammarcheck documentation.
Rik <rik@octave.org>
parents: 28735
diff changeset
1284 limited to the following functions: The functions @code{plot} and @code{plot3}
28286
496735a910c1 Add graphics object "scatter" (bug #58282).
Markus Mützel <markus.muetzel@gmx.de>
parents: 28136
diff changeset
1285 return a handle pointing to an object of type @code{line}. The function
496735a910c1 Add graphics object "scatter" (bug #58282).
Markus Mützel <markus.muetzel@gmx.de>
parents: 28136
diff changeset
1286 @code{subplot} returns a handle pointing to an object of type @code{axes}.
29395
4d747b196935 fill3.m: Add new function.
Markus Mützel <markus.muetzel@gmx.de>
parents: 29122
diff changeset
1287 The functions @code{fill}, @code{fill3}, @code{trimesh}, and @code{trisurf}
4d747b196935 fill3.m: Add new function.
Markus Mützel <markus.muetzel@gmx.de>
parents: 29122
diff changeset
1288 return a handle pointing to an object of type patch. The function
4d747b196935 fill3.m: Add new function.
Markus Mützel <markus.muetzel@gmx.de>
parents: 29122
diff changeset
1289 @code{scatter3} returns a handle to an object of type scatter. The functions
4d747b196935 fill3.m: Add new function.
Markus Mützel <markus.muetzel@gmx.de>
parents: 29122
diff changeset
1290 @code{slice}, @code{surf}, @code{surfl}, @code{mesh}, @code{meshz},
4d747b196935 fill3.m: Add new function.
Markus Mützel <markus.muetzel@gmx.de>
parents: 29122
diff changeset
1291 @code{pcolor}, and @code{waterfall} each return a handle of type surface. The
4d747b196935 fill3.m: Add new function.
Markus Mützel <markus.muetzel@gmx.de>
parents: 29122
diff changeset
1292 function @code{camlight} returns a handle to an object of type light. The
4d747b196935 fill3.m: Add new function.
Markus Mützel <markus.muetzel@gmx.de>
parents: 29122
diff changeset
1293 functions @code{area}, @code{bar}, @code{barh}, @code{contour},
4d747b196935 fill3.m: Add new function.
Markus Mützel <markus.muetzel@gmx.de>
parents: 29122
diff changeset
1294 @code{contourf}, @code{contour3}, @code{surfc}, @code{meshc}, @code{errorbar},
4d747b196935 fill3.m: Add new function.
Markus Mützel <markus.muetzel@gmx.de>
parents: 29122
diff changeset
1295 @code{quiver}, @code{quiver3}, @code{stair}, @code{stem}, @code{stem3} each
4d747b196935 fill3.m: Add new function.
Markus Mützel <markus.muetzel@gmx.de>
parents: 29122
diff changeset
1296 return a handle to a complex data structure as documented in
31574
05a1b9a60efa doc: Avoid use of formatting Texinfo macros (e.g., @code) inside @menu, @xref macros.
Rik <rik@octave.org>
parents: 30564
diff changeset
1297 @ref{Data Sources in Object Groups,,Data Sources}.
9672
43a07df0ed4c document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents: 9316
diff changeset
1298
43a07df0ed4c document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents: 9316
diff changeset
1299 The graphics objects are arranged in a hierarchy:
43a07df0ed4c document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents: 9316
diff changeset
1300
24462
8ff3c13d14c1 groot.m: New function to return handle of graphics root object.
Rik <rik@octave.org>
parents: 24423
diff changeset
1301 1. The root object is returned by @code{groot} (historically, equivalent to
8ff3c13d14c1 groot.m: New function to return handle of graphics root object.
Rik <rik@octave.org>
parents: 24423
diff changeset
1302 the handle 0). In other words, @code{get (groot)} returns the properties of
19460
78c0241306b5 Add documentation about when to use newplot (bug #40289).
Rik <rik@octave.org>
parents: 19405
diff changeset
1303 the root object.
9672
43a07df0ed4c document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents: 9316
diff changeset
1304
43a07df0ed4c document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents: 9316
diff changeset
1305 2. Below the root are @code{figure} objects.
43a07df0ed4c document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents: 9316
diff changeset
1306
24462
8ff3c13d14c1 groot.m: New function to return handle of graphics root object.
Rik <rik@octave.org>
parents: 24423
diff changeset
1307 3. Below the @code{figure} objects are @code{axes} or @code{hggroup} objects.
19460
78c0241306b5 Add documentation about when to use newplot (bug #40289).
Rik <rik@octave.org>
parents: 19405
diff changeset
1308
28286
496735a910c1 Add graphics object "scatter" (bug #58282).
Markus Mützel <markus.muetzel@gmx.de>
parents: 28136
diff changeset
1309 4. Below the @code{axes} or @code{hggroup} objects are @code{line},
496735a910c1 Add graphics object "scatter" (bug #58282).
Markus Mützel <markus.muetzel@gmx.de>
parents: 28136
diff changeset
1310 @code{text}, @code{patch}, @code{scatter}, @code{surface}, @code{image}, and
496735a910c1 Add graphics object "scatter" (bug #58282).
Markus Mützel <markus.muetzel@gmx.de>
parents: 28136
diff changeset
1311 @code{light} objects.
496735a910c1 Add graphics object "scatter" (bug #58282).
Markus Mützel <markus.muetzel@gmx.de>
parents: 28136
diff changeset
1312
496735a910c1 Add graphics object "scatter" (bug #58282).
Markus Mützel <markus.muetzel@gmx.de>
parents: 28136
diff changeset
1313 It is possible to walk this hierarchical tree by querying the @qcode{"parent"}
496735a910c1 Add graphics object "scatter" (bug #58282).
Markus Mützel <markus.muetzel@gmx.de>
parents: 28136
diff changeset
1314 and @qcode{"children"} properties of the graphics objects.
9672
43a07df0ed4c document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents: 9316
diff changeset
1315
16814
64e7bb01fce2 doc: Improve documentation for 2-D plot functions
Rik <rik@octave.org>
parents: 16813
diff changeset
1316 Graphics handles may be distinguished from function handles
24423
1d52db450db4 Change ishandle to return true for Java objects for Matlab compatibility.
Rik <rik@octave.org>
parents: 24208
diff changeset
1317 (@pxref{Function Handles}) by means of the function @code{ishghandle}.
24626
58dd3c2d5db8 Document and fix "busyaction" an "interruptible" properties (bug #52804).
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents: 24576
diff changeset
1318 @code{ishghandle} returns true if its argument is a handle of a graphics
58dd3c2d5db8 Document and fix "busyaction" an "interruptible" properties (bug #52804).
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents: 24576
diff changeset
1319 object. In addition, a figure or axes object may be tested using
58dd3c2d5db8 Document and fix "busyaction" an "interruptible" properties (bug #52804).
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents: 24576
diff changeset
1320 @code{isfigure} or @code{isaxes} respectively. To test for a specific type of
58dd3c2d5db8 Document and fix "busyaction" an "interruptible" properties (bug #52804).
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents: 24576
diff changeset
1321 graphics handle, such as a patch or line object, use @code{isgraphics}. The
58dd3c2d5db8 Document and fix "busyaction" an "interruptible" properties (bug #52804).
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents: 24576
diff changeset
1322 more specific test functions return true only if the argument is both a
58dd3c2d5db8 Document and fix "busyaction" an "interruptible" properties (bug #52804).
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents: 24576
diff changeset
1323 graphics handle and of the correct type (figure, axes, specified object type).
19460
78c0241306b5 Add documentation about when to use newplot (bug #40289).
Rik <rik@octave.org>
parents: 19405
diff changeset
1324
16814
64e7bb01fce2 doc: Improve documentation for 2-D plot functions
Rik <rik@octave.org>
parents: 16813
diff changeset
1325 The @code{get} and @code{set} commands are used to obtain and set the values of
64e7bb01fce2 doc: Improve documentation for 2-D plot functions
Rik <rik@octave.org>
parents: 16813
diff changeset
1326 properties of graphics objects. In addition, the @code{get} command may be
64e7bb01fce2 doc: Improve documentation for 2-D plot functions
Rik <rik@octave.org>
parents: 16813
diff changeset
1327 used to obtain property names.
10828
322f43e0e170 Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents: 10711
diff changeset
1328
17281
bc924baa2c4e doc: Add new @qcode macro for code samples which are quoted.
Rik <rik@octave.org>
parents: 17170
diff changeset
1329 For example, the property @qcode{"type"} of the graphics object pointed to by
bc924baa2c4e doc: Add new @qcode macro for code samples which are quoted.
Rik <rik@octave.org>
parents: 17170
diff changeset
1330 the graphics handle h may be displayed by:
9672
43a07df0ed4c document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents: 9316
diff changeset
1331
11444
08f8b0d96091 doc fixes
John W. Eaton <jwe@octave.org>
parents: 11382
diff changeset
1332 @example
08f8b0d96091 doc fixes
John W. Eaton <jwe@octave.org>
parents: 11382
diff changeset
1333 get (h, "type")
08f8b0d96091 doc fixes
John W. Eaton <jwe@octave.org>
parents: 11382
diff changeset
1334 @end example
08f8b0d96091 doc fixes
John W. Eaton <jwe@octave.org>
parents: 11382
diff changeset
1335
25857
c3c9c8533a86 Document that high level graphics functions redefine axes properties (bug #49400).
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents: 25585
diff changeset
1336 The properties and their current values may be obtained in the form of a
c3c9c8533a86 Document that high level graphics functions redefine axes properties (bug #49400).
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents: 25585
diff changeset
1337 structure using @code{s = get (h)}, where @code{h} is the handle of a graphics
c3c9c8533a86 Document that high level graphics functions redefine axes properties (bug #49400).
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents: 25585
diff changeset
1338 object. If only the names of the properties and the allowed values (for radio
c3c9c8533a86 Document that high level graphics functions redefine axes properties (bug #49400).
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents: 25585
diff changeset
1339 properties only) are wanted, one may use @code{set (h)}.
9672
43a07df0ed4c document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents: 9316
diff changeset
1340
17281
bc924baa2c4e doc: Add new @qcode macro for code samples which are quoted.
Rik <rik@octave.org>
parents: 17170
diff changeset
1341 Thus, for example:
11573
6f8ffe2c6f76 Grammarcheck txi files for 3.4 release.
Rik <octave@nomad.inbox5.com>
parents: 11523
diff changeset
1342
25857
c3c9c8533a86 Document that high level graphics functions redefine axes properties (bug #49400).
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents: 25585
diff changeset
1343 @example
11444
08f8b0d96091 doc fixes
John W. Eaton <jwe@octave.org>
parents: 11382
diff changeset
1344 h = figure ();
08f8b0d96091 doc fixes
John W. Eaton <jwe@octave.org>
parents: 11382
diff changeset
1345 get (h, "type")
25857
c3c9c8533a86 Document that high level graphics functions redefine axes properties (bug #49400).
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents: 25585
diff changeset
1346 @result{} ans = figure
c3c9c8533a86 Document that high level graphics functions redefine axes properties (bug #49400).
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents: 25585
diff changeset
1347 set (h)
c3c9c8533a86 Document that high level graphics functions redefine axes properties (bug #49400).
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents: 25585
diff changeset
1348 @result{}
c3c9c8533a86 Document that high level graphics functions redefine axes properties (bug #49400).
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents: 25585
diff changeset
1349 alphamap:
c3c9c8533a86 Document that high level graphics functions redefine axes properties (bug #49400).
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents: 25585
diff changeset
1350 beingdeleted: [ @{off@} | on ]
c3c9c8533a86 Document that high level graphics functions redefine axes properties (bug #49400).
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents: 25585
diff changeset
1351 busyaction: [ cancel | @{queue@} ]
c3c9c8533a86 Document that high level graphics functions redefine axes properties (bug #49400).
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents: 25585
diff changeset
1352 buttondownfcn:
c3c9c8533a86 Document that high level graphics functions redefine axes properties (bug #49400).
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents: 25585
diff changeset
1353 clipping: [ off | @{on@} ]
c3c9c8533a86 Document that high level graphics functions redefine axes properties (bug #49400).
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents: 25585
diff changeset
1354 closerequestfcn:
c3c9c8533a86 Document that high level graphics functions redefine axes properties (bug #49400).
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents: 25585
diff changeset
1355 color:
c3c9c8533a86 Document that high level graphics functions redefine axes properties (bug #49400).
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents: 25585
diff changeset
1356 colormap:
c3c9c8533a86 Document that high level graphics functions redefine axes properties (bug #49400).
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents: 25585
diff changeset
1357 createfcn:
c3c9c8533a86 Document that high level graphics functions redefine axes properties (bug #49400).
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents: 25585
diff changeset
1358 currentaxes:
c3c9c8533a86 Document that high level graphics functions redefine axes properties (bug #49400).
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents: 25585
diff changeset
1359 deletefcn:
c3c9c8533a86 Document that high level graphics functions redefine axes properties (bug #49400).
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents: 25585
diff changeset
1360 dockcontrols: [ @{off@} | on ]
c3c9c8533a86 Document that high level graphics functions redefine axes properties (bug #49400).
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents: 25585
diff changeset
1361 filename:
c3c9c8533a86 Document that high level graphics functions redefine axes properties (bug #49400).
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents: 25585
diff changeset
1362 graphicssmoothing: [ off | @{on@} ]
c3c9c8533a86 Document that high level graphics functions redefine axes properties (bug #49400).
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents: 25585
diff changeset
1363 handlevisibility: [ callback | off | @{on@} ]
c3c9c8533a86 Document that high level graphics functions redefine axes properties (bug #49400).
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents: 25585
diff changeset
1364 ...
c3c9c8533a86 Document that high level graphics functions redefine axes properties (bug #49400).
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents: 25585
diff changeset
1365 @end example
11444
08f8b0d96091 doc fixes
John W. Eaton <jwe@octave.org>
parents: 11382
diff changeset
1366
08f8b0d96091 doc fixes
John W. Eaton <jwe@octave.org>
parents: 11382
diff changeset
1367 The uses of @code{get} and @code{set} are further explained in
17097
e7a059a9a644 doc: Use XREF as anchor prefix in documentation for clearer results in Info viewer.
Rik <rik@octave.org>
parents: 16923
diff changeset
1368 @ref{XREFget,,get}, @ref{XREFset,,set}.
9672
43a07df0ed4c document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents: 9316
diff changeset
1369
11380
5dfb6aab3513 document isprop
John W. Eaton <jwe@octave.org>
parents: 11365
diff changeset
1370 @DOCSTRING(isprop)
5dfb6aab3513 document isprop
John W. Eaton <jwe@octave.org>
parents: 11365
diff changeset
1371
6888
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
1372 @node Graphics Objects
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
1373 @subsection Graphics Objects
9672
43a07df0ed4c document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents: 9316
diff changeset
1374 @cindex graphics objects
43a07df0ed4c document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents: 9316
diff changeset
1375
17097
e7a059a9a644 doc: Use XREF as anchor prefix in documentation for clearer results in Info viewer.
Rik <rik@octave.org>
parents: 16923
diff changeset
1376 The hierarchy of graphics objects was explained above.
e7a059a9a644 doc: Use XREF as anchor prefix in documentation for clearer results in Info viewer.
Rik <rik@octave.org>
parents: 16923
diff changeset
1377 @xref{Introduction to Graphics Structures}. Here the
9672
43a07df0ed4c document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents: 9316
diff changeset
1378 specific objects are described, and the properties contained in
9758
09da0bd91412 Periodic grammar check of Octave documentation files to ensure common format
Rik <rdrider0-list@yahoo.com>
parents: 9752
diff changeset
1379 these objects are discussed. Keep in mind that
9672
43a07df0ed4c document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents: 9316
diff changeset
1380 graphics objects are always referenced by @dfn{handle}.
6888
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
1381
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
1382 @table @asis
9672
43a07df0ed4c document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents: 9316
diff changeset
1383 @c @group
10846
a4f482e66b65 Grammarcheck more of the documentation.
Rik <octave@nomad.inbox5.com>
parents: 10828
diff changeset
1384
26878
3c7c5b7c3044 doc: Refer to "root object" rather than "root figure object".
Rik <rik@octave.org>
parents: 26877
diff changeset
1385 @item root
3c7c5b7c3044 doc: Refer to "root object" rather than "root figure object".
Rik <rik@octave.org>
parents: 26877
diff changeset
1386 @cindex root graphics object
3c7c5b7c3044 doc: Refer to "root object" rather than "root figure object".
Rik <rik@octave.org>
parents: 26877
diff changeset
1387 @cindex graphics object, root
24462
8ff3c13d14c1 groot.m: New function to return handle of graphics root object.
Rik <rik@octave.org>
parents: 24423
diff changeset
1388 The top level of the hierarchy and the parent of all figure objects.
8ff3c13d14c1 groot.m: New function to return handle of graphics root object.
Rik <rik@octave.org>
parents: 24423
diff changeset
1389 Use @code{groot} to obtain the handle of the root graphics object.
6888
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
1390
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
1391 @item figure
8071
b6e85fb238c1 doc fixes
John W. Eaton <jwe@octave.org>
parents: 8070
diff changeset
1392 @cindex figure graphics object
b6e85fb238c1 doc fixes
John W. Eaton <jwe@octave.org>
parents: 8070
diff changeset
1393 @cindex graphics object, figure
6888
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
1394 A figure window.
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
1395
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
1396 @item axes
8071
b6e85fb238c1 doc fixes
John W. Eaton <jwe@octave.org>
parents: 8070
diff changeset
1397 @cindex axes graphics object
b6e85fb238c1 doc fixes
John W. Eaton <jwe@octave.org>
parents: 8070
diff changeset
1398 @cindex graphics object, axes
9316
c539ec5726e7 Update some of Advanced Plotting documentation.
Rik <rdrider0-list@yahoo.com>
parents: 9209
diff changeset
1399 A set of axes. This object is a child of a figure object and may be a
21789
6afdf40be534 Implement graphics object "light" (patch #8943).
mmuetzel <markus.muetzel@gmx.de>
parents: 21771
diff changeset
1400 parent of line, text, image, patch, surface, or light objects.
6888
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
1401
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
1402 @item line
8071
b6e85fb238c1 doc fixes
John W. Eaton <jwe@octave.org>
parents: 8070
diff changeset
1403 @cindex line graphics object
b6e85fb238c1 doc fixes
John W. Eaton <jwe@octave.org>
parents: 8070
diff changeset
1404 @cindex graphics object, line
6888
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
1405 A line in two or three dimensions.
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
1406
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
1407 @item text
8071
b6e85fb238c1 doc fixes
John W. Eaton <jwe@octave.org>
parents: 8070
diff changeset
1408 @cindex text graphics object
b6e85fb238c1 doc fixes
John W. Eaton <jwe@octave.org>
parents: 8070
diff changeset
1409 @cindex graphics object, text
6888
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
1410 Text annotations.
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
1411
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
1412 @item image
8071
b6e85fb238c1 doc fixes
John W. Eaton <jwe@octave.org>
parents: 8070
diff changeset
1413 @cindex image graphics object
b6e85fb238c1 doc fixes
John W. Eaton <jwe@octave.org>
parents: 8070
diff changeset
1414 @cindex graphics object, image
6888
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
1415 A bitmap image.
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
1416
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
1417 @item patch
8071
b6e85fb238c1 doc fixes
John W. Eaton <jwe@octave.org>
parents: 8070
diff changeset
1418 @cindex patch graphics object
b6e85fb238c1 doc fixes
John W. Eaton <jwe@octave.org>
parents: 8070
diff changeset
1419 @cindex graphics object, patch
6888
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
1420 A filled polygon, currently limited to two dimensions.
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
1421
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
1422 @item surface
8071
b6e85fb238c1 doc fixes
John W. Eaton <jwe@octave.org>
parents: 8070
diff changeset
1423 @cindex surface graphics object
9672
43a07df0ed4c document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents: 9316
diff changeset
1424 @cindex graphics object, surface
6888
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
1425 A three-dimensional surface.
21789
6afdf40be534 Implement graphics object "light" (patch #8943).
mmuetzel <markus.muetzel@gmx.de>
parents: 21771
diff changeset
1426
6afdf40be534 Implement graphics object "light" (patch #8943).
mmuetzel <markus.muetzel@gmx.de>
parents: 21771
diff changeset
1427 @item light
6afdf40be534 Implement graphics object "light" (patch #8943).
mmuetzel <markus.muetzel@gmx.de>
parents: 21771
diff changeset
1428 @cindex light graphics object
6afdf40be534 Implement graphics object "light" (patch #8943).
mmuetzel <markus.muetzel@gmx.de>
parents: 21771
diff changeset
1429 @cindex graphics object, light
6afdf40be534 Implement graphics object "light" (patch #8943).
mmuetzel <markus.muetzel@gmx.de>
parents: 21771
diff changeset
1430 A light object used for lighting effects on patches and surfaces.
9672
43a07df0ed4c document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents: 9316
diff changeset
1431 @c @end group
6888
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
1432 @end table
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
1433
16923
5d08a2ec7edb doc: Move graphics object functions into the right section
Mike Miller <mtmiller@ieee.org>
parents: 16814
diff changeset
1434 @subsubsection Creating Graphics Objects
5d08a2ec7edb doc: Move graphics object functions into the right section
Mike Miller <mtmiller@ieee.org>
parents: 16814
diff changeset
1435 @cindex creating graphics objects
5d08a2ec7edb doc: Move graphics object functions into the right section
Mike Miller <mtmiller@ieee.org>
parents: 16814
diff changeset
1436
19460
78c0241306b5 Add documentation about when to use newplot (bug #40289).
Rik <rik@octave.org>
parents: 19405
diff changeset
1437 You can create any graphics object primitive by calling the function of the
78c0241306b5 Add documentation about when to use newplot (bug #40289).
Rik <rik@octave.org>
parents: 19405
diff changeset
1438 same name as the object; In other words, @code{figure}, @code{axes},
21789
6afdf40be534 Implement graphics object "light" (patch #8943).
mmuetzel <markus.muetzel@gmx.de>
parents: 21771
diff changeset
1439 @code{line}, @code{text}, @code{image}, @code{patch}, @code{surface}, and
6afdf40be534 Implement graphics object "light" (patch #8943).
mmuetzel <markus.muetzel@gmx.de>
parents: 21771
diff changeset
1440 @code{light} functions. These fundamental graphic objects automatically become
6afdf40be534 Implement graphics object "light" (patch #8943).
mmuetzel <markus.muetzel@gmx.de>
parents: 21771
diff changeset
1441 children of the current axes object as if @code{hold on} was in place.
22106
c8abb2ba4017 doc: Fix 2 typos: Seperately -> Separately, lit -> list
Andreas Weber <andy.weber.aw@gmail.com>
parents: 21824
diff changeset
1442 Separately, axes will automatically become children of the current figure
24462
8ff3c13d14c1 groot.m: New function to return handle of graphics root object.
Rik <rik@octave.org>
parents: 24423
diff changeset
1443 object and figures will become children of the root object.
19460
78c0241306b5 Add documentation about when to use newplot (bug #40289).
Rik <rik@octave.org>
parents: 19405
diff changeset
1444
78c0241306b5 Add documentation about when to use newplot (bug #40289).
Rik <rik@octave.org>
parents: 19405
diff changeset
1445 If this auto-joining feature is not desired then it is important to call
78c0241306b5 Add documentation about when to use newplot (bug #40289).
Rik <rik@octave.org>
parents: 19405
diff changeset
1446 @code{newplot} first to prepare a new figure and axes for plotting.
78c0241306b5 Add documentation about when to use newplot (bug #40289).
Rik <rik@octave.org>
parents: 19405
diff changeset
1447 Alternatively, the easier way is to call a high-level graphics routine which
78c0241306b5 Add documentation about when to use newplot (bug #40289).
Rik <rik@octave.org>
parents: 19405
diff changeset
1448 will both create the plot and then populate it with low-level graphics objects.
78c0241306b5 Add documentation about when to use newplot (bug #40289).
Rik <rik@octave.org>
parents: 19405
diff changeset
1449 Instead of calling @code{line}, use @code{plot}. Or use @code{surf} instead of
29395
4d747b196935 fill3.m: Add new function.
Markus Mützel <markus.muetzel@gmx.de>
parents: 29122
diff changeset
1450 @code{surface}. Or use @code{fill} or @code{fill3} instead of @code{patch}.
16923
5d08a2ec7edb doc: Move graphics object functions into the right section
Mike Miller <mtmiller@ieee.org>
parents: 16814
diff changeset
1451
5d08a2ec7edb doc: Move graphics object functions into the right section
Mike Miller <mtmiller@ieee.org>
parents: 16814
diff changeset
1452 @DOCSTRING(axes)
5d08a2ec7edb doc: Move graphics object functions into the right section
Mike Miller <mtmiller@ieee.org>
parents: 16814
diff changeset
1453
5d08a2ec7edb doc: Move graphics object functions into the right section
Mike Miller <mtmiller@ieee.org>
parents: 16814
diff changeset
1454 @DOCSTRING(line)
5d08a2ec7edb doc: Move graphics object functions into the right section
Mike Miller <mtmiller@ieee.org>
parents: 16814
diff changeset
1455
5d08a2ec7edb doc: Move graphics object functions into the right section
Mike Miller <mtmiller@ieee.org>
parents: 16814
diff changeset
1456 @DOCSTRING(patch)
5d08a2ec7edb doc: Move graphics object functions into the right section
Mike Miller <mtmiller@ieee.org>
parents: 16814
diff changeset
1457
5d08a2ec7edb doc: Move graphics object functions into the right section
Mike Miller <mtmiller@ieee.org>
parents: 16814
diff changeset
1458 @DOCSTRING(surface)
5d08a2ec7edb doc: Move graphics object functions into the right section
Mike Miller <mtmiller@ieee.org>
parents: 16814
diff changeset
1459
21789
6afdf40be534 Implement graphics object "light" (patch #8943).
mmuetzel <markus.muetzel@gmx.de>
parents: 21771
diff changeset
1460 @DOCSTRING(light)
6afdf40be534 Implement graphics object "light" (patch #8943).
mmuetzel <markus.muetzel@gmx.de>
parents: 21771
diff changeset
1461
9672
43a07df0ed4c document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents: 9316
diff changeset
1462 @subsubsection Handle Functions
43a07df0ed4c document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents: 9316
diff changeset
1463 @cindex handle functions
43a07df0ed4c document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents: 9316
diff changeset
1464
17123
bcada0a4f8a7 isaxes.m: New function to determine if object is axes handle.
Rik <rik@octave.org>
parents: 17122
diff changeset
1465 To determine whether a variable is a graphics object index, or an index
24423
1d52db450db4 Change ishandle to return true for Java objects for Matlab compatibility.
Rik <rik@octave.org>
parents: 24208
diff changeset
1466 to an axes or figure, use the functions @code{ishghandle}, @code{isgraphics},
1d52db450db4 Change ishandle to return true for Java objects for Matlab compatibility.
Rik <rik@octave.org>
parents: 24208
diff changeset
1467 @code{isaxes}, and @code{isfigure}.
1d52db450db4 Change ishandle to return true for Java objects for Matlab compatibility.
Rik <rik@octave.org>
parents: 24208
diff changeset
1468
1d52db450db4 Change ishandle to return true for Java objects for Matlab compatibility.
Rik <rik@octave.org>
parents: 24208
diff changeset
1469 @DOCSTRING(ishghandle)
1d52db450db4 Change ishandle to return true for Java objects for Matlab compatibility.
Rik <rik@octave.org>
parents: 24208
diff changeset
1470
1d52db450db4 Change ishandle to return true for Java objects for Matlab compatibility.
Rik <rik@octave.org>
parents: 24208
diff changeset
1471 @DOCSTRING(isgraphics)
6888
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
1472
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
1473 @DOCSTRING(ishandle)
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
1474
17123
bcada0a4f8a7 isaxes.m: New function to determine if object is axes handle.
Rik <rik@octave.org>
parents: 17122
diff changeset
1475 @DOCSTRING(isaxes)
bcada0a4f8a7 isaxes.m: New function to determine if object is axes handle.
Rik <rik@octave.org>
parents: 17122
diff changeset
1476
6888
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
1477 @DOCSTRING(isfigure)
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
1478
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
1479 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
1480 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
1481 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
1482 none exists.
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
1483
24462
8ff3c13d14c1 groot.m: New function to return handle of graphics root object.
Rik <rik@octave.org>
parents: 24423
diff changeset
1484 @DOCSTRING(groot)
8ff3c13d14c1 groot.m: New function to return handle of graphics root object.
Rik <rik@octave.org>
parents: 24423
diff changeset
1485
6888
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
1486 @DOCSTRING(gcf)
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
1487
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
1488 @DOCSTRING(gca)
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
1489
16808
772f51539af8 doc: Add gco() to documentation.
Rik <rik@octave.org>
parents: 16802
diff changeset
1490 @DOCSTRING(gco)
772f51539af8 doc: Add gco() to documentation.
Rik <rik@octave.org>
parents: 16802
diff changeset
1491
6888
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
1492 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
1493 properties for graphics objects. For example,
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
1494
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
1495 @example
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
1496 @group
24462
8ff3c13d14c1 groot.m: New function to return handle of graphics root object.
Rik <rik@octave.org>
parents: 24423
diff changeset
1497 get (groot)
6888
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
1498 @result{} ans =
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
1499 @{
9316
c539ec5726e7 Update some of Advanced Plotting documentation.
Rik <rdrider0-list@yahoo.com>
parents: 9209
diff changeset
1500 type = root
6888
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
1501 currentfigure = [](0x0)
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
1502 children = [](0x0)
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
1503 visible = on
10599
d0e0bb2ebebb Remove tabs in .txi files causing problems with pdf formatting.
Rik <octave@nomad.inbox5.com>
parents: 10522
diff changeset
1504 @dots{}
6888
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
1505 @}
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
1506 @end group
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
1507 @end example
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
1508
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
1509 @noindent
26878
3c7c5b7c3044 doc: Refer to "root object" rather than "root figure object".
Rik <rik@octave.org>
parents: 26877
diff changeset
1510 returns a structure containing all the properties of the root graphics object.
6888
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
1511 As with all functions in Octave, the structure is returned by value, so
26878
3c7c5b7c3044 doc: Refer to "root object" rather than "root figure object".
Rik <rik@octave.org>
parents: 26877
diff changeset
1512 modifying it will not modify the internal root object. To do that, you must
3c7c5b7c3044 doc: Refer to "root object" rather than "root figure object".
Rik <rik@octave.org>
parents: 26877
diff changeset
1513 use the @code{set} function. Also, note that in this case, the
3c7c5b7c3044 doc: Refer to "root object" rather than "root figure object".
Rik <rik@octave.org>
parents: 26877
diff changeset
1514 @code{currentfigure} property is empty, which indicates that there is no
3c7c5b7c3044 doc: Refer to "root object" rather than "root figure object".
Rik <rik@octave.org>
parents: 26877
diff changeset
1515 current figure window.
6888
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
1516
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
1517 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
1518 property. For example,
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
1519
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
1520 @example
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
1521 @group
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
1522 get (gca (), "xlim")
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
1523 @result{} [ 0 1 ]
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
1524 @end group
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
1525 @end example
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
1526
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
1527 @noindent
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
1528 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
1529 current figure.
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
1530
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
1531 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
1532
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
1533 @example
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
1534 set (gca (), "xlim", [-10, 10]);
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
1535 @end example
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
1536
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
1537 @noindent
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
1538 sets the range of the x-axis for the current axes object in the current
18151
1c22f0465c74 doc: Add documentation about using set() to get default graphic properties.
Rik <rik@octave.org>
parents: 18078
diff changeset
1539 figure to @samp{[-10, 10]}.
1c22f0465c74 doc: Add documentation about using set() to get default graphic properties.
Rik <rik@octave.org>
parents: 18078
diff changeset
1540
1c22f0465c74 doc: Add documentation about using set() to get default graphic properties.
Rik <rik@octave.org>
parents: 18078
diff changeset
1541 Default property values can also be queried if the @code{set} function is
1c22f0465c74 doc: Add documentation about using set() to get default graphic properties.
Rik <rik@octave.org>
parents: 18078
diff changeset
1542 called without a value argument. When only one argument is given (a graphic
1c22f0465c74 doc: Add documentation about using set() to get default graphic properties.
Rik <rik@octave.org>
parents: 18078
diff changeset
1543 handle) then a structure with defaults for all properties of the given object
1c22f0465c74 doc: Add documentation about using set() to get default graphic properties.
Rik <rik@octave.org>
parents: 18078
diff changeset
1544 type is returned. For example,
6888
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
1545
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
1546 @example
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
1547 set (gca ())
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
1548 @end example
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
1549
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
1550 @noindent
18151
1c22f0465c74 doc: Add documentation about using set() to get default graphic properties.
Rik <rik@octave.org>
parents: 18078
diff changeset
1551 returns a structure containing the default property values for axes objects.
1c22f0465c74 doc: Add documentation about using set() to get default graphic properties.
Rik <rik@octave.org>
parents: 18078
diff changeset
1552 If @code{set} is called with two arguments (a graphic handle and a property
1c22f0465c74 doc: Add documentation about using set() to get default graphic properties.
Rik <rik@octave.org>
parents: 18078
diff changeset
1553 name) then only the defaults for the requested property are returned.
6888
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
1554
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
1555 @DOCSTRING(get)
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
1556
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
1557 @DOCSTRING(set)
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
1558
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
1559 @DOCSTRING(ancestor)
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
1560
7984
bbaa5d7d0143 Some documentation updates
David Bateman <dbateman@free.fr>
parents: 7981
diff changeset
1561 @DOCSTRING(allchild)
bbaa5d7d0143 Some documentation updates
David Bateman <dbateman@free.fr>
parents: 7981
diff changeset
1562
14577
447038c2dde8 Add findfigs.m docstring to plot.txi
Carnë Draug <carandraug+dev@gmail.com>
parents: 14574
diff changeset
1563 @DOCSTRING(findfigs)
447038c2dde8 Add findfigs.m docstring to plot.txi
Carnë Draug <carandraug+dev@gmail.com>
parents: 14574
diff changeset
1564
16813
81e041f5633a doc: Add copyobj, struct2hdl, hdl2struct to manual.
Rik <rik@octave.org>
parents: 16808
diff changeset
1565 @cindex saving graphics objects
18330
200851c87444 Edits to Manual and indicies
Michael Godfrey <michaeldgodfrey@gmail.com>
parents: 17957
diff changeset
1566 @cindex graphics objects, saving
16813
81e041f5633a doc: Add copyobj, struct2hdl, hdl2struct to manual.
Rik <rik@octave.org>
parents: 16808
diff changeset
1567
81e041f5633a doc: Add copyobj, struct2hdl, hdl2struct to manual.
Rik <rik@octave.org>
parents: 16808
diff changeset
1568 Figures can be printed or saved in many graphics formats with @code{print} and
81e041f5633a doc: Add copyobj, struct2hdl, hdl2struct to manual.
Rik <rik@octave.org>
parents: 16808
diff changeset
1569 @code{saveas}. Occasionally, however, it may be useful to save the original
81e041f5633a doc: Add copyobj, struct2hdl, hdl2struct to manual.
Rik <rik@octave.org>
parents: 16808
diff changeset
1570 Octave handle graphic directly so that further modifications can be made such
17469
710b3d5fe966 improve interpreter tex Tables
Michael Godfrey <michaeldgodfrey@gmail.com>
parents: 17281
diff changeset
1571 as modifying a title or legend.
710b3d5fe966 improve interpreter tex Tables
Michael Godfrey <michaeldgodfrey@gmail.com>
parents: 17281
diff changeset
1572
710b3d5fe966 improve interpreter tex Tables
Michael Godfrey <michaeldgodfrey@gmail.com>
parents: 17281
diff changeset
1573 This can be accomplished with the following functions by
16813
81e041f5633a doc: Add copyobj, struct2hdl, hdl2struct to manual.
Rik <rik@octave.org>
parents: 16808
diff changeset
1574
81e041f5633a doc: Add copyobj, struct2hdl, hdl2struct to manual.
Rik <rik@octave.org>
parents: 16808
diff changeset
1575 @example
81e041f5633a doc: Add copyobj, struct2hdl, hdl2struct to manual.
Rik <rik@octave.org>
parents: 16808
diff changeset
1576 @group
81e041f5633a doc: Add copyobj, struct2hdl, hdl2struct to manual.
Rik <rik@octave.org>
parents: 16808
diff changeset
1577 fig_struct = hdl2struct (gcf);
81e041f5633a doc: Add copyobj, struct2hdl, hdl2struct to manual.
Rik <rik@octave.org>
parents: 16808
diff changeset
1578 save myplot.fig -struct fig_struct;
81e041f5633a doc: Add copyobj, struct2hdl, hdl2struct to manual.
Rik <rik@octave.org>
parents: 16808
diff changeset
1579 @dots{}
81e041f5633a doc: Add copyobj, struct2hdl, hdl2struct to manual.
Rik <rik@octave.org>
parents: 16808
diff changeset
1580 fig_struct = load ("myplot.fig");
81e041f5633a doc: Add copyobj, struct2hdl, hdl2struct to manual.
Rik <rik@octave.org>
parents: 16808
diff changeset
1581 struct2hdl (fig_struct);
81e041f5633a doc: Add copyobj, struct2hdl, hdl2struct to manual.
Rik <rik@octave.org>
parents: 16808
diff changeset
1582 @end group
81e041f5633a doc: Add copyobj, struct2hdl, hdl2struct to manual.
Rik <rik@octave.org>
parents: 16808
diff changeset
1583 @end example
81e041f5633a doc: Add copyobj, struct2hdl, hdl2struct to manual.
Rik <rik@octave.org>
parents: 16808
diff changeset
1584
81e041f5633a doc: Add copyobj, struct2hdl, hdl2struct to manual.
Rik <rik@octave.org>
parents: 16808
diff changeset
1585 @DOCSTRING(hdl2struct)
81e041f5633a doc: Add copyobj, struct2hdl, hdl2struct to manual.
Rik <rik@octave.org>
parents: 16808
diff changeset
1586
81e041f5633a doc: Add copyobj, struct2hdl, hdl2struct to manual.
Rik <rik@octave.org>
parents: 16808
diff changeset
1587 @DOCSTRING(struct2hdl)
81e041f5633a doc: Add copyobj, struct2hdl, hdl2struct to manual.
Rik <rik@octave.org>
parents: 16808
diff changeset
1588
81e041f5633a doc: Add copyobj, struct2hdl, hdl2struct to manual.
Rik <rik@octave.org>
parents: 16808
diff changeset
1589 @DOCSTRING(copyobj)
81e041f5633a doc: Add copyobj, struct2hdl, hdl2struct to manual.
Rik <rik@octave.org>
parents: 16808
diff changeset
1590
6888
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
1591 @node Graphics Object Properties
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
1592 @subsection Graphics Object Properties
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
1593 @cindex graphics object properties
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
1594
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
1595 @menu
26878
3c7c5b7c3044 doc: Refer to "root object" rather than "root figure object".
Rik <rik@octave.org>
parents: 26877
diff changeset
1596 * Root Properties::
17152
f2a8592b8fbd doc: Shorten some long subsection names in Manual.
Rik <rik@octave.org>
parents: 17123
diff changeset
1597 * Figure Properties::
f2a8592b8fbd doc: Shorten some long subsection names in Manual.
Rik <rik@octave.org>
parents: 17123
diff changeset
1598 * Axes Properties::
28658
c49a546a745a Better documentation for legend objects (bug #57254)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents: 28427
diff changeset
1599 * Legend Properties::
17152
f2a8592b8fbd doc: Shorten some long subsection names in Manual.
Rik <rik@octave.org>
parents: 17123
diff changeset
1600 * Line Properties::
f2a8592b8fbd doc: Shorten some long subsection names in Manual.
Rik <rik@octave.org>
parents: 17123
diff changeset
1601 * Text Properties::
f2a8592b8fbd doc: Shorten some long subsection names in Manual.
Rik <rik@octave.org>
parents: 17123
diff changeset
1602 * Image Properties::
f2a8592b8fbd doc: Shorten some long subsection names in Manual.
Rik <rik@octave.org>
parents: 17123
diff changeset
1603 * Patch Properties::
28286
496735a910c1 Add graphics object "scatter" (bug #58282).
Markus Mützel <markus.muetzel@gmx.de>
parents: 28136
diff changeset
1604 * Scatter Properties::
17152
f2a8592b8fbd doc: Shorten some long subsection names in Manual.
Rik <rik@octave.org>
parents: 17123
diff changeset
1605 * Surface Properties::
21789
6afdf40be534 Implement graphics object "light" (patch #8943).
mmuetzel <markus.muetzel@gmx.de>
parents: 21771
diff changeset
1606 * Light Properties::
20593
3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents: 20381
diff changeset
1607 * Uimenu Properties::
21824
6780a8657be3 Implement uibuttongroup (bug #47513)
Andrew Thornton <art27@cantab.net>
parents: 21789
diff changeset
1608 * Uibuttongroup Properties::
20593
3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents: 20381
diff changeset
1609 * Uicontextmenu Properties::
3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents: 20381
diff changeset
1610 * Uipanel Properties::
3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents: 20381
diff changeset
1611 * Uicontrol Properties::
26112
36e0e5b428e7 Implement uitable (patch #9084)
Andrew Thornton <art27@cantab.net>
parents: 25973
diff changeset
1612 * Uitable Properties::
20593
3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents: 20381
diff changeset
1613 * Uitoolbar Properties::
3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents: 20381
diff changeset
1614 * Uipushtool Properties::
3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents: 20381
diff changeset
1615 * Uitoggletool Properties::
6888
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
1616 @end menu
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
1617
26878
3c7c5b7c3044 doc: Refer to "root object" rather than "root figure object".
Rik <rik@octave.org>
parents: 26877
diff changeset
1618 In this section the graphics object properties are discussed in detail,
3c7c5b7c3044 doc: Refer to "root object" rather than "root figure object".
Rik <rik@octave.org>
parents: 26877
diff changeset
1619 starting with the root properties and continuing through the object hierarchy.
3c7c5b7c3044 doc: Refer to "root object" rather than "root figure object".
Rik <rik@octave.org>
parents: 26877
diff changeset
1620 The documentation about a specific graphics object can be displayed using
3c7c5b7c3044 doc: Refer to "root object" rather than "root figure object".
Rik <rik@octave.org>
parents: 26877
diff changeset
1621 @code{doc} function, e.g., @code{doc ("axes properties")} will show
19597
db92e7e28e1f strip trailing whitespace from most source files
John W. Eaton <jwe@octave.org>
parents: 19596
diff changeset
1622 @ref{Axes Properties}.
db92e7e28e1f strip trailing whitespace from most source files
John W. Eaton <jwe@octave.org>
parents: 19596
diff changeset
1623
db92e7e28e1f strip trailing whitespace from most source files
John W. Eaton <jwe@octave.org>
parents: 19596
diff changeset
1624 The allowed values for radio (string) properties can be retrieved
26878
3c7c5b7c3044 doc: Refer to "root object" rather than "root figure object".
Rik <rik@octave.org>
parents: 26877
diff changeset
1625 programmatically or displayed using the one or two argument calling form of the
3c7c5b7c3044 doc: Refer to "root object" rather than "root figure object".
Rik <rik@octave.org>
parents: 26877
diff changeset
1626 @code{set} function. @xref{XREFset, , set}.
3c7c5b7c3044 doc: Refer to "root object" rather than "root figure object".
Rik <rik@octave.org>
parents: 26877
diff changeset
1627
3c7c5b7c3044 doc: Refer to "root object" rather than "root figure object".
Rik <rik@octave.org>
parents: 26877
diff changeset
1628 In the following documentation default values are enclosed in @{ @}.
3c7c5b7c3044 doc: Refer to "root object" rather than "root figure object".
Rik <rik@octave.org>
parents: 26877
diff changeset
1629
3c7c5b7c3044 doc: Refer to "root object" rather than "root figure object".
Rik <rik@octave.org>
parents: 26877
diff changeset
1630 @node Root Properties
3c7c5b7c3044 doc: Refer to "root object" rather than "root figure object".
Rik <rik@octave.org>
parents: 26877
diff changeset
1631 @subsubsection Root Properties
3c7c5b7c3044 doc: Refer to "root object" rather than "root figure object".
Rik <rik@octave.org>
parents: 26877
diff changeset
1632 @prindex @sortas{@ Root Properties} Root Properties
9672
43a07df0ed4c document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents: 9316
diff changeset
1633
19257
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents: 19152
diff changeset
1634 @include plot-rootproperties.texi
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents: 19152
diff changeset
1635
6888
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
1636
6889
ebff56d6b0a8 [project @ 2007-09-12 18:32:12 by jwe]
jwe
parents: 6888
diff changeset
1637 @node Figure Properties
ebff56d6b0a8 [project @ 2007-09-12 18:32:12 by jwe]
jwe
parents: 6888
diff changeset
1638 @subsubsection Figure Properties
24549
2c497be89710 doc: Create new Graphic Properties Index (bug #52812).
Rik <rik@octave.org>
parents: 24534
diff changeset
1639 @prindex @sortas{@ Figure Properties} Figure Properties
6888
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
1640
19257
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents: 19152
diff changeset
1641 @include plot-figureproperties.texi
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents: 19152
diff changeset
1642
6888
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
1643
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
1644 @node Axes Properties
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
1645 @subsubsection Axes Properties
24549
2c497be89710 doc: Create new Graphic Properties Index (bug #52812).
Rik <rik@octave.org>
parents: 24534
diff changeset
1646 @prindex @sortas{@ Axes Properties} Axes Properties
6888
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
1647
19257
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents: 19152
diff changeset
1648 @include plot-axesproperties.texi
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents: 19152
diff changeset
1649
6888
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
1650
28658
c49a546a745a Better documentation for legend objects (bug #57254)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents: 28427
diff changeset
1651 @node Legend Properties
c49a546a745a Better documentation for legend objects (bug #57254)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents: 28427
diff changeset
1652 @subsubsection Legend Properties
c49a546a745a Better documentation for legend objects (bug #57254)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents: 28427
diff changeset
1653 @prindex @sortas{@ Legend Properties} Legend Properties
c49a546a745a Better documentation for legend objects (bug #57254)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents: 28427
diff changeset
1654
c49a546a745a Better documentation for legend objects (bug #57254)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents: 28427
diff changeset
1655 @include plot-legendproperties.texi
c49a546a745a Better documentation for legend objects (bug #57254)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents: 28427
diff changeset
1656
c49a546a745a Better documentation for legend objects (bug #57254)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents: 28427
diff changeset
1657
6888
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
1658 @node Line Properties
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
1659 @subsubsection Line Properties
24549
2c497be89710 doc: Create new Graphic Properties Index (bug #52812).
Rik <rik@octave.org>
parents: 24534
diff changeset
1660 @prindex @sortas{@ Line Properties} Line Properties
6888
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
1661
19257
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents: 19152
diff changeset
1662 @include plot-lineproperties.texi
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents: 19152
diff changeset
1663
6888
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
1664
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
1665 @node Text Properties
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
1666 @subsubsection Text Properties
24549
2c497be89710 doc: Create new Graphic Properties Index (bug #52812).
Rik <rik@octave.org>
parents: 24534
diff changeset
1667 @prindex @sortas{@ Text Properties} Text Properties
6888
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
1668
19257
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents: 19152
diff changeset
1669 @include plot-textproperties.texi
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents: 19152
diff changeset
1670
6888
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
1671
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
1672 @node Image Properties
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
1673 @subsubsection Image Properties
24549
2c497be89710 doc: Create new Graphic Properties Index (bug #52812).
Rik <rik@octave.org>
parents: 24534
diff changeset
1674 @prindex @sortas{@ Image Properties} Image Properties
6888
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
1675
19257
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents: 19152
diff changeset
1676 @include plot-imageproperties.texi
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents: 19152
diff changeset
1677
6888
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
1678
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
1679 @node Patch Properties
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
1680 @subsubsection Patch Properties
24549
2c497be89710 doc: Create new Graphic Properties Index (bug #52812).
Rik <rik@octave.org>
parents: 24534
diff changeset
1681 @prindex @sortas{@ Patch Properties} Patch Properties
6888
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
1682
19257
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents: 19152
diff changeset
1683 @include plot-patchproperties.texi
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents: 19152
diff changeset
1684
6888
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
1685
28286
496735a910c1 Add graphics object "scatter" (bug #58282).
Markus Mützel <markus.muetzel@gmx.de>
parents: 28136
diff changeset
1686 @node Scatter Properties
496735a910c1 Add graphics object "scatter" (bug #58282).
Markus Mützel <markus.muetzel@gmx.de>
parents: 28136
diff changeset
1687 @subsubsection Scatter Properties
496735a910c1 Add graphics object "scatter" (bug #58282).
Markus Mützel <markus.muetzel@gmx.de>
parents: 28136
diff changeset
1688 @prindex @sortas{@ Scatter Properties} Scatter Properties
496735a910c1 Add graphics object "scatter" (bug #58282).
Markus Mützel <markus.muetzel@gmx.de>
parents: 28136
diff changeset
1689
496735a910c1 Add graphics object "scatter" (bug #58282).
Markus Mützel <markus.muetzel@gmx.de>
parents: 28136
diff changeset
1690 @include plot-scatterproperties.texi
496735a910c1 Add graphics object "scatter" (bug #58282).
Markus Mützel <markus.muetzel@gmx.de>
parents: 28136
diff changeset
1691
496735a910c1 Add graphics object "scatter" (bug #58282).
Markus Mützel <markus.muetzel@gmx.de>
parents: 28136
diff changeset
1692
6888
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
1693 @node Surface Properties
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
1694 @subsubsection Surface Properties
24549
2c497be89710 doc: Create new Graphic Properties Index (bug #52812).
Rik <rik@octave.org>
parents: 24534
diff changeset
1695 @prindex @sortas{@ Surface Properties} Surface Properties
6888
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
1696
19257
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents: 19152
diff changeset
1697 @include plot-surfaceproperties.texi
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents: 19152
diff changeset
1698
21789
6afdf40be534 Implement graphics object "light" (patch #8943).
mmuetzel <markus.muetzel@gmx.de>
parents: 21771
diff changeset
1699
6afdf40be534 Implement graphics object "light" (patch #8943).
mmuetzel <markus.muetzel@gmx.de>
parents: 21771
diff changeset
1700 @node Light Properties
6afdf40be534 Implement graphics object "light" (patch #8943).
mmuetzel <markus.muetzel@gmx.de>
parents: 21771
diff changeset
1701 @subsubsection Light Properties
24549
2c497be89710 doc: Create new Graphic Properties Index (bug #52812).
Rik <rik@octave.org>
parents: 24534
diff changeset
1702 @prindex @sortas{@ Light Properties} Light Properties
21789
6afdf40be534 Implement graphics object "light" (patch #8943).
mmuetzel <markus.muetzel@gmx.de>
parents: 21771
diff changeset
1703
6afdf40be534 Implement graphics object "light" (patch #8943).
mmuetzel <markus.muetzel@gmx.de>
parents: 21771
diff changeset
1704 @include plot-lightproperties.texi
6afdf40be534 Implement graphics object "light" (patch #8943).
mmuetzel <markus.muetzel@gmx.de>
parents: 21771
diff changeset
1705
28658
c49a546a745a Better documentation for legend objects (bug #57254)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents: 28427
diff changeset
1706
20593
3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents: 20381
diff changeset
1707 @node Uimenu Properties
3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents: 20381
diff changeset
1708 @subsubsection Uimenu Properties
24549
2c497be89710 doc: Create new Graphic Properties Index (bug #52812).
Rik <rik@octave.org>
parents: 24534
diff changeset
1709 @prindex @sortas{@ Uimenu Properties} Uimenu Properties
20593
3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents: 20381
diff changeset
1710
3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents: 20381
diff changeset
1711 @include plot-uimenuproperties.texi
3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents: 20381
diff changeset
1712
28658
c49a546a745a Better documentation for legend objects (bug #57254)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents: 28427
diff changeset
1713
21824
6780a8657be3 Implement uibuttongroup (bug #47513)
Andrew Thornton <art27@cantab.net>
parents: 21789
diff changeset
1714 @node Uibuttongroup Properties
6780a8657be3 Implement uibuttongroup (bug #47513)
Andrew Thornton <art27@cantab.net>
parents: 21789
diff changeset
1715 @subsubsection Uibuttongroup Properties
24549
2c497be89710 doc: Create new Graphic Properties Index (bug #52812).
Rik <rik@octave.org>
parents: 24534
diff changeset
1716 @prindex @sortas{@ Uibuttongroup Properties} Uibuttongroup Properties
21824
6780a8657be3 Implement uibuttongroup (bug #47513)
Andrew Thornton <art27@cantab.net>
parents: 21789
diff changeset
1717
6780a8657be3 Implement uibuttongroup (bug #47513)
Andrew Thornton <art27@cantab.net>
parents: 21789
diff changeset
1718 @include plot-uibuttongroupproperties.texi
6780a8657be3 Implement uibuttongroup (bug #47513)
Andrew Thornton <art27@cantab.net>
parents: 21789
diff changeset
1719
28658
c49a546a745a Better documentation for legend objects (bug #57254)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents: 28427
diff changeset
1720
20593
3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents: 20381
diff changeset
1721 @node Uicontextmenu Properties
3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents: 20381
diff changeset
1722 @subsubsection Uicontextmenu Properties
24549
2c497be89710 doc: Create new Graphic Properties Index (bug #52812).
Rik <rik@octave.org>
parents: 24534
diff changeset
1723 @prindex @sortas{@ Uicontextmenu Properties} Uicontextmenu Properties
20593
3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents: 20381
diff changeset
1724
3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents: 20381
diff changeset
1725 @include plot-uicontextmenuproperties.texi
3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents: 20381
diff changeset
1726
28658
c49a546a745a Better documentation for legend objects (bug #57254)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents: 28427
diff changeset
1727
20593
3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents: 20381
diff changeset
1728 @node Uipanel Properties
3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents: 20381
diff changeset
1729 @subsubsection Uipanel Properties
24549
2c497be89710 doc: Create new Graphic Properties Index (bug #52812).
Rik <rik@octave.org>
parents: 24534
diff changeset
1730 @prindex @sortas{@ Uipanel Properties} Uipanel Properties
20593
3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents: 20381
diff changeset
1731
3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents: 20381
diff changeset
1732 @include plot-uipanelproperties.texi
3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents: 20381
diff changeset
1733
28658
c49a546a745a Better documentation for legend objects (bug #57254)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents: 28427
diff changeset
1734
20593
3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents: 20381
diff changeset
1735 @node Uicontrol Properties
3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents: 20381
diff changeset
1736 @subsubsection Uicontrol Properties
24549
2c497be89710 doc: Create new Graphic Properties Index (bug #52812).
Rik <rik@octave.org>
parents: 24534
diff changeset
1737 @prindex @sortas{@ Uicontrol Properties} Uicontrol Properties
20593
3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents: 20381
diff changeset
1738
3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents: 20381
diff changeset
1739 @include plot-uicontrolproperties.texi
3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents: 20381
diff changeset
1740
28658
c49a546a745a Better documentation for legend objects (bug #57254)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents: 28427
diff changeset
1741
26112
36e0e5b428e7 Implement uitable (patch #9084)
Andrew Thornton <art27@cantab.net>
parents: 25973
diff changeset
1742 @node Uitable Properties
36e0e5b428e7 Implement uitable (patch #9084)
Andrew Thornton <art27@cantab.net>
parents: 25973
diff changeset
1743 @subsubsection Uitable Properties
36e0e5b428e7 Implement uitable (patch #9084)
Andrew Thornton <art27@cantab.net>
parents: 25973
diff changeset
1744 @cindex uitable properties
36e0e5b428e7 Implement uitable (patch #9084)
Andrew Thornton <art27@cantab.net>
parents: 25973
diff changeset
1745
36e0e5b428e7 Implement uitable (patch #9084)
Andrew Thornton <art27@cantab.net>
parents: 25973
diff changeset
1746 @include plot-uitableproperties.texi
36e0e5b428e7 Implement uitable (patch #9084)
Andrew Thornton <art27@cantab.net>
parents: 25973
diff changeset
1747
28658
c49a546a745a Better documentation for legend objects (bug #57254)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents: 28427
diff changeset
1748
20593
3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents: 20381
diff changeset
1749 @node Uitoolbar Properties
3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents: 20381
diff changeset
1750 @subsubsection Uitoolbar Properties
24549
2c497be89710 doc: Create new Graphic Properties Index (bug #52812).
Rik <rik@octave.org>
parents: 24534
diff changeset
1751 @prindex @sortas{@ Uitoolbar Properties} Uitoolbar Properties
20593
3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents: 20381
diff changeset
1752
3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents: 20381
diff changeset
1753 @include plot-uitoolbarproperties.texi
3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents: 20381
diff changeset
1754
28658
c49a546a745a Better documentation for legend objects (bug #57254)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents: 28427
diff changeset
1755
20593
3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents: 20381
diff changeset
1756 @node Uipushtool Properties
3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents: 20381
diff changeset
1757 @subsubsection Uipushtool Properties
24549
2c497be89710 doc: Create new Graphic Properties Index (bug #52812).
Rik <rik@octave.org>
parents: 24534
diff changeset
1758 @prindex @sortas{@ Uipushtool Properties} Uipushtool Properties
20593
3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents: 20381
diff changeset
1759
3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents: 20381
diff changeset
1760 @include plot-uipushtoolproperties.texi
3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents: 20381
diff changeset
1761
28658
c49a546a745a Better documentation for legend objects (bug #57254)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents: 28427
diff changeset
1762
20593
3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents: 20381
diff changeset
1763 @node Uitoggletool Properties
3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents: 20381
diff changeset
1764 @subsubsection Uitoggletool Properties
24549
2c497be89710 doc: Create new Graphic Properties Index (bug #52812).
Rik <rik@octave.org>
parents: 24534
diff changeset
1765 @prindex @sortas{@ Uitoggletool Properties} Uitoggletool Properties
20593
3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents: 20381
diff changeset
1766
3af34e1ef330 Preliminary inclusion of uixx objects properties in the manual (bug #46076)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents: 20381
diff changeset
1767 @include plot-uitoggletoolproperties.texi
6889
ebff56d6b0a8 [project @ 2007-09-12 18:32:12 by jwe]
jwe
parents: 6888
diff changeset
1768
28658
c49a546a745a Better documentation for legend objects (bug #57254)
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents: 28427
diff changeset
1769
8070
3b53b25e2550 Add data sources and line series
David Bateman <dbateman@free.fr>
parents: 8057
diff changeset
1770 @node Searching Properties
9672
43a07df0ed4c document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents: 9316
diff changeset
1771 @subsection Searching Properties
7984
bbaa5d7d0143 Some documentation updates
David Bateman <dbateman@free.fr>
parents: 7981
diff changeset
1772
bbaa5d7d0143 Some documentation updates
David Bateman <dbateman@free.fr>
parents: 7981
diff changeset
1773 @DOCSTRING(findobj)
bbaa5d7d0143 Some documentation updates
David Bateman <dbateman@free.fr>
parents: 7981
diff changeset
1774
bbaa5d7d0143 Some documentation updates
David Bateman <dbateman@free.fr>
parents: 7981
diff changeset
1775 @DOCSTRING(findall)
6891
e9921bb3d95b [project @ 2007-09-13 02:44:27 by jwe]
jwe
parents: 6889
diff changeset
1776 @node Managing Default Properties
e9921bb3d95b [project @ 2007-09-13 02:44:27 by jwe]
jwe
parents: 6889
diff changeset
1777 @subsection Managing Default Properties
8071
b6e85fb238c1 doc fixes
John W. Eaton <jwe@octave.org>
parents: 8070
diff changeset
1778 @cindex default graphics properties
b6e85fb238c1 doc fixes
John W. Eaton <jwe@octave.org>
parents: 8070
diff changeset
1779 @cindex graphics properties, default
6891
e9921bb3d95b [project @ 2007-09-13 02:44:27 by jwe]
jwe
parents: 6889
diff changeset
1780
6892
29fa8673d8d1 [project @ 2007-09-13 07:36:52 by jwe]
jwe
parents: 6891
diff changeset
1781 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
1782 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
1783 may override the factory defaults.
6891
e9921bb3d95b [project @ 2007-09-13 02:44:27 by jwe]
jwe
parents: 6889
diff changeset
1784
e9921bb3d95b [project @ 2007-09-13 02:44:27 by jwe]
jwe
parents: 6889
diff changeset
1785 Although default values may be set for any object, they are set in
12610
bdf694af4aa5 plot.txi: Clarify that inheritance of default property values only applies to the named object type.
Ben Abbott <bpabbott@mac.com>
parents: 12578
diff changeset
1786 parent objects and apply to child objects, of the specified object type.
13931
9de488c6c59c doc: Spellcheck documentation before 3.6.0 release
Rik <octave@nomad.inbox5.com>
parents: 12763
diff changeset
1787 For example, setting the default @code{color} property of @code{line}
17281
bc924baa2c4e doc: Add new @qcode macro for code samples which are quoted.
Rik <rik@octave.org>
parents: 17170
diff changeset
1788 objects to @qcode{"green"}, for the @code{root} object, will result in all
bc924baa2c4e doc: Add new @qcode macro for code samples which are quoted.
Rik <rik@octave.org>
parents: 17170
diff changeset
1789 @code{line} objects inheriting the @code{color} @qcode{"green"} as the default
12610
bdf694af4aa5 plot.txi: Clarify that inheritance of default property values only applies to the named object type.
Ben Abbott <bpabbott@mac.com>
parents: 12578
diff changeset
1790 value.
6891
e9921bb3d95b [project @ 2007-09-13 02:44:27 by jwe]
jwe
parents: 6889
diff changeset
1791
e9921bb3d95b [project @ 2007-09-13 02:44:27 by jwe]
jwe
parents: 6889
diff changeset
1792 @example
24462
8ff3c13d14c1 groot.m: New function to return handle of graphics root object.
Rik <rik@octave.org>
parents: 24423
diff changeset
1793 set (groot, "defaultlinecolor", "green");
6891
e9921bb3d95b [project @ 2007-09-13 02:44:27 by jwe]
jwe
parents: 6889
diff changeset
1794 @end example
e9921bb3d95b [project @ 2007-09-13 02:44:27 by jwe]
jwe
parents: 6889
diff changeset
1795
e9921bb3d95b [project @ 2007-09-13 02:44:27 by jwe]
jwe
parents: 6889
diff changeset
1796 @noindent
e9921bb3d95b [project @ 2007-09-13 02:44:27 by jwe]
jwe
parents: 6889
diff changeset
1797 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
1798 the property name to set a default value is
e9921bb3d95b [project @ 2007-09-13 02:44:27 by jwe]
jwe
parents: 6889
diff changeset
1799
e9921bb3d95b [project @ 2007-09-13 02:44:27 by jwe]
jwe
parents: 6889
diff changeset
1800 @example
e9921bb3d95b [project @ 2007-09-13 02:44:27 by jwe]
jwe
parents: 6889
diff changeset
1801 default + @var{object-type} + @var{property-name}
e9921bb3d95b [project @ 2007-09-13 02:44:27 by jwe]
jwe
parents: 6889
diff changeset
1802 @end example
e9921bb3d95b [project @ 2007-09-13 02:44:27 by jwe]
jwe
parents: 6889
diff changeset
1803
e9921bb3d95b [project @ 2007-09-13 02:44:27 by jwe]
jwe
parents: 6889
diff changeset
1804 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
1805 @code{defaultlinelinewidth"} specifies the default @code{linewidth}
e9921bb3d95b [project @ 2007-09-13 02:44:27 by jwe]
jwe
parents: 6889
diff changeset
1806 property for @code{line} objects.
e9921bb3d95b [project @ 2007-09-13 02:44:27 by jwe]
jwe
parents: 6889
diff changeset
1807
26878
3c7c5b7c3044 doc: Refer to "root object" rather than "root figure object".
Rik <rik@octave.org>
parents: 26877
diff changeset
1808 The example above used the root object so the default property value will apply
3c7c5b7c3044 doc: Refer to "root object" rather than "root figure object".
Rik <rik@octave.org>
parents: 26877
diff changeset
1809 to all line objects. However, default values are hierarchical, so defaults set
3c7c5b7c3044 doc: Refer to "root object" rather than "root figure object".
Rik <rik@octave.org>
parents: 26877
diff changeset
1810 in a figure objects override those set in the root object. Likewise, defaults
3c7c5b7c3044 doc: Refer to "root object" rather than "root figure object".
Rik <rik@octave.org>
parents: 26877
diff changeset
1811 set in an axes object override those set in figure or root objects. For
3c7c5b7c3044 doc: Refer to "root object" rather than "root figure object".
Rik <rik@octave.org>
parents: 26877
diff changeset
1812 example,
6891
e9921bb3d95b [project @ 2007-09-13 02:44:27 by jwe]
jwe
parents: 6889
diff changeset
1813
e9921bb3d95b [project @ 2007-09-13 02:44:27 by jwe]
jwe
parents: 6889
diff changeset
1814 @example
e9921bb3d95b [project @ 2007-09-13 02:44:27 by jwe]
jwe
parents: 6889
diff changeset
1815 @group
e9921bb3d95b [project @ 2007-09-13 02:44:27 by jwe]
jwe
parents: 6889
diff changeset
1816 subplot (2, 1, 1);
24462
8ff3c13d14c1 groot.m: New function to return handle of graphics root object.
Rik <rik@octave.org>
parents: 24423
diff changeset
1817 set (groot, "defaultlinecolor", "red");
6891
e9921bb3d95b [project @ 2007-09-13 02:44:27 by jwe]
jwe
parents: 6889
diff changeset
1818 set (1, "defaultlinecolor", "green");
e9921bb3d95b [project @ 2007-09-13 02:44:27 by jwe]
jwe
parents: 6889
diff changeset
1819 set (gca (), "defaultlinecolor", "blue");
e9921bb3d95b [project @ 2007-09-13 02:44:27 by jwe]
jwe
parents: 6889
diff changeset
1820 line (1:10, rand (1, 10));
e9921bb3d95b [project @ 2007-09-13 02:44:27 by jwe]
jwe
parents: 6889
diff changeset
1821 subplot (2, 1, 2);
e9921bb3d95b [project @ 2007-09-13 02:44:27 by jwe]
jwe
parents: 6889
diff changeset
1822 line (1:10, rand (1, 10));
e9921bb3d95b [project @ 2007-09-13 02:44:27 by jwe]
jwe
parents: 6889
diff changeset
1823 figure (2)
e9921bb3d95b [project @ 2007-09-13 02:44:27 by jwe]
jwe
parents: 6889
diff changeset
1824 line (1:10, rand (1, 10));
e9921bb3d95b [project @ 2007-09-13 02:44:27 by jwe]
jwe
parents: 6889
diff changeset
1825 @end group
e9921bb3d95b [project @ 2007-09-13 02:44:27 by jwe]
jwe
parents: 6889
diff changeset
1826 @end example
e9921bb3d95b [project @ 2007-09-13 02:44:27 by jwe]
jwe
parents: 6889
diff changeset
1827
e9921bb3d95b [project @ 2007-09-13 02:44:27 by jwe]
jwe
parents: 6889
diff changeset
1828 @noindent
e9921bb3d95b [project @ 2007-09-13 02:44:27 by jwe]
jwe
parents: 6889
diff changeset
1829 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
1830 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
1831 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
1832 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
1833 line in the second figure window is red because it inherits its color
26878
3c7c5b7c3044 doc: Refer to "root object" rather than "root figure object".
Rik <rik@octave.org>
parents: 26877
diff changeset
1834 from the global root object.
6891
e9921bb3d95b [project @ 2007-09-13 02:44:27 by jwe]
jwe
parents: 6889
diff changeset
1835
e9921bb3d95b [project @ 2007-09-13 02:44:27 by jwe]
jwe
parents: 6889
diff changeset
1836 To remove a user-defined default setting, set the default property to
17281
bc924baa2c4e doc: Add new @qcode macro for code samples which are quoted.
Rik <rik@octave.org>
parents: 17170
diff changeset
1837 the value @qcode{"remove"}. For example,
6891
e9921bb3d95b [project @ 2007-09-13 02:44:27 by jwe]
jwe
parents: 6889
diff changeset
1838
e9921bb3d95b [project @ 2007-09-13 02:44:27 by jwe]
jwe
parents: 6889
diff changeset
1839 @example
e9921bb3d95b [project @ 2007-09-13 02:44:27 by jwe]
jwe
parents: 6889
diff changeset
1840 set (gca (), "defaultlinecolor", "remove");
e9921bb3d95b [project @ 2007-09-13 02:44:27 by jwe]
jwe
parents: 6889
diff changeset
1841 @end example
e9921bb3d95b [project @ 2007-09-13 02:44:27 by jwe]
jwe
parents: 6889
diff changeset
1842
e9921bb3d95b [project @ 2007-09-13 02:44:27 by jwe]
jwe
parents: 6889
diff changeset
1843 @noindent
e9921bb3d95b [project @ 2007-09-13 02:44:27 by jwe]
jwe
parents: 6889
diff changeset
1844 removes the user-defined default line color setting from the current axes
12189
9558ca33648d Add functions reset, whitebg to documentation.
Rik <octave@nomad.inbox5.com>
parents: 11591
diff changeset
1845 object. To quickly remove all user-defined defaults use the @code{reset}
9558ca33648d Add functions reset, whitebg to documentation.
Rik <octave@nomad.inbox5.com>
parents: 11591
diff changeset
1846 function.
9558ca33648d Add functions reset, whitebg to documentation.
Rik <octave@nomad.inbox5.com>
parents: 11591
diff changeset
1847
25857
c3c9c8533a86 Document that high level graphics functions redefine axes properties (bug #49400).
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents: 25585
diff changeset
1848 By default, high level plotting functions such as @code{plot} reset and
c3c9c8533a86 Document that high level graphics functions redefine axes properties (bug #49400).
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents: 25585
diff changeset
1849 redefine axes properties independently from the defaults. An example of such
c3c9c8533a86 Document that high level graphics functions redefine axes properties (bug #49400).
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents: 25585
diff changeset
1850 property is the axes @code{box} property: it is set @code{on} by high level 2-D
c3c9c8533a86 Document that high level graphics functions redefine axes properties (bug #49400).
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents: 25585
diff changeset
1851 graphics functions regardless of the property @qcode{"defaultaxesbox"}. Use
c3c9c8533a86 Document that high level graphics functions redefine axes properties (bug #49400).
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents: 25585
diff changeset
1852 the @code{hold} function to prevent this behavior:
c3c9c8533a86 Document that high level graphics functions redefine axes properties (bug #49400).
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents: 25585
diff changeset
1853
c3c9c8533a86 Document that high level graphics functions redefine axes properties (bug #49400).
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents: 25585
diff changeset
1854 @example
c3c9c8533a86 Document that high level graphics functions redefine axes properties (bug #49400).
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents: 25585
diff changeset
1855 @group
c3c9c8533a86 Document that high level graphics functions redefine axes properties (bug #49400).
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents: 25585
diff changeset
1856 set (groot, "defaultaxesbox", "off");
c3c9c8533a86 Document that high level graphics functions redefine axes properties (bug #49400).
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents: 25585
diff changeset
1857 subplot (2, 1, 1);
c3c9c8533a86 Document that high level graphics functions redefine axes properties (bug #49400).
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents: 25585
diff changeset
1858 plot (1:10)
c3c9c8533a86 Document that high level graphics functions redefine axes properties (bug #49400).
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents: 25585
diff changeset
1859 title ("Box is on anyway")
c3c9c8533a86 Document that high level graphics functions redefine axes properties (bug #49400).
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents: 25585
diff changeset
1860 subplot (2, 1, 2);
c3c9c8533a86 Document that high level graphics functions redefine axes properties (bug #49400).
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents: 25585
diff changeset
1861 hold on
c3c9c8533a86 Document that high level graphics functions redefine axes properties (bug #49400).
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents: 25585
diff changeset
1862 plot (1:10)
c3c9c8533a86 Document that high level graphics functions redefine axes properties (bug #49400).
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents: 25585
diff changeset
1863 title ("Box is off")
c3c9c8533a86 Document that high level graphics functions redefine axes properties (bug #49400).
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents: 25585
diff changeset
1864 @end group
c3c9c8533a86 Document that high level graphics functions redefine axes properties (bug #49400).
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents: 25585
diff changeset
1865 @end example
c3c9c8533a86 Document that high level graphics functions redefine axes properties (bug #49400).
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents: 25585
diff changeset
1866
12189
9558ca33648d Add functions reset, whitebg to documentation.
Rik <octave@nomad.inbox5.com>
parents: 11591
diff changeset
1867 @DOCSTRING(reset)
6891
e9921bb3d95b [project @ 2007-09-13 02:44:27 by jwe]
jwe
parents: 6889
diff changeset
1868
17281
bc924baa2c4e doc: Add new @qcode macro for code samples which are quoted.
Rik <rik@octave.org>
parents: 17170
diff changeset
1869 Getting the @qcode{"default"} property of an object returns a list of
6891
e9921bb3d95b [project @ 2007-09-13 02:44:27 by jwe]
jwe
parents: 6889
diff changeset
1870 user-defined defaults set for the object. For example,
e9921bb3d95b [project @ 2007-09-13 02:44:27 by jwe]
jwe
parents: 6889
diff changeset
1871
e9921bb3d95b [project @ 2007-09-13 02:44:27 by jwe]
jwe
parents: 6889
diff changeset
1872 @example
e9921bb3d95b [project @ 2007-09-13 02:44:27 by jwe]
jwe
parents: 6889
diff changeset
1873 get (gca (), "default");
e9921bb3d95b [project @ 2007-09-13 02:44:27 by jwe]
jwe
parents: 6889
diff changeset
1874 @end example
e9921bb3d95b [project @ 2007-09-13 02:44:27 by jwe]
jwe
parents: 6889
diff changeset
1875
e9921bb3d95b [project @ 2007-09-13 02:44:27 by jwe]
jwe
parents: 6889
diff changeset
1876 @noindent
e9921bb3d95b [project @ 2007-09-13 02:44:27 by jwe]
jwe
parents: 6889
diff changeset
1877 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
1878 object.
e9921bb3d95b [project @ 2007-09-13 02:44:27 by jwe]
jwe
parents: 6889
diff changeset
1879
26878
3c7c5b7c3044 doc: Refer to "root object" rather than "root figure object".
Rik <rik@octave.org>
parents: 26877
diff changeset
1880 Factory default values are stored in the root object. The command
6891
e9921bb3d95b [project @ 2007-09-13 02:44:27 by jwe]
jwe
parents: 6889
diff changeset
1881
e9921bb3d95b [project @ 2007-09-13 02:44:27 by jwe]
jwe
parents: 6889
diff changeset
1882 @example
24462
8ff3c13d14c1 groot.m: New function to return handle of graphics root object.
Rik <rik@octave.org>
parents: 24423
diff changeset
1883 get (groot, "factory");
6891
e9921bb3d95b [project @ 2007-09-13 02:44:27 by jwe]
jwe
parents: 6889
diff changeset
1884 @end example
e9921bb3d95b [project @ 2007-09-13 02:44:27 by jwe]
jwe
parents: 6889
diff changeset
1885
e9921bb3d95b [project @ 2007-09-13 02:44:27 by jwe]
jwe
parents: 6889
diff changeset
1886 @noindent
e9921bb3d95b [project @ 2007-09-13 02:44:27 by jwe]
jwe
parents: 6889
diff changeset
1887 returns a list of factory defaults.
e9921bb3d95b [project @ 2007-09-13 02:44:27 by jwe]
jwe
parents: 6889
diff changeset
1888
9672
43a07df0ed4c document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents: 9316
diff changeset
1889 @node Advanced Plotting
43a07df0ed4c document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents: 9316
diff changeset
1890 @section Advanced Plotting
43a07df0ed4c document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents: 9316
diff changeset
1891
12525
d36266a54202 Add getappdata, setappdata, isappdata, rmappdata functions to documentation.
Rik <octave@nomad.inbox5.com>
parents: 12522
diff changeset
1892
9672
43a07df0ed4c document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents: 9316
diff changeset
1893 @menu
17152
f2a8592b8fbd doc: Shorten some long subsection names in Manual.
Rik <rik@octave.org>
parents: 17123
diff changeset
1894 * Colors::
f2a8592b8fbd doc: Shorten some long subsection names in Manual.
Rik <rik@octave.org>
parents: 17123
diff changeset
1895 * Line Styles::
f2a8592b8fbd doc: Shorten some long subsection names in Manual.
Rik <rik@octave.org>
parents: 17123
diff changeset
1896 * Marker Styles::
f2a8592b8fbd doc: Shorten some long subsection names in Manual.
Rik <rik@octave.org>
parents: 17123
diff changeset
1897 * Callbacks::
12525
d36266a54202 Add getappdata, setappdata, isappdata, rmappdata functions to documentation.
Rik <octave@nomad.inbox5.com>
parents: 12522
diff changeset
1898 * Application-defined Data::
17152
f2a8592b8fbd doc: Shorten some long subsection names in Manual.
Rik <rik@octave.org>
parents: 17123
diff changeset
1899 * Object Groups::
23255
aaf91b4f48e4 hgtransform.m: New function (bug #50466).
Rik <rik@octave.org>
parents: 23220
diff changeset
1900 * Transform Groups::
17152
f2a8592b8fbd doc: Shorten some long subsection names in Manual.
Rik <rik@octave.org>
parents: 17123
diff changeset
1901 * Graphics Toolkits::
9672
43a07df0ed4c document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents: 9316
diff changeset
1902 @end menu
43a07df0ed4c document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents: 9316
diff changeset
1903
43a07df0ed4c document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents: 9316
diff changeset
1904
6889
ebff56d6b0a8 [project @ 2007-09-12 18:32:12 by jwe]
jwe
parents: 6888
diff changeset
1905 @node Colors
ebff56d6b0a8 [project @ 2007-09-12 18:32:12 by jwe]
jwe
parents: 6888
diff changeset
1906 @subsection Colors
8071
b6e85fb238c1 doc fixes
John W. Eaton <jwe@octave.org>
parents: 8070
diff changeset
1907 @cindex graphics colors
b6e85fb238c1 doc fixes
John W. Eaton <jwe@octave.org>
parents: 8070
diff changeset
1908 @cindex colors, graphics
6889
ebff56d6b0a8 [project @ 2007-09-12 18:32:12 by jwe]
jwe
parents: 6888
diff changeset
1909
30355
6a6efd7bb3ec doc: grammarcheck texi files of Octave manual ahead of 7.1 release
Rik <rik@octave.org>
parents: 29670
diff changeset
1910 Colors may be specified in three ways: 1) RGB triplets, 2) by name, or 3) by
6a6efd7bb3ec doc: grammarcheck texi files of Octave manual ahead of 7.1 release
Rik <rik@octave.org>
parents: 29670
diff changeset
1911 HTML notation.
29122
5b8885af4e2f Allow color graphic properties to accept HTML specifications (bug #59562).
Rik <rik@octave.org>
parents: 29024
diff changeset
1912
5b8885af4e2f Allow color graphic properties to accept HTML specifications (bug #59562).
Rik <rik@octave.org>
parents: 29024
diff changeset
1913 @table @asis
5b8885af4e2f Allow color graphic properties to accept HTML specifications (bug #59562).
Rik <rik@octave.org>
parents: 29024
diff changeset
1914
5b8885af4e2f Allow color graphic properties to accept HTML specifications (bug #59562).
Rik <rik@octave.org>
parents: 29024
diff changeset
1915 @item RGB triplet
5b8885af4e2f Allow color graphic properties to accept HTML specifications (bug #59562).
Rik <rik@octave.org>
parents: 29024
diff changeset
1916
5b8885af4e2f Allow color graphic properties to accept HTML specifications (bug #59562).
Rik <rik@octave.org>
parents: 29024
diff changeset
1917 An RGB triplet is a 1x3 vector where each value is between 0 and 1 inclusive.
5b8885af4e2f Allow color graphic properties to accept HTML specifications (bug #59562).
Rik <rik@octave.org>
parents: 29024
diff changeset
1918 The first value represents the percentage of Red, the second value the
5b8885af4e2f Allow color graphic properties to accept HTML specifications (bug #59562).
Rik <rik@octave.org>
parents: 29024
diff changeset
1919 percentage of Green, and the third value the percentage of Blue. For example,
5b8885af4e2f Allow color graphic properties to accept HTML specifications (bug #59562).
Rik <rik@octave.org>
parents: 29024
diff changeset
1920 @code{[1, 0, 1]} represents full Red and Blue channels resulting in the color
5b8885af4e2f Allow color graphic properties to accept HTML specifications (bug #59562).
Rik <rik@octave.org>
parents: 29024
diff changeset
1921 magenta.
5b8885af4e2f Allow color graphic properties to accept HTML specifications (bug #59562).
Rik <rik@octave.org>
parents: 29024
diff changeset
1922
5b8885af4e2f Allow color graphic properties to accept HTML specifications (bug #59562).
Rik <rik@octave.org>
parents: 29024
diff changeset
1923 @item short or long name
5b8885af4e2f Allow color graphic properties to accept HTML specifications (bug #59562).
Rik <rik@octave.org>
parents: 29024
diff changeset
1924
5b8885af4e2f Allow color graphic properties to accept HTML specifications (bug #59562).
Rik <rik@octave.org>
parents: 29024
diff changeset
1925 Eight colors can be specified directly by name or by a single character short
5b8885af4e2f Allow color graphic properties to accept HTML specifications (bug #59562).
Rik <rik@octave.org>
parents: 29024
diff changeset
1926 name.
5b8885af4e2f Allow color graphic properties to accept HTML specifications (bug #59562).
Rik <rik@octave.org>
parents: 29024
diff changeset
1927
5b8885af4e2f Allow color graphic properties to accept HTML specifications (bug #59562).
Rik <rik@octave.org>
parents: 29024
diff changeset
1928 @multitable @columnfractions 0.21 0.79
5b8885af4e2f Allow color graphic properties to accept HTML specifications (bug #59562).
Rik <rik@octave.org>
parents: 29024
diff changeset
1929 @headitem Name @tab Color
5b8885af4e2f Allow color graphic properties to accept HTML specifications (bug #59562).
Rik <rik@octave.org>
parents: 29024
diff changeset
1930 @item @samp{k}, @qcode{"black"} @tab blacK
5b8885af4e2f Allow color graphic properties to accept HTML specifications (bug #59562).
Rik <rik@octave.org>
parents: 29024
diff changeset
1931 @item @samp{r}, @qcode{"red"} @tab Red
5b8885af4e2f Allow color graphic properties to accept HTML specifications (bug #59562).
Rik <rik@octave.org>
parents: 29024
diff changeset
1932 @item @samp{g}, @qcode{"green"} @tab Green
5b8885af4e2f Allow color graphic properties to accept HTML specifications (bug #59562).
Rik <rik@octave.org>
parents: 29024
diff changeset
1933 @item @samp{b}, @qcode{"blue"} @tab Blue
5b8885af4e2f Allow color graphic properties to accept HTML specifications (bug #59562).
Rik <rik@octave.org>
parents: 29024
diff changeset
1934 @item @samp{y}, @qcode{"yellow"} @tab Yellow
5b8885af4e2f Allow color graphic properties to accept HTML specifications (bug #59562).
Rik <rik@octave.org>
parents: 29024
diff changeset
1935 @item @samp{m}, @qcode{"magenta"} @tab Magenta
5b8885af4e2f Allow color graphic properties to accept HTML specifications (bug #59562).
Rik <rik@octave.org>
parents: 29024
diff changeset
1936 @item @samp{c}, @qcode{"cyan"} @tab Cyan
5b8885af4e2f Allow color graphic properties to accept HTML specifications (bug #59562).
Rik <rik@octave.org>
parents: 29024
diff changeset
1937 @item @samp{w}, @qcode{"white"} @tab White
5b8885af4e2f Allow color graphic properties to accept HTML specifications (bug #59562).
Rik <rik@octave.org>
parents: 29024
diff changeset
1938 @end multitable
5b8885af4e2f Allow color graphic properties to accept HTML specifications (bug #59562).
Rik <rik@octave.org>
parents: 29024
diff changeset
1939
5b8885af4e2f Allow color graphic properties to accept HTML specifications (bug #59562).
Rik <rik@octave.org>
parents: 29024
diff changeset
1940 @item HTML notation
5b8885af4e2f Allow color graphic properties to accept HTML specifications (bug #59562).
Rik <rik@octave.org>
parents: 29024
diff changeset
1941
5b8885af4e2f Allow color graphic properties to accept HTML specifications (bug #59562).
Rik <rik@octave.org>
parents: 29024
diff changeset
1942 HTML notation is a string that begins with the character @samp{#} and is
5b8885af4e2f Allow color graphic properties to accept HTML specifications (bug #59562).
Rik <rik@octave.org>
parents: 29024
diff changeset
1943 followed by either 3 or 6 hexadecimal digits. As with RGB triplets, each
5b8885af4e2f Allow color graphic properties to accept HTML specifications (bug #59562).
Rik <rik@octave.org>
parents: 29024
diff changeset
1944 hexadecimal number represents the fraction of the Red, Green, and Blue channels
5b8885af4e2f Allow color graphic properties to accept HTML specifications (bug #59562).
Rik <rik@octave.org>
parents: 29024
diff changeset
1945 present in the specified color. For example, @qcode{"#FF00FF"} represents
5b8885af4e2f Allow color graphic properties to accept HTML specifications (bug #59562).
Rik <rik@octave.org>
parents: 29024
diff changeset
1946 the color magenta.
5b8885af4e2f Allow color graphic properties to accept HTML specifications (bug #59562).
Rik <rik@octave.org>
parents: 29024
diff changeset
1947
5b8885af4e2f Allow color graphic properties to accept HTML specifications (bug #59562).
Rik <rik@octave.org>
parents: 29024
diff changeset
1948 @end table
6889
ebff56d6b0a8 [project @ 2007-09-12 18:32:12 by jwe]
jwe
parents: 6888
diff changeset
1949
ebff56d6b0a8 [project @ 2007-09-12 18:32:12 by jwe]
jwe
parents: 6888
diff changeset
1950 @node Line Styles
ebff56d6b0a8 [project @ 2007-09-12 18:32:12 by jwe]
jwe
parents: 6888
diff changeset
1951 @subsection Line Styles
8071
b6e85fb238c1 doc fixes
John W. Eaton <jwe@octave.org>
parents: 8070
diff changeset
1952 @cindex line styles, graphics
b6e85fb238c1 doc fixes
John W. Eaton <jwe@octave.org>
parents: 8070
diff changeset
1953 @cindex graphics line styles
b6e85fb238c1 doc fixes
John W. Eaton <jwe@octave.org>
parents: 8070
diff changeset
1954
7001
8b0cfeb06365 [project @ 2007-10-10 18:02:59 by jwe]
jwe
parents: 6899
diff changeset
1955 Line styles are specified by the following properties:
6889
ebff56d6b0a8 [project @ 2007-09-12 18:32:12 by jwe]
jwe
parents: 6888
diff changeset
1956
ebff56d6b0a8 [project @ 2007-09-12 18:32:12 by jwe]
jwe
parents: 6888
diff changeset
1957 @table @code
ebff56d6b0a8 [project @ 2007-09-12 18:32:12 by jwe]
jwe
parents: 6888
diff changeset
1958 @item linestyle
ebff56d6b0a8 [project @ 2007-09-12 18:32:12 by jwe]
jwe
parents: 6888
diff changeset
1959 May be one of
14853
72b8b39e12be doc: Periodic grammarcheck of documentation.
Rik <octave@nomad.inbox5.com>
parents: 14577
diff changeset
1960
18078
b06a9768b643 doc: Don't use @table @qcode to avoid problems with Texinfo 5.2.
Rik <rik@octave.org>
parents: 17957
diff changeset
1961 @table @asis
b06a9768b643 doc: Don't use @table @qcode to avoid problems with Texinfo 5.2.
Rik <rik@octave.org>
parents: 17957
diff changeset
1962 @item @qcode{"-"}
12690
e9e35a707721 doc: Add 'none' to list of plot linestyles.
Rik <octave@nomad.inbox5.com>
parents: 12607
diff changeset
1963 Solid line. [default]
10828
322f43e0e170 Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents: 10711
diff changeset
1964
18473
2b01c11197d6 Fix contraction of '--' to '-' in Info format of Line Styles (bug #41585)
Rik <rik@octave.org>
parents: 18339
diff changeset
1965 @c Special handling required to avoid '--' becoming single en-dash in Info
18474
d39fd728ddef Tweak cset 044bbf569cd3 to get '--' to display in HTML as well (bug #41585).
Rik <rik@octave.org>
parents: 18473
diff changeset
1966 @ifnottex
19405
cbce5d1bcaf9 doc: Periodic grammarcheck of documentation.
Rik <rik@octave.org>
parents: 19313
diff changeset
1967
18474
d39fd728ddef Tweak cset 044bbf569cd3 to get '--' to display in HTML as well (bug #41585).
Rik <rik@octave.org>
parents: 18473
diff changeset
1968 @item @verb{|"--"|}
d39fd728ddef Tweak cset 044bbf569cd3 to get '--' to display in HTML as well (bug #41585).
Rik <rik@octave.org>
parents: 18473
diff changeset
1969 @end ifnottex
18473
2b01c11197d6 Fix contraction of '--' to '-' in Info format of Line Styles (bug #41585)
Rik <rik@octave.org>
parents: 18339
diff changeset
1970 @iftex
19405
cbce5d1bcaf9 doc: Periodic grammarcheck of documentation.
Rik <rik@octave.org>
parents: 19313
diff changeset
1971
18473
2b01c11197d6 Fix contraction of '--' to '-' in Info format of Line Styles (bug #41585)
Rik <rik@octave.org>
parents: 18339
diff changeset
1972 @item @code{"--"}
2b01c11197d6 Fix contraction of '--' to '-' in Info format of Line Styles (bug #41585)
Rik <rik@octave.org>
parents: 18339
diff changeset
1973 @end iftex
12690
e9e35a707721 doc: Add 'none' to list of plot linestyles.
Rik <octave@nomad.inbox5.com>
parents: 12607
diff changeset
1974 Dashed line.
10828
322f43e0e170 Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents: 10711
diff changeset
1975
18078
b06a9768b643 doc: Don't use @table @qcode to avoid problems with Texinfo 5.2.
Rik <rik@octave.org>
parents: 17957
diff changeset
1976 @item @qcode{":"}
12690
e9e35a707721 doc: Add 'none' to list of plot linestyles.
Rik <octave@nomad.inbox5.com>
parents: 12607
diff changeset
1977 Dotted line.
10828
322f43e0e170 Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents: 10711
diff changeset
1978
18078
b06a9768b643 doc: Don't use @table @qcode to avoid problems with Texinfo 5.2.
Rik <rik@octave.org>
parents: 17957
diff changeset
1979 @item @qcode{"-."}
6889
ebff56d6b0a8 [project @ 2007-09-12 18:32:12 by jwe]
jwe
parents: 6888
diff changeset
1980 A dash-dot line.
12690
e9e35a707721 doc: Add 'none' to list of plot linestyles.
Rik <octave@nomad.inbox5.com>
parents: 12607
diff changeset
1981
17281
bc924baa2c4e doc: Add new @qcode macro for code samples which are quoted.
Rik <rik@octave.org>
parents: 17170
diff changeset
1982 @item @qcode{"none"}
12690
e9e35a707721 doc: Add 'none' to list of plot linestyles.
Rik <octave@nomad.inbox5.com>
parents: 12607
diff changeset
1983 No line. Points will still be marked using the current Marker Style.
6889
ebff56d6b0a8 [project @ 2007-09-12 18:32:12 by jwe]
jwe
parents: 6888
diff changeset
1984 @end table
ebff56d6b0a8 [project @ 2007-09-12 18:32:12 by jwe]
jwe
parents: 6888
diff changeset
1985
ebff56d6b0a8 [project @ 2007-09-12 18:32:12 by jwe]
jwe
parents: 6888
diff changeset
1986 @item linewidth
ebff56d6b0a8 [project @ 2007-09-12 18:32:12 by jwe]
jwe
parents: 6888
diff changeset
1987 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
1988 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
1989 @end table
ebff56d6b0a8 [project @ 2007-09-12 18:32:12 by jwe]
jwe
parents: 6888
diff changeset
1990
ebff56d6b0a8 [project @ 2007-09-12 18:32:12 by jwe]
jwe
parents: 6888
diff changeset
1991 @node Marker Styles
ebff56d6b0a8 [project @ 2007-09-12 18:32:12 by jwe]
jwe
parents: 6888
diff changeset
1992 @subsection Marker Styles
8071
b6e85fb238c1 doc fixes
John W. Eaton <jwe@octave.org>
parents: 8070
diff changeset
1993 @cindex graphics marker styles
b6e85fb238c1 doc fixes
John W. Eaton <jwe@octave.org>
parents: 8070
diff changeset
1994 @cindex marker styles, graphics
b6e85fb238c1 doc fixes
John W. Eaton <jwe@octave.org>
parents: 8070
diff changeset
1995
7001
8b0cfeb06365 [project @ 2007-10-10 18:02:59 by jwe]
jwe
parents: 6899
diff changeset
1996 Marker styles are specified by the following properties:
14853
72b8b39e12be doc: Periodic grammarcheck of documentation.
Rik <octave@nomad.inbox5.com>
parents: 14577
diff changeset
1997
6889
ebff56d6b0a8 [project @ 2007-09-12 18:32:12 by jwe]
jwe
parents: 6888
diff changeset
1998 @table @code
ebff56d6b0a8 [project @ 2007-09-12 18:32:12 by jwe]
jwe
parents: 6888
diff changeset
1999 @item marker
ebff56d6b0a8 [project @ 2007-09-12 18:32:12 by jwe]
jwe
parents: 6888
diff changeset
2000 A character indicating a plot marker to be place at each data point, or
17281
bc924baa2c4e doc: Add new @qcode macro for code samples which are quoted.
Rik <rik@octave.org>
parents: 17170
diff changeset
2001 @qcode{"none"}, meaning no markers should be displayed.
6889
ebff56d6b0a8 [project @ 2007-09-12 18:32:12 by jwe]
jwe
parents: 6888
diff changeset
2002
16094
8899c785cc99 doc: Fix warnings associated with Texinfo 5.0 (bug #38392)
Rik <rik@octave.org>
parents: 16008
diff changeset
2003 @item markeredgecolor
17281
bc924baa2c4e doc: Add new @qcode macro for code samples which are quoted.
Rik <rik@octave.org>
parents: 17170
diff changeset
2004 The color of the edge around the marker, or @qcode{"auto"}, meaning that
6889
ebff56d6b0a8 [project @ 2007-09-12 18:32:12 by jwe]
jwe
parents: 6888
diff changeset
2005 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
2006
16094
8899c785cc99 doc: Fix warnings associated with Texinfo 5.0 (bug #38392)
Rik <rik@octave.org>
parents: 16008
diff changeset
2007 @item markerfacecolor
17281
bc924baa2c4e doc: Add new @qcode macro for code samples which are quoted.
Rik <rik@octave.org>
parents: 17170
diff changeset
2008 The color of the marker, or @qcode{"none"} to indicate that the marker
6889
ebff56d6b0a8 [project @ 2007-09-12 18:32:12 by jwe]
jwe
parents: 6888
diff changeset
2009 should not be filled. @xref{Colors}.
ebff56d6b0a8 [project @ 2007-09-12 18:32:12 by jwe]
jwe
parents: 6888
diff changeset
2010
16094
8899c785cc99 doc: Fix warnings associated with Texinfo 5.0 (bug #38392)
Rik <rik@octave.org>
parents: 16008
diff changeset
2011 @item markersize
6889
ebff56d6b0a8 [project @ 2007-09-12 18:32:12 by jwe]
jwe
parents: 6888
diff changeset
2012 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
2013 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
2014 @end table
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe]
jwe
parents: 6877
diff changeset
2015
12607
2846ea58b288 colstyle.m: Add new function (bug #33063)
Rik <octave@nomad.inbox5.com>
parents: 12578
diff changeset
2016 The @code{colstyle} function will parse a @code{plot}-style specification
2846ea58b288 colstyle.m: Add new function (bug #33063)
Rik <octave@nomad.inbox5.com>
parents: 12578
diff changeset
2017 and will return the color, line, and marker values that would result.
2846ea58b288 colstyle.m: Add new function (bug #33063)
Rik <octave@nomad.inbox5.com>
parents: 12578
diff changeset
2018
2846ea58b288 colstyle.m: Add new function (bug #33063)
Rik <octave@nomad.inbox5.com>
parents: 12578
diff changeset
2019 @DOCSTRING(colstyle)
2846ea58b288 colstyle.m: Add new function (bug #33063)
Rik <octave@nomad.inbox5.com>
parents: 12578
diff changeset
2020
8056
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents: 8055
diff changeset
2021 @node Callbacks
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents: 8055
diff changeset
2022 @subsection Callbacks
8071
b6e85fb238c1 doc fixes
John W. Eaton <jwe@octave.org>
parents: 8070
diff changeset
2023 @cindex callbacks
8056
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents: 8055
diff changeset
2024
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents: 8055
diff changeset
2025 Callback functions can be associated with graphics objects and triggered
9040
dbd0c77e575e Cleanup documentation file plot.texi
Rik <rdrider0-list@yahoo.com>
parents: 9032
diff changeset
2026 after certain events occur. The basic structure of all callback function
9672
43a07df0ed4c document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents: 9316
diff changeset
2027 is
8056
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents: 8055
diff changeset
2028
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents: 8055
diff changeset
2029 @example
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents: 8055
diff changeset
2030 @group
23205
1468c2234478 Better documentation of *fcn properties
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents: 23089
diff changeset
2031 function mycallback (hsrc, evt)
24626
58dd3c2d5db8 Document and fix "busyaction" an "interruptible" properties (bug #52804).
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents: 24576
diff changeset
2032 @dots{}
8056
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents: 8055
diff changeset
2033 endfunction
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents: 8055
diff changeset
2034 @end group
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents: 8055
diff changeset
2035 @end example
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents: 8055
diff changeset
2036
10846
a4f482e66b65 Grammarcheck more of the documentation.
Rik <octave@nomad.inbox5.com>
parents: 10828
diff changeset
2037 @noindent
23563
614d71cdf614 maint: Strip trailing whitespace from files.
John W. Eaton <jwe@octave.org>
parents: 23255
diff changeset
2038 where @code{hsrc} is a handle to the source of the callback, and @code{evt}
614d71cdf614 maint: Strip trailing whitespace from files.
John W. Eaton <jwe@octave.org>
parents: 23255
diff changeset
2039 gives some event specific data.
614d71cdf614 maint: Strip trailing whitespace from files.
John W. Eaton <jwe@octave.org>
parents: 23255
diff changeset
2040
614d71cdf614 maint: Strip trailing whitespace from files.
John W. Eaton <jwe@octave.org>
parents: 23255
diff changeset
2041 The function can be provided as a function handle to a plain Octave function,
24626
58dd3c2d5db8 Document and fix "busyaction" an "interruptible" properties (bug #52804).
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents: 24576
diff changeset
2042 as an anonymous function, or as a string representing an Octave command. The
23563
614d71cdf614 maint: Strip trailing whitespace from files.
John W. Eaton <jwe@octave.org>
parents: 23255
diff changeset
2043 latter syntax is not recommended since syntax errors will only occur when the
614d71cdf614 maint: Strip trailing whitespace from files.
John W. Eaton <jwe@octave.org>
parents: 23255
diff changeset
2044 string is evaluated.
28427
7a8c69c4eb55 convert obsolete octave_fcn_inline object to @inline class
John W. Eaton <jwe@octave.org>
parents: 28136
diff changeset
2045 @xref{Function Handles and Anonymous Functions, , Function Handles section}.
23205
1468c2234478 Better documentation of *fcn properties
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents: 23089
diff changeset
2046
24626
58dd3c2d5db8 Document and fix "busyaction" an "interruptible" properties (bug #52804).
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents: 24576
diff changeset
2047 This can then be associated with an object either at the object's creation, or
58dd3c2d5db8 Document and fix "busyaction" an "interruptible" properties (bug #52804).
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents: 24576
diff changeset
2048 later with the @code{set} function. For example,
8056
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents: 8055
diff changeset
2049
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents: 8055
diff changeset
2050 @example
23205
1468c2234478 Better documentation of *fcn properties
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents: 23089
diff changeset
2051 plot (x, "DeleteFcn", @@(h, e) disp ("Window Deleted"))
8056
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents: 8055
diff changeset
2052 @end example
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents: 8055
diff changeset
2053
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents: 8055
diff changeset
2054 @noindent
24987
a895967fd5a7 doc: grammarcheck manual (*.txi) ahead of 4.4 release.
Rik <rik@octave.org>
parents: 24626
diff changeset
2055 where at the moment that the plot is deleted, the message
a895967fd5a7 doc: grammarcheck manual (*.txi) ahead of 4.4 release.
Rik <rik@octave.org>
parents: 24626
diff changeset
2056 @qcode{"Window Deleted"} will be displayed.
24626
58dd3c2d5db8 Document and fix "busyaction" an "interruptible" properties (bug #52804).
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents: 24576
diff changeset
2057
58dd3c2d5db8 Document and fix "busyaction" an "interruptible" properties (bug #52804).
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents: 24576
diff changeset
2058 Additional user arguments can be passed to callback functions, and will be
58dd3c2d5db8 Document and fix "busyaction" an "interruptible" properties (bug #52804).
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents: 24576
diff changeset
2059 passed after the two default arguments. For example:
8056
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents: 8055
diff changeset
2060
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents: 8055
diff changeset
2061 @example
9088
77e71f3da3d6 Fix documentation image printing under new development code
Rik <rdrider0-list@yahoo.com>
parents: 9040
diff changeset
2062 @group
8057
David Bateman <dbateman@free.fr>
parents: 8056
diff changeset
2063 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
2064 @dots{}
24626
58dd3c2d5db8 Document and fix "busyaction" an "interruptible" properties (bug #52804).
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents: 24576
diff changeset
2065 function mycallback (h, evt, arg1)
58dd3c2d5db8 Document and fix "busyaction" an "interruptible" properties (bug #52804).
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents: 24576
diff changeset
2066 fprintf ("Closing plot %d\n", arg1);
8056
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents: 8055
diff changeset
2067 endfunction
9088
77e71f3da3d6 Fix documentation image printing under new development code
Rik <rdrider0-list@yahoo.com>
parents: 9040
diff changeset
2068 @end group
8056
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents: 8055
diff changeset
2069 @end example
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents: 8055
diff changeset
2070
24626
58dd3c2d5db8 Document and fix "busyaction" an "interruptible" properties (bug #52804).
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents: 24576
diff changeset
2071 @strong{Caution:} The second argument in callback functions---@code{evt}---is
58dd3c2d5db8 Document and fix "busyaction" an "interruptible" properties (bug #52804).
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents: 24576
diff changeset
2072 only partially implemented in the Qt graphics toolkit:
58dd3c2d5db8 Document and fix "busyaction" an "interruptible" properties (bug #52804).
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents: 24576
diff changeset
2073
58dd3c2d5db8 Document and fix "busyaction" an "interruptible" properties (bug #52804).
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents: 24576
diff changeset
2074 @itemize @bullet
58dd3c2d5db8 Document and fix "busyaction" an "interruptible" properties (bug #52804).
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents: 24576
diff changeset
2075 @item Mouse click events:
58dd3c2d5db8 Document and fix "busyaction" an "interruptible" properties (bug #52804).
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents: 24576
diff changeset
2076 @code{evt} is a class @code{double} value: 1 for left, 2 for middle, and 3 for
58dd3c2d5db8 Document and fix "busyaction" an "interruptible" properties (bug #52804).
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents: 24576
diff changeset
2077 right click.
58dd3c2d5db8 Document and fix "busyaction" an "interruptible" properties (bug #52804).
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents: 24576
diff changeset
2078
58dd3c2d5db8 Document and fix "busyaction" an "interruptible" properties (bug #52804).
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents: 24576
diff changeset
2079 @item Key press events:
58dd3c2d5db8 Document and fix "busyaction" an "interruptible" properties (bug #52804).
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents: 24576
diff changeset
2080 @code{evt} is a structure with fields @code{Key} (string), @code{Character}
58dd3c2d5db8 Document and fix "busyaction" an "interruptible" properties (bug #52804).
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents: 24576
diff changeset
2081 (string), and @code{Modifier} (cell array of strings).
58dd3c2d5db8 Document and fix "busyaction" an "interruptible" properties (bug #52804).
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents: 24576
diff changeset
2082
58dd3c2d5db8 Document and fix "busyaction" an "interruptible" properties (bug #52804).
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents: 24576
diff changeset
2083 @item Other events:
58dd3c2d5db8 Document and fix "busyaction" an "interruptible" properties (bug #52804).
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents: 24576
diff changeset
2084 @code{evt} is a class @code{double} empty matrix.
58dd3c2d5db8 Document and fix "busyaction" an "interruptible" properties (bug #52804).
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents: 24576
diff changeset
2085 @end itemize
58dd3c2d5db8 Document and fix "busyaction" an "interruptible" properties (bug #52804).
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents: 24576
diff changeset
2086
58dd3c2d5db8 Document and fix "busyaction" an "interruptible" properties (bug #52804).
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents: 24576
diff changeset
2087 The basic callback functions that are available for all graphics objects are
8056
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents: 8055
diff changeset
2088
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents: 8055
diff changeset
2089 @itemize @bullet
23563
614d71cdf614 maint: Strip trailing whitespace from files.
John W. Eaton <jwe@octave.org>
parents: 23255
diff changeset
2090 @item CreateFcn:
614d71cdf614 maint: Strip trailing whitespace from files.
John W. Eaton <jwe@octave.org>
parents: 23255
diff changeset
2091 called at the moment of the objects creation. It is not called if the
614d71cdf614 maint: Strip trailing whitespace from files.
John W. Eaton <jwe@octave.org>
parents: 23255
diff changeset
2092 object is altered in any way, and so it only makes sense to define this
614d71cdf614 maint: Strip trailing whitespace from files.
John W. Eaton <jwe@octave.org>
parents: 23255
diff changeset
2093 callback in the function call that defines the object. Callbacks that
614d71cdf614 maint: Strip trailing whitespace from files.
John W. Eaton <jwe@octave.org>
parents: 23255
diff changeset
2094 are added to @code{CreateFcn} later with the @code{set} function will
614d71cdf614 maint: Strip trailing whitespace from files.
John W. Eaton <jwe@octave.org>
parents: 23255
diff changeset
2095 never be executed.
614d71cdf614 maint: Strip trailing whitespace from files.
John W. Eaton <jwe@octave.org>
parents: 23255
diff changeset
2096
614d71cdf614 maint: Strip trailing whitespace from files.
John W. Eaton <jwe@octave.org>
parents: 23255
diff changeset
2097 @item DeleteFcn:
23205
1468c2234478 Better documentation of *fcn properties
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents: 23089
diff changeset
2098 called at the moment an object is deleted.
1468c2234478 Better documentation of *fcn properties
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents: 23089
diff changeset
2099
23563
614d71cdf614 maint: Strip trailing whitespace from files.
John W. Eaton <jwe@octave.org>
parents: 23255
diff changeset
2100 @item ButtonDownFcn:
614d71cdf614 maint: Strip trailing whitespace from files.
John W. Eaton <jwe@octave.org>
parents: 23255
diff changeset
2101 called if a mouse button is pressed while the pointer is over this
24626
58dd3c2d5db8 Document and fix "busyaction" an "interruptible" properties (bug #52804).
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents: 24576
diff changeset
2102 object. Note, that the gnuplot interface does not implement this
23563
614d71cdf614 maint: Strip trailing whitespace from files.
John W. Eaton <jwe@octave.org>
parents: 23255
diff changeset
2103 callback.
8056
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents: 8055
diff changeset
2104 @end itemize
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents: 8055
diff changeset
2105
24626
58dd3c2d5db8 Document and fix "busyaction" an "interruptible" properties (bug #52804).
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents: 24576
diff changeset
2106 By default callback functions are queued (they are executed one after the other
58dd3c2d5db8 Document and fix "busyaction" an "interruptible" properties (bug #52804).
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents: 24576
diff changeset
2107 in the event queue) unless the @code{drawnow}, @code{figure}, @code{waitfor},
58dd3c2d5db8 Document and fix "busyaction" an "interruptible" properties (bug #52804).
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents: 24576
diff changeset
2108 @code{getframe}, or @code{pause} functions are used. If an executing callback
58dd3c2d5db8 Document and fix "busyaction" an "interruptible" properties (bug #52804).
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents: 24576
diff changeset
2109 invokes one of those functions, it causes Octave to flush the event queue,
58dd3c2d5db8 Document and fix "busyaction" an "interruptible" properties (bug #52804).
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents: 24576
diff changeset
2110 which results in the executing callback being interrupted.
58dd3c2d5db8 Document and fix "busyaction" an "interruptible" properties (bug #52804).
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents: 24576
diff changeset
2111
58dd3c2d5db8 Document and fix "busyaction" an "interruptible" properties (bug #52804).
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents: 24576
diff changeset
2112 It is possible to specify that an object's callbacks should not be interrupted
58dd3c2d5db8 Document and fix "busyaction" an "interruptible" properties (bug #52804).
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents: 24576
diff changeset
2113 by setting the object's @code{interruptible} property to @qcode{"off"}. In
58dd3c2d5db8 Document and fix "busyaction" an "interruptible" properties (bug #52804).
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents: 24576
diff changeset
2114 this case, Octave decides what to do based on the @code{busyaction} property of
58dd3c2d5db8 Document and fix "busyaction" an "interruptible" properties (bug #52804).
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents: 24576
diff changeset
2115 the @strong{interrupting} callback object:
58dd3c2d5db8 Document and fix "busyaction" an "interruptible" properties (bug #52804).
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents: 24576
diff changeset
2116
58dd3c2d5db8 Document and fix "busyaction" an "interruptible" properties (bug #52804).
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents: 24576
diff changeset
2117 @table @asis
58dd3c2d5db8 Document and fix "busyaction" an "interruptible" properties (bug #52804).
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents: 24576
diff changeset
2118 @item @code{queue} (the default)
58dd3c2d5db8 Document and fix "busyaction" an "interruptible" properties (bug #52804).
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents: 24576
diff changeset
2119 The interrupting callback is executed after the executing callback has
58dd3c2d5db8 Document and fix "busyaction" an "interruptible" properties (bug #52804).
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents: 24576
diff changeset
2120 returned.
58dd3c2d5db8 Document and fix "busyaction" an "interruptible" properties (bug #52804).
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents: 24576
diff changeset
2121
58dd3c2d5db8 Document and fix "busyaction" an "interruptible" properties (bug #52804).
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents: 24576
diff changeset
2122 @item @code{cancel}
58dd3c2d5db8 Document and fix "busyaction" an "interruptible" properties (bug #52804).
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents: 24576
diff changeset
2123 The interrupting callback is discarded.
58dd3c2d5db8 Document and fix "busyaction" an "interruptible" properties (bug #52804).
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents: 24576
diff changeset
2124 @end table
58dd3c2d5db8 Document and fix "busyaction" an "interruptible" properties (bug #52804).
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents: 24576
diff changeset
2125
58dd3c2d5db8 Document and fix "busyaction" an "interruptible" properties (bug #52804).
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents: 24576
diff changeset
2126 The @code{interruptible} property has no effect when the interrupting callback
58dd3c2d5db8 Document and fix "busyaction" an "interruptible" properties (bug #52804).
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents: 24576
diff changeset
2127 is a @code{deletefcn}, or a figure @code{resizefcn} or @code{closerequestfcn}.
58dd3c2d5db8 Document and fix "busyaction" an "interruptible" properties (bug #52804).
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents: 24576
diff changeset
2128 Those callbacks always interrupt the executing callback.
58dd3c2d5db8 Document and fix "busyaction" an "interruptible" properties (bug #52804).
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents: 24576
diff changeset
2129
58dd3c2d5db8 Document and fix "busyaction" an "interruptible" properties (bug #52804).
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents: 24576
diff changeset
2130 The handle to the object that holds the callback being executed can be
58dd3c2d5db8 Document and fix "busyaction" an "interruptible" properties (bug #52804).
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents: 24576
diff changeset
2131 obtained with the @code{gcbo} function. The handle to the ancestor figure
58dd3c2d5db8 Document and fix "busyaction" an "interruptible" properties (bug #52804).
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents: 24576
diff changeset
2132 of this object may be obtained using the @code{gcbf} function.
8056
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents: 8055
diff changeset
2133
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents: 8055
diff changeset
2134 @DOCSTRING(gcbo)
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents: 8055
diff changeset
2135
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents: 8055
diff changeset
2136 @DOCSTRING(gcbf)
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents: 8055
diff changeset
2137
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents: 8055
diff changeset
2138 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
2139 function described below.
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents: 8055
diff changeset
2140
12525
d36266a54202 Add getappdata, setappdata, isappdata, rmappdata functions to documentation.
Rik <octave@nomad.inbox5.com>
parents: 12522
diff changeset
2141 @node Application-defined Data
17152
f2a8592b8fbd doc: Shorten some long subsection names in Manual.
Rik <rik@octave.org>
parents: 17123
diff changeset
2142 @subsection Application-defined Data
12578
f5a780d675a1 Clean up operator and function indices in documentation.
Rik <octave@nomad.inbox5.com>
parents: 12577
diff changeset
2143 @cindex application-defined data
12525
d36266a54202 Add getappdata, setappdata, isappdata, rmappdata functions to documentation.
Rik <octave@nomad.inbox5.com>
parents: 12522
diff changeset
2144
d36266a54202 Add getappdata, setappdata, isappdata, rmappdata functions to documentation.
Rik <octave@nomad.inbox5.com>
parents: 12522
diff changeset
2145 Octave has a provision for attaching application-defined data to a graphics
d36266a54202 Add getappdata, setappdata, isappdata, rmappdata functions to documentation.
Rik <octave@nomad.inbox5.com>
parents: 12522
diff changeset
2146 handle. The data can be anything which is meaningful to the application, and
d36266a54202 Add getappdata, setappdata, isappdata, rmappdata functions to documentation.
Rik <octave@nomad.inbox5.com>
parents: 12522
diff changeset
2147 will be completely ignored by Octave.
d36266a54202 Add getappdata, setappdata, isappdata, rmappdata functions to documentation.
Rik <octave@nomad.inbox5.com>
parents: 12522
diff changeset
2148
d36266a54202 Add getappdata, setappdata, isappdata, rmappdata functions to documentation.
Rik <octave@nomad.inbox5.com>
parents: 12522
diff changeset
2149 @DOCSTRING(setappdata)
d36266a54202 Add getappdata, setappdata, isappdata, rmappdata functions to documentation.
Rik <octave@nomad.inbox5.com>
parents: 12522
diff changeset
2150
d36266a54202 Add getappdata, setappdata, isappdata, rmappdata functions to documentation.
Rik <octave@nomad.inbox5.com>
parents: 12522
diff changeset
2151 @DOCSTRING(getappdata)
d36266a54202 Add getappdata, setappdata, isappdata, rmappdata functions to documentation.
Rik <octave@nomad.inbox5.com>
parents: 12522
diff changeset
2152
d36266a54202 Add getappdata, setappdata, isappdata, rmappdata functions to documentation.
Rik <octave@nomad.inbox5.com>
parents: 12522
diff changeset
2153 @DOCSTRING(rmappdata)
d36266a54202 Add getappdata, setappdata, isappdata, rmappdata functions to documentation.
Rik <octave@nomad.inbox5.com>
parents: 12522
diff changeset
2154
d36266a54202 Add getappdata, setappdata, isappdata, rmappdata functions to documentation.
Rik <octave@nomad.inbox5.com>
parents: 12522
diff changeset
2155 @DOCSTRING(isappdata)
d36266a54202 Add getappdata, setappdata, isappdata, rmappdata functions to documentation.
Rik <octave@nomad.inbox5.com>
parents: 12522
diff changeset
2156
8056
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents: 8055
diff changeset
2157 @node Object Groups
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents: 8055
diff changeset
2158 @subsection Object Groups
8071
b6e85fb238c1 doc fixes
John W. Eaton <jwe@octave.org>
parents: 8070
diff changeset
2159 @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
2160
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents: 8055
diff changeset
2161 A number of Octave high level plot functions return groups of other
9672
43a07df0ed4c document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents: 9316
diff changeset
2162 graphics objects or they return graphics objects that have their
8056
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents: 8055
diff changeset
2163 properties linked in such a way that changes to one of the properties
9040
dbd0c77e575e Cleanup documentation file plot.texi
Rik <rdrider0-list@yahoo.com>
parents: 9032
diff changeset
2164 results in changes in the others. A graphic object that groups other
8056
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents: 8055
diff changeset
2165 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
2166
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents: 8055
diff changeset
2167 @DOCSTRING(hggroup)
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents: 8055
diff changeset
2168
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents: 8055
diff changeset
2169 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
2170
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents: 8055
diff changeset
2171 @example
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents: 8055
diff changeset
2172 @group
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents: 8055
diff changeset
2173 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
2174 hg = hggroup ();
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents: 8055
diff changeset
2175 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
2176 hold on
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents: 8055
diff changeset
2177 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
2178 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
2179 @end group
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents: 8055
diff changeset
2180 @end example
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents: 8055
diff changeset
2181
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents: 8055
diff changeset
2182 @noindent
9040
dbd0c77e575e Cleanup documentation file plot.texi
Rik <rdrider0-list@yahoo.com>
parents: 9032
diff changeset
2183 which groups the two plots into a single object and controls their
dbd0c77e575e Cleanup documentation file plot.texi
Rik <rdrider0-list@yahoo.com>
parents: 9032
diff changeset
2184 visibility directly. The default properties of an @code{hggroup} are
8056
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents: 8055
diff changeset
2185 the same as the set of common properties for the other graphics
9040
dbd0c77e575e Cleanup documentation file plot.texi
Rik <rdrider0-list@yahoo.com>
parents: 9032
diff changeset
2186 objects. Additional properties can be added with the @code{addproperty}
9672
43a07df0ed4c document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents: 9316
diff changeset
2187 function.
8056
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents: 8055
diff changeset
2188
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents: 8055
diff changeset
2189 @DOCSTRING(addproperty)
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents: 8055
diff changeset
2190
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents: 8055
diff changeset
2191 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
2192 other property of either the children of the group, or any other
9040
dbd0c77e575e Cleanup documentation file plot.texi
Rik <rdrider0-list@yahoo.com>
parents: 9032
diff changeset
2193 graphics object. Add so to control the way in which this newly added
8056
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents: 8055
diff changeset
2194 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
2195 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
2196
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents: 8055
diff changeset
2197 @DOCSTRING(addlistener)
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents: 8055
diff changeset
2198
8817
03b7f618ab3d include docstrings for new functions in the manual
John W. Eaton <jwe@octave.org>
parents: 8519
diff changeset
2199 @DOCSTRING(dellistener)
03b7f618ab3d include docstrings for new functions in the manual
John W. Eaton <jwe@octave.org>
parents: 8519
diff changeset
2200
8056
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents: 8055
diff changeset
2201 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
2202
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents: 8055
diff changeset
2203 @example
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents: 8055
diff changeset
2204 @group
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents: 8055
diff changeset
2205 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
2206 hg = hggroup ();
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents: 8055
diff changeset
2207 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
2208 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
2209 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
2210 hold on
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents: 8055
diff changeset
2211 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
2212
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents: 8055
diff changeset
2213 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
2214 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
2215 endfunction
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents: 8055
diff changeset
2216 @end group
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents: 8055
diff changeset
2217 @end example
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents: 8055
diff changeset
2218
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents: 8055
diff changeset
2219 @noindent
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents: 8055
diff changeset
2220 that adds a @code{linestyle} property to the @code{hggroup} and
9040
dbd0c77e575e Cleanup documentation file plot.texi
Rik <rdrider0-list@yahoo.com>
parents: 9032
diff changeset
2221 propagating any changes its value to the children of the group. The
8070
3b53b25e2550 Add data sources and line series
David Bateman <dbateman@free.fr>
parents: 8057
diff changeset
2222 @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
2223
3b53b25e2550 Add data sources and line series
David Bateman <dbateman@free.fr>
parents: 8057
diff changeset
2224 @example
3b53b25e2550 Add data sources and line series
David Bateman <dbateman@free.fr>
parents: 8057
diff changeset
2225 @group
3b53b25e2550 Add data sources and line series
David Bateman <dbateman@free.fr>
parents: 8057
diff changeset
2226 x = 0:0.1:10;
3b53b25e2550 Add data sources and line series
David Bateman <dbateman@free.fr>
parents: 8057
diff changeset
2227 hg = hggroup ();
3b53b25e2550 Add data sources and line series
David Bateman <dbateman@free.fr>
parents: 8057
diff changeset
2228 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
2229 addproperty ("linestyle", hg, "linelinestyle", get (h, "linestyle"));
3b53b25e2550 Add data sources and line series
David Bateman <dbateman@free.fr>
parents: 8057
diff changeset
2230 hold on
3b53b25e2550 Add data sources and line series
David Bateman <dbateman@free.fr>
parents: 8057
diff changeset
2231 h2 = plot (x, cos (x), "color", [0, 1, 0], "parent", hg);
9672
43a07df0ed4c document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents: 9316
diff changeset
2232 hlink = linkprop ([hg, h1, h2], "color");
8070
3b53b25e2550 Add data sources and line series
David Bateman <dbateman@free.fr>
parents: 8057
diff changeset
2233 @end group
3b53b25e2550 Add data sources and line series
David Bateman <dbateman@free.fr>
parents: 8057
diff changeset
2234 @end example
3b53b25e2550 Add data sources and line series
David Bateman <dbateman@free.fr>
parents: 8057
diff changeset
2235
3b53b25e2550 Add data sources and line series
David Bateman <dbateman@free.fr>
parents: 8057
diff changeset
2236 @DOCSTRING(linkprop)
8056
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents: 8055
diff changeset
2237
18729
d1750be79dee linkaxes.m: Implement new function linkaxes.
Willem Atsma <willem.atsma@tanglebridge.com>
parents: 18580
diff changeset
2238 @DOCSTRING(linkaxes)
d1750be79dee linkaxes.m: Implement new function linkaxes.
Willem Atsma <willem.atsma@tanglebridge.com>
parents: 18580
diff changeset
2239
9672
43a07df0ed4c document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents: 9316
diff changeset
2240 These capabilities are used in a number of basic graphics objects.
8056
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents: 8055
diff changeset
2241 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
2242 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
2243
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents: 8055
diff changeset
2244 @itemize @bullet
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents: 8055
diff changeset
2245 @item group together multiple graphics objects,
10828
322f43e0e170 Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents: 10711
diff changeset
2246
8056
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents: 8055
diff changeset
2247 @item create linked properties between different graphics objects, and
10828
322f43e0e170 Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents: 10711
diff changeset
2248
8056
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents: 8055
diff changeset
2249 @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
2250 @end itemize
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents: 8055
diff changeset
2251
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents: 8055
diff changeset
2252 @noindent
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents: 8055
diff changeset
2253 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
2254 @code{hggroup} of the stem series contains two line objects representing
9040
dbd0c77e575e Cleanup documentation file plot.texi
Rik <rdrider0-list@yahoo.com>
parents: 9032
diff changeset
2255 the body and head of the stem. The @code{ydata} property of the
8056
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents: 8055
diff changeset
2256 @code{hggroup} of the stem series represents the head of the stem,
9040
dbd0c77e575e Cleanup documentation file plot.texi
Rik <rdrider0-list@yahoo.com>
parents: 9032
diff changeset
2257 whereas the body of the stem is between the baseline and this value. For
8056
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents: 8055
diff changeset
2258 example
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents: 8055
diff changeset
2259
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents: 8055
diff changeset
2260 @example
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents: 8055
diff changeset
2261 @group
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents: 8055
diff changeset
2262 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
2263 get (h, "xdata")
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents: 8055
diff changeset
2264 @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
2265 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
2266 @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
2267 @end group
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents: 8055
diff changeset
2268 @end example
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents: 8055
diff changeset
2269
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents: 8055
diff changeset
2270 @noindent
9040
dbd0c77e575e Cleanup documentation file plot.texi
Rik <rdrider0-list@yahoo.com>
parents: 9032
diff changeset
2271 shows the difference between the @code{xdata} of the @code{hggroup}
8056
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents: 8055
diff changeset
2272 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
2273
9672
43a07df0ed4c document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents: 9316
diff changeset
2274 The basic properties of such group objects is that they consist of one
8056
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents: 8055
diff changeset
2275 or more linked @code{hggroup}, and that changes in certain properties of
9040
dbd0c77e575e Cleanup documentation file plot.texi
Rik <rdrider0-list@yahoo.com>
parents: 9032
diff changeset
2276 these groups are propagated to other members of the group. Whereas,
8056
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents: 8055
diff changeset
2277 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
2278 member.
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents: 8055
diff changeset
2279
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents: 8055
diff changeset
2280 In addition the members of the group can also be linked to other
9040
dbd0c77e575e Cleanup documentation file plot.texi
Rik <rdrider0-list@yahoo.com>
parents: 9032
diff changeset
2281 graphics objects through callback functions. For example the baseline of
8056
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents: 8055
diff changeset
2282 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
2283 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
2284 corresponding hggroup elements.
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents: 8055
diff changeset
2285
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents: 8055
diff changeset
2286 @menu
17152
f2a8592b8fbd doc: Shorten some long subsection names in Manual.
Rik <rik@octave.org>
parents: 17123
diff changeset
2287 * Data Sources in Object Groups::
f2a8592b8fbd doc: Shorten some long subsection names in Manual.
Rik <rik@octave.org>
parents: 17123
diff changeset
2288 * Area Series::
f2a8592b8fbd doc: Shorten some long subsection names in Manual.
Rik <rik@octave.org>
parents: 17123
diff changeset
2289 * Bar Series::
f2a8592b8fbd doc: Shorten some long subsection names in Manual.
Rik <rik@octave.org>
parents: 17123
diff changeset
2290 * Contour Groups::
f2a8592b8fbd doc: Shorten some long subsection names in Manual.
Rik <rik@octave.org>
parents: 17123
diff changeset
2291 * Error Bar Series::
f2a8592b8fbd doc: Shorten some long subsection names in Manual.
Rik <rik@octave.org>
parents: 17123
diff changeset
2292 * Line Series::
f2a8592b8fbd doc: Shorten some long subsection names in Manual.
Rik <rik@octave.org>
parents: 17123
diff changeset
2293 * Quiver Group::
f2a8592b8fbd doc: Shorten some long subsection names in Manual.
Rik <rik@octave.org>
parents: 17123
diff changeset
2294 * Stair Group::
f2a8592b8fbd doc: Shorten some long subsection names in Manual.
Rik <rik@octave.org>
parents: 17123
diff changeset
2295 * Stem Series::
f2a8592b8fbd doc: Shorten some long subsection names in Manual.
Rik <rik@octave.org>
parents: 17123
diff changeset
2296 * Surface Group::
8056
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents: 8055
diff changeset
2297 @end menu
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents: 8055
diff changeset
2298
11257
8d4c57258523 fix some menu problems in the manual
John W. Eaton <jwe@octave.org>
parents: 11255
diff changeset
2299 @node Data Sources in Object Groups
8d4c57258523 fix some menu problems in the manual
John W. Eaton <jwe@octave.org>
parents: 11255
diff changeset
2300 @subsubsection Data Sources in Object Groups
8071
b6e85fb238c1 doc fixes
John W. Eaton <jwe@octave.org>
parents: 8070
diff changeset
2301 @cindex data sources in object groups
31574
05a1b9a60efa doc: Avoid use of formatting Texinfo macros (e.g., @code) inside @menu, @xref macros.
Rik <rik@octave.org>
parents: 30564
diff changeset
2302
9040
dbd0c77e575e Cleanup documentation file plot.texi
Rik <rdrider0-list@yahoo.com>
parents: 9032
diff changeset
2303 All of the group objects contain data source parameters. There are
8070
3b53b25e2550 Add data sources and line series
David Bateman <dbateman@free.fr>
parents: 8057
diff changeset
2304 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
2305 the relevant data property of the group when the @code{refreshdata}
9672
43a07df0ed4c document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents: 9316
diff changeset
2306 function is called.
8070
3b53b25e2550 Add data sources and line series
David Bateman <dbateman@free.fr>
parents: 8057
diff changeset
2307
3b53b25e2550 Add data sources and line series
David Bateman <dbateman@free.fr>
parents: 8057
diff changeset
2308 @DOCSTRING(refreshdata)
3b53b25e2550 Add data sources and line series
David Bateman <dbateman@free.fr>
parents: 8057
diff changeset
2309
17097
e7a059a9a644 doc: Use XREF as anchor prefix in documentation for clearer results in Info viewer.
Rik <rik@octave.org>
parents: 16923
diff changeset
2310 @anchor{XREFlinkdata}
8070
3b53b25e2550 Add data sources and line series
David Bateman <dbateman@free.fr>
parents: 8057
diff changeset
2311 @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
2312 @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
2313 @c command
8070
3b53b25e2550 Add data sources and line series
David Bateman <dbateman@free.fr>
parents: 8057
diff changeset
2314
11257
8d4c57258523 fix some menu problems in the manual
John W. Eaton <jwe@octave.org>
parents: 11255
diff changeset
2315 @node Area Series
8d4c57258523 fix some menu problems in the manual
John W. Eaton <jwe@octave.org>
parents: 11255
diff changeset
2316 @subsubsection Area Series
8071
b6e85fb238c1 doc fixes
John W. Eaton <jwe@octave.org>
parents: 8070
diff changeset
2317 @cindex series objects
b6e85fb238c1 doc fixes
John W. Eaton <jwe@octave.org>
parents: 8070
diff changeset
2318 @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
2319
9040
dbd0c77e575e Cleanup documentation file plot.texi
Rik <rdrider0-list@yahoo.com>
parents: 9032
diff changeset
2320 Area series objects are created by the @code{area} function. Each of the
dbd0c77e575e Cleanup documentation file plot.texi
Rik <rdrider0-list@yahoo.com>
parents: 9032
diff changeset
2321 @code{hggroup} elements contains a single patch object. The properties
8056
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents: 8055
diff changeset
2322 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
2323
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents: 8055
diff changeset
2324 @table @code
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents: 8055
diff changeset
2325 @item basevalue
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents: 8055
diff changeset
2326 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
2327
17170
d6499c14021c doc: Periodic grammarcheck of documentation.
Rik <rik@octave.org>
parents: 17152
diff changeset
2328 @item linewidth
8056
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents: 8055
diff changeset
2329 @itemx linestyle
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents: 8055
diff changeset
2330 The line width and style of the edge of the patch objects making up the
9040
dbd0c77e575e Cleanup documentation file plot.texi
Rik <rdrider0-list@yahoo.com>
parents: 9032
diff changeset
2331 areas. @xref{Line Styles}.
8056
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents: 8055
diff changeset
2332
17170
d6499c14021c doc: Periodic grammarcheck of documentation.
Rik <rik@octave.org>
parents: 17152
diff changeset
2333 @item edgecolor
8056
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents: 8055
diff changeset
2334 @itemx facecolor
17469
710b3d5fe966 improve interpreter tex Tables
Michael Godfrey <michaeldgodfrey@gmail.com>
parents: 17281
diff changeset
2335 The line and fill color of the patch objects making up the areas.
10828
322f43e0e170 Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents: 10711
diff changeset
2336 @xref{Colors}.
8056
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents: 8055
diff changeset
2337
17170
d6499c14021c doc: Periodic grammarcheck of documentation.
Rik <rik@octave.org>
parents: 17152
diff changeset
2338 @item xdata
8056
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents: 8055
diff changeset
2339 @itemx ydata
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents: 8055
diff changeset
2340 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
2341 @code{area} prior to the cumulative summation used in the @code{area}
9672
43a07df0ed4c document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents: 9316
diff changeset
2342 function.
8070
3b53b25e2550 Add data sources and line series
David Bateman <dbateman@free.fr>
parents: 8057
diff changeset
2343
17170
d6499c14021c doc: Periodic grammarcheck of documentation.
Rik <rik@octave.org>
parents: 17152
diff changeset
2344 @item xdatasource
8070
3b53b25e2550 Add data sources and line series
David Bateman <dbateman@free.fr>
parents: 8057
diff changeset
2345 @itemx ydatasource
3b53b25e2550 Add data sources and line series
David Bateman <dbateman@free.fr>
parents: 8057
diff changeset
2346 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
2347 @end table
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents: 8055
diff changeset
2348
11257
8d4c57258523 fix some menu problems in the manual
John W. Eaton <jwe@octave.org>
parents: 11255
diff changeset
2349 @node Bar Series
8d4c57258523 fix some menu problems in the manual
John W. Eaton <jwe@octave.org>
parents: 11255
diff changeset
2350 @subsubsection Bar Series
8071
b6e85fb238c1 doc fixes
John W. Eaton <jwe@octave.org>
parents: 8070
diff changeset
2351 @cindex series objects
b6e85fb238c1 doc fixes
John W. Eaton <jwe@octave.org>
parents: 8070
diff changeset
2352 @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
2353
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents: 8055
diff changeset
2354 Bar series objects are created by the @code{bar} or @code{barh}
9672
43a07df0ed4c document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents: 9316
diff changeset
2355 functions. Each @code{hggroup} element contains a single patch object.
8056
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents: 8055
diff changeset
2356 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
2357
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents: 8055
diff changeset
2358 @table @code
17170
d6499c14021c doc: Periodic grammarcheck of documentation.
Rik <rik@octave.org>
parents: 17152
diff changeset
2359 @item showbaseline
8056
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents: 8055
diff changeset
2360 @itemx baseline
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents: 8055
diff changeset
2361 @itemx basevalue
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents: 8055
diff changeset
2362 The property @code{showbaseline} flags whether the baseline of the bar
17281
bc924baa2c4e doc: Add new @qcode macro for code samples which are quoted.
Rik <rik@octave.org>
parents: 17170
diff changeset
2363 series is displayed (default is @qcode{"on"}). The handle of the graphics
bc924baa2c4e doc: Add new @qcode macro for code samples which are quoted.
Rik <rik@octave.org>
parents: 17170
diff changeset
2364 object representing the baseline is given by the @code{baseline} property and
9672
43a07df0ed4c document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents: 9316
diff changeset
2365 the y-value of the baseline by the @code{basevalue} property.
8056
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents: 8055
diff changeset
2366
18330
200851c87444 Edits to Manual and indicies
Michael Godfrey <michaeldgodfrey@gmail.com>
parents: 17957
diff changeset
2367 Changes to any of these properties are propagated to the other members of
200851c87444 Edits to Manual and indicies
Michael Godfrey <michaeldgodfrey@gmail.com>
parents: 17957
diff changeset
2368 the bar series and to the baseline itself. Equally, changes in the
8056
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents: 8055
diff changeset
2369 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
2370 corresponding bar series.
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents: 8055
diff changeset
2371
17170
d6499c14021c doc: Periodic grammarcheck of documentation.
Rik <rik@octave.org>
parents: 17152
diff changeset
2372 @item barwidth
8056
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents: 8055
diff changeset
2373 @itemx barlayout
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents: 8055
diff changeset
2374 @itemx horizontal
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents: 8055
diff changeset
2375 The property @code{barwidth} is the width of the bar corresponding to
9040
dbd0c77e575e Cleanup documentation file plot.texi
Rik <rdrider0-list@yahoo.com>
parents: 9032
diff changeset
2376 the @var{width} variable passed to @code{bar} or @var{barh}. Whether the
17281
bc924baa2c4e doc: Add new @qcode macro for code samples which are quoted.
Rik <rik@octave.org>
parents: 17170
diff changeset
2377 bar series is @qcode{"grouped"} or @qcode{"stacked"} is determined by the
8056
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents: 8055
diff changeset
2378 @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
2379 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
2380
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents: 8055
diff changeset
2381 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
2382 the bar series.
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents: 8055
diff changeset
2383
17170
d6499c14021c doc: Periodic grammarcheck of documentation.
Rik <rik@octave.org>
parents: 17152
diff changeset
2384 @item linewidth
8056
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents: 8055
diff changeset
2385 @itemx linestyle
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents: 8055
diff changeset
2386 The line width and style of the edge of the patch objects making up the
9040
dbd0c77e575e Cleanup documentation file plot.texi
Rik <rdrider0-list@yahoo.com>
parents: 9032
diff changeset
2387 bars. @xref{Line Styles}.
8056
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents: 8055
diff changeset
2388
17170
d6499c14021c doc: Periodic grammarcheck of documentation.
Rik <rik@octave.org>
parents: 17152
diff changeset
2389 @item edgecolor
8056
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents: 8055
diff changeset
2390 @itemx facecolor
22299
9fc91bb2aec3 doc: grammarcheck documentation for 4.2 release.
Rik <rik@octave.org>
parents: 22288
diff changeset
2391 The line and fill color of the patch objects making up the bars.
9fc91bb2aec3 doc: grammarcheck documentation for 4.2 release.
Rik <rik@octave.org>
parents: 22288
diff changeset
2392 @xref{Colors}.
8056
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents: 8055
diff changeset
2393
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents: 8055
diff changeset
2394 @item xdata
9040
dbd0c77e575e Cleanup documentation file plot.texi
Rik <rdrider0-list@yahoo.com>
parents: 9032
diff changeset
2395 The nominal x positions of the bars. Changes in this property and
9672
43a07df0ed4c document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents: 9316
diff changeset
2396 propagated to the other members of the bar series.
8056
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents: 8055
diff changeset
2397
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents: 8055
diff changeset
2398 @item ydata
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents: 8055
diff changeset
2399 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
2400
17170
d6499c14021c doc: Periodic grammarcheck of documentation.
Rik <rik@octave.org>
parents: 17152
diff changeset
2401 @item xdatasource
8070
3b53b25e2550 Add data sources and line series
David Bateman <dbateman@free.fr>
parents: 8057
diff changeset
2402 @itemx ydatasource
3b53b25e2550 Add data sources and line series
David Bateman <dbateman@free.fr>
parents: 8057
diff changeset
2403 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
2404 @end table
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents: 8055
diff changeset
2405
11257
8d4c57258523 fix some menu problems in the manual
John W. Eaton <jwe@octave.org>
parents: 11255
diff changeset
2406 @node Contour Groups
8d4c57258523 fix some menu problems in the manual
John W. Eaton <jwe@octave.org>
parents: 11255
diff changeset
2407 @subsubsection Contour Groups
8071
b6e85fb238c1 doc fixes
John W. Eaton <jwe@octave.org>
parents: 8070
diff changeset
2408 @cindex series objects
b6e85fb238c1 doc fixes
John W. Eaton <jwe@octave.org>
parents: 8070
diff changeset
2409 @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
2410
24575
93714122ed59 doc: Fixes for signal, image, audio, and OOP chapters (bug #52844).
Rik <rik@octave.org>
parents: 24181
diff changeset
2411 Contour group objects are created by the @code{contour}, @code{contourf}, and
25578
32ddc111ff49 doc: small fixes to size() and plot.txi (bug #54283).
Rik <rik@octave.org>
parents: 25054
diff changeset
2412 @code{contour3} functions. They are also one of the handles returned by the
24575
93714122ed59 doc: Fixes for signal, image, audio, and OOP chapters (bug #52844).
Rik <rik@octave.org>
parents: 24181
diff changeset
2413 @code{surfc} and @code{meshc} functions. The properties of the contour group
93714122ed59 doc: Fixes for signal, image, audio, and OOP chapters (bug #52844).
Rik <rik@octave.org>
parents: 24181
diff changeset
2414 are
8289
ac7f334d9652 Add contour group objects and the clabel function
David Bateman <dbateman@free.fr>
parents: 8286
diff changeset
2415
ac7f334d9652 Add contour group objects and the clabel function
David Bateman <dbateman@free.fr>
parents: 8286
diff changeset
2416 @table @code
ac7f334d9652 Add contour group objects and the clabel function
David Bateman <dbateman@free.fr>
parents: 8286
diff changeset
2417 @item contourmatrix
ac7f334d9652 Add contour group objects and the clabel function
David Bateman <dbateman@free.fr>
parents: 8286
diff changeset
2418 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
2419 create the contours of the plot.
ac7f334d9652 Add contour group objects and the clabel function
David Bateman <dbateman@free.fr>
parents: 8286
diff changeset
2420
ac7f334d9652 Add contour group objects and the clabel function
David Bateman <dbateman@free.fr>
parents: 8286
diff changeset
2421 @item fill
17281
bc924baa2c4e doc: Add new @qcode macro for code samples which are quoted.
Rik <rik@octave.org>
parents: 17170
diff changeset
2422 A radio property that can have the values @qcode{"on"} or @qcode{"off"} that
bc924baa2c4e doc: Add new @qcode macro for code samples which are quoted.
Rik <rik@octave.org>
parents: 17170
diff changeset
2423 flags whether the contours to plot are to be filled.
8289
ac7f334d9652 Add contour group objects and the clabel function
David Bateman <dbateman@free.fr>
parents: 8286
diff changeset
2424
17170
d6499c14021c doc: Periodic grammarcheck of documentation.
Rik <rik@octave.org>
parents: 17152
diff changeset
2425 @item zlevelmode
8289
ac7f334d9652 Add contour group objects and the clabel function
David Bateman <dbateman@free.fr>
parents: 8286
diff changeset
2426 @itemx zlevel
17281
bc924baa2c4e doc: Add new @qcode macro for code samples which are quoted.
Rik <rik@octave.org>
parents: 17170
diff changeset
2427 The radio property @code{zlevelmode} can have the values @qcode{"none"},
bc924baa2c4e doc: Add new @qcode macro for code samples which are quoted.
Rik <rik@octave.org>
parents: 17170
diff changeset
2428 @qcode{"auto"}, or @qcode{"manual"}. When its value is @qcode{"none"} there is
bc924baa2c4e doc: Add new @qcode macro for code samples which are quoted.
Rik <rik@octave.org>
parents: 17170
diff changeset
2429 no z component to the plotted contours. When its value is @qcode{"auto"} the z
bc924baa2c4e doc: Add new @qcode macro for code samples which are quoted.
Rik <rik@octave.org>
parents: 17170
diff changeset
2430 value of the plotted contours is at the same value as the contour itself. If
bc924baa2c4e doc: Add new @qcode macro for code samples which are quoted.
Rik <rik@octave.org>
parents: 17170
diff changeset
2431 the value is @qcode{"manual"}, then the z value at which to plot the contour is
bc924baa2c4e doc: Add new @qcode macro for code samples which are quoted.
Rik <rik@octave.org>
parents: 17170
diff changeset
2432 determined by the @code{zlevel} property.
8289
ac7f334d9652 Add contour group objects and the clabel function
David Bateman <dbateman@free.fr>
parents: 8286
diff changeset
2433
17170
d6499c14021c doc: Periodic grammarcheck of documentation.
Rik <rik@octave.org>
parents: 17152
diff changeset
2434 @item levellistmode
8289
ac7f334d9652 Add contour group objects and the clabel function
David Bateman <dbateman@free.fr>
parents: 8286
diff changeset
2435 @itemx levellist
ac7f334d9652 Add contour group objects and the clabel function
David Bateman <dbateman@free.fr>
parents: 8286
diff changeset
2436 @itemx levelstepmode
ac7f334d9652 Add contour group objects and the clabel function
David Bateman <dbateman@free.fr>
parents: 8286
diff changeset
2437 @itemx levelstep
17281
bc924baa2c4e doc: Add new @qcode macro for code samples which are quoted.
Rik <rik@octave.org>
parents: 17170
diff changeset
2438 If @code{levellistmode} is @qcode{"manual"}, then the levels at which to plot
bc924baa2c4e doc: Add new @qcode macro for code samples which are quoted.
Rik <rik@octave.org>
parents: 17170
diff changeset
2439 the contours is determined by @code{levellist}. If @code{levellistmode} is set
bc924baa2c4e doc: Add new @qcode macro for code samples which are quoted.
Rik <rik@octave.org>
parents: 17170
diff changeset
2440 to @qcode{"auto"}, then the distance between contours is determined by
bc924baa2c4e doc: Add new @qcode macro for code samples which are quoted.
Rik <rik@octave.org>
parents: 17170
diff changeset
2441 @code{levelstep}. If both @code{levellistmode} and @code{levelstepmode} are
bc924baa2c4e doc: Add new @qcode macro for code samples which are quoted.
Rik <rik@octave.org>
parents: 17170
diff changeset
2442 set to @qcode{"auto"}, then there are assumed to be 10 equal spaced contours.
8289
ac7f334d9652 Add contour group objects and the clabel function
David Bateman <dbateman@free.fr>
parents: 8286
diff changeset
2443
17170
d6499c14021c doc: Periodic grammarcheck of documentation.
Rik <rik@octave.org>
parents: 17152
diff changeset
2444 @item textlistmode
8289
ac7f334d9652 Add contour group objects and the clabel function
David Bateman <dbateman@free.fr>
parents: 8286
diff changeset
2445 @itemx textlist
ac7f334d9652 Add contour group objects and the clabel function
David Bateman <dbateman@free.fr>
parents: 8286
diff changeset
2446 @itemx textstepmode
ac7f334d9652 Add contour group objects and the clabel function
David Bateman <dbateman@free.fr>
parents: 8286
diff changeset
2447 @itemx textstep
17281
bc924baa2c4e doc: Add new @qcode macro for code samples which are quoted.
Rik <rik@octave.org>
parents: 17170
diff changeset
2448 If @code{textlistmode} is @qcode{"manual"}, then the labeled contours
9672
43a07df0ed4c document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents: 9316
diff changeset
2449 is determined by @code{textlist}. If @code{textlistmode} is set to
17281
bc924baa2c4e doc: Add new @qcode macro for code samples which are quoted.
Rik <rik@octave.org>
parents: 17170
diff changeset
2450 @qcode{"auto"}, then the distance between labeled contours is determined by
9040
dbd0c77e575e Cleanup documentation file plot.texi
Rik <rdrider0-list@yahoo.com>
parents: 9032
diff changeset
2451 @code{textstep}. If both @code{textlistmode} and @code{textstepmode}
17281
bc924baa2c4e doc: Add new @qcode macro for code samples which are quoted.
Rik <rik@octave.org>
parents: 17170
diff changeset
2452 are set to @qcode{"auto"}, then there are assumed to be 10 equal spaced
9672
43a07df0ed4c document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents: 9316
diff changeset
2453 labeled contours.
8289
ac7f334d9652 Add contour group objects and the clabel function
David Bateman <dbateman@free.fr>
parents: 8286
diff changeset
2454
ac7f334d9652 Add contour group objects and the clabel function
David Bateman <dbateman@free.fr>
parents: 8286
diff changeset
2455 @item showtext
ac7f334d9652 Add contour group objects and the clabel function
David Bateman <dbateman@free.fr>
parents: 8286
diff changeset
2456 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
2457
ac7f334d9652 Add contour group objects and the clabel function
David Bateman <dbateman@free.fr>
parents: 8286
diff changeset
2458 @item labelspacing
ac7f334d9652 Add contour group objects and the clabel function
David Bateman <dbateman@free.fr>
parents: 8286
diff changeset
2459 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
2460
ac7f334d9652 Add contour group objects and the clabel function
David Bateman <dbateman@free.fr>
parents: 8286
diff changeset
2461 @item linewidth
10828
322f43e0e170 Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents: 10711
diff changeset
2462
8289
ac7f334d9652 Add contour group objects and the clabel function
David Bateman <dbateman@free.fr>
parents: 8286
diff changeset
2463 @item linestyle
10828
322f43e0e170 Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents: 10711
diff changeset
2464
8289
ac7f334d9652 Add contour group objects and the clabel function
David Bateman <dbateman@free.fr>
parents: 8286
diff changeset
2465 @item linecolor
9040
dbd0c77e575e Cleanup documentation file plot.texi
Rik <rdrider0-list@yahoo.com>
parents: 9032
diff changeset
2466 The properties of the contour lines. The properties @code{linewidth} and
dbd0c77e575e Cleanup documentation file plot.texi
Rik <rdrider0-list@yahoo.com>
parents: 9032
diff changeset
2467 @code{linestyle} are similar to the corresponding properties for lines. The
8297
dc62132651db doc fixes
John W. Eaton <jwe@octave.org>
parents: 8289
diff changeset
2468 property @code{linecolor} is a color property (@pxref{Colors}), that can also
17281
bc924baa2c4e doc: Add new @qcode macro for code samples which are quoted.
Rik <rik@octave.org>
parents: 17170
diff changeset
2469 have the values of @qcode{"none"} or @qcode{"auto"}. If @code{linecolor} is
bc924baa2c4e doc: Add new @qcode macro for code samples which are quoted.
Rik <rik@octave.org>
parents: 17170
diff changeset
2470 @qcode{"none"}, then no contour line is drawn. If @code{linecolor} is
bc924baa2c4e doc: Add new @qcode macro for code samples which are quoted.
Rik <rik@octave.org>
parents: 17170
diff changeset
2471 @qcode{"auto"} then the line color is determined by the colormap.
8289
ac7f334d9652 Add contour group objects and the clabel function
David Bateman <dbateman@free.fr>
parents: 8286
diff changeset
2472
17170
d6499c14021c doc: Periodic grammarcheck of documentation.
Rik <rik@octave.org>
parents: 17152
diff changeset
2473 @item xdata
8289
ac7f334d9652 Add contour group objects and the clabel function
David Bateman <dbateman@free.fr>
parents: 8286
diff changeset
2474 @itemx ydata
ac7f334d9652 Add contour group objects and the clabel function
David Bateman <dbateman@free.fr>
parents: 8286
diff changeset
2475 @itemx zdata
ac7f334d9652 Add contour group objects and the clabel function
David Bateman <dbateman@free.fr>
parents: 8286
diff changeset
2476 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
2477
17170
d6499c14021c doc: Periodic grammarcheck of documentation.
Rik <rik@octave.org>
parents: 17152
diff changeset
2478 @item xdatasource
8289
ac7f334d9652 Add contour group objects and the clabel function
David Bateman <dbateman@free.fr>
parents: 8286
diff changeset
2479 @itemx ydatasource
ac7f334d9652 Add contour group objects and the clabel function
David Bateman <dbateman@free.fr>
parents: 8286
diff changeset
2480 @itemx zdatasource
ac7f334d9652 Add contour group objects and the clabel function
David Bateman <dbateman@free.fr>
parents: 8286
diff changeset
2481 Data source variables.
ac7f334d9652 Add contour group objects and the clabel function
David Bateman <dbateman@free.fr>
parents: 8286
diff changeset
2482 @end table
8056
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents: 8055
diff changeset
2483
11257
8d4c57258523 fix some menu problems in the manual
John W. Eaton <jwe@octave.org>
parents: 11255
diff changeset
2484 @node Error Bar Series
8d4c57258523 fix some menu problems in the manual
John W. Eaton <jwe@octave.org>
parents: 11255
diff changeset
2485 @subsubsection Error Bar Series
8071
b6e85fb238c1 doc fixes
John W. Eaton <jwe@octave.org>
parents: 8070
diff changeset
2486 @cindex series objects
b6e85fb238c1 doc fixes
John W. Eaton <jwe@octave.org>
parents: 8070
diff changeset
2487 @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
2488
9672
43a07df0ed4c document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents: 9316
diff changeset
2489 Error bar series are created by the @code{errorbar} function. Each
9040
dbd0c77e575e Cleanup documentation file plot.texi
Rik <rdrider0-list@yahoo.com>
parents: 9032
diff changeset
2490 @code{hggroup} element contains two line objects representing the data and
dbd0c77e575e Cleanup documentation file plot.texi
Rik <rdrider0-list@yahoo.com>
parents: 9032
diff changeset
2491 the errorbars separately. The properties of the error bar series are
8258
2b408bbd8904 Add error bar series
David Bateman <dbateman@free.fr>
parents: 8257
diff changeset
2492
2b408bbd8904 Add error bar series
David Bateman <dbateman@free.fr>
parents: 8257
diff changeset
2493 @table @code
2b408bbd8904 Add error bar series
David Bateman <dbateman@free.fr>
parents: 8257
diff changeset
2494 @item color
17469
710b3d5fe966 improve interpreter tex Tables
Michael Godfrey <michaeldgodfrey@gmail.com>
parents: 17281
diff changeset
2495 The RGB color or color name of the line objects of the error bars.
10828
322f43e0e170 Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents: 10711
diff changeset
2496 @xref{Colors}.
8258
2b408bbd8904 Add error bar series
David Bateman <dbateman@free.fr>
parents: 8257
diff changeset
2497
17170
d6499c14021c doc: Periodic grammarcheck of documentation.
Rik <rik@octave.org>
parents: 17152
diff changeset
2498 @item linewidth
8258
2b408bbd8904 Add error bar series
David Bateman <dbateman@free.fr>
parents: 8257
diff changeset
2499 @itemx linestyle
10828
322f43e0e170 Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents: 10711
diff changeset
2500 The line width and style of the line objects of the error bars. @xref{Line
322f43e0e170 Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents: 10711
diff changeset
2501 Styles}.
8258
2b408bbd8904 Add error bar series
David Bateman <dbateman@free.fr>
parents: 8257
diff changeset
2502
17170
d6499c14021c doc: Periodic grammarcheck of documentation.
Rik <rik@octave.org>
parents: 17152
diff changeset
2503 @item marker
8258
2b408bbd8904 Add error bar series
David Bateman <dbateman@free.fr>
parents: 8257
diff changeset
2504 @itemx markeredgecolor
2b408bbd8904 Add error bar series
David Bateman <dbateman@free.fr>
parents: 8257
diff changeset
2505 @itemx markerfacecolor
2b408bbd8904 Add error bar series
David Bateman <dbateman@free.fr>
parents: 8257
diff changeset
2506 @itemx markersize
9040
dbd0c77e575e Cleanup documentation file plot.texi
Rik <rdrider0-list@yahoo.com>
parents: 9032
diff changeset
2507 The line and fill color of the markers on the error bars. @xref{Colors}.
8258
2b408bbd8904 Add error bar series
David Bateman <dbateman@free.fr>
parents: 8257
diff changeset
2508
17170
d6499c14021c doc: Periodic grammarcheck of documentation.
Rik <rik@octave.org>
parents: 17152
diff changeset
2509 @item xdata
8258
2b408bbd8904 Add error bar series
David Bateman <dbateman@free.fr>
parents: 8257
diff changeset
2510 @itemx ydata
2b408bbd8904 Add error bar series
David Bateman <dbateman@free.fr>
parents: 8257
diff changeset
2511 @itemx ldata
2b408bbd8904 Add error bar series
David Bateman <dbateman@free.fr>
parents: 8257
diff changeset
2512 @itemx udata
2b408bbd8904 Add error bar series
David Bateman <dbateman@free.fr>
parents: 8257
diff changeset
2513 @itemx xldata
2b408bbd8904 Add error bar series
David Bateman <dbateman@free.fr>
parents: 8257
diff changeset
2514 @itemx xudata
25003
2365c2661b3c doc: Spellcheck documentation ahead of 4.4 release.
Rik <rik@octave.org>
parents: 24987
diff changeset
2515 The original x, y, l, u, @nospell{xl, xu} data of the error bars.
8258
2b408bbd8904 Add error bar series
David Bateman <dbateman@free.fr>
parents: 8257
diff changeset
2516
17170
d6499c14021c doc: Periodic grammarcheck of documentation.
Rik <rik@octave.org>
parents: 17152
diff changeset
2517 @item xdatasource
8258
2b408bbd8904 Add error bar series
David Bateman <dbateman@free.fr>
parents: 8257
diff changeset
2518 @itemx ydatasource
2b408bbd8904 Add error bar series
David Bateman <dbateman@free.fr>
parents: 8257
diff changeset
2519 @itemx ldatasource
2b408bbd8904 Add error bar series
David Bateman <dbateman@free.fr>
parents: 8257
diff changeset
2520 @itemx udatasource
2b408bbd8904 Add error bar series
David Bateman <dbateman@free.fr>
parents: 8257
diff changeset
2521 @itemx xldatasource
2b408bbd8904 Add error bar series
David Bateman <dbateman@free.fr>
parents: 8257
diff changeset
2522 @itemx xudatasource
2b408bbd8904 Add error bar series
David Bateman <dbateman@free.fr>
parents: 8257
diff changeset
2523 Data source variables.
2b408bbd8904 Add error bar series
David Bateman <dbateman@free.fr>
parents: 8257
diff changeset
2524 @end table
2b408bbd8904 Add error bar series
David Bateman <dbateman@free.fr>
parents: 8257
diff changeset
2525
11257
8d4c57258523 fix some menu problems in the manual
John W. Eaton <jwe@octave.org>
parents: 11255
diff changeset
2526 @node Line Series
8d4c57258523 fix some menu problems in the manual
John W. Eaton <jwe@octave.org>
parents: 11255
diff changeset
2527 @subsubsection Line Series
8071
b6e85fb238c1 doc fixes
John W. Eaton <jwe@octave.org>
parents: 8070
diff changeset
2528 @cindex series objects
b6e85fb238c1 doc fixes
John W. Eaton <jwe@octave.org>
parents: 8070
diff changeset
2529 @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
2530
8257
79c874fe5100 More plot object updates
David Bateman <dbateman@free.fr>
parents: 8089
diff changeset
2531 Line series objects are created by the @code{plot} and @code{plot3}
9040
dbd0c77e575e Cleanup documentation file plot.texi
Rik <rdrider0-list@yahoo.com>
parents: 9032
diff changeset
2532 functions and are of the type @code{line}. The properties of the
8257
79c874fe5100 More plot object updates
David Bateman <dbateman@free.fr>
parents: 8089
diff changeset
2533 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
2534
3b53b25e2550 Add data sources and line series
David Bateman <dbateman@free.fr>
parents: 8057
diff changeset
2535 @table @code
3b53b25e2550 Add data sources and line series
David Bateman <dbateman@free.fr>
parents: 8057
diff changeset
2536 @item color
9040
dbd0c77e575e Cleanup documentation file plot.texi
Rik <rdrider0-list@yahoo.com>
parents: 9032
diff changeset
2537 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
2538
17170
d6499c14021c doc: Periodic grammarcheck of documentation.
Rik <rik@octave.org>
parents: 17152
diff changeset
2539 @item linewidth
8070
3b53b25e2550 Add data sources and line series
David Bateman <dbateman@free.fr>
parents: 8057
diff changeset
2540 @itemx linestyle
9040
dbd0c77e575e Cleanup documentation file plot.texi
Rik <rdrider0-list@yahoo.com>
parents: 9032
diff changeset
2541 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
2542
17170
d6499c14021c doc: Periodic grammarcheck of documentation.
Rik <rik@octave.org>
parents: 17152
diff changeset
2543 @item marker
8070
3b53b25e2550 Add data sources and line series
David Bateman <dbateman@free.fr>
parents: 8057
diff changeset
2544 @itemx markeredgecolor
3b53b25e2550 Add data sources and line series
David Bateman <dbateman@free.fr>
parents: 8057
diff changeset
2545 @itemx markerfacecolor
3b53b25e2550 Add data sources and line series
David Bateman <dbateman@free.fr>
parents: 8057
diff changeset
2546 @itemx markersize
9040
dbd0c77e575e Cleanup documentation file plot.texi
Rik <rdrider0-list@yahoo.com>
parents: 9032
diff changeset
2547 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
2548
17170
d6499c14021c doc: Periodic grammarcheck of documentation.
Rik <rik@octave.org>
parents: 17152
diff changeset
2549 @item xdata
8070
3b53b25e2550 Add data sources and line series
David Bateman <dbateman@free.fr>
parents: 8057
diff changeset
2550 @itemx ydata
3b53b25e2550 Add data sources and line series
David Bateman <dbateman@free.fr>
parents: 8057
diff changeset
2551 @itemx zdata
8257
79c874fe5100 More plot object updates
David Bateman <dbateman@free.fr>
parents: 8089
diff changeset
2552 The original x, y and z data.
8070
3b53b25e2550 Add data sources and line series
David Bateman <dbateman@free.fr>
parents: 8057
diff changeset
2553
17170
d6499c14021c doc: Periodic grammarcheck of documentation.
Rik <rik@octave.org>
parents: 17152
diff changeset
2554 @item xdatasource
8070
3b53b25e2550 Add data sources and line series
David Bateman <dbateman@free.fr>
parents: 8057
diff changeset
2555 @itemx ydatasource
3b53b25e2550 Add data sources and line series
David Bateman <dbateman@free.fr>
parents: 8057
diff changeset
2556 @itemx zdatasource
3b53b25e2550 Add data sources and line series
David Bateman <dbateman@free.fr>
parents: 8057
diff changeset
2557 Data source variables.
3b53b25e2550 Add data sources and line series
David Bateman <dbateman@free.fr>
parents: 8057
diff changeset
2558 @end table
8056
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents: 8055
diff changeset
2559
11257
8d4c57258523 fix some menu problems in the manual
John W. Eaton <jwe@octave.org>
parents: 11255
diff changeset
2560 @node Quiver Group
8d4c57258523 fix some menu problems in the manual
John W. Eaton <jwe@octave.org>
parents: 11255
diff changeset
2561 @subsubsection Quiver Group
8071
b6e85fb238c1 doc fixes
John W. Eaton <jwe@octave.org>
parents: 8070
diff changeset
2562 @cindex group objects
b6e85fb238c1 doc fixes
John W. Eaton <jwe@octave.org>
parents: 8070
diff changeset
2563 @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
2564
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents: 8055
diff changeset
2565 Quiver series objects are created by the @code{quiver} or @code{quiver3}
9040
dbd0c77e575e Cleanup documentation file plot.texi
Rik <rdrider0-list@yahoo.com>
parents: 9032
diff changeset
2566 functions. Each @code{hggroup} element of the series contains three line
8056
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents: 8055
diff changeset
2567 objects as children representing the body and head of the arrow,
11365
4b4d5a4d7d0e Fix typo in Quiver section of plot.txi
Rik <octave@nomad.inbox5.com>
parents: 11330
diff changeset
2568 together with a marker as the point of origin of the arrows. The
8056
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents: 8055
diff changeset
2569 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
2570
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents: 8055
diff changeset
2571 @table @code
17170
d6499c14021c doc: Periodic grammarcheck of documentation.
Rik <rik@octave.org>
parents: 17152
diff changeset
2572 @item autoscale
8056
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents: 8055
diff changeset
2573 @itemx autoscalefactor
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents: 8055
diff changeset
2574 Flag whether the length of the arrows is scaled or defined directly from
9040
dbd0c77e575e Cleanup documentation file plot.texi
Rik <rdrider0-list@yahoo.com>
parents: 9032
diff changeset
2575 the @var{u}, @var{v} and @var{w} data. If the arrow length is flagged
8056
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents: 8055
diff changeset
2576 as being scaled by the @code{autoscale} property, then the length of the
9672
43a07df0ed4c document graphics structures
Michael D. Godfrey <godfrey@isl.stanford.edu>
parents: 9316
diff changeset
2577 autoscaled arrow is controlled by the @code{autoscalefactor}.
8056
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents: 8055
diff changeset
2578
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents: 8055
diff changeset
2579 @item maxheadsize
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents: 8055
diff changeset
2580 This property controls the size of the head of the arrows in the quiver
9040
dbd0c77e575e Cleanup documentation file plot.texi
Rik <rdrider0-list@yahoo.com>
parents: 9032
diff changeset
2581 series. The default value is 0.2.
8056
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents: 8055
diff changeset
2582
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents: 8055
diff changeset
2583 @item showarrowhead
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents: 8055
diff changeset
2584 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
2585
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents: 8055
diff changeset
2586 @item color
9040
dbd0c77e575e Cleanup documentation file plot.texi
Rik <rdrider0-list@yahoo.com>
parents: 9032
diff changeset
2587 The RGB color or color name of the line objects of the quiver. @xref{Colors}.
8056
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents: 8055
diff changeset
2588
17170
d6499c14021c doc: Periodic grammarcheck of documentation.
Rik <rik@octave.org>
parents: 17152
diff changeset
2589 @item linewidth
8056
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents: 8055
diff changeset
2590 @itemx linestyle
22299
9fc91bb2aec3 doc: grammarcheck documentation for 4.2 release.
Rik <rik@octave.org>
parents: 22288
diff changeset
2591 The line width and style of the line objects of the quiver. @xref{Line
9fc91bb2aec3 doc: grammarcheck documentation for 4.2 release.
Rik <rik@octave.org>
parents: 22288
diff changeset
2592 Styles}.
8056
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents: 8055
diff changeset
2593
17170
d6499c14021c doc: Periodic grammarcheck of documentation.
Rik <rik@octave.org>
parents: 17152
diff changeset
2594 @item marker
8056
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents: 8055
diff changeset
2595 @itemx markerfacecolor
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents: 8055
diff changeset
2596 @itemx markersize
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents: 8055
diff changeset
2597 The line and fill color of the marker objects at the original of the
9040
dbd0c77e575e Cleanup documentation file plot.texi
Rik <rdrider0-list@yahoo.com>
parents: 9032
diff changeset
2598 arrows. @xref{Colors}.
8056
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents: 8055
diff changeset
2599
17170
d6499c14021c doc: Periodic grammarcheck of documentation.
Rik <rik@octave.org>
parents: 17152
diff changeset
2600 @item xdata
8056
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents: 8055
diff changeset
2601 @itemx ydata
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents: 8055
diff changeset
2602 @itemx zdata
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents: 8055
diff changeset
2603 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
2604
17170
d6499c14021c doc: Periodic grammarcheck of documentation.
Rik <rik@octave.org>
parents: 17152
diff changeset
2605 @item udata
8056
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents: 8055
diff changeset
2606 @itemx vdata
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents: 8055
diff changeset
2607 @itemx wdata
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents: 8055
diff changeset
2608 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
2609
17170
d6499c14021c doc: Periodic grammarcheck of documentation.
Rik <rik@octave.org>
parents: 17152
diff changeset
2610 @item xdatasource
8070
3b53b25e2550 Add data sources and line series
David Bateman <dbateman@free.fr>
parents: 8057
diff changeset
2611 @itemx ydatasource
3b53b25e2550 Add data sources and line series
David Bateman <dbateman@free.fr>
parents: 8057
diff changeset
2612 @itemx zdatasource
3b53b25e2550 Add data sources and line series
David Bateman <dbateman@free.fr>
parents: 8057
diff changeset
2613 @itemx udatasource
3b53b25e2550 Add data sources and line series
David Bateman <dbateman@free.fr>
parents: 8057
diff changeset
2614 @itemx vdatasource
3b53b25e2550 Add data sources and line series
David Bateman <dbateman@free.fr>
parents: 8057
diff changeset
2615 @itemx wdatasource
3b53b25e2550 Add data sources and line series
David Bateman <dbateman@free.fr>
parents: 8057
diff changeset
2616 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
2617 @end table
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents: 8055
diff changeset
2618
11257
8d4c57258523 fix some menu problems in the manual
John W. Eaton <jwe@octave.org>
parents: 11255
diff changeset
2619 @node Stair Group
8d4c57258523 fix some menu problems in the manual
John W. Eaton <jwe@octave.org>
parents: 11255
diff changeset
2620 @subsubsection Stair Group
8071
b6e85fb238c1 doc fixes
John W. Eaton <jwe@octave.org>
parents: 8070
diff changeset
2621 @cindex group objects
b6e85fb238c1 doc fixes
John W. Eaton <jwe@octave.org>
parents: 8070
diff changeset
2622 @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
2623
9040
dbd0c77e575e Cleanup documentation file plot.texi
Rik <rdrider0-list@yahoo.com>
parents: 9032
diff changeset
2624 Stair series objects are created by the @code{stair} function. Each
8056
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents: 8055
diff changeset
2625 @code{hggroup} element of the series contains a single line object as a
9040
dbd0c77e575e Cleanup documentation file plot.texi
Rik <rdrider0-list@yahoo.com>
parents: 9032
diff changeset
2626 child representing the stair. The properties of the stair series are
8056
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents: 8055
diff changeset
2627
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents: 8055
diff changeset
2628 @table @code
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents: 8055
diff changeset
2629 @item color
9040
dbd0c77e575e Cleanup documentation file plot.texi
Rik <rdrider0-list@yahoo.com>
parents: 9032
diff changeset
2630 The RGB color or color name of the line objects of the stairs. @xref{Colors}.
8056
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents: 8055
diff changeset
2631
17170
d6499c14021c doc: Periodic grammarcheck of documentation.
Rik <rik@octave.org>
parents: 17152
diff changeset
2632 @item linewidth
8056
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents: 8055
diff changeset
2633 @itemx linestyle
22299
9fc91bb2aec3 doc: grammarcheck documentation for 4.2 release.
Rik <rik@octave.org>
parents: 22288
diff changeset
2634 The line width and style of the line objects of the stairs. @xref{Line
9fc91bb2aec3 doc: grammarcheck documentation for 4.2 release.
Rik <rik@octave.org>
parents: 22288
diff changeset
2635 Styles}.
8056
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents: 8055
diff changeset
2636
17170
d6499c14021c doc: Periodic grammarcheck of documentation.
Rik <rik@octave.org>
parents: 17152
diff changeset
2637 @item marker
8056
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents: 8055
diff changeset
2638 @itemx markeredgecolor
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents: 8055
diff changeset
2639 @itemx markerfacecolor
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents: 8055
diff changeset
2640 @itemx markersize
9040
dbd0c77e575e Cleanup documentation file plot.texi
Rik <rdrider0-list@yahoo.com>
parents: 9032
diff changeset
2641 The line and fill color of the markers on the stairs. @xref{Colors}.
8056
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents: 8055
diff changeset
2642
17170
d6499c14021c doc: Periodic grammarcheck of documentation.
Rik <rik@octave.org>
parents: 17152
diff changeset
2643 @item xdata
8056
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents: 8055
diff changeset
2644 @itemx ydata
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents: 8055
diff changeset
2645 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
2646
17170
d6499c14021c doc: Periodic grammarcheck of documentation.
Rik <rik@octave.org>
parents: 17152
diff changeset
2647 @item xdatasource
8070
3b53b25e2550 Add data sources and line series
David Bateman <dbateman@free.fr>
parents: 8057
diff changeset
2648 @itemx ydatasource
3b53b25e2550 Add data sources and line series
David Bateman <dbateman@free.fr>
parents: 8057
diff changeset
2649 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
2650 @end table
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents: 8055
diff changeset
2651
8073
8468140fd997 doc fix
John W. Eaton <jwe@octave.org>
parents: 8071
diff changeset
2652 @node Stem Series
8468140fd997 doc fix
John W. Eaton <jwe@octave.org>
parents: 8071
diff changeset
2653 @subsubsection Stem Series
8468140fd997 doc fix
John W. Eaton <jwe@octave.org>
parents: 8071
diff changeset
2654 @cindex series objects
8468140fd997 doc fix
John W. Eaton <jwe@octave.org>
parents: 8071
diff changeset
2655 @cindex stem series
8468140fd997 doc fix
John W. Eaton <jwe@octave.org>
parents: 8071
diff changeset
2656
8257
79c874fe5100 More plot object updates
David Bateman <dbateman@free.fr>
parents: 8089
diff changeset
2657 Stem series objects are created by the @code{stem} or @code{stem3}
9040
dbd0c77e575e Cleanup documentation file plot.texi
Rik <rdrider0-list@yahoo.com>
parents: 9032
diff changeset
2658 functions. Each @code{hggroup} element contains a single line object
dbd0c77e575e Cleanup documentation file plot.texi
Rik <rdrider0-list@yahoo.com>
parents: 9032
diff changeset
2659 as a child representing the stems. The properties of the stem series
8257
79c874fe5100 More plot object updates
David Bateman <dbateman@free.fr>
parents: 8089
diff changeset
2660 are
79c874fe5100 More plot object updates
David Bateman <dbateman@free.fr>
parents: 8089
diff changeset
2661
79c874fe5100 More plot object updates
David Bateman <dbateman@free.fr>
parents: 8089
diff changeset
2662 @table @code
17170
d6499c14021c doc: Periodic grammarcheck of documentation.
Rik <rik@octave.org>
parents: 17152
diff changeset
2663 @item showbaseline
8257
79c874fe5100 More plot object updates
David Bateman <dbateman@free.fr>
parents: 8089
diff changeset
2664 @itemx baseline
79c874fe5100 More plot object updates
David Bateman <dbateman@free.fr>
parents: 8089
diff changeset
2665 @itemx basevalue
79c874fe5100 More plot object updates
David Bateman <dbateman@free.fr>
parents: 8089
diff changeset
2666 The property @code{showbaseline} flags whether the baseline of the
17281
bc924baa2c4e doc: Add new @qcode macro for code samples which are quoted.
Rik <rik@octave.org>
parents: 17170
diff changeset
2667 stem series is displayed (default is @qcode{"on"}). The handle of the graphics
8257
79c874fe5100 More plot object updates
David Bateman <dbateman@free.fr>
parents: 8089
diff changeset
2668 object representing the baseline is given by the @code{baseline}
79c874fe5100 More plot object updates
David Bateman <dbateman@free.fr>
parents: 8089
diff changeset
2669 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
2670 by the @code{basevalue} property.
79c874fe5100 More plot object updates
David Bateman <dbateman@free.fr>
parents: 8089
diff changeset
2671
79c874fe5100 More plot object updates
David Bateman <dbateman@free.fr>
parents: 8089
diff changeset
2672 Changes to any of these property are propagated to the other members of
9040
dbd0c77e575e Cleanup documentation file plot.texi
Rik <rdrider0-list@yahoo.com>
parents: 9032
diff changeset
2673 the stem series and to the baseline itself. Equally changes in the
8257
79c874fe5100 More plot object updates
David Bateman <dbateman@free.fr>
parents: 8089
diff changeset
2674 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
2675 corresponding stem series.
79c874fe5100 More plot object updates
David Bateman <dbateman@free.fr>
parents: 8089
diff changeset
2676
79c874fe5100 More plot object updates
David Bateman <dbateman@free.fr>
parents: 8089
diff changeset
2677 @item color
9040
dbd0c77e575e Cleanup documentation file plot.texi
Rik <rdrider0-list@yahoo.com>
parents: 9032
diff changeset
2678 The RGB color or color name of the line objects of the stems. @xref{Colors}.
8257
79c874fe5100 More plot object updates
David Bateman <dbateman@free.fr>
parents: 8089
diff changeset
2679
17170
d6499c14021c doc: Periodic grammarcheck of documentation.
Rik <rik@octave.org>
parents: 17152
diff changeset
2680 @item linewidth
8257
79c874fe5100 More plot object updates
David Bateman <dbateman@free.fr>
parents: 8089
diff changeset
2681 @itemx linestyle
9040
dbd0c77e575e Cleanup documentation file plot.texi
Rik <rdrider0-list@yahoo.com>
parents: 9032
diff changeset
2682 The line width and style of the line objects of the stems. @xref{Line Styles}.
8257
79c874fe5100 More plot object updates
David Bateman <dbateman@free.fr>
parents: 8089
diff changeset
2683
17170
d6499c14021c doc: Periodic grammarcheck of documentation.
Rik <rik@octave.org>
parents: 17152
diff changeset
2684 @item marker
8257
79c874fe5100 More plot object updates
David Bateman <dbateman@free.fr>
parents: 8089
diff changeset
2685 @itemx markeredgecolor
79c874fe5100 More plot object updates
David Bateman <dbateman@free.fr>
parents: 8089
diff changeset
2686 @itemx markerfacecolor
79c874fe5100 More plot object updates
David Bateman <dbateman@free.fr>
parents: 8089
diff changeset
2687 @itemx markersize
9040
dbd0c77e575e Cleanup documentation file plot.texi
Rik <rdrider0-list@yahoo.com>
parents: 9032
diff changeset
2688 The line and fill color of the markers on the stems. @xref{Colors}.
8257
79c874fe5100 More plot object updates
David Bateman <dbateman@free.fr>
parents: 8089
diff changeset
2689
17170
d6499c14021c doc: Periodic grammarcheck of documentation.
Rik <rik@octave.org>
parents: 17152
diff changeset
2690 @item xdata
8257
79c874fe5100 More plot object updates
David Bateman <dbateman@free.fr>
parents: 8089
diff changeset
2691 @itemx ydata
79c874fe5100 More plot object updates
David Bateman <dbateman@free.fr>
parents: 8089
diff changeset
2692 @itemx zdata
79c874fe5100 More plot object updates
David Bateman <dbateman@free.fr>
parents: 8089
diff changeset
2693 The original x, y and z data of the stems.
79c874fe5100 More plot object updates
David Bateman <dbateman@free.fr>
parents: 8089
diff changeset
2694
17170
d6499c14021c doc: Periodic grammarcheck of documentation.
Rik <rik@octave.org>
parents: 17152
diff changeset
2695 @item xdatasource
8257
79c874fe5100 More plot object updates
David Bateman <dbateman@free.fr>
parents: 8089
diff changeset
2696 @itemx ydatasource
79c874fe5100 More plot object updates
David Bateman <dbateman@free.fr>
parents: 8089
diff changeset
2697 @itemx zdatasource
79c874fe5100 More plot object updates
David Bateman <dbateman@free.fr>
parents: 8089
diff changeset
2698 Data source variables.
79c874fe5100 More plot object updates
David Bateman <dbateman@free.fr>
parents: 8089
diff changeset
2699 @end table
8073
8468140fd997 doc fix
John W. Eaton <jwe@octave.org>
parents: 8071
diff changeset
2700
11257
8d4c57258523 fix some menu problems in the manual
John W. Eaton <jwe@octave.org>
parents: 11255
diff changeset
2701 @node Surface Group
8d4c57258523 fix some menu problems in the manual
John W. Eaton <jwe@octave.org>
parents: 11255
diff changeset
2702 @subsubsection Surface Group
8071
b6e85fb238c1 doc fixes
John W. Eaton <jwe@octave.org>
parents: 8070
diff changeset
2703 @cindex group objects
b6e85fb238c1 doc fixes
John W. Eaton <jwe@octave.org>
parents: 8070
diff changeset
2704 @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
2705
8257
79c874fe5100 More plot object updates
David Bateman <dbateman@free.fr>
parents: 8089
diff changeset
2706 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
2707 functions, but are equally one of the handles returned by the @code{surfc}
9040
dbd0c77e575e Cleanup documentation file plot.texi
Rik <rdrider0-list@yahoo.com>
parents: 9032
diff changeset
2708 or @code{meshc} functions. The surface group is of the type @code{surface}.
8257
79c874fe5100 More plot object updates
David Bateman <dbateman@free.fr>
parents: 8089
diff changeset
2709
79c874fe5100 More plot object updates
David Bateman <dbateman@free.fr>
parents: 8089
diff changeset
2710 The properties of the surface group are
79c874fe5100 More plot object updates
David Bateman <dbateman@free.fr>
parents: 8089
diff changeset
2711
79c874fe5100 More plot object updates
David Bateman <dbateman@free.fr>
parents: 8089
diff changeset
2712 @table @code
79c874fe5100 More plot object updates
David Bateman <dbateman@free.fr>
parents: 8089
diff changeset
2713 @item edgecolor
10828
322f43e0e170 Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents: 10711
diff changeset
2714
8257
79c874fe5100 More plot object updates
David Bateman <dbateman@free.fr>
parents: 8089
diff changeset
2715 @item facecolor
17469
710b3d5fe966 improve interpreter tex Tables
Michael Godfrey <michaeldgodfrey@gmail.com>
parents: 17281
diff changeset
2716 The RGB color or color name of the edges or faces of the surface.
10828
322f43e0e170 Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents: 10711
diff changeset
2717 @xref{Colors}.
8257
79c874fe5100 More plot object updates
David Bateman <dbateman@free.fr>
parents: 8089
diff changeset
2718
17170
d6499c14021c doc: Periodic grammarcheck of documentation.
Rik <rik@octave.org>
parents: 17152
diff changeset
2719 @item linewidth
8257
79c874fe5100 More plot object updates
David Bateman <dbateman@free.fr>
parents: 8089
diff changeset
2720 @itemx linestyle
9040
dbd0c77e575e Cleanup documentation file plot.texi
Rik <rdrider0-list@yahoo.com>
parents: 9032
diff changeset
2721 The line width and style of the lines on the surface. @xref{Line Styles}.
8257
79c874fe5100 More plot object updates
David Bateman <dbateman@free.fr>
parents: 8089
diff changeset
2722
17170
d6499c14021c doc: Periodic grammarcheck of documentation.
Rik <rik@octave.org>
parents: 17152
diff changeset
2723 @item marker
8257
79c874fe5100 More plot object updates
David Bateman <dbateman@free.fr>
parents: 8089
diff changeset
2724 @itemx markeredgecolor
79c874fe5100 More plot object updates
David Bateman <dbateman@free.fr>
parents: 8089
diff changeset
2725 @itemx markerfacecolor
79c874fe5100 More plot object updates
David Bateman <dbateman@free.fr>
parents: 8089
diff changeset
2726 @itemx markersize
9040
dbd0c77e575e Cleanup documentation file plot.texi
Rik <rdrider0-list@yahoo.com>
parents: 9032
diff changeset
2727 The line and fill color of the markers on the surface. @xref{Colors}.
8257
79c874fe5100 More plot object updates
David Bateman <dbateman@free.fr>
parents: 8089
diff changeset
2728
17170
d6499c14021c doc: Periodic grammarcheck of documentation.
Rik <rik@octave.org>
parents: 17152
diff changeset
2729 @item xdata
8257
79c874fe5100 More plot object updates
David Bateman <dbateman@free.fr>
parents: 8089
diff changeset
2730 @itemx ydata
79c874fe5100 More plot object updates
David Bateman <dbateman@free.fr>
parents: 8089
diff changeset
2731 @itemx zdata
10828
322f43e0e170 Grammarcheck .txi documentation files.
Rik <octave@nomad.inbox5.com>
parents: 10711
diff changeset
2732 @itemx cdata
8257
79c874fe5100 More plot object updates
David Bateman <dbateman@free.fr>
parents: 8089
diff changeset
2733 The original x, y, z and c data.
79c874fe5100 More plot object updates
David Bateman <dbateman@free.fr>
parents: 8089
diff changeset
2734
17170
d6499c14021c doc: Periodic grammarcheck of documentation.
Rik <rik@octave.org>
parents: 17152
diff changeset
2735 @item xdatasource
8257
79c874fe5100 More plot object updates
David Bateman <dbateman@free.fr>
parents: 8089
diff changeset
2736 @itemx ydatasource
79c874fe5100 More plot object updates
David Bateman <dbateman@free.fr>
parents: 8089
diff changeset
2737 @itemx zdatasource
79c874fe5100 More plot object updates
David Bateman <dbateman@free.fr>
parents: 8089
diff changeset
2738 @itemx cdatasource
79c874fe5100 More plot object updates
David Bateman <dbateman@free.fr>
parents: 8089
diff changeset
2739 Data source variables.
79c874fe5100 More plot object updates
David Bateman <dbateman@free.fr>
parents: 8089
diff changeset
2740 @end table
8056
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents: 8055
diff changeset
2741
23255
aaf91b4f48e4 hgtransform.m: New function (bug #50466).
Rik <rik@octave.org>
parents: 23220
diff changeset
2742 @node Transform Groups
aaf91b4f48e4 hgtransform.m: New function (bug #50466).
Rik <rik@octave.org>
parents: 23220
diff changeset
2743 @subsection Transform Groups
aaf91b4f48e4 hgtransform.m: New function (bug #50466).
Rik <rik@octave.org>
parents: 23220
diff changeset
2744 @cindex transform groups
aaf91b4f48e4 hgtransform.m: New function (bug #50466).
Rik <rik@octave.org>
parents: 23220
diff changeset
2745
aaf91b4f48e4 hgtransform.m: New function (bug #50466).
Rik <rik@octave.org>
parents: 23220
diff changeset
2746 @c FIXME: Need to add documentation on transforms.
aaf91b4f48e4 hgtransform.m: New function (bug #50466).
Rik <rik@octave.org>
parents: 23220
diff changeset
2747
aaf91b4f48e4 hgtransform.m: New function (bug #50466).
Rik <rik@octave.org>
parents: 23220
diff changeset
2748 @DOCSTRING(hgtransform)
aaf91b4f48e4 hgtransform.m: New function (bug #50466).
Rik <rik@octave.org>
parents: 23220
diff changeset
2749
aaf91b4f48e4 hgtransform.m: New function (bug #50466).
Rik <rik@octave.org>
parents: 23220
diff changeset
2750 @c @DOCSTRING(makehgtform)
aaf91b4f48e4 hgtransform.m: New function (bug #50466).
Rik <rik@octave.org>
parents: 23220
diff changeset
2751
11576
8ac9687dbe9f rename backend to graphics_toolkit
John W. Eaton <jwe@octave.org>
parents: 11573
diff changeset
2752 @node Graphics Toolkits
8ac9687dbe9f rename backend to graphics_toolkit
John W. Eaton <jwe@octave.org>
parents: 11573
diff changeset
2753 @subsection Graphics Toolkits
8ac9687dbe9f rename backend to graphics_toolkit
John W. Eaton <jwe@octave.org>
parents: 11573
diff changeset
2754 @cindex graphics toolkits
8ac9687dbe9f rename backend to graphics_toolkit
John W. Eaton <jwe@octave.org>
parents: 11573
diff changeset
2755 @cindex toolkits, graphics
8ac9687dbe9f rename backend to graphics_toolkit
John W. Eaton <jwe@octave.org>
parents: 11573
diff changeset
2756
8ac9687dbe9f rename backend to graphics_toolkit
John W. Eaton <jwe@octave.org>
parents: 11573
diff changeset
2757 @DOCSTRING(graphics_toolkit)
8ac9687dbe9f rename backend to graphics_toolkit
John W. Eaton <jwe@octave.org>
parents: 11573
diff changeset
2758
8ac9687dbe9f rename backend to graphics_toolkit
John W. Eaton <jwe@octave.org>
parents: 11573
diff changeset
2759 @DOCSTRING(available_graphics_toolkits)
8056
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents: 8055
diff changeset
2760
14134
84f38aeb9f0e doc: Add register_graphics_toolkit() and loaded_graphics_toolkits() to documentation
Rik <octave@nomad.inbox5.com>
parents: 13947
diff changeset
2761 @DOCSTRING(loaded_graphics_toolkits)
84f38aeb9f0e doc: Add register_graphics_toolkit() and loaded_graphics_toolkits() to documentation
Rik <octave@nomad.inbox5.com>
parents: 13947
diff changeset
2762
84f38aeb9f0e doc: Add register_graphics_toolkit() and loaded_graphics_toolkits() to documentation
Rik <octave@nomad.inbox5.com>
parents: 13947
diff changeset
2763 @DOCSTRING(register_graphics_toolkit)
84f38aeb9f0e doc: Add register_graphics_toolkit() and loaded_graphics_toolkits() to documentation
Rik <octave@nomad.inbox5.com>
parents: 13947
diff changeset
2764
8056
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents: 8055
diff changeset
2765 @menu
17152
f2a8592b8fbd doc: Shorten some long subsection names in Manual.
Rik <rik@octave.org>
parents: 17123
diff changeset
2766 * Customizing Toolkit Behavior::
31596
e03694e047fa doc: Fix Texinfo 7 warning about node names with a dot
Arun Giridhar <arungiridhar@gmail.com>
parents: 31574
diff changeset
2767 * Hardware vs Software Rendering::
29451
75ba68c686ab doc: Document single precision issues with OpenGL graphics toolkits (bug #59418).
Markus Mützel <markus.muetzel@gmx.de>
parents: 29010
diff changeset
2768 * Precision issues::
8056
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents: 8055
diff changeset
2769 @end menu
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents: 8055
diff changeset
2770
12226
8cc154f45e37 Rename fltk_mouse_wheel_zoom, fltk_gui_mode functions to remove fltk_ prefix.
Rik <octave@nomad.inbox5.com>
parents: 12215
diff changeset
2771 @node Customizing Toolkit Behavior
8cc154f45e37 Rename fltk_mouse_wheel_zoom, fltk_gui_mode functions to remove fltk_ prefix.
Rik <octave@nomad.inbox5.com>
parents: 12215
diff changeset
2772 @subsubsection Customizing Toolkit Behavior
8cc154f45e37 Rename fltk_mouse_wheel_zoom, fltk_gui_mode functions to remove fltk_ prefix.
Rik <octave@nomad.inbox5.com>
parents: 12215
diff changeset
2773 @cindex toolkit customization
8cc154f45e37 Rename fltk_mouse_wheel_zoom, fltk_gui_mode functions to remove fltk_ prefix.
Rik <octave@nomad.inbox5.com>
parents: 12215
diff changeset
2774
8cc154f45e37 Rename fltk_mouse_wheel_zoom, fltk_gui_mode functions to remove fltk_ prefix.
Rik <octave@nomad.inbox5.com>
parents: 12215
diff changeset
2775 The specific behavior of the backend toolkit may be modified using the
8cc154f45e37 Rename fltk_mouse_wheel_zoom, fltk_gui_mode functions to remove fltk_ prefix.
Rik <octave@nomad.inbox5.com>
parents: 12215
diff changeset
2776 following utility functions. Note: Not all functions apply to every
8cc154f45e37 Rename fltk_mouse_wheel_zoom, fltk_gui_mode functions to remove fltk_ prefix.
Rik <octave@nomad.inbox5.com>
parents: 12215
diff changeset
2777 graphics toolkit.
3428
5b77cf82393c [project @ 2000-01-14 02:54:53 by jwe]
jwe
parents: 3368
diff changeset
2778
5b77cf82393c [project @ 2000-01-14 02:54:53 by jwe]
jwe
parents: 3368
diff changeset
2779 @DOCSTRING(gnuplot_binary)
25585
d4b478bd105c Document work-around for disabling OpenGL software rendering (bug #53846).
Markus Mützel <markus.muetzel@gmx.de>
parents: 25578
diff changeset
2780
27422
f42c47910064 doc: Add documentation for GNUTERM variable used with gnuplot (bug #56906).
Mike Miller <mtmiller@octave.org>
parents: 26949
diff changeset
2781 @cindex GNUTERM
f42c47910064 doc: Add documentation for GNUTERM variable used with gnuplot (bug #56906).
Mike Miller <mtmiller@octave.org>
parents: 26949
diff changeset
2782
f42c47910064 doc: Add documentation for GNUTERM variable used with gnuplot (bug #56906).
Mike Miller <mtmiller@octave.org>
parents: 26949
diff changeset
2783 In addition, the gnuplot program usually provides a number of different
f42c47910064 doc: Add documentation for GNUTERM variable used with gnuplot (bug #56906).
Mike Miller <mtmiller@octave.org>
parents: 26949
diff changeset
2784 interfaces, known as terminals. Octave normally chooses a default terminal,
f42c47910064 doc: Add documentation for GNUTERM variable used with gnuplot (bug #56906).
Mike Miller <mtmiller@octave.org>
parents: 26949
diff changeset
2785 but you can override this with the environment variable @env{GNUTERM}. This
f42c47910064 doc: Add documentation for GNUTERM variable used with gnuplot (bug #56906).
Mike Miller <mtmiller@octave.org>
parents: 26949
diff changeset
2786 variable may be set in the shell before starting Octave or from within Octave
27796
e7dd7d98a058 doc: grammarcheck .txi files before 6.1 release.
Rik <rik@octave.org>
parents: 27759
diff changeset
2787 before plotting for the first time. For example:
27422
f42c47910064 doc: Add documentation for GNUTERM variable used with gnuplot (bug #56906).
Mike Miller <mtmiller@octave.org>
parents: 26949
diff changeset
2788
f42c47910064 doc: Add documentation for GNUTERM variable used with gnuplot (bug #56906).
Mike Miller <mtmiller@octave.org>
parents: 26949
diff changeset
2789 @example
f42c47910064 doc: Add documentation for GNUTERM variable used with gnuplot (bug #56906).
Mike Miller <mtmiller@octave.org>
parents: 26949
diff changeset
2790 @group
f42c47910064 doc: Add documentation for GNUTERM variable used with gnuplot (bug #56906).
Mike Miller <mtmiller@octave.org>
parents: 26949
diff changeset
2791 setenv ("GNUTERM", "wxt")
f42c47910064 doc: Add documentation for GNUTERM variable used with gnuplot (bug #56906).
Mike Miller <mtmiller@octave.org>
parents: 26949
diff changeset
2792 graphics_toolkit ("gnuplot")
f42c47910064 doc: Add documentation for GNUTERM variable used with gnuplot (bug #56906).
Mike Miller <mtmiller@octave.org>
parents: 26949
diff changeset
2793 plot (1:10)
f42c47910064 doc: Add documentation for GNUTERM variable used with gnuplot (bug #56906).
Mike Miller <mtmiller@octave.org>
parents: 26949
diff changeset
2794 @end group
f42c47910064 doc: Add documentation for GNUTERM variable used with gnuplot (bug #56906).
Mike Miller <mtmiller@octave.org>
parents: 26949
diff changeset
2795 @end example
f42c47910064 doc: Add documentation for GNUTERM variable used with gnuplot (bug #56906).
Mike Miller <mtmiller@octave.org>
parents: 26949
diff changeset
2796
31596
e03694e047fa doc: Fix Texinfo 7 warning about node names with a dot
Arun Giridhar <arungiridhar@gmail.com>
parents: 31574
diff changeset
2797 @node Hardware vs Software Rendering
e03694e047fa doc: Fix Texinfo 7 warning about node names with a dot
Arun Giridhar <arungiridhar@gmail.com>
parents: 31574
diff changeset
2798 @subsubsection Hardware vs Software Rendering
25585
d4b478bd105c Document work-around for disabling OpenGL software rendering (bug #53846).
Markus Mützel <markus.muetzel@gmx.de>
parents: 25578
diff changeset
2799 @cindex opengl rendering slow windows
d4b478bd105c Document work-around for disabling OpenGL software rendering (bug #53846).
Markus Mützel <markus.muetzel@gmx.de>
parents: 25578
diff changeset
2800
31828
d4693c66e7c9 doc: Update section about hardware vs. software rendering on Windows.
Markus Mützel <markus.muetzel@gmx.de>
parents: 31706
diff changeset
2801 When using the Octave for Windows installer, the user has the option to select
d4693c66e7c9 doc: Update section about hardware vs. software rendering on Windows.
Markus Mützel <markus.muetzel@gmx.de>
parents: 31706
diff changeset
2802 between "System OpenGL" and "Software OpenGL" renderers. This option selects
d4693c66e7c9 doc: Update section about hardware vs. software rendering on Windows.
Markus Mützel <markus.muetzel@gmx.de>
parents: 31706
diff changeset
2803 whether software rendering is used for the OpenGL graphics toolkits
d4693c66e7c9 doc: Update section about hardware vs. software rendering on Windows.
Markus Mützel <markus.muetzel@gmx.de>
parents: 31706
diff changeset
2804 (@qcode{"qt"} and @qcode{"fltk"}). Software rendering can be used to avoid
25857
c3c9c8533a86 Document that high level graphics functions redefine axes properties (bug #49400).
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents: 25585
diff changeset
2805 rendering and printing issues due to imperfect OpenGL driver implementations
31828
d4693c66e7c9 doc: Update section about hardware vs. software rendering on Windows.
Markus Mützel <markus.muetzel@gmx.de>
parents: 31706
diff changeset
2806 for diverse graphic cards from different vendors (notably integrated Intel
d4693c66e7c9 doc: Update section about hardware vs. software rendering on Windows.
Markus Mützel <markus.muetzel@gmx.de>
parents: 31706
diff changeset
2807 graphics). As a down-side, software rendering might be considerably slower
d4693c66e7c9 doc: Update section about hardware vs. software rendering on Windows.
Markus Mützel <markus.muetzel@gmx.de>
parents: 31706
diff changeset
2808 than hardware accelerated rendering (and it might not work correctly on 32-bit
d4693c66e7c9 doc: Update section about hardware vs. software rendering on Windows.
Markus Mützel <markus.muetzel@gmx.de>
parents: 31706
diff changeset
2809 platforms or WoW64). To permanently switch between hardware accelerated
d4693c66e7c9 doc: Update section about hardware vs. software rendering on Windows.
Markus Mützel <markus.muetzel@gmx.de>
parents: 31706
diff changeset
2810 rendering with your graphics card drivers and software rendering, use the
d4693c66e7c9 doc: Update section about hardware vs. software rendering on Windows.
Markus Mützel <markus.muetzel@gmx.de>
parents: 31706
diff changeset
2811 "OpenGL Switcher" application from the Start menu while Octave is closed.
d4693c66e7c9 doc: Update section about hardware vs. software rendering on Windows.
Markus Mützel <markus.muetzel@gmx.de>
parents: 31706
diff changeset
2812 Alternatively, rename the following file while Octave is closed:
25585
d4b478bd105c Document work-around for disabling OpenGL software rendering (bug #53846).
Markus Mützel <markus.muetzel@gmx.de>
parents: 25578
diff changeset
2813
d4b478bd105c Document work-around for disabling OpenGL software rendering (bug #53846).
Markus Mützel <markus.muetzel@gmx.de>
parents: 25578
diff changeset
2814 @file{@var{octave-home}\bin\opengl32.dll}
31833
c5fa6a6ba7af doc: Refer to OCTAVE_HOME in section about graphics renderer.
Markus Mützel <markus.muetzel@gmx.de>
parents: 31828
diff changeset
2815 @*where @var{octave-home} is the directory returned by
c5fa6a6ba7af doc: Refer to OCTAVE_HOME in section about graphics renderer.
Markus Mützel <markus.muetzel@gmx.de>
parents: 31828
diff changeset
2816 @ref{XREFOCTAVE_HOME, , @w{@qcode{OCTAVE_HOME}}}, i.e., the directory in which
c5fa6a6ba7af doc: Refer to OCTAVE_HOME in section about graphics renderer.
Markus Mützel <markus.muetzel@gmx.de>
parents: 31828
diff changeset
2817 Octave is installed (the default is
c5fa6a6ba7af doc: Refer to OCTAVE_HOME in section about graphics renderer.
Markus Mützel <markus.muetzel@gmx.de>
parents: 31828
diff changeset
2818 @file{C:\Program Files\GNU Octave\Octave\Octave-@var{version}\mingw64}).
31828
d4693c66e7c9 doc: Update section about hardware vs. software rendering on Windows.
Markus Mützel <markus.muetzel@gmx.de>
parents: 31706
diff changeset
2819 Change the file extension to @file{.bak} for hardware rendering or to
d4693c66e7c9 doc: Update section about hardware vs. software rendering on Windows.
Markus Mützel <markus.muetzel@gmx.de>
parents: 31706
diff changeset
2820 @file{.dll} for software rendering.
29451
75ba68c686ab doc: Document single precision issues with OpenGL graphics toolkits (bug #59418).
Markus Mützel <markus.muetzel@gmx.de>
parents: 29010
diff changeset
2821
75ba68c686ab doc: Document single precision issues with OpenGL graphics toolkits (bug #59418).
Markus Mützel <markus.muetzel@gmx.de>
parents: 29010
diff changeset
2822 @node Precision issues
75ba68c686ab doc: Document single precision issues with OpenGL graphics toolkits (bug #59418).
Markus Mützel <markus.muetzel@gmx.de>
parents: 29010
diff changeset
2823 @subsubsection Precision issues
75ba68c686ab doc: Document single precision issues with OpenGL graphics toolkits (bug #59418).
Markus Mützel <markus.muetzel@gmx.de>
parents: 29010
diff changeset
2824 @cindex opengl single precision date time
75ba68c686ab doc: Document single precision issues with OpenGL graphics toolkits (bug #59418).
Markus Mützel <markus.muetzel@gmx.de>
parents: 29010
diff changeset
2825
75ba68c686ab doc: Document single precision issues with OpenGL graphics toolkits (bug #59418).
Markus Mützel <markus.muetzel@gmx.de>
parents: 29010
diff changeset
2826 The OpenGL graphics toolkits (@qcode{"qt"} and @qcode{"fltk"}) use single
75ba68c686ab doc: Document single precision issues with OpenGL graphics toolkits (bug #59418).
Markus Mützel <markus.muetzel@gmx.de>
parents: 29010
diff changeset
2827 precision for rendering. This limitation in particular applies to plots of
29669
101d1d8df273 doc: Spellcheck documentation ahead of 6.3 release.
Rik <rik@octave.org>
parents: 29668
diff changeset
2828 time series against serial dates as used by the @code{datenum}, @code{datestr},
29451
75ba68c686ab doc: Document single precision issues with OpenGL graphics toolkits (bug #59418).
Markus Mützel <markus.muetzel@gmx.de>
parents: 29010
diff changeset
2829 @code{datestruct}, and @code{datetick} functions.
75ba68c686ab doc: Document single precision issues with OpenGL graphics toolkits (bug #59418).
Markus Mützel <markus.muetzel@gmx.de>
parents: 29010
diff changeset
2830
75ba68c686ab doc: Document single precision issues with OpenGL graphics toolkits (bug #59418).
Markus Mützel <markus.muetzel@gmx.de>
parents: 29010
diff changeset
2831 Serial dates encode timestamps as days elapsed since the year zero with hours,
29668
f17b1f0141ed doc: Grammarcheck documentation ahead of 6.3 release.
Rik <rik@octave.org>
parents: 29453
diff changeset
2832 minutes, seconds as the fractional part. On December 31st 1999, the serial
f17b1f0141ed doc: Grammarcheck documentation ahead of 6.3 release.
Rik <rik@octave.org>
parents: 29453
diff changeset
2833 date representation was 730485. A double precision variable with this integer
f17b1f0141ed doc: Grammarcheck documentation ahead of 6.3 release.
Rik <rik@octave.org>
parents: 29453
diff changeset
2834 part allows for a resolution in its fractional part of 1.2e-10, representing
f17b1f0141ed doc: Grammarcheck documentation ahead of 6.3 release.
Rik <rik@octave.org>
parents: 29453
diff changeset
2835 about 5 microseconds. But with single precision, the resolution is reduced to
f17b1f0141ed doc: Grammarcheck documentation ahead of 6.3 release.
Rik <rik@octave.org>
parents: 29453
diff changeset
2836 about 0.06, representing 45 minutes. Any attempt to plot timestamped data
f17b1f0141ed doc: Grammarcheck documentation ahead of 6.3 release.
Rik <rik@octave.org>
parents: 29453
diff changeset
2837 with finer granularity will result in a distorted graph.
29451
75ba68c686ab doc: Document single precision issues with OpenGL graphics toolkits (bug #59418).
Markus Mützel <markus.muetzel@gmx.de>
parents: 29010
diff changeset
2838
75ba68c686ab doc: Document single precision issues with OpenGL graphics toolkits (bug #59418).
Markus Mützel <markus.muetzel@gmx.de>
parents: 29010
diff changeset
2839 As a workaround, it is possible to use the @qcode{"gnuplot"} graphics toolkit
29668
f17b1f0141ed doc: Grammarcheck documentation ahead of 6.3 release.
Rik <rik@octave.org>
parents: 29453
diff changeset
2840 or subtract 2000 years---i.e., @code{datenum (2000, 0, 0)} or 730485---from the
29453
766db6d094fe doc: Minor changes to documentation of single precision issues with OpenGL (bug #59418).
Markus Mützel <markus.muetzel@gmx.de>
parents: 29451
diff changeset
2841 time values. Due to the fact that the calendar structure repeats every 2000
766db6d094fe doc: Minor changes to documentation of single precision issues with OpenGL (bug #59418).
Markus Mützel <markus.muetzel@gmx.de>
parents: 29451
diff changeset
2842 years, the relation between year, month, day of month and day of week will stay
29451
75ba68c686ab doc: Document single precision issues with OpenGL graphics toolkits (bug #59418).
Markus Mützel <markus.muetzel@gmx.de>
parents: 29010
diff changeset
2843 unchanged and the ticks and ticklabels produced by the @code{datetick} function
75ba68c686ab doc: Document single precision issues with OpenGL graphics toolkits (bug #59418).
Markus Mützel <markus.muetzel@gmx.de>
parents: 29010
diff changeset
2844 will still be correct. Only years will lack the millennium digit. Thus,
75ba68c686ab doc: Document single precision issues with OpenGL graphics toolkits (bug #59418).
Markus Mützel <markus.muetzel@gmx.de>
parents: 29010
diff changeset
2845 "2020" will be printed as "20". For example:
75ba68c686ab doc: Document single precision issues with OpenGL graphics toolkits (bug #59418).
Markus Mützel <markus.muetzel@gmx.de>
parents: 29010
diff changeset
2846
75ba68c686ab doc: Document single precision issues with OpenGL graphics toolkits (bug #59418).
Markus Mützel <markus.muetzel@gmx.de>
parents: 29010
diff changeset
2847 @example
75ba68c686ab doc: Document single precision issues with OpenGL graphics toolkits (bug #59418).
Markus Mützel <markus.muetzel@gmx.de>
parents: 29010
diff changeset
2848 @group
75ba68c686ab doc: Document single precision issues with OpenGL graphics toolkits (bug #59418).
Markus Mützel <markus.muetzel@gmx.de>
parents: 29010
diff changeset
2849 # timestamps of 24 hours in one minute steps
75ba68c686ab doc: Document single precision issues with OpenGL graphics toolkits (bug #59418).
Markus Mützel <markus.muetzel@gmx.de>
parents: 29010
diff changeset
2850 t = datenum (2020, 1, 1):(1/1440):datenum (2020, 1, 2);
75ba68c686ab doc: Document single precision issues with OpenGL graphics toolkits (bug #59418).
Markus Mützel <markus.muetzel@gmx.de>
parents: 29010
diff changeset
2851
29669
101d1d8df273 doc: Spellcheck documentation ahead of 6.3 release.
Rik <rik@octave.org>
parents: 29668
diff changeset
2852 # some example time series data
29451
75ba68c686ab doc: Document single precision issues with OpenGL graphics toolkits (bug #59418).
Markus Mützel <markus.muetzel@gmx.de>
parents: 29010
diff changeset
2853 x = -cos (2*pi*t) + rand (size (t)) / 10;
75ba68c686ab doc: Document single precision issues with OpenGL graphics toolkits (bug #59418).
Markus Mützel <markus.muetzel@gmx.de>
parents: 29010
diff changeset
2854
75ba68c686ab doc: Document single precision issues with OpenGL graphics toolkits (bug #59418).
Markus Mützel <markus.muetzel@gmx.de>
parents: 29010
diff changeset
2855 subplot (1, 2, 1);
75ba68c686ab doc: Document single precision issues with OpenGL graphics toolkits (bug #59418).
Markus Mützel <markus.muetzel@gmx.de>
parents: 29010
diff changeset
2856 plot (t, x);
75ba68c686ab doc: Document single precision issues with OpenGL graphics toolkits (bug #59418).
Markus Mützel <markus.muetzel@gmx.de>
parents: 29010
diff changeset
2857 datetick ("x");
75ba68c686ab doc: Document single precision issues with OpenGL graphics toolkits (bug #59418).
Markus Mützel <markus.muetzel@gmx.de>
parents: 29010
diff changeset
2858 xlabel ("serial date");
75ba68c686ab doc: Document single precision issues with OpenGL graphics toolkits (bug #59418).
Markus Mützel <markus.muetzel@gmx.de>
parents: 29010
diff changeset
2859 title ("problem");
75ba68c686ab doc: Document single precision issues with OpenGL graphics toolkits (bug #59418).
Markus Mützel <markus.muetzel@gmx.de>
parents: 29010
diff changeset
2860
75ba68c686ab doc: Document single precision issues with OpenGL graphics toolkits (bug #59418).
Markus Mützel <markus.muetzel@gmx.de>
parents: 29010
diff changeset
2861 subplot (1, 2, 2);
75ba68c686ab doc: Document single precision issues with OpenGL graphics toolkits (bug #59418).
Markus Mützel <markus.muetzel@gmx.de>
parents: 29010
diff changeset
2862 plot (t - 730485, x);
75ba68c686ab doc: Document single precision issues with OpenGL graphics toolkits (bug #59418).
Markus Mützel <markus.muetzel@gmx.de>
parents: 29010
diff changeset
2863 datetick ("x");
75ba68c686ab doc: Document single precision issues with OpenGL graphics toolkits (bug #59418).
Markus Mützel <markus.muetzel@gmx.de>
parents: 29010
diff changeset
2864 xlabel ("2000 years off");
75ba68c686ab doc: Document single precision issues with OpenGL graphics toolkits (bug #59418).
Markus Mützel <markus.muetzel@gmx.de>
parents: 29010
diff changeset
2865 title ("workaround");
75ba68c686ab doc: Document single precision issues with OpenGL graphics toolkits (bug #59418).
Markus Mützel <markus.muetzel@gmx.de>
parents: 29010
diff changeset
2866 @end group
75ba68c686ab doc: Document single precision issues with OpenGL graphics toolkits (bug #59418).
Markus Mützel <markus.muetzel@gmx.de>
parents: 29010
diff changeset
2867 @end example
75ba68c686ab doc: Document single precision issues with OpenGL graphics toolkits (bug #59418).
Markus Mützel <markus.muetzel@gmx.de>
parents: 29010
diff changeset
2868
75ba68c686ab doc: Document single precision issues with OpenGL graphics toolkits (bug #59418).
Markus Mützel <markus.muetzel@gmx.de>
parents: 29010
diff changeset
2869 @ifnotinfo
75ba68c686ab doc: Document single precision issues with OpenGL graphics toolkits (bug #59418).
Markus Mützel <markus.muetzel@gmx.de>
parents: 29010
diff changeset
2870 @noindent
75ba68c686ab doc: Document single precision issues with OpenGL graphics toolkits (bug #59418).
Markus Mützel <markus.muetzel@gmx.de>
parents: 29010
diff changeset
2871 The result of which can be seen in @ref{fig:precisiondate}.
75ba68c686ab doc: Document single precision issues with OpenGL graphics toolkits (bug #59418).
Markus Mützel <markus.muetzel@gmx.de>
parents: 29010
diff changeset
2872
75ba68c686ab doc: Document single precision issues with OpenGL graphics toolkits (bug #59418).
Markus Mützel <markus.muetzel@gmx.de>
parents: 29010
diff changeset
2873 @float Figure,fig:precisiondate
75ba68c686ab doc: Document single precision issues with OpenGL graphics toolkits (bug #59418).
Markus Mützel <markus.muetzel@gmx.de>
parents: 29010
diff changeset
2874 @center @image{precisiondate,4in}
75ba68c686ab doc: Document single precision issues with OpenGL graphics toolkits (bug #59418).
Markus Mützel <markus.muetzel@gmx.de>
parents: 29010
diff changeset
2875 @caption{Single precision issues with OpenGL graphics toolkits}
75ba68c686ab doc: Document single precision issues with OpenGL graphics toolkits (bug #59418).
Markus Mützel <markus.muetzel@gmx.de>
parents: 29010
diff changeset
2876 @end float
75ba68c686ab doc: Document single precision issues with OpenGL graphics toolkits (bug #59418).
Markus Mützel <markus.muetzel@gmx.de>
parents: 29010
diff changeset
2877 @end ifnotinfo
29453
766db6d094fe doc: Minor changes to documentation of single precision issues with OpenGL (bug #59418).
Markus Mützel <markus.muetzel@gmx.de>
parents: 29451
diff changeset
2878
766db6d094fe doc: Minor changes to documentation of single precision issues with OpenGL (bug #59418).
Markus Mützel <markus.muetzel@gmx.de>
parents: 29451
diff changeset
2879 Similarly, other data can be translated or re-scaled to work around this issue.