octave-nkf: doc/interpreter/plot.txi annotate

annotate doc/interpreter/plot.txi @ 18487:8473198fd005

maint: Periodic merge of gui-release to default.

author	John W. Eaton <jwe@octave.org>
date	Tue, 18 Feb 2014 02:51:48 -0500
parents	a91654d70f99 d39fd728ddef
children	13c80c3e9660

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