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

annotate doc/interpreter/plot.txi @ 9752:51c21837686f

Period spellcheck of Octave documentation to check and fix newly added DOCSTRINGS

author	Rik <rdrider0-list@yahoo.com>
date	Thu, 22 Oct 2009 20:25:08 -0700
parents	e40835382b68
children	09da0bd91412

rev	line source
7018 fd42779a8428 [project @ 2007-10-13 00:52:12 by jwe] jwe parents: 7001 diff changeset	1 @c Copyright (C) 1996, 1997, 1999, 2000, 2002, 2003, 2004, 2005,
8920 eb63fbe60fab update copyright notices John W. Eaton <jwe@octave.org> parents: 8817 diff changeset	2 @c 2006, 2007, 2008, 2009 John W. Eaton
7018 fd42779a8428 [project @ 2007-10-13 00:52:12 by jwe] jwe parents: 7001 diff changeset	3 @c
fd42779a8428 [project @ 2007-10-13 00:52:12 by jwe] jwe parents: 7001 diff changeset	4 @c This file is part of Octave.
fd42779a8428 [project @ 2007-10-13 00:52:12 by jwe] jwe parents: 7001 diff changeset	5 @c
fd42779a8428 [project @ 2007-10-13 00:52:12 by jwe] jwe parents: 7001 diff changeset	6 @c Octave is free software; you can redistribute it and/or modify it
fd42779a8428 [project @ 2007-10-13 00:52:12 by jwe] jwe parents: 7001 diff changeset	7 @c under the terms of the GNU General Public License as published by the
fd42779a8428 [project @ 2007-10-13 00:52:12 by jwe] jwe parents: 7001 diff changeset	8 @c Free Software Foundation; either version 3 of the License, or (at
fd42779a8428 [project @ 2007-10-13 00:52:12 by jwe] jwe parents: 7001 diff changeset	9 @c your option) any later version.
9672 43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	10 @c
7018 fd42779a8428 [project @ 2007-10-13 00:52:12 by jwe] jwe parents: 7001 diff changeset	11 @c Octave is distributed in the hope that it will be useful, but WITHOUT
fd42779a8428 [project @ 2007-10-13 00:52:12 by jwe] jwe parents: 7001 diff changeset	12 @c ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
fd42779a8428 [project @ 2007-10-13 00:52:12 by jwe] jwe parents: 7001 diff changeset	13 @c FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
fd42779a8428 [project @ 2007-10-13 00:52:12 by jwe] jwe parents: 7001 diff changeset	14 @c for more details.
9672 43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	15 @c
7018 fd42779a8428 [project @ 2007-10-13 00:52:12 by jwe] jwe parents: 7001 diff changeset	16 @c You should have received a copy of the GNU General Public License
fd42779a8428 [project @ 2007-10-13 00:52:12 by jwe] jwe parents: 7001 diff changeset	17 @c along with Octave; see the file COPYING. If not, see
fd42779a8428 [project @ 2007-10-13 00:52:12 by jwe] jwe parents: 7001 diff changeset	18 @c <http://www.gnu.org/licenses/>.
3294 bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	19
4167 aae05d51353c [project @ 2002-11-12 02:52:50 by jwe] jwe parents: 3439 diff changeset	20 @node Plotting
3294 bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	21 @chapter Plotting
6888 b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe] jwe parents: 6877 diff changeset	22 @cindex plotting
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe] jwe parents: 6877 diff changeset	23 @cindex graphics
3294 bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	24
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	25 @menu
9676 e40835382b68 doc fixes John W. Eaton <jwe@octave.org> parents: 9672 diff changeset	26 * Introduction to Plotting::
e40835382b68 doc fixes John W. Eaton <jwe@octave.org> parents: 9672 diff changeset	27 * High-Level Plotting::
e40835382b68 doc fixes John W. Eaton <jwe@octave.org> parents: 9672 diff changeset	28 * Graphics Data Structures::
e40835382b68 doc fixes John W. Eaton <jwe@octave.org> parents: 9672 diff changeset	29 * Advanced Plotting::
6888 b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe] jwe parents: 6877 diff changeset	30 @end menu
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe] jwe parents: 6877 diff changeset	31
9672 43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	32 @node Introduction to Plotting
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	33 @section Introduction to Plotting
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	34
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	35 Earlier versions of Octave provided plotting through the use of
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	36 gnuplot. This capability is still available. But, a newer plotting
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	37 capability is provided by access to OpenGL. Which plotting system
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	38 is used is controlled by the @code{backend} function. (See @ref{Graphics Backends}.)
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	39
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	40 The function call @code{backend("fltk")} selects the fltk/OpenGL system, and
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	41 @code{backend("gnuplot")} selects the gnuplot system.
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	42 The two systems may be used selectively through the use of the @code{backend}
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	43 property of the graphics handle for each figure. This is
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	44 explained in @ref{Graphics Data Structures}.
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	45
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	46 @node High-Level Plotting
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	47 @section High-Level Plotting
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	48
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	49 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	50 three-dimensional plots using high-level functions.
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	51
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	52 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	53 and @ref{Advanced Plotting}.
6888 b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe] jwe parents: 6877 diff changeset	54
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe] jwe parents: 6877 diff changeset	55 @menu
9676 e40835382b68 doc fixes John W. Eaton <jwe@octave.org> parents: 9672 diff changeset	56 * Two-Dimensional Plots::
e40835382b68 doc fixes John W. Eaton <jwe@octave.org> parents: 9672 diff changeset	57 * Three-Dimensional Plotting::
e40835382b68 doc fixes John W. Eaton <jwe@octave.org> parents: 9672 diff changeset	58 * Plot Annotations::
e40835382b68 doc fixes John W. Eaton <jwe@octave.org> parents: 9672 diff changeset	59 * Multiple Plots on One Page::
e40835382b68 doc fixes John W. Eaton <jwe@octave.org> parents: 9672 diff changeset	60 * Multiple Plot Windows::
e40835382b68 doc fixes John W. Eaton <jwe@octave.org> parents: 9672 diff changeset	61 * Printing Plots::
e40835382b68 doc fixes John W. Eaton <jwe@octave.org> parents: 9672 diff changeset	62 * Interacting with plots::
e40835382b68 doc fixes John W. Eaton <jwe@octave.org> parents: 9672 diff changeset	63 * Test Plotting Functions::
3294 bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	64 @end menu
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	65
6888 b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe] jwe parents: 6877 diff changeset	66 @node Two-Dimensional Plots
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe] jwe parents: 6877 diff changeset	67 @subsection Two-Dimensional Plots
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe] jwe parents: 6877 diff changeset	68
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe] jwe parents: 6877 diff changeset	69 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	70 linear axes. For example,
3294 bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	71
6888 b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe] jwe parents: 6877 diff changeset	72 @example
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe] jwe parents: 6877 diff changeset	73 @group
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe] jwe parents: 6877 diff changeset	74 x = -10:0.1:10;
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe] jwe parents: 6877 diff changeset	75 plot (x, sin (x));
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe] jwe parents: 6877 diff changeset	76 @end group
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe] jwe parents: 6877 diff changeset	77 @end example
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe] jwe parents: 6877 diff changeset	78
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe] jwe parents: 6877 diff changeset	79 @noindent
6899 110c5782fe3b [project @ 2007-09-14 15:17:53 by jwe] jwe parents: 6892 diff changeset	80 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	81 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	82
6888 b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe] jwe parents: 6877 diff changeset	83 @float Figure,fig:plot
9088 77e71f3da3d6 Fix documentation image printing under new development code Rik <rdrider0-list@yahoo.com> parents: 9040 diff changeset	84 @center @image{plot,4in}
6888 b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe] jwe parents: 6877 diff changeset	85 @caption{Simple Two-Dimensional Plot.}
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe] jwe parents: 6877 diff changeset	86 @end float
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe] jwe parents: 6877 diff changeset	87
5134 0309b6722ee9 [project @ 2005-02-08 20:17:55 by jwe] jwe parents: 5016 diff changeset	88 @DOCSTRING(plot)
0309b6722ee9 [project @ 2005-02-08 20:17:55 by jwe] jwe parents: 5016 diff changeset	89
8817 03b7f618ab3d include docstrings for new functions in the manual John W. Eaton <jwe@octave.org> parents: 8519 diff changeset	90 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	91 independent y axes.
03b7f618ab3d include docstrings for new functions in the manual John W. Eaton <jwe@octave.org> parents: 8519 diff changeset	92
03b7f618ab3d include docstrings for new functions in the manual John W. Eaton <jwe@octave.org> parents: 8519 diff changeset	93 @DOCSTRING(plotyy)
03b7f618ab3d include docstrings for new functions in the manual John W. Eaton <jwe@octave.org> parents: 8519 diff changeset	94
6888 b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe] jwe parents: 6877 diff changeset	95 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	96 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	97 both of the axes use log scales.
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe] jwe parents: 6877 diff changeset	98
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe] jwe parents: 6877 diff changeset	99 @DOCSTRING(semilogx)
6502 6ab0a8767780 [project @ 2007-04-06 03:32:06 by jwe] jwe parents: 6331 diff changeset	100
6888 b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe] jwe parents: 6877 diff changeset	101 @DOCSTRING(semilogy)
6502 6ab0a8767780 [project @ 2007-04-06 03:32:06 by jwe] jwe parents: 6331 diff changeset	102
6888 b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe] jwe parents: 6877 diff changeset	103 @DOCSTRING(loglog)
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe] jwe parents: 6877 diff changeset	104
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe] jwe parents: 6877 diff changeset	105 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	106 are useful for displaying discrete data. For example,
5134 0309b6722ee9 [project @ 2005-02-08 20:17:55 by jwe] jwe parents: 5016 diff changeset	107
6888 b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe] jwe parents: 6877 diff changeset	108 @example
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe] jwe parents: 6877 diff changeset	109 @group
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe] jwe parents: 6877 diff changeset	110 hist (randn (10000, 1), 30);
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe] jwe parents: 6877 diff changeset	111 @end group
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe] jwe parents: 6877 diff changeset	112 @end example
5134 0309b6722ee9 [project @ 2005-02-08 20:17:55 by jwe] jwe parents: 5016 diff changeset	113
6888 b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe] jwe parents: 6877 diff changeset	114 @noindent
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe] jwe parents: 6877 diff changeset	115 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	116 shown in @ref{fig:hist}.
5134 0309b6722ee9 [project @ 2005-02-08 20:17:55 by jwe] jwe parents: 5016 diff changeset	117
6888 b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe] jwe parents: 6877 diff changeset	118 @float Figure,fig:hist
9088 77e71f3da3d6 Fix documentation image printing under new development code Rik <rdrider0-list@yahoo.com> parents: 9040 diff changeset	119 @center @image{hist,4in}
6888 b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe] jwe parents: 6877 diff changeset	120 @caption{Histogram.}
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe] jwe parents: 6877 diff changeset	121 @end float
5134 0309b6722ee9 [project @ 2005-02-08 20:17:55 by jwe] jwe parents: 5016 diff changeset	122
0309b6722ee9 [project @ 2005-02-08 20:17:55 by jwe] jwe parents: 5016 diff changeset	123 @DOCSTRING(bar)
0309b6722ee9 [project @ 2005-02-08 20:17:55 by jwe] jwe parents: 5016 diff changeset	124
6877 ab11bdb09820 [project @ 2007-09-07 05:12:32 by jwe] jwe parents: 6788 diff changeset	125 @DOCSTRING(barh)
ab11bdb09820 [project @ 2007-09-07 05:12:32 by jwe] jwe parents: 6788 diff changeset	126
6888 b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe] jwe parents: 6877 diff changeset	127 @DOCSTRING(hist)
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe] jwe parents: 6877 diff changeset	128
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe] jwe parents: 6877 diff changeset	129 @DOCSTRING(stairs)
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe] jwe parents: 6877 diff changeset	130
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe] jwe parents: 6877 diff changeset	131 @DOCSTRING(stem)
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe] jwe parents: 6877 diff changeset	132
8817 03b7f618ab3d include docstrings for new functions in the manual John W. Eaton <jwe@octave.org> parents: 8519 diff changeset	133 @DOCSTRING(stem3)
03b7f618ab3d include docstrings for new functions in the manual John W. Eaton <jwe@octave.org> parents: 8519 diff changeset	134
03b7f618ab3d include docstrings for new functions in the manual John W. Eaton <jwe@octave.org> parents: 8519 diff changeset	135 @DOCSTRING(scatter)
03b7f618ab3d include docstrings for new functions in the manual John W. Eaton <jwe@octave.org> parents: 8519 diff changeset	136
03b7f618ab3d include docstrings for new functions in the manual John W. Eaton <jwe@octave.org> parents: 8519 diff changeset	137 @DOCSTRING(plotmatrix)
03b7f618ab3d include docstrings for new functions in the manual John W. Eaton <jwe@octave.org> parents: 8519 diff changeset	138
03b7f618ab3d include docstrings for new functions in the manual John W. Eaton <jwe@octave.org> parents: 8519 diff changeset	139 @DOCSTRING(pareto)
03b7f618ab3d include docstrings for new functions in the manual John W. Eaton <jwe@octave.org> parents: 8519 diff changeset	140
03b7f618ab3d include docstrings for new functions in the manual John W. Eaton <jwe@octave.org> parents: 8519 diff changeset	141 @DOCSTRING(rose)
03b7f618ab3d include docstrings for new functions in the manual John W. Eaton <jwe@octave.org> parents: 8519 diff changeset	142
7981 90413830b690 Document contourf David Bateman <dbateman@free.fr> parents: 7980 diff changeset	143 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	144 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	145
5134 0309b6722ee9 [project @ 2005-02-08 20:17:55 by jwe] jwe parents: 5016 diff changeset	146 @DOCSTRING(contour)
0309b6722ee9 [project @ 2005-02-08 20:17:55 by jwe] jwe parents: 5016 diff changeset	147
7981 90413830b690 Document contourf David Bateman <dbateman@free.fr> parents: 7980 diff changeset	148 @DOCSTRING(contourf)
90413830b690 Document contourf David Bateman <dbateman@free.fr> parents: 7980 diff changeset	149
6502 6ab0a8767780 [project @ 2007-04-06 03:32:06 by jwe] jwe parents: 6331 diff changeset	150 @DOCSTRING(contourc)
6ab0a8767780 [project @ 2007-04-06 03:32:06 by jwe] jwe parents: 6331 diff changeset	151
8817 03b7f618ab3d include docstrings for new functions in the manual John W. Eaton <jwe@octave.org> parents: 8519 diff changeset	152 @DOCSTRING(contour3)
03b7f618ab3d include docstrings for new functions in the manual John W. Eaton <jwe@octave.org> parents: 8519 diff changeset	153
6888 b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe] jwe parents: 6877 diff changeset	154 The @code{errorbar}, @code{semilogxerr}, @code{semilogyerr}, and
8347 fa78cb8d8a5c corrections for typos Brian Gough<bjg@network-theory.co.uk> parents: 8325 diff changeset	155 @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	156 example,
6877 ab11bdb09820 [project @ 2007-09-07 05:12:32 by jwe] jwe parents: 6788 diff changeset	157
6888 b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe] jwe parents: 6877 diff changeset	158 @example
9088 77e71f3da3d6 Fix documentation image printing under new development code Rik <rdrider0-list@yahoo.com> parents: 9040 diff changeset	159 @group
6888 b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe] jwe parents: 6877 diff changeset	160 x = 0:0.1:10;
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe] jwe parents: 6877 diff changeset	161 y = sin (x);
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe] jwe parents: 6877 diff changeset	162 yp = 0.1 .* randn (size (x));
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe] jwe parents: 6877 diff changeset	163 ym = -0.1 .* randn (size (x));
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe] jwe parents: 6877 diff changeset	164 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	165 @end group
6888 b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe] jwe parents: 6877 diff changeset	166 @end example
5134 0309b6722ee9 [project @ 2005-02-08 20:17:55 by jwe] jwe parents: 5016 diff changeset	167
6888 b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe] jwe parents: 6877 diff changeset	168 @noindent
6899 110c5782fe3b [project @ 2007-09-14 15:17:53 by jwe] jwe parents: 6892 diff changeset	169 produces the figure shown in @ref{fig:errorbar}.
6502 6ab0a8767780 [project @ 2007-04-06 03:32:06 by jwe] jwe parents: 6331 diff changeset	170
6888 b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe] jwe parents: 6877 diff changeset	171 @float Figure,fig:errorbar
9088 77e71f3da3d6 Fix documentation image printing under new development code Rik <rdrider0-list@yahoo.com> parents: 9040 diff changeset	172 @center @image{errorbar,4in}
6888 b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe] jwe parents: 6877 diff changeset	173 @caption{Errorbar plot.}
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe] jwe parents: 6877 diff changeset	174 @end float
5134 0309b6722ee9 [project @ 2005-02-08 20:17:55 by jwe] jwe parents: 5016 diff changeset	175
0309b6722ee9 [project @ 2005-02-08 20:17:55 by jwe] jwe parents: 5016 diff changeset	176 @DOCSTRING(errorbar)
0309b6722ee9 [project @ 2005-02-08 20:17:55 by jwe] jwe parents: 5016 diff changeset	177
0309b6722ee9 [project @ 2005-02-08 20:17:55 by jwe] jwe parents: 5016 diff changeset	178 @DOCSTRING(semilogxerr)
0309b6722ee9 [project @ 2005-02-08 20:17:55 by jwe] jwe parents: 5016 diff changeset	179
0309b6722ee9 [project @ 2005-02-08 20:17:55 by jwe] jwe parents: 5016 diff changeset	180 @DOCSTRING(semilogyerr)
0309b6722ee9 [project @ 2005-02-08 20:17:55 by jwe] jwe parents: 5016 diff changeset	181
6888 b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe] jwe parents: 6877 diff changeset	182 @DOCSTRING(loglogerr)
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe] jwe parents: 6877 diff changeset	183
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe] jwe parents: 6877 diff changeset	184 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	185 polar coordinates. However, the display coordinates remain rectangular
6888 b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe] jwe parents: 6877 diff changeset	186 and linear. For example,
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe] jwe parents: 6877 diff changeset	187
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe] jwe parents: 6877 diff changeset	188 @example
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe] jwe parents: 6877 diff changeset	189 polar (0:0.1:10pi, 0:0.1:10pi);
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe] jwe parents: 6877 diff changeset	190 @end example
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe] jwe parents: 6877 diff changeset	191
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe] jwe parents: 6877 diff changeset	192 @noindent
6899 110c5782fe3b [project @ 2007-09-14 15:17:53 by jwe] jwe parents: 6892 diff changeset	193 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	194
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe] jwe parents: 6877 diff changeset	195 @float Figure,fig:polar
9088 77e71f3da3d6 Fix documentation image printing under new development code Rik <rdrider0-list@yahoo.com> parents: 9040 diff changeset	196 @center @image{polar,4in}
6888 b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe] jwe parents: 6877 diff changeset	197 @caption{Polar plot.}
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe] jwe parents: 6877 diff changeset	198 @end float
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe] jwe parents: 6877 diff changeset	199
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe] jwe parents: 6877 diff changeset	200 @DOCSTRING(polar)
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe] jwe parents: 6877 diff changeset	201
7120 a2174fb073d4 [project @ 2007-11-07 21:26:43 by jwe] jwe parents: 7018 diff changeset	202 @DOCSTRING(pie)
a2174fb073d4 [project @ 2007-11-07 21:26:43 by jwe] jwe parents: 7018 diff changeset	203
a2174fb073d4 [project @ 2007-11-07 21:26:43 by jwe] jwe parents: 7018 diff changeset	204 @DOCSTRING(quiver)
a2174fb073d4 [project @ 2007-11-07 21:26:43 by jwe] jwe parents: 7018 diff changeset	205
8817 03b7f618ab3d include docstrings for new functions in the manual John W. Eaton <jwe@octave.org> parents: 8519 diff changeset	206 @DOCSTRING(quiver3)
03b7f618ab3d include docstrings for new functions in the manual John W. Eaton <jwe@octave.org> parents: 8519 diff changeset	207
03b7f618ab3d include docstrings for new functions in the manual John W. Eaton <jwe@octave.org> parents: 8519 diff changeset	208 @DOCSTRING(compass)
03b7f618ab3d include docstrings for new functions in the manual John W. Eaton <jwe@octave.org> parents: 8519 diff changeset	209
03b7f618ab3d include docstrings for new functions in the manual John W. Eaton <jwe@octave.org> parents: 8519 diff changeset	210 @DOCSTRING(feather)
03b7f618ab3d include docstrings for new functions in the manual John W. Eaton <jwe@octave.org> parents: 8519 diff changeset	211
7120 a2174fb073d4 [project @ 2007-11-07 21:26:43 by jwe] jwe parents: 7018 diff changeset	212 @DOCSTRING(pcolor)
a2174fb073d4 [project @ 2007-11-07 21:26:43 by jwe] jwe parents: 7018 diff changeset	213
7153 4246642e9f48 [project @ 2007-11-09 21:20:07 by dbateman] dbateman parents: 7120 diff changeset	214 @DOCSTRING(area)
4246642e9f48 [project @ 2007-11-09 21:20:07 by dbateman] dbateman parents: 7120 diff changeset	215
8817 03b7f618ab3d include docstrings for new functions in the manual John W. Eaton <jwe@octave.org> parents: 8519 diff changeset	216 @DOCSTRING(comet)
03b7f618ab3d include docstrings for new functions in the manual John W. Eaton <jwe@octave.org> parents: 8519 diff changeset	217
6888 b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe] jwe parents: 6877 diff changeset	218 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	219 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	220 appearance of tic marks.
6888 b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe] jwe parents: 6877 diff changeset	221
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe] jwe parents: 6877 diff changeset	222 @DOCSTRING(axis)
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe] jwe parents: 6877 diff changeset	223
7189 e8d953d03f6a [project @ 2007-11-26 20:42:09 by dbateman] dbateman parents: 7153 diff changeset	224 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	225 function.
e8d953d03f6a [project @ 2007-11-26 20:42:09 by dbateman] dbateman parents: 7153 diff changeset	226
e8d953d03f6a [project @ 2007-11-26 20:42:09 by dbateman] dbateman parents: 7153 diff changeset	227 @DOCSTRING(caxis)
e8d953d03f6a [project @ 2007-11-26 20:42:09 by dbateman] dbateman parents: 7153 diff changeset	228
8817 03b7f618ab3d include docstrings for new functions in the manual John W. Eaton <jwe@octave.org> parents: 8519 diff changeset	229 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	230 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	231
03b7f618ab3d include docstrings for new functions in the manual John W. Eaton <jwe@octave.org> parents: 8519 diff changeset	232 @anchor{doc-ylim}
03b7f618ab3d include docstrings for new functions in the manual John W. Eaton <jwe@octave.org> parents: 8519 diff changeset	233 @anchor{doc-zlim}
03b7f618ab3d include docstrings for new functions in the manual John W. Eaton <jwe@octave.org> parents: 8519 diff changeset	234 @DOCSTRING(xlim)
03b7f618ab3d include docstrings for new functions in the manual John W. Eaton <jwe@octave.org> parents: 8519 diff changeset	235
7989 23c248d415b5 Various doc fixes. Readd cellidx David Bateman <dbateman@free.fr> parents: 7984 diff changeset	236 @menu
9676 e40835382b68 doc fixes John W. Eaton <jwe@octave.org> parents: 9672 diff changeset	237 * Two-dimensional Function Plotting::
7989 23c248d415b5 Various doc fixes. Readd cellidx David Bateman <dbateman@free.fr> parents: 7984 diff changeset	238 @end menu
23c248d415b5 Various doc fixes. Readd cellidx David Bateman <dbateman@free.fr> parents: 7984 diff changeset	239
7984 bbaa5d7d0143 Some documentation updates David Bateman <dbateman@free.fr> parents: 7981 diff changeset	240 @node Two-dimensional Function Plotting
bbaa5d7d0143 Some documentation updates David Bateman <dbateman@free.fr> parents: 7981 diff changeset	241 @subsubsection Two-dimensional Function Plotting
bbaa5d7d0143 Some documentation updates David Bateman <dbateman@free.fr> parents: 7981 diff changeset	242
bbaa5d7d0143 Some documentation updates David Bateman <dbateman@free.fr> parents: 7981 diff changeset	243 Octave can plot a function from a function handle inline function or
bbaa5d7d0143 Some documentation updates David Bateman <dbateman@free.fr> parents: 7981 diff changeset	244 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	245 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	246 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	247 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	248 example,
bbaa5d7d0143 Some documentation updates David Bateman <dbateman@free.fr> parents: 7981 diff changeset	249
bbaa5d7d0143 Some documentation updates David Bateman <dbateman@free.fr> parents: 7981 diff changeset	250 @example
bbaa5d7d0143 Some documentation updates David Bateman <dbateman@free.fr> parents: 7981 diff changeset	251 @group
bbaa5d7d0143 Some documentation updates David Bateman <dbateman@free.fr> parents: 7981 diff changeset	252 fplot (@@sin, [-10, 10], 201);
bbaa5d7d0143 Some documentation updates David Bateman <dbateman@free.fr> parents: 7981 diff changeset	253 @end group
bbaa5d7d0143 Some documentation updates David Bateman <dbateman@free.fr> parents: 7981 diff changeset	254 @end example
bbaa5d7d0143 Some documentation updates David Bateman <dbateman@free.fr> parents: 7981 diff changeset	255
bbaa5d7d0143 Some documentation updates David Bateman <dbateman@free.fr> parents: 7981 diff changeset	256 @noindent
bbaa5d7d0143 Some documentation updates David Bateman <dbateman@free.fr> parents: 7981 diff changeset	257 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	258 legend displaying the name of the plotted function.
bbaa5d7d0143 Some documentation updates David Bateman <dbateman@free.fr> parents: 7981 diff changeset	259
bbaa5d7d0143 Some documentation updates David Bateman <dbateman@free.fr> parents: 7981 diff changeset	260 @DOCSTRING(fplot)
bbaa5d7d0143 Some documentation updates David Bateman <dbateman@free.fr> parents: 7981 diff changeset	261
bbaa5d7d0143 Some documentation updates David Bateman <dbateman@free.fr> parents: 7981 diff changeset	262 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	263 function include @code{ezplot}, @code{ezcontour}, @code{ezcontourf} and
8046 c4482fc30c7f Add the ezplot function David Bateman <dbateman@free.fr> parents: 7989 diff changeset	264 @code{ezpolar}.
c4482fc30c7f Add the ezplot function David Bateman <dbateman@free.fr> parents: 7989 diff changeset	265
c4482fc30c7f Add the ezplot function David Bateman <dbateman@free.fr> parents: 7989 diff changeset	266 @DOCSTRING(ezplot)
7984 bbaa5d7d0143 Some documentation updates David Bateman <dbateman@free.fr> parents: 7981 diff changeset	267
bbaa5d7d0143 Some documentation updates David Bateman <dbateman@free.fr> parents: 7981 diff changeset	268 @DOCSTRING(ezcontour)
bbaa5d7d0143 Some documentation updates David Bateman <dbateman@free.fr> parents: 7981 diff changeset	269
bbaa5d7d0143 Some documentation updates David Bateman <dbateman@free.fr> parents: 7981 diff changeset	270 @DOCSTRING(ezcontourf)
bbaa5d7d0143 Some documentation updates David Bateman <dbateman@free.fr> parents: 7981 diff changeset	271
bbaa5d7d0143 Some documentation updates David Bateman <dbateman@free.fr> parents: 7981 diff changeset	272 @DOCSTRING(ezpolar)
bbaa5d7d0143 Some documentation updates David Bateman <dbateman@free.fr> parents: 7981 diff changeset	273
5134 0309b6722ee9 [project @ 2005-02-08 20:17:55 by jwe] jwe parents: 5016 diff changeset	274 @node Three-Dimensional Plotting
6888 b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe] jwe parents: 6877 diff changeset	275 @subsection Three-Dimensional Plotting
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe] jwe parents: 6877 diff changeset	276
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe] jwe parents: 6877 diff changeset	277 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	278
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe] jwe parents: 6877 diff changeset	279 @example
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe] jwe parents: 6877 diff changeset	280 @group
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe] jwe parents: 6877 diff changeset	281 tx = ty = linspace (-8, 8, 41)';
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe] jwe parents: 6877 diff changeset	282 [xx, yy] = meshgrid (tx, ty);
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe] jwe parents: 6877 diff changeset	283 r = sqrt (xx .^ 2 + yy .^ 2) + eps;
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe] jwe parents: 6877 diff changeset	284 tz = sin (r) ./ r;
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe] jwe parents: 6877 diff changeset	285 mesh (tx, ty, tz);
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe] jwe parents: 6877 diff changeset	286 @end group
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe] jwe parents: 6877 diff changeset	287 @end example
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe] jwe parents: 6877 diff changeset	288
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe] jwe parents: 6877 diff changeset	289 @noindent
6899 110c5782fe3b [project @ 2007-09-14 15:17:53 by jwe] jwe parents: 6892 diff changeset	290 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	291 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	292 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	293 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	294
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe] jwe parents: 6877 diff changeset	295 @float Figure,fig:mesh
9088 77e71f3da3d6 Fix documentation image printing under new development code Rik <rdrider0-list@yahoo.com> parents: 9040 diff changeset	296 @center @image{mesh,4in}
6888 b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe] jwe parents: 6877 diff changeset	297 @caption{Mesh plot.}
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe] jwe parents: 6877 diff changeset	298 @end float
5134 0309b6722ee9 [project @ 2005-02-08 20:17:55 by jwe] jwe parents: 5016 diff changeset	299
6888 b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe] jwe parents: 6877 diff changeset	300 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	301 plot of contours for the surface.
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe] jwe parents: 6877 diff changeset	302
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe] jwe parents: 6877 diff changeset	303 The @code{plot3} function displays arbitrary three-dimensional data,
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe] jwe parents: 6877 diff changeset	304 without requiring it to form a surface. For example
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe] jwe parents: 6877 diff changeset	305
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe] jwe parents: 6877 diff changeset	306 @example
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe] jwe parents: 6877 diff changeset	307 @group
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe] jwe parents: 6877 diff changeset	308 t = 0:0.1:10*pi;
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe] jwe parents: 6877 diff changeset	309 r = linspace (0, 1, numel (t));
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe] jwe parents: 6877 diff changeset	310 z = linspace (0, 1, numel (t));
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe] jwe parents: 6877 diff changeset	311 plot3 (r.sin(t), r.cos(t), z);
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe] jwe parents: 6877 diff changeset	312 @end group
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe] jwe parents: 6877 diff changeset	313 @end example
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe] jwe parents: 6877 diff changeset	314
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe] jwe parents: 6877 diff changeset	315 @noindent
6899 110c5782fe3b [project @ 2007-09-14 15:17:53 by jwe] jwe parents: 6892 diff changeset	316 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	317
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe] jwe parents: 6877 diff changeset	318 @float Figure,fig:plot3
9088 77e71f3da3d6 Fix documentation image printing under new development code Rik <rdrider0-list@yahoo.com> parents: 9040 diff changeset	319 @center @image{plot3,4in}
6888 b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe] jwe parents: 6877 diff changeset	320 @caption{Three dimensional spiral.}
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe] jwe parents: 6877 diff changeset	321 @end float
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe] jwe parents: 6877 diff changeset	322
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe] jwe parents: 6877 diff changeset	323 Finally, the @code{view} function changes the viewpoint for
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe] jwe parents: 6877 diff changeset	324 three-dimensional plots.
5134 0309b6722ee9 [project @ 2005-02-08 20:17:55 by jwe] jwe parents: 5016 diff changeset	325
0309b6722ee9 [project @ 2005-02-08 20:17:55 by jwe] jwe parents: 5016 diff changeset	326 @DOCSTRING(mesh)
0309b6722ee9 [project @ 2005-02-08 20:17:55 by jwe] jwe parents: 5016 diff changeset	327
6788 c81a0f3f5a82 [project @ 2007-07-23 22:05:29 by dbateman] dbateman parents: 6778 diff changeset	328 @DOCSTRING(meshc)
c81a0f3f5a82 [project @ 2007-07-23 22:05:29 by dbateman] dbateman parents: 6778 diff changeset	329
8817 03b7f618ab3d include docstrings for new functions in the manual John W. Eaton <jwe@octave.org> parents: 8519 diff changeset	330 @DOCSTRING(meshz)
03b7f618ab3d include docstrings for new functions in the manual John W. Eaton <jwe@octave.org> parents: 8519 diff changeset	331
7153 4246642e9f48 [project @ 2007-11-09 21:20:07 by dbateman] dbateman parents: 7120 diff changeset	332 @DOCSTRING(hidden)
4246642e9f48 [project @ 2007-11-09 21:20:07 by dbateman] dbateman parents: 7120 diff changeset	333
7120 a2174fb073d4 [project @ 2007-11-07 21:26:43 by jwe] jwe parents: 7018 diff changeset	334 @DOCSTRING(surf)
a2174fb073d4 [project @ 2007-11-07 21:26:43 by jwe] jwe parents: 7018 diff changeset	335
a2174fb073d4 [project @ 2007-11-07 21:26:43 by jwe] jwe parents: 7018 diff changeset	336 @DOCSTRING(surfc)
a2174fb073d4 [project @ 2007-11-07 21:26:43 by jwe] jwe parents: 7018 diff changeset	337
8817 03b7f618ab3d include docstrings for new functions in the manual John W. Eaton <jwe@octave.org> parents: 8519 diff changeset	338 @DOCSTRING(surfl)
03b7f618ab3d include docstrings for new functions in the manual John W. Eaton <jwe@octave.org> parents: 8519 diff changeset	339
03b7f618ab3d include docstrings for new functions in the manual John W. Eaton <jwe@octave.org> parents: 8519 diff changeset	340 @DOCSTRING(surfnorm)
03b7f618ab3d include docstrings for new functions in the manual John W. Eaton <jwe@octave.org> parents: 8519 diff changeset	341
03b7f618ab3d include docstrings for new functions in the manual John W. Eaton <jwe@octave.org> parents: 8519 diff changeset	342 @DOCSTRING(diffuse)
03b7f618ab3d include docstrings for new functions in the manual John W. Eaton <jwe@octave.org> parents: 8519 diff changeset	343
03b7f618ab3d include docstrings for new functions in the manual John W. Eaton <jwe@octave.org> parents: 8519 diff changeset	344 @DOCSTRING(specular)
03b7f618ab3d include docstrings for new functions in the manual John W. Eaton <jwe@octave.org> parents: 8519 diff changeset	345
5134 0309b6722ee9 [project @ 2005-02-08 20:17:55 by jwe] jwe parents: 5016 diff changeset	346 @DOCSTRING(meshgrid)
0309b6722ee9 [project @ 2005-02-08 20:17:55 by jwe] jwe parents: 5016 diff changeset	347
6550 1b7a6061a05d [project @ 2007-04-20 07:40:26 by jwe] jwe parents: 6549 diff changeset	348 @DOCSTRING(ndgrid)
1b7a6061a05d [project @ 2007-04-20 07:40:26 by jwe] jwe parents: 6549 diff changeset	349
6888 b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe] jwe parents: 6877 diff changeset	350 @DOCSTRING(plot3)
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe] jwe parents: 6877 diff changeset	351
6502 6ab0a8767780 [project @ 2007-04-06 03:32:06 by jwe] jwe parents: 6331 diff changeset	352 @DOCSTRING(view)
6ab0a8767780 [project @ 2007-04-06 03:32:06 by jwe] jwe parents: 6331 diff changeset	353
8817 03b7f618ab3d include docstrings for new functions in the manual John W. Eaton <jwe@octave.org> parents: 8519 diff changeset	354 @DOCSTRING(slice)
03b7f618ab3d include docstrings for new functions in the manual John W. Eaton <jwe@octave.org> parents: 8519 diff changeset	355
03b7f618ab3d include docstrings for new functions in the manual John W. Eaton <jwe@octave.org> parents: 8519 diff changeset	356 @DOCSTRING(ribbon)
03b7f618ab3d include docstrings for new functions in the manual John W. Eaton <jwe@octave.org> parents: 8519 diff changeset	357
7120 a2174fb073d4 [project @ 2007-11-07 21:26:43 by jwe] jwe parents: 7018 diff changeset	358 @DOCSTRING(shading)
a2174fb073d4 [project @ 2007-11-07 21:26:43 by jwe] jwe parents: 7018 diff changeset	359
9672 43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	360 @DOCSTRING(scatter3)
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	361
7989 23c248d415b5 Various doc fixes. Readd cellidx David Bateman <dbateman@free.fr> parents: 7984 diff changeset	362 @menu
9676 e40835382b68 doc fixes John W. Eaton <jwe@octave.org> parents: 9672 diff changeset	363 * Three-dimensional Function Plotting::
e40835382b68 doc fixes John W. Eaton <jwe@octave.org> parents: 9672 diff changeset	364 * Three-dimensional Geometric Shapes::
7989 23c248d415b5 Various doc fixes. Readd cellidx David Bateman <dbateman@free.fr> parents: 7984 diff changeset	365 @end menu
23c248d415b5 Various doc fixes. Readd cellidx David Bateman <dbateman@free.fr> parents: 7984 diff changeset	366
23c248d415b5 Various doc fixes. Readd cellidx David Bateman <dbateman@free.fr> parents: 7984 diff changeset	367 @node Three-dimensional Function Plotting
23c248d415b5 Various doc fixes. Readd cellidx David Bateman <dbateman@free.fr> parents: 7984 diff changeset	368 @subsubsection Three-dimensional Function Plotting
7984 bbaa5d7d0143 Some documentation updates David Bateman <dbateman@free.fr> parents: 7981 diff changeset	369
bbaa5d7d0143 Some documentation updates David Bateman <dbateman@free.fr> parents: 7981 diff changeset	370 @DOCSTRING(ezplot3)
bbaa5d7d0143 Some documentation updates David Bateman <dbateman@free.fr> parents: 7981 diff changeset	371
bbaa5d7d0143 Some documentation updates David Bateman <dbateman@free.fr> parents: 7981 diff changeset	372 @DOCSTRING(ezmesh)
bbaa5d7d0143 Some documentation updates David Bateman <dbateman@free.fr> parents: 7981 diff changeset	373
bbaa5d7d0143 Some documentation updates David Bateman <dbateman@free.fr> parents: 7981 diff changeset	374 @DOCSTRING(ezmeshc)
bbaa5d7d0143 Some documentation updates David Bateman <dbateman@free.fr> parents: 7981 diff changeset	375
bbaa5d7d0143 Some documentation updates David Bateman <dbateman@free.fr> parents: 7981 diff changeset	376 @DOCSTRING(ezsurf)
bbaa5d7d0143 Some documentation updates David Bateman <dbateman@free.fr> parents: 7981 diff changeset	377
bbaa5d7d0143 Some documentation updates David Bateman <dbateman@free.fr> parents: 7981 diff changeset	378 @DOCSTRING(ezsurfc)
bbaa5d7d0143 Some documentation updates David Bateman <dbateman@free.fr> parents: 7981 diff changeset	379
8817 03b7f618ab3d include docstrings for new functions in the manual John W. Eaton <jwe@octave.org> parents: 8519 diff changeset	380 @node Three-dimensional Geometric Shapes
03b7f618ab3d include docstrings for new functions in the manual John W. Eaton <jwe@octave.org> parents: 8519 diff changeset	381 @subsubsection Three-dimensional Geometric Shapes
03b7f618ab3d include docstrings for new functions in the manual John W. Eaton <jwe@octave.org> parents: 8519 diff changeset	382
03b7f618ab3d include docstrings for new functions in the manual John W. Eaton <jwe@octave.org> parents: 8519 diff changeset	383 @DOCSTRING(cylinder)
03b7f618ab3d include docstrings for new functions in the manual John W. Eaton <jwe@octave.org> parents: 8519 diff changeset	384
03b7f618ab3d include docstrings for new functions in the manual John W. Eaton <jwe@octave.org> parents: 8519 diff changeset	385 @DOCSTRING(sphere)
03b7f618ab3d include docstrings for new functions in the manual John W. Eaton <jwe@octave.org> parents: 8519 diff changeset	386
03b7f618ab3d include docstrings for new functions in the manual John W. Eaton <jwe@octave.org> parents: 8519 diff changeset	387 @DOCSTRING(ellipsoid)
03b7f618ab3d include docstrings for new functions in the manual John W. Eaton <jwe@octave.org> parents: 8519 diff changeset	388
6888 b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe] jwe parents: 6877 diff changeset	389 @node Plot Annotations
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe] jwe parents: 6877 diff changeset	390 @subsection Plot Annotations
6502 6ab0a8767780 [project @ 2007-04-06 03:32:06 by jwe] jwe parents: 6331 diff changeset	391
6888 b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe] jwe parents: 6877 diff changeset	392 You can add titles, axis labels, legends, and arbitrary text to an
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe] jwe parents: 6877 diff changeset	393 existing plot. For example,
6877 ab11bdb09820 [project @ 2007-09-07 05:12:32 by jwe] jwe parents: 6788 diff changeset	394
6888 b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe] jwe parents: 6877 diff changeset	395 @example
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe] jwe parents: 6877 diff changeset	396 @group
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe] jwe parents: 6877 diff changeset	397 x = -10:0.1:10;
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe] jwe parents: 6877 diff changeset	398 plot (x, sin (x));
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe] jwe parents: 6877 diff changeset	399 title ("sin(x) for x = -10:0.1:10");
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe] jwe parents: 6877 diff changeset	400 xlabel ("x");
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe] jwe parents: 6877 diff changeset	401 ylabel ("sin (x)");
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe] jwe parents: 6877 diff changeset	402 text (pi, 0.7, "arbitrary text");
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe] jwe parents: 6877 diff changeset	403 legend ("sin (x)");
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe] jwe parents: 6877 diff changeset	404 @end group
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe] jwe parents: 6877 diff changeset	405 @end example
6502 6ab0a8767780 [project @ 2007-04-06 03:32:06 by jwe] jwe parents: 6331 diff changeset	406
6888 b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe] jwe parents: 6877 diff changeset	407 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	408 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	409 border lines are on.
5134 0309b6722ee9 [project @ 2005-02-08 20:17:55 by jwe] jwe parents: 5016 diff changeset	410
0309b6722ee9 [project @ 2005-02-08 20:17:55 by jwe] jwe parents: 5016 diff changeset	411 @DOCSTRING(title)
0309b6722ee9 [project @ 2005-02-08 20:17:55 by jwe] jwe parents: 5016 diff changeset	412
6502 6ab0a8767780 [project @ 2007-04-06 03:32:06 by jwe] jwe parents: 6331 diff changeset	413 @DOCSTRING(legend)
6ab0a8767780 [project @ 2007-04-06 03:32:06 by jwe] jwe parents: 6331 diff changeset	414
6ab0a8767780 [project @ 2007-04-06 03:32:06 by jwe] jwe parents: 6331 diff changeset	415 @DOCSTRING(text)
6ab0a8767780 [project @ 2007-04-06 03:32:06 by jwe] jwe parents: 6331 diff changeset	416
8428 ee1bc8aa226b Add cross reference from Plot Annotations to Text Properties. Francesco PotortÃ¬ <pot@gnu.org> parents: 8347 diff changeset	417 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	418
8286 6f2d95255911 fix @seealso references to point to existing anchors Thorsten Meyer <thorsten.meyier@gmx.de> parents: 8261 diff changeset	419 @anchor{doc-ylabel}
6f2d95255911 fix @seealso references to point to existing anchors Thorsten Meyer <thorsten.meyier@gmx.de> parents: 8261 diff changeset	420 @anchor{doc-zlabel}
5134 0309b6722ee9 [project @ 2005-02-08 20:17:55 by jwe] jwe parents: 5016 diff changeset	421 @DOCSTRING(xlabel)
0309b6722ee9 [project @ 2005-02-08 20:17:55 by jwe] jwe parents: 5016 diff changeset	422
8817 03b7f618ab3d include docstrings for new functions in the manual John W. Eaton <jwe@octave.org> parents: 8519 diff changeset	423 @DOCSTRING(clabel)
03b7f618ab3d include docstrings for new functions in the manual John W. Eaton <jwe@octave.org> parents: 8519 diff changeset	424
6502 6ab0a8767780 [project @ 2007-04-06 03:32:06 by jwe] jwe parents: 6331 diff changeset	425 @DOCSTRING(box)
6ab0a8767780 [project @ 2007-04-06 03:32:06 by jwe] jwe parents: 6331 diff changeset	426
6ab0a8767780 [project @ 2007-04-06 03:32:06 by jwe] jwe parents: 6331 diff changeset	427 @DOCSTRING(grid)
6ab0a8767780 [project @ 2007-04-06 03:32:06 by jwe] jwe parents: 6331 diff changeset	428
8089 0ec09255515a add colorbar docstring to the manual John W. Eaton <jwe@octave.org> parents: 8073 diff changeset	429 @DOCSTRING(colorbar)
0ec09255515a add colorbar docstring to the manual John W. Eaton <jwe@octave.org> parents: 8073 diff changeset	430
5134 0309b6722ee9 [project @ 2005-02-08 20:17:55 by jwe] jwe parents: 5016 diff changeset	431 @node Multiple Plots on One Page
6888 b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe] jwe parents: 6877 diff changeset	432 @subsection Multiple Plots on One Page
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe] jwe parents: 6877 diff changeset	433
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe] jwe parents: 6877 diff changeset	434 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	435 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	436 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	437 For example,
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe] jwe parents: 6877 diff changeset	438
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe] jwe parents: 6877 diff changeset	439 @example
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe] jwe parents: 6877 diff changeset	440 @group
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe] jwe parents: 6877 diff changeset	441 subplot (2, 1, 1)
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe] jwe parents: 6877 diff changeset	442 fplot (@@sin, [-10, 10]);
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe] jwe parents: 6877 diff changeset	443 subplot (2, 1, 2)
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe] jwe parents: 6877 diff changeset	444 fplot (@@cos, [-10, 10]);
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe] jwe parents: 6877 diff changeset	445 @end group
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe] jwe parents: 6877 diff changeset	446 @end example
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe] jwe parents: 6877 diff changeset	447
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe] jwe parents: 6877 diff changeset	448 @noindent
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe] jwe parents: 6877 diff changeset	449 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	450 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	451 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	452 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	453 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	454
0309b6722ee9 [project @ 2005-02-08 20:17:55 by jwe] jwe parents: 5016 diff changeset	455 @DOCSTRING(subplot)
0309b6722ee9 [project @ 2005-02-08 20:17:55 by jwe] jwe parents: 5016 diff changeset	456
0309b6722ee9 [project @ 2005-02-08 20:17:55 by jwe] jwe parents: 5016 diff changeset	457 @node Multiple Plot Windows
6888 b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe] jwe parents: 6877 diff changeset	458 @subsection Multiple Plot Windows
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe] jwe parents: 6877 diff changeset	459
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe] jwe parents: 6877 diff changeset	460 You can open multiple plot windows using the @code{figure} function.
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe] jwe parents: 6877 diff changeset	461 For example
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe] jwe parents: 6877 diff changeset	462
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe] jwe parents: 6877 diff changeset	463 @example
9088 77e71f3da3d6 Fix documentation image printing under new development code Rik <rdrider0-list@yahoo.com> parents: 9040 diff changeset	464 @group
6888 b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe] jwe parents: 6877 diff changeset	465 figure (1);
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe] jwe parents: 6877 diff changeset	466 fplot (@@sin, [-10, 10]);
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe] jwe parents: 6877 diff changeset	467 figure (2);
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe] jwe parents: 6877 diff changeset	468 fplot (@@cos, [-10, 10]);
9088 77e71f3da3d6 Fix documentation image printing under new development code Rik <rdrider0-list@yahoo.com> parents: 9040 diff changeset	469 @end group
6888 b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe] jwe parents: 6877 diff changeset	470 @end example
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe] jwe parents: 6877 diff changeset	471
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe] jwe parents: 6877 diff changeset	472 @noindent
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe] jwe parents: 6877 diff changeset	473 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	474 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	475
0309b6722ee9 [project @ 2005-02-08 20:17:55 by jwe] jwe parents: 5016 diff changeset	476 @DOCSTRING(figure)
9672 43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	477 @subsection Use of @code{axis}, @code{line}, and @code{patch} functions
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	478 @cindex use of @code{axis}, @code{line}, and @code{patch} functions
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	479
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	480 You can create axes, line, and patch objects directly using the
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	481 @code{axes}, @code{line}, and @code{patch} functions. These objects
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	482 become children of the current axes object.
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	483
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	484 @DOCSTRING(axes)
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	485 @DOCSTRING(line)
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	486 @DOCSTRING(patch)
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	487
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	488 @DOCSTRING(fill)
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	489
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	490 @DOCSTRING(surface)
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	491
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	492 @subsection Manipulation of plot windows
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	493 @cindex manipulation of plot windows
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	494
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	495 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	496 or when waiting for input. The
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	497 @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	498
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	499 @DOCSTRING(drawnow)
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	500
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	501 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	502 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	503 it is not modified.
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	504
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	505 @DOCSTRING(refresh)
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	506
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	507 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	508 @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	509 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	510 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	511 function. For example,
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	512
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	513 @example
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	514 @group
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	515 hold on;
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	516 x = -10:0.1:10;
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	517 plot (x, sin (x));
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	518 plot (x, cos (x));
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	519 hold off;
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	520 @end group
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	521 @end example
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	522
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	523 @noindent
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	524 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	525 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	526 plot.
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	527
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	528 @DOCSTRING(newplot)
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	529
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	530 @DOCSTRING(hold)
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	531
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	532 @DOCSTRING(ishold)
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	533 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	534 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	535 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	536 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	537 figure window, call the @code{close} function.
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	538
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	539 @DOCSTRING(clf)
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(cla)
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 @DOCSTRING(shg)
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	544
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	545 @DOCSTRING(delete)
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(close)
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 @DOCSTRING(closereq)
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	550
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	551 @subsection Use of the @code{interpreter} Property
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	552 @cindex use of the @code{interpreter} property
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	553
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	554 All text objects, including titles, labels, legends, and text, include
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	555 the property 'interpreter', this property determines the manner in which
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	556 special control sequences in the text are rendered. If the interpreter
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	557 is set to 'none', then no rendering occurs. At this point the 'latex'
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	558 option is not implemented and so the 'latex' interpreter also does not
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	559 interpret the text.
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	560
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	561 The 'tex' option implements a subset of @sc{TeX} functionality in the
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	562 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	563 such as Greek or mathematical symbols within the text. The special
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	564 characters are also inserted with a code starting with the back-slash
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	565 (\) character, as in the table @ref{tab:extended}.
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	566
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	567 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	568 with the codes
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 @multitable @columnfractions .2 .2 .6 .2
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	571 @item @tab \bf @tab Bold font @tab
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	572 @item @tab \it @tab Italic font @tab
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	573 @item @tab \sl @tab Oblique Font @tab
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	574 @item @tab \rm @tab Normal font @tab
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	575 @end multitable
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	576
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	577 These are be used in conjunction with the @{ and @} characters to limit
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	578 the change in the font to part of the string. For example
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	579
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	580 @example
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	581 xlabel ('@{\bf H@} = a @{\bf V@}')
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	582 @end example
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	583
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	584 where the character 'a' will not appear in a bold font. Note that to
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	585 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	586 the strings should be in single quotes.
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	587
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	588 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	589
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	590 @multitable @columnfractions .1 .4 .6 .1
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	591 @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	592 @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	593 use @tab
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	594 @end multitable
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 Finally, the superscript and subscripting can be controlled with the '^'
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	597 and '_' characters. If the '^' or '_' is followed by a @{ character,
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	598 then all of the block surrounded by the @{ @} pair is super- or
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	599 sub-scripted. Without the @{ @} pair, only the character immediately
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	600 following the '^' or '_' is super- or sub-scripted.
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	601
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	602 @float Table,tab:extended
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	603 @tex
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	604 \vskip 6pt
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	605 {\hbox to \hsize {\hfill\vbox{\offinterlineskip \tabskip=0pt
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	606 \halign{
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	607 \vrule height2.0ex depth1.ex width 0.6pt #\tabskip=0.3em &
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	608 # \hfil & \vrule # & # \hfil & # \vrule &
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	609 # \hfil & \vrule # & # \hfil & # \vrule &
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	610 # \hfil & \vrule # & # \hfil & # \vrule
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	611 width 0.6pt \tabskip=0pt\cr
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	612 \noalign{\hrule height 0.6pt}
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	613 & Code && Sym && Code && Sym && Code && Sym &\cr
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	614 \noalign{\hrule}
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	615 & $\backslash$forall && $\forall$
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	616 && $\backslash$exists && $\exists$
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	617 && $\backslash$ni && $\ni$ &\cr
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	618 & $\backslash$cong && $\cong$
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	619 && $\backslash$Delta && $\Delta$
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	620 && $\backslash$Phi && $\Phi$ &\cr
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	621 & $\backslash$Gamma && $\Gamma$
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	622 && $\backslash$vartheta && $\vartheta$
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	623 && $\backslash$Lambda && $\Lambda$ &\cr
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	624 & $\backslash$Pi && $\Pi$
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	625 && $\backslash$Theta && $\Theta$
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	626 && $\backslash$Sigma && $\Sigma$ &\cr
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	627 & $\backslash$varsigma && $\varsigma$
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	628 && $\backslash$Omega && $\Omega$
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	629 && $\backslash$Xi && $\Xi$ &\cr
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	630 & $\backslash$Psi && $\Psi$
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	631 && $\backslash$perp && $\perp$
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	632 && $\backslash$alpha && $\alpha$ &\cr
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	633 & $\backslash$beta && $\beta$
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	634 && $\backslash$chi && $\chi$
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	635 && $\backslash$delta && $\delta$ &\cr
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	636 & $\backslash$epsilon && $\epsilon$
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	637 && $\backslash$phi && $\phi$
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	638 && $\backslash$gamma && $\gamma$ &\cr
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	639 & $\backslash$eta && $\eta$
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	640 && $\backslash$iota && $\iota$
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	641 && $\backslash$varphi && $\varphi$ &\cr
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	642 & $\backslash$kappa && $\kappa$
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	643 && $\backslash$lambda && $\lambda$
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	644 && $\backslash$mu && $\mu$ &\cr
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	645 & $\backslash$nu && $\nu$
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	646 && $\backslash$o && $\o$
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	647 && $\backslash$pi && $\pi$ &\cr
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	648 & $\backslash$theta && $\theta$
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	649 && $\backslash$rho && $\rho$
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	650 && $\backslash$sigma && $\sigma$ &\cr
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	651 & $\backslash$tau && $\tau$
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	652 && $\backslash$upsilon && $\upsilon$
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	653 && $\backslash$varpi && $\varpi$ &\cr
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	654 & $\backslash$omega && $\omega$
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	655 && $\backslash$xi && $\xi$
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	656 && $\backslash$psi && $\psi$ &\cr
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	657 & $\backslash$zeta && $\zeta$
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	658 && $\backslash$sim && $\sim$
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	659 && $\backslash$Upsilon && $\Upsilon$ &\cr
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	660 & $\backslash$prime && $\prime$
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	661 && $\backslash$leq && $\leq$
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	662 && $\backslash$infty && $\infty$ &\cr
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	663 & $\backslash$clubsuit && $\clubsuit$
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	664 && $\backslash$diamondsuit && $\diamondsuit$
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	665 && $\backslash$heartsuit && $\heartsuit$ &\cr
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	666 & $\backslash$spadesuit && $\spadesuit$
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	667 && $\backslash$leftrightarrow && $\leftrightarrow$
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	668 && $\backslash$leftarrow && $\leftarrow$ &\cr
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	669 & $\backslash$uparrow && $\uparrow$
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	670 && $\backslash$rightarrow && $\rightarrow$
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	671 && $\backslash$downarrow && $\downarrow$ &\cr
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	672 & $\backslash$circ && $\circ$
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	673 && $\backslash$pm && $\pm$
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	674 && $\backslash$geq && $\geq$ &\cr
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	675 & $\backslash$times && $\times$
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	676 && $\backslash$propto && $\propto$
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	677 && $\backslash$partial && $\partial$ &\cr
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	678 & $\backslash$bullet && $\bullet$
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	679 && $\backslash$div && $\div$
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	680 && $\backslash$neq && $\neq$ &\cr
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	681 & $\backslash$equiv && $\equiv$
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	682 && $\backslash$approx && $\approx$
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	683 && $\backslash$ldots && $\ldots$ &\cr
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	684 & $\backslash$mid && $\mid$
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	685 && $\backslash$aleph && $\aleph$
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	686 && $\backslash$Im && $\Im$ &\cr
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	687 & $\backslash$Re && $\Re$
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	688 && $\backslash$wp && $\wp$
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	689 && $\backslash$otimes && $\otimes$ &\cr
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	690 & $\backslash$oplus && $\oplus$
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	691 && $\backslash$oslash && $\oslash$
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	692 && $\backslash$cap && $\cap$ &\cr
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	693 & $\backslash$cup && $\cup$
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	694 && $\backslash$supset && $\supset$
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	695 && $\backslash$supseteq && $\supseteq$ &\cr
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	696 & $\backslash$subset && $\subset$
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	697 && $\backslash$subseteq && $\subseteq$
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	698 && $\backslash$in && $\in$ &\cr
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	699 & $\backslash$notin && $\notin$
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	700 && $\backslash$angle && $\angle$
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	701 && $\backslash$bigtriangledown && $\bigtriangledown$ &\cr
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	702 & $\backslash$langle && $\langle$
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	703 && $\backslash$rangle && $\rangle$
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	704 && $\backslash$nabla && $\nabla$ &\cr
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	705 & $\backslash$prod && $\prod$
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	706 && $\backslash$surd && $\surd$
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	707 && $\backslash$cdot && $\cdot$ &\cr
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	708 & $\backslash$neg && $\neg$
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	709 && $\backslash$wedge && $\wedge$
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	710 && $\backslash$vee && $\vee$ &\cr
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	711 & $\backslash$Leftrightarrow && $\Leftrightarrow$
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	712 && $\backslash$Leftarrow && $\Leftarrow$
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	713 && $\backslash$Uparrow && $\Uparrow$ &\cr
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	714 & $\backslash$Rightarrow && $\Rightarrow$
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	715 && $\backslash$Downarrow && $\Downarrow$
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	716 && $\backslash$diamond && $\diamond$ &\cr
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	717 & $\backslash$copyright && $\copyright$
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	718 && $\backslash$rfloor && $\rfloor$
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	719 && $\backslash$lceil && $\lceil$ &\cr
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	720 & $\backslash$lfloor && $\lfloor$
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	721 && $\backslash$rceil && $\rceil$
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	722 && $\backslash$int && $\int$ &\cr
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	723 \noalign{\hrule height 0.6pt}
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	724 }}\hfill}}
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	725 @end tex
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	726 @ifnottex
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	727 @multitable @columnfractions .125 .25 .25 .25 .125
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	728 @item @tab \forall @tab \exists @tab \ni @tab
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	729 @item @tab \cong @tab \Delta @tab \Phi @tab
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	730 @item @tab \Gamma @tab \vartheta @tab \Lambda @tab
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	731 @item @tab \Pi @tab \Theta @tab \Sigma @tab
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	732 @item @tab \varsigma @tab \Omega @tab \Xi @tab
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	733 @item @tab \Psi @tab \perp @tab \alpha @tab
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	734 @item @tab \beta @tab \chi @tab \delta @tab
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	735 @item @tab \epsilon @tab \phi @tab \gamma @tab
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	736 @item @tab \eta @tab \iota @tab \varphi @tab
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	737 @item @tab \kappa @tab \lambda @tab \mu @tab
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	738 @item @tab \nu @tab \o @tab \pi @tab
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	739 @item @tab \theta @tab \rho @tab \sigma @tab
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	740 @item @tab \tau @tab \upsilon @tab \varpi @tab
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	741 @item @tab \omega @tab \xi @tab \psi @tab
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	742 @item @tab \zeta @tab \sim @tab \Upsilon @tab
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	743 @item @tab \prime @tab \leq @tab \infty @tab
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	744 @item @tab \clubsuit @tab \diamondsuit @tab \heartsuit @tab
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	745 @item @tab \spadesuit @tab \leftrightarrow @tab \leftarrow @tab
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	746 @item @tab \uparrow @tab \rightarrow @tab \downarrow @tab
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	747 @item @tab \circ @tab \pm @tab \geq @tab
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	748 @item @tab \times @tab \propto @tab \partial @tab
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	749 @item @tab \bullet @tab \div @tab \neq @tab
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	750 @item @tab \equiv @tab \approx @tab \ldots @tab
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	751 @item @tab \mid @tab \aleph @tab \Im @tab
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	752 @item @tab \Re @tab \wp @tab \otimes @tab
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	753 @item @tab \oplus @tab \oslash @tab \cap @tab
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	754 @item @tab \cup @tab \supset @tab \supseteq @tab
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	755 @item @tab \subset @tab \subseteq @tab \in @tab
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	756 @item @tab \notin @tab \angle @tab \bigrightriangledown @tab
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	757 @item @tab \langle @tab \rangle @tab \nabla @tab
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	758 @item @tab \prod @tab \surd @tab \cdot @tab
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	759 @item @tab \neg @tab \wedge @tab \vee @tab
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	760 @item @tab \Leftrightarrow @tab \Leftarrow @tab \Uparrow @tab
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	761 @item @tab \Rightarrow @tab \Downarrow @tab \diamond @tab
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	762 @item @tab \copyright @tab \lfloor @tab \lceil @tab
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	763 @item @tab \rfloor @tab \rceil @tab \int @tab
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	764 @end multitable
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	765 @end ifnottex
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	766 @caption{Available special characters in @sc{TeX} mode}
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	767 @end float
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	768
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	769 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	770
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	771 @example
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	772 @group
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	773 x = 0:0.01:3;
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	774 plot(x,erf(x));
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	775 hold on;
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	776 plot(x,x,"r");
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	777 axis([0, 3, 0, 1]);
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	778 text(0.65, 0.6175, strcat('\leftarrow x = @{2/\surd\pi',
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	779 ' @{\fontsize@{16@}\int_@{\fontsize@{8@}0@}^@{\fontsize@{8@}x@}@}',
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	780 ' e^@{-t^2@} dt@} = 0.6175'))
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	781 @end group
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	782 @end example
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	783
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	784 @ifnotinfo
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	785 @noindent
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	786 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	787
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	788 @float Figure,fig:extendedtext
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	789 @center @image{extended,4in}
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	790 @caption{Example of inclusion of text with the @sc{TeX} interpreter}
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	791 @end float
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	792 @end ifnotinfo
5134 0309b6722ee9 [project @ 2005-02-08 20:17:55 by jwe] jwe parents: 5016 diff changeset	793
6502 6ab0a8767780 [project @ 2007-04-06 03:32:06 by jwe] jwe parents: 6331 diff changeset	794 @node Printing Plots
6888 b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe] jwe parents: 6877 diff changeset	795 @subsection Printing Plots
9672 43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	796 @cindex printing plots
6888 b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe] jwe parents: 6877 diff changeset	797
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe] jwe parents: 6877 diff changeset	798 The @code{print} command allows you to save plots in a variety of
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe] jwe parents: 6877 diff changeset	799 formats. For example,
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe] jwe parents: 6877 diff changeset	800
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe] jwe parents: 6877 diff changeset	801 @example
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe] jwe parents: 6877 diff changeset	802 print -deps foo.eps
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe] jwe parents: 6877 diff changeset	803 @end example
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe] jwe parents: 6877 diff changeset	804
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe] jwe parents: 6877 diff changeset	805 @noindent
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe] jwe parents: 6877 diff changeset	806 writes the current figure to an encapsulated PostScript file called
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe] jwe parents: 6877 diff changeset	807 @file{foo.eps}.
6502 6ab0a8767780 [project @ 2007-04-06 03:32:06 by jwe] jwe parents: 6331 diff changeset	808
6ab0a8767780 [project @ 2007-04-06 03:32:06 by jwe] jwe parents: 6331 diff changeset	809 @DOCSTRING(print)
6ab0a8767780 [project @ 2007-04-06 03:32:06 by jwe] jwe parents: 6331 diff changeset	810
6ab0a8767780 [project @ 2007-04-06 03:32:06 by jwe] jwe parents: 6331 diff changeset	811 @DOCSTRING(orient)
5134 0309b6722ee9 [project @ 2005-02-08 20:17:55 by jwe] jwe parents: 5016 diff changeset	812
7984 bbaa5d7d0143 Some documentation updates David Bateman <dbateman@free.fr> parents: 7981 diff changeset	813 @node Interacting with plots
bbaa5d7d0143 Some documentation updates David Bateman <dbateman@free.fr> parents: 7981 diff changeset	814 @subsection Interacting with plots
bbaa5d7d0143 Some documentation updates David Bateman <dbateman@free.fr> parents: 7981 diff changeset	815
bbaa5d7d0143 Some documentation updates David Bateman <dbateman@free.fr> parents: 7981 diff changeset	816 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	817 selection the position at which to place text on the plot with the
7984 bbaa5d7d0143 Some documentation updates David Bateman <dbateman@free.fr> parents: 7981 diff changeset	818 @code{gtext} function using the mouse.
bbaa5d7d0143 Some documentation updates David Bateman <dbateman@free.fr> parents: 7981 diff changeset	819
bbaa5d7d0143 Some documentation updates David Bateman <dbateman@free.fr> parents: 7981 diff changeset	820 @DOCSTRING(ginput)
bbaa5d7d0143 Some documentation updates David Bateman <dbateman@free.fr> parents: 7981 diff changeset	821
bbaa5d7d0143 Some documentation updates David Bateman <dbateman@free.fr> parents: 7981 diff changeset	822 @DOCSTRING(waitforbuttonpress)
bbaa5d7d0143 Some documentation updates David Bateman <dbateman@free.fr> parents: 7981 diff changeset	823
bbaa5d7d0143 Some documentation updates David Bateman <dbateman@free.fr> parents: 7981 diff changeset	824 @DOCSTRING(gtext)
bbaa5d7d0143 Some documentation updates David Bateman <dbateman@free.fr> parents: 7981 diff changeset	825
6788 c81a0f3f5a82 [project @ 2007-07-23 22:05:29 by dbateman] dbateman parents: 6778 diff changeset	826 @node Test Plotting Functions
6888 b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe] jwe parents: 6877 diff changeset	827 @subsection Test Plotting Functions
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe] jwe parents: 6877 diff changeset	828
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe] jwe parents: 6877 diff changeset	829 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	830 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	831 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	832
6877 ab11bdb09820 [project @ 2007-09-07 05:12:32 by jwe] jwe parents: 6788 diff changeset	833 @DOCSTRING(sombrero)
ab11bdb09820 [project @ 2007-09-07 05:12:32 by jwe] jwe parents: 6788 diff changeset	834
6788 c81a0f3f5a82 [project @ 2007-07-23 22:05:29 by dbateman] dbateman parents: 6778 diff changeset	835 @DOCSTRING(peaks)
9672 43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	836 @node Graphics Data Structures
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	837 @section Graphics Data Structures
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	838 @cindex graphics data structures
6888 b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe] jwe parents: 6877 diff changeset	839
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe] jwe parents: 6877 diff changeset	840 @menu
9676 e40835382b68 doc fixes John W. Eaton <jwe@octave.org> parents: 9672 diff changeset	841 * Introduction to Graphics Structures::
e40835382b68 doc fixes John W. Eaton <jwe@octave.org> parents: 9672 diff changeset	842 * Graphics Objects::
e40835382b68 doc fixes John W. Eaton <jwe@octave.org> parents: 9672 diff changeset	843 * Graphics Object Properties::
e40835382b68 doc fixes John W. Eaton <jwe@octave.org> parents: 9672 diff changeset	844 * Searching Properties::
e40835382b68 doc fixes John W. Eaton <jwe@octave.org> parents: 9672 diff changeset	845 * Managing Default Properties::
6888 b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe] jwe parents: 6877 diff changeset	846 @end menu
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe] jwe parents: 6877 diff changeset	847
9672 43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	848 @node Introduction to Graphics Structures
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	849 @subsection Introduction to Graphics Structures
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	850 @cindex introduction to graphics structures
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	851 @anchor{doc-graphics structures}
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	852
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	853 The graphics functions use pointers, which are of class graphics_handle,
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	854 in order to address the data structures which control
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	855 graphical displays.
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	856 A graphics handle may point any one of a number of different object types.
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	857 The objects are the graphics data structures. The types of objects
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	858 are: @code{figure}, @code{axes},
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	859 @code{line}, @code{text}, @code{patch},
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	860 @code{surface}, @code{text} and @code{image}.
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	861
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	862 Each of these objects has a function by the
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	863 same name. and, each of these functions returns a graphics handle pointing
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	864 to an object of corresponding type. In addition there are several functions
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	865 which operate on properties of the graphics objects and which return handles: the functions @code{ plot}
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	866 and @code{plot3}
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	867 return a handle pointing to an object of type line, the function @code{subplot}
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	868 returns a handle pointing to an object of type axes, the function @code{fill} returns a
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	869 handle pointing to an object of type patch, the functions @code{area}, @code{bar},
9752 51c21837686f Period spellcheck of Octave documentation to check and fix newly added DOCSTRINGS Rik <rdrider0-list@yahoo.com> parents: 9676 diff changeset	870 @code{barh}, @code{contour}, @code{contourf}, @code{contour3}, @code{surf}, @code{mesh},
9672 43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	871 @code{surfc}, @code{meshc},
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	872 @code{errorbar}, @code{quiver}, @code{quiver3}, @code{scatter}, @code{scatter3},
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	873 @code{stair}, @code{stem}, @code{stem3} each return a handle as documented
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	874 in @ref{doc-datasources,, Data Sources}.
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	875
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	876
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	877 The graphics objects are arranged in a hierarchy:
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	878
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	879 1. The root is at 0. i.e. @code{get(0)} returns the properties of the root
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	880 object.
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	881
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	882 2. Below the root are @code{figure} objects.
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	883
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	884 3. Below the @code{figure} objects are @code{axes}.
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	885
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	886 4. Below the @code{axes} objects are
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	887 @code{line}, @code{text}, @code{patch},
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	888 @code{surface}, and @code{image} objects.
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	889
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	890 Graphics handles may be distinguished from function handles (@ref{Function Handles})
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	891 by means of the function @code{ishandle()}. @code{ishandle} returns true if its
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	892 argument is a handle of a graphics object. In addition, the figure object
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	893 may be tested using @code{isfigure()}. @code{isfigure} returns true only if its
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	894 argument is a handle of a figure.
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	895 ishghandle() is synonymous with ishandle(). The @code{whos} function can be used
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	896 to show the object type of each currently defined graphics handle. (Note: this is
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	897 not true today, but it is, I hope, considered an error in whos. It may be better
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	898 to have whos just show graphics_handle as the class, and provide a new function
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	899 which, given a graphics handle, returns its object type. This could generalize
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	900 the ishandle() functions and, in fact, replace them.)
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	901
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	902 The @code{get} and @code{set} commands are
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	903 used to obtain and set the values of properties of graphics objects. In addition,
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	904 the @code{get} command may be used to obtain property names.
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	905
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	906 For example, the property "type" of the graphics object pointed to by the graphics
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	907 handle h may be displayed by:
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	908
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	909 @code{get(h, "type")}
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	910
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	911 The properties and their current values are returned by @code{get(h)}
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	912 where h is a handle of a graphics object. If only the names of the
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	913 allowed properties are wanted they may be displayed by:
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	914 @code{get(h, "");}
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	915
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	916 Thus, for example,
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	917 @c @example
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	918 @smallformat
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	919 @group
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	920 @verbatim
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	921 h=figure();
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	922 get(h,"type")
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	923 ans = figure
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	924 get(h, "");
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	925 error: get: ambiguous figure property name ; possible matches:
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	926
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	927 __backend__ currentobject paperposition toolbar
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	928 __enhanced__ deletefcn paperpositionmode type
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	929 __modified__ dockcontrols papersize uicontextmenu
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	930 __myhandle__ doublebuffer papertype units
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	931 __plot_stream__ filename paperunits userdata
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	932 alphamap handlevisibility parent visible
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	933 beingdeleted hittest pointer windowbuttondownfcn
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	934 busyaction integerhandle pointershapecdata windowbuttonmotionfcn
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	935 buttondownfcn interruptible pointershapehotspot windowbuttonupfcn
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	936 children inverthardcopy position windowbuttonwheelfcn
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	937 clipping keypressfcn renderer windowstyle
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	938 closerequestfcn keyreleasefcn renderermode wvisual
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	939 color menubar resize wvisualmode
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	940 colormap mincolormap resizefcn xdisplay
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	941 createfcn name selected xvisual
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	942 current_point nextplot selectionhighlight xvisualmode
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	943 currentaxes numbertitle selectiontype
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	944 currentcharacter paperorientation tag
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	945 @end verbatim
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	946 @end group
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	947 @end smallformat
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	948 @c @end example
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	949 @c @end flushleft
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	950 @c @example
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	951 @smallformat
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	952 @group
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	953 @verbatim
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	954 aa=axes();
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	955 get(aa,"");
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	956 error: get: ambiguous axes property name ; possible matches:
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	957
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	958 __modified__ drawmode tickdir xtickmode
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	959 __myhandle__ fontangle tickdirmode yaxislocation
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	960 activepositionproperty fontname ticklength ycolor
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	961 alim fontsize tightinset ydir
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	962 alimmode fontunits title ygrid
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	963 ambientlightcolor fontweight type ylabel
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	964 beingdeleted gridlinestyle uicontextmenu ylim
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	965 box handlevisibility units ylimmode
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	966 busyaction hittest userdata yminorgrid
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	967 buttondownfcn interpreter view yminortick
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	968 cameraposition interruptible visible yscale
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	969 camerapositionmode key x_normrendertransform ytick
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	970 cameratarget keybox x_projectiontransform yticklabel
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	971 cameratargetmode keypos x_rendertransform yticklabelmode
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	972 cameraupvector keyreverse x_viewporttransform ytickmode
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	973 cameraupvectormode layer x_viewtransform zcolor
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	974 cameraviewangle linestyleorder xaxislocation zdir
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	975 cameraviewanglemode linewidth xcolor zgrid
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	976 children minorgridlinestyle xdir zlabel
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	977 clim nextplot xgrid zlim
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	978 climmode outerposition xlabel zlimmode
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	979 @end verbatim
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	980 @end group
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	981 @group
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	982 @verbatim
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	983 clipping parent xlim zminorgrid
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	984 color plotboxaspectratio xlimmode zminortick
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	985 colororder plotboxaspectratiomode xminorgrid zscale
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	986 createfcn position xminortick ztick
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	987 currentpoint projection xscale zticklabel
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	988 dataaspectratio selected xtick zticklabelmode
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	989 dataaspectratiomode selectionhighlight xticklabel ztickmode
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	990 deletefcn tag xticklabelmode
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	991 @end verbatim
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	992 @end group
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	993 @end smallformat
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	994 @c @end example
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	995
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	996 The root figure has index 0. Its properties may be displayed by:
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	997 @code{get(0,"")}.
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	998 The uses of @code{get()} and @code{set()} are further explained in
9676 e40835382b68 doc fixes John W. Eaton <jwe@octave.org> parents: 9672 diff changeset	999 @ref{doc-get,,get}, @ref{doc-set,,set}.
9672 43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	1000
6888 b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe] jwe parents: 6877 diff changeset	1001 @node Graphics Objects
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe] jwe parents: 6877 diff changeset	1002 @subsection Graphics Objects
9672 43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	1003 @cindex graphics objects
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	1004
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	1005 The hierarchy of graphics objects was explained above. (See
9676 e40835382b68 doc fixes John W. Eaton <jwe@octave.org> parents: 9672 diff changeset	1006 @ref{Introduction to Graphics Structures}. Here the
9672 43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	1007 specific objects are described, and the properties contained in
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	1008 these objects are discussed. Keep in mind that
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	1009 graphics objects are always referenced by @dfn{handle}.
6888 b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe] jwe parents: 6877 diff changeset	1010
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe] jwe parents: 6877 diff changeset	1011 @table @asis
9672 43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	1012 @c @group
6888 b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe] jwe parents: 6877 diff changeset	1013 @item root figure
8071 b6e85fb238c1 doc fixes John W. Eaton <jwe@octave.org> parents: 8070 diff changeset	1014 @cindex root figure graphics object
b6e85fb238c1 doc fixes John W. Eaton <jwe@octave.org> parents: 8070 diff changeset	1015 @cindex graphics object, root figure
9672 43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	1016 the top level of the hierarchy and the parent of all figure objects.
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	1017 The @code{handle} index of the root figure is 0.
6888 b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe] jwe parents: 6877 diff changeset	1018
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe] jwe parents: 6877 diff changeset	1019 @item figure
8071 b6e85fb238c1 doc fixes John W. Eaton <jwe@octave.org> parents: 8070 diff changeset	1020 @cindex figure graphics object
b6e85fb238c1 doc fixes John W. Eaton <jwe@octave.org> parents: 8070 diff changeset	1021 @cindex graphics object, figure
6888 b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe] jwe parents: 6877 diff changeset	1022 A figure window.
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe] jwe parents: 6877 diff changeset	1023
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe] jwe parents: 6877 diff changeset	1024 @item axes
8071 b6e85fb238c1 doc fixes John W. Eaton <jwe@octave.org> parents: 8070 diff changeset	1025 @cindex axes graphics object
b6e85fb238c1 doc fixes John W. Eaton <jwe@octave.org> parents: 8070 diff changeset	1026 @cindex graphics object, axes
9316 c539ec5726e7 Update some of Advanced Plotting documentation. Rik <rdrider0-list@yahoo.com> parents: 9209 diff changeset	1027 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	1028 parent of line, text, image, patch, or surface objects.
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe] jwe parents: 6877 diff changeset	1029
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe] jwe parents: 6877 diff changeset	1030 @item line
8071 b6e85fb238c1 doc fixes John W. Eaton <jwe@octave.org> parents: 8070 diff changeset	1031 @cindex line graphics object
b6e85fb238c1 doc fixes John W. Eaton <jwe@octave.org> parents: 8070 diff changeset	1032 @cindex graphics object, line
6888 b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe] jwe parents: 6877 diff changeset	1033 A line in two or three dimensions.
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe] jwe parents: 6877 diff changeset	1034
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe] jwe parents: 6877 diff changeset	1035 @item text
8071 b6e85fb238c1 doc fixes John W. Eaton <jwe@octave.org> parents: 8070 diff changeset	1036 @cindex text graphics object
b6e85fb238c1 doc fixes John W. Eaton <jwe@octave.org> parents: 8070 diff changeset	1037 @cindex graphics object, text
6888 b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe] jwe parents: 6877 diff changeset	1038 Text annotations.
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe] jwe parents: 6877 diff changeset	1039
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe] jwe parents: 6877 diff changeset	1040 @item image
8071 b6e85fb238c1 doc fixes John W. Eaton <jwe@octave.org> parents: 8070 diff changeset	1041 @cindex image graphics object
b6e85fb238c1 doc fixes John W. Eaton <jwe@octave.org> parents: 8070 diff changeset	1042 @cindex graphics object, image
6888 b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe] jwe parents: 6877 diff changeset	1043 A bitmap image.
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe] jwe parents: 6877 diff changeset	1044
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe] jwe parents: 6877 diff changeset	1045 @item patch
8071 b6e85fb238c1 doc fixes John W. Eaton <jwe@octave.org> parents: 8070 diff changeset	1046 @cindex patch graphics object
b6e85fb238c1 doc fixes John W. Eaton <jwe@octave.org> parents: 8070 diff changeset	1047 @cindex graphics object, patch
6888 b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe] jwe parents: 6877 diff changeset	1048 A filled polygon, currently limited to two dimensions.
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe] jwe parents: 6877 diff changeset	1049
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe] jwe parents: 6877 diff changeset	1050 @item surface
8071 b6e85fb238c1 doc fixes John W. Eaton <jwe@octave.org> parents: 8070 diff changeset	1051 @cindex surface graphics object
9672 43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	1052 @cindex graphics object, surface
6888 b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe] jwe parents: 6877 diff changeset	1053 A three-dimensional surface.
9672 43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	1054 @c @end group
6888 b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe] jwe parents: 6877 diff changeset	1055 @end table
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe] jwe parents: 6877 diff changeset	1056
9672 43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	1057 @subsubsection Handle Functions
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	1058 @cindex handle functions
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	1059
9316 c539ec5726e7 Update some of Advanced Plotting documentation. Rik <rdrider0-list@yahoo.com> parents: 9209 diff changeset	1060 To determine whether a variable is a graphics object index or a figure
6888 b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe] jwe parents: 6877 diff changeset	1061 index, use the functions @code{ishandle} and @code{isfigure}.
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe] jwe parents: 6877 diff changeset	1062
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe] jwe parents: 6877 diff changeset	1063 @DOCSTRING(ishandle)
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe] jwe parents: 6877 diff changeset	1064
8817 03b7f618ab3d include docstrings for new functions in the manual John W. Eaton <jwe@octave.org> parents: 8519 diff changeset	1065 @DOCSTRING(ishghandle)
03b7f618ab3d include docstrings for new functions in the manual John W. Eaton <jwe@octave.org> parents: 8519 diff changeset	1066
6888 b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe] jwe parents: 6877 diff changeset	1067 @DOCSTRING(isfigure)
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe] jwe parents: 6877 diff changeset	1068
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe] jwe parents: 6877 diff changeset	1069 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	1070 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	1071 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	1072 none exists.
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe] jwe parents: 6877 diff changeset	1073
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe] jwe parents: 6877 diff changeset	1074 @DOCSTRING(gcf)
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe] jwe parents: 6877 diff changeset	1075
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe] jwe parents: 6877 diff changeset	1076 @DOCSTRING(gca)
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe] jwe parents: 6877 diff changeset	1077
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe] jwe parents: 6877 diff changeset	1078 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	1079 properties for graphics objects. For example,
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe] jwe parents: 6877 diff changeset	1080
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe] jwe parents: 6877 diff changeset	1081 @example
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe] jwe parents: 6877 diff changeset	1082 @group
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe] jwe parents: 6877 diff changeset	1083 get (0)
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe] jwe parents: 6877 diff changeset	1084 @result{} ans =
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe] jwe parents: 6877 diff changeset	1085 @{
9316 c539ec5726e7 Update some of Advanced Plotting documentation. Rik <rdrider0-list@yahoo.com> parents: 9209 diff changeset	1086 type = root
6888 b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe] jwe parents: 6877 diff changeset	1087 currentfigure = [](0x0)
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe] jwe parents: 6877 diff changeset	1088 children = [](0x0)
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe] jwe parents: 6877 diff changeset	1089 visible = on
9316 c539ec5726e7 Update some of Advanced Plotting documentation. Rik <rdrider0-list@yahoo.com> parents: 9209 diff changeset	1090 @dots{}
6888 b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe] jwe parents: 6877 diff changeset	1091 @}
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe] jwe parents: 6877 diff changeset	1092 @end group
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe] jwe parents: 6877 diff changeset	1093 @end example
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe] jwe parents: 6877 diff changeset	1094
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe] jwe parents: 6877 diff changeset	1095 @noindent
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe] jwe parents: 6877 diff changeset	1096 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	1097 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	1098 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	1099 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	1100 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	1101 there is no current figure window.
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe] jwe parents: 6877 diff changeset	1102
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe] jwe parents: 6877 diff changeset	1103 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	1104 property. For example,
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe] jwe parents: 6877 diff changeset	1105
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe] jwe parents: 6877 diff changeset	1106 @example
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe] jwe parents: 6877 diff changeset	1107 @group
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe] jwe parents: 6877 diff changeset	1108 get (gca (), "xlim")
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe] jwe parents: 6877 diff changeset	1109 @result{} [ 0 1 ]
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe] jwe parents: 6877 diff changeset	1110 @end group
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe] jwe parents: 6877 diff changeset	1111 @end example
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 @noindent
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe] jwe parents: 6877 diff changeset	1114 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	1115 current figure.
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe] jwe parents: 6877 diff changeset	1116
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe] jwe parents: 6877 diff changeset	1117 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	1118
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe] jwe parents: 6877 diff changeset	1119 @example
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe] jwe parents: 6877 diff changeset	1120 set (gca (), "xlim", [-10, 10]);
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe] jwe parents: 6877 diff changeset	1121 @end example
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe] jwe parents: 6877 diff changeset	1122
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe] jwe parents: 6877 diff changeset	1123 @noindent
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe] jwe parents: 6877 diff changeset	1124 sets the range of the x-axis for the current axes object in the current
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe] jwe parents: 6877 diff changeset	1125 figure to @samp{[-10, 10]}. Additionally, calling set with a graphics
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe] jwe parents: 6877 diff changeset	1126 object index as the only argument returns a structure containing the
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe] jwe parents: 6877 diff changeset	1127 default values for all the properties for the given object type. For
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe] jwe parents: 6877 diff changeset	1128 example,
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe] jwe parents: 6877 diff changeset	1129
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe] jwe parents: 6877 diff changeset	1130 @example
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe] jwe parents: 6877 diff changeset	1131 set (gca ())
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe] jwe parents: 6877 diff changeset	1132 @end example
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 @noindent
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe] jwe parents: 6877 diff changeset	1135 returns a structure containing the default property values for axes
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe] jwe parents: 6877 diff changeset	1136 objects.
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe] jwe parents: 6877 diff changeset	1137
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe] jwe parents: 6877 diff changeset	1138 @DOCSTRING(get)
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe] jwe parents: 6877 diff changeset	1139
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe] jwe parents: 6877 diff changeset	1140 @DOCSTRING(set)
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe] jwe parents: 6877 diff changeset	1141
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe] jwe parents: 6877 diff changeset	1142 @DOCSTRING(ancestor)
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe] jwe parents: 6877 diff changeset	1143
7984 bbaa5d7d0143 Some documentation updates David Bateman <dbateman@free.fr> parents: 7981 diff changeset	1144 @DOCSTRING(allchild)
bbaa5d7d0143 Some documentation updates David Bateman <dbateman@free.fr> parents: 7981 diff changeset	1145
6888 b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe] jwe parents: 6877 diff changeset	1146 @node Graphics Object Properties
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe] jwe parents: 6877 diff changeset	1147 @subsection Graphics Object Properties
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe] jwe parents: 6877 diff changeset	1148 @cindex graphics object properties
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe] jwe parents: 6877 diff changeset	1149
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe] jwe parents: 6877 diff changeset	1150 @menu
9676 e40835382b68 doc fixes John W. Eaton <jwe@octave.org> parents: 9672 diff changeset	1151 * Root Figure Properties::
e40835382b68 doc fixes John W. Eaton <jwe@octave.org> parents: 9672 diff changeset	1152 * Figure Properties::
e40835382b68 doc fixes John W. Eaton <jwe@octave.org> parents: 9672 diff changeset	1153 * Axes Properties::
e40835382b68 doc fixes John W. Eaton <jwe@octave.org> parents: 9672 diff changeset	1154 * Line Properties::
e40835382b68 doc fixes John W. Eaton <jwe@octave.org> parents: 9672 diff changeset	1155 * Text Properties::
e40835382b68 doc fixes John W. Eaton <jwe@octave.org> parents: 9672 diff changeset	1156 * Image Properties::
e40835382b68 doc fixes John W. Eaton <jwe@octave.org> parents: 9672 diff changeset	1157 * Patch Properties::
e40835382b68 doc fixes John W. Eaton <jwe@octave.org> parents: 9672 diff changeset	1158 * Surface Properties::
6888 b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe] jwe parents: 6877 diff changeset	1159 @end menu
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe] jwe parents: 6877 diff changeset	1160
9672 43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	1161 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	1162 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	1163 hierarchy.
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	1164
6888 b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe] jwe parents: 6877 diff changeset	1165 @node Root Figure Properties
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe] jwe parents: 6877 diff changeset	1166 @subsubsection Root Figure Properties
9672 43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	1167 @cindex root figure properties
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	1168
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	1169 The @code{root figure} properties are:
6888 b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe] jwe parents: 6877 diff changeset	1170 @table @code
9672 43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	1171 @item __modified__
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	1172 --- Values: "on," "off"
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	1173 @item __myhandle__
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	1174 @item beingdeleted
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	1175 --- Values: "on," "off"
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	1176 @item busyaction
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	1177 @item buttondownfcn
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	1178 @item callbackobject
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	1179 @item children
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	1180 @item clipping
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	1181 --- Values: "on," "off"
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	1182 @item createfcn
6888 b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe] jwe parents: 6877 diff changeset	1183 @item currentfigure
9672 43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	1184 @item deletefcn
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	1185 @item handlevisibility
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	1186 --- Values: "on," "off"
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	1187 @item hittest
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	1188 --- Values: "on," "off"
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	1189 @item interruptible
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	1190 --- Values: "on," "off"
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	1191 @item parent
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	1192 @item screendepth
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	1193 @item screenpixelsperinch
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	1194 @item screensize
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	1195 @item selected
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	1196 @item selectionhighlight
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	1197 @item screendepth
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	1198 @item screenpixelsperinch
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	1199 @item showhiddenhandles
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	1200 --- Values: "on," "off"
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	1201 @item tag
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	1202 @item type
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	1203 @item uicontextmenu
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	1204 @item units
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	1205 @item userdata
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	1206 @item visible
6888 b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe] jwe parents: 6877 diff changeset	1207 @end table
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe] jwe parents: 6877 diff changeset	1208
6889 ebff56d6b0a8 [project @ 2007-09-12 18:32:12 by jwe] jwe parents: 6888 diff changeset	1209 @node Figure Properties
ebff56d6b0a8 [project @ 2007-09-12 18:32:12 by jwe] jwe parents: 6888 diff changeset	1210 @subsubsection Figure Properties
8071 b6e85fb238c1 doc fixes John W. Eaton <jwe@octave.org> parents: 8070 diff changeset	1211 @cindex figure properties
6888 b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe] jwe parents: 6877 diff changeset	1212
9672 43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	1213 The @code{figure} properties are:
6888 b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe] jwe parents: 6877 diff changeset	1214 @table @code
9672 43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	1215 @item __backend__
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	1216 --- The backend currently in use.
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	1217 @item __enhanced__
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	1218 @item __modified__
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	1219 @item __myhandle__
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	1220 @item __plot_stream__
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	1221 @item alphamap
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	1222 @item beingdeleted
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	1223 --- Values: "on," "off"
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	1224 @item busyaction
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	1225 @item buttondownfcn
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	1226 @item children
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	1227 Handle to children.
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	1228 @item clipping
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	1229 --- Values: "on," "off"
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	1230 @item closerequestfcn
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	1231 --- Handle of function to call on close.
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	1232 @item color
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	1233 @item colormap
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	1234 An N-by-3 matrix containing the color map for the current axes.
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	1235 @item paperorientation
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	1236 @item createfcn
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	1237 @item currentaxes
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	1238 Handle to graphics object of current axes.
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	1239 @item currentcharacter
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	1240 @item currentobject
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	1241 @item current_point
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	1242 @item deletefcn
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	1243 @item dockcontrols
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	1244 --- Values: "on," "off"
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	1245 @item doublebuffer
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	1246 --- Values: "on," "off"
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	1247 @item filename
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	1248 @item handlevisibility
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	1249 --- Values: "on," "off"
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	1250 @item hittest
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	1251 @item integerhandle
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	1252 @item interruptible
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	1253 --- Values: "on," "off"
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	1254 @item inverthardcopy
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	1255 @item keypressfcn
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	1256 @item keyreleasefcn
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	1257 @item menubar
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	1258 @item mincolormap
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	1259 @item name
6888 b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe] jwe parents: 6877 diff changeset	1260 @item nextplot
6889 ebff56d6b0a8 [project @ 2007-09-12 18:32:12 by jwe] jwe parents: 6888 diff changeset	1261 May be one of
ebff56d6b0a8 [project @ 2007-09-12 18:32:12 by jwe] jwe parents: 6888 diff changeset	1262 @table @code
ebff56d6b0a8 [project @ 2007-09-12 18:32:12 by jwe] jwe parents: 6888 diff changeset	1263 @item "new"
ebff56d6b0a8 [project @ 2007-09-12 18:32:12 by jwe] jwe parents: 6888 diff changeset	1264 @item "add"
ebff56d6b0a8 [project @ 2007-09-12 18:32:12 by jwe] jwe parents: 6888 diff changeset	1265 @item "replace"
ebff56d6b0a8 [project @ 2007-09-12 18:32:12 by jwe] jwe parents: 6888 diff changeset	1266 @item "replacechildren"
ebff56d6b0a8 [project @ 2007-09-12 18:32:12 by jwe] jwe parents: 6888 diff changeset	1267 @end table
9672 43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	1268 @item numbertitle
6888 b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe] jwe parents: 6877 diff changeset	1269 @item paperorientation
6889 ebff56d6b0a8 [project @ 2007-09-12 18:32:12 by jwe] jwe parents: 6888 diff changeset	1270 Indicates the orientation for printing. Either @code{"landscape"} or
ebff56d6b0a8 [project @ 2007-09-12 18:32:12 by jwe] jwe parents: 6888 diff changeset	1271 @code{"portrait"}.
9672 43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	1272 @item paperposition
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	1273 @item paperpositionmode
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	1274 @item papersize
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	1275 @item papertype
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	1276 @item paperunits
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	1277 @item pointer
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	1278 @item pointershapecdata
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	1279 @item pointershapehotspot
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	1280 @item position
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	1281 @item renderer
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	1282 @item renderermode
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	1283 @item resize
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	1284 @item resizefcn
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	1285 @item selected
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	1286 @item selectionhighlight
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	1287 --- Values: "on," "off"
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	1288 @item selectiontype
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	1289 @item tag
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	1290 @item toolbar
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	1291 @item type
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	1292 @item units
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	1293 @item userdata
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	1294 @item visible
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	1295 Either @code{"on"} or @code{"off"} to toggle display of the figure.
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	1296 @item windowbuttondownfcn
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	1297 @item windowbuttonmotionfcn
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	1298 @item windowbuttonupfcn
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	1299 @item windowbuttonwheelfcn
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	1300 @item windowstyle
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	1301 @item wvisual
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	1302 @item wvisualmode
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	1303 @item xdisplay
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	1304 @item xvisual
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	1305 @item xvisualmode
6888 b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe] jwe parents: 6877 diff changeset	1306 @end table
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe] jwe parents: 6877 diff changeset	1307
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe] jwe parents: 6877 diff changeset	1308 @node Axes Properties
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe] jwe parents: 6877 diff changeset	1309 @subsubsection Axes Properties
8071 b6e85fb238c1 doc fixes John W. Eaton <jwe@octave.org> parents: 8070 diff changeset	1310 @cindex axes properties
6888 b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe] jwe parents: 6877 diff changeset	1311
9672 43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	1312 The @code{axes} properties are:
6888 b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe] jwe parents: 6877 diff changeset	1313 @table @code
9672 43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	1314 @item __modified__
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	1315 @item __myhandle__
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	1316 @item activepositionproperty
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	1317 @item alim
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	1318 @item alimmode
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	1319 @item ambientlightcolor
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	1320 @item beingdeleted
6888 b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe] jwe parents: 6877 diff changeset	1321 @item box
9672 43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	1322 Box surrounding axes.
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	1323 --- Values: "on," "off"
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	1324 @item busyaction
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	1325 @item buttondownfcn
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	1326 @item cameraposition
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	1327 @item camerapositionmode
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	1328 @item cameratarget
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	1329 @item cameratargetmode
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	1330 @item cameraupvector
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	1331 @item cameraupvectormode
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	1332 @item cameraviewangle
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	1333 @item cameraviewanglemode
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	1334 @item children
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	1335 @item clim
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	1336 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	1337 an image. See @code{pcolor} property.
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	1338 Setting this property also forces the corresponding mode
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	1339 property to be set to @code{"manual"}.
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	1340 @item climmode
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	1341 Either @code{"manual"} or @code{"auto"}.
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	1342 @item clipping
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	1343 @item color
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	1344 @item colororder
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	1345 @item createfcn
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	1346 @item currentpoint
6888 b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe] jwe parents: 6877 diff changeset	1347 @item dataaspectratio
6889 ebff56d6b0a8 [project @ 2007-09-12 18:32:12 by jwe] jwe parents: 6888 diff changeset	1348 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	1349 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	1350 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	1351 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	1352 @code{dataaspectratio} also forces the @code{dataaspectratiomode}
ebff56d6b0a8 [project @ 2007-09-12 18:32:12 by jwe] jwe parents: 6888 diff changeset	1353 property to be set to @code{"manual"}.
9672 43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	1354 @item dataaspectratiomode
6889 ebff56d6b0a8 [project @ 2007-09-12 18:32:12 by jwe] jwe parents: 6888 diff changeset	1355 Either @code{"manual"} or @code{"auto"}.
9672 43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	1356 @item deletefcn
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	1357 @item drawmode
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	1358 @item fontangle
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	1359 @item fontname
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	1360 @item fontsize
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	1361 @item fontunits
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	1362 @item fontweight
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	1363 @item gridlinestyle
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	1364 @item handlevisibility
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	1365 @item hittest
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	1366 @item interpreter
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	1367 @item interruptible
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	1368 @item key
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	1369 Toggle display of the legend. --- Values: "on," "off"
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	1370 Note that this property is not compatible with @sc{matlab} and may be
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	1371 removed in a future version of Octave.
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	1372 @item keybox
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	1373 Toggle display of a box around the
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	1374 legend. --- Values: "on," "off"
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	1375 Note that this property is not compatible with @sc{matlab} and
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	1376 may be removed in a future version of Octave.
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	1377 @item keypos
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	1378 An integer from 1 to 4 specifying the position of the legend. 1
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	1379 indicates upper right corner, 2 indicates upper left, 3 indicates lower
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	1380 left, and 4 indicates lower right. Note that this property is not
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	1381 compatible with @sc{matlab} and may be removed in a future version of
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	1382 Octave.
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	1383 @item keyreverse
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	1384 @item layer
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	1385 @item linestyleorder
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	1386 @item linewidth
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	1387 @item minorgridlinestyle
6888 b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe] jwe parents: 6877 diff changeset	1388 @item nextplot
6889 ebff56d6b0a8 [project @ 2007-09-12 18:32:12 by jwe] jwe parents: 6888 diff changeset	1389 May be one of
ebff56d6b0a8 [project @ 2007-09-12 18:32:12 by jwe] jwe parents: 6888 diff changeset	1390 @table @code
ebff56d6b0a8 [project @ 2007-09-12 18:32:12 by jwe] jwe parents: 6888 diff changeset	1391 @item "new"
ebff56d6b0a8 [project @ 2007-09-12 18:32:12 by jwe] jwe parents: 6888 diff changeset	1392 @item "add"
ebff56d6b0a8 [project @ 2007-09-12 18:32:12 by jwe] jwe parents: 6888 diff changeset	1393 @item "replace"
ebff56d6b0a8 [project @ 2007-09-12 18:32:12 by jwe] jwe parents: 6888 diff changeset	1394 @item "replacechildren"
ebff56d6b0a8 [project @ 2007-09-12 18:32:12 by jwe] jwe parents: 6888 diff changeset	1395 @end table
6888 b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe] jwe parents: 6877 diff changeset	1396 @item outerposition
8071 b6e85fb238c1 doc fixes John W. Eaton <jwe@octave.org> parents: 8070 diff changeset	1397 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	1398 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	1399 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	1400 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	1401 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	1402 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	1403 the @code{position} property.
9672 43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	1404 @item parent
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	1405 @item plotboxaspectratio
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	1406 @item plotboxaspectratiomode
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	1407 @item position
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	1408 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	1409 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	1410 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	1411 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	1412 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	1413 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	1414 the @code{outerposition} property.
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	1415 @item projection
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	1416 @item selected
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	1417 @item selectionhighlight
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	1418 @item tag
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	1419 @item tickdir
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	1420 @item tickdirmode
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	1421 @item ticklength
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	1422 @item tightinset
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	1423 @item title
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	1424 Index of text object for the axes title.
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	1425 @item type
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	1426 @item uicontextmenu
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	1427 @item units
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	1428 @item userdata
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	1429 @item view
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	1430 A three element vector specifying the view point for three-dimensional plots.
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	1431 @item visible
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	1432 Either @code{"on"} or @code{"off"} to toggle display of the axes.
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	1433 @item x_normrendertransform
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	1434 @item x_projectiontransform
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	1435 @item x_rendertransform
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	1436 @item x_viewporttransform
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	1437 @item x_viewtransform
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	1438 @item xaxislocation
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	1439 Either @code{"top"} or @code{"bottom"}.
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	1440 @item xcolor
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	1441 @item xdir
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	1442 Either @code{"forward"} or @code{"reverse"}.
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	1443 @item xgrid
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	1444 Either @code{"on"} or @code{"off"} to toggle display of grid lines.
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	1445 @item xlabel
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	1446 Indices to text objects for the axes labels.
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	1447 @item xlim
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	1448 Two-element vector defining the limits for the x axis.
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	1449 Setting this property also forces the corresponding mode
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	1450 property to be set to @code{"manual"}.
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	1451 @item xlimmode
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	1452 Either @code{"manual"} or @code{"auto"}.
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	1453 @item xminorgrid
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	1454 Either @code{"on"} or @code{"off"} to toggle display of minor grid lines.
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	1455 @item xminortick
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	1456 @item xscale
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	1457 Either @code{"linear"} or @code{"log"}.
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	1458 @item xtick
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	1459 Set position of tick marks.
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	1460 Setting this property also forces the corresponding mode
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	1461 property to be set to @code{"manual"}.
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	1462 @item xticklabel
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	1463 Setting this property also forces the corresponding mode
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	1464 property to be set to @code{"manual"}.
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	1465 @item xticklabelmode
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	1466 Either @code{"manual"} or @code{"auto"}.
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	1467 @item xtickmode
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	1468 Either @code{"manual"} or @code{"auto"}.
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	1469 @item yaxislocation
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	1470 Either @code{"left"} or @code{"right"}
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	1471 @item ycolor
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	1472 @item ydir
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	1473 Either @code{"forward"} or @code{"reverse"}.
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	1474 @item ygrid
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	1475 Either @code{"on"} or @code{"off"} to toggle display of grid lines.
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	1476 @item ylabel
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	1477 Indices to text objects for the axes labels.
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	1478 @item ylim
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	1479 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	1480 Setting one of these properties also forces the corresponding mode
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	1481 property to be set to @code{"manual"}.
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	1482 @item ylimmode
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	1483 Either @code{"manual"} or @code{"auto"}.
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	1484 @item yminorgrid
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	1485 Either @code{"on"} or @code{"off"} to toggle display of minor grid lines.
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	1486 @item yminortick
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	1487 @item yscale
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	1488 Either @code{"linear"} or @code{"log"}.
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	1489 @item ytick
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	1490 Set position of tick marks.
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	1491 Setting this property also forces the corresponding mode
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	1492 property to be set to @code{"manual"}.
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	1493 @item yticklabel
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	1494 Setting this property also forces the corresponding mode
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	1495 property to be set to @code{"manual"}.
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	1496 @item yticklabelmode
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	1497 Either @code{"manual"} or @code{"auto"}.
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	1498 @item ytickmode
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	1499 Either @code{"manual"} or @code{"auto"}.
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	1500 @item zcolor
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	1501 @item zdir
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	1502 Either @code{"forward"} or @code{"reverse"}.
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	1503 @item zgrid
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	1504 Either @code{"on"} or @code{"off"} to toggle display of grid lines.
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	1505 @item zlabel
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	1506 Indices to text objects for the axes labels.
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	1507 @item zlim
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	1508 Two-element vector defining the limits for z axis.
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	1509 Setting this property also forces the corresponding mode
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	1510 property to be set to @code{"manual"}.
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	1511 @item zlimmode
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	1512 Either @code{"manual"} or @code{"auto"}.
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	1513 @item zminorgrid
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	1514 Either @code{"on"} or @code{"off"} to toggle display of minor grid lines.
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	1515 @item zminortick
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	1516 @item zscale
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	1517 Either @code{"linear"} or @code{"log"}.
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	1518 @item ztick
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	1519 Set position of tick marks.
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	1520 Setting this property also forces the corresponding mode
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	1521 property to be set to @code{"manual"}.
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	1522 @item zticklabel
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	1523 Setting this property also forces the corresponding mode
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	1524 property to be set to @code{"manual"}.
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	1525 @item zticklabelmode
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	1526 Either @code{"manual"} or @code{"auto"}.
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	1527 @item ztickmode
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	1528 Either @code{"manual"} or @code{"auto"}.
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	1529
6888 b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe] jwe parents: 6877 diff changeset	1530 @end table
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe] jwe parents: 6877 diff changeset	1531
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe] jwe parents: 6877 diff changeset	1532 @node Line Properties
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe] jwe parents: 6877 diff changeset	1533 @subsubsection Line Properties
8071 b6e85fb238c1 doc fixes John W. Eaton <jwe@octave.org> parents: 8070 diff changeset	1534 @cindex line properties
6888 b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe] jwe parents: 6877 diff changeset	1535
9672 43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	1536 The @code{line} properties are:
6888 b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe] jwe parents: 6877 diff changeset	1537 @table @code
9672 43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	1538 @item __modified__
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	1539 @item __myhandle__
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	1540 @item beingdeleted
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	1541 @item busyaction
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	1542 @item buttondownfcn
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	1543 @item children
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	1544 @item clipping
6888 b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe] jwe parents: 6877 diff changeset	1545 @item color
6889 ebff56d6b0a8 [project @ 2007-09-12 18:32:12 by jwe] jwe parents: 6888 diff changeset	1546 The RGB color of the line, or a color name. @xref{Colors}.
9672 43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	1547 @item createfcn
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	1548 @item deletefcn
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	1549 @item displayname
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	1550 @item erasemode
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	1551 @item handlevisibility
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	1552 @item hittest
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	1553 @item interpreter
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	1554 @item interruptible
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	1555 @item keylabel
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	1556 The text of the legend entry corresponding to this line. Note that this
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	1557 property is not compatible with @sc{matlab} and may be removed in a
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	1558 future version of Octave.
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	1559 @item ldata
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	1560 The lower errorbar in the y direction to be plotted.
6888 b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe] jwe parents: 6877 diff changeset	1561 @item linestyle
6889 ebff56d6b0a8 [project @ 2007-09-12 18:32:12 by jwe] jwe parents: 6888 diff changeset	1562 @itemx linewidth
ebff56d6b0a8 [project @ 2007-09-12 18:32:12 by jwe] jwe parents: 6888 diff changeset	1563 @xref{Line Styles}.
9672 43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	1564 @item linewidth
6888 b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe] jwe parents: 6877 diff changeset	1565 @item marker
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe] jwe parents: 6877 diff changeset	1566 @item markeredgecolor
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe] jwe parents: 6877 diff changeset	1567 @item markerfacecolor
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe] jwe parents: 6877 diff changeset	1568 @item markersize
6889 ebff56d6b0a8 [project @ 2007-09-12 18:32:12 by jwe] jwe parents: 6888 diff changeset	1569 @xref{Marker Styles}.
9672 43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	1570 @item parent
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	1571 @item selected
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	1572 @item selectionhighlight
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	1573 @item tag
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	1574 @item type
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	1575 @item udata
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	1576 The upper errorbar in the y direction to be plotted.
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	1577 @item uicontextmenu
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	1578 @item userdata
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	1579 @item visible
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	1580 @item xdata
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	1581 The data to be plotted.
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	1582 @item xdatasource
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	1583 @item xldata
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	1584 The lower errorbar to be plotted.
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	1585 @item xlim
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	1586 @item xliminclude
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	1587 @item xudata
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	1588 The upper errorbar to be plotted.
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	1589 @item ydata
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	1590 The data to be plotted.
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	1591 @item ydatasource
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	1592 @item ylim
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	1593 @item yliminclude
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	1594 @item zdata
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	1595 The data to be plotted.
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	1596 @item zdatasource
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	1597 @item zlim
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	1598 @item zliminclude
6888 b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe] jwe parents: 6877 diff changeset	1599 @end table
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe] jwe parents: 6877 diff changeset	1600
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe] jwe parents: 6877 diff changeset	1601 @node Text Properties
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe] jwe parents: 6877 diff changeset	1602 @subsubsection Text Properties
8071 b6e85fb238c1 doc fixes John W. Eaton <jwe@octave.org> parents: 8070 diff changeset	1603 @cindex text properties
6888 b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe] jwe parents: 6877 diff changeset	1604
9672 43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	1605 The @code{text} properties are:
6888 b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe] jwe parents: 6877 diff changeset	1606 @table @code
9672 43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	1607 @item __modified__
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	1608 @item __myhandle__
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	1609 @item backgroundcolor
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	1610 @item beingdeleted
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	1611 @item busyaction
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	1612 @item buttondownfcn
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	1613 @item children
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	1614 @item clipping
6888 b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe] jwe parents: 6877 diff changeset	1615 @item color
6889 ebff56d6b0a8 [project @ 2007-09-12 18:32:12 by jwe] jwe parents: 6888 diff changeset	1616 The color of the text. @xref{Colors}.
9672 43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	1617 @item createfcn
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	1618 @item deletefcn
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	1619 @item displayname
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	1620 @item edgecolor
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	1621 @item editing
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	1622 @item erasemode
7189 e8d953d03f6a [project @ 2007-11-26 20:42:09 by dbateman] dbateman parents: 7153 diff changeset	1623 @item fontangle
9040 dbd0c77e575e Cleanup documentation file plot.texi Rik <rdrider0-list@yahoo.com> parents: 9032 diff changeset	1624 Flag whether the font is italic or normal. Valid values are 'normal',
7189 e8d953d03f6a [project @ 2007-11-26 20:42:09 by dbateman] dbateman parents: 7153 diff changeset	1625 'italic' and 'oblique'.
9672 43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	1626 @item fontname
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	1627 The font used for the text.
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	1628 @item fontsize
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	1629 The size of the font, in points to use.
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	1630 @item fontunits
7189 e8d953d03f6a [project @ 2007-11-26 20:42:09 by dbateman] dbateman parents: 7153 diff changeset	1631 @item fontweight
9040 dbd0c77e575e Cleanup documentation file plot.texi Rik <rdrider0-list@yahoo.com> parents: 9032 diff changeset	1632 Flag whether the font is bold, etc. Valid values are 'normal', 'bold',
7189 e8d953d03f6a [project @ 2007-11-26 20:42:09 by dbateman] dbateman parents: 7153 diff changeset	1633 'demi' or 'light'.
9672 43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	1634 @item handlevisibility
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	1635 @item hittest
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	1636 @item horizontalalignment
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	1637 May be @code{"left"}, @code{"center"}, or @code{"right"}.
7189 e8d953d03f6a [project @ 2007-11-26 20:42:09 by dbateman] dbateman parents: 7153 diff changeset	1638 @item interpreter
9040 dbd0c77e575e Cleanup documentation file plot.texi Rik <rdrider0-list@yahoo.com> parents: 9032 diff changeset	1639 Determines how the text is rendered. Valid values are 'none', 'tex' or
7189 e8d953d03f6a [project @ 2007-11-26 20:42:09 by dbateman] dbateman parents: 7153 diff changeset	1640 'latex'.
9672 43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	1641 @item interruptible
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	1642 @item linestyle
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	1643 @item linewidth
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	1644 @item margin
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	1645 @item parent
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	1646 @item position
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	1647 The coordinates of the text object.
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	1648 @item rotation
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	1649 The angle of rotation for the displayed text, measured in degrees.
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	1650 @item selected
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	1651 @item selectionhighlight
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	1652 @item string
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	1653 The character string contained by the text object.
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	1654 @item tag
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	1655 @item type
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	1656 @item uicontextmenu
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	1657 @item units
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	1658 May be @code{"normalized"} or @code{"graph"}.
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	1659 @item userdata
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	1660 @item verticalalignment
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	1661 @item visible
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	1662 @item xlim
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	1663 @item xliminclude
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	1664 @item ylim
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	1665 @item yliminclude
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	1666 @item zlim
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	1667 @item zliminclude
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	1668
6888 b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe] jwe parents: 6877 diff changeset	1669 @end table
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe] jwe parents: 6877 diff changeset	1670
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe] jwe parents: 6877 diff changeset	1671 @node Image Properties
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe] jwe parents: 6877 diff changeset	1672 @subsubsection Image Properties
8071 b6e85fb238c1 doc fixes John W. Eaton <jwe@octave.org> parents: 8070 diff changeset	1673 @cindex image properties
6888 b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe] jwe parents: 6877 diff changeset	1674
9672 43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	1675 The @code{image} properties are:
6888 b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe] jwe parents: 6877 diff changeset	1676 @table @code
9672 43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	1677 @item __modified__
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	1678 @item __myhandle__
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	1679 @item beingdeleted
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	1680 @item busyaction
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	1681 @item buttondownfcn
6888 b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe] jwe parents: 6877 diff changeset	1682 @item cdata
6889 ebff56d6b0a8 [project @ 2007-09-12 18:32:12 by jwe] jwe parents: 6888 diff changeset	1683 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	1684 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	1685 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	1686 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	1687 determines the color of the pixel.
9672 43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	1688 @item cdatamapping
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	1689 @item children
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	1690 @item clim
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	1691 @item climinclude
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	1692 @item clipping
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	1693 @item createfcn
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	1694 @item deletefcn
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	1695 @item handlevisibility
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	1696 @item hittest
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	1697 @item interruptible
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	1698 @item parent
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	1699 @item selected
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	1700 @item selectionhighlight
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	1701 @item tag
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	1702 @item type
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	1703 @item uicontextmenu
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	1704 @item userdata
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	1705 @item visible
6889 ebff56d6b0a8 [project @ 2007-09-12 18:32:12 by jwe] jwe parents: 6888 diff changeset	1706 @item xdata
9672 43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	1707 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	1708 the image.
9672 43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	1709 @item xlim
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	1710 @item xliminclude
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	1711 @item ydata
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	1712 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	1713 the image.
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	1714 @item ylim
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	1715 @item yliminclude
6888 b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe] jwe parents: 6877 diff changeset	1716 @end table
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe] jwe parents: 6877 diff changeset	1717
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe] jwe parents: 6877 diff changeset	1718 @node Patch Properties
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe] jwe parents: 6877 diff changeset	1719 @subsubsection Patch Properties
8071 b6e85fb238c1 doc fixes John W. Eaton <jwe@octave.org> parents: 8070 diff changeset	1720 @cindex patch properties
6888 b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe] jwe parents: 6877 diff changeset	1721
9672 43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	1722 The @code{patch} properties are:
6888 b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe] jwe parents: 6877 diff changeset	1723 @table @code
9672 43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	1724 @item __modified__
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	1725 @item __myhandle__
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	1726 @item alim
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	1727 @item aliminclude
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	1728 @item alphadatamapping
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	1729 @item ambientstrength
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	1730 @item backfacelighting
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	1731 @item beingdeleted
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	1732 @item busyaction
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	1733 @item buttondownfcn
6888 b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe] jwe parents: 6877 diff changeset	1734 @item cdata
6889 ebff56d6b0a8 [project @ 2007-09-12 18:32:12 by jwe] jwe parents: 6888 diff changeset	1735 Data defining the patch object.
9672 43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	1736 @item cdatamapping
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	1737 @item children
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	1738 @item clim
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	1739 @item climinclude
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	1740 @item clipping
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	1741 @item createfcn
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	1742 @item deletefcn
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	1743 @item diffusestrength
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	1744 @item edgealpha
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	1745 @item edgecolor
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	1746 The color of the line defining the patch. @xref{Colors}.
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	1747 @item edgelighting
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	1748 @item erasemode
6888 b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe] jwe parents: 6877 diff changeset	1749 @item facealpha
6889 ebff56d6b0a8 [project @ 2007-09-12 18:32:12 by jwe] jwe parents: 6888 diff changeset	1750 A number in the range [0, 1] indicating the transparency of the patch.
9672 43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	1751 @item facecolor
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	1752 The fill color of the patch. @xref{Colors}.
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	1753 @item facelighting
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	1754 @item faces
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	1755 @item facevertexalphadata
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	1756 @item facevertexcdata
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	1757 @item handlevisibility
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	1758 @item hittest
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	1759 @item interpreter
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	1760 @item interruptible
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	1761 @item keylabel
6888 b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe] jwe parents: 6877 diff changeset	1762 @item linestyle
9672 43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	1763 @xref{Line Styles}.
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	1764 @item linewidth
6889 ebff56d6b0a8 [project @ 2007-09-12 18:32:12 by jwe] jwe parents: 6888 diff changeset	1765 @xref{Line Styles}.
6888 b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe] jwe parents: 6877 diff changeset	1766 @item marker
9672 43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	1767 @xref{Marker Styles}.
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	1768 @item markeredgecolor
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	1769 @xref{Marker Styles}.
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	1770 @item markerfacecolor
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	1771 @xref{Marker Styles}.
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	1772 @item markersize
6889 ebff56d6b0a8 [project @ 2007-09-12 18:32:12 by jwe] jwe parents: 6888 diff changeset	1773 @xref{Marker Styles}.
9672 43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	1774 @item normalmode
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	1775 @item parent
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	1776 @item selected
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	1777 @item selectionhighlight
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	1778 @item specularcolorreflectance
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	1779 @item specularexponent
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	1780 @item specularstrength
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	1781 @item tag
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	1782 @item type
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	1783 @item uicontextmenu
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	1784 @item userdata
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	1785 @item vertexnormals
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	1786 @item vertices
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	1787 @item visible
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	1788 @item xdata
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	1789 Data defining the patch object.
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	1790 @item xlim
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	1791 @item xliminclude
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	1792 @item ydata
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	1793 Data defining the patch object.
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	1794 @item ylim
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	1795 @item yliminclude
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	1796 @item zdata
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	1797 Data defining the patch object.
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	1798 @item zlim
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	1799 @item zliminclude
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	1800
6888 b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe] jwe parents: 6877 diff changeset	1801 @end table
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe] jwe parents: 6877 diff changeset	1802
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe] jwe parents: 6877 diff changeset	1803 @node Surface Properties
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe] jwe parents: 6877 diff changeset	1804 @subsubsection Surface Properties
8071 b6e85fb238c1 doc fixes John W. Eaton <jwe@octave.org> parents: 8070 diff changeset	1805 @cindex surface properties
6888 b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe] jwe parents: 6877 diff changeset	1806
9672 43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	1807 The @code{surface} properties are:
6888 b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe] jwe parents: 6877 diff changeset	1808 @table @code
9672 43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	1809 @item __modified__
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	1810 @item __myhandle__
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	1811 @item alim
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	1812 @item aliminclude
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	1813 @item alphadata
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	1814 @item alphadatamapping
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	1815 @item ambientstrength
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	1816 @item backfacelighting
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	1817 @item beingdeleted
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	1818 @item busyaction
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	1819 @item buttondownfcn
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	1820 @item cdata
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	1821 @item cdatamapping
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	1822 @item cdatasource
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	1823 @item children
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	1824 @item clim
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	1825 @item climinclude
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	1826 @item clipping
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	1827 @item createfcn
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	1828 @item deletefcn
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	1829 @item diffusestrength
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	1830 @item edgealpha
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	1831 @item edgecolor
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	1832 @item edgelighting
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	1833 @item erasemode
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	1834 @item facealpha
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	1835 @item facecolor
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	1836 @item facelighting
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	1837 @item handlevisibility
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	1838 @item hittest
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	1839 @item interpreter
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	1840 @item interruptible
6888 b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe] jwe parents: 6877 diff changeset	1841 @item keylabel
6889 ebff56d6b0a8 [project @ 2007-09-12 18:32:12 by jwe] jwe parents: 6888 diff changeset	1842 The text of the legend entry corresponding to this surface. Note that
9088 77e71f3da3d6 Fix documentation image printing under new development code Rik <rdrider0-list@yahoo.com> parents: 9040 diff changeset	1843 this property is not compatible with @sc{matlab} and may be removed in a
6889 ebff56d6b0a8 [project @ 2007-09-12 18:32:12 by jwe] jwe parents: 6888 diff changeset	1844 future version of Octave.
9672 43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	1845 @item linestyle
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	1846 @item linewidth
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	1847 @item marker
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	1848 @item markeredgecolor
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	1849 @item markerfacecolor
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	1850 @item markersize
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	1851 @item meshstyle
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	1852 @item normalmode
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	1853 @item parent
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	1854 @item selected
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	1855 @item selectionhighlight
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	1856 @item specularcolorreflectance
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	1857 @item specularexponent
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	1858 @item specularstrength
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	1859 @item tag
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	1860 @item type
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	1861 @item uicontextmenu
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	1862 @item userdata
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	1863 @item vertexnormals
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	1864 @item visible
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	1865 @item xdata
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	1866 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	1867 elements are vectors and @code{zdata} must be a matrix.
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	1868 @item xdatasource
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	1869 @item xlim
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	1870 @item xliminclude
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	1871 @item ydata
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	1872 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	1873 elements are vectors and @code{zdata} must be a matrix.
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	1874 @item ydatasource
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	1875 @item ylim
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	1876 @item yliminclude
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	1877 @item zdata
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	1878 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	1879 elements are vectors and @code{zdata} must be a matrix.
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	1880 @item zdatasource
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	1881 @item zlim
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	1882 @item zliminclude
6889 ebff56d6b0a8 [project @ 2007-09-12 18:32:12 by jwe] jwe parents: 6888 diff changeset	1883 @end table
ebff56d6b0a8 [project @ 2007-09-12 18:32:12 by jwe] jwe parents: 6888 diff changeset	1884
8070 3b53b25e2550 Add data sources and line series David Bateman <dbateman@free.fr> parents: 8057 diff changeset	1885 @node Searching Properties
9672 43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	1886 @subsection Searching Properties
7984 bbaa5d7d0143 Some documentation updates David Bateman <dbateman@free.fr> parents: 7981 diff changeset	1887
bbaa5d7d0143 Some documentation updates David Bateman <dbateman@free.fr> parents: 7981 diff changeset	1888 @DOCSTRING(findobj)
bbaa5d7d0143 Some documentation updates David Bateman <dbateman@free.fr> parents: 7981 diff changeset	1889
bbaa5d7d0143 Some documentation updates David Bateman <dbateman@free.fr> parents: 7981 diff changeset	1890 @DOCSTRING(findall)
6891 e9921bb3d95b [project @ 2007-09-13 02:44:27 by jwe] jwe parents: 6889 diff changeset	1891 @node Managing Default Properties
e9921bb3d95b [project @ 2007-09-13 02:44:27 by jwe] jwe parents: 6889 diff changeset	1892 @subsection Managing Default Properties
8071 b6e85fb238c1 doc fixes John W. Eaton <jwe@octave.org> parents: 8070 diff changeset	1893 @cindex default graphics properties
b6e85fb238c1 doc fixes John W. Eaton <jwe@octave.org> parents: 8070 diff changeset	1894 @cindex graphics properties, default
6891 e9921bb3d95b [project @ 2007-09-13 02:44:27 by jwe] jwe parents: 6889 diff changeset	1895
6892 29fa8673d8d1 [project @ 2007-09-13 07:36:52 by jwe] jwe parents: 6891 diff changeset	1896 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	1897 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	1898 may override the factory defaults.
6891 e9921bb3d95b [project @ 2007-09-13 02:44:27 by jwe] jwe parents: 6889 diff changeset	1899
e9921bb3d95b [project @ 2007-09-13 02:44:27 by jwe] jwe parents: 6889 diff changeset	1900 Although default values may be set for any object, they are set in
e9921bb3d95b [project @ 2007-09-13 02:44:27 by jwe] jwe parents: 6889 diff changeset	1901 parent objects and apply to child objects. For example,
e9921bb3d95b [project @ 2007-09-13 02:44:27 by jwe] jwe parents: 6889 diff changeset	1902
e9921bb3d95b [project @ 2007-09-13 02:44:27 by jwe] jwe parents: 6889 diff changeset	1903 @example
e9921bb3d95b [project @ 2007-09-13 02:44:27 by jwe] jwe parents: 6889 diff changeset	1904 set (0, "defaultlinecolor", "green");
e9921bb3d95b [project @ 2007-09-13 02:44:27 by jwe] jwe parents: 6889 diff changeset	1905 @end example
e9921bb3d95b [project @ 2007-09-13 02:44:27 by jwe] jwe parents: 6889 diff changeset	1906
e9921bb3d95b [project @ 2007-09-13 02:44:27 by jwe] jwe parents: 6889 diff changeset	1907 @noindent
e9921bb3d95b [project @ 2007-09-13 02:44:27 by jwe] jwe parents: 6889 diff changeset	1908 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	1909 the property name to set a default value is
e9921bb3d95b [project @ 2007-09-13 02:44:27 by jwe] jwe parents: 6889 diff changeset	1910
e9921bb3d95b [project @ 2007-09-13 02:44:27 by jwe] jwe parents: 6889 diff changeset	1911 @example
e9921bb3d95b [project @ 2007-09-13 02:44:27 by jwe] jwe parents: 6889 diff changeset	1912 default + @var{object-type} + @var{property-name}
e9921bb3d95b [project @ 2007-09-13 02:44:27 by jwe] jwe parents: 6889 diff changeset	1913 @end example
e9921bb3d95b [project @ 2007-09-13 02:44:27 by jwe] jwe parents: 6889 diff changeset	1914
e9921bb3d95b [project @ 2007-09-13 02:44:27 by jwe] jwe parents: 6889 diff changeset	1915 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	1916 @code{defaultlinelinewidth"} specifies the default @code{linewidth}
e9921bb3d95b [project @ 2007-09-13 02:44:27 by jwe] jwe parents: 6889 diff changeset	1917 property for @code{line} objects.
e9921bb3d95b [project @ 2007-09-13 02:44:27 by jwe] jwe parents: 6889 diff changeset	1918
e9921bb3d95b [project @ 2007-09-13 02:44:27 by jwe] jwe parents: 6889 diff changeset	1919 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	1920 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	1921 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	1922 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	1923 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	1924
e9921bb3d95b [project @ 2007-09-13 02:44:27 by jwe] jwe parents: 6889 diff changeset	1925 @example
e9921bb3d95b [project @ 2007-09-13 02:44:27 by jwe] jwe parents: 6889 diff changeset	1926 @group
e9921bb3d95b [project @ 2007-09-13 02:44:27 by jwe] jwe parents: 6889 diff changeset	1927 subplot (2, 1, 1);
e9921bb3d95b [project @ 2007-09-13 02:44:27 by jwe] jwe parents: 6889 diff changeset	1928 set (0, "defaultlinecolor", "red");
e9921bb3d95b [project @ 2007-09-13 02:44:27 by jwe] jwe parents: 6889 diff changeset	1929 set (1, "defaultlinecolor", "green");
e9921bb3d95b [project @ 2007-09-13 02:44:27 by jwe] jwe parents: 6889 diff changeset	1930 set (gca (), "defaultlinecolor", "blue");
e9921bb3d95b [project @ 2007-09-13 02:44:27 by jwe] jwe parents: 6889 diff changeset	1931 line (1:10, rand (1, 10));
e9921bb3d95b [project @ 2007-09-13 02:44:27 by jwe] jwe parents: 6889 diff changeset	1932 subplot (2, 1, 2);
e9921bb3d95b [project @ 2007-09-13 02:44:27 by jwe] jwe parents: 6889 diff changeset	1933 line (1:10, rand (1, 10));
e9921bb3d95b [project @ 2007-09-13 02:44:27 by jwe] jwe parents: 6889 diff changeset	1934 figure (2)
e9921bb3d95b [project @ 2007-09-13 02:44:27 by jwe] jwe parents: 6889 diff changeset	1935 line (1:10, rand (1, 10));
e9921bb3d95b [project @ 2007-09-13 02:44:27 by jwe] jwe parents: 6889 diff changeset	1936 @end group
e9921bb3d95b [project @ 2007-09-13 02:44:27 by jwe] jwe parents: 6889 diff changeset	1937 @end example
e9921bb3d95b [project @ 2007-09-13 02:44:27 by jwe] jwe parents: 6889 diff changeset	1938
e9921bb3d95b [project @ 2007-09-13 02:44:27 by jwe] jwe parents: 6889 diff changeset	1939 @noindent
e9921bb3d95b [project @ 2007-09-13 02:44:27 by jwe] jwe parents: 6889 diff changeset	1940 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	1941 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	1942 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	1943 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	1944 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	1945 from the global root figure parent object.
e9921bb3d95b [project @ 2007-09-13 02:44:27 by jwe] jwe parents: 6889 diff changeset	1946
e9921bb3d95b [project @ 2007-09-13 02:44:27 by jwe] jwe parents: 6889 diff changeset	1947 To remove a user-defined default setting, set the default property to
e9921bb3d95b [project @ 2007-09-13 02:44:27 by jwe] jwe parents: 6889 diff changeset	1948 the value @code{"remove"}. For example,
e9921bb3d95b [project @ 2007-09-13 02:44:27 by jwe] jwe parents: 6889 diff changeset	1949
e9921bb3d95b [project @ 2007-09-13 02:44:27 by jwe] jwe parents: 6889 diff changeset	1950 @example
e9921bb3d95b [project @ 2007-09-13 02:44:27 by jwe] jwe parents: 6889 diff changeset	1951 set (gca (), "defaultlinecolor", "remove");
e9921bb3d95b [project @ 2007-09-13 02:44:27 by jwe] jwe parents: 6889 diff changeset	1952 @end example
e9921bb3d95b [project @ 2007-09-13 02:44:27 by jwe] jwe parents: 6889 diff changeset	1953
e9921bb3d95b [project @ 2007-09-13 02:44:27 by jwe] jwe parents: 6889 diff changeset	1954 @noindent
e9921bb3d95b [project @ 2007-09-13 02:44:27 by jwe] jwe parents: 6889 diff changeset	1955 removes the user-defined default line color setting from the current axes
e9921bb3d95b [project @ 2007-09-13 02:44:27 by jwe] jwe parents: 6889 diff changeset	1956 object.
e9921bb3d95b [project @ 2007-09-13 02:44:27 by jwe] jwe parents: 6889 diff changeset	1957
e9921bb3d95b [project @ 2007-09-13 02:44:27 by jwe] jwe parents: 6889 diff changeset	1958 Getting the @code{"default"} property of an object returns a list of
e9921bb3d95b [project @ 2007-09-13 02:44:27 by jwe] jwe parents: 6889 diff changeset	1959 user-defined defaults set for the object. For example,
e9921bb3d95b [project @ 2007-09-13 02:44:27 by jwe] jwe parents: 6889 diff changeset	1960
e9921bb3d95b [project @ 2007-09-13 02:44:27 by jwe] jwe parents: 6889 diff changeset	1961 @example
e9921bb3d95b [project @ 2007-09-13 02:44:27 by jwe] jwe parents: 6889 diff changeset	1962 get (gca (), "default");
e9921bb3d95b [project @ 2007-09-13 02:44:27 by jwe] jwe parents: 6889 diff changeset	1963 @end example
e9921bb3d95b [project @ 2007-09-13 02:44:27 by jwe] jwe parents: 6889 diff changeset	1964
e9921bb3d95b [project @ 2007-09-13 02:44:27 by jwe] jwe parents: 6889 diff changeset	1965 @noindent
e9921bb3d95b [project @ 2007-09-13 02:44:27 by jwe] jwe parents: 6889 diff changeset	1966 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	1967 object.
e9921bb3d95b [project @ 2007-09-13 02:44:27 by jwe] jwe parents: 6889 diff changeset	1968
e9921bb3d95b [project @ 2007-09-13 02:44:27 by jwe] jwe parents: 6889 diff changeset	1969 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	1970 command
e9921bb3d95b [project @ 2007-09-13 02:44:27 by jwe] jwe parents: 6889 diff changeset	1971
e9921bb3d95b [project @ 2007-09-13 02:44:27 by jwe] jwe parents: 6889 diff changeset	1972 @example
e9921bb3d95b [project @ 2007-09-13 02:44:27 by jwe] jwe parents: 6889 diff changeset	1973 get (0, "factory");
e9921bb3d95b [project @ 2007-09-13 02:44:27 by jwe] jwe parents: 6889 diff changeset	1974 @end example
e9921bb3d95b [project @ 2007-09-13 02:44:27 by jwe] jwe parents: 6889 diff changeset	1975
e9921bb3d95b [project @ 2007-09-13 02:44:27 by jwe] jwe parents: 6889 diff changeset	1976 @noindent
e9921bb3d95b [project @ 2007-09-13 02:44:27 by jwe] jwe parents: 6889 diff changeset	1977 returns a list of factory defaults.
e9921bb3d95b [project @ 2007-09-13 02:44:27 by jwe] jwe parents: 6889 diff changeset	1978
9672 43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	1979
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	1980 @node Advanced Plotting
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	1981 @section Advanced Plotting
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	1982
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	1983 @menu
9676 e40835382b68 doc fixes John W. Eaton <jwe@octave.org> parents: 9672 diff changeset	1984 * Colors::
e40835382b68 doc fixes John W. Eaton <jwe@octave.org> parents: 9672 diff changeset	1985 * Line Styles::
e40835382b68 doc fixes John W. Eaton <jwe@octave.org> parents: 9672 diff changeset	1986 * Marker Styles::
e40835382b68 doc fixes John W. Eaton <jwe@octave.org> parents: 9672 diff changeset	1987 * Callbacks::
e40835382b68 doc fixes John W. Eaton <jwe@octave.org> parents: 9672 diff changeset	1988 * Object Groups::
e40835382b68 doc fixes John W. Eaton <jwe@octave.org> parents: 9672 diff changeset	1989 * Graphics Backends::
9672 43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	1990 @end menu
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	1991
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	1992
6889 ebff56d6b0a8 [project @ 2007-09-12 18:32:12 by jwe] jwe parents: 6888 diff changeset	1993 @node Colors
ebff56d6b0a8 [project @ 2007-09-12 18:32:12 by jwe] jwe parents: 6888 diff changeset	1994 @subsection Colors
8071 b6e85fb238c1 doc fixes John W. Eaton <jwe@octave.org> parents: 8070 diff changeset	1995 @cindex graphics colors
b6e85fb238c1 doc fixes John W. Eaton <jwe@octave.org> parents: 8070 diff changeset	1996 @cindex colors, graphics
6889 ebff56d6b0a8 [project @ 2007-09-12 18:32:12 by jwe] jwe parents: 6888 diff changeset	1997
ebff56d6b0a8 [project @ 2007-09-12 18:32:12 by jwe] jwe parents: 6888 diff changeset	1998 Colors may be specified as RGB triplets with values ranging from zero to
ebff56d6b0a8 [project @ 2007-09-12 18:32:12 by jwe] jwe parents: 6888 diff changeset	1999 one, or by name. Recognized color names include @code{"blue"},
ebff56d6b0a8 [project @ 2007-09-12 18:32:12 by jwe] jwe parents: 6888 diff changeset	2000 @code{"black"}, @code{"cyan"}, @code{"green"}, @code{"magenta"},
ebff56d6b0a8 [project @ 2007-09-12 18:32:12 by jwe] jwe parents: 6888 diff changeset	2001 @code{"red"}, @code{"white"}, and @code{"yellow"}.
ebff56d6b0a8 [project @ 2007-09-12 18:32:12 by jwe] jwe parents: 6888 diff changeset	2002
ebff56d6b0a8 [project @ 2007-09-12 18:32:12 by jwe] jwe parents: 6888 diff changeset	2003 @node Line Styles
ebff56d6b0a8 [project @ 2007-09-12 18:32:12 by jwe] jwe parents: 6888 diff changeset	2004 @subsection Line Styles
8071 b6e85fb238c1 doc fixes John W. Eaton <jwe@octave.org> parents: 8070 diff changeset	2005 @cindex line styles, graphics
b6e85fb238c1 doc fixes John W. Eaton <jwe@octave.org> parents: 8070 diff changeset	2006 @cindex graphics line styles
b6e85fb238c1 doc fixes John W. Eaton <jwe@octave.org> parents: 8070 diff changeset	2007
7001 8b0cfeb06365 [project @ 2007-10-10 18:02:59 by jwe] jwe parents: 6899 diff changeset	2008 Line styles are specified by the following properties:
6889 ebff56d6b0a8 [project @ 2007-09-12 18:32:12 by jwe] jwe parents: 6888 diff changeset	2009
ebff56d6b0a8 [project @ 2007-09-12 18:32:12 by jwe] jwe parents: 6888 diff changeset	2010 @table @code
ebff56d6b0a8 [project @ 2007-09-12 18:32:12 by jwe] jwe parents: 6888 diff changeset	2011 @item linestyle
ebff56d6b0a8 [project @ 2007-09-12 18:32:12 by jwe] jwe parents: 6888 diff changeset	2012 May be one of
ebff56d6b0a8 [project @ 2007-09-12 18:32:12 by jwe] jwe parents: 6888 diff changeset	2013 @table @code
ebff56d6b0a8 [project @ 2007-09-12 18:32:12 by jwe] jwe parents: 6888 diff changeset	2014 @item "-"
ebff56d6b0a8 [project @ 2007-09-12 18:32:12 by jwe] jwe parents: 6888 diff changeset	2015 Solid lines.
ebff56d6b0a8 [project @ 2007-09-12 18:32:12 by jwe] jwe parents: 6888 diff changeset	2016 @item "--"
ebff56d6b0a8 [project @ 2007-09-12 18:32:12 by jwe] jwe parents: 6888 diff changeset	2017 Dashed lines.
ebff56d6b0a8 [project @ 2007-09-12 18:32:12 by jwe] jwe parents: 6888 diff changeset	2018 @item ":"
ebff56d6b0a8 [project @ 2007-09-12 18:32:12 by jwe] jwe parents: 6888 diff changeset	2019 Points.
ebff56d6b0a8 [project @ 2007-09-12 18:32:12 by jwe] jwe parents: 6888 diff changeset	2020 @item "-."
ebff56d6b0a8 [project @ 2007-09-12 18:32:12 by jwe] jwe parents: 6888 diff changeset	2021 A dash-dot line.
ebff56d6b0a8 [project @ 2007-09-12 18:32:12 by jwe] jwe parents: 6888 diff changeset	2022 @end table
ebff56d6b0a8 [project @ 2007-09-12 18:32:12 by jwe] jwe parents: 6888 diff changeset	2023
ebff56d6b0a8 [project @ 2007-09-12 18:32:12 by jwe] jwe parents: 6888 diff changeset	2024 @item linewidth
ebff56d6b0a8 [project @ 2007-09-12 18:32:12 by jwe] jwe parents: 6888 diff changeset	2025 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	2026 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	2027 @end table
ebff56d6b0a8 [project @ 2007-09-12 18:32:12 by jwe] jwe parents: 6888 diff changeset	2028
ebff56d6b0a8 [project @ 2007-09-12 18:32:12 by jwe] jwe parents: 6888 diff changeset	2029 @node Marker Styles
ebff56d6b0a8 [project @ 2007-09-12 18:32:12 by jwe] jwe parents: 6888 diff changeset	2030 @subsection Marker Styles
8071 b6e85fb238c1 doc fixes John W. Eaton <jwe@octave.org> parents: 8070 diff changeset	2031 @cindex graphics marker styles
b6e85fb238c1 doc fixes John W. Eaton <jwe@octave.org> parents: 8070 diff changeset	2032 @cindex marker styles, graphics
b6e85fb238c1 doc fixes John W. Eaton <jwe@octave.org> parents: 8070 diff changeset	2033
7001 8b0cfeb06365 [project @ 2007-10-10 18:02:59 by jwe] jwe parents: 6899 diff changeset	2034 Marker styles are specified by the following properties:
6889 ebff56d6b0a8 [project @ 2007-09-12 18:32:12 by jwe] jwe parents: 6888 diff changeset	2035 @table @code
ebff56d6b0a8 [project @ 2007-09-12 18:32:12 by jwe] jwe parents: 6888 diff changeset	2036 @item marker
ebff56d6b0a8 [project @ 2007-09-12 18:32:12 by jwe] jwe parents: 6888 diff changeset	2037 A character indicating a plot marker to be place at each data point, or
ebff56d6b0a8 [project @ 2007-09-12 18:32:12 by jwe] jwe parents: 6888 diff changeset	2038 @code{"none"}, meaning no markers should be displayed.
ebff56d6b0a8 [project @ 2007-09-12 18:32:12 by jwe] jwe parents: 6888 diff changeset	2039
ebff56d6b0a8 [project @ 2007-09-12 18:32:12 by jwe] jwe parents: 6888 diff changeset	2040 @itemx markeredgecolor
ebff56d6b0a8 [project @ 2007-09-12 18:32:12 by jwe] jwe parents: 6888 diff changeset	2041 The color of the edge around the marker, or @code{"auto"}, meaning that
ebff56d6b0a8 [project @ 2007-09-12 18:32:12 by jwe] jwe parents: 6888 diff changeset	2042 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	2043
ebff56d6b0a8 [project @ 2007-09-12 18:32:12 by jwe] jwe parents: 6888 diff changeset	2044 @itemx markerfacecolor
ebff56d6b0a8 [project @ 2007-09-12 18:32:12 by jwe] jwe parents: 6888 diff changeset	2045 The color of the marker, or @code{"none"} to indicate that the marker
ebff56d6b0a8 [project @ 2007-09-12 18:32:12 by jwe] jwe parents: 6888 diff changeset	2046 should not be filled. @xref{Colors}.
ebff56d6b0a8 [project @ 2007-09-12 18:32:12 by jwe] jwe parents: 6888 diff changeset	2047
ebff56d6b0a8 [project @ 2007-09-12 18:32:12 by jwe] jwe parents: 6888 diff changeset	2048 @itemx markersize
ebff56d6b0a8 [project @ 2007-09-12 18:32:12 by jwe] jwe parents: 6888 diff changeset	2049 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	2050 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	2051 @end table
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe] jwe parents: 6877 diff changeset	2052
8056 9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them David Bateman <dbateman@free.fr> parents: 8055 diff changeset	2053 @node Callbacks
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them David Bateman <dbateman@free.fr> parents: 8055 diff changeset	2054 @subsection Callbacks
8071 b6e85fb238c1 doc fixes John W. Eaton <jwe@octave.org> parents: 8070 diff changeset	2055 @cindex callbacks
8056 9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them David Bateman <dbateman@free.fr> parents: 8055 diff changeset	2056
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them David Bateman <dbateman@free.fr> parents: 8055 diff changeset	2057 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	2058 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	2059 is
8056 9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them David Bateman <dbateman@free.fr> parents: 8055 diff changeset	2060
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them David Bateman <dbateman@free.fr> parents: 8055 diff changeset	2061 @example
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them David Bateman <dbateman@free.fr> parents: 8055 diff changeset	2062 @group
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them David Bateman <dbateman@free.fr> parents: 8055 diff changeset	2063 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	2064 @dots{}
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them David Bateman <dbateman@free.fr> parents: 8055 diff changeset	2065 endfunction
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them David Bateman <dbateman@free.fr> parents: 8055 diff changeset	2066 @end group
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them David Bateman <dbateman@free.fr> parents: 8055 diff changeset	2067 @end example
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them David Bateman <dbateman@free.fr> parents: 8055 diff changeset	2068
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them David Bateman <dbateman@free.fr> parents: 8055 diff changeset	2069 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	2070 @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	2071 with an object either at the objects creation or later with the
9040 dbd0c77e575e Cleanup documentation file plot.texi Rik <rdrider0-list@yahoo.com> parents: 9032 diff changeset	2072 @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	2073
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them David Bateman <dbateman@free.fr> parents: 8055 diff changeset	2074 @example
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them David Bateman <dbateman@free.fr> parents: 8055 diff changeset	2075 plot (x, "DeleteFcn", @@(s, e) disp("Window Deleted"))
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them David Bateman <dbateman@free.fr> parents: 8055 diff changeset	2076 @end example
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them David Bateman <dbateman@free.fr> parents: 8055 diff changeset	2077
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them David Bateman <dbateman@free.fr> parents: 8055 diff changeset	2078 @noindent
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them David Bateman <dbateman@free.fr> parents: 8055 diff changeset	2079 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	2080 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	2081
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them David Bateman <dbateman@free.fr> parents: 8055 diff changeset	2082 Additional user arguments can be passed to callback functions, and will
9040 dbd0c77e575e Cleanup documentation file plot.texi Rik <rdrider0-list@yahoo.com> parents: 9032 diff changeset	2083 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	2084
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them David Bateman <dbateman@free.fr> parents: 8055 diff changeset	2085 @example
9088 77e71f3da3d6 Fix documentation image printing under new development code Rik <rdrider0-list@yahoo.com> parents: 9040 diff changeset	2086 @group
8057 7670cd296687 Opps David Bateman <dbateman@free.fr> parents: 8056 diff changeset	2087 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	2088 @dots{}
8057 7670cd296687 Opps David Bateman <dbateman@free.fr> parents: 8056 diff changeset	2089 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	2090 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	2091 endfunction
9088 77e71f3da3d6 Fix documentation image printing under new development code Rik <rdrider0-list@yahoo.com> parents: 9040 diff changeset	2092 @end group
8056 9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them David Bateman <dbateman@free.fr> parents: 8055 diff changeset	2093 @end example
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them David Bateman <dbateman@free.fr> parents: 8055 diff changeset	2094
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them David Bateman <dbateman@free.fr> parents: 8055 diff changeset	2095 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	2096 are
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them David Bateman <dbateman@free.fr> parents: 8055 diff changeset	2097
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them David Bateman <dbateman@free.fr> parents: 8055 diff changeset	2098 @itemize @bullet
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them David Bateman <dbateman@free.fr> parents: 8055 diff changeset	2099 @item CreateFcn
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them David Bateman <dbateman@free.fr> parents: 8055 diff changeset	2100 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	2101 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	2102 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	2103 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	2104 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	2105
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them David Bateman <dbateman@free.fr> parents: 8055 diff changeset	2106 @item DeleteFcn
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them David Bateman <dbateman@free.fr> parents: 8055 diff changeset	2107 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	2108
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them David Bateman <dbateman@free.fr> parents: 8055 diff changeset	2109 @item ButtonDownFcn
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them David Bateman <dbateman@free.fr> parents: 8055 diff changeset	2110 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	2111 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	2112 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	2113 @end itemize
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them David Bateman <dbateman@free.fr> parents: 8055 diff changeset	2114
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them David Bateman <dbateman@free.fr> parents: 8055 diff changeset	2115 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	2116 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	2117 functions.
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them David Bateman <dbateman@free.fr> parents: 8055 diff changeset	2118
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them David Bateman <dbateman@free.fr> parents: 8055 diff changeset	2119 @DOCSTRING(gcbo)
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them David Bateman <dbateman@free.fr> parents: 8055 diff changeset	2120
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them David Bateman <dbateman@free.fr> parents: 8055 diff changeset	2121 @DOCSTRING(gcbf)
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them David Bateman <dbateman@free.fr> parents: 8055 diff changeset	2122
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them David Bateman <dbateman@free.fr> parents: 8055 diff changeset	2123 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	2124 function described below.
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them David Bateman <dbateman@free.fr> parents: 8055 diff changeset	2125
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them David Bateman <dbateman@free.fr> parents: 8055 diff changeset	2126 @node Object Groups
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them David Bateman <dbateman@free.fr> parents: 8055 diff changeset	2127 @subsection Object Groups
8071 b6e85fb238c1 doc fixes John W. Eaton <jwe@octave.org> parents: 8070 diff changeset	2128 @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	2129
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them David Bateman <dbateman@free.fr> parents: 8055 diff changeset	2130 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	2131 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	2132 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	2133 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	2134 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	2135
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them David Bateman <dbateman@free.fr> parents: 8055 diff changeset	2136 @DOCSTRING(hggroup)
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them David Bateman <dbateman@free.fr> parents: 8055 diff changeset	2137
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them David Bateman <dbateman@free.fr> parents: 8055 diff changeset	2138 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	2139
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them David Bateman <dbateman@free.fr> parents: 8055 diff changeset	2140 @example
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them David Bateman <dbateman@free.fr> parents: 8055 diff changeset	2141 @group
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them David Bateman <dbateman@free.fr> parents: 8055 diff changeset	2142 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	2143 hg = hggroup ();
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them David Bateman <dbateman@free.fr> parents: 8055 diff changeset	2144 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	2145 hold on
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them David Bateman <dbateman@free.fr> parents: 8055 diff changeset	2146 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	2147 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	2148 @end group
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them David Bateman <dbateman@free.fr> parents: 8055 diff changeset	2149 @end example
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them David Bateman <dbateman@free.fr> parents: 8055 diff changeset	2150
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them David Bateman <dbateman@free.fr> parents: 8055 diff changeset	2151 @noindent
9040 dbd0c77e575e Cleanup documentation file plot.texi Rik <rdrider0-list@yahoo.com> parents: 9032 diff changeset	2152 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	2153 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	2154 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	2155 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	2156 function.
8056 9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them David Bateman <dbateman@free.fr> parents: 8055 diff changeset	2157
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them David Bateman <dbateman@free.fr> parents: 8055 diff changeset	2158 @DOCSTRING(addproperty)
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them David Bateman <dbateman@free.fr> parents: 8055 diff changeset	2159
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them David Bateman <dbateman@free.fr> parents: 8055 diff changeset	2160 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	2161 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	2162 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	2163 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	2164 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	2165
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them David Bateman <dbateman@free.fr> parents: 8055 diff changeset	2166 @DOCSTRING(addlistener)
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them David Bateman <dbateman@free.fr> parents: 8055 diff changeset	2167
8817 03b7f618ab3d include docstrings for new functions in the manual John W. Eaton <jwe@octave.org> parents: 8519 diff changeset	2168 @DOCSTRING(dellistener)
03b7f618ab3d include docstrings for new functions in the manual John W. Eaton <jwe@octave.org> parents: 8519 diff changeset	2169
8056 9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them David Bateman <dbateman@free.fr> parents: 8055 diff changeset	2170 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	2171
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them David Bateman <dbateman@free.fr> parents: 8055 diff changeset	2172 @example
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them David Bateman <dbateman@free.fr> parents: 8055 diff changeset	2173 @group
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them David Bateman <dbateman@free.fr> parents: 8055 diff changeset	2174 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	2175 hg = hggroup ();
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them David Bateman <dbateman@free.fr> parents: 8055 diff changeset	2176 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	2177 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	2178 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	2179 hold on
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them David Bateman <dbateman@free.fr> parents: 8055 diff changeset	2180 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	2181
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them David Bateman <dbateman@free.fr> parents: 8055 diff changeset	2182 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	2183 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	2184 endfunction
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them David Bateman <dbateman@free.fr> parents: 8055 diff changeset	2185 @end group
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them David Bateman <dbateman@free.fr> parents: 8055 diff changeset	2186 @end example
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them David Bateman <dbateman@free.fr> parents: 8055 diff changeset	2187
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them David Bateman <dbateman@free.fr> parents: 8055 diff changeset	2188 @noindent
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them David Bateman <dbateman@free.fr> parents: 8055 diff changeset	2189 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	2190 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	2191 @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	2192
3b53b25e2550 Add data sources and line series David Bateman <dbateman@free.fr> parents: 8057 diff changeset	2193 @example
3b53b25e2550 Add data sources and line series David Bateman <dbateman@free.fr> parents: 8057 diff changeset	2194 @group
3b53b25e2550 Add data sources and line series David Bateman <dbateman@free.fr> parents: 8057 diff changeset	2195 x = 0:0.1:10;
3b53b25e2550 Add data sources and line series David Bateman <dbateman@free.fr> parents: 8057 diff changeset	2196 hg = hggroup ();
3b53b25e2550 Add data sources and line series David Bateman <dbateman@free.fr> parents: 8057 diff changeset	2197 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	2198 addproperty ("linestyle", hg, "linelinestyle", get (h, "linestyle"));
3b53b25e2550 Add data sources and line series David Bateman <dbateman@free.fr> parents: 8057 diff changeset	2199 hold on
3b53b25e2550 Add data sources and line series David Bateman <dbateman@free.fr> parents: 8057 diff changeset	2200 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	2201 hlink = linkprop ([hg, h1, h2], "color");
8070 3b53b25e2550 Add data sources and line series David Bateman <dbateman@free.fr> parents: 8057 diff changeset	2202 @end group
3b53b25e2550 Add data sources and line series David Bateman <dbateman@free.fr> parents: 8057 diff changeset	2203 @end example
3b53b25e2550 Add data sources and line series David Bateman <dbateman@free.fr> parents: 8057 diff changeset	2204
3b53b25e2550 Add data sources and line series David Bateman <dbateman@free.fr> parents: 8057 diff changeset	2205 @DOCSTRING(linkprop)
8056 9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them David Bateman <dbateman@free.fr> parents: 8055 diff changeset	2206
9672 43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	2207 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	2208 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	2209 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	2210
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them David Bateman <dbateman@free.fr> parents: 8055 diff changeset	2211 @itemize @bullet
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them David Bateman <dbateman@free.fr> parents: 8055 diff changeset	2212 @item group together multiple graphics objects,
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them David Bateman <dbateman@free.fr> parents: 8055 diff changeset	2213 @item create linked properties between different graphics objects, and
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them David Bateman <dbateman@free.fr> parents: 8055 diff changeset	2214 @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	2215 @end itemize
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them David Bateman <dbateman@free.fr> parents: 8055 diff changeset	2216
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them David Bateman <dbateman@free.fr> parents: 8055 diff changeset	2217 @noindent
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them David Bateman <dbateman@free.fr> parents: 8055 diff changeset	2218 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	2219 @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	2220 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	2221 @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	2222 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	2223 example
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them David Bateman <dbateman@free.fr> parents: 8055 diff changeset	2224
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them David Bateman <dbateman@free.fr> parents: 8055 diff changeset	2225 @example
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them David Bateman <dbateman@free.fr> parents: 8055 diff changeset	2226 @group
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them David Bateman <dbateman@free.fr> parents: 8055 diff changeset	2227 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	2228 get (h, "xdata")
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them David Bateman <dbateman@free.fr> parents: 8055 diff changeset	2229 @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	2230 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	2231 @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	2232 @end group
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them David Bateman <dbateman@free.fr> parents: 8055 diff changeset	2233 @end example
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them David Bateman <dbateman@free.fr> parents: 8055 diff changeset	2234
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them David Bateman <dbateman@free.fr> parents: 8055 diff changeset	2235 @noindent
9040 dbd0c77e575e Cleanup documentation file plot.texi Rik <rdrider0-list@yahoo.com> parents: 9032 diff changeset	2236 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	2237 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	2238
9672 43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	2239 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	2240 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	2241 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	2242 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	2243 member.
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them David Bateman <dbateman@free.fr> parents: 8055 diff changeset	2244
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them David Bateman <dbateman@free.fr> parents: 8055 diff changeset	2245 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	2246 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	2247 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	2248 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	2249 corresponding hggroup elements.
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them David Bateman <dbateman@free.fr> parents: 8055 diff changeset	2250
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them David Bateman <dbateman@free.fr> parents: 8055 diff changeset	2251 @menu
9676 e40835382b68 doc fixes John W. Eaton <jwe@octave.org> parents: 9672 diff changeset	2252 * Data sources in object groups::
e40835382b68 doc fixes John W. Eaton <jwe@octave.org> parents: 9672 diff changeset	2253 * Area series::
e40835382b68 doc fixes John W. Eaton <jwe@octave.org> parents: 9672 diff changeset	2254 * Bar series::
e40835382b68 doc fixes John W. Eaton <jwe@octave.org> parents: 9672 diff changeset	2255 * Contour groups::
e40835382b68 doc fixes John W. Eaton <jwe@octave.org> parents: 9672 diff changeset	2256 * Error bar series::
e40835382b68 doc fixes John W. Eaton <jwe@octave.org> parents: 9672 diff changeset	2257 * Line series::
e40835382b68 doc fixes John W. Eaton <jwe@octave.org> parents: 9672 diff changeset	2258 * Quiver group::
e40835382b68 doc fixes John W. Eaton <jwe@octave.org> parents: 9672 diff changeset	2259 * Scatter group::
e40835382b68 doc fixes John W. Eaton <jwe@octave.org> parents: 9672 diff changeset	2260 * Stair group::
e40835382b68 doc fixes John W. Eaton <jwe@octave.org> parents: 9672 diff changeset	2261 * Stem Series::
e40835382b68 doc fixes John W. Eaton <jwe@octave.org> parents: 9672 diff changeset	2262 * Surface group::
8056 9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them David Bateman <dbateman@free.fr> parents: 8055 diff changeset	2263 @end menu
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them David Bateman <dbateman@free.fr> parents: 8055 diff changeset	2264
8070 3b53b25e2550 Add data sources and line series David Bateman <dbateman@free.fr> parents: 8057 diff changeset	2265 @node Data sources in object groups
3b53b25e2550 Add data sources and line series David Bateman <dbateman@free.fr> parents: 8057 diff changeset	2266 @subsubsection Data sources in object groups
8071 b6e85fb238c1 doc fixes John W. Eaton <jwe@octave.org> parents: 8070 diff changeset	2267 @cindex data sources in object groups
9672 43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	2268 @anchor{doc-datasources}
9040 dbd0c77e575e Cleanup documentation file plot.texi Rik <rdrider0-list@yahoo.com> parents: 9032 diff changeset	2269 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	2270 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	2271 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	2272 function is called.
8070 3b53b25e2550 Add data sources and line series David Bateman <dbateman@free.fr> parents: 8057 diff changeset	2273
3b53b25e2550 Add data sources and line series David Bateman <dbateman@free.fr> parents: 8057 diff changeset	2274 @DOCSTRING(refreshdata)
3b53b25e2550 Add data sources and line series David Bateman <dbateman@free.fr> parents: 8057 diff changeset	2275
8286 6f2d95255911 fix @seealso references to point to existing anchors Thorsten Meyer <thorsten.meyier@gmx.de> parents: 8261 diff changeset	2276 @anchor{doc-linkdata}
8070 3b53b25e2550 Add data sources and line series David Bateman <dbateman@free.fr> parents: 8057 diff changeset	2277 @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	2278 @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	2279 @c command
8070 3b53b25e2550 Add data sources and line series David Bateman <dbateman@free.fr> parents: 8057 diff changeset	2280
8056 9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them David Bateman <dbateman@free.fr> parents: 8055 diff changeset	2281 @node Area series
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them David Bateman <dbateman@free.fr> parents: 8055 diff changeset	2282 @subsubsection Area series
8071 b6e85fb238c1 doc fixes John W. Eaton <jwe@octave.org> parents: 8070 diff changeset	2283 @cindex series objects
b6e85fb238c1 doc fixes John W. Eaton <jwe@octave.org> parents: 8070 diff changeset	2284 @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	2285
9040 dbd0c77e575e Cleanup documentation file plot.texi Rik <rdrider0-list@yahoo.com> parents: 9032 diff changeset	2286 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	2287 @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	2288 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	2289
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them David Bateman <dbateman@free.fr> parents: 8055 diff changeset	2290 @table @code
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them David Bateman <dbateman@free.fr> parents: 8055 diff changeset	2291 @item basevalue
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them David Bateman <dbateman@free.fr> parents: 8055 diff changeset	2292 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	2293
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them David Bateman <dbateman@free.fr> parents: 8055 diff changeset	2294 @item linewidth
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them David Bateman <dbateman@free.fr> parents: 8055 diff changeset	2295 @itemx linestyle
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them David Bateman <dbateman@free.fr> parents: 8055 diff changeset	2296 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	2297 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	2298
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them David Bateman <dbateman@free.fr> parents: 8055 diff changeset	2299 @item edgecolor
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them David Bateman <dbateman@free.fr> parents: 8055 diff changeset	2300 @itemx facecolor
9040 dbd0c77e575e Cleanup documentation file plot.texi Rik <rdrider0-list@yahoo.com> parents: 9032 diff changeset	2301 The line and fill color of the patch objects making up the areas. @xref{Colors}.
8056 9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them David Bateman <dbateman@free.fr> parents: 8055 diff changeset	2302
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them David Bateman <dbateman@free.fr> parents: 8055 diff changeset	2303 @item xdata
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them David Bateman <dbateman@free.fr> parents: 8055 diff changeset	2304 @itemx ydata
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them David Bateman <dbateman@free.fr> parents: 8055 diff changeset	2305 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	2306 @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	2307 function.
8070 3b53b25e2550 Add data sources and line series David Bateman <dbateman@free.fr> parents: 8057 diff changeset	2308
3b53b25e2550 Add data sources and line series David Bateman <dbateman@free.fr> parents: 8057 diff changeset	2309 @item xdatasource
3b53b25e2550 Add data sources and line series David Bateman <dbateman@free.fr> parents: 8057 diff changeset	2310 @itemx ydatasource
3b53b25e2550 Add data sources and line series David Bateman <dbateman@free.fr> parents: 8057 diff changeset	2311 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	2312 @end table
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them David Bateman <dbateman@free.fr> parents: 8055 diff changeset	2313
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them David Bateman <dbateman@free.fr> parents: 8055 diff changeset	2314 @node Bar series
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them David Bateman <dbateman@free.fr> parents: 8055 diff changeset	2315 @subsubsection Bar series
8071 b6e85fb238c1 doc fixes John W. Eaton <jwe@octave.org> parents: 8070 diff changeset	2316 @cindex series objects
b6e85fb238c1 doc fixes John W. Eaton <jwe@octave.org> parents: 8070 diff changeset	2317 @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	2318
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them David Bateman <dbateman@free.fr> parents: 8055 diff changeset	2319 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	2320 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	2321 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	2322
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them David Bateman <dbateman@free.fr> parents: 8055 diff changeset	2323 @table @code
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them David Bateman <dbateman@free.fr> parents: 8055 diff changeset	2324 @item showbaseline
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them David Bateman <dbateman@free.fr> parents: 8055 diff changeset	2325 @itemx baseline
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them David Bateman <dbateman@free.fr> parents: 8055 diff changeset	2326 @itemx basevalue
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them David Bateman <dbateman@free.fr> parents: 8055 diff changeset	2327 The property @code{showbaseline} flags whether the baseline of the bar
9040 dbd0c77e575e Cleanup documentation file plot.texi Rik <rdrider0-list@yahoo.com> parents: 9032 diff changeset	2328 series is displayed (default is "on"). The handle of the graphics object
8056 9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them David Bateman <dbateman@free.fr> parents: 8055 diff changeset	2329 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	2330 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	2331
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them David Bateman <dbateman@free.fr> parents: 8055 diff changeset	2332 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	2333 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	2334 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	2335 corresponding bar series.
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them David Bateman <dbateman@free.fr> parents: 8055 diff changeset	2336
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them David Bateman <dbateman@free.fr> parents: 8055 diff changeset	2337 @item barwidth
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them David Bateman <dbateman@free.fr> parents: 8055 diff changeset	2338 @itemx barlayout
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them David Bateman <dbateman@free.fr> parents: 8055 diff changeset	2339 @itemx horizontal
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them David Bateman <dbateman@free.fr> parents: 8055 diff changeset	2340 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	2341 the @var{width} variable passed to @code{bar} or @var{barh}. Whether the
8056 9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them David Bateman <dbateman@free.fr> parents: 8055 diff changeset	2342 bar series is "grouped" or "stacked" is determined by the
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them David Bateman <dbateman@free.fr> parents: 8055 diff changeset	2343 @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	2344 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	2345
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them David Bateman <dbateman@free.fr> parents: 8055 diff changeset	2346 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	2347 the bar series.
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them David Bateman <dbateman@free.fr> parents: 8055 diff changeset	2348
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them David Bateman <dbateman@free.fr> parents: 8055 diff changeset	2349 @item linewidth
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them David Bateman <dbateman@free.fr> parents: 8055 diff changeset	2350 @itemx linestyle
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them David Bateman <dbateman@free.fr> parents: 8055 diff changeset	2351 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	2352 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	2353
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them David Bateman <dbateman@free.fr> parents: 8055 diff changeset	2354 @item edgecolor
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them David Bateman <dbateman@free.fr> parents: 8055 diff changeset	2355 @itemx facecolor
9040 dbd0c77e575e Cleanup documentation file plot.texi Rik <rdrider0-list@yahoo.com> parents: 9032 diff changeset	2356 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	2357
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them David Bateman <dbateman@free.fr> parents: 8055 diff changeset	2358 @item xdata
9040 dbd0c77e575e Cleanup documentation file plot.texi Rik <rdrider0-list@yahoo.com> parents: 9032 diff changeset	2359 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	2360 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	2361
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them David Bateman <dbateman@free.fr> parents: 8055 diff changeset	2362 @item ydata
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them David Bateman <dbateman@free.fr> parents: 8055 diff changeset	2363 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	2364
3b53b25e2550 Add data sources and line series David Bateman <dbateman@free.fr> parents: 8057 diff changeset	2365 @item xdatasource
3b53b25e2550 Add data sources and line series David Bateman <dbateman@free.fr> parents: 8057 diff changeset	2366 @itemx ydatasource
3b53b25e2550 Add data sources and line series David Bateman <dbateman@free.fr> parents: 8057 diff changeset	2367 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	2368 @end table
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them David Bateman <dbateman@free.fr> parents: 8055 diff changeset	2369
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them David Bateman <dbateman@free.fr> parents: 8055 diff changeset	2370 @node Contour groups
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them David Bateman <dbateman@free.fr> parents: 8055 diff changeset	2371 @subsubsection Contour groups
8071 b6e85fb238c1 doc fixes John W. Eaton <jwe@octave.org> parents: 8070 diff changeset	2372 @cindex series objects
b6e85fb238c1 doc fixes John W. Eaton <jwe@octave.org> parents: 8070 diff changeset	2373 @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	2374
8289 ac7f334d9652 Add contour group objects and the clabel function David Bateman <dbateman@free.fr> parents: 8286 diff changeset	2375 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	2376 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	2377 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	2378 group are
ac7f334d9652 Add contour group objects and the clabel function David Bateman <dbateman@free.fr> parents: 8286 diff changeset	2379
ac7f334d9652 Add contour group objects and the clabel function David Bateman <dbateman@free.fr> parents: 8286 diff changeset	2380 @table @code
ac7f334d9652 Add contour group objects and the clabel function David Bateman <dbateman@free.fr> parents: 8286 diff changeset	2381 @item contourmatrix
ac7f334d9652 Add contour group objects and the clabel function David Bateman <dbateman@free.fr> parents: 8286 diff changeset	2382 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	2383 create the contours of the plot.
ac7f334d9652 Add contour group objects and the clabel function David Bateman <dbateman@free.fr> parents: 8286 diff changeset	2384
ac7f334d9652 Add contour group objects and the clabel function David Bateman <dbateman@free.fr> parents: 8286 diff changeset	2385 @item fill
ac7f334d9652 Add contour group objects and the clabel function David Bateman <dbateman@free.fr> parents: 8286 diff changeset	2386 A radio property that can have the values "on" or "off" that flags whether the
ac7f334d9652 Add contour group objects and the clabel function David Bateman <dbateman@free.fr> parents: 8286 diff changeset	2387 contours to plot are to be filled.
ac7f334d9652 Add contour group objects and the clabel function David Bateman <dbateman@free.fr> parents: 8286 diff changeset	2388
ac7f334d9652 Add contour group objects and the clabel function David Bateman <dbateman@free.fr> parents: 8286 diff changeset	2389 @item zlevelmode
ac7f334d9652 Add contour group objects and the clabel function David Bateman <dbateman@free.fr> parents: 8286 diff changeset	2390 @itemx zlevel
9672 43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	2391 The radio property @code{zlevelmode} can have the values "none", "auto" or
9040 dbd0c77e575e Cleanup documentation file plot.texi Rik <rdrider0-list@yahoo.com> parents: 9032 diff changeset	2392 "manual". When its value is "none" there is no z component to the plotted
9672 43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	2393 contours. When its value is "auto" the z value of the plotted contours is
9040 dbd0c77e575e Cleanup documentation file plot.texi Rik <rdrider0-list@yahoo.com> parents: 9032 diff changeset	2394 at the same value as the contour itself. If the value is "manual", then the
8289 ac7f334d9652 Add contour group objects and the clabel function David Bateman <dbateman@free.fr> parents: 8286 diff changeset	2395 z value at which to plot the contour is determined by the @code{zlevel}
ac7f334d9652 Add contour group objects and the clabel function David Bateman <dbateman@free.fr> parents: 8286 diff changeset	2396 property.
ac7f334d9652 Add contour group objects and the clabel function David Bateman <dbateman@free.fr> parents: 8286 diff changeset	2397
ac7f334d9652 Add contour group objects and the clabel function David Bateman <dbateman@free.fr> parents: 8286 diff changeset	2398 @item levellistmode
ac7f334d9652 Add contour group objects and the clabel function David Bateman <dbateman@free.fr> parents: 8286 diff changeset	2399 @itemx levellist
ac7f334d9652 Add contour group objects and the clabel function David Bateman <dbateman@free.fr> parents: 8286 diff changeset	2400 @itemx levelstepmode
ac7f334d9652 Add contour group objects and the clabel function David Bateman <dbateman@free.fr> parents: 8286 diff changeset	2401 @itemx levelstep
9672 43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	2402 If @code{levellistmode} is "manual", then the levels at which to plot the
9040 dbd0c77e575e Cleanup documentation file plot.texi Rik <rdrider0-list@yahoo.com> parents: 9032 diff changeset	2403 contours is determined by @code{levellist}. If @code{levellistmode} is
9672 43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	2404 set to "auto", then the distance between contours is determined by
9040 dbd0c77e575e Cleanup documentation file plot.texi Rik <rdrider0-list@yahoo.com> parents: 9032 diff changeset	2405 @code{levelstep}. If both @code{levellistmode} and @code{levelstepmode}
8289 ac7f334d9652 Add contour group objects and the clabel function David Bateman <dbateman@free.fr> parents: 8286 diff changeset	2406 are set to "auto", then there are assumed to be 10 equal spaced contours.
ac7f334d9652 Add contour group objects and the clabel function David Bateman <dbateman@free.fr> parents: 8286 diff changeset	2407
ac7f334d9652 Add contour group objects and the clabel function David Bateman <dbateman@free.fr> parents: 8286 diff changeset	2408 @item textlistmode
ac7f334d9652 Add contour group objects and the clabel function David Bateman <dbateman@free.fr> parents: 8286 diff changeset	2409 @itemx textlist
ac7f334d9652 Add contour group objects and the clabel function David Bateman <dbateman@free.fr> parents: 8286 diff changeset	2410 @itemx textstepmode
ac7f334d9652 Add contour group objects and the clabel function David Bateman <dbateman@free.fr> parents: 8286 diff changeset	2411 @itemx textstep
9672 43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	2412 If @code{textlistmode} is "manual", then the labeled contours
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	2413 is determined by @code{textlist}. If @code{textlistmode} is set to
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	2414 "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	2415 @code{textstep}. If both @code{textlistmode} and @code{textstepmode}
9672 43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	2416 are set to "auto", then there are assumed to be 10 equal spaced
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	2417 labeled contours.
8289 ac7f334d9652 Add contour group objects and the clabel function David Bateman <dbateman@free.fr> parents: 8286 diff changeset	2418
ac7f334d9652 Add contour group objects and the clabel function David Bateman <dbateman@free.fr> parents: 8286 diff changeset	2419 @item showtext
ac7f334d9652 Add contour group objects and the clabel function David Bateman <dbateman@free.fr> parents: 8286 diff changeset	2420 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	2421
ac7f334d9652 Add contour group objects and the clabel function David Bateman <dbateman@free.fr> parents: 8286 diff changeset	2422 @item labelspacing
ac7f334d9652 Add contour group objects and the clabel function David Bateman <dbateman@free.fr> parents: 8286 diff changeset	2423 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	2424
ac7f334d9652 Add contour group objects and the clabel function David Bateman <dbateman@free.fr> parents: 8286 diff changeset	2425 @item linewidth
ac7f334d9652 Add contour group objects and the clabel function David Bateman <dbateman@free.fr> parents: 8286 diff changeset	2426 @item linestyle
ac7f334d9652 Add contour group objects and the clabel function David Bateman <dbateman@free.fr> parents: 8286 diff changeset	2427 @item linecolor
9040 dbd0c77e575e Cleanup documentation file plot.texi Rik <rdrider0-list@yahoo.com> parents: 9032 diff changeset	2428 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	2429 @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	2430 property @code{linecolor} is a color property (@pxref{Colors}), that can also
9040 dbd0c77e575e Cleanup documentation file plot.texi Rik <rdrider0-list@yahoo.com> parents: 9032 diff changeset	2431 have the values of "none" or "auto". If @code{linecolor} is "none", then no
dbd0c77e575e Cleanup documentation file plot.texi Rik <rdrider0-list@yahoo.com> parents: 9032 diff changeset	2432 contour line is drawn. If @code{linecolor} is "auto" then the line color is
8289 ac7f334d9652 Add contour group objects and the clabel function David Bateman <dbateman@free.fr> parents: 8286 diff changeset	2433 determined by the colormap.
ac7f334d9652 Add contour group objects and the clabel function David Bateman <dbateman@free.fr> parents: 8286 diff changeset	2434
ac7f334d9652 Add contour group objects and the clabel function David Bateman <dbateman@free.fr> parents: 8286 diff changeset	2435 @item xdata
ac7f334d9652 Add contour group objects and the clabel function David Bateman <dbateman@free.fr> parents: 8286 diff changeset	2436 @itemx ydata
ac7f334d9652 Add contour group objects and the clabel function David Bateman <dbateman@free.fr> parents: 8286 diff changeset	2437 @itemx zdata
ac7f334d9652 Add contour group objects and the clabel function David Bateman <dbateman@free.fr> parents: 8286 diff changeset	2438 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	2439
ac7f334d9652 Add contour group objects and the clabel function David Bateman <dbateman@free.fr> parents: 8286 diff changeset	2440 @item xdatasource
ac7f334d9652 Add contour group objects and the clabel function David Bateman <dbateman@free.fr> parents: 8286 diff changeset	2441 @itemx ydatasource
ac7f334d9652 Add contour group objects and the clabel function David Bateman <dbateman@free.fr> parents: 8286 diff changeset	2442 @itemx zdatasource
ac7f334d9652 Add contour group objects and the clabel function David Bateman <dbateman@free.fr> parents: 8286 diff changeset	2443 Data source variables.
ac7f334d9652 Add contour group objects and the clabel function David Bateman <dbateman@free.fr> parents: 8286 diff changeset	2444 @end table
8056 9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them David Bateman <dbateman@free.fr> parents: 8055 diff changeset	2445
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them David Bateman <dbateman@free.fr> parents: 8055 diff changeset	2446 @node Error bar series
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them David Bateman <dbateman@free.fr> parents: 8055 diff changeset	2447 @subsubsection Error bar series
8071 b6e85fb238c1 doc fixes John W. Eaton <jwe@octave.org> parents: 8070 diff changeset	2448 @cindex series objects
b6e85fb238c1 doc fixes John W. Eaton <jwe@octave.org> parents: 8070 diff changeset	2449 @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	2450
9672 43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	2451 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	2452 @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	2453 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	2454
2b408bbd8904 Add error bar series David Bateman <dbateman@free.fr> parents: 8257 diff changeset	2455 @table @code
2b408bbd8904 Add error bar series David Bateman <dbateman@free.fr> parents: 8257 diff changeset	2456 @item color
9040 dbd0c77e575e Cleanup documentation file plot.texi Rik <rdrider0-list@yahoo.com> parents: 9032 diff changeset	2457 The RGB color or color name of the line objects of the error bars. @xref{Colors}.
8258 2b408bbd8904 Add error bar series David Bateman <dbateman@free.fr> parents: 8257 diff changeset	2458
2b408bbd8904 Add error bar series David Bateman <dbateman@free.fr> parents: 8257 diff changeset	2459 @item linewidth
2b408bbd8904 Add error bar series David Bateman <dbateman@free.fr> parents: 8257 diff changeset	2460 @itemx linestyle
9040 dbd0c77e575e Cleanup documentation file plot.texi Rik <rdrider0-list@yahoo.com> parents: 9032 diff changeset	2461 The line width and style of the line objects of the error bars. @xref{Line Styles}.
8258 2b408bbd8904 Add error bar series David Bateman <dbateman@free.fr> parents: 8257 diff changeset	2462
2b408bbd8904 Add error bar series David Bateman <dbateman@free.fr> parents: 8257 diff changeset	2463 @item marker
2b408bbd8904 Add error bar series David Bateman <dbateman@free.fr> parents: 8257 diff changeset	2464 @itemx markeredgecolor
2b408bbd8904 Add error bar series David Bateman <dbateman@free.fr> parents: 8257 diff changeset	2465 @itemx markerfacecolor
2b408bbd8904 Add error bar series David Bateman <dbateman@free.fr> parents: 8257 diff changeset	2466 @itemx markersize
9040 dbd0c77e575e Cleanup documentation file plot.texi Rik <rdrider0-list@yahoo.com> parents: 9032 diff changeset	2467 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	2468
2b408bbd8904 Add error bar series David Bateman <dbateman@free.fr> parents: 8257 diff changeset	2469 @item xdata
2b408bbd8904 Add error bar series David Bateman <dbateman@free.fr> parents: 8257 diff changeset	2470 @itemx ydata
2b408bbd8904 Add error bar series David Bateman <dbateman@free.fr> parents: 8257 diff changeset	2471 @itemx ldata
2b408bbd8904 Add error bar series David Bateman <dbateman@free.fr> parents: 8257 diff changeset	2472 @itemx udata
2b408bbd8904 Add error bar series David Bateman <dbateman@free.fr> parents: 8257 diff changeset	2473 @itemx xldata
2b408bbd8904 Add error bar series David Bateman <dbateman@free.fr> parents: 8257 diff changeset	2474 @itemx xudata
2b408bbd8904 Add error bar series David Bateman <dbateman@free.fr> parents: 8257 diff changeset	2475 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	2476
2b408bbd8904 Add error bar series David Bateman <dbateman@free.fr> parents: 8257 diff changeset	2477 @item xdatasource
2b408bbd8904 Add error bar series David Bateman <dbateman@free.fr> parents: 8257 diff changeset	2478 @itemx ydatasource
2b408bbd8904 Add error bar series David Bateman <dbateman@free.fr> parents: 8257 diff changeset	2479 @itemx ldatasource
2b408bbd8904 Add error bar series David Bateman <dbateman@free.fr> parents: 8257 diff changeset	2480 @itemx udatasource
2b408bbd8904 Add error bar series David Bateman <dbateman@free.fr> parents: 8257 diff changeset	2481 @itemx xldatasource
2b408bbd8904 Add error bar series David Bateman <dbateman@free.fr> parents: 8257 diff changeset	2482 @itemx xudatasource
2b408bbd8904 Add error bar series David Bateman <dbateman@free.fr> parents: 8257 diff changeset	2483 Data source variables.
2b408bbd8904 Add error bar series David Bateman <dbateman@free.fr> parents: 8257 diff changeset	2484 @end table
2b408bbd8904 Add error bar series David Bateman <dbateman@free.fr> parents: 8257 diff changeset	2485
8056 9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them David Bateman <dbateman@free.fr> parents: 8055 diff changeset	2486 @node Line series
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them David Bateman <dbateman@free.fr> parents: 8055 diff changeset	2487 @subsubsection Line series
8071 b6e85fb238c1 doc fixes John W. Eaton <jwe@octave.org> parents: 8070 diff changeset	2488 @cindex series objects
b6e85fb238c1 doc fixes John W. Eaton <jwe@octave.org> parents: 8070 diff changeset	2489 @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	2490
8257 79c874fe5100 More plot object updates David Bateman <dbateman@free.fr> parents: 8089 diff changeset	2491 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	2492 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	2493 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	2494
3b53b25e2550 Add data sources and line series David Bateman <dbateman@free.fr> parents: 8057 diff changeset	2495 @table @code
3b53b25e2550 Add data sources and line series David Bateman <dbateman@free.fr> parents: 8057 diff changeset	2496 @item color
9040 dbd0c77e575e Cleanup documentation file plot.texi Rik <rdrider0-list@yahoo.com> parents: 9032 diff changeset	2497 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	2498
3b53b25e2550 Add data sources and line series David Bateman <dbateman@free.fr> parents: 8057 diff changeset	2499 @item linewidth
3b53b25e2550 Add data sources and line series David Bateman <dbateman@free.fr> parents: 8057 diff changeset	2500 @itemx linestyle
9040 dbd0c77e575e Cleanup documentation file plot.texi Rik <rdrider0-list@yahoo.com> parents: 9032 diff changeset	2501 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	2502
3b53b25e2550 Add data sources and line series David Bateman <dbateman@free.fr> parents: 8057 diff changeset	2503 @item marker
3b53b25e2550 Add data sources and line series David Bateman <dbateman@free.fr> parents: 8057 diff changeset	2504 @itemx markeredgecolor
3b53b25e2550 Add data sources and line series David Bateman <dbateman@free.fr> parents: 8057 diff changeset	2505 @itemx markerfacecolor
3b53b25e2550 Add data sources and line series David Bateman <dbateman@free.fr> parents: 8057 diff changeset	2506 @itemx markersize
9040 dbd0c77e575e Cleanup documentation file plot.texi Rik <rdrider0-list@yahoo.com> parents: 9032 diff changeset	2507 The line and fill color of the markers. @xref{Colors}.
8070 3b53b25e2550 Add data sources and line series David Bateman <dbateman@free.fr> parents: 8057 diff changeset	2508
3b53b25e2550 Add data sources and line series David Bateman <dbateman@free.fr> parents: 8057 diff changeset	2509 @item xdata
3b53b25e2550 Add data sources and line series David Bateman <dbateman@free.fr> parents: 8057 diff changeset	2510 @itemx ydata
3b53b25e2550 Add data sources and line series David Bateman <dbateman@free.fr> parents: 8057 diff changeset	2511 @itemx zdata
8257 79c874fe5100 More plot object updates David Bateman <dbateman@free.fr> parents: 8089 diff changeset	2512 The original x, y and z data.
8070 3b53b25e2550 Add data sources and line series David Bateman <dbateman@free.fr> parents: 8057 diff changeset	2513
3b53b25e2550 Add data sources and line series David Bateman <dbateman@free.fr> parents: 8057 diff changeset	2514 @item xdatasource
3b53b25e2550 Add data sources and line series David Bateman <dbateman@free.fr> parents: 8057 diff changeset	2515 @itemx ydatasource
3b53b25e2550 Add data sources and line series David Bateman <dbateman@free.fr> parents: 8057 diff changeset	2516 @itemx zdatasource
3b53b25e2550 Add data sources and line series David Bateman <dbateman@free.fr> parents: 8057 diff changeset	2517 Data source variables.
3b53b25e2550 Add data sources and line series David Bateman <dbateman@free.fr> parents: 8057 diff changeset	2518 @end table
8056 9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them David Bateman <dbateman@free.fr> parents: 8055 diff changeset	2519
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them David Bateman <dbateman@free.fr> parents: 8055 diff changeset	2520 @node Quiver group
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them David Bateman <dbateman@free.fr> parents: 8055 diff changeset	2521 @subsubsection Quiver group
8071 b6e85fb238c1 doc fixes John W. Eaton <jwe@octave.org> parents: 8070 diff changeset	2522 @cindex group objects
b6e85fb238c1 doc fixes John W. Eaton <jwe@octave.org> parents: 8070 diff changeset	2523 @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	2524
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them David Bateman <dbateman@free.fr> parents: 8055 diff changeset	2525 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	2526 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	2527 objects as children representing the body and head of the arrow,
9672 43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	2528 together with a marker as the point of original 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	2529 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	2530
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them David Bateman <dbateman@free.fr> parents: 8055 diff changeset	2531 @table @code
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them David Bateman <dbateman@free.fr> parents: 8055 diff changeset	2532 @item autoscale
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them David Bateman <dbateman@free.fr> parents: 8055 diff changeset	2533 @itemx autoscalefactor
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them David Bateman <dbateman@free.fr> parents: 8055 diff changeset	2534 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	2535 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	2536 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	2537 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	2538
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them David Bateman <dbateman@free.fr> parents: 8055 diff changeset	2539 @item maxheadsize
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them David Bateman <dbateman@free.fr> parents: 8055 diff changeset	2540 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	2541 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	2542
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them David Bateman <dbateman@free.fr> parents: 8055 diff changeset	2543 @item showarrowhead
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them David Bateman <dbateman@free.fr> parents: 8055 diff changeset	2544 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	2545
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them David Bateman <dbateman@free.fr> parents: 8055 diff changeset	2546 @item color
9040 dbd0c77e575e Cleanup documentation file plot.texi Rik <rdrider0-list@yahoo.com> parents: 9032 diff changeset	2547 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	2548
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them David Bateman <dbateman@free.fr> parents: 8055 diff changeset	2549 @item linewidth
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them David Bateman <dbateman@free.fr> parents: 8055 diff changeset	2550 @itemx linestyle
9040 dbd0c77e575e Cleanup documentation file plot.texi Rik <rdrider0-list@yahoo.com> parents: 9032 diff changeset	2551 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	2552
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them David Bateman <dbateman@free.fr> parents: 8055 diff changeset	2553 @item marker
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them David Bateman <dbateman@free.fr> parents: 8055 diff changeset	2554 @itemx markerfacecolor
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them David Bateman <dbateman@free.fr> parents: 8055 diff changeset	2555 @itemx markersize
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them David Bateman <dbateman@free.fr> parents: 8055 diff changeset	2556 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	2557 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	2558
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them David Bateman <dbateman@free.fr> parents: 8055 diff changeset	2559 @item xdata
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them David Bateman <dbateman@free.fr> parents: 8055 diff changeset	2560 @itemx ydata
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them David Bateman <dbateman@free.fr> parents: 8055 diff changeset	2561 @itemx zdata
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them David Bateman <dbateman@free.fr> parents: 8055 diff changeset	2562 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	2563
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them David Bateman <dbateman@free.fr> parents: 8055 diff changeset	2564 @item udata
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them David Bateman <dbateman@free.fr> parents: 8055 diff changeset	2565 @itemx vdata
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them David Bateman <dbateman@free.fr> parents: 8055 diff changeset	2566 @itemx wdata
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them David Bateman <dbateman@free.fr> parents: 8055 diff changeset	2567 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	2568
3b53b25e2550 Add data sources and line series David Bateman <dbateman@free.fr> parents: 8057 diff changeset	2569 @item xdatasource
3b53b25e2550 Add data sources and line series David Bateman <dbateman@free.fr> parents: 8057 diff changeset	2570 @itemx ydatasource
3b53b25e2550 Add data sources and line series David Bateman <dbateman@free.fr> parents: 8057 diff changeset	2571 @itemx zdatasource
3b53b25e2550 Add data sources and line series David Bateman <dbateman@free.fr> parents: 8057 diff changeset	2572 @itemx udatasource
3b53b25e2550 Add data sources and line series David Bateman <dbateman@free.fr> parents: 8057 diff changeset	2573 @itemx vdatasource
3b53b25e2550 Add data sources and line series David Bateman <dbateman@free.fr> parents: 8057 diff changeset	2574 @itemx wdatasource
3b53b25e2550 Add data sources and line series David Bateman <dbateman@free.fr> parents: 8057 diff changeset	2575 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	2576 @end table
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them David Bateman <dbateman@free.fr> parents: 8055 diff changeset	2577
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them David Bateman <dbateman@free.fr> parents: 8055 diff changeset	2578 @node Scatter group
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them David Bateman <dbateman@free.fr> parents: 8055 diff changeset	2579 @subsubsection Scatter group
8071 b6e85fb238c1 doc fixes John W. Eaton <jwe@octave.org> parents: 8070 diff changeset	2580 @cindex group objects
b6e85fb238c1 doc fixes John W. Eaton <jwe@octave.org> parents: 8070 diff changeset	2581 @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	2582
8257 79c874fe5100 More plot object updates David Bateman <dbateman@free.fr> parents: 8089 diff changeset	2583 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	2584 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	2585 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	2586 The properties of the stem series are
79c874fe5100 More plot object updates David Bateman <dbateman@free.fr> parents: 8089 diff changeset	2587
79c874fe5100 More plot object updates David Bateman <dbateman@free.fr> parents: 8089 diff changeset	2588 @table @code
79c874fe5100 More plot object updates David Bateman <dbateman@free.fr> parents: 8089 diff changeset	2589 @item linewidth
9040 dbd0c77e575e Cleanup documentation file plot.texi Rik <rdrider0-list@yahoo.com> parents: 9032 diff changeset	2590 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	2591
79c874fe5100 More plot object updates David Bateman <dbateman@free.fr> parents: 8089 diff changeset	2592 @item marker
79c874fe5100 More plot object updates David Bateman <dbateman@free.fr> parents: 8089 diff changeset	2593 @itemx markeredgecolor
79c874fe5100 More plot object updates David Bateman <dbateman@free.fr> parents: 8089 diff changeset	2594 @itemx markerfacecolor
9040 dbd0c77e575e Cleanup documentation file plot.texi Rik <rdrider0-list@yahoo.com> parents: 9032 diff changeset	2595 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	2596
79c874fe5100 More plot object updates David Bateman <dbateman@free.fr> parents: 8089 diff changeset	2597 @item xdata
79c874fe5100 More plot object updates David Bateman <dbateman@free.fr> parents: 8089 diff changeset	2598 @itemx ydata
79c874fe5100 More plot object updates David Bateman <dbateman@free.fr> parents: 8089 diff changeset	2599 @itemx zdata
79c874fe5100 More plot object updates David Bateman <dbateman@free.fr> parents: 8089 diff changeset	2600 The original x, y and z data of the stems.
79c874fe5100 More plot object updates David Bateman <dbateman@free.fr> parents: 8089 diff changeset	2601
79c874fe5100 More plot object updates David Bateman <dbateman@free.fr> parents: 8089 diff changeset	2602 @item cdata
9040 dbd0c77e575e Cleanup documentation file plot.texi Rik <rdrider0-list@yahoo.com> parents: 9032 diff changeset	2603 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	2604 color, or a unique color can be specified.
79c874fe5100 More plot object updates David Bateman <dbateman@free.fr> parents: 8089 diff changeset	2605
79c874fe5100 More plot object updates David Bateman <dbateman@free.fr> parents: 8089 diff changeset	2606 @item sizedata
9672 43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	2607 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	2608 unique size can be specified.
79c874fe5100 More plot object updates David Bateman <dbateman@free.fr> parents: 8089 diff changeset	2609
79c874fe5100 More plot object updates David Bateman <dbateman@free.fr> parents: 8089 diff changeset	2610 @item xdatasource
79c874fe5100 More plot object updates David Bateman <dbateman@free.fr> parents: 8089 diff changeset	2611 @itemx ydatasource
79c874fe5100 More plot object updates David Bateman <dbateman@free.fr> parents: 8089 diff changeset	2612 @itemx zdatasource
79c874fe5100 More plot object updates David Bateman <dbateman@free.fr> parents: 8089 diff changeset	2613 @itemx cdatasource
79c874fe5100 More plot object updates David Bateman <dbateman@free.fr> parents: 8089 diff changeset	2614 @itemx sizedatasource
79c874fe5100 More plot object updates David Bateman <dbateman@free.fr> parents: 8089 diff changeset	2615 Data source variables.
79c874fe5100 More plot object updates David Bateman <dbateman@free.fr> parents: 8089 diff changeset	2616 @end table
8056 9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them David Bateman <dbateman@free.fr> parents: 8055 diff changeset	2617
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them David Bateman <dbateman@free.fr> parents: 8055 diff changeset	2618 @node Stair group
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them David Bateman <dbateman@free.fr> parents: 8055 diff changeset	2619 @subsubsection Stair group
8071 b6e85fb238c1 doc fixes John W. Eaton <jwe@octave.org> parents: 8070 diff changeset	2620 @cindex group objects
b6e85fb238c1 doc fixes John W. Eaton <jwe@octave.org> parents: 8070 diff changeset	2621 @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	2622
9040 dbd0c77e575e Cleanup documentation file plot.texi Rik <rdrider0-list@yahoo.com> parents: 9032 diff changeset	2623 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	2624 @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	2625 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	2626
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them David Bateman <dbateman@free.fr> parents: 8055 diff changeset	2627 @table @code
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them David Bateman <dbateman@free.fr> parents: 8055 diff changeset	2628 @item color
9040 dbd0c77e575e Cleanup documentation file plot.texi Rik <rdrider0-list@yahoo.com> parents: 9032 diff changeset	2629 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	2630
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them David Bateman <dbateman@free.fr> parents: 8055 diff changeset	2631 @item linewidth
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them David Bateman <dbateman@free.fr> parents: 8055 diff changeset	2632 @itemx linestyle
9040 dbd0c77e575e Cleanup documentation file plot.texi Rik <rdrider0-list@yahoo.com> parents: 9032 diff changeset	2633 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	2634
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them David Bateman <dbateman@free.fr> parents: 8055 diff changeset	2635 @item marker
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them David Bateman <dbateman@free.fr> parents: 8055 diff changeset	2636 @itemx markeredgecolor
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them David Bateman <dbateman@free.fr> parents: 8055 diff changeset	2637 @itemx markerfacecolor
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them David Bateman <dbateman@free.fr> parents: 8055 diff changeset	2638 @itemx markersize
9040 dbd0c77e575e Cleanup documentation file plot.texi Rik <rdrider0-list@yahoo.com> parents: 9032 diff changeset	2639 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	2640
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them David Bateman <dbateman@free.fr> parents: 8055 diff changeset	2641 @item xdata
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them David Bateman <dbateman@free.fr> parents: 8055 diff changeset	2642 @itemx ydata
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them David Bateman <dbateman@free.fr> parents: 8055 diff changeset	2643 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	2644
3b53b25e2550 Add data sources and line series David Bateman <dbateman@free.fr> parents: 8057 diff changeset	2645 @item xdatasource
3b53b25e2550 Add data sources and line series David Bateman <dbateman@free.fr> parents: 8057 diff changeset	2646 @itemx ydatasource
3b53b25e2550 Add data sources and line series David Bateman <dbateman@free.fr> parents: 8057 diff changeset	2647 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	2648 @end table
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them David Bateman <dbateman@free.fr> parents: 8055 diff changeset	2649
8073 8468140fd997 doc fix John W. Eaton <jwe@octave.org> parents: 8071 diff changeset	2650 @node Stem Series
8468140fd997 doc fix John W. Eaton <jwe@octave.org> parents: 8071 diff changeset	2651 @subsubsection Stem Series
8468140fd997 doc fix John W. Eaton <jwe@octave.org> parents: 8071 diff changeset	2652 @cindex series objects
8468140fd997 doc fix John W. Eaton <jwe@octave.org> parents: 8071 diff changeset	2653 @cindex stem series
8468140fd997 doc fix John W. Eaton <jwe@octave.org> parents: 8071 diff changeset	2654
8257 79c874fe5100 More plot object updates David Bateman <dbateman@free.fr> parents: 8089 diff changeset	2655 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	2656 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	2657 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	2658 are
79c874fe5100 More plot object updates David Bateman <dbateman@free.fr> parents: 8089 diff changeset	2659
79c874fe5100 More plot object updates David Bateman <dbateman@free.fr> parents: 8089 diff changeset	2660 @table @code
79c874fe5100 More plot object updates David Bateman <dbateman@free.fr> parents: 8089 diff changeset	2661 @item showbaseline
79c874fe5100 More plot object updates David Bateman <dbateman@free.fr> parents: 8089 diff changeset	2662 @itemx baseline
79c874fe5100 More plot object updates David Bateman <dbateman@free.fr> parents: 8089 diff changeset	2663 @itemx basevalue
79c874fe5100 More plot object updates David Bateman <dbateman@free.fr> parents: 8089 diff changeset	2664 The property @code{showbaseline} flags whether the baseline of the
9040 dbd0c77e575e Cleanup documentation file plot.texi Rik <rdrider0-list@yahoo.com> parents: 9032 diff changeset	2665 stem series is displayed (default is "on"). The handle of the graphics
8257 79c874fe5100 More plot object updates David Bateman <dbateman@free.fr> parents: 8089 diff changeset	2666 object representing the baseline is given by the @code{baseline}
79c874fe5100 More plot object updates David Bateman <dbateman@free.fr> parents: 8089 diff changeset	2667 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	2668 by the @code{basevalue} property.
79c874fe5100 More plot object updates David Bateman <dbateman@free.fr> parents: 8089 diff changeset	2669
79c874fe5100 More plot object updates David Bateman <dbateman@free.fr> parents: 8089 diff changeset	2670 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	2671 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	2672 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	2673 corresponding stem series.
79c874fe5100 More plot object updates David Bateman <dbateman@free.fr> parents: 8089 diff changeset	2674
79c874fe5100 More plot object updates David Bateman <dbateman@free.fr> parents: 8089 diff changeset	2675 @item color
9040 dbd0c77e575e Cleanup documentation file plot.texi Rik <rdrider0-list@yahoo.com> parents: 9032 diff changeset	2676 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	2677
79c874fe5100 More plot object updates David Bateman <dbateman@free.fr> parents: 8089 diff changeset	2678 @item linewidth
79c874fe5100 More plot object updates David Bateman <dbateman@free.fr> parents: 8089 diff changeset	2679 @itemx linestyle
9040 dbd0c77e575e Cleanup documentation file plot.texi Rik <rdrider0-list@yahoo.com> parents: 9032 diff changeset	2680 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	2681
79c874fe5100 More plot object updates David Bateman <dbateman@free.fr> parents: 8089 diff changeset	2682 @item marker
79c874fe5100 More plot object updates David Bateman <dbateman@free.fr> parents: 8089 diff changeset	2683 @itemx markeredgecolor
79c874fe5100 More plot object updates David Bateman <dbateman@free.fr> parents: 8089 diff changeset	2684 @itemx markerfacecolor
79c874fe5100 More plot object updates David Bateman <dbateman@free.fr> parents: 8089 diff changeset	2685 @itemx markersize
9040 dbd0c77e575e Cleanup documentation file plot.texi Rik <rdrider0-list@yahoo.com> parents: 9032 diff changeset	2686 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	2687
79c874fe5100 More plot object updates David Bateman <dbateman@free.fr> parents: 8089 diff changeset	2688 @item xdata
79c874fe5100 More plot object updates David Bateman <dbateman@free.fr> parents: 8089 diff changeset	2689 @itemx ydata
79c874fe5100 More plot object updates David Bateman <dbateman@free.fr> parents: 8089 diff changeset	2690 @itemx zdata
79c874fe5100 More plot object updates David Bateman <dbateman@free.fr> parents: 8089 diff changeset	2691 The original x, y and z data of the stems.
79c874fe5100 More plot object updates David Bateman <dbateman@free.fr> parents: 8089 diff changeset	2692
79c874fe5100 More plot object updates David Bateman <dbateman@free.fr> parents: 8089 diff changeset	2693 @item xdatasource
79c874fe5100 More plot object updates David Bateman <dbateman@free.fr> parents: 8089 diff changeset	2694 @itemx ydatasource
79c874fe5100 More plot object updates David Bateman <dbateman@free.fr> parents: 8089 diff changeset	2695 @itemx zdatasource
79c874fe5100 More plot object updates David Bateman <dbateman@free.fr> parents: 8089 diff changeset	2696 Data source variables.
79c874fe5100 More plot object updates David Bateman <dbateman@free.fr> parents: 8089 diff changeset	2697 @end table
8073 8468140fd997 doc fix John W. Eaton <jwe@octave.org> parents: 8071 diff changeset	2698
8056 9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them David Bateman <dbateman@free.fr> parents: 8055 diff changeset	2699 @node Surface group
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them David Bateman <dbateman@free.fr> parents: 8055 diff changeset	2700 @subsubsection Surface group
8071 b6e85fb238c1 doc fixes John W. Eaton <jwe@octave.org> parents: 8070 diff changeset	2701 @cindex group objects
b6e85fb238c1 doc fixes John W. Eaton <jwe@octave.org> parents: 8070 diff changeset	2702 @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	2703
8257 79c874fe5100 More plot object updates David Bateman <dbateman@free.fr> parents: 8089 diff changeset	2704 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	2705 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	2706 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	2707
79c874fe5100 More plot object updates David Bateman <dbateman@free.fr> parents: 8089 diff changeset	2708 The properties of the surface group are
79c874fe5100 More plot object updates David Bateman <dbateman@free.fr> parents: 8089 diff changeset	2709
79c874fe5100 More plot object updates David Bateman <dbateman@free.fr> parents: 8089 diff changeset	2710 @table @code
79c874fe5100 More plot object updates David Bateman <dbateman@free.fr> parents: 8089 diff changeset	2711 @item edgecolor
79c874fe5100 More plot object updates David Bateman <dbateman@free.fr> parents: 8089 diff changeset	2712 @item facecolor
9040 dbd0c77e575e Cleanup documentation file plot.texi Rik <rdrider0-list@yahoo.com> parents: 9032 diff changeset	2713 The RGB color or color name of the edges or faces of the surface. @xref{Colors}.
8257 79c874fe5100 More plot object updates David Bateman <dbateman@free.fr> parents: 8089 diff changeset	2714
79c874fe5100 More plot object updates David Bateman <dbateman@free.fr> parents: 8089 diff changeset	2715 @item linewidth
79c874fe5100 More plot object updates David Bateman <dbateman@free.fr> parents: 8089 diff changeset	2716 @itemx linestyle
9040 dbd0c77e575e Cleanup documentation file plot.texi Rik <rdrider0-list@yahoo.com> parents: 9032 diff changeset	2717 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	2718
79c874fe5100 More plot object updates David Bateman <dbateman@free.fr> parents: 8089 diff changeset	2719 @item marker
79c874fe5100 More plot object updates David Bateman <dbateman@free.fr> parents: 8089 diff changeset	2720 @itemx markeredgecolor
79c874fe5100 More plot object updates David Bateman <dbateman@free.fr> parents: 8089 diff changeset	2721 @itemx markerfacecolor
79c874fe5100 More plot object updates David Bateman <dbateman@free.fr> parents: 8089 diff changeset	2722 @itemx markersize
9040 dbd0c77e575e Cleanup documentation file plot.texi Rik <rdrider0-list@yahoo.com> parents: 9032 diff changeset	2723 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	2724
79c874fe5100 More plot object updates David Bateman <dbateman@free.fr> parents: 8089 diff changeset	2725 @item xdata
79c874fe5100 More plot object updates David Bateman <dbateman@free.fr> parents: 8089 diff changeset	2726 @itemx ydata
79c874fe5100 More plot object updates David Bateman <dbateman@free.fr> parents: 8089 diff changeset	2727 @itemx zdata
79c874fe5100 More plot object updates David Bateman <dbateman@free.fr> parents: 8089 diff changeset	2728 @item cdata
79c874fe5100 More plot object updates David Bateman <dbateman@free.fr> parents: 8089 diff changeset	2729 The original x, y, z and c data.
79c874fe5100 More plot object updates David Bateman <dbateman@free.fr> parents: 8089 diff changeset	2730
79c874fe5100 More plot object updates David Bateman <dbateman@free.fr> parents: 8089 diff changeset	2731 @item xdatasource
79c874fe5100 More plot object updates David Bateman <dbateman@free.fr> parents: 8089 diff changeset	2732 @itemx ydatasource
79c874fe5100 More plot object updates David Bateman <dbateman@free.fr> parents: 8089 diff changeset	2733 @itemx zdatasource
79c874fe5100 More plot object updates David Bateman <dbateman@free.fr> parents: 8089 diff changeset	2734 @itemx cdatasource
79c874fe5100 More plot object updates David Bateman <dbateman@free.fr> parents: 8089 diff changeset	2735 Data source variables.
79c874fe5100 More plot object updates David Bateman <dbateman@free.fr> parents: 8089 diff changeset	2736 @end table
8056 9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them David Bateman <dbateman@free.fr> parents: 8055 diff changeset	2737
9672 43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	2738 @node Graphics Backends
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	2739 @subsection Graphics Backends
8071 b6e85fb238c1 doc fixes John W. Eaton <jwe@octave.org> parents: 8070 diff changeset	2740 @cindex graphics backends
b6e85fb238c1 doc fixes John W. Eaton <jwe@octave.org> parents: 8070 diff changeset	2741 @cindex backends, graphics
8056 9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them David Bateman <dbateman@free.fr> parents: 8055 diff changeset	2742
8519 68aa5abfd136 Trivial doc fixes sh@sh-laptop parents: 8429 diff changeset	2743 @DOCSTRING(backend)
8070 3b53b25e2550 Add data sources and line series David Bateman <dbateman@free.fr> parents: 8057 diff changeset	2744
8056 9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them David Bateman <dbateman@free.fr> parents: 8055 diff changeset	2745 @DOCSTRING(available_backends)
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them David Bateman <dbateman@free.fr> parents: 8055 diff changeset	2746
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them David Bateman <dbateman@free.fr> parents: 8055 diff changeset	2747 @menu
9676 e40835382b68 doc fixes John W. Eaton <jwe@octave.org> parents: 9672 diff changeset	2748 * Interaction with gnuplot::
8056 9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them David Bateman <dbateman@free.fr> parents: 8055 diff changeset	2749 @end menu
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them David Bateman <dbateman@free.fr> parents: 8055 diff changeset	2750
4167 aae05d51353c [project @ 2002-11-12 02:52:50 by jwe] jwe parents: 3439 diff changeset	2751 @node Interaction with gnuplot
8056 9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them David Bateman <dbateman@free.fr> parents: 8055 diff changeset	2752 @subsubsection Interaction with @code{gnuplot}
8071 b6e85fb238c1 doc fixes John W. Eaton <jwe@octave.org> parents: 8070 diff changeset	2753 @cindex gnuplot interaction
3428 5b77cf82393c [project @ 2000-01-14 02:54:53 by jwe] jwe parents: 3368 diff changeset	2754
5b77cf82393c [project @ 2000-01-14 02:54:53 by jwe] jwe parents: 3368 diff changeset	2755 @DOCSTRING(gnuplot_binary)