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

annotate doc/interpreter/plot.txi @ 20495:6db2ea5556a4

Make use of the axes "ticklabelinterpreter" property (bug #45438) * plot.txi: add an anchor pointing to usage of interpreter property * genpropdoc.m: document axes "ticklabelinterpreter" property and text "interpreter" property * gl-render.h: new private attribute "interpreter" that stores the interperter to be used in text_to_pixels * gl-render.h (set_interpreter): new protected virtual method to set "interpreter" * gl-render.cc (opengl_renderer::draw_axes): set interpreter before rendering tick labels * gl-render.cc (opengl_renderer::text_to_pixels): make use of interpreter attribute * graphics.cc (axes::properties::set_defaults): initialize "ticklabelinterpreter" instead of unused "interpreter" * graphics.in.h (axes::properties): fix doubly defined defaults for "ticklabelinterpreter" and "interpreter" properties

author	Pantxo Diribarne <pantxo.diribarne@gmail.com>
date	Tue, 23 Jun 2015 22:21:50 +0200
parents	ca7599ae464d
children	cdb382f1de79

rev	line source
19898 4197fc428c7d maint: Update copyright notices for 2015. John W. Eaton <jwe@octave.org> parents: 19794 diff changeset	1 @c Copyright (C) 1996-2015 John W. Eaton
7018 fd42779a8428 [project @ 2007-10-13 00:52:12 by jwe] jwe parents: 7001 diff changeset	2 @c
fd42779a8428 [project @ 2007-10-13 00:52:12 by jwe] jwe parents: 7001 diff changeset	3 @c This file is part of Octave.
fd42779a8428 [project @ 2007-10-13 00:52:12 by jwe] jwe parents: 7001 diff changeset	4 @c
fd42779a8428 [project @ 2007-10-13 00:52:12 by jwe] jwe parents: 7001 diff changeset	5 @c Octave is free software; you can redistribute it and/or modify it
fd42779a8428 [project @ 2007-10-13 00:52:12 by jwe] jwe parents: 7001 diff changeset	6 @c under the terms of the GNU General Public License as published by the
fd42779a8428 [project @ 2007-10-13 00:52:12 by jwe] jwe parents: 7001 diff changeset	7 @c Free Software Foundation; either version 3 of the License, or (at
fd42779a8428 [project @ 2007-10-13 00:52:12 by jwe] jwe parents: 7001 diff changeset	8 @c your option) any later version.
9672 43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	9 @c
7018 fd42779a8428 [project @ 2007-10-13 00:52:12 by jwe] jwe parents: 7001 diff changeset	10 @c Octave is distributed in the hope that it will be useful, but WITHOUT
fd42779a8428 [project @ 2007-10-13 00:52:12 by jwe] jwe parents: 7001 diff changeset	11 @c ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
fd42779a8428 [project @ 2007-10-13 00:52:12 by jwe] jwe parents: 7001 diff changeset	12 @c FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
fd42779a8428 [project @ 2007-10-13 00:52:12 by jwe] jwe parents: 7001 diff changeset	13 @c for more details.
9672 43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	14 @c
7018 fd42779a8428 [project @ 2007-10-13 00:52:12 by jwe] jwe parents: 7001 diff changeset	15 @c You should have received a copy of the GNU General Public License
fd42779a8428 [project @ 2007-10-13 00:52:12 by jwe] jwe parents: 7001 diff changeset	16 @c along with Octave; see the file COPYING. If not, see
fd42779a8428 [project @ 2007-10-13 00:52:12 by jwe] jwe parents: 7001 diff changeset	17 @c <http://www.gnu.org/licenses/>.
3294 bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	18
4167 aae05d51353c [project @ 2002-11-12 02:52:50 by jwe] jwe parents: 3439 diff changeset	19 @node Plotting
3294 bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	20 @chapter Plotting
6888 b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe] jwe parents: 6877 diff changeset	21 @cindex plotting
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe] jwe parents: 6877 diff changeset	22 @cindex graphics
3294 bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	23
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	24 @menu
17152 f2a8592b8fbd doc: Shorten some long subsection names in Manual. Rik <rik@octave.org> parents: 17123 diff changeset	25 * Introduction to Plotting::
f2a8592b8fbd doc: Shorten some long subsection names in Manual. Rik <rik@octave.org> parents: 17123 diff changeset	26 * High-Level Plotting::
f2a8592b8fbd doc: Shorten some long subsection names in Manual. Rik <rik@octave.org> parents: 17123 diff changeset	27 * Graphics Data Structures::
f2a8592b8fbd doc: Shorten some long subsection names in Manual. Rik <rik@octave.org> parents: 17123 diff changeset	28 * Advanced Plotting::
6888 b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe] jwe parents: 6877 diff changeset	29 @end menu
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe] jwe parents: 6877 diff changeset	30
9672 43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	31 @node Introduction to Plotting
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	32 @section Introduction to Plotting
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	33
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	34 Earlier versions of Octave provided plotting through the use of
9758 09da0bd91412 Periodic grammar check of Octave documentation files to ensure common format Rik <rdrider0-list@yahoo.com> parents: 9752 diff changeset	35 gnuplot. This capability is still available. But, a newer plotting
10828 322f43e0e170 Grammarcheck .txi documentation files. Rik <octave@nomad.inbox5.com> parents: 10711 diff changeset	36 capability is provided by access to OpenGL@. Which plotting system
17097 e7a059a9a644 doc: Use XREF as anchor prefix in documentation for clearer results in Info viewer. Rik <rik@octave.org> parents: 16923 diff changeset	37 is used is controlled by the @code{graphics_toolkit} function.
e7a059a9a644 doc: Use XREF as anchor prefix in documentation for clearer results in Info viewer. Rik <rik@octave.org> parents: 16923 diff changeset	38 @xref{Graphics Toolkits}.
11576 8ac9687dbe9f rename backend to graphics_toolkit John W. Eaton <jwe@octave.org> parents: 11573 diff changeset	39
8ac9687dbe9f rename backend to graphics_toolkit John W. Eaton <jwe@octave.org> parents: 11573 diff changeset	40 The function call @code{graphics_toolkit ("fltk")} selects the
11591 1d13679b587e Use @nospell macro on certain words in docstrings. Rik <octave@nomad.inbox5.com> parents: 11576 diff changeset	41 FLTK/OpenGL system, and @code{graphics_toolkit ("gnuplot")} selects the
11576 8ac9687dbe9f rename backend to graphics_toolkit John W. Eaton <jwe@octave.org> parents: 11573 diff changeset	42 gnuplot system. The two systems may be used selectively through the use
8ac9687dbe9f rename backend to graphics_toolkit John W. Eaton <jwe@octave.org> parents: 11573 diff changeset	43 of the @code{graphics_toolkit} property of the graphics handle for each
8ac9687dbe9f rename backend to graphics_toolkit John W. Eaton <jwe@octave.org> parents: 11573 diff changeset	44 figure. This is explained in @ref{Graphics Data Structures}.
12577 562e40e3d5db Add warning about single precision in FLTK. Rik <octave@nomad.inbox5.com> parents: 12529 diff changeset	45 @strong{Caution:} The FLTK toolkit uses single precision variables internally
562e40e3d5db Add warning about single precision in FLTK. Rik <octave@nomad.inbox5.com> parents: 12529 diff changeset	46 which limits the maximum value that can be displayed to approximately
562e40e3d5db Add warning about single precision in FLTK. Rik <octave@nomad.inbox5.com> parents: 12529 diff changeset	47 @math{10^{38}}. If your data contains larger values you must use the gnuplot
562e40e3d5db Add warning about single precision in FLTK. Rik <octave@nomad.inbox5.com> parents: 12529 diff changeset	48 toolkit which supports values up to @math{10^{308}}.
9672 43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	49
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	50 @node High-Level Plotting
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	51 @section High-Level Plotting
18398 200851c87444 Edits to Manual and indicies Michael Godfrey <michaeldgodfrey@gmail.com> parents: 17957 diff changeset	52 @cindex plotting, high-level
9672 43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	53
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	54 Octave provides simple means to create many different types of two- and
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	55 three-dimensional plots using high-level functions.
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	56
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	57 If you need more detailed control, see @ref{Graphics Data Structures}
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	58 and @ref{Advanced Plotting}.
6888 b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe] jwe parents: 6877 diff changeset	59
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe] jwe parents: 6877 diff changeset	60 @menu
17152 f2a8592b8fbd doc: Shorten some long subsection names in Manual. Rik <rik@octave.org> parents: 17123 diff changeset	61 * Two-Dimensional Plots::
f2a8592b8fbd doc: Shorten some long subsection names in Manual. Rik <rik@octave.org> parents: 17123 diff changeset	62 * Three-Dimensional Plots::
f2a8592b8fbd doc: Shorten some long subsection names in Manual. Rik <rik@octave.org> parents: 17123 diff changeset	63 * Plot Annotations::
f2a8592b8fbd doc: Shorten some long subsection names in Manual. Rik <rik@octave.org> parents: 17123 diff changeset	64 * Multiple Plots on One Page::
f2a8592b8fbd doc: Shorten some long subsection names in Manual. Rik <rik@octave.org> parents: 17123 diff changeset	65 * Multiple Plot Windows::
19273 d59d052c9858 rotate.m: new function John W. Eaton <jwe@octave.org> parents: 19270 diff changeset	66 * Manipulation of Plot Objects::
16096 9720ecf8d257 Fix additional warning associated with Texinfo 5.0 (bug #38392) Rik <rik@octave.org> parents: 16094 diff changeset	67 * Manipulation of Plot Windows::
9720ecf8d257 Fix additional warning associated with Texinfo 5.0 (bug #38392) Rik <rik@octave.org> parents: 16094 diff changeset	68 * Use of the @code{interpreter} Property::
17152 f2a8592b8fbd doc: Shorten some long subsection names in Manual. Rik <rik@octave.org> parents: 17123 diff changeset	69 * Printing and Saving Plots::
f2a8592b8fbd doc: Shorten some long subsection names in Manual. Rik <rik@octave.org> parents: 17123 diff changeset	70 * Interacting with Plots::
f2a8592b8fbd doc: Shorten some long subsection names in Manual. Rik <rik@octave.org> parents: 17123 diff changeset	71 * Test Plotting Functions::
3294 bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	72 @end menu
bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	73
6888 b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe] jwe parents: 6877 diff changeset	74 @node Two-Dimensional Plots
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe] jwe parents: 6877 diff changeset	75 @subsection Two-Dimensional Plots
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe] jwe parents: 6877 diff changeset	76
12526 f8ea3eabcb85 Add daspect, pbaspect functions to documentation. Rik <octave@nomad.inbox5.com> parents: 12525 diff changeset	77 @menu
17152 f2a8592b8fbd doc: Shorten some long subsection names in Manual. Rik <rik@octave.org> parents: 17123 diff changeset	78 * Axis Configuration::
f2a8592b8fbd doc: Shorten some long subsection names in Manual. Rik <rik@octave.org> parents: 17123 diff changeset	79 * Two-dimensional Function Plotting::
f2a8592b8fbd doc: Shorten some long subsection names in Manual. Rik <rik@octave.org> parents: 17123 diff changeset	80 * Two-dimensional Geometric Shapes::
12526 f8ea3eabcb85 Add daspect, pbaspect functions to documentation. Rik <octave@nomad.inbox5.com> parents: 12525 diff changeset	81 @end menu
f8ea3eabcb85 Add daspect, pbaspect functions to documentation. Rik <octave@nomad.inbox5.com> parents: 12525 diff changeset	82
6888 b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe] jwe parents: 6877 diff changeset	83 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	84 linear axes. For example,
3294 bfe1573bd2ae [project @ 1999-10-19 10:06:07 by jwe] jwe parents: diff changeset	85
6888 b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe] jwe parents: 6877 diff changeset	86 @example
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe] jwe parents: 6877 diff changeset	87 @group
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe] jwe parents: 6877 diff changeset	88 x = -10:0.1:10;
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe] jwe parents: 6877 diff changeset	89 plot (x, sin (x));
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe] jwe parents: 6877 diff changeset	90 @end group
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe] jwe parents: 6877 diff changeset	91 @end example
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe] jwe parents: 6877 diff changeset	92
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe] jwe parents: 6877 diff changeset	93 @noindent
6899 110c5782fe3b [project @ 2007-09-14 15:17:53 by jwe] jwe parents: 6892 diff changeset	94 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	95 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	96
6888 b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe] jwe parents: 6877 diff changeset	97 @float Figure,fig:plot
9088 77e71f3da3d6 Fix documentation image printing under new development code Rik <rdrider0-list@yahoo.com> parents: 9040 diff changeset	98 @center @image{plot,4in}
6888 b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe] jwe parents: 6877 diff changeset	99 @caption{Simple Two-Dimensional Plot.}
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe] jwe parents: 6877 diff changeset	100 @end float
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe] jwe parents: 6877 diff changeset	101
5134 0309b6722ee9 [project @ 2005-02-08 20:17:55 by jwe] jwe parents: 5016 diff changeset	102 @DOCSTRING(plot)
0309b6722ee9 [project @ 2005-02-08 20:17:55 by jwe] jwe parents: 5016 diff changeset	103
8817 03b7f618ab3d include docstrings for new functions in the manual John W. Eaton <jwe@octave.org> parents: 8519 diff changeset	104 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	105 independent y axes.
03b7f618ab3d include docstrings for new functions in the manual John W. Eaton <jwe@octave.org> parents: 8519 diff changeset	106
03b7f618ab3d include docstrings for new functions in the manual John W. Eaton <jwe@octave.org> parents: 8519 diff changeset	107 @DOCSTRING(plotyy)
03b7f618ab3d include docstrings for new functions in the manual John W. Eaton <jwe@octave.org> parents: 8519 diff changeset	108
6888 b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe] jwe parents: 6877 diff changeset	109 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	110 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	111 both of the axes use log scales.
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe] jwe parents: 6877 diff changeset	112
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe] jwe parents: 6877 diff changeset	113 @DOCSTRING(semilogx)
6502 6ab0a8767780 [project @ 2007-04-06 03:32:06 by jwe] jwe parents: 6331 diff changeset	114
6888 b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe] jwe parents: 6877 diff changeset	115 @DOCSTRING(semilogy)
6502 6ab0a8767780 [project @ 2007-04-06 03:32:06 by jwe] jwe parents: 6331 diff changeset	116
6888 b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe] jwe parents: 6877 diff changeset	117 @DOCSTRING(loglog)
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe] jwe parents: 6877 diff changeset	118
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe] jwe parents: 6877 diff changeset	119 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	120 are useful for displaying discrete data. For example,
5134 0309b6722ee9 [project @ 2005-02-08 20:17:55 by jwe] jwe parents: 5016 diff changeset	121
6888 b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe] jwe parents: 6877 diff changeset	122 @example
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe] jwe parents: 6877 diff changeset	123 @group
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe] jwe parents: 6877 diff changeset	124 hist (randn (10000, 1), 30);
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe] jwe parents: 6877 diff changeset	125 @end group
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe] jwe parents: 6877 diff changeset	126 @end example
5134 0309b6722ee9 [project @ 2005-02-08 20:17:55 by jwe] jwe parents: 5016 diff changeset	127
6888 b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe] jwe parents: 6877 diff changeset	128 @noindent
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe] jwe parents: 6877 diff changeset	129 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	130 shown in @ref{fig:hist}.
5134 0309b6722ee9 [project @ 2005-02-08 20:17:55 by jwe] jwe parents: 5016 diff changeset	131
6888 b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe] jwe parents: 6877 diff changeset	132 @float Figure,fig:hist
9088 77e71f3da3d6 Fix documentation image printing under new development code Rik <rdrider0-list@yahoo.com> parents: 9040 diff changeset	133 @center @image{hist,4in}
6888 b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe] jwe parents: 6877 diff changeset	134 @caption{Histogram.}
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe] jwe parents: 6877 diff changeset	135 @end float
5134 0309b6722ee9 [project @ 2005-02-08 20:17:55 by jwe] jwe parents: 5016 diff changeset	136
0309b6722ee9 [project @ 2005-02-08 20:17:55 by jwe] jwe parents: 5016 diff changeset	137 @DOCSTRING(bar)
0309b6722ee9 [project @ 2005-02-08 20:17:55 by jwe] jwe parents: 5016 diff changeset	138
6877 ab11bdb09820 [project @ 2007-09-07 05:12:32 by jwe] jwe parents: 6788 diff changeset	139 @DOCSTRING(barh)
ab11bdb09820 [project @ 2007-09-07 05:12:32 by jwe] jwe parents: 6788 diff changeset	140
6888 b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe] jwe parents: 6877 diff changeset	141 @DOCSTRING(hist)
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe] jwe parents: 6877 diff changeset	142
16008 6f567476e6f0 Add stemleaf and printd to the manual Michael Godfrey <michaeldgodfrey@gmail.com> parents: 14856 diff changeset	143 @DOCSTRING(stemleaf)
6f567476e6f0 Add stemleaf and printd to the manual Michael Godfrey <michaeldgodfrey@gmail.com> parents: 14856 diff changeset	144
6f567476e6f0 Add stemleaf and printd to the manual Michael Godfrey <michaeldgodfrey@gmail.com> parents: 14856 diff changeset	145 @DOCSTRING(printd)
6f567476e6f0 Add stemleaf and printd to the manual Michael Godfrey <michaeldgodfrey@gmail.com> parents: 14856 diff changeset	146
6888 b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe] jwe parents: 6877 diff changeset	147 @DOCSTRING(stairs)
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe] jwe parents: 6877 diff changeset	148
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe] jwe parents: 6877 diff changeset	149 @DOCSTRING(stem)
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe] jwe parents: 6877 diff changeset	150
8817 03b7f618ab3d include docstrings for new functions in the manual John W. Eaton <jwe@octave.org> parents: 8519 diff changeset	151 @DOCSTRING(stem3)
03b7f618ab3d include docstrings for new functions in the manual John W. Eaton <jwe@octave.org> parents: 8519 diff changeset	152
03b7f618ab3d include docstrings for new functions in the manual John W. Eaton <jwe@octave.org> parents: 8519 diff changeset	153 @DOCSTRING(scatter)
03b7f618ab3d include docstrings for new functions in the manual John W. Eaton <jwe@octave.org> parents: 8519 diff changeset	154
03b7f618ab3d include docstrings for new functions in the manual John W. Eaton <jwe@octave.org> parents: 8519 diff changeset	155 @DOCSTRING(plotmatrix)
03b7f618ab3d include docstrings for new functions in the manual John W. Eaton <jwe@octave.org> parents: 8519 diff changeset	156
03b7f618ab3d include docstrings for new functions in the manual John W. Eaton <jwe@octave.org> parents: 8519 diff changeset	157 @DOCSTRING(pareto)
03b7f618ab3d include docstrings for new functions in the manual John W. Eaton <jwe@octave.org> parents: 8519 diff changeset	158
03b7f618ab3d include docstrings for new functions in the manual John W. Eaton <jwe@octave.org> parents: 8519 diff changeset	159 @DOCSTRING(rose)
03b7f618ab3d include docstrings for new functions in the manual John W. Eaton <jwe@octave.org> parents: 8519 diff changeset	160
7981 90413830b690 Document contourf David Bateman <dbateman@free.fr> parents: 7980 diff changeset	161 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	162 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	163
5134 0309b6722ee9 [project @ 2005-02-08 20:17:55 by jwe] jwe parents: 5016 diff changeset	164 @DOCSTRING(contour)
0309b6722ee9 [project @ 2005-02-08 20:17:55 by jwe] jwe parents: 5016 diff changeset	165
7981 90413830b690 Document contourf David Bateman <dbateman@free.fr> parents: 7980 diff changeset	166 @DOCSTRING(contourf)
90413830b690 Document contourf David Bateman <dbateman@free.fr> parents: 7980 diff changeset	167
6502 6ab0a8767780 [project @ 2007-04-06 03:32:06 by jwe] jwe parents: 6331 diff changeset	168 @DOCSTRING(contourc)
6ab0a8767780 [project @ 2007-04-06 03:32:06 by jwe] jwe parents: 6331 diff changeset	169
8817 03b7f618ab3d include docstrings for new functions in the manual John W. Eaton <jwe@octave.org> parents: 8519 diff changeset	170 @DOCSTRING(contour3)
03b7f618ab3d include docstrings for new functions in the manual John W. Eaton <jwe@octave.org> parents: 8519 diff changeset	171
6888 b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe] jwe parents: 6877 diff changeset	172 The @code{errorbar}, @code{semilogxerr}, @code{semilogyerr}, and
8347 fa78cb8d8a5c corrections for typos Brian Gough<bjg@network-theory.co.uk> parents: 8325 diff changeset	173 @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	174 example,
6877 ab11bdb09820 [project @ 2007-09-07 05:12:32 by jwe] jwe parents: 6788 diff changeset	175
6888 b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe] jwe parents: 6877 diff changeset	176 @example
9088 77e71f3da3d6 Fix documentation image printing under new development code Rik <rdrider0-list@yahoo.com> parents: 9040 diff changeset	177 @group
6888 b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe] jwe parents: 6877 diff changeset	178 x = 0:0.1:10;
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe] jwe parents: 6877 diff changeset	179 y = sin (x);
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe] jwe parents: 6877 diff changeset	180 yp = 0.1 .* randn (size (x));
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe] jwe parents: 6877 diff changeset	181 ym = -0.1 .* randn (size (x));
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe] jwe parents: 6877 diff changeset	182 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	183 @end group
6888 b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe] jwe parents: 6877 diff changeset	184 @end example
5134 0309b6722ee9 [project @ 2005-02-08 20:17:55 by jwe] jwe parents: 5016 diff changeset	185
6888 b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe] jwe parents: 6877 diff changeset	186 @noindent
6899 110c5782fe3b [project @ 2007-09-14 15:17:53 by jwe] jwe parents: 6892 diff changeset	187 produces the figure shown in @ref{fig:errorbar}.
6502 6ab0a8767780 [project @ 2007-04-06 03:32:06 by jwe] jwe parents: 6331 diff changeset	188
6888 b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe] jwe parents: 6877 diff changeset	189 @float Figure,fig:errorbar
9088 77e71f3da3d6 Fix documentation image printing under new development code Rik <rdrider0-list@yahoo.com> parents: 9040 diff changeset	190 @center @image{errorbar,4in}
6888 b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe] jwe parents: 6877 diff changeset	191 @caption{Errorbar plot.}
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe] jwe parents: 6877 diff changeset	192 @end float
5134 0309b6722ee9 [project @ 2005-02-08 20:17:55 by jwe] jwe parents: 5016 diff changeset	193
0309b6722ee9 [project @ 2005-02-08 20:17:55 by jwe] jwe parents: 5016 diff changeset	194 @DOCSTRING(errorbar)
0309b6722ee9 [project @ 2005-02-08 20:17:55 by jwe] jwe parents: 5016 diff changeset	195
0309b6722ee9 [project @ 2005-02-08 20:17:55 by jwe] jwe parents: 5016 diff changeset	196 @DOCSTRING(semilogxerr)
0309b6722ee9 [project @ 2005-02-08 20:17:55 by jwe] jwe parents: 5016 diff changeset	197
0309b6722ee9 [project @ 2005-02-08 20:17:55 by jwe] jwe parents: 5016 diff changeset	198 @DOCSTRING(semilogyerr)
0309b6722ee9 [project @ 2005-02-08 20:17:55 by jwe] jwe parents: 5016 diff changeset	199
6888 b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe] jwe parents: 6877 diff changeset	200 @DOCSTRING(loglogerr)
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe] jwe parents: 6877 diff changeset	201
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe] jwe parents: 6877 diff changeset	202 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	203 polar coordinates. However, the display coordinates remain rectangular
6888 b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe] jwe parents: 6877 diff changeset	204 and linear. For example,
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe] jwe parents: 6877 diff changeset	205
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe] jwe parents: 6877 diff changeset	206 @example
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe] jwe parents: 6877 diff changeset	207 polar (0:0.1:10pi, 0:0.1:10pi);
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe] jwe parents: 6877 diff changeset	208 @end example
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe] jwe parents: 6877 diff changeset	209
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe] jwe parents: 6877 diff changeset	210 @noindent
6899 110c5782fe3b [project @ 2007-09-14 15:17:53 by jwe] jwe parents: 6892 diff changeset	211 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	212
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe] jwe parents: 6877 diff changeset	213 @float Figure,fig:polar
9088 77e71f3da3d6 Fix documentation image printing under new development code Rik <rdrider0-list@yahoo.com> parents: 9040 diff changeset	214 @center @image{polar,4in}
6888 b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe] jwe parents: 6877 diff changeset	215 @caption{Polar plot.}
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe] jwe parents: 6877 diff changeset	216 @end float
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe] jwe parents: 6877 diff changeset	217
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe] jwe parents: 6877 diff changeset	218 @DOCSTRING(polar)
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe] jwe parents: 6877 diff changeset	219
7120 a2174fb073d4 [project @ 2007-11-07 21:26:43 by jwe] jwe parents: 7018 diff changeset	220 @DOCSTRING(pie)
a2174fb073d4 [project @ 2007-11-07 21:26:43 by jwe] jwe parents: 7018 diff changeset	221
11330 4f399d91eb32 add pie3 to plot functions Kai Habel <kai.habel@gmx.de> parents: 11257 diff changeset	222 @DOCSTRING(pie3)
4f399d91eb32 add pie3 to plot functions Kai Habel <kai.habel@gmx.de> parents: 11257 diff changeset	223
7120 a2174fb073d4 [project @ 2007-11-07 21:26:43 by jwe] jwe parents: 7018 diff changeset	224 @DOCSTRING(quiver)
a2174fb073d4 [project @ 2007-11-07 21:26:43 by jwe] jwe parents: 7018 diff changeset	225
8817 03b7f618ab3d include docstrings for new functions in the manual John W. Eaton <jwe@octave.org> parents: 8519 diff changeset	226 @DOCSTRING(quiver3)
03b7f618ab3d include docstrings for new functions in the manual John W. Eaton <jwe@octave.org> parents: 8519 diff changeset	227
03b7f618ab3d include docstrings for new functions in the manual John W. Eaton <jwe@octave.org> parents: 8519 diff changeset	228 @DOCSTRING(compass)
03b7f618ab3d include docstrings for new functions in the manual John W. Eaton <jwe@octave.org> parents: 8519 diff changeset	229
03b7f618ab3d include docstrings for new functions in the manual John W. Eaton <jwe@octave.org> parents: 8519 diff changeset	230 @DOCSTRING(feather)
03b7f618ab3d include docstrings for new functions in the manual John W. Eaton <jwe@octave.org> parents: 8519 diff changeset	231
7120 a2174fb073d4 [project @ 2007-11-07 21:26:43 by jwe] jwe parents: 7018 diff changeset	232 @DOCSTRING(pcolor)
a2174fb073d4 [project @ 2007-11-07 21:26:43 by jwe] jwe parents: 7018 diff changeset	233
7153 4246642e9f48 [project @ 2007-11-09 21:20:07 by dbateman] dbateman parents: 7120 diff changeset	234 @DOCSTRING(area)
4246642e9f48 [project @ 2007-11-09 21:20:07 by dbateman] dbateman parents: 7120 diff changeset	235
19657 78c0241306b5 Add documentation about when to use newplot (bug #40289). Rik <rik@octave.org> parents: 19602 diff changeset	236 @DOCSTRING(fill)
78c0241306b5 Add documentation about when to use newplot (bug #40289). Rik <rik@octave.org> parents: 19602 diff changeset	237
8817 03b7f618ab3d include docstrings for new functions in the manual John W. Eaton <jwe@octave.org> parents: 8519 diff changeset	238 @DOCSTRING(comet)
03b7f618ab3d include docstrings for new functions in the manual John W. Eaton <jwe@octave.org> parents: 8519 diff changeset	239
11382 ed74d1fbdc2f comet3: new function John W. Eaton <jwe@octave.org> parents: 11380 diff changeset	240 @DOCSTRING(comet3)
ed74d1fbdc2f comet3: new function John W. Eaton <jwe@octave.org> parents: 11380 diff changeset	241
19504 39a69f54417e New functions im2frame and frame2im. Carnë Draug <carandraug@octave.org> parents: 19449 diff changeset	242 @DOCSTRING(frame2im)
39a69f54417e New functions im2frame and frame2im. Carnë Draug <carandraug@octave.org> parents: 19449 diff changeset	243
39a69f54417e New functions im2frame and frame2im. Carnë Draug <carandraug@octave.org> parents: 19449 diff changeset	244 @DOCSTRING(im2frame)
39a69f54417e New functions im2frame and frame2im. Carnë Draug <carandraug@octave.org> parents: 19449 diff changeset	245
12526 f8ea3eabcb85 Add daspect, pbaspect functions to documentation. Rik <octave@nomad.inbox5.com> parents: 12525 diff changeset	246 @node Axis Configuration
f8ea3eabcb85 Add daspect, pbaspect functions to documentation. Rik <octave@nomad.inbox5.com> parents: 12525 diff changeset	247 @subsubsection Axis Configuration
f8ea3eabcb85 Add daspect, pbaspect functions to documentation. Rik <octave@nomad.inbox5.com> parents: 12525 diff changeset	248
6888 b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe] jwe parents: 6877 diff changeset	249 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	250 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	251 appearance of tic marks.
6888 b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe] jwe parents: 6877 diff changeset	252
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe] jwe parents: 6877 diff changeset	253 @DOCSTRING(axis)
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe] jwe parents: 6877 diff changeset	254
7189 e8d953d03f6a [project @ 2007-11-26 20:42:09 by dbateman] dbateman parents: 7153 diff changeset	255 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	256 function.
e8d953d03f6a [project @ 2007-11-26 20:42:09 by dbateman] dbateman parents: 7153 diff changeset	257
e8d953d03f6a [project @ 2007-11-26 20:42:09 by dbateman] dbateman parents: 7153 diff changeset	258 @DOCSTRING(caxis)
e8d953d03f6a [project @ 2007-11-26 20:42:09 by dbateman] dbateman parents: 7153 diff changeset	259
8817 03b7f618ab3d include docstrings for new functions in the manual John W. Eaton <jwe@octave.org> parents: 8519 diff changeset	260 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	261 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	262
17122 eaab03308c0b doc: Rewrite docstrings for most plot functions. Rik <rik@octave.org> parents: 17099 diff changeset	263 @c Add cross-references and function index entries for other limit functions.
17097 e7a059a9a644 doc: Use XREF as anchor prefix in documentation for clearer results in Info viewer. Rik <rik@octave.org> parents: 16923 diff changeset	264 @anchor{XREFylim}
e7a059a9a644 doc: Use XREF as anchor prefix in documentation for clearer results in Info viewer. Rik <rik@octave.org> parents: 16923 diff changeset	265 @anchor{XREFzlim}
17122 eaab03308c0b doc: Rewrite docstrings for most plot functions. Rik <rik@octave.org> parents: 17099 diff changeset	266 @findex ylim
eaab03308c0b doc: Rewrite docstrings for most plot functions. Rik <rik@octave.org> parents: 17099 diff changeset	267 @findex zlim
8817 03b7f618ab3d include docstrings for new functions in the manual John W. Eaton <jwe@octave.org> parents: 8519 diff changeset	268 @DOCSTRING(xlim)
03b7f618ab3d include docstrings for new functions in the manual John W. Eaton <jwe@octave.org> parents: 8519 diff changeset	269
7984 bbaa5d7d0143 Some documentation updates David Bateman <dbateman@free.fr> parents: 7981 diff changeset	270 @node Two-dimensional Function Plotting
bbaa5d7d0143 Some documentation updates David Bateman <dbateman@free.fr> parents: 7981 diff changeset	271 @subsubsection Two-dimensional Function Plotting
18398 200851c87444 Edits to Manual and indicies Michael Godfrey <michaeldgodfrey@gmail.com> parents: 17957 diff changeset	272 @cindex plotting, two-dimensional functions
200851c87444 Edits to Manual and indicies Michael Godfrey <michaeldgodfrey@gmail.com> parents: 17957 diff changeset	273
200851c87444 Edits to Manual and indicies Michael Godfrey <michaeldgodfrey@gmail.com> parents: 17957 diff changeset	274 Octave can plot a function from a function handle, inline function, or
7984 bbaa5d7d0143 Some documentation updates David Bateman <dbateman@free.fr> parents: 7981 diff changeset	275 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	276 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	277 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	278 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	279 example,
bbaa5d7d0143 Some documentation updates David Bateman <dbateman@free.fr> parents: 7981 diff changeset	280
bbaa5d7d0143 Some documentation updates David Bateman <dbateman@free.fr> parents: 7981 diff changeset	281 @example
bbaa5d7d0143 Some documentation updates David Bateman <dbateman@free.fr> parents: 7981 diff changeset	282 @group
bbaa5d7d0143 Some documentation updates David Bateman <dbateman@free.fr> parents: 7981 diff changeset	283 fplot (@@sin, [-10, 10], 201);
bbaa5d7d0143 Some documentation updates David Bateman <dbateman@free.fr> parents: 7981 diff changeset	284 @end group
bbaa5d7d0143 Some documentation updates David Bateman <dbateman@free.fr> parents: 7981 diff changeset	285 @end example
bbaa5d7d0143 Some documentation updates David Bateman <dbateman@free.fr> parents: 7981 diff changeset	286
bbaa5d7d0143 Some documentation updates David Bateman <dbateman@free.fr> parents: 7981 diff changeset	287 @noindent
bbaa5d7d0143 Some documentation updates David Bateman <dbateman@free.fr> parents: 7981 diff changeset	288 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	289 legend displaying the name of the plotted function.
bbaa5d7d0143 Some documentation updates David Bateman <dbateman@free.fr> parents: 7981 diff changeset	290
bbaa5d7d0143 Some documentation updates David Bateman <dbateman@free.fr> parents: 7981 diff changeset	291 @DOCSTRING(fplot)
bbaa5d7d0143 Some documentation updates David Bateman <dbateman@free.fr> parents: 7981 diff changeset	292
bbaa5d7d0143 Some documentation updates David Bateman <dbateman@free.fr> parents: 7981 diff changeset	293 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	294 function include @code{ezplot}, @code{ezcontour}, @code{ezcontourf} and
8046 c4482fc30c7f Add the ezplot function David Bateman <dbateman@free.fr> parents: 7989 diff changeset	295 @code{ezpolar}.
c4482fc30c7f Add the ezplot function David Bateman <dbateman@free.fr> parents: 7989 diff changeset	296
c4482fc30c7f Add the ezplot function David Bateman <dbateman@free.fr> parents: 7989 diff changeset	297 @DOCSTRING(ezplot)
7984 bbaa5d7d0143 Some documentation updates David Bateman <dbateman@free.fr> parents: 7981 diff changeset	298
bbaa5d7d0143 Some documentation updates David Bateman <dbateman@free.fr> parents: 7981 diff changeset	299 @DOCSTRING(ezcontour)
bbaa5d7d0143 Some documentation updates David Bateman <dbateman@free.fr> parents: 7981 diff changeset	300
bbaa5d7d0143 Some documentation updates David Bateman <dbateman@free.fr> parents: 7981 diff changeset	301 @DOCSTRING(ezcontourf)
bbaa5d7d0143 Some documentation updates David Bateman <dbateman@free.fr> parents: 7981 diff changeset	302
bbaa5d7d0143 Some documentation updates David Bateman <dbateman@free.fr> parents: 7981 diff changeset	303 @DOCSTRING(ezpolar)
bbaa5d7d0143 Some documentation updates David Bateman <dbateman@free.fr> parents: 7981 diff changeset	304
12761 13bcd62824a7 doc: Add documentation for gmres, rectangle to manual Rik <octave@nomad.inbox5.com> parents: 12690 diff changeset	305 @node Two-dimensional Geometric Shapes
13bcd62824a7 doc: Add documentation for gmres, rectangle to manual Rik <octave@nomad.inbox5.com> parents: 12690 diff changeset	306 @subsubsection Two-dimensional Geometric Shapes
13bcd62824a7 doc: Add documentation for gmres, rectangle to manual Rik <octave@nomad.inbox5.com> parents: 12690 diff changeset	307
13bcd62824a7 doc: Add documentation for gmres, rectangle to manual Rik <octave@nomad.inbox5.com> parents: 12690 diff changeset	308 @DOCSTRING(rectangle)
13bcd62824a7 doc: Add documentation for gmres, rectangle to manual Rik <octave@nomad.inbox5.com> parents: 12690 diff changeset	309
12526 f8ea3eabcb85 Add daspect, pbaspect functions to documentation. Rik <octave@nomad.inbox5.com> parents: 12525 diff changeset	310 @node Three-Dimensional Plots
f8ea3eabcb85 Add daspect, pbaspect functions to documentation. Rik <octave@nomad.inbox5.com> parents: 12525 diff changeset	311 @subsection Three-Dimensional Plots
18398 200851c87444 Edits to Manual and indicies Michael Godfrey <michaeldgodfrey@gmail.com> parents: 17957 diff changeset	312 @cindex plotting, three-dimensional
6888 b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe] jwe parents: 6877 diff changeset	313
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe] jwe parents: 6877 diff changeset	314 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	315
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe] jwe parents: 6877 diff changeset	316 @example
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe] jwe parents: 6877 diff changeset	317 @group
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe] jwe parents: 6877 diff changeset	318 tx = ty = linspace (-8, 8, 41)';
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe] jwe parents: 6877 diff changeset	319 [xx, yy] = meshgrid (tx, ty);
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe] jwe parents: 6877 diff changeset	320 r = sqrt (xx .^ 2 + yy .^ 2) + eps;
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe] jwe parents: 6877 diff changeset	321 tz = sin (r) ./ r;
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe] jwe parents: 6877 diff changeset	322 mesh (tx, ty, tz);
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe] jwe parents: 6877 diff changeset	323 @end group
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe] jwe parents: 6877 diff changeset	324 @end example
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe] jwe parents: 6877 diff changeset	325
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe] jwe parents: 6877 diff changeset	326 @noindent
6899 110c5782fe3b [project @ 2007-09-14 15:17:53 by jwe] jwe parents: 6892 diff changeset	327 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	328 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	329 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	330 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	331
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe] jwe parents: 6877 diff changeset	332 @float Figure,fig:mesh
9088 77e71f3da3d6 Fix documentation image printing under new development code Rik <rdrider0-list@yahoo.com> parents: 9040 diff changeset	333 @center @image{mesh,4in}
6888 b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe] jwe parents: 6877 diff changeset	334 @caption{Mesh plot.}
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe] jwe parents: 6877 diff changeset	335 @end float
5134 0309b6722ee9 [project @ 2005-02-08 20:17:55 by jwe] jwe parents: 5016 diff changeset	336
6888 b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe] jwe parents: 6877 diff changeset	337 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	338 plot of contours for the surface.
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe] jwe parents: 6877 diff changeset	339
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe] jwe parents: 6877 diff changeset	340 The @code{plot3} function displays arbitrary three-dimensional data,
10828 322f43e0e170 Grammarcheck .txi documentation files. Rik <octave@nomad.inbox5.com> parents: 10711 diff changeset	341 without requiring it to form a surface. For example,
6888 b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe] jwe parents: 6877 diff changeset	342
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe] jwe parents: 6877 diff changeset	343 @example
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe] jwe parents: 6877 diff changeset	344 @group
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe] jwe parents: 6877 diff changeset	345 t = 0:0.1:10*pi;
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe] jwe parents: 6877 diff changeset	346 r = linspace (0, 1, numel (t));
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe] jwe parents: 6877 diff changeset	347 z = linspace (0, 1, numel (t));
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe] jwe parents: 6877 diff changeset	348 plot3 (r.sin(t), r.cos(t), z);
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe] jwe parents: 6877 diff changeset	349 @end group
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe] jwe parents: 6877 diff changeset	350 @end example
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe] jwe parents: 6877 diff changeset	351
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe] jwe parents: 6877 diff changeset	352 @noindent
6899 110c5782fe3b [project @ 2007-09-14 15:17:53 by jwe] jwe parents: 6892 diff changeset	353 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	354
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe] jwe parents: 6877 diff changeset	355 @float Figure,fig:plot3
9088 77e71f3da3d6 Fix documentation image printing under new development code Rik <rdrider0-list@yahoo.com> parents: 9040 diff changeset	356 @center @image{plot3,4in}
10828 322f43e0e170 Grammarcheck .txi documentation files. Rik <octave@nomad.inbox5.com> parents: 10711 diff changeset	357 @caption{Three-dimensional spiral.}
6888 b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe] jwe parents: 6877 diff changeset	358 @end float
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe] jwe parents: 6877 diff changeset	359
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe] jwe parents: 6877 diff changeset	360 Finally, the @code{view} function changes the viewpoint for
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe] jwe parents: 6877 diff changeset	361 three-dimensional plots.
5134 0309b6722ee9 [project @ 2005-02-08 20:17:55 by jwe] jwe parents: 5016 diff changeset	362
0309b6722ee9 [project @ 2005-02-08 20:17:55 by jwe] jwe parents: 5016 diff changeset	363 @DOCSTRING(mesh)
0309b6722ee9 [project @ 2005-02-08 20:17:55 by jwe] jwe parents: 5016 diff changeset	364
6788 c81a0f3f5a82 [project @ 2007-07-23 22:05:29 by dbateman] dbateman parents: 6778 diff changeset	365 @DOCSTRING(meshc)
c81a0f3f5a82 [project @ 2007-07-23 22:05:29 by dbateman] dbateman parents: 6778 diff changeset	366
8817 03b7f618ab3d include docstrings for new functions in the manual John W. Eaton <jwe@octave.org> parents: 8519 diff changeset	367 @DOCSTRING(meshz)
03b7f618ab3d include docstrings for new functions in the manual John W. Eaton <jwe@octave.org> parents: 8519 diff changeset	368
7153 4246642e9f48 [project @ 2007-11-09 21:20:07 by dbateman] dbateman parents: 7120 diff changeset	369 @DOCSTRING(hidden)
4246642e9f48 [project @ 2007-11-09 21:20:07 by dbateman] dbateman parents: 7120 diff changeset	370
7120 a2174fb073d4 [project @ 2007-11-07 21:26:43 by jwe] jwe parents: 7018 diff changeset	371 @DOCSTRING(surf)
a2174fb073d4 [project @ 2007-11-07 21:26:43 by jwe] jwe parents: 7018 diff changeset	372
a2174fb073d4 [project @ 2007-11-07 21:26:43 by jwe] jwe parents: 7018 diff changeset	373 @DOCSTRING(surfc)
a2174fb073d4 [project @ 2007-11-07 21:26:43 by jwe] jwe parents: 7018 diff changeset	374
8817 03b7f618ab3d include docstrings for new functions in the manual John W. Eaton <jwe@octave.org> parents: 8519 diff changeset	375 @DOCSTRING(surfl)
03b7f618ab3d include docstrings for new functions in the manual John W. Eaton <jwe@octave.org> parents: 8519 diff changeset	376
03b7f618ab3d include docstrings for new functions in the manual John W. Eaton <jwe@octave.org> parents: 8519 diff changeset	377 @DOCSTRING(surfnorm)
03b7f618ab3d include docstrings for new functions in the manual John W. Eaton <jwe@octave.org> parents: 8519 diff changeset	378
12529 0579a13f29a1 Add isocolors, isonormals, isosurface functions to documentation. Rik <octave@nomad.inbox5.com> parents: 12526 diff changeset	379 @DOCSTRING(isosurface)
0579a13f29a1 Add isocolors, isonormals, isosurface functions to documentation. Rik <octave@nomad.inbox5.com> parents: 12526 diff changeset	380
0579a13f29a1 Add isocolors, isonormals, isosurface functions to documentation. Rik <octave@nomad.inbox5.com> parents: 12526 diff changeset	381 @DOCSTRING(isonormals)
0579a13f29a1 Add isocolors, isonormals, isosurface functions to documentation. Rik <octave@nomad.inbox5.com> parents: 12526 diff changeset	382
0579a13f29a1 Add isocolors, isonormals, isosurface functions to documentation. Rik <octave@nomad.inbox5.com> parents: 12526 diff changeset	383 @DOCSTRING(isocolors)
0579a13f29a1 Add isocolors, isonormals, isosurface functions to documentation. Rik <octave@nomad.inbox5.com> parents: 12526 diff changeset	384
14574 9546bb28648c New Function, shrinkfaces.m Martin Helm <martin@mhelm.de> parents: 14456 diff changeset	385 @DOCSTRING(shrinkfaces)
9546bb28648c New Function, shrinkfaces.m Martin Helm <martin@mhelm.de> parents: 14456 diff changeset	386
8817 03b7f618ab3d include docstrings for new functions in the manual John W. Eaton <jwe@octave.org> parents: 8519 diff changeset	387 @DOCSTRING(diffuse)
03b7f618ab3d include docstrings for new functions in the manual John W. Eaton <jwe@octave.org> parents: 8519 diff changeset	388
03b7f618ab3d include docstrings for new functions in the manual John W. Eaton <jwe@octave.org> parents: 8519 diff changeset	389 @DOCSTRING(specular)
03b7f618ab3d include docstrings for new functions in the manual John W. Eaton <jwe@octave.org> parents: 8519 diff changeset	390
5134 0309b6722ee9 [project @ 2005-02-08 20:17:55 by jwe] jwe parents: 5016 diff changeset	391 @DOCSTRING(meshgrid)
0309b6722ee9 [project @ 2005-02-08 20:17:55 by jwe] jwe parents: 5016 diff changeset	392
6550 1b7a6061a05d [project @ 2007-04-20 07:40:26 by jwe] jwe parents: 6549 diff changeset	393 @DOCSTRING(ndgrid)
1b7a6061a05d [project @ 2007-04-20 07:40:26 by jwe] jwe parents: 6549 diff changeset	394
6888 b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe] jwe parents: 6877 diff changeset	395 @DOCSTRING(plot3)
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe] jwe parents: 6877 diff changeset	396
6502 6ab0a8767780 [project @ 2007-04-06 03:32:06 by jwe] jwe parents: 6331 diff changeset	397 @DOCSTRING(view)
6ab0a8767780 [project @ 2007-04-06 03:32:06 by jwe] jwe parents: 6331 diff changeset	398
8817 03b7f618ab3d include docstrings for new functions in the manual John W. Eaton <jwe@octave.org> parents: 8519 diff changeset	399 @DOCSTRING(slice)
03b7f618ab3d include docstrings for new functions in the manual John W. Eaton <jwe@octave.org> parents: 8519 diff changeset	400
03b7f618ab3d include docstrings for new functions in the manual John W. Eaton <jwe@octave.org> parents: 8519 diff changeset	401 @DOCSTRING(ribbon)
03b7f618ab3d include docstrings for new functions in the manual John W. Eaton <jwe@octave.org> parents: 8519 diff changeset	402
7120 a2174fb073d4 [project @ 2007-11-07 21:26:43 by jwe] jwe parents: 7018 diff changeset	403 @DOCSTRING(shading)
a2174fb073d4 [project @ 2007-11-07 21:26:43 by jwe] jwe parents: 7018 diff changeset	404
9672 43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	405 @DOCSTRING(scatter3)
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	406
16563 34a9a4e48f9b New function waterfall Mike Miller <mtmiller@ieee.org> parents: 16137 diff changeset	407 @DOCSTRING(waterfall)
34a9a4e48f9b New function waterfall Mike Miller <mtmiller@ieee.org> parents: 16137 diff changeset	408
7989 23c248d415b5 Various doc fixes. Readd cellidx David Bateman <dbateman@free.fr> parents: 7984 diff changeset	409 @menu
12526 f8ea3eabcb85 Add daspect, pbaspect functions to documentation. Rik <octave@nomad.inbox5.com> parents: 12525 diff changeset	410 * Aspect Ratio::
17152 f2a8592b8fbd doc: Shorten some long subsection names in Manual. Rik <rik@octave.org> parents: 17123 diff changeset	411 * Three-dimensional Function Plotting::
f2a8592b8fbd doc: Shorten some long subsection names in Manual. Rik <rik@octave.org> parents: 17123 diff changeset	412 * Three-dimensional Geometric Shapes::
7989 23c248d415b5 Various doc fixes. Readd cellidx David Bateman <dbateman@free.fr> parents: 7984 diff changeset	413 @end menu
23c248d415b5 Various doc fixes. Readd cellidx David Bateman <dbateman@free.fr> parents: 7984 diff changeset	414
12526 f8ea3eabcb85 Add daspect, pbaspect functions to documentation. Rik <octave@nomad.inbox5.com> parents: 12525 diff changeset	415 @node Aspect Ratio
f8ea3eabcb85 Add daspect, pbaspect functions to documentation. Rik <octave@nomad.inbox5.com> parents: 12525 diff changeset	416 @subsubsection Aspect Ratio
f8ea3eabcb85 Add daspect, pbaspect functions to documentation. Rik <octave@nomad.inbox5.com> parents: 12525 diff changeset	417
f8ea3eabcb85 Add daspect, pbaspect functions to documentation. Rik <octave@nomad.inbox5.com> parents: 12525 diff changeset	418 For three-dimensional plots the aspect ratio can be set for data with
17469 710b3d5fe966 improve interpreter tex Tables Michael Godfrey <michaeldgodfrey@gmail.com> parents: 17281 diff changeset	419 @code{daspect} and for the plot box with @code{pbaspect}.
17097 e7a059a9a644 doc: Use XREF as anchor prefix in documentation for clearer results in Info viewer. Rik <rik@octave.org> parents: 16923 diff changeset	420 @xref{Axis Configuration}, for controlling the x-, y-, and z-limits for
12526 f8ea3eabcb85 Add daspect, pbaspect functions to documentation. Rik <octave@nomad.inbox5.com> parents: 12525 diff changeset	421 plotting.
f8ea3eabcb85 Add daspect, pbaspect functions to documentation. Rik <octave@nomad.inbox5.com> parents: 12525 diff changeset	422
f8ea3eabcb85 Add daspect, pbaspect functions to documentation. Rik <octave@nomad.inbox5.com> parents: 12525 diff changeset	423 @DOCSTRING(daspect)
f8ea3eabcb85 Add daspect, pbaspect functions to documentation. Rik <octave@nomad.inbox5.com> parents: 12525 diff changeset	424
f8ea3eabcb85 Add daspect, pbaspect functions to documentation. Rik <octave@nomad.inbox5.com> parents: 12525 diff changeset	425 @DOCSTRING(pbaspect)
f8ea3eabcb85 Add daspect, pbaspect functions to documentation. Rik <octave@nomad.inbox5.com> parents: 12525 diff changeset	426
7989 23c248d415b5 Various doc fixes. Readd cellidx David Bateman <dbateman@free.fr> parents: 7984 diff changeset	427 @node Three-dimensional Function Plotting
23c248d415b5 Various doc fixes. Readd cellidx David Bateman <dbateman@free.fr> parents: 7984 diff changeset	428 @subsubsection Three-dimensional Function Plotting
7984 bbaa5d7d0143 Some documentation updates David Bateman <dbateman@free.fr> parents: 7981 diff changeset	429
bbaa5d7d0143 Some documentation updates David Bateman <dbateman@free.fr> parents: 7981 diff changeset	430 @DOCSTRING(ezplot3)
bbaa5d7d0143 Some documentation updates David Bateman <dbateman@free.fr> parents: 7981 diff changeset	431
bbaa5d7d0143 Some documentation updates David Bateman <dbateman@free.fr> parents: 7981 diff changeset	432 @DOCSTRING(ezmesh)
bbaa5d7d0143 Some documentation updates David Bateman <dbateman@free.fr> parents: 7981 diff changeset	433
bbaa5d7d0143 Some documentation updates David Bateman <dbateman@free.fr> parents: 7981 diff changeset	434 @DOCSTRING(ezmeshc)
bbaa5d7d0143 Some documentation updates David Bateman <dbateman@free.fr> parents: 7981 diff changeset	435
bbaa5d7d0143 Some documentation updates David Bateman <dbateman@free.fr> parents: 7981 diff changeset	436 @DOCSTRING(ezsurf)
bbaa5d7d0143 Some documentation updates David Bateman <dbateman@free.fr> parents: 7981 diff changeset	437
bbaa5d7d0143 Some documentation updates David Bateman <dbateman@free.fr> parents: 7981 diff changeset	438 @DOCSTRING(ezsurfc)
bbaa5d7d0143 Some documentation updates David Bateman <dbateman@free.fr> parents: 7981 diff changeset	439
8817 03b7f618ab3d include docstrings for new functions in the manual John W. Eaton <jwe@octave.org> parents: 8519 diff changeset	440 @node Three-dimensional Geometric Shapes
03b7f618ab3d include docstrings for new functions in the manual John W. Eaton <jwe@octave.org> parents: 8519 diff changeset	441 @subsubsection Three-dimensional Geometric Shapes
03b7f618ab3d include docstrings for new functions in the manual John W. Eaton <jwe@octave.org> parents: 8519 diff changeset	442
03b7f618ab3d include docstrings for new functions in the manual John W. Eaton <jwe@octave.org> parents: 8519 diff changeset	443 @DOCSTRING(cylinder)
03b7f618ab3d include docstrings for new functions in the manual John W. Eaton <jwe@octave.org> parents: 8519 diff changeset	444
03b7f618ab3d include docstrings for new functions in the manual John W. Eaton <jwe@octave.org> parents: 8519 diff changeset	445 @DOCSTRING(sphere)
03b7f618ab3d include docstrings for new functions in the manual John W. Eaton <jwe@octave.org> parents: 8519 diff changeset	446
03b7f618ab3d include docstrings for new functions in the manual John W. Eaton <jwe@octave.org> parents: 8519 diff changeset	447 @DOCSTRING(ellipsoid)
03b7f618ab3d include docstrings for new functions in the manual John W. Eaton <jwe@octave.org> parents: 8519 diff changeset	448
6888 b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe] jwe parents: 6877 diff changeset	449 @node Plot Annotations
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe] jwe parents: 6877 diff changeset	450 @subsection Plot Annotations
6502 6ab0a8767780 [project @ 2007-04-06 03:32:06 by jwe] jwe parents: 6331 diff changeset	451
6888 b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe] jwe parents: 6877 diff changeset	452 You can add titles, axis labels, legends, and arbitrary text to an
10828 322f43e0e170 Grammarcheck .txi documentation files. Rik <octave@nomad.inbox5.com> parents: 10711 diff changeset	453 existing plot. For example:
6877 ab11bdb09820 [project @ 2007-09-07 05:12:32 by jwe] jwe parents: 6788 diff changeset	454
6888 b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe] jwe parents: 6877 diff changeset	455 @example
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe] jwe parents: 6877 diff changeset	456 @group
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe] jwe parents: 6877 diff changeset	457 x = -10:0.1:10;
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe] jwe parents: 6877 diff changeset	458 plot (x, sin (x));
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe] jwe parents: 6877 diff changeset	459 title ("sin(x) for x = -10:0.1:10");
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe] jwe parents: 6877 diff changeset	460 xlabel ("x");
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe] jwe parents: 6877 diff changeset	461 ylabel ("sin (x)");
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe] jwe parents: 6877 diff changeset	462 text (pi, 0.7, "arbitrary text");
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe] jwe parents: 6877 diff changeset	463 legend ("sin (x)");
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe] jwe parents: 6877 diff changeset	464 @end group
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe] jwe parents: 6877 diff changeset	465 @end example
6502 6ab0a8767780 [project @ 2007-04-06 03:32:06 by jwe] jwe parents: 6331 diff changeset	466
6888 b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe] jwe parents: 6877 diff changeset	467 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	468 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	469 border lines are on.
5134 0309b6722ee9 [project @ 2005-02-08 20:17:55 by jwe] jwe parents: 5016 diff changeset	470
20000 ca7599ae464d doc: Grammarcheck documentation ahead of 4.0 release. Rik <rik@octave.org> parents: 19982 diff changeset	471 Finally, arrows, text and rectangular or elliptic boxes can be added to
ca7599ae464d doc: Grammarcheck documentation ahead of 4.0 release. Rik <rik@octave.org> parents: 19982 diff changeset	472 highlight parts of a plot using the @code{annotation} function. Those objects
ca7599ae464d doc: Grammarcheck documentation ahead of 4.0 release. Rik <rik@octave.org> parents: 19982 diff changeset	473 are drawn in an invisible axes, on top of every other axes.
19946 b8e4104a8f55 Add the annotation function (bug #43282) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 19898 diff changeset	474
5134 0309b6722ee9 [project @ 2005-02-08 20:17:55 by jwe] jwe parents: 5016 diff changeset	475 @DOCSTRING(title)
0309b6722ee9 [project @ 2005-02-08 20:17:55 by jwe] jwe parents: 5016 diff changeset	476
6502 6ab0a8767780 [project @ 2007-04-06 03:32:06 by jwe] jwe parents: 6331 diff changeset	477 @DOCSTRING(legend)
6ab0a8767780 [project @ 2007-04-06 03:32:06 by jwe] jwe parents: 6331 diff changeset	478
6ab0a8767780 [project @ 2007-04-06 03:32:06 by jwe] jwe parents: 6331 diff changeset	479 @DOCSTRING(text)
6ab0a8767780 [project @ 2007-04-06 03:32:06 by jwe] jwe parents: 6331 diff changeset	480
8428 ee1bc8aa226b Add cross reference from Plot Annotations to Text Properties. Francesco PotortÃ¬ <pot@gnu.org> parents: 8347 diff changeset	481 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	482
17097 e7a059a9a644 doc: Use XREF as anchor prefix in documentation for clearer results in Info viewer. Rik <rik@octave.org> parents: 16923 diff changeset	483 @anchor{XREFylabel}
e7a059a9a644 doc: Use XREF as anchor prefix in documentation for clearer results in Info viewer. Rik <rik@octave.org> parents: 16923 diff changeset	484 @anchor{XREFzlabel}
5134 0309b6722ee9 [project @ 2005-02-08 20:17:55 by jwe] jwe parents: 5016 diff changeset	485 @DOCSTRING(xlabel)
0309b6722ee9 [project @ 2005-02-08 20:17:55 by jwe] jwe parents: 5016 diff changeset	486
8817 03b7f618ab3d include docstrings for new functions in the manual John W. Eaton <jwe@octave.org> parents: 8519 diff changeset	487 @DOCSTRING(clabel)
03b7f618ab3d include docstrings for new functions in the manual John W. Eaton <jwe@octave.org> parents: 8519 diff changeset	488
6502 6ab0a8767780 [project @ 2007-04-06 03:32:06 by jwe] jwe parents: 6331 diff changeset	489 @DOCSTRING(box)
6ab0a8767780 [project @ 2007-04-06 03:32:06 by jwe] jwe parents: 6331 diff changeset	490
6ab0a8767780 [project @ 2007-04-06 03:32:06 by jwe] jwe parents: 6331 diff changeset	491 @DOCSTRING(grid)
6ab0a8767780 [project @ 2007-04-06 03:32:06 by jwe] jwe parents: 6331 diff changeset	492
8089 0ec09255515a add colorbar docstring to the manual John W. Eaton <jwe@octave.org> parents: 8073 diff changeset	493 @DOCSTRING(colorbar)
0ec09255515a add colorbar docstring to the manual John W. Eaton <jwe@octave.org> parents: 8073 diff changeset	494
19946 b8e4104a8f55 Add the annotation function (bug #43282) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 19898 diff changeset	495 @DOCSTRING(annotation)
b8e4104a8f55 Add the annotation function (bug #43282) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 19898 diff changeset	496
5134 0309b6722ee9 [project @ 2005-02-08 20:17:55 by jwe] jwe parents: 5016 diff changeset	497 @node Multiple Plots on One Page
6888 b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe] jwe parents: 6877 diff changeset	498 @subsection Multiple Plots on One Page
18398 200851c87444 Edits to Manual and indicies Michael Godfrey <michaeldgodfrey@gmail.com> parents: 17957 diff changeset	499 @cindex plotting, multiple plots per figure
6888 b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe] jwe parents: 6877 diff changeset	500
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe] jwe parents: 6877 diff changeset	501 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	502 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	503 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	504 For example,
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe] jwe parents: 6877 diff changeset	505
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe] jwe parents: 6877 diff changeset	506 @example
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe] jwe parents: 6877 diff changeset	507 @group
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe] jwe parents: 6877 diff changeset	508 subplot (2, 1, 1)
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe] jwe parents: 6877 diff changeset	509 fplot (@@sin, [-10, 10]);
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe] jwe parents: 6877 diff changeset	510 subplot (2, 1, 2)
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe] jwe parents: 6877 diff changeset	511 fplot (@@cos, [-10, 10]);
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe] jwe parents: 6877 diff changeset	512 @end group
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe] jwe parents: 6877 diff changeset	513 @end example
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe] jwe parents: 6877 diff changeset	514
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe] jwe parents: 6877 diff changeset	515 @noindent
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe] jwe parents: 6877 diff changeset	516 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	517 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	518 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	519 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	520 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	521
0309b6722ee9 [project @ 2005-02-08 20:17:55 by jwe] jwe parents: 5016 diff changeset	522 @DOCSTRING(subplot)
0309b6722ee9 [project @ 2005-02-08 20:17:55 by jwe] jwe parents: 5016 diff changeset	523
0309b6722ee9 [project @ 2005-02-08 20:17:55 by jwe] jwe parents: 5016 diff changeset	524 @node Multiple Plot Windows
6888 b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe] jwe parents: 6877 diff changeset	525 @subsection Multiple Plot Windows
18398 200851c87444 Edits to Manual and indicies Michael Godfrey <michaeldgodfrey@gmail.com> parents: 17957 diff changeset	526 @cindex plotting, multiple plot windows
6888 b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe] jwe parents: 6877 diff changeset	527
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe] jwe parents: 6877 diff changeset	528 You can open multiple plot windows using the @code{figure} function.
10828 322f43e0e170 Grammarcheck .txi documentation files. Rik <octave@nomad.inbox5.com> parents: 10711 diff changeset	529 For example,
6888 b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe] jwe parents: 6877 diff changeset	530
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe] jwe parents: 6877 diff changeset	531 @example
9088 77e71f3da3d6 Fix documentation image printing under new development code Rik <rdrider0-list@yahoo.com> parents: 9040 diff changeset	532 @group
6888 b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe] jwe parents: 6877 diff changeset	533 figure (1);
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe] jwe parents: 6877 diff changeset	534 fplot (@@sin, [-10, 10]);
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe] jwe parents: 6877 diff changeset	535 figure (2);
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe] jwe parents: 6877 diff changeset	536 fplot (@@cos, [-10, 10]);
9088 77e71f3da3d6 Fix documentation image printing under new development code Rik <rdrider0-list@yahoo.com> parents: 9040 diff changeset	537 @end group
6888 b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe] jwe parents: 6877 diff changeset	538 @end example
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe] jwe parents: 6877 diff changeset	539
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe] jwe parents: 6877 diff changeset	540 @noindent
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe] jwe parents: 6877 diff changeset	541 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	542 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	543
0309b6722ee9 [project @ 2005-02-08 20:17:55 by jwe] jwe parents: 5016 diff changeset	544 @DOCSTRING(figure)
16096 9720ecf8d257 Fix additional warning associated with Texinfo 5.0 (bug #38392) Rik <rik@octave.org> parents: 16094 diff changeset	545
19273 d59d052c9858 rotate.m: new function John W. Eaton <jwe@octave.org> parents: 19270 diff changeset	546 @node Manipulation of Plot Objects
d59d052c9858 rotate.m: new function John W. Eaton <jwe@octave.org> parents: 19270 diff changeset	547 @subsection Manipulation of Plot Objects
d59d052c9858 rotate.m: new function John W. Eaton <jwe@octave.org> parents: 19270 diff changeset	548 @cindex plotting, object manipulation
d59d052c9858 rotate.m: new function John W. Eaton <jwe@octave.org> parents: 19270 diff changeset	549
19282 4e5fae88065f add pan docstring to the manual John W. Eaton <jwe@octave.org> parents: 19281 diff changeset	550 @DOCSTRING(pan)
4e5fae88065f add pan docstring to the manual John W. Eaton <jwe@octave.org> parents: 19281 diff changeset	551
19273 d59d052c9858 rotate.m: new function John W. Eaton <jwe@octave.org> parents: 19270 diff changeset	552 @DOCSTRING(rotate)
d59d052c9858 rotate.m: new function John W. Eaton <jwe@octave.org> parents: 19270 diff changeset	553
19280 99aec089e8c3 add rotate3d docstring to the manual John W. Eaton <jwe@octave.org> parents: 19273 diff changeset	554 @DOCSTRING(rotate3d)
99aec089e8c3 add rotate3d docstring to the manual John W. Eaton <jwe@octave.org> parents: 19273 diff changeset	555
19281 8a6f87637c16 hg new function, zoom John W. Eaton <jwe@octave.org> parents: 19280 diff changeset	556 @DOCSTRING(zoom)
8a6f87637c16 hg new function, zoom John W. Eaton <jwe@octave.org> parents: 19280 diff changeset	557
16096 9720ecf8d257 Fix additional warning associated with Texinfo 5.0 (bug #38392) Rik <rik@octave.org> parents: 16094 diff changeset	558 @node Manipulation of Plot Windows
9720ecf8d257 Fix additional warning associated with Texinfo 5.0 (bug #38392) Rik <rik@octave.org> parents: 16094 diff changeset	559 @subsection Manipulation of Plot Windows
18398 200851c87444 Edits to Manual and indicies Michael Godfrey <michaeldgodfrey@gmail.com> parents: 17957 diff changeset	560 @cindex plotting, window manipulation
9672 43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	561
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	562 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	563 or when waiting for input. The
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	564 @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	565
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	566 @DOCSTRING(drawnow)
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	567
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	568 Only figures that are modified will be updated. The @code{refresh}
19449 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 19344 diff changeset	569 function can also be used to cause an update of the current figure, even if
9672 43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	570 it is not modified.
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	571
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	572 @DOCSTRING(refresh)
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	573
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	574 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	575 @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	576 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	577 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	578 function. 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 @group
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	582 hold on;
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	583 x = -10:0.1:10;
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	584 plot (x, sin (x));
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	585 plot (x, cos (x));
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	586 hold off;
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	587 @end group
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	588 @end example
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 @noindent
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	591 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	592 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	593 plot.
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	594
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	595 @DOCSTRING(newplot)
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	596
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	597 @DOCSTRING(hold)
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	598
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	599 @DOCSTRING(ishold)
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	600 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	601 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	602 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	603 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	604 figure window, call the @code{close} function.
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	605
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	606 @DOCSTRING(clf)
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	607
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	608 @DOCSTRING(cla)
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	609
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	610 @DOCSTRING(shg)
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	611
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	612 @DOCSTRING(delete)
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	613
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	614 @DOCSTRING(close)
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	615
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	616 @DOCSTRING(closereq)
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	617
16096 9720ecf8d257 Fix additional warning associated with Texinfo 5.0 (bug #38392) Rik <rik@octave.org> parents: 16094 diff changeset	618 @node Use of the @code{interpreter} Property
20495 6db2ea5556a4 Make use of the axes "ticklabelinterpreter" property (bug #45438) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 20000 diff changeset	619 @anchor{XREFinterpreterusage}
9672 43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	620 @subsection Use of the @code{interpreter} Property
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	621
19034 77d5e7661b8e doc: Update wording on using TeX interpreter in plotting. Rik <rik@octave.org> parents: 18398 diff changeset	622 All text objects---such as titles, labels, legends, and text---include
19203 c4ffcc961f3c Document that "tex" interpreter only works with gnuplot for printing (bug #42340). Rik <rik@octave.org> parents: 19034 diff changeset	623 the property @qcode{"interpreter"} that determines the manner in
c4ffcc961f3c Document that "tex" interpreter only works with gnuplot for printing (bug #42340). Rik <rik@octave.org> parents: 19034 diff changeset	624 which special control sequences in the text are rendered.
c4ffcc961f3c Document that "tex" interpreter only works with gnuplot for printing (bug #42340). Rik <rik@octave.org> parents: 19034 diff changeset	625
c4ffcc961f3c Document that "tex" interpreter only works with gnuplot for printing (bug #42340). Rik <rik@octave.org> parents: 19034 diff changeset	626 The interpreter property can take three values: @qcode{"none"}, @qcode{"tex"},
c4ffcc961f3c Document that "tex" interpreter only works with gnuplot for printing (bug #42340). Rik <rik@octave.org> parents: 19034 diff changeset	627 @qcode{"latex"}. If the interpreter is set to @qcode{"none"} then no special
c4ffcc961f3c Document that "tex" interpreter only works with gnuplot for printing (bug #42340). Rik <rik@octave.org> parents: 19034 diff changeset	628 rendering occurs---the displayed text is a verbatim copy of the specified text.
c4ffcc961f3c Document that "tex" interpreter only works with gnuplot for printing (bug #42340). Rik <rik@octave.org> parents: 19034 diff changeset	629 Currently, the @qcode{"latex"} interpreter is not implemented and is equivalent
c4ffcc961f3c Document that "tex" interpreter only works with gnuplot for printing (bug #42340). Rik <rik@octave.org> parents: 19034 diff changeset	630 to @qcode{"none"}.
19034 77d5e7661b8e doc: Update wording on using TeX interpreter in plotting. Rik <rik@octave.org> parents: 18398 diff changeset	631
77d5e7661b8e doc: Update wording on using TeX interpreter in plotting. Rik <rik@octave.org> parents: 18398 diff changeset	632 The @qcode{"tex"} option implements a subset of @TeX{} functionality when
77d5e7661b8e doc: Update wording on using TeX interpreter in plotting. Rik <rik@octave.org> parents: 18398 diff changeset	633 rendering text. This allows the insertion of special glyphs such as Greek
19203 c4ffcc961f3c Document that "tex" interpreter only works with gnuplot for printing (bug #42340). Rik <rik@octave.org> parents: 19034 diff changeset	634 characters or mathematical symbols. The special characters are inserted with a
c4ffcc961f3c Document that "tex" interpreter only works with gnuplot for printing (bug #42340). Rik <rik@octave.org> parents: 19034 diff changeset	635 code following a backslash (\) character, as shown in @ref{tab:extended}.
c4ffcc961f3c Document that "tex" interpreter only works with gnuplot for printing (bug #42340). Rik <rik@octave.org> parents: 19034 diff changeset	636
c4ffcc961f3c Document that "tex" interpreter only works with gnuplot for printing (bug #42340). Rik <rik@octave.org> parents: 19034 diff changeset	637 Note that for on-screen display the interpreter property is honored by all
c4ffcc961f3c Document that "tex" interpreter only works with gnuplot for printing (bug #42340). Rik <rik@octave.org> parents: 19034 diff changeset	638 graphics toolkits. However for printing, @strong{only} the @qcode{"gnuplot"}
c4ffcc961f3c Document that "tex" interpreter only works with gnuplot for printing (bug #42340). Rik <rik@octave.org> parents: 19034 diff changeset	639 toolkit renders @TeX{} instructions.
c4ffcc961f3c Document that "tex" interpreter only works with gnuplot for printing (bug #42340). Rik <rik@octave.org> parents: 19034 diff changeset	640
c4ffcc961f3c Document that "tex" interpreter only works with gnuplot for printing (bug #42340). Rik <rik@octave.org> parents: 19034 diff changeset	641 Besides special glyphs, the formatting of text can be changed within the
c4ffcc961f3c Document that "tex" interpreter only works with gnuplot for printing (bug #42340). Rik <rik@octave.org> parents: 19034 diff changeset	642 string by using the codes
9672 43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	643
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	644 @multitable @columnfractions .2 .2 .6 .2
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	645 @item @tab \bf @tab Bold font @tab
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	646 @item @tab \it @tab Italic font @tab
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	647 @item @tab \sl @tab Oblique Font @tab
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	648 @item @tab \rm @tab Normal font @tab
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	649 @end multitable
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	650
19203 c4ffcc961f3c Document that "tex" interpreter only works with gnuplot for printing (bug #42340). Rik <rik@octave.org> parents: 19034 diff changeset	651 These codes may be used in conjunction with the @{ and @} characters to limit
c4ffcc961f3c Document that "tex" interpreter only works with gnuplot for printing (bug #42340). Rik <rik@octave.org> parents: 19034 diff changeset	652 the change to just a part of the string. For example,
9672 43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	653
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	654 @example
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	655 xlabel ('@{\bf H@} = a @{\bf V@}')
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	656 @end example
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	657
10846 a4f482e66b65 Grammarcheck more of the documentation. Rik <octave@nomad.inbox5.com> parents: 10828 diff changeset	658 @noindent
17281 bc924baa2c4e doc: Add new @qcode macro for code samples which are quoted. Rik <rik@octave.org> parents: 17170 diff changeset	659 where the character @qcode{'a'} will not appear in a bold font. Note that to
9672 43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	660 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	661 the strings should be in single quotes.
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	662
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	663 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	664
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	665 @multitable @columnfractions .1 .4 .6 .1
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	666 @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	667 @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	668 use @tab
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	669 @end multitable
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	670
19034 77d5e7661b8e doc: Update wording on using TeX interpreter in plotting. Rik <rik@octave.org> parents: 18398 diff changeset	671 Finally, superscripting and subscripting can be controlled with the @qcode{'^'}
17281 bc924baa2c4e doc: Add new @qcode macro for code samples which are quoted. Rik <rik@octave.org> parents: 17170 diff changeset	672 and @qcode{'_'} characters. If the @qcode{'^'} or @qcode{'_'} is followed by a
bc924baa2c4e doc: Add new @qcode macro for code samples which are quoted. Rik <rik@octave.org> parents: 17170 diff changeset	673 @{ character, then all of the block surrounded by the @{ @} pair is super- or
bc924baa2c4e doc: Add new @qcode macro for code samples which are quoted. Rik <rik@octave.org> parents: 17170 diff changeset	674 sub-scripted. Without the @{ @} pair, only the character immediately following
bc924baa2c4e doc: Add new @qcode macro for code samples which are quoted. Rik <rik@octave.org> parents: 17170 diff changeset	675 the @qcode{'^'} or @qcode{'_'} is super- or sub-scripted.
9672 43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	676
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	677 @float Table,tab:extended
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	678 @tex
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	679 \vskip 6pt
17521 3670ce8da1a0 doc: improve format of table 15.1 for TeX characters. Michael Godfrey <michaeldgodfrey@gmail.com> parents: 17469 diff changeset	680 \newdimen\cola \cola=78pt
3670ce8da1a0 doc: improve format of table 15.1 for TeX characters. Michael Godfrey <michaeldgodfrey@gmail.com> parents: 17469 diff changeset	681 \newdimen\colb \colb=78pt
3670ce8da1a0 doc: improve format of table 15.1 for TeX characters. Michael Godfrey <michaeldgodfrey@gmail.com> parents: 17469 diff changeset	682 \newdimen\colc \colc=78pt
3670ce8da1a0 doc: improve format of table 15.1 for TeX characters. Michael Godfrey <michaeldgodfrey@gmail.com> parents: 17469 diff changeset	683 \def\symtable#1#2#3{
3670ce8da1a0 doc: improve format of table 15.1 for TeX characters. Michael Godfrey <michaeldgodfrey@gmail.com> parents: 17469 diff changeset	684 \hbox to \hsize {\hfill\vbox{\offinterlineskip \tabskip=0pt
17469 710b3d5fe966 improve interpreter tex Tables Michael Godfrey <michaeldgodfrey@gmail.com> parents: 17281 diff changeset	685 \hskip36pt #1
710b3d5fe966 improve interpreter tex Tables Michael Godfrey <michaeldgodfrey@gmail.com> parents: 17281 diff changeset	686 \vskip6pt
9672 43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	687 \halign{
17469 710b3d5fe966 improve interpreter tex Tables Michael Godfrey <michaeldgodfrey@gmail.com> parents: 17281 diff changeset	688 \vrule height2.0ex depth1.ex width 0.6pt #2\tabskip=0.3em &
710b3d5fe966 improve interpreter tex Tables Michael Godfrey <michaeldgodfrey@gmail.com> parents: 17281 diff changeset	689 #2 \hfil & \vrule #2 & #2 \hfil & #2 \vrule &
710b3d5fe966 improve interpreter tex Tables Michael Godfrey <michaeldgodfrey@gmail.com> parents: 17281 diff changeset	690 #2 \hfil & \vrule #2 & #2 \hfil & #2 \vrule &
710b3d5fe966 improve interpreter tex Tables Michael Godfrey <michaeldgodfrey@gmail.com> parents: 17281 diff changeset	691 #2 \hfil & \vrule #2 & #2 \hfil & #2 \vrule
9672 43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	692 width 0.6pt \tabskip=0pt\cr
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	693 \noalign{\hrule height 0.6pt}
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	694 & Code && Sym && Code && Sym && Code && Sym &\cr
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	695 \noalign{\hrule}
17469 710b3d5fe966 improve interpreter tex Tables Michael Godfrey <michaeldgodfrey@gmail.com> parents: 17281 diff changeset	696 #3
9672 43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	697 \noalign{\hrule height 0.6pt}
17469 710b3d5fe966 improve interpreter tex Tables Michael Godfrey <michaeldgodfrey@gmail.com> parents: 17281 diff changeset	698 }
710b3d5fe966 improve interpreter tex Tables Michael Godfrey <michaeldgodfrey@gmail.com> parents: 17281 diff changeset	699 }\hfill}}
17521 3670ce8da1a0 doc: improve format of table 15.1 for TeX characters. Michael Godfrey <michaeldgodfrey@gmail.com> parents: 17469 diff changeset	700 \hoffset72pt
17469 710b3d5fe966 improve interpreter tex Tables Michael Godfrey <michaeldgodfrey@gmail.com> parents: 17281 diff changeset	701 \symtable{Greek Lowercase Letters} {#}
17521 3670ce8da1a0 doc: improve format of table 15.1 for TeX characters. Michael Godfrey <michaeldgodfrey@gmail.com> parents: 17469 diff changeset	702 {& \hbox to \cola{$\backslash$alpha } && $\alpha$
3670ce8da1a0 doc: improve format of table 15.1 for TeX characters. Michael Godfrey <michaeldgodfrey@gmail.com> parents: 17469 diff changeset	703 && \hbox to \colb{$\backslash$beta } && $\beta$
3670ce8da1a0 doc: improve format of table 15.1 for TeX characters. Michael Godfrey <michaeldgodfrey@gmail.com> parents: 17469 diff changeset	704 && \hbox to \colc{$\backslash$gamma} && $\gamma$ &\cr
17469 710b3d5fe966 improve interpreter tex Tables Michael Godfrey <michaeldgodfrey@gmail.com> parents: 17281 diff changeset	705 & $\backslash$delta && $\delta$
710b3d5fe966 improve interpreter tex Tables Michael Godfrey <michaeldgodfrey@gmail.com> parents: 17281 diff changeset	706 && $\backslash$epsilon && $\epsilon$
710b3d5fe966 improve interpreter tex Tables Michael Godfrey <michaeldgodfrey@gmail.com> parents: 17281 diff changeset	707 && $\backslash$zeta && $\zeta$ &\cr
710b3d5fe966 improve interpreter tex Tables Michael Godfrey <michaeldgodfrey@gmail.com> parents: 17281 diff changeset	708 & $\backslash$eta && $\eta$
710b3d5fe966 improve interpreter tex Tables Michael Godfrey <michaeldgodfrey@gmail.com> parents: 17281 diff changeset	709 && $\backslash$theta && $\theta$
710b3d5fe966 improve interpreter tex Tables Michael Godfrey <michaeldgodfrey@gmail.com> parents: 17281 diff changeset	710 && $\backslash$vartheta && $\vartheta$ &\cr
710b3d5fe966 improve interpreter tex Tables Michael Godfrey <michaeldgodfrey@gmail.com> parents: 17281 diff changeset	711 & $\backslash$iota && $\iota$
710b3d5fe966 improve interpreter tex Tables Michael Godfrey <michaeldgodfrey@gmail.com> parents: 17281 diff changeset	712 && $\backslash$kappa && $\kappa$
710b3d5fe966 improve interpreter tex Tables Michael Godfrey <michaeldgodfrey@gmail.com> parents: 17281 diff changeset	713 && $\backslash$lambda && $\lambda$ &\cr
710b3d5fe966 improve interpreter tex Tables Michael Godfrey <michaeldgodfrey@gmail.com> parents: 17281 diff changeset	714 & $\backslash$mu && $\mu$
710b3d5fe966 improve interpreter tex Tables Michael Godfrey <michaeldgodfrey@gmail.com> parents: 17281 diff changeset	715 && $\backslash$nu && $\nu$
710b3d5fe966 improve interpreter tex Tables Michael Godfrey <michaeldgodfrey@gmail.com> parents: 17281 diff changeset	716 && $\backslash$xi && $\xi$ &\cr
710b3d5fe966 improve interpreter tex Tables Michael Godfrey <michaeldgodfrey@gmail.com> parents: 17281 diff changeset	717 & $\backslash$o && $o$
710b3d5fe966 improve interpreter tex Tables Michael Godfrey <michaeldgodfrey@gmail.com> parents: 17281 diff changeset	718 && $\backslash$pi && $\pi$
710b3d5fe966 improve interpreter tex Tables Michael Godfrey <michaeldgodfrey@gmail.com> parents: 17281 diff changeset	719 && $\backslash$varpi && $\varpi$ &\cr
710b3d5fe966 improve interpreter tex Tables Michael Godfrey <michaeldgodfrey@gmail.com> parents: 17281 diff changeset	720 & $\backslash$rho && $\rho$
710b3d5fe966 improve interpreter tex Tables Michael Godfrey <michaeldgodfrey@gmail.com> parents: 17281 diff changeset	721 && $\backslash$sigma && $\sigma$
710b3d5fe966 improve interpreter tex Tables Michael Godfrey <michaeldgodfrey@gmail.com> parents: 17281 diff changeset	722 && $\backslash$varsigma && $\varsigma$ &\cr
710b3d5fe966 improve interpreter tex Tables Michael Godfrey <michaeldgodfrey@gmail.com> parents: 17281 diff changeset	723 & $\backslash$tau && $\tau$
710b3d5fe966 improve interpreter tex Tables Michael Godfrey <michaeldgodfrey@gmail.com> parents: 17281 diff changeset	724 && $\backslash$upsilon && $\upsilon$
710b3d5fe966 improve interpreter tex Tables Michael Godfrey <michaeldgodfrey@gmail.com> parents: 17281 diff changeset	725 && $\backslash$phi && $\phi$ &\cr
710b3d5fe966 improve interpreter tex Tables Michael Godfrey <michaeldgodfrey@gmail.com> parents: 17281 diff changeset	726 & $\backslash$chi && $\chi$
710b3d5fe966 improve interpreter tex Tables Michael Godfrey <michaeldgodfrey@gmail.com> parents: 17281 diff changeset	727 && $\backslash$psi && $\psi$
710b3d5fe966 improve interpreter tex Tables Michael Godfrey <michaeldgodfrey@gmail.com> parents: 17281 diff changeset	728 && $\backslash$omega && $\omega$ &\cr}
710b3d5fe966 improve interpreter tex Tables Michael Godfrey <michaeldgodfrey@gmail.com> parents: 17281 diff changeset	729 \vskip12pt
710b3d5fe966 improve interpreter tex Tables Michael Godfrey <michaeldgodfrey@gmail.com> parents: 17281 diff changeset	730 \symtable{Greek Uppercase Letters} {#}
17521 3670ce8da1a0 doc: improve format of table 15.1 for TeX characters. Michael Godfrey <michaeldgodfrey@gmail.com> parents: 17469 diff changeset	731 {& \hbox to \cola{$\backslash$Gamma} && $\Gamma$
3670ce8da1a0 doc: improve format of table 15.1 for TeX characters. Michael Godfrey <michaeldgodfrey@gmail.com> parents: 17469 diff changeset	732 && \hbox to \colb{$\backslash$Delta} && $\Delta$
3670ce8da1a0 doc: improve format of table 15.1 for TeX characters. Michael Godfrey <michaeldgodfrey@gmail.com> parents: 17469 diff changeset	733 && \hbox to \colc{$\backslash$Theta} && $\Theta$ &\cr
17469 710b3d5fe966 improve interpreter tex Tables Michael Godfrey <michaeldgodfrey@gmail.com> parents: 17281 diff changeset	734 & $\backslash$Lambda && $\Lambda$
710b3d5fe966 improve interpreter tex Tables Michael Godfrey <michaeldgodfrey@gmail.com> parents: 17281 diff changeset	735 && $\backslash$Xi && $\Xi$
710b3d5fe966 improve interpreter tex Tables Michael Godfrey <michaeldgodfrey@gmail.com> parents: 17281 diff changeset	736 && $\backslash$Pi && $\Pi$ &\cr
710b3d5fe966 improve interpreter tex Tables Michael Godfrey <michaeldgodfrey@gmail.com> parents: 17281 diff changeset	737 & $\backslash$Sigma && $\Sigma$
710b3d5fe966 improve interpreter tex Tables Michael Godfrey <michaeldgodfrey@gmail.com> parents: 17281 diff changeset	738 && $\backslash$Upsilon && $\Upsilon$
710b3d5fe966 improve interpreter tex Tables Michael Godfrey <michaeldgodfrey@gmail.com> parents: 17281 diff changeset	739 && $\backslash$Phi && $\Phi$ &\cr
710b3d5fe966 improve interpreter tex Tables Michael Godfrey <michaeldgodfrey@gmail.com> parents: 17281 diff changeset	740 & $\backslash$Psi && $\Psi$
710b3d5fe966 improve interpreter tex Tables Michael Godfrey <michaeldgodfrey@gmail.com> parents: 17281 diff changeset	741 && $\backslash$Omega && $\Omega$
710b3d5fe966 improve interpreter tex Tables Michael Godfrey <michaeldgodfrey@gmail.com> parents: 17281 diff changeset	742 && && &\cr}
710b3d5fe966 improve interpreter tex Tables Michael Godfrey <michaeldgodfrey@gmail.com> parents: 17281 diff changeset	743 \vskip12pt
710b3d5fe966 improve interpreter tex Tables Michael Godfrey <michaeldgodfrey@gmail.com> parents: 17281 diff changeset	744 \symtable{Misc Symbols Type Ord} {#}
17521 3670ce8da1a0 doc: improve format of table 15.1 for TeX characters. Michael Godfrey <michaeldgodfrey@gmail.com> parents: 17469 diff changeset	745 {& \hbox to \cola{$\backslash$aleph} && $\aleph$
3670ce8da1a0 doc: improve format of table 15.1 for TeX characters. Michael Godfrey <michaeldgodfrey@gmail.com> parents: 17469 diff changeset	746 && \hbox to \colb{$\backslash$wp} && $\wp$
3670ce8da1a0 doc: improve format of table 15.1 for TeX characters. Michael Godfrey <michaeldgodfrey@gmail.com> parents: 17469 diff changeset	747 && \hbox to \colc{$\backslash$Re} && $\Re$ &\cr
17469 710b3d5fe966 improve interpreter tex Tables Michael Godfrey <michaeldgodfrey@gmail.com> parents: 17281 diff changeset	748 & $\backslash$Im && $\Im$
710b3d5fe966 improve interpreter tex Tables Michael Godfrey <michaeldgodfrey@gmail.com> parents: 17281 diff changeset	749 && $\backslash$partial && $\partial$
710b3d5fe966 improve interpreter tex Tables Michael Godfrey <michaeldgodfrey@gmail.com> parents: 17281 diff changeset	750 && $\backslash$infty && $\infty$ &\cr
710b3d5fe966 improve interpreter tex Tables Michael Godfrey <michaeldgodfrey@gmail.com> parents: 17281 diff changeset	751 & $\backslash$prime && $\prime$
710b3d5fe966 improve interpreter tex Tables Michael Godfrey <michaeldgodfrey@gmail.com> parents: 17281 diff changeset	752 && $\backslash$nabla && $\nabla$
710b3d5fe966 improve interpreter tex Tables Michael Godfrey <michaeldgodfrey@gmail.com> parents: 17281 diff changeset	753 && $\backslash$surd && $\surd$ &\cr
710b3d5fe966 improve interpreter tex Tables Michael Godfrey <michaeldgodfrey@gmail.com> parents: 17281 diff changeset	754 & $\backslash$angle && $\angle$
710b3d5fe966 improve interpreter tex Tables Michael Godfrey <michaeldgodfrey@gmail.com> parents: 17281 diff changeset	755 && $\backslash$forall && $\forall$
710b3d5fe966 improve interpreter tex Tables Michael Godfrey <michaeldgodfrey@gmail.com> parents: 17281 diff changeset	756 && $\backslash$exists && $\exists$ &\cr
710b3d5fe966 improve interpreter tex Tables Michael Godfrey <michaeldgodfrey@gmail.com> parents: 17281 diff changeset	757 & $\backslash$neg && $\neg$
710b3d5fe966 improve interpreter tex Tables Michael Godfrey <michaeldgodfrey@gmail.com> parents: 17281 diff changeset	758 && $\backslash$clubsuit && $\clubsuit$
710b3d5fe966 improve interpreter tex Tables Michael Godfrey <michaeldgodfrey@gmail.com> parents: 17281 diff changeset	759 && $\backslash$diamondsuit && $\diamondsuit$ &\cr
710b3d5fe966 improve interpreter tex Tables Michael Godfrey <michaeldgodfrey@gmail.com> parents: 17281 diff changeset	760 & $\backslash$heartsuit && $\heartsuit$
710b3d5fe966 improve interpreter tex Tables Michael Godfrey <michaeldgodfrey@gmail.com> parents: 17281 diff changeset	761 && $\backslash$spadesuit && $\spadesuit$
710b3d5fe966 improve interpreter tex Tables Michael Godfrey <michaeldgodfrey@gmail.com> parents: 17281 diff changeset	762 && && &\cr}
710b3d5fe966 improve interpreter tex Tables Michael Godfrey <michaeldgodfrey@gmail.com> parents: 17281 diff changeset	763 \vskip12pt
710b3d5fe966 improve interpreter tex Tables Michael Godfrey <michaeldgodfrey@gmail.com> parents: 17281 diff changeset	764 \symtable{``Large'' Operators} {#}
17521 3670ce8da1a0 doc: improve format of table 15.1 for TeX characters. Michael Godfrey <michaeldgodfrey@gmail.com> parents: 17469 diff changeset	765 {& \hbox to \cola{$\backslash$int} && $\int$
3670ce8da1a0 doc: improve format of table 15.1 for TeX characters. Michael Godfrey <michaeldgodfrey@gmail.com> parents: 17469 diff changeset	766 && \hbox to \colb{} &&
3670ce8da1a0 doc: improve format of table 15.1 for TeX characters. Michael Godfrey <michaeldgodfrey@gmail.com> parents: 17469 diff changeset	767 && \hbox to \colc{} && &\cr}
17469 710b3d5fe966 improve interpreter tex Tables Michael Godfrey <michaeldgodfrey@gmail.com> parents: 17281 diff changeset	768 \vskip12pt
710b3d5fe966 improve interpreter tex Tables Michael Godfrey <michaeldgodfrey@gmail.com> parents: 17281 diff changeset	769 \symtable{Binary operators} {#}
17521 3670ce8da1a0 doc: improve format of table 15.1 for TeX characters. Michael Godfrey <michaeldgodfrey@gmail.com> parents: 17469 diff changeset	770 {& \hbox to \cola{$\backslash$pm} && $\pm$
3670ce8da1a0 doc: improve format of table 15.1 for TeX characters. Michael Godfrey <michaeldgodfrey@gmail.com> parents: 17469 diff changeset	771 && \hbox to \colb{$\backslash$cdot} && $\cdot$
3670ce8da1a0 doc: improve format of table 15.1 for TeX characters. Michael Godfrey <michaeldgodfrey@gmail.com> parents: 17469 diff changeset	772 && \hbox to \colc{$\backslash$times} && $\times$ &\cr
17469 710b3d5fe966 improve interpreter tex Tables Michael Godfrey <michaeldgodfrey@gmail.com> parents: 17281 diff changeset	773 & $\backslash$ast && $\ast$
710b3d5fe966 improve interpreter tex Tables Michael Godfrey <michaeldgodfrey@gmail.com> parents: 17281 diff changeset	774 && $\backslash$circ && $\circ$
710b3d5fe966 improve interpreter tex Tables Michael Godfrey <michaeldgodfrey@gmail.com> parents: 17281 diff changeset	775 && $\backslash$bullet && $\bullet$ &\cr
710b3d5fe966 improve interpreter tex Tables Michael Godfrey <michaeldgodfrey@gmail.com> parents: 17281 diff changeset	776 & $\backslash$div && $\div$
710b3d5fe966 improve interpreter tex Tables Michael Godfrey <michaeldgodfrey@gmail.com> parents: 17281 diff changeset	777 && $\backslash$cap && $\cap$
710b3d5fe966 improve interpreter tex Tables Michael Godfrey <michaeldgodfrey@gmail.com> parents: 17281 diff changeset	778 && $\backslash$cup && $\cup$ &\cr
710b3d5fe966 improve interpreter tex Tables Michael Godfrey <michaeldgodfrey@gmail.com> parents: 17281 diff changeset	779 & $\backslash$vee && $\vee$
710b3d5fe966 improve interpreter tex Tables Michael Godfrey <michaeldgodfrey@gmail.com> parents: 17281 diff changeset	780 && $\backslash$wedge && $\wedge$
710b3d5fe966 improve interpreter tex Tables Michael Godfrey <michaeldgodfrey@gmail.com> parents: 17281 diff changeset	781 && $\backslash$oplus && $\oplus$ &\cr
710b3d5fe966 improve interpreter tex Tables Michael Godfrey <michaeldgodfrey@gmail.com> parents: 17281 diff changeset	782 & $\backslash$otimes && $\otimes$
710b3d5fe966 improve interpreter tex Tables Michael Godfrey <michaeldgodfrey@gmail.com> parents: 17281 diff changeset	783 && $\backslash$oslash && $\oslash$
710b3d5fe966 improve interpreter tex Tables Michael Godfrey <michaeldgodfrey@gmail.com> parents: 17281 diff changeset	784 && && &\cr}
9672 43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	785 @end tex
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	786 @ifnottex
17469 710b3d5fe966 improve interpreter tex Tables Michael Godfrey <michaeldgodfrey@gmail.com> parents: 17281 diff changeset	787 @multitable @columnfractions .25 .25 .25 .25
710b3d5fe966 improve interpreter tex Tables Michael Godfrey <michaeldgodfrey@gmail.com> parents: 17281 diff changeset	788 @item Greek Lowercase Letters
710b3d5fe966 improve interpreter tex Tables Michael Godfrey <michaeldgodfrey@gmail.com> parents: 17281 diff changeset	789 @item @tab \alpha @tab \beta @tab \gamma
710b3d5fe966 improve interpreter tex Tables Michael Godfrey <michaeldgodfrey@gmail.com> parents: 17281 diff changeset	790 @item @tab \delta @tab \epsilon @tab \zeta
710b3d5fe966 improve interpreter tex Tables Michael Godfrey <michaeldgodfrey@gmail.com> parents: 17281 diff changeset	791 @item @tab \eta @tab \theta @tab \vartheta
710b3d5fe966 improve interpreter tex Tables Michael Godfrey <michaeldgodfrey@gmail.com> parents: 17281 diff changeset	792 @item @tab \iota @tab \kappa @tab \lambda
710b3d5fe966 improve interpreter tex Tables Michael Godfrey <michaeldgodfrey@gmail.com> parents: 17281 diff changeset	793 @item @tab \mu @tab \nu @tab \xi
710b3d5fe966 improve interpreter tex Tables Michael Godfrey <michaeldgodfrey@gmail.com> parents: 17281 diff changeset	794 @item @tab \o @tab \pi @tab \varpi
710b3d5fe966 improve interpreter tex Tables Michael Godfrey <michaeldgodfrey@gmail.com> parents: 17281 diff changeset	795 @item @tab \rho @tab \sigma @tab \varsigma
710b3d5fe966 improve interpreter tex Tables Michael Godfrey <michaeldgodfrey@gmail.com> parents: 17281 diff changeset	796 @item @tab \tau @tab \upsilon @tab \phi
710b3d5fe966 improve interpreter tex Tables Michael Godfrey <michaeldgodfrey@gmail.com> parents: 17281 diff changeset	797 @item @tab \chi @tab \psi @tab \omega
710b3d5fe966 improve interpreter tex Tables Michael Godfrey <michaeldgodfrey@gmail.com> parents: 17281 diff changeset	798 @item Greek Uppercase Letters
710b3d5fe966 improve interpreter tex Tables Michael Godfrey <michaeldgodfrey@gmail.com> parents: 17281 diff changeset	799 @item @tab \Gamma @tab \Delta @tab \Theta
710b3d5fe966 improve interpreter tex Tables Michael Godfrey <michaeldgodfrey@gmail.com> parents: 17281 diff changeset	800 @item @tab \Lambda @tab \Xi @tab \Pi
710b3d5fe966 improve interpreter tex Tables Michael Godfrey <michaeldgodfrey@gmail.com> parents: 17281 diff changeset	801 @item @tab \Sigma @tab \Upsilon @tab \Phi
710b3d5fe966 improve interpreter tex Tables Michael Godfrey <michaeldgodfrey@gmail.com> parents: 17281 diff changeset	802 @item @tab \Psi @tab \Omega @tab
710b3d5fe966 improve interpreter tex Tables Michael Godfrey <michaeldgodfrey@gmail.com> parents: 17281 diff changeset	803 @item Misc Symbols Type Ord
710b3d5fe966 improve interpreter tex Tables Michael Godfrey <michaeldgodfrey@gmail.com> parents: 17281 diff changeset	804 @item @tab \aleph @tab \wp @tab \Re
710b3d5fe966 improve interpreter tex Tables Michael Godfrey <michaeldgodfrey@gmail.com> parents: 17281 diff changeset	805 @item @tab \Im @tab \partial @tab \infty
710b3d5fe966 improve interpreter tex Tables Michael Godfrey <michaeldgodfrey@gmail.com> parents: 17281 diff changeset	806 @item @tab \prime @tab \nabla @tab \surd
710b3d5fe966 improve interpreter tex Tables Michael Godfrey <michaeldgodfrey@gmail.com> parents: 17281 diff changeset	807 @item @tab \angle @tab \forall @tab \exists
710b3d5fe966 improve interpreter tex Tables Michael Godfrey <michaeldgodfrey@gmail.com> parents: 17281 diff changeset	808 @item @tab \neg @tab \clubsuit @tab \diamondsuit
710b3d5fe966 improve interpreter tex Tables Michael Godfrey <michaeldgodfrey@gmail.com> parents: 17281 diff changeset	809 @item @tab \heartsuit @tab \spadesuit @tab
710b3d5fe966 improve interpreter tex Tables Michael Godfrey <michaeldgodfrey@gmail.com> parents: 17281 diff changeset	810 @item ``Large'' Operators
710b3d5fe966 improve interpreter tex Tables Michael Godfrey <michaeldgodfrey@gmail.com> parents: 17281 diff changeset	811 @item @tab \int
710b3d5fe966 improve interpreter tex Tables Michael Godfrey <michaeldgodfrey@gmail.com> parents: 17281 diff changeset	812 @item Binary Operators
710b3d5fe966 improve interpreter tex Tables Michael Godfrey <michaeldgodfrey@gmail.com> parents: 17281 diff changeset	813 @item @tab \pm @tab \cdot @tab \times
710b3d5fe966 improve interpreter tex Tables Michael Godfrey <michaeldgodfrey@gmail.com> parents: 17281 diff changeset	814 @item @tab \ast @tab \circ @tab \bullet
710b3d5fe966 improve interpreter tex Tables Michael Godfrey <michaeldgodfrey@gmail.com> parents: 17281 diff changeset	815 @item @tab \div @tab \cap @tab \cup
710b3d5fe966 improve interpreter tex Tables Michael Godfrey <michaeldgodfrey@gmail.com> parents: 17281 diff changeset	816 @item @tab \vee @tab \wedge @tab \oplus
710b3d5fe966 improve interpreter tex Tables Michael Godfrey <michaeldgodfrey@gmail.com> parents: 17281 diff changeset	817 @item @tab \otimes @tab \oslash @tab
710b3d5fe966 improve interpreter tex Tables Michael Godfrey <michaeldgodfrey@gmail.com> parents: 17281 diff changeset	818 @item Relations
710b3d5fe966 improve interpreter tex Tables Michael Godfrey <michaeldgodfrey@gmail.com> parents: 17281 diff changeset	819 @item @tab \leq @tab \subset @tab \subseteq
710b3d5fe966 improve interpreter tex Tables Michael Godfrey <michaeldgodfrey@gmail.com> parents: 17281 diff changeset	820 @item @tab \in @tab \geq @tab \supset
710b3d5fe966 improve interpreter tex Tables Michael Godfrey <michaeldgodfrey@gmail.com> parents: 17281 diff changeset	821 @item @tab \supseteq @tab \ni @tab \mid
710b3d5fe966 improve interpreter tex Tables Michael Godfrey <michaeldgodfrey@gmail.com> parents: 17281 diff changeset	822 @item @tab \equiv @tab \sim @tab \approx
710b3d5fe966 improve interpreter tex Tables Michael Godfrey <michaeldgodfrey@gmail.com> parents: 17281 diff changeset	823 @item @tab \cong @tab \propto @tab \perp
710b3d5fe966 improve interpreter tex Tables Michael Godfrey <michaeldgodfrey@gmail.com> parents: 17281 diff changeset	824 @item Arrows
710b3d5fe966 improve interpreter tex Tables Michael Godfrey <michaeldgodfrey@gmail.com> parents: 17281 diff changeset	825 @item @tab \leftarrow @tab \Leftarrow @tab \rightarrow
710b3d5fe966 improve interpreter tex Tables Michael Godfrey <michaeldgodfrey@gmail.com> parents: 17281 diff changeset	826 @item @tab \Rightarrow @tab \leftrightarrow @tab \uparrow
710b3d5fe966 improve interpreter tex Tables Michael Godfrey <michaeldgodfrey@gmail.com> parents: 17281 diff changeset	827 @item @tab \downarrow @tab @tab
710b3d5fe966 improve interpreter tex Tables Michael Godfrey <michaeldgodfrey@gmail.com> parents: 17281 diff changeset	828 @item Openings and Closings
710b3d5fe966 improve interpreter tex Tables Michael Godfrey <michaeldgodfrey@gmail.com> parents: 17281 diff changeset	829 @item @tab \lfloor @tab \langle @tab \lceil
710b3d5fe966 improve interpreter tex Tables Michael Godfrey <michaeldgodfrey@gmail.com> parents: 17281 diff changeset	830 @item @tab \rfloor @tab \rangle @tab \rceil
710b3d5fe966 improve interpreter tex Tables Michael Godfrey <michaeldgodfrey@gmail.com> parents: 17281 diff changeset	831 @item Alternate Names
710b3d5fe966 improve interpreter tex Tables Michael Godfrey <michaeldgodfrey@gmail.com> parents: 17281 diff changeset	832 @item @tab \neq
710b3d5fe966 improve interpreter tex Tables Michael Godfrey <michaeldgodfrey@gmail.com> parents: 17281 diff changeset	833 @item Other
710b3d5fe966 improve interpreter tex Tables Michael Godfrey <michaeldgodfrey@gmail.com> parents: 17281 diff changeset	834 @item @tab \ldots @tab \0 @tab \copyright
710b3d5fe966 improve interpreter tex Tables Michael Godfrey <michaeldgodfrey@gmail.com> parents: 17281 diff changeset	835 @item @tab \deg
9672 43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	836 @end multitable
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	837 @end ifnottex
9758 09da0bd91412 Periodic grammar check of Octave documentation files to ensure common format Rik <rdrider0-list@yahoo.com> parents: 9752 diff changeset	838 @caption{Available special characters in @TeX{} mode}
9672 43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	839 @end float
17469 710b3d5fe966 improve interpreter tex Tables Michael Godfrey <michaeldgodfrey@gmail.com> parents: 17281 diff changeset	840 @float
710b3d5fe966 improve interpreter tex Tables Michael Godfrey <michaeldgodfrey@gmail.com> parents: 17281 diff changeset	841 @tex
710b3d5fe966 improve interpreter tex Tables Michael Godfrey <michaeldgodfrey@gmail.com> parents: 17281 diff changeset	842 \vskip 6pt
17521 3670ce8da1a0 doc: improve format of table 15.1 for TeX characters. Michael Godfrey <michaeldgodfrey@gmail.com> parents: 17469 diff changeset	843 \newdimen\cola \cola=78pt
3670ce8da1a0 doc: improve format of table 15.1 for TeX characters. Michael Godfrey <michaeldgodfrey@gmail.com> parents: 17469 diff changeset	844 \newdimen\colb \colb=78pt
3670ce8da1a0 doc: improve format of table 15.1 for TeX characters. Michael Godfrey <michaeldgodfrey@gmail.com> parents: 17469 diff changeset	845 \newdimen\colc \colc=78pt
17469 710b3d5fe966 improve interpreter tex Tables Michael Godfrey <michaeldgodfrey@gmail.com> parents: 17281 diff changeset	846 \def\symtable#1#2#3{\hbox to \hsize {\hfill\vbox{\offinterlineskip \tabskip=0pt
710b3d5fe966 improve interpreter tex Tables Michael Godfrey <michaeldgodfrey@gmail.com> parents: 17281 diff changeset	847 \hskip36pt #1
710b3d5fe966 improve interpreter tex Tables Michael Godfrey <michaeldgodfrey@gmail.com> parents: 17281 diff changeset	848 \vskip6pt
710b3d5fe966 improve interpreter tex Tables Michael Godfrey <michaeldgodfrey@gmail.com> parents: 17281 diff changeset	849 \halign{
710b3d5fe966 improve interpreter tex Tables Michael Godfrey <michaeldgodfrey@gmail.com> parents: 17281 diff changeset	850 \vrule height2.0ex depth1.ex width 0.6pt #2\tabskip=0.3em &
710b3d5fe966 improve interpreter tex Tables Michael Godfrey <michaeldgodfrey@gmail.com> parents: 17281 diff changeset	851 #2 \hfil & \vrule #2 & #2 \hfil & #2 \vrule &
710b3d5fe966 improve interpreter tex Tables Michael Godfrey <michaeldgodfrey@gmail.com> parents: 17281 diff changeset	852 #2 \hfil & \vrule #2 & #2 \hfil & #2 \vrule &
710b3d5fe966 improve interpreter tex Tables Michael Godfrey <michaeldgodfrey@gmail.com> parents: 17281 diff changeset	853 #2 \hfil & \vrule #2 & #2 \hfil & #2 \vrule
710b3d5fe966 improve interpreter tex Tables Michael Godfrey <michaeldgodfrey@gmail.com> parents: 17281 diff changeset	854 width 0.6pt \tabskip=0pt\cr
710b3d5fe966 improve interpreter tex Tables Michael Godfrey <michaeldgodfrey@gmail.com> parents: 17281 diff changeset	855 \noalign{\hrule height 0.6pt}
710b3d5fe966 improve interpreter tex Tables Michael Godfrey <michaeldgodfrey@gmail.com> parents: 17281 diff changeset	856 & Code && Sym && Code && Sym && Code && Sym &\cr
710b3d5fe966 improve interpreter tex Tables Michael Godfrey <michaeldgodfrey@gmail.com> parents: 17281 diff changeset	857 \noalign{\hrule}
710b3d5fe966 improve interpreter tex Tables Michael Godfrey <michaeldgodfrey@gmail.com> parents: 17281 diff changeset	858 #3
710b3d5fe966 improve interpreter tex Tables Michael Godfrey <michaeldgodfrey@gmail.com> parents: 17281 diff changeset	859 \noalign{\hrule height 0.6pt}
710b3d5fe966 improve interpreter tex Tables Michael Godfrey <michaeldgodfrey@gmail.com> parents: 17281 diff changeset	860 }
710b3d5fe966 improve interpreter tex Tables Michael Godfrey <michaeldgodfrey@gmail.com> parents: 17281 diff changeset	861 }\hfill}}
17521 3670ce8da1a0 doc: improve format of table 15.1 for TeX characters. Michael Godfrey <michaeldgodfrey@gmail.com> parents: 17469 diff changeset	862 \hoffset72pt
3670ce8da1a0 doc: improve format of table 15.1 for TeX characters. Michael Godfrey <michaeldgodfrey@gmail.com> parents: 17469 diff changeset	863 \vskip12pt
17469 710b3d5fe966 improve interpreter tex Tables Michael Godfrey <michaeldgodfrey@gmail.com> parents: 17281 diff changeset	864 \symtable{Relations} {#}
17521 3670ce8da1a0 doc: improve format of table 15.1 for TeX characters. Michael Godfrey <michaeldgodfrey@gmail.com> parents: 17469 diff changeset	865 {& \hbox to \cola{$\backslash$leq} && $\leq$
3670ce8da1a0 doc: improve format of table 15.1 for TeX characters. Michael Godfrey <michaeldgodfrey@gmail.com> parents: 17469 diff changeset	866 && \hbox to \colb{$\backslash$subset} && $\subset$
3670ce8da1a0 doc: improve format of table 15.1 for TeX characters. Michael Godfrey <michaeldgodfrey@gmail.com> parents: 17469 diff changeset	867 && \hbox to \colc{$\backslash$subseteq} && $\subseteq$ &\cr
17469 710b3d5fe966 improve interpreter tex Tables Michael Godfrey <michaeldgodfrey@gmail.com> parents: 17281 diff changeset	868 & $\backslash$in && $\in$
710b3d5fe966 improve interpreter tex Tables Michael Godfrey <michaeldgodfrey@gmail.com> parents: 17281 diff changeset	869 && $\backslash$geq && $\geq$
710b3d5fe966 improve interpreter tex Tables Michael Godfrey <michaeldgodfrey@gmail.com> parents: 17281 diff changeset	870 && $\backslash$supset && $\supset$ &\cr
710b3d5fe966 improve interpreter tex Tables Michael Godfrey <michaeldgodfrey@gmail.com> parents: 17281 diff changeset	871 & $\backslash$supseteq && $\supseteq$
710b3d5fe966 improve interpreter tex Tables Michael Godfrey <michaeldgodfrey@gmail.com> parents: 17281 diff changeset	872 && $\backslash$ni && $\ni$
710b3d5fe966 improve interpreter tex Tables Michael Godfrey <michaeldgodfrey@gmail.com> parents: 17281 diff changeset	873 && $\backslash$mid && $\mid$ &\cr
710b3d5fe966 improve interpreter tex Tables Michael Godfrey <michaeldgodfrey@gmail.com> parents: 17281 diff changeset	874 & $\backslash$equiv && $\equiv$
710b3d5fe966 improve interpreter tex Tables Michael Godfrey <michaeldgodfrey@gmail.com> parents: 17281 diff changeset	875 && $\backslash$sim && $\sim$
710b3d5fe966 improve interpreter tex Tables Michael Godfrey <michaeldgodfrey@gmail.com> parents: 17281 diff changeset	876 && $\backslash$approx && $\approx$ &\cr
710b3d5fe966 improve interpreter tex Tables Michael Godfrey <michaeldgodfrey@gmail.com> parents: 17281 diff changeset	877 & $\backslash$cong && $\cong$
710b3d5fe966 improve interpreter tex Tables Michael Godfrey <michaeldgodfrey@gmail.com> parents: 17281 diff changeset	878 && $\backslash$propto && $\propto$
710b3d5fe966 improve interpreter tex Tables Michael Godfrey <michaeldgodfrey@gmail.com> parents: 17281 diff changeset	879 && $\backslash$perp && $\perp$ &\cr}
17521 3670ce8da1a0 doc: improve format of table 15.1 for TeX characters. Michael Godfrey <michaeldgodfrey@gmail.com> parents: 17469 diff changeset	880 \vskip12pt
17469 710b3d5fe966 improve interpreter tex Tables Michael Godfrey <michaeldgodfrey@gmail.com> parents: 17281 diff changeset	881 \symtable{Arrows} {#}
17521 3670ce8da1a0 doc: improve format of table 15.1 for TeX characters. Michael Godfrey <michaeldgodfrey@gmail.com> parents: 17469 diff changeset	882 {& \hbox to \cola{$\backslash$leftarrow} && $\leftarrow$
3670ce8da1a0 doc: improve format of table 15.1 for TeX characters. Michael Godfrey <michaeldgodfrey@gmail.com> parents: 17469 diff changeset	883 && \hbox to \colb{$\backslash$Leftarrow} && $\Leftarrow$
3670ce8da1a0 doc: improve format of table 15.1 for TeX characters. Michael Godfrey <michaeldgodfrey@gmail.com> parents: 17469 diff changeset	884 && \hbox to \colc{$\backslash$rightarrow} && $\rightarrow$ &\cr
17469 710b3d5fe966 improve interpreter tex Tables Michael Godfrey <michaeldgodfrey@gmail.com> parents: 17281 diff changeset	885 & $\backslash$Rightarrow && $\Rightarrow$
710b3d5fe966 improve interpreter tex Tables Michael Godfrey <michaeldgodfrey@gmail.com> parents: 17281 diff changeset	886 && $\backslash$leftrightarrow && $\leftrightarrow$
710b3d5fe966 improve interpreter tex Tables Michael Godfrey <michaeldgodfrey@gmail.com> parents: 17281 diff changeset	887 && $\backslash$uparrow && $\uparrow$ &\cr
710b3d5fe966 improve interpreter tex Tables Michael Godfrey <michaeldgodfrey@gmail.com> parents: 17281 diff changeset	888 & $\backslash$downarrow && $\downarrow$
19790 446c46af4b42 strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19203 diff changeset	889 && &&
17469 710b3d5fe966 improve interpreter tex Tables Michael Godfrey <michaeldgodfrey@gmail.com> parents: 17281 diff changeset	890 && && &\cr}
710b3d5fe966 improve interpreter tex Tables Michael Godfrey <michaeldgodfrey@gmail.com> parents: 17281 diff changeset	891 \vskip12pt
710b3d5fe966 improve interpreter tex Tables Michael Godfrey <michaeldgodfrey@gmail.com> parents: 17281 diff changeset	892 \symtable{Openings and Closings} {#}
17521 3670ce8da1a0 doc: improve format of table 15.1 for TeX characters. Michael Godfrey <michaeldgodfrey@gmail.com> parents: 17469 diff changeset	893 {& \hbox to \cola{$\backslash$lfloor } && $\lfloor$
3670ce8da1a0 doc: improve format of table 15.1 for TeX characters. Michael Godfrey <michaeldgodfrey@gmail.com> parents: 17469 diff changeset	894 && \hbox to \colb{$\backslash$langle } && $\langle$
3670ce8da1a0 doc: improve format of table 15.1 for TeX characters. Michael Godfrey <michaeldgodfrey@gmail.com> parents: 17469 diff changeset	895 && \hbox to \colc{$\backslash$lceil } && $\lceil$ &\cr
17469 710b3d5fe966 improve interpreter tex Tables Michael Godfrey <michaeldgodfrey@gmail.com> parents: 17281 diff changeset	896 & $\backslash$rfloor && $\rfloor$
710b3d5fe966 improve interpreter tex Tables Michael Godfrey <michaeldgodfrey@gmail.com> parents: 17281 diff changeset	897 && $\backslash$rangle && $\rangle$
710b3d5fe966 improve interpreter tex Tables Michael Godfrey <michaeldgodfrey@gmail.com> parents: 17281 diff changeset	898 && $\backslash$rceil && $\rceil$ &\cr}
710b3d5fe966 improve interpreter tex Tables Michael Godfrey <michaeldgodfrey@gmail.com> parents: 17281 diff changeset	899 \vskip12pt
710b3d5fe966 improve interpreter tex Tables Michael Godfrey <michaeldgodfrey@gmail.com> parents: 17281 diff changeset	900 \symtable{Alternate Names} {#}
17521 3670ce8da1a0 doc: improve format of table 15.1 for TeX characters. Michael Godfrey <michaeldgodfrey@gmail.com> parents: 17469 diff changeset	901 {& \hbox to \cola{$\backslash$neq} && $\neq$
19790 446c46af4b42 strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19203 diff changeset	902 && \hbox to \colb{} &&
17521 3670ce8da1a0 doc: improve format of table 15.1 for TeX characters. Michael Godfrey <michaeldgodfrey@gmail.com> parents: 17469 diff changeset	903 && \hbox to \colc{} && &\cr}
17469 710b3d5fe966 improve interpreter tex Tables Michael Godfrey <michaeldgodfrey@gmail.com> parents: 17281 diff changeset	904 \vskip12pt
710b3d5fe966 improve interpreter tex Tables Michael Godfrey <michaeldgodfrey@gmail.com> parents: 17281 diff changeset	905 \symtable{Other (not in Appendix F Tables)} {#}
17521 3670ce8da1a0 doc: improve format of table 15.1 for TeX characters. Michael Godfrey <michaeldgodfrey@gmail.com> parents: 17469 diff changeset	906 {& \hbox to \cola{$\backslash$ldots} && $\ldots$
3670ce8da1a0 doc: improve format of table 15.1 for TeX characters. Michael Godfrey <michaeldgodfrey@gmail.com> parents: 17469 diff changeset	907 && \hbox to \colb{$\backslash$0} && $\oslash$
3670ce8da1a0 doc: improve format of table 15.1 for TeX characters. Michael Godfrey <michaeldgodfrey@gmail.com> parents: 17469 diff changeset	908 && \hbox to \colc{$\backslash$copyright} && $\copyright$ &\cr
17524 797545fa86d0 plot.txi: fix \deg in TeX symbol table. Michael Godfrey <michaeldgodfrey@gmail.com> parents: 17521 diff changeset	909 & $\backslash$deg && $^\circ$
19790 446c46af4b42 strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19203 diff changeset	910 && &&
17469 710b3d5fe966 improve interpreter tex Tables Michael Godfrey <michaeldgodfrey@gmail.com> parents: 17281 diff changeset	911 && && &\cr}
710b3d5fe966 improve interpreter tex Tables Michael Godfrey <michaeldgodfrey@gmail.com> parents: 17281 diff changeset	912 \vskip12pt
710b3d5fe966 improve interpreter tex Tables Michael Godfrey <michaeldgodfrey@gmail.com> parents: 17281 diff changeset	913 \hskip36pt Table 15.1: Available special characters in \TeX\ mode (cont.)
710b3d5fe966 improve interpreter tex Tables Michael Godfrey <michaeldgodfrey@gmail.com> parents: 17281 diff changeset	914 @end tex
710b3d5fe966 improve interpreter tex Tables Michael Godfrey <michaeldgodfrey@gmail.com> parents: 17281 diff changeset	915 @end float
9672 43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	916
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	917 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	918
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	919 @example
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	920 @group
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	921 x = 0:0.01:3;
14856 c3fd61c59e9c maint: Use Octave coding conventions for cuddling parentheses in doc directory Rik <octave@nomad.inbox5.com> parents: 14853 diff changeset	922 plot (x, erf (x));
9672 43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	923 hold on;
14856 c3fd61c59e9c maint: Use Octave coding conventions for cuddling parentheses in doc directory Rik <octave@nomad.inbox5.com> parents: 14853 diff changeset	924 plot (x,x,"r");
c3fd61c59e9c maint: Use Octave coding conventions for cuddling parentheses in doc directory Rik <octave@nomad.inbox5.com> parents: 14853 diff changeset	925 axis ([0, 3, 0, 1]);
c3fd61c59e9c maint: Use Octave coding conventions for cuddling parentheses in doc directory Rik <octave@nomad.inbox5.com> parents: 14853 diff changeset	926 text (0.65, 0.6175, strcat ('\leftarrow x = @{2/\surd\pi',
9672 43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	927 ' @{\fontsize@{16@}\int_@{\fontsize@{8@}0@}^@{\fontsize@{8@}x@}@}',
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	928 ' e^@{-t^2@} dt@} = 0.6175'))
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	929 @end group
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	930 @end example
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	931
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	932 @ifnotinfo
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	933 @noindent
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	934 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	935
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	936 @float Figure,fig:extendedtext
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	937 @center @image{extended,4in}
9758 09da0bd91412 Periodic grammar check of Octave documentation files to ensure common format Rik <rdrider0-list@yahoo.com> parents: 9752 diff changeset	938 @caption{Example of inclusion of text with the @TeX{} interpreter}
9672 43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	939 @end float
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	940 @end ifnotinfo
5134 0309b6722ee9 [project @ 2005-02-08 20:17:55 by jwe] jwe parents: 5016 diff changeset	941
11254 31f8534eb055 Add reference to new saveas function in printed manual. Rik <octave@nomad.inbox5.com> parents: 10846 diff changeset	942 @node Printing and Saving Plots
31f8534eb055 Add reference to new saveas function in printed manual. Rik <octave@nomad.inbox5.com> parents: 10846 diff changeset	943 @subsection Printing and Saving Plots
18398 200851c87444 Edits to Manual and indicies Michael Godfrey <michaeldgodfrey@gmail.com> parents: 17957 diff changeset	944 @cindex plotting, saving and printing plots
9672 43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	945 @cindex printing plots
11254 31f8534eb055 Add reference to new saveas function in printed manual. Rik <octave@nomad.inbox5.com> parents: 10846 diff changeset	946 @cindex saving plots
6888 b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe] jwe parents: 6877 diff changeset	947
14456 05635e4c605a Improve documentation for print(). Ben Abbott <bpabbott@mac.com> parents: 14138 diff changeset	948 The @code{print} command allows you to send plots to you printer and
05635e4c605a Improve documentation for print(). Ben Abbott <bpabbott@mac.com> parents: 14138 diff changeset	949 to save plots in a variety of formats. For example,
05635e4c605a Improve documentation for print(). Ben Abbott <bpabbott@mac.com> parents: 14138 diff changeset	950
05635e4c605a Improve documentation for print(). Ben Abbott <bpabbott@mac.com> parents: 14138 diff changeset	951 @example
05635e4c605a Improve documentation for print(). Ben Abbott <bpabbott@mac.com> parents: 14138 diff changeset	952 print -dpsc
05635e4c605a Improve documentation for print(). Ben Abbott <bpabbott@mac.com> parents: 14138 diff changeset	953 @end example
05635e4c605a Improve documentation for print(). Ben Abbott <bpabbott@mac.com> parents: 14138 diff changeset	954
05635e4c605a Improve documentation for print(). Ben Abbott <bpabbott@mac.com> parents: 14138 diff changeset	955 @noindent
14853 72b8b39e12be doc: Periodic grammarcheck of documentation. Rik <octave@nomad.inbox5.com> parents: 14577 diff changeset	956 prints the current figure to a color PostScript printer. And,
6888 b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe] jwe parents: 6877 diff changeset	957
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe] jwe parents: 6877 diff changeset	958 @example
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe] jwe parents: 6877 diff changeset	959 print -deps foo.eps
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe] jwe parents: 6877 diff changeset	960 @end example
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe] jwe parents: 6877 diff changeset	961
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe] jwe parents: 6877 diff changeset	962 @noindent
14456 05635e4c605a Improve documentation for print(). Ben Abbott <bpabbott@mac.com> parents: 14138 diff changeset	963 saves the current figure to an encapsulated PostScript file called
6888 b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe] jwe parents: 6877 diff changeset	964 @file{foo.eps}.
6502 6ab0a8767780 [project @ 2007-04-06 03:32:06 by jwe] jwe parents: 6331 diff changeset	965
19203 c4ffcc961f3c Document that "tex" interpreter only works with gnuplot for printing (bug #42340). Rik <rik@octave.org> parents: 19034 diff changeset	966 The different graphic toolkits have different print capabilities. In
c4ffcc961f3c Document that "tex" interpreter only works with gnuplot for printing (bug #42340). Rik <rik@octave.org> parents: 19034 diff changeset	967 particular, the OpenGL based toolkits such as @code{fltk} do not support
c4ffcc961f3c Document that "tex" interpreter only works with gnuplot for printing (bug #42340). Rik <rik@octave.org> parents: 19034 diff changeset	968 the @qcode{"interpreter"} property of text objects. This means special
c4ffcc961f3c Document that "tex" interpreter only works with gnuplot for printing (bug #42340). Rik <rik@octave.org> parents: 19034 diff changeset	969 symbols drawn with the @qcode{"tex"} interpreter will appear correctly
c4ffcc961f3c Document that "tex" interpreter only works with gnuplot for printing (bug #42340). Rik <rik@octave.org> parents: 19034 diff changeset	970 on-screen but will be rendered with interpreter @qcode{"none"} when printing.
c4ffcc961f3c Document that "tex" interpreter only works with gnuplot for printing (bug #42340). Rik <rik@octave.org> parents: 19034 diff changeset	971 Switch graphics toolkits for printing if this is a concern.
c4ffcc961f3c Document that "tex" interpreter only works with gnuplot for printing (bug #42340). Rik <rik@octave.org> parents: 19034 diff changeset	972
6502 6ab0a8767780 [project @ 2007-04-06 03:32:06 by jwe] jwe parents: 6331 diff changeset	973 @DOCSTRING(print)
6ab0a8767780 [project @ 2007-04-06 03:32:06 by jwe] jwe parents: 6331 diff changeset	974
11254 31f8534eb055 Add reference to new saveas function in printed manual. Rik <octave@nomad.inbox5.com> parents: 10846 diff changeset	975 @DOCSTRING(saveas)
31f8534eb055 Add reference to new saveas function in printed manual. Rik <octave@nomad.inbox5.com> parents: 10846 diff changeset	976
6502 6ab0a8767780 [project @ 2007-04-06 03:32:06 by jwe] jwe parents: 6331 diff changeset	977 @DOCSTRING(orient)
5134 0309b6722ee9 [project @ 2005-02-08 20:17:55 by jwe] jwe parents: 5016 diff changeset	978
18715 13c80c3e9660 Add new functions hgsave and hgload (bug #39532). Massimiliano Fasi <mogrob.sanit@gmail.com> and Rik <rik@octave.org> parents: 18555 diff changeset	979 @code{print} and @code{saveas} are used when work on a plot has finished
13c80c3e9660 Add new functions hgsave and hgload (bug #39532). Massimiliano Fasi <mogrob.sanit@gmail.com> and Rik <rik@octave.org> parents: 18555 diff changeset	980 and the output must be in a publication-ready format. During intermediate
13c80c3e9660 Add new functions hgsave and hgload (bug #39532). Massimiliano Fasi <mogrob.sanit@gmail.com> and Rik <rik@octave.org> parents: 18555 diff changeset	981 stages it is often better to save the graphics object and all of its
13c80c3e9660 Add new functions hgsave and hgload (bug #39532). Massimiliano Fasi <mogrob.sanit@gmail.com> and Rik <rik@octave.org> parents: 18555 diff changeset	982 associated information so that changes---to colors, axis limits, marker styles,
13c80c3e9660 Add new functions hgsave and hgload (bug #39532). Massimiliano Fasi <mogrob.sanit@gmail.com> and Rik <rik@octave.org> parents: 18555 diff changeset	983 etc.---can be made easily from within Octave. The @code{hgsave}/@code{hgload}
13c80c3e9660 Add new functions hgsave and hgload (bug #39532). Massimiliano Fasi <mogrob.sanit@gmail.com> and Rik <rik@octave.org> parents: 18555 diff changeset	984 commands can be used to save and re-create a graphics object.
13c80c3e9660 Add new functions hgsave and hgload (bug #39532). Massimiliano Fasi <mogrob.sanit@gmail.com> and Rik <rik@octave.org> parents: 18555 diff changeset	985
13c80c3e9660 Add new functions hgsave and hgload (bug #39532). Massimiliano Fasi <mogrob.sanit@gmail.com> and Rik <rik@octave.org> parents: 18555 diff changeset	986 @DOCSTRING(hgsave)
13c80c3e9660 Add new functions hgsave and hgload (bug #39532). Massimiliano Fasi <mogrob.sanit@gmail.com> and Rik <rik@octave.org> parents: 18555 diff changeset	987
13c80c3e9660 Add new functions hgsave and hgload (bug #39532). Massimiliano Fasi <mogrob.sanit@gmail.com> and Rik <rik@octave.org> parents: 18555 diff changeset	988 @DOCSTRING(hgload)
13c80c3e9660 Add new functions hgsave and hgload (bug #39532). Massimiliano Fasi <mogrob.sanit@gmail.com> and Rik <rik@octave.org> parents: 18555 diff changeset	989
11254 31f8534eb055 Add reference to new saveas function in printed manual. Rik <octave@nomad.inbox5.com> parents: 10846 diff changeset	990 @node Interacting with Plots
31f8534eb055 Add reference to new saveas function in printed manual. Rik <octave@nomad.inbox5.com> parents: 10846 diff changeset	991 @subsection Interacting with Plots
7984 bbaa5d7d0143 Some documentation updates David Bateman <dbateman@free.fr> parents: 7981 diff changeset	992
bbaa5d7d0143 Some documentation updates David Bateman <dbateman@free.fr> parents: 7981 diff changeset	993 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	994 selection the position at which to place text on the plot with the
12522 33bbae85769a Add uimenu, uigetdir, uigetfile, and uiputfile to documentation. Rik <octave@nomad.inbox5.com> parents: 12226 diff changeset	995 @code{gtext} function using the mouse. Menus may also be created
33bbae85769a Add uimenu, uigetdir, uigetfile, and uiputfile to documentation. Rik <octave@nomad.inbox5.com> parents: 12226 diff changeset	996 and populated with specific user commands via the @code{uimenu} function.
7984 bbaa5d7d0143 Some documentation updates David Bateman <dbateman@free.fr> parents: 7981 diff changeset	997
bbaa5d7d0143 Some documentation updates David Bateman <dbateman@free.fr> parents: 7981 diff changeset	998 @DOCSTRING(ginput)
bbaa5d7d0143 Some documentation updates David Bateman <dbateman@free.fr> parents: 7981 diff changeset	999
bbaa5d7d0143 Some documentation updates David Bateman <dbateman@free.fr> parents: 7981 diff changeset	1000 @DOCSTRING(waitforbuttonpress)
bbaa5d7d0143 Some documentation updates David Bateman <dbateman@free.fr> parents: 7981 diff changeset	1001
bbaa5d7d0143 Some documentation updates David Bateman <dbateman@free.fr> parents: 7981 diff changeset	1002 @DOCSTRING(gtext)
bbaa5d7d0143 Some documentation updates David Bateman <dbateman@free.fr> parents: 7981 diff changeset	1003
12522 33bbae85769a Add uimenu, uigetdir, uigetfile, and uiputfile to documentation. Rik <octave@nomad.inbox5.com> parents: 12226 diff changeset	1004 @DOCSTRING(uimenu)
33bbae85769a Add uimenu, uigetdir, uigetfile, and uiputfile to documentation. Rik <octave@nomad.inbox5.com> parents: 12226 diff changeset	1005
6788 c81a0f3f5a82 [project @ 2007-07-23 22:05:29 by dbateman] dbateman parents: 6778 diff changeset	1006 @node Test Plotting Functions
6888 b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe] jwe parents: 6877 diff changeset	1007 @subsection Test Plotting Functions
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe] jwe parents: 6877 diff changeset	1008
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe] jwe parents: 6877 diff changeset	1009 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	1010 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	1011 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	1012
6877 ab11bdb09820 [project @ 2007-09-07 05:12:32 by jwe] jwe parents: 6788 diff changeset	1013 @DOCSTRING(sombrero)
ab11bdb09820 [project @ 2007-09-07 05:12:32 by jwe] jwe parents: 6788 diff changeset	1014
6788 c81a0f3f5a82 [project @ 2007-07-23 22:05:29 by dbateman] dbateman parents: 6778 diff changeset	1015 @DOCSTRING(peaks)
9672 43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	1016 @node Graphics Data Structures
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	1017 @section Graphics Data Structures
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	1018 @cindex graphics data structures
6888 b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe] jwe parents: 6877 diff changeset	1019
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe] jwe parents: 6877 diff changeset	1020 @menu
17152 f2a8592b8fbd doc: Shorten some long subsection names in Manual. Rik <rik@octave.org> parents: 17123 diff changeset	1021 * Introduction to Graphics Structures::
f2a8592b8fbd doc: Shorten some long subsection names in Manual. Rik <rik@octave.org> parents: 17123 diff changeset	1022 * Graphics Objects::
f2a8592b8fbd doc: Shorten some long subsection names in Manual. Rik <rik@octave.org> parents: 17123 diff changeset	1023 * Graphics Object Properties::
f2a8592b8fbd doc: Shorten some long subsection names in Manual. Rik <rik@octave.org> parents: 17123 diff changeset	1024 * Searching Properties::
f2a8592b8fbd doc: Shorten some long subsection names in Manual. Rik <rik@octave.org> parents: 17123 diff changeset	1025 * Managing Default Properties::
6888 b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe] jwe parents: 6877 diff changeset	1026 @end menu
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe] jwe parents: 6877 diff changeset	1027
9672 43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	1028 @node Introduction to Graphics Structures
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	1029 @subsection Introduction to Graphics Structures
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	1030 @cindex introduction to graphics structures
17097 e7a059a9a644 doc: Use XREF as anchor prefix in documentation for clearer results in Info viewer. Rik <rik@octave.org> parents: 16923 diff changeset	1031 @anchor{XREFgraphics structures}
9672 43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	1032
10846 a4f482e66b65 Grammarcheck more of the documentation. Rik <octave@nomad.inbox5.com> parents: 10828 diff changeset	1033 The graphics functions use pointers, which are of class graphics_handle, in
19657 78c0241306b5 Add documentation about when to use newplot (bug #40289). Rik <rik@octave.org> parents: 19602 diff changeset	1034 order to address the data structures which control visual display. A
78c0241306b5 Add documentation about when to use newplot (bug #40289). Rik <rik@octave.org> parents: 19602 diff changeset	1035 graphics handle may point to any one of a number of different base object
78c0241306b5 Add documentation about when to use newplot (bug #40289). Rik <rik@octave.org> parents: 19602 diff changeset	1036 types and these objects are the graphics data structures themselves. The
78c0241306b5 Add documentation about when to use newplot (bug #40289). Rik <rik@octave.org> parents: 19602 diff changeset	1037 primitive graphic object types are: @code{figure}, @code{axes}, @code{line},
78c0241306b5 Add documentation about when to use newplot (bug #40289). Rik <rik@octave.org> parents: 19602 diff changeset	1038 @code{text}, @code{patch}, @code{surface}, @code{text}, and @code{image}.
78c0241306b5 Add documentation about when to use newplot (bug #40289). Rik <rik@octave.org> parents: 19602 diff changeset	1039
78c0241306b5 Add documentation about when to use newplot (bug #40289). Rik <rik@octave.org> parents: 19602 diff changeset	1040 Each of these objects has a function by the same name, and, each of these
78c0241306b5 Add documentation about when to use newplot (bug #40289). Rik <rik@octave.org> parents: 19602 diff changeset	1041 functions returns a graphics handle pointing to an object of the corresponding
10846 a4f482e66b65 Grammarcheck more of the documentation. Rik <octave@nomad.inbox5.com> parents: 10828 diff changeset	1042 type. In addition there are several functions which operate on properties of
19657 78c0241306b5 Add documentation about when to use newplot (bug #40289). Rik <rik@octave.org> parents: 19602 diff changeset	1043 the graphics objects and which also return handles: the functions @code{plot}
78c0241306b5 Add documentation about when to use newplot (bug #40289). Rik <rik@octave.org> parents: 19602 diff changeset	1044 and @code{plot3} return a handle pointing to an object of type line, the
78c0241306b5 Add documentation about when to use newplot (bug #40289). Rik <rik@octave.org> parents: 19602 diff changeset	1045 function @code{subplot} returns a handle pointing to an object of type axes,
78c0241306b5 Add documentation about when to use newplot (bug #40289). Rik <rik@octave.org> parents: 19602 diff changeset	1046 the function @code{fill} returns a handle pointing to an object of type patch,
78c0241306b5 Add documentation about when to use newplot (bug #40289). Rik <rik@octave.org> parents: 19602 diff changeset	1047 the functions @code{area}, @code{bar}, @code{barh}, @code{contour},
10846 a4f482e66b65 Grammarcheck more of the documentation. Rik <octave@nomad.inbox5.com> parents: 10828 diff changeset	1048 @code{contourf}, @code{contour3}, @code{surf}, @code{mesh}, @code{surfc},
a4f482e66b65 Grammarcheck more of the documentation. Rik <octave@nomad.inbox5.com> parents: 10828 diff changeset	1049 @code{meshc}, @code{errorbar}, @code{quiver}, @code{quiver3}, @code{scatter},
a4f482e66b65 Grammarcheck more of the documentation. Rik <octave@nomad.inbox5.com> parents: 10828 diff changeset	1050 @code{scatter3}, @code{stair}, @code{stem}, @code{stem3} each return a handle
19657 78c0241306b5 Add documentation about when to use newplot (bug #40289). Rik <rik@octave.org> parents: 19602 diff changeset	1051 to a complex data structure as documented in
78c0241306b5 Add documentation about when to use newplot (bug #40289). Rik <rik@octave.org> parents: 19602 diff changeset	1052 @ref{XREFdatasources,,Data Sources}.
9672 43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	1053
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	1054 The graphics objects are arranged in a hierarchy:
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	1055
19657 78c0241306b5 Add documentation about when to use newplot (bug #40289). Rik <rik@octave.org> parents: 19602 diff changeset	1056 1. The root is at 0. In other words, @code{get (0)} returns the properties of
78c0241306b5 Add documentation about when to use newplot (bug #40289). Rik <rik@octave.org> parents: 19602 diff changeset	1057 the root object.
9672 43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	1058
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	1059 2. Below the root are @code{figure} objects.
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	1060
19657 78c0241306b5 Add documentation about when to use newplot (bug #40289). Rik <rik@octave.org> parents: 19602 diff changeset	1061 3. Below the @code{figure} objects are @code{axes} objects.
78c0241306b5 Add documentation about when to use newplot (bug #40289). Rik <rik@octave.org> parents: 19602 diff changeset	1062
78c0241306b5 Add documentation about when to use newplot (bug #40289). Rik <rik@octave.org> parents: 19602 diff changeset	1063 4. Below the @code{axes} objects are @code{line}, @code{text}, @code{patch},
9672 43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	1064 @code{surface}, and @code{image} objects.
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	1065
16814 64e7bb01fce2 doc: Improve documentation for 2-D plot functions Rik <rik@octave.org> parents: 16813 diff changeset	1066 Graphics handles may be distinguished from function handles
17097 e7a059a9a644 doc: Use XREF as anchor prefix in documentation for clearer results in Info viewer. Rik <rik@octave.org> parents: 16923 diff changeset	1067 (@pxref{Function Handles}) by means of the function @code{ishandle}.
17469 710b3d5fe966 improve interpreter tex Tables Michael Godfrey <michaeldgodfrey@gmail.com> parents: 17281 diff changeset	1068 @code{ishandle} returns true if its argument is a handle of a graphics object.
19657 78c0241306b5 Add documentation about when to use newplot (bug #40289). Rik <rik@octave.org> parents: 19602 diff changeset	1069 In addition, a figure or axes object may be tested using @code{isfigure} or
78c0241306b5 Add documentation about when to use newplot (bug #40289). Rik <rik@octave.org> parents: 19602 diff changeset	1070 @code{isaxes} respectively. The test functions return true only if the
78c0241306b5 Add documentation about when to use newplot (bug #40289). Rik <rik@octave.org> parents: 19602 diff changeset	1071 argument is both a handle and of the correct type (figure or axes).
78c0241306b5 Add documentation about when to use newplot (bug #40289). Rik <rik@octave.org> parents: 19602 diff changeset	1072
78c0241306b5 Add documentation about when to use newplot (bug #40289). Rik <rik@octave.org> parents: 19602 diff changeset	1073 The @code{whos} function can be used to show the object type of each currently
16814 64e7bb01fce2 doc: Improve documentation for 2-D plot functions Rik <rik@octave.org> parents: 16813 diff changeset	1074 defined graphics handle. (Note: this is not true today, but it is, I hope,
64e7bb01fce2 doc: Improve documentation for 2-D plot functions Rik <rik@octave.org> parents: 16813 diff changeset	1075 considered an error in whos. It may be better to have whos just show
64e7bb01fce2 doc: Improve documentation for 2-D plot functions Rik <rik@octave.org> parents: 16813 diff changeset	1076 graphics_handle as the class, and provide a new function which, given a
10828 322f43e0e170 Grammarcheck .txi documentation files. Rik <octave@nomad.inbox5.com> parents: 10711 diff changeset	1077 graphics handle, returns its object type. This could generalize the ishandle()
322f43e0e170 Grammarcheck .txi documentation files. Rik <octave@nomad.inbox5.com> parents: 10711 diff changeset	1078 functions and, in fact, replace them.)
9672 43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	1079
16814 64e7bb01fce2 doc: Improve documentation for 2-D plot functions Rik <rik@octave.org> parents: 16813 diff changeset	1080 The @code{get} and @code{set} commands are used to obtain and set the values of
64e7bb01fce2 doc: Improve documentation for 2-D plot functions Rik <rik@octave.org> parents: 16813 diff changeset	1081 properties of graphics objects. In addition, the @code{get} command may be
64e7bb01fce2 doc: Improve documentation for 2-D plot functions Rik <rik@octave.org> parents: 16813 diff changeset	1082 used to obtain property names.
10828 322f43e0e170 Grammarcheck .txi documentation files. Rik <octave@nomad.inbox5.com> parents: 10711 diff changeset	1083
17281 bc924baa2c4e doc: Add new @qcode macro for code samples which are quoted. Rik <rik@octave.org> parents: 17170 diff changeset	1084 For example, the property @qcode{"type"} of the graphics object pointed to by
bc924baa2c4e doc: Add new @qcode macro for code samples which are quoted. Rik <rik@octave.org> parents: 17170 diff changeset	1085 the graphics handle h may be displayed by:
9672 43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	1086
11444 08f8b0d96091 doc fixes John W. Eaton <jwe@octave.org> parents: 11382 diff changeset	1087 @example
08f8b0d96091 doc fixes John W. Eaton <jwe@octave.org> parents: 11382 diff changeset	1088 get (h, "type")
08f8b0d96091 doc fixes John W. Eaton <jwe@octave.org> parents: 11382 diff changeset	1089 @end example
08f8b0d96091 doc fixes John W. Eaton <jwe@octave.org> parents: 11382 diff changeset	1090
08f8b0d96091 doc fixes John W. Eaton <jwe@octave.org> parents: 11382 diff changeset	1091 The properties and their current values are returned by @code{get (h)}
9758 09da0bd91412 Periodic grammar check of Octave documentation files to ensure common format Rik <rdrider0-list@yahoo.com> parents: 9752 diff changeset	1092 where h is a handle of a graphics object. If only the names of the
9672 43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	1093 allowed properties are wanted they may be displayed by:
11444 08f8b0d96091 doc fixes John W. Eaton <jwe@octave.org> parents: 11382 diff changeset	1094 @code{get (h, "")}.
9672 43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	1095
17281 bc924baa2c4e doc: Add new @qcode macro for code samples which are quoted. Rik <rik@octave.org> parents: 17170 diff changeset	1096 Thus, for example:
11573 6f8ffe2c6f76 Grammarcheck txi files for 3.4 release. Rik <octave@nomad.inbox5.com> parents: 11523 diff changeset	1097
11444 08f8b0d96091 doc fixes John W. Eaton <jwe@octave.org> parents: 11382 diff changeset	1098 @smallexample
08f8b0d96091 doc fixes John W. Eaton <jwe@octave.org> parents: 11382 diff changeset	1099 h = figure ();
08f8b0d96091 doc fixes John W. Eaton <jwe@octave.org> parents: 11382 diff changeset	1100 get (h, "type")
9672 43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	1101 ans = figure
11444 08f8b0d96091 doc fixes John W. Eaton <jwe@octave.org> parents: 11382 diff changeset	1102 get (h, "");
9672 43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	1103 error: get: ambiguous figure property name ; possible matches:
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	1104
17957 e5566719e0a1 doc: Mention GUI in introduction. Update figure root properties. Michael Godfrey <michaeldgodfrey@gmail.com> parents: 17744 diff changeset	1105 __enhanced__ hittest resize
e5566719e0a1 doc: Mention GUI in introduction. Update figure root properties. Michael Godfrey <michaeldgodfrey@gmail.com> parents: 17744 diff changeset	1106 __graphics_toolkit__ integerhandle resizefcn
e5566719e0a1 doc: Mention GUI in introduction. Update figure root properties. Michael Godfrey <michaeldgodfrey@gmail.com> parents: 17744 diff changeset	1107 __guidata__ interruptible selected
e5566719e0a1 doc: Mention GUI in introduction. Update figure root properties. Michael Godfrey <michaeldgodfrey@gmail.com> parents: 17744 diff changeset	1108 __modified__ inverthardcopy selectionhighlight
e5566719e0a1 doc: Mention GUI in introduction. Update figure root properties. Michael Godfrey <michaeldgodfrey@gmail.com> parents: 17744 diff changeset	1109 __myhandle__ keypressfcn selectiontype
e5566719e0a1 doc: Mention GUI in introduction. Update figure root properties. Michael Godfrey <michaeldgodfrey@gmail.com> parents: 17744 diff changeset	1110 __plot_stream__ keyreleasefcn tag
e5566719e0a1 doc: Mention GUI in introduction. Update figure root properties. Michael Godfrey <michaeldgodfrey@gmail.com> parents: 17744 diff changeset	1111 alphamap menubar toolbar
e5566719e0a1 doc: Mention GUI in introduction. Update figure root properties. Michael Godfrey <michaeldgodfrey@gmail.com> parents: 17744 diff changeset	1112 beingdeleted mincolormap type
e5566719e0a1 doc: Mention GUI in introduction. Update figure root properties. Michael Godfrey <michaeldgodfrey@gmail.com> parents: 17744 diff changeset	1113 busyaction name uicontextmenu
e5566719e0a1 doc: Mention GUI in introduction. Update figure root properties. Michael Godfrey <michaeldgodfrey@gmail.com> parents: 17744 diff changeset	1114 buttondownfcn nextplot units
e5566719e0a1 doc: Mention GUI in introduction. Update figure root properties. Michael Godfrey <michaeldgodfrey@gmail.com> parents: 17744 diff changeset	1115 children numbertitle userdata
e5566719e0a1 doc: Mention GUI in introduction. Update figure root properties. Michael Godfrey <michaeldgodfrey@gmail.com> parents: 17744 diff changeset	1116 clipping outerposition visible
e5566719e0a1 doc: Mention GUI in introduction. Update figure root properties. Michael Godfrey <michaeldgodfrey@gmail.com> parents: 17744 diff changeset	1117 closerequestfcn paperorientation windowbuttondownfcn
e5566719e0a1 doc: Mention GUI in introduction. Update figure root properties. Michael Godfrey <michaeldgodfrey@gmail.com> parents: 17744 diff changeset	1118 color paperposition windowbuttonmotionfcn
e5566719e0a1 doc: Mention GUI in introduction. Update figure root properties. Michael Godfrey <michaeldgodfrey@gmail.com> parents: 17744 diff changeset	1119 colormap paperpositionmode windowbuttonupfcn
e5566719e0a1 doc: Mention GUI in introduction. Update figure root properties. Michael Godfrey <michaeldgodfrey@gmail.com> parents: 17744 diff changeset	1120 createfcn papersize windowkeypressfcn
e5566719e0a1 doc: Mention GUI in introduction. Update figure root properties. Michael Godfrey <michaeldgodfrey@gmail.com> parents: 17744 diff changeset	1121 currentaxes papertype windowkeyreleasefcn
e5566719e0a1 doc: Mention GUI in introduction. Update figure root properties. Michael Godfrey <michaeldgodfrey@gmail.com> parents: 17744 diff changeset	1122 currentcharacter paperunits windowscrollwheelfcn
e5566719e0a1 doc: Mention GUI in introduction. Update figure root properties. Michael Godfrey <michaeldgodfrey@gmail.com> parents: 17744 diff changeset	1123 currentobject parent windowstyle
e5566719e0a1 doc: Mention GUI in introduction. Update figure root properties. Michael Godfrey <michaeldgodfrey@gmail.com> parents: 17744 diff changeset	1124 currentpoint pointer wvisual
e5566719e0a1 doc: Mention GUI in introduction. Update figure root properties. Michael Godfrey <michaeldgodfrey@gmail.com> parents: 17744 diff changeset	1125 deletefcn pointershapecdata wvisualmode
e5566719e0a1 doc: Mention GUI in introduction. Update figure root properties. Michael Godfrey <michaeldgodfrey@gmail.com> parents: 17744 diff changeset	1126 dockcontrols pointershapehotspot xdisplay
e5566719e0a1 doc: Mention GUI in introduction. Update figure root properties. Michael Godfrey <michaeldgodfrey@gmail.com> parents: 17744 diff changeset	1127 doublebuffer position xvisual
e5566719e0a1 doc: Mention GUI in introduction. Update figure root properties. Michael Godfrey <michaeldgodfrey@gmail.com> parents: 17744 diff changeset	1128 filename renderer xvisualmode
e5566719e0a1 doc: Mention GUI in introduction. Update figure root properties. Michael Godfrey <michaeldgodfrey@gmail.com> parents: 17744 diff changeset	1129 handlevisibility renderermode
11444 08f8b0d96091 doc fixes John W. Eaton <jwe@octave.org> parents: 11382 diff changeset	1130 @end smallexample
9672 43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	1131
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	1132 The root figure has index 0. Its properties may be displayed by:
11444 08f8b0d96091 doc fixes John W. Eaton <jwe@octave.org> parents: 11382 diff changeset	1133 @code{get (0, "")}.
08f8b0d96091 doc fixes John W. Eaton <jwe@octave.org> parents: 11382 diff changeset	1134
08f8b0d96091 doc fixes John W. Eaton <jwe@octave.org> parents: 11382 diff changeset	1135 The uses of @code{get} and @code{set} are further explained in
17097 e7a059a9a644 doc: Use XREF as anchor prefix in documentation for clearer results in Info viewer. Rik <rik@octave.org> parents: 16923 diff changeset	1136 @ref{XREFget,,get}, @ref{XREFset,,set}.
9672 43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	1137
11380 5dfb6aab3513 document isprop John W. Eaton <jwe@octave.org> parents: 11365 diff changeset	1138 @DOCSTRING(isprop)
5dfb6aab3513 document isprop John W. Eaton <jwe@octave.org> parents: 11365 diff changeset	1139
6888 b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe] jwe parents: 6877 diff changeset	1140 @node Graphics Objects
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe] jwe parents: 6877 diff changeset	1141 @subsection Graphics Objects
9672 43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	1142 @cindex graphics objects
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	1143
17097 e7a059a9a644 doc: Use XREF as anchor prefix in documentation for clearer results in Info viewer. Rik <rik@octave.org> parents: 16923 diff changeset	1144 The hierarchy of graphics objects was explained above.
e7a059a9a644 doc: Use XREF as anchor prefix in documentation for clearer results in Info viewer. Rik <rik@octave.org> parents: 16923 diff changeset	1145 @xref{Introduction to Graphics Structures}. Here the
9672 43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	1146 specific objects are described, and the properties contained in
9758 09da0bd91412 Periodic grammar check of Octave documentation files to ensure common format Rik <rdrider0-list@yahoo.com> parents: 9752 diff changeset	1147 these objects are discussed. Keep in mind that
9672 43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	1148 graphics objects are always referenced by @dfn{handle}.
6888 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 @table @asis
9672 43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	1151 @c @group
10846 a4f482e66b65 Grammarcheck more of the documentation. Rik <octave@nomad.inbox5.com> parents: 10828 diff changeset	1152
6888 b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe] jwe parents: 6877 diff changeset	1153 @item root figure
8071 b6e85fb238c1 doc fixes John W. Eaton <jwe@octave.org> parents: 8070 diff changeset	1154 @cindex root figure graphics object
b6e85fb238c1 doc fixes John W. Eaton <jwe@octave.org> parents: 8070 diff changeset	1155 @cindex graphics object, root figure
9672 43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	1156 the top level of the hierarchy and the parent of all figure objects.
16814 64e7bb01fce2 doc: Improve documentation for 2-D plot functions Rik <rik@octave.org> parents: 16813 diff changeset	1157 The handle index of the root figure is 0.
6888 b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe] jwe parents: 6877 diff changeset	1158
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe] jwe parents: 6877 diff changeset	1159 @item figure
8071 b6e85fb238c1 doc fixes John W. Eaton <jwe@octave.org> parents: 8070 diff changeset	1160 @cindex figure graphics object
b6e85fb238c1 doc fixes John W. Eaton <jwe@octave.org> parents: 8070 diff changeset	1161 @cindex graphics object, figure
6888 b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe] jwe parents: 6877 diff changeset	1162 A figure window.
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe] jwe parents: 6877 diff changeset	1163
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe] jwe parents: 6877 diff changeset	1164 @item axes
8071 b6e85fb238c1 doc fixes John W. Eaton <jwe@octave.org> parents: 8070 diff changeset	1165 @cindex axes graphics object
b6e85fb238c1 doc fixes John W. Eaton <jwe@octave.org> parents: 8070 diff changeset	1166 @cindex graphics object, axes
9316 c539ec5726e7 Update some of Advanced Plotting documentation. Rik <rdrider0-list@yahoo.com> parents: 9209 diff changeset	1167 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	1168 parent of line, text, image, patch, or surface objects.
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe] jwe parents: 6877 diff changeset	1169
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe] jwe parents: 6877 diff changeset	1170 @item line
8071 b6e85fb238c1 doc fixes John W. Eaton <jwe@octave.org> parents: 8070 diff changeset	1171 @cindex line graphics object
b6e85fb238c1 doc fixes John W. Eaton <jwe@octave.org> parents: 8070 diff changeset	1172 @cindex graphics object, line
6888 b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe] jwe parents: 6877 diff changeset	1173 A line in two or three dimensions.
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe] jwe parents: 6877 diff changeset	1174
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe] jwe parents: 6877 diff changeset	1175 @item text
8071 b6e85fb238c1 doc fixes John W. Eaton <jwe@octave.org> parents: 8070 diff changeset	1176 @cindex text graphics object
b6e85fb238c1 doc fixes John W. Eaton <jwe@octave.org> parents: 8070 diff changeset	1177 @cindex graphics object, text
6888 b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe] jwe parents: 6877 diff changeset	1178 Text annotations.
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe] jwe parents: 6877 diff changeset	1179
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe] jwe parents: 6877 diff changeset	1180 @item image
8071 b6e85fb238c1 doc fixes John W. Eaton <jwe@octave.org> parents: 8070 diff changeset	1181 @cindex image graphics object
b6e85fb238c1 doc fixes John W. Eaton <jwe@octave.org> parents: 8070 diff changeset	1182 @cindex graphics object, image
6888 b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe] jwe parents: 6877 diff changeset	1183 A bitmap image.
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe] jwe parents: 6877 diff changeset	1184
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe] jwe parents: 6877 diff changeset	1185 @item patch
8071 b6e85fb238c1 doc fixes John W. Eaton <jwe@octave.org> parents: 8070 diff changeset	1186 @cindex patch graphics object
b6e85fb238c1 doc fixes John W. Eaton <jwe@octave.org> parents: 8070 diff changeset	1187 @cindex graphics object, patch
6888 b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe] jwe parents: 6877 diff changeset	1188 A filled polygon, currently limited to two dimensions.
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe] jwe parents: 6877 diff changeset	1189
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe] jwe parents: 6877 diff changeset	1190 @item surface
8071 b6e85fb238c1 doc fixes John W. Eaton <jwe@octave.org> parents: 8070 diff changeset	1191 @cindex surface graphics object
9672 43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	1192 @cindex graphics object, surface
6888 b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe] jwe parents: 6877 diff changeset	1193 A three-dimensional surface.
9672 43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	1194 @c @end group
6888 b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe] jwe parents: 6877 diff changeset	1195 @end table
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe] jwe parents: 6877 diff changeset	1196
16923 5d08a2ec7edb doc: Move graphics object functions into the right section Mike Miller <mtmiller@ieee.org> parents: 16814 diff changeset	1197 @subsubsection Creating Graphics Objects
5d08a2ec7edb doc: Move graphics object functions into the right section Mike Miller <mtmiller@ieee.org> parents: 16814 diff changeset	1198 @cindex creating graphics objects
5d08a2ec7edb doc: Move graphics object functions into the right section Mike Miller <mtmiller@ieee.org> parents: 16814 diff changeset	1199
19657 78c0241306b5 Add documentation about when to use newplot (bug #40289). Rik <rik@octave.org> parents: 19602 diff changeset	1200 You can create any graphics object primitive by calling the function of the
78c0241306b5 Add documentation about when to use newplot (bug #40289). Rik <rik@octave.org> parents: 19602 diff changeset	1201 same name as the object; In other words, @code{figure}, @code{axes},
78c0241306b5 Add documentation about when to use newplot (bug #40289). Rik <rik@octave.org> parents: 19602 diff changeset	1202 @code{line}, @code{text}, @code{image}, @code{patch}, and @code{surface}
78c0241306b5 Add documentation about when to use newplot (bug #40289). Rik <rik@octave.org> parents: 19602 diff changeset	1203 functions. These fundamental graphic objects automatically become children
78c0241306b5 Add documentation about when to use newplot (bug #40289). Rik <rik@octave.org> parents: 19602 diff changeset	1204 of the current axes object as if @code{hold on} was in place. Seperately, axes
78c0241306b5 Add documentation about when to use newplot (bug #40289). Rik <rik@octave.org> parents: 19602 diff changeset	1205 will automatically become children of the current figure object and figures
78c0241306b5 Add documentation about when to use newplot (bug #40289). Rik <rik@octave.org> parents: 19602 diff changeset	1206 will become children of the root object 0.
78c0241306b5 Add documentation about when to use newplot (bug #40289). Rik <rik@octave.org> parents: 19602 diff changeset	1207
78c0241306b5 Add documentation about when to use newplot (bug #40289). Rik <rik@octave.org> parents: 19602 diff changeset	1208 If this auto-joining feature is not desired then it is important to call
78c0241306b5 Add documentation about when to use newplot (bug #40289). Rik <rik@octave.org> parents: 19602 diff changeset	1209 @code{newplot} first to prepare a new figure and axes for plotting.
78c0241306b5 Add documentation about when to use newplot (bug #40289). Rik <rik@octave.org> parents: 19602 diff changeset	1210 Alternatively, the easier way is to call a high-level graphics routine which
78c0241306b5 Add documentation about when to use newplot (bug #40289). Rik <rik@octave.org> parents: 19602 diff changeset	1211 will both create the plot and then populate it with low-level graphics objects.
78c0241306b5 Add documentation about when to use newplot (bug #40289). Rik <rik@octave.org> parents: 19602 diff changeset	1212 Instead of calling @code{line}, use @code{plot}. Or use @code{surf} instead of
78c0241306b5 Add documentation about when to use newplot (bug #40289). Rik <rik@octave.org> parents: 19602 diff changeset	1213 @code{surface}. Or use @code{fill} instead of @code{patch}.
16923 5d08a2ec7edb doc: Move graphics object functions into the right section Mike Miller <mtmiller@ieee.org> parents: 16814 diff changeset	1214
5d08a2ec7edb doc: Move graphics object functions into the right section Mike Miller <mtmiller@ieee.org> parents: 16814 diff changeset	1215 @DOCSTRING(axes)
5d08a2ec7edb doc: Move graphics object functions into the right section Mike Miller <mtmiller@ieee.org> parents: 16814 diff changeset	1216
5d08a2ec7edb doc: Move graphics object functions into the right section Mike Miller <mtmiller@ieee.org> parents: 16814 diff changeset	1217 @DOCSTRING(line)
5d08a2ec7edb doc: Move graphics object functions into the right section Mike Miller <mtmiller@ieee.org> parents: 16814 diff changeset	1218
5d08a2ec7edb doc: Move graphics object functions into the right section Mike Miller <mtmiller@ieee.org> parents: 16814 diff changeset	1219 @DOCSTRING(patch)
5d08a2ec7edb doc: Move graphics object functions into the right section Mike Miller <mtmiller@ieee.org> parents: 16814 diff changeset	1220
5d08a2ec7edb doc: Move graphics object functions into the right section Mike Miller <mtmiller@ieee.org> parents: 16814 diff changeset	1221 @DOCSTRING(surface)
5d08a2ec7edb doc: Move graphics object functions into the right section Mike Miller <mtmiller@ieee.org> parents: 16814 diff changeset	1222
9672 43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	1223 @subsubsection Handle Functions
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	1224 @cindex handle functions
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	1225
17123 bcada0a4f8a7 isaxes.m: New function to determine if object is axes handle. Rik <rik@octave.org> parents: 17122 diff changeset	1226 To determine whether a variable is a graphics object index, or an index
bcada0a4f8a7 isaxes.m: New function to determine if object is axes handle. Rik <rik@octave.org> parents: 17122 diff changeset	1227 to an axes or figure, use the functions @code{ishandle}, @code{isaxes}, and
bcada0a4f8a7 isaxes.m: New function to determine if object is axes handle. Rik <rik@octave.org> parents: 17122 diff changeset	1228 @code{isfigure}.
6888 b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe] jwe parents: 6877 diff changeset	1229
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe] jwe parents: 6877 diff changeset	1230 @DOCSTRING(ishandle)
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe] jwe parents: 6877 diff changeset	1231
8817 03b7f618ab3d include docstrings for new functions in the manual John W. Eaton <jwe@octave.org> parents: 8519 diff changeset	1232 @DOCSTRING(ishghandle)
03b7f618ab3d include docstrings for new functions in the manual John W. Eaton <jwe@octave.org> parents: 8519 diff changeset	1233
17123 bcada0a4f8a7 isaxes.m: New function to determine if object is axes handle. Rik <rik@octave.org> parents: 17122 diff changeset	1234 @DOCSTRING(isaxes)
bcada0a4f8a7 isaxes.m: New function to determine if object is axes handle. Rik <rik@octave.org> parents: 17122 diff changeset	1235
6888 b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe] jwe parents: 6877 diff changeset	1236 @DOCSTRING(isfigure)
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe] jwe parents: 6877 diff changeset	1237
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe] jwe parents: 6877 diff changeset	1238 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	1239 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	1240 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	1241 none exists.
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe] jwe parents: 6877 diff changeset	1242
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe] jwe parents: 6877 diff changeset	1243 @DOCSTRING(gcf)
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe] jwe parents: 6877 diff changeset	1244
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe] jwe parents: 6877 diff changeset	1245 @DOCSTRING(gca)
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe] jwe parents: 6877 diff changeset	1246
16808 772f51539af8 doc: Add gco() to documentation. Rik <rik@octave.org> parents: 16802 diff changeset	1247 @DOCSTRING(gco)
772f51539af8 doc: Add gco() to documentation. Rik <rik@octave.org> parents: 16802 diff changeset	1248
6888 b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe] jwe parents: 6877 diff changeset	1249 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	1250 properties for graphics objects. For example,
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe] jwe parents: 6877 diff changeset	1251
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe] jwe parents: 6877 diff changeset	1252 @example
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe] jwe parents: 6877 diff changeset	1253 @group
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe] jwe parents: 6877 diff changeset	1254 get (0)
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe] jwe parents: 6877 diff changeset	1255 @result{} ans =
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe] jwe parents: 6877 diff changeset	1256 @{
9316 c539ec5726e7 Update some of Advanced Plotting documentation. Rik <rdrider0-list@yahoo.com> parents: 9209 diff changeset	1257 type = root
6888 b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe] jwe parents: 6877 diff changeset	1258 currentfigure = [](0x0)
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe] jwe parents: 6877 diff changeset	1259 children = [](0x0)
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe] jwe parents: 6877 diff changeset	1260 visible = on
10599 d0e0bb2ebebb Remove tabs in .txi files causing problems with pdf formatting. Rik <octave@nomad.inbox5.com> parents: 10522 diff changeset	1261 @dots{}
6888 b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe] jwe parents: 6877 diff changeset	1262 @}
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe] jwe parents: 6877 diff changeset	1263 @end group
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe] jwe parents: 6877 diff changeset	1264 @end example
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe] jwe parents: 6877 diff changeset	1265
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe] jwe parents: 6877 diff changeset	1266 @noindent
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe] jwe parents: 6877 diff changeset	1267 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	1268 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	1269 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	1270 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	1271 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	1272 there is no current figure window.
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe] jwe parents: 6877 diff changeset	1273
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe] jwe parents: 6877 diff changeset	1274 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	1275 property. For example,
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe] jwe parents: 6877 diff changeset	1276
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe] jwe parents: 6877 diff changeset	1277 @example
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe] jwe parents: 6877 diff changeset	1278 @group
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe] jwe parents: 6877 diff changeset	1279 get (gca (), "xlim")
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe] jwe parents: 6877 diff changeset	1280 @result{} [ 0 1 ]
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe] jwe parents: 6877 diff changeset	1281 @end group
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe] jwe parents: 6877 diff changeset	1282 @end example
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe] jwe parents: 6877 diff changeset	1283
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe] jwe parents: 6877 diff changeset	1284 @noindent
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe] jwe parents: 6877 diff changeset	1285 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	1286 current figure.
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe] jwe parents: 6877 diff changeset	1287
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe] jwe parents: 6877 diff changeset	1288 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	1289
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe] jwe parents: 6877 diff changeset	1290 @example
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe] jwe parents: 6877 diff changeset	1291 set (gca (), "xlim", [-10, 10]);
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe] jwe parents: 6877 diff changeset	1292 @end example
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe] jwe parents: 6877 diff changeset	1293
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe] jwe parents: 6877 diff changeset	1294 @noindent
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe] jwe parents: 6877 diff changeset	1295 sets the range of the x-axis for the current axes object in the current
18150 1c22f0465c74 doc: Add documentation about using set() to get default graphic properties. Rik <rik@octave.org> parents: 18078 diff changeset	1296 figure to @samp{[-10, 10]}.
1c22f0465c74 doc: Add documentation about using set() to get default graphic properties. Rik <rik@octave.org> parents: 18078 diff changeset	1297
1c22f0465c74 doc: Add documentation about using set() to get default graphic properties. Rik <rik@octave.org> parents: 18078 diff changeset	1298 Default property values can also be queried if the @code{set} function is
1c22f0465c74 doc: Add documentation about using set() to get default graphic properties. Rik <rik@octave.org> parents: 18078 diff changeset	1299 called without a value argument. When only one argument is given (a graphic
1c22f0465c74 doc: Add documentation about using set() to get default graphic properties. Rik <rik@octave.org> parents: 18078 diff changeset	1300 handle) then a structure with defaults for all properties of the given object
1c22f0465c74 doc: Add documentation about using set() to get default graphic properties. Rik <rik@octave.org> parents: 18078 diff changeset	1301 type is returned. For example,
6888 b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe] jwe parents: 6877 diff changeset	1302
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe] jwe parents: 6877 diff changeset	1303 @example
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe] jwe parents: 6877 diff changeset	1304 set (gca ())
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe] jwe parents: 6877 diff changeset	1305 @end example
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe] jwe parents: 6877 diff changeset	1306
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe] jwe parents: 6877 diff changeset	1307 @noindent
18150 1c22f0465c74 doc: Add documentation about using set() to get default graphic properties. Rik <rik@octave.org> parents: 18078 diff changeset	1308 returns a structure containing the default property values for axes objects.
1c22f0465c74 doc: Add documentation about using set() to get default graphic properties. Rik <rik@octave.org> parents: 18078 diff changeset	1309 If @code{set} is called with two arguments (a graphic handle and a property
1c22f0465c74 doc: Add documentation about using set() to get default graphic properties. Rik <rik@octave.org> parents: 18078 diff changeset	1310 name) then only the defaults for the requested property are returned.
6888 b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe] jwe parents: 6877 diff changeset	1311
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe] jwe parents: 6877 diff changeset	1312 @DOCSTRING(get)
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe] jwe parents: 6877 diff changeset	1313
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe] jwe parents: 6877 diff changeset	1314 @DOCSTRING(set)
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe] jwe parents: 6877 diff changeset	1315
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe] jwe parents: 6877 diff changeset	1316 @DOCSTRING(ancestor)
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe] jwe parents: 6877 diff changeset	1317
7984 bbaa5d7d0143 Some documentation updates David Bateman <dbateman@free.fr> parents: 7981 diff changeset	1318 @DOCSTRING(allchild)
bbaa5d7d0143 Some documentation updates David Bateman <dbateman@free.fr> parents: 7981 diff changeset	1319
14577 447038c2dde8 Add findfigs.m docstring to plot.txi Carnë Draug <carandraug+dev@gmail.com> parents: 14574 diff changeset	1320 @DOCSTRING(findfigs)
447038c2dde8 Add findfigs.m docstring to plot.txi Carnë Draug <carandraug+dev@gmail.com> parents: 14574 diff changeset	1321
16813 81e041f5633a doc: Add copyobj, struct2hdl, hdl2struct to manual. Rik <rik@octave.org> parents: 16808 diff changeset	1322 @cindex saving graphics objects
18398 200851c87444 Edits to Manual and indicies Michael Godfrey <michaeldgodfrey@gmail.com> parents: 17957 diff changeset	1323 @cindex graphics objects, saving
16813 81e041f5633a doc: Add copyobj, struct2hdl, hdl2struct to manual. Rik <rik@octave.org> parents: 16808 diff changeset	1324
81e041f5633a doc: Add copyobj, struct2hdl, hdl2struct to manual. Rik <rik@octave.org> parents: 16808 diff changeset	1325 Figures can be printed or saved in many graphics formats with @code{print} and
81e041f5633a doc: Add copyobj, struct2hdl, hdl2struct to manual. Rik <rik@octave.org> parents: 16808 diff changeset	1326 @code{saveas}. Occasionally, however, it may be useful to save the original
81e041f5633a doc: Add copyobj, struct2hdl, hdl2struct to manual. Rik <rik@octave.org> parents: 16808 diff changeset	1327 Octave handle graphic directly so that further modifications can be made such
17469 710b3d5fe966 improve interpreter tex Tables Michael Godfrey <michaeldgodfrey@gmail.com> parents: 17281 diff changeset	1328 as modifying a title or legend.
710b3d5fe966 improve interpreter tex Tables Michael Godfrey <michaeldgodfrey@gmail.com> parents: 17281 diff changeset	1329
710b3d5fe966 improve interpreter tex Tables Michael Godfrey <michaeldgodfrey@gmail.com> parents: 17281 diff changeset	1330 This can be accomplished with the following functions by
16813 81e041f5633a doc: Add copyobj, struct2hdl, hdl2struct to manual. Rik <rik@octave.org> parents: 16808 diff changeset	1331
81e041f5633a doc: Add copyobj, struct2hdl, hdl2struct to manual. Rik <rik@octave.org> parents: 16808 diff changeset	1332 @example
81e041f5633a doc: Add copyobj, struct2hdl, hdl2struct to manual. Rik <rik@octave.org> parents: 16808 diff changeset	1333 @group
81e041f5633a doc: Add copyobj, struct2hdl, hdl2struct to manual. Rik <rik@octave.org> parents: 16808 diff changeset	1334 fig_struct = hdl2struct (gcf);
81e041f5633a doc: Add copyobj, struct2hdl, hdl2struct to manual. Rik <rik@octave.org> parents: 16808 diff changeset	1335 save myplot.fig -struct fig_struct;
81e041f5633a doc: Add copyobj, struct2hdl, hdl2struct to manual. Rik <rik@octave.org> parents: 16808 diff changeset	1336 @dots{}
81e041f5633a doc: Add copyobj, struct2hdl, hdl2struct to manual. Rik <rik@octave.org> parents: 16808 diff changeset	1337 fig_struct = load ("myplot.fig");
81e041f5633a doc: Add copyobj, struct2hdl, hdl2struct to manual. Rik <rik@octave.org> parents: 16808 diff changeset	1338 struct2hdl (fig_struct);
81e041f5633a doc: Add copyobj, struct2hdl, hdl2struct to manual. Rik <rik@octave.org> parents: 16808 diff changeset	1339 @end group
81e041f5633a doc: Add copyobj, struct2hdl, hdl2struct to manual. Rik <rik@octave.org> parents: 16808 diff changeset	1340 @end example
81e041f5633a doc: Add copyobj, struct2hdl, hdl2struct to manual. Rik <rik@octave.org> parents: 16808 diff changeset	1341
81e041f5633a doc: Add copyobj, struct2hdl, hdl2struct to manual. Rik <rik@octave.org> parents: 16808 diff changeset	1342 @DOCSTRING(hdl2struct)
81e041f5633a doc: Add copyobj, struct2hdl, hdl2struct to manual. Rik <rik@octave.org> parents: 16808 diff changeset	1343
81e041f5633a doc: Add copyobj, struct2hdl, hdl2struct to manual. Rik <rik@octave.org> parents: 16808 diff changeset	1344 @DOCSTRING(struct2hdl)
81e041f5633a doc: Add copyobj, struct2hdl, hdl2struct to manual. Rik <rik@octave.org> parents: 16808 diff changeset	1345
81e041f5633a doc: Add copyobj, struct2hdl, hdl2struct to manual. Rik <rik@octave.org> parents: 16808 diff changeset	1346 @DOCSTRING(copyobj)
81e041f5633a doc: Add copyobj, struct2hdl, hdl2struct to manual. Rik <rik@octave.org> parents: 16808 diff changeset	1347
6888 b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe] jwe parents: 6877 diff changeset	1348 @node Graphics Object Properties
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe] jwe parents: 6877 diff changeset	1349 @subsection Graphics Object Properties
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe] jwe parents: 6877 diff changeset	1350 @cindex graphics object properties
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe] jwe parents: 6877 diff changeset	1351
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe] jwe parents: 6877 diff changeset	1352 @menu
17152 f2a8592b8fbd doc: Shorten some long subsection names in Manual. Rik <rik@octave.org> parents: 17123 diff changeset	1353 * Root Figure Properties::
f2a8592b8fbd doc: Shorten some long subsection names in Manual. Rik <rik@octave.org> parents: 17123 diff changeset	1354 * Figure Properties::
f2a8592b8fbd doc: Shorten some long subsection names in Manual. Rik <rik@octave.org> parents: 17123 diff changeset	1355 * Axes Properties::
f2a8592b8fbd doc: Shorten some long subsection names in Manual. Rik <rik@octave.org> parents: 17123 diff changeset	1356 * Line Properties::
f2a8592b8fbd doc: Shorten some long subsection names in Manual. Rik <rik@octave.org> parents: 17123 diff changeset	1357 * Text Properties::
f2a8592b8fbd doc: Shorten some long subsection names in Manual. Rik <rik@octave.org> parents: 17123 diff changeset	1358 * Image Properties::
f2a8592b8fbd doc: Shorten some long subsection names in Manual. Rik <rik@octave.org> parents: 17123 diff changeset	1359 * Patch Properties::
f2a8592b8fbd doc: Shorten some long subsection names in Manual. Rik <rik@octave.org> parents: 17123 diff changeset	1360 * Surface Properties::
6888 b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe] jwe parents: 6877 diff changeset	1361 @end menu
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe] jwe parents: 6877 diff changeset	1362
19449 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 19344 diff changeset	1363 In this Section the graphics object properties are discussed in detail, starting
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 19344 diff changeset	1364 with the root figure properties and continuing through the objects
19794 db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19793 diff changeset	1365 hierarchy. The documentation about a specific graphics object can be displayed
db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19793 diff changeset	1366 using @code{doc} function, e.g., @code{doc ("axes properties")} will show
db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19793 diff changeset	1367 @ref{Axes Properties}.
db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19793 diff changeset	1368
db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19793 diff changeset	1369 The allowed values for radio (string) properties can be retrieved
db92e7e28e1f strip trailing whitespace from most source files John W. Eaton <jwe@octave.org> parents: 19793 diff changeset	1370 programmatically or displayed using the one or
19602 cbce5d1bcaf9 doc: Periodic grammarcheck of documentation. Rik <rik@octave.org> parents: 19504 diff changeset	1371 two arguments call to @code{set} function. @xref{XREFset, , set}.
19449 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 19344 diff changeset	1372
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 19344 diff changeset	1373 In the following documentation, default values are enclosed in @{ @}.
9672 43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	1374
6888 b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe] jwe parents: 6877 diff changeset	1375 @node Root Figure Properties
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe] jwe parents: 6877 diff changeset	1376 @subsubsection Root Figure Properties
9672 43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	1377 @cindex root figure properties
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	1378
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	1379 The @code{root figure} properties are:
14853 72b8b39e12be doc: Periodic grammarcheck of documentation. Rik <octave@nomad.inbox5.com> parents: 14577 diff changeset	1380
19449 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 19344 diff changeset	1381 @include plot-rootproperties.texi
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 19344 diff changeset	1382
6888 b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe] jwe parents: 6877 diff changeset	1383
6889 ebff56d6b0a8 [project @ 2007-09-12 18:32:12 by jwe] jwe parents: 6888 diff changeset	1384 @node Figure Properties
ebff56d6b0a8 [project @ 2007-09-12 18:32:12 by jwe] jwe parents: 6888 diff changeset	1385 @subsubsection Figure Properties
8071 b6e85fb238c1 doc fixes John W. Eaton <jwe@octave.org> parents: 8070 diff changeset	1386 @cindex figure properties
6888 b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe] jwe parents: 6877 diff changeset	1387
9672 43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	1388 The @code{figure} properties are:
14853 72b8b39e12be doc: Periodic grammarcheck of documentation. Rik <octave@nomad.inbox5.com> parents: 14577 diff changeset	1389
19449 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 19344 diff changeset	1390 @include plot-figureproperties.texi
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 19344 diff changeset	1391
6888 b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe] jwe parents: 6877 diff changeset	1392
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe] jwe parents: 6877 diff changeset	1393 @node Axes Properties
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe] jwe parents: 6877 diff changeset	1394 @subsubsection Axes Properties
8071 b6e85fb238c1 doc fixes John W. Eaton <jwe@octave.org> parents: 8070 diff changeset	1395 @cindex axes properties
6888 b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe] jwe parents: 6877 diff changeset	1396
9672 43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	1397 The @code{axes} properties are:
14853 72b8b39e12be doc: Periodic grammarcheck of documentation. Rik <octave@nomad.inbox5.com> parents: 14577 diff changeset	1398
19449 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 19344 diff changeset	1399 @include plot-axesproperties.texi
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 19344 diff changeset	1400
6888 b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe] jwe parents: 6877 diff changeset	1401
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe] jwe parents: 6877 diff changeset	1402 @node Line Properties
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe] jwe parents: 6877 diff changeset	1403 @subsubsection Line Properties
8071 b6e85fb238c1 doc fixes John W. Eaton <jwe@octave.org> parents: 8070 diff changeset	1404 @cindex line properties
6888 b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe] jwe parents: 6877 diff changeset	1405
9672 43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	1406 The @code{line} properties are:
14853 72b8b39e12be doc: Periodic grammarcheck of documentation. Rik <octave@nomad.inbox5.com> parents: 14577 diff changeset	1407
19449 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 19344 diff changeset	1408 @include plot-lineproperties.texi
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 19344 diff changeset	1409
6888 b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe] jwe parents: 6877 diff changeset	1410
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe] jwe parents: 6877 diff changeset	1411 @node Text Properties
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe] jwe parents: 6877 diff changeset	1412 @subsubsection Text Properties
8071 b6e85fb238c1 doc fixes John W. Eaton <jwe@octave.org> parents: 8070 diff changeset	1413 @cindex text properties
6888 b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe] jwe parents: 6877 diff changeset	1414
9672 43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	1415 The @code{text} properties are:
14853 72b8b39e12be doc: Periodic grammarcheck of documentation. Rik <octave@nomad.inbox5.com> parents: 14577 diff changeset	1416
19449 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 19344 diff changeset	1417 @include plot-textproperties.texi
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 19344 diff changeset	1418
6888 b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe] jwe parents: 6877 diff changeset	1419
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe] jwe parents: 6877 diff changeset	1420 @node Image Properties
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe] jwe parents: 6877 diff changeset	1421 @subsubsection Image Properties
8071 b6e85fb238c1 doc fixes John W. Eaton <jwe@octave.org> parents: 8070 diff changeset	1422 @cindex image properties
6888 b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe] jwe parents: 6877 diff changeset	1423
9672 43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	1424 The @code{image} properties are:
14853 72b8b39e12be doc: Periodic grammarcheck of documentation. Rik <octave@nomad.inbox5.com> parents: 14577 diff changeset	1425
19449 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 19344 diff changeset	1426 @include plot-imageproperties.texi
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 19344 diff changeset	1427
6888 b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe] jwe parents: 6877 diff changeset	1428
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe] jwe parents: 6877 diff changeset	1429 @node Patch Properties
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe] jwe parents: 6877 diff changeset	1430 @subsubsection Patch Properties
8071 b6e85fb238c1 doc fixes John W. Eaton <jwe@octave.org> parents: 8070 diff changeset	1431 @cindex patch properties
6888 b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe] jwe parents: 6877 diff changeset	1432
9672 43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	1433 The @code{patch} properties are:
14853 72b8b39e12be doc: Periodic grammarcheck of documentation. Rik <octave@nomad.inbox5.com> parents: 14577 diff changeset	1434
19449 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 19344 diff changeset	1435 @include plot-patchproperties.texi
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 19344 diff changeset	1436
6888 b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe] jwe parents: 6877 diff changeset	1437
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe] jwe parents: 6877 diff changeset	1438 @node Surface Properties
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe] jwe parents: 6877 diff changeset	1439 @subsubsection Surface Properties
8071 b6e85fb238c1 doc fixes John W. Eaton <jwe@octave.org> parents: 8070 diff changeset	1440 @cindex surface properties
6888 b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe] jwe parents: 6877 diff changeset	1441
9672 43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	1442 The @code{surface} properties are:
14853 72b8b39e12be doc: Periodic grammarcheck of documentation. Rik <octave@nomad.inbox5.com> parents: 14577 diff changeset	1443
19449 1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 19344 diff changeset	1444 @include plot-surfaceproperties.texi
1f2a16d41ba2 Automatically generate graphics properties documentation (bug #42536) Pantxo Diribarne <pantxo.diribarne@gmail.com> parents: 19344 diff changeset	1445
6889 ebff56d6b0a8 [project @ 2007-09-12 18:32:12 by jwe] jwe parents: 6888 diff changeset	1446
8070 3b53b25e2550 Add data sources and line series David Bateman <dbateman@free.fr> parents: 8057 diff changeset	1447 @node Searching Properties
9672 43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	1448 @subsection Searching Properties
7984 bbaa5d7d0143 Some documentation updates David Bateman <dbateman@free.fr> parents: 7981 diff changeset	1449
bbaa5d7d0143 Some documentation updates David Bateman <dbateman@free.fr> parents: 7981 diff changeset	1450 @DOCSTRING(findobj)
bbaa5d7d0143 Some documentation updates David Bateman <dbateman@free.fr> parents: 7981 diff changeset	1451
bbaa5d7d0143 Some documentation updates David Bateman <dbateman@free.fr> parents: 7981 diff changeset	1452 @DOCSTRING(findall)
6891 e9921bb3d95b [project @ 2007-09-13 02:44:27 by jwe] jwe parents: 6889 diff changeset	1453 @node Managing Default Properties
e9921bb3d95b [project @ 2007-09-13 02:44:27 by jwe] jwe parents: 6889 diff changeset	1454 @subsection Managing Default Properties
8071 b6e85fb238c1 doc fixes John W. Eaton <jwe@octave.org> parents: 8070 diff changeset	1455 @cindex default graphics properties
b6e85fb238c1 doc fixes John W. Eaton <jwe@octave.org> parents: 8070 diff changeset	1456 @cindex graphics properties, default
6891 e9921bb3d95b [project @ 2007-09-13 02:44:27 by jwe] jwe parents: 6889 diff changeset	1457
6892 29fa8673d8d1 [project @ 2007-09-13 07:36:52 by jwe] jwe parents: 6891 diff changeset	1458 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	1459 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	1460 may override the factory defaults.
6891 e9921bb3d95b [project @ 2007-09-13 02:44:27 by jwe] jwe parents: 6889 diff changeset	1461
e9921bb3d95b [project @ 2007-09-13 02:44:27 by jwe] jwe parents: 6889 diff changeset	1462 Although default values may be set for any object, they are set in
12610 bdf694af4aa5 plot.txi: Clarify that inheritance of default property values only applies to the named object type. Ben Abbott <bpabbott@mac.com> parents: 12578 diff changeset	1463 parent objects and apply to child objects, of the specified object type.
13931 9de488c6c59c doc: Spellcheck documentation before 3.6.0 release Rik <octave@nomad.inbox5.com> parents: 12763 diff changeset	1464 For example, setting the default @code{color} property of @code{line}
17281 bc924baa2c4e doc: Add new @qcode macro for code samples which are quoted. Rik <rik@octave.org> parents: 17170 diff changeset	1465 objects to @qcode{"green"}, for the @code{root} object, will result in all
bc924baa2c4e doc: Add new @qcode macro for code samples which are quoted. Rik <rik@octave.org> parents: 17170 diff changeset	1466 @code{line} objects inheriting the @code{color} @qcode{"green"} as the default
12610 bdf694af4aa5 plot.txi: Clarify that inheritance of default property values only applies to the named object type. Ben Abbott <bpabbott@mac.com> parents: 12578 diff changeset	1467 value.
6891 e9921bb3d95b [project @ 2007-09-13 02:44:27 by jwe] jwe parents: 6889 diff changeset	1468
e9921bb3d95b [project @ 2007-09-13 02:44:27 by jwe] jwe parents: 6889 diff changeset	1469 @example
e9921bb3d95b [project @ 2007-09-13 02:44:27 by jwe] jwe parents: 6889 diff changeset	1470 set (0, "defaultlinecolor", "green");
e9921bb3d95b [project @ 2007-09-13 02:44:27 by jwe] jwe parents: 6889 diff changeset	1471 @end example
e9921bb3d95b [project @ 2007-09-13 02:44:27 by jwe] jwe parents: 6889 diff changeset	1472
e9921bb3d95b [project @ 2007-09-13 02:44:27 by jwe] jwe parents: 6889 diff changeset	1473 @noindent
e9921bb3d95b [project @ 2007-09-13 02:44:27 by jwe] jwe parents: 6889 diff changeset	1474 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	1475 the property name to set a default value is
e9921bb3d95b [project @ 2007-09-13 02:44:27 by jwe] jwe parents: 6889 diff changeset	1476
e9921bb3d95b [project @ 2007-09-13 02:44:27 by jwe] jwe parents: 6889 diff changeset	1477 @example
e9921bb3d95b [project @ 2007-09-13 02:44:27 by jwe] jwe parents: 6889 diff changeset	1478 default + @var{object-type} + @var{property-name}
e9921bb3d95b [project @ 2007-09-13 02:44:27 by jwe] jwe parents: 6889 diff changeset	1479 @end example
e9921bb3d95b [project @ 2007-09-13 02:44:27 by jwe] jwe parents: 6889 diff changeset	1480
e9921bb3d95b [project @ 2007-09-13 02:44:27 by jwe] jwe parents: 6889 diff changeset	1481 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	1482 @code{defaultlinelinewidth"} specifies the default @code{linewidth}
e9921bb3d95b [project @ 2007-09-13 02:44:27 by jwe] jwe parents: 6889 diff changeset	1483 property for @code{line} objects.
e9921bb3d95b [project @ 2007-09-13 02:44:27 by jwe] jwe parents: 6889 diff changeset	1484
e9921bb3d95b [project @ 2007-09-13 02:44:27 by jwe] jwe parents: 6889 diff changeset	1485 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	1486 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	1487 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	1488 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	1489 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	1490
e9921bb3d95b [project @ 2007-09-13 02:44:27 by jwe] jwe parents: 6889 diff changeset	1491 @example
e9921bb3d95b [project @ 2007-09-13 02:44:27 by jwe] jwe parents: 6889 diff changeset	1492 @group
e9921bb3d95b [project @ 2007-09-13 02:44:27 by jwe] jwe parents: 6889 diff changeset	1493 subplot (2, 1, 1);
e9921bb3d95b [project @ 2007-09-13 02:44:27 by jwe] jwe parents: 6889 diff changeset	1494 set (0, "defaultlinecolor", "red");
e9921bb3d95b [project @ 2007-09-13 02:44:27 by jwe] jwe parents: 6889 diff changeset	1495 set (1, "defaultlinecolor", "green");
e9921bb3d95b [project @ 2007-09-13 02:44:27 by jwe] jwe parents: 6889 diff changeset	1496 set (gca (), "defaultlinecolor", "blue");
e9921bb3d95b [project @ 2007-09-13 02:44:27 by jwe] jwe parents: 6889 diff changeset	1497 line (1:10, rand (1, 10));
e9921bb3d95b [project @ 2007-09-13 02:44:27 by jwe] jwe parents: 6889 diff changeset	1498 subplot (2, 1, 2);
e9921bb3d95b [project @ 2007-09-13 02:44:27 by jwe] jwe parents: 6889 diff changeset	1499 line (1:10, rand (1, 10));
e9921bb3d95b [project @ 2007-09-13 02:44:27 by jwe] jwe parents: 6889 diff changeset	1500 figure (2)
e9921bb3d95b [project @ 2007-09-13 02:44:27 by jwe] jwe parents: 6889 diff changeset	1501 line (1:10, rand (1, 10));
e9921bb3d95b [project @ 2007-09-13 02:44:27 by jwe] jwe parents: 6889 diff changeset	1502 @end group
e9921bb3d95b [project @ 2007-09-13 02:44:27 by jwe] jwe parents: 6889 diff changeset	1503 @end example
e9921bb3d95b [project @ 2007-09-13 02:44:27 by jwe] jwe parents: 6889 diff changeset	1504
e9921bb3d95b [project @ 2007-09-13 02:44:27 by jwe] jwe parents: 6889 diff changeset	1505 @noindent
e9921bb3d95b [project @ 2007-09-13 02:44:27 by jwe] jwe parents: 6889 diff changeset	1506 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	1507 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	1508 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	1509 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	1510 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	1511 from the global root figure parent object.
e9921bb3d95b [project @ 2007-09-13 02:44:27 by jwe] jwe parents: 6889 diff changeset	1512
e9921bb3d95b [project @ 2007-09-13 02:44:27 by jwe] jwe parents: 6889 diff changeset	1513 To remove a user-defined default setting, set the default property to
17281 bc924baa2c4e doc: Add new @qcode macro for code samples which are quoted. Rik <rik@octave.org> parents: 17170 diff changeset	1514 the value @qcode{"remove"}. For example,
6891 e9921bb3d95b [project @ 2007-09-13 02:44:27 by jwe] jwe parents: 6889 diff changeset	1515
e9921bb3d95b [project @ 2007-09-13 02:44:27 by jwe] jwe parents: 6889 diff changeset	1516 @example
e9921bb3d95b [project @ 2007-09-13 02:44:27 by jwe] jwe parents: 6889 diff changeset	1517 set (gca (), "defaultlinecolor", "remove");
e9921bb3d95b [project @ 2007-09-13 02:44:27 by jwe] jwe parents: 6889 diff changeset	1518 @end example
e9921bb3d95b [project @ 2007-09-13 02:44:27 by jwe] jwe parents: 6889 diff changeset	1519
e9921bb3d95b [project @ 2007-09-13 02:44:27 by jwe] jwe parents: 6889 diff changeset	1520 @noindent
e9921bb3d95b [project @ 2007-09-13 02:44:27 by jwe] jwe parents: 6889 diff changeset	1521 removes the user-defined default line color setting from the current axes
12189 9558ca33648d Add functions reset, whitebg to documentation. Rik <octave@nomad.inbox5.com> parents: 11591 diff changeset	1522 object. To quickly remove all user-defined defaults use the @code{reset}
9558ca33648d Add functions reset, whitebg to documentation. Rik <octave@nomad.inbox5.com> parents: 11591 diff changeset	1523 function.
9558ca33648d Add functions reset, whitebg to documentation. Rik <octave@nomad.inbox5.com> parents: 11591 diff changeset	1524
9558ca33648d Add functions reset, whitebg to documentation. Rik <octave@nomad.inbox5.com> parents: 11591 diff changeset	1525 @DOCSTRING(reset)
6891 e9921bb3d95b [project @ 2007-09-13 02:44:27 by jwe] jwe parents: 6889 diff changeset	1526
17281 bc924baa2c4e doc: Add new @qcode macro for code samples which are quoted. Rik <rik@octave.org> parents: 17170 diff changeset	1527 Getting the @qcode{"default"} property of an object returns a list of
6891 e9921bb3d95b [project @ 2007-09-13 02:44:27 by jwe] jwe parents: 6889 diff changeset	1528 user-defined defaults set for the object. For example,
e9921bb3d95b [project @ 2007-09-13 02:44:27 by jwe] jwe parents: 6889 diff changeset	1529
e9921bb3d95b [project @ 2007-09-13 02:44:27 by jwe] jwe parents: 6889 diff changeset	1530 @example
e9921bb3d95b [project @ 2007-09-13 02:44:27 by jwe] jwe parents: 6889 diff changeset	1531 get (gca (), "default");
e9921bb3d95b [project @ 2007-09-13 02:44:27 by jwe] jwe parents: 6889 diff changeset	1532 @end example
e9921bb3d95b [project @ 2007-09-13 02:44:27 by jwe] jwe parents: 6889 diff changeset	1533
e9921bb3d95b [project @ 2007-09-13 02:44:27 by jwe] jwe parents: 6889 diff changeset	1534 @noindent
e9921bb3d95b [project @ 2007-09-13 02:44:27 by jwe] jwe parents: 6889 diff changeset	1535 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	1536 object.
e9921bb3d95b [project @ 2007-09-13 02:44:27 by jwe] jwe parents: 6889 diff changeset	1537
e9921bb3d95b [project @ 2007-09-13 02:44:27 by jwe] jwe parents: 6889 diff changeset	1538 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	1539 command
e9921bb3d95b [project @ 2007-09-13 02:44:27 by jwe] jwe parents: 6889 diff changeset	1540
e9921bb3d95b [project @ 2007-09-13 02:44:27 by jwe] jwe parents: 6889 diff changeset	1541 @example
e9921bb3d95b [project @ 2007-09-13 02:44:27 by jwe] jwe parents: 6889 diff changeset	1542 get (0, "factory");
e9921bb3d95b [project @ 2007-09-13 02:44:27 by jwe] jwe parents: 6889 diff changeset	1543 @end example
e9921bb3d95b [project @ 2007-09-13 02:44:27 by jwe] jwe parents: 6889 diff changeset	1544
e9921bb3d95b [project @ 2007-09-13 02:44:27 by jwe] jwe parents: 6889 diff changeset	1545 @noindent
e9921bb3d95b [project @ 2007-09-13 02:44:27 by jwe] jwe parents: 6889 diff changeset	1546 returns a list of factory defaults.
e9921bb3d95b [project @ 2007-09-13 02:44:27 by jwe] jwe parents: 6889 diff changeset	1547
9672 43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	1548 @node Advanced Plotting
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	1549 @section Advanced Plotting
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	1550
12525 d36266a54202 Add getappdata, setappdata, isappdata, rmappdata functions to documentation. Rik <octave@nomad.inbox5.com> parents: 12522 diff changeset	1551
9672 43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	1552 @menu
17152 f2a8592b8fbd doc: Shorten some long subsection names in Manual. Rik <rik@octave.org> parents: 17123 diff changeset	1553 * Colors::
f2a8592b8fbd doc: Shorten some long subsection names in Manual. Rik <rik@octave.org> parents: 17123 diff changeset	1554 * Line Styles::
f2a8592b8fbd doc: Shorten some long subsection names in Manual. Rik <rik@octave.org> parents: 17123 diff changeset	1555 * Marker Styles::
f2a8592b8fbd doc: Shorten some long subsection names in Manual. Rik <rik@octave.org> parents: 17123 diff changeset	1556 * Callbacks::
12525 d36266a54202 Add getappdata, setappdata, isappdata, rmappdata functions to documentation. Rik <octave@nomad.inbox5.com> parents: 12522 diff changeset	1557 * Application-defined Data::
17152 f2a8592b8fbd doc: Shorten some long subsection names in Manual. Rik <rik@octave.org> parents: 17123 diff changeset	1558 * Object Groups::
f2a8592b8fbd doc: Shorten some long subsection names in Manual. Rik <rik@octave.org> parents: 17123 diff changeset	1559 * Graphics Toolkits::
9672 43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	1560 @end menu
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	1561
43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	1562
6889 ebff56d6b0a8 [project @ 2007-09-12 18:32:12 by jwe] jwe parents: 6888 diff changeset	1563 @node Colors
ebff56d6b0a8 [project @ 2007-09-12 18:32:12 by jwe] jwe parents: 6888 diff changeset	1564 @subsection Colors
8071 b6e85fb238c1 doc fixes John W. Eaton <jwe@octave.org> parents: 8070 diff changeset	1565 @cindex graphics colors
b6e85fb238c1 doc fixes John W. Eaton <jwe@octave.org> parents: 8070 diff changeset	1566 @cindex colors, graphics
6889 ebff56d6b0a8 [project @ 2007-09-12 18:32:12 by jwe] jwe parents: 6888 diff changeset	1567
ebff56d6b0a8 [project @ 2007-09-12 18:32:12 by jwe] jwe parents: 6888 diff changeset	1568 Colors may be specified as RGB triplets with values ranging from zero to
17281 bc924baa2c4e doc: Add new @qcode macro for code samples which are quoted. Rik <rik@octave.org> parents: 17170 diff changeset	1569 one, or by name. Recognized color names include @qcode{"blue"},
bc924baa2c4e doc: Add new @qcode macro for code samples which are quoted. Rik <rik@octave.org> parents: 17170 diff changeset	1570 @qcode{"black"}, @qcode{"cyan"}, @qcode{"green"}, @qcode{"magenta"},
bc924baa2c4e doc: Add new @qcode macro for code samples which are quoted. Rik <rik@octave.org> parents: 17170 diff changeset	1571 @qcode{"red"}, @qcode{"white"}, and @qcode{"yellow"}.
6889 ebff56d6b0a8 [project @ 2007-09-12 18:32:12 by jwe] jwe parents: 6888 diff changeset	1572
ebff56d6b0a8 [project @ 2007-09-12 18:32:12 by jwe] jwe parents: 6888 diff changeset	1573 @node Line Styles
ebff56d6b0a8 [project @ 2007-09-12 18:32:12 by jwe] jwe parents: 6888 diff changeset	1574 @subsection Line Styles
8071 b6e85fb238c1 doc fixes John W. Eaton <jwe@octave.org> parents: 8070 diff changeset	1575 @cindex line styles, graphics
b6e85fb238c1 doc fixes John W. Eaton <jwe@octave.org> parents: 8070 diff changeset	1576 @cindex graphics line styles
b6e85fb238c1 doc fixes John W. Eaton <jwe@octave.org> parents: 8070 diff changeset	1577
7001 8b0cfeb06365 [project @ 2007-10-10 18:02:59 by jwe] jwe parents: 6899 diff changeset	1578 Line styles are specified by the following properties:
6889 ebff56d6b0a8 [project @ 2007-09-12 18:32:12 by jwe] jwe parents: 6888 diff changeset	1579
ebff56d6b0a8 [project @ 2007-09-12 18:32:12 by jwe] jwe parents: 6888 diff changeset	1580 @table @code
ebff56d6b0a8 [project @ 2007-09-12 18:32:12 by jwe] jwe parents: 6888 diff changeset	1581 @item linestyle
ebff56d6b0a8 [project @ 2007-09-12 18:32:12 by jwe] jwe parents: 6888 diff changeset	1582 May be one of
14853 72b8b39e12be doc: Periodic grammarcheck of documentation. Rik <octave@nomad.inbox5.com> parents: 14577 diff changeset	1583
18078 b06a9768b643 doc: Don't use @table @qcode to avoid problems with Texinfo 5.2. Rik <rik@octave.org> parents: 17957 diff changeset	1584 @table @asis
b06a9768b643 doc: Don't use @table @qcode to avoid problems with Texinfo 5.2. Rik <rik@octave.org> parents: 17957 diff changeset	1585 @item @qcode{"-"}
12690 e9e35a707721 doc: Add 'none' to list of plot linestyles. Rik <octave@nomad.inbox5.com> parents: 12607 diff changeset	1586 Solid line. [default]
10828 322f43e0e170 Grammarcheck .txi documentation files. Rik <octave@nomad.inbox5.com> parents: 10711 diff changeset	1587
18541 2b01c11197d6 Fix contraction of '--' to '-' in Info format of Line Styles (bug #41585) Rik <rik@octave.org> parents: 18407 diff changeset	1588 @c Special handling required to avoid '--' becoming single en-dash in Info
18542 d39fd728ddef Tweak cset 044bbf569cd3 to get '--' to display in HTML as well (bug #41585). Rik <rik@octave.org> parents: 18541 diff changeset	1589 @ifnottex
19602 cbce5d1bcaf9 doc: Periodic grammarcheck of documentation. Rik <rik@octave.org> parents: 19504 diff changeset	1590
18542 d39fd728ddef Tweak cset 044bbf569cd3 to get '--' to display in HTML as well (bug #41585). Rik <rik@octave.org> parents: 18541 diff changeset	1591 @item @verb{\|"--"\|}
d39fd728ddef Tweak cset 044bbf569cd3 to get '--' to display in HTML as well (bug #41585). Rik <rik@octave.org> parents: 18541 diff changeset	1592 @end ifnottex
18541 2b01c11197d6 Fix contraction of '--' to '-' in Info format of Line Styles (bug #41585) Rik <rik@octave.org> parents: 18407 diff changeset	1593 @iftex
19602 cbce5d1bcaf9 doc: Periodic grammarcheck of documentation. Rik <rik@octave.org> parents: 19504 diff changeset	1594
18541 2b01c11197d6 Fix contraction of '--' to '-' in Info format of Line Styles (bug #41585) Rik <rik@octave.org> parents: 18407 diff changeset	1595 @item @code{"--"}
2b01c11197d6 Fix contraction of '--' to '-' in Info format of Line Styles (bug #41585) Rik <rik@octave.org> parents: 18407 diff changeset	1596 @end iftex
12690 e9e35a707721 doc: Add 'none' to list of plot linestyles. Rik <octave@nomad.inbox5.com> parents: 12607 diff changeset	1597 Dashed line.
10828 322f43e0e170 Grammarcheck .txi documentation files. Rik <octave@nomad.inbox5.com> parents: 10711 diff changeset	1598
18078 b06a9768b643 doc: Don't use @table @qcode to avoid problems with Texinfo 5.2. Rik <rik@octave.org> parents: 17957 diff changeset	1599 @item @qcode{":"}
12690 e9e35a707721 doc: Add 'none' to list of plot linestyles. Rik <octave@nomad.inbox5.com> parents: 12607 diff changeset	1600 Dotted line.
10828 322f43e0e170 Grammarcheck .txi documentation files. Rik <octave@nomad.inbox5.com> parents: 10711 diff changeset	1601
18078 b06a9768b643 doc: Don't use @table @qcode to avoid problems with Texinfo 5.2. Rik <rik@octave.org> parents: 17957 diff changeset	1602 @item @qcode{"-."}
6889 ebff56d6b0a8 [project @ 2007-09-12 18:32:12 by jwe] jwe parents: 6888 diff changeset	1603 A dash-dot line.
12690 e9e35a707721 doc: Add 'none' to list of plot linestyles. Rik <octave@nomad.inbox5.com> parents: 12607 diff changeset	1604
17281 bc924baa2c4e doc: Add new @qcode macro for code samples which are quoted. Rik <rik@octave.org> parents: 17170 diff changeset	1605 @item @qcode{"none"}
12690 e9e35a707721 doc: Add 'none' to list of plot linestyles. Rik <octave@nomad.inbox5.com> parents: 12607 diff changeset	1606 No line. Points will still be marked using the current Marker Style.
6889 ebff56d6b0a8 [project @ 2007-09-12 18:32:12 by jwe] jwe parents: 6888 diff changeset	1607 @end table
ebff56d6b0a8 [project @ 2007-09-12 18:32:12 by jwe] jwe parents: 6888 diff changeset	1608
ebff56d6b0a8 [project @ 2007-09-12 18:32:12 by jwe] jwe parents: 6888 diff changeset	1609 @item linewidth
ebff56d6b0a8 [project @ 2007-09-12 18:32:12 by jwe] jwe parents: 6888 diff changeset	1610 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	1611 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	1612 @end table
ebff56d6b0a8 [project @ 2007-09-12 18:32:12 by jwe] jwe parents: 6888 diff changeset	1613
ebff56d6b0a8 [project @ 2007-09-12 18:32:12 by jwe] jwe parents: 6888 diff changeset	1614 @node Marker Styles
ebff56d6b0a8 [project @ 2007-09-12 18:32:12 by jwe] jwe parents: 6888 diff changeset	1615 @subsection Marker Styles
8071 b6e85fb238c1 doc fixes John W. Eaton <jwe@octave.org> parents: 8070 diff changeset	1616 @cindex graphics marker styles
b6e85fb238c1 doc fixes John W. Eaton <jwe@octave.org> parents: 8070 diff changeset	1617 @cindex marker styles, graphics
b6e85fb238c1 doc fixes John W. Eaton <jwe@octave.org> parents: 8070 diff changeset	1618
7001 8b0cfeb06365 [project @ 2007-10-10 18:02:59 by jwe] jwe parents: 6899 diff changeset	1619 Marker styles are specified by the following properties:
14853 72b8b39e12be doc: Periodic grammarcheck of documentation. Rik <octave@nomad.inbox5.com> parents: 14577 diff changeset	1620
6889 ebff56d6b0a8 [project @ 2007-09-12 18:32:12 by jwe] jwe parents: 6888 diff changeset	1621 @table @code
ebff56d6b0a8 [project @ 2007-09-12 18:32:12 by jwe] jwe parents: 6888 diff changeset	1622 @item marker
ebff56d6b0a8 [project @ 2007-09-12 18:32:12 by jwe] jwe parents: 6888 diff changeset	1623 A character indicating a plot marker to be place at each data point, or
17281 bc924baa2c4e doc: Add new @qcode macro for code samples which are quoted. Rik <rik@octave.org> parents: 17170 diff changeset	1624 @qcode{"none"}, meaning no markers should be displayed.
6889 ebff56d6b0a8 [project @ 2007-09-12 18:32:12 by jwe] jwe parents: 6888 diff changeset	1625
16094 8899c785cc99 doc: Fix warnings associated with Texinfo 5.0 (bug #38392) Rik <rik@octave.org> parents: 16008 diff changeset	1626 @item markeredgecolor
17281 bc924baa2c4e doc: Add new @qcode macro for code samples which are quoted. Rik <rik@octave.org> parents: 17170 diff changeset	1627 The color of the edge around the marker, or @qcode{"auto"}, meaning that
6889 ebff56d6b0a8 [project @ 2007-09-12 18:32:12 by jwe] jwe parents: 6888 diff changeset	1628 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	1629
16094 8899c785cc99 doc: Fix warnings associated with Texinfo 5.0 (bug #38392) Rik <rik@octave.org> parents: 16008 diff changeset	1630 @item markerfacecolor
17281 bc924baa2c4e doc: Add new @qcode macro for code samples which are quoted. Rik <rik@octave.org> parents: 17170 diff changeset	1631 The color of the marker, or @qcode{"none"} to indicate that the marker
6889 ebff56d6b0a8 [project @ 2007-09-12 18:32:12 by jwe] jwe parents: 6888 diff changeset	1632 should not be filled. @xref{Colors}.
ebff56d6b0a8 [project @ 2007-09-12 18:32:12 by jwe] jwe parents: 6888 diff changeset	1633
16094 8899c785cc99 doc: Fix warnings associated with Texinfo 5.0 (bug #38392) Rik <rik@octave.org> parents: 16008 diff changeset	1634 @item markersize
6889 ebff56d6b0a8 [project @ 2007-09-12 18:32:12 by jwe] jwe parents: 6888 diff changeset	1635 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	1636 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	1637 @end table
b3d286e8a243 [project @ 2007-09-12 06:40:58 by jwe] jwe parents: 6877 diff changeset	1638
12607 2846ea58b288 colstyle.m: Add new function (bug #33063) Rik <octave@nomad.inbox5.com> parents: 12578 diff changeset	1639 The @code{colstyle} function will parse a @code{plot}-style specification
2846ea58b288 colstyle.m: Add new function (bug #33063) Rik <octave@nomad.inbox5.com> parents: 12578 diff changeset	1640 and will return the color, line, and marker values that would result.
2846ea58b288 colstyle.m: Add new function (bug #33063) Rik <octave@nomad.inbox5.com> parents: 12578 diff changeset	1641
2846ea58b288 colstyle.m: Add new function (bug #33063) Rik <octave@nomad.inbox5.com> parents: 12578 diff changeset	1642 @DOCSTRING(colstyle)
2846ea58b288 colstyle.m: Add new function (bug #33063) Rik <octave@nomad.inbox5.com> parents: 12578 diff changeset	1643
8056 9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them David Bateman <dbateman@free.fr> parents: 8055 diff changeset	1644 @node Callbacks
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them David Bateman <dbateman@free.fr> parents: 8055 diff changeset	1645 @subsection Callbacks
8071 b6e85fb238c1 doc fixes John W. Eaton <jwe@octave.org> parents: 8070 diff changeset	1646 @cindex callbacks
8056 9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them David Bateman <dbateman@free.fr> parents: 8055 diff changeset	1647
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them David Bateman <dbateman@free.fr> parents: 8055 diff changeset	1648 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	1649 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	1650 is
8056 9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them David Bateman <dbateman@free.fr> parents: 8055 diff changeset	1651
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them David Bateman <dbateman@free.fr> parents: 8055 diff changeset	1652 @example
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them David Bateman <dbateman@free.fr> parents: 8055 diff changeset	1653 @group
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them David Bateman <dbateman@free.fr> parents: 8055 diff changeset	1654 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	1655 @dots{}
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them David Bateman <dbateman@free.fr> parents: 8055 diff changeset	1656 endfunction
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them David Bateman <dbateman@free.fr> parents: 8055 diff changeset	1657 @end group
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them David Bateman <dbateman@free.fr> parents: 8055 diff changeset	1658 @end example
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them David Bateman <dbateman@free.fr> parents: 8055 diff changeset	1659
10846 a4f482e66b65 Grammarcheck more of the documentation. Rik <octave@nomad.inbox5.com> parents: 10828 diff changeset	1660 @noindent
8056 9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them David Bateman <dbateman@free.fr> parents: 8055 diff changeset	1661 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	1662 @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	1663 with an object either at the objects creation or later with the
10828 322f43e0e170 Grammarcheck .txi documentation files. Rik <octave@nomad.inbox5.com> parents: 10711 diff changeset	1664 @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	1665
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them David Bateman <dbateman@free.fr> parents: 8055 diff changeset	1666 @example
14856 c3fd61c59e9c maint: Use Octave coding conventions for cuddling parentheses in doc directory Rik <octave@nomad.inbox5.com> parents: 14853 diff changeset	1667 plot (x, "DeleteFcn", @@(s, e) disp ("Window Deleted"))
8056 9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them David Bateman <dbateman@free.fr> parents: 8055 diff changeset	1668 @end example
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them David Bateman <dbateman@free.fr> parents: 8055 diff changeset	1669
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them David Bateman <dbateman@free.fr> parents: 8055 diff changeset	1670 @noindent
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them David Bateman <dbateman@free.fr> parents: 8055 diff changeset	1671 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	1672 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	1673
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them David Bateman <dbateman@free.fr> parents: 8055 diff changeset	1674 Additional user arguments can be passed to callback functions, and will
10828 322f43e0e170 Grammarcheck .txi documentation files. Rik <octave@nomad.inbox5.com> parents: 10711 diff changeset	1675 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	1676
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them David Bateman <dbateman@free.fr> parents: 8055 diff changeset	1677 @example
9088 77e71f3da3d6 Fix documentation image printing under new development code Rik <rdrider0-list@yahoo.com> parents: 9040 diff changeset	1678 @group
8057 7670cd296687 Opps David Bateman <dbateman@free.fr> parents: 8056 diff changeset	1679 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	1680 @dots{}
8057 7670cd296687 Opps David Bateman <dbateman@free.fr> parents: 8056 diff changeset	1681 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	1682 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	1683 endfunction
9088 77e71f3da3d6 Fix documentation image printing under new development code Rik <rdrider0-list@yahoo.com> parents: 9040 diff changeset	1684 @end group
8056 9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them David Bateman <dbateman@free.fr> parents: 8055 diff changeset	1685 @end example
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them David Bateman <dbateman@free.fr> parents: 8055 diff changeset	1686
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them David Bateman <dbateman@free.fr> parents: 8055 diff changeset	1687 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	1688 are
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them David Bateman <dbateman@free.fr> parents: 8055 diff changeset	1689
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them David Bateman <dbateman@free.fr> parents: 8055 diff changeset	1690 @itemize @bullet
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them David Bateman <dbateman@free.fr> parents: 8055 diff changeset	1691 @item CreateFcn
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them David Bateman <dbateman@free.fr> parents: 8055 diff changeset	1692 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	1693 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	1694 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	1695 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	1696 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	1697
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them David Bateman <dbateman@free.fr> parents: 8055 diff changeset	1698 @item DeleteFcn
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them David Bateman <dbateman@free.fr> parents: 8055 diff changeset	1699 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	1700
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them David Bateman <dbateman@free.fr> parents: 8055 diff changeset	1701 @item ButtonDownFcn
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them David Bateman <dbateman@free.fr> parents: 8055 diff changeset	1702 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	1703 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	1704 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	1705 @end itemize
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them David Bateman <dbateman@free.fr> parents: 8055 diff changeset	1706
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them David Bateman <dbateman@free.fr> parents: 8055 diff changeset	1707 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	1708 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	1709 functions.
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them David Bateman <dbateman@free.fr> parents: 8055 diff changeset	1710
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them David Bateman <dbateman@free.fr> parents: 8055 diff changeset	1711 @DOCSTRING(gcbo)
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them David Bateman <dbateman@free.fr> parents: 8055 diff changeset	1712
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them David Bateman <dbateman@free.fr> parents: 8055 diff changeset	1713 @DOCSTRING(gcbf)
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them David Bateman <dbateman@free.fr> parents: 8055 diff changeset	1714
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them David Bateman <dbateman@free.fr> parents: 8055 diff changeset	1715 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	1716 function described below.
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them David Bateman <dbateman@free.fr> parents: 8055 diff changeset	1717
12525 d36266a54202 Add getappdata, setappdata, isappdata, rmappdata functions to documentation. Rik <octave@nomad.inbox5.com> parents: 12522 diff changeset	1718 @node Application-defined Data
17152 f2a8592b8fbd doc: Shorten some long subsection names in Manual. Rik <rik@octave.org> parents: 17123 diff changeset	1719 @subsection Application-defined Data
12578 f5a780d675a1 Clean up operator and function indices in documentation. Rik <octave@nomad.inbox5.com> parents: 12577 diff changeset	1720 @cindex application-defined data
12525 d36266a54202 Add getappdata, setappdata, isappdata, rmappdata functions to documentation. Rik <octave@nomad.inbox5.com> parents: 12522 diff changeset	1721
d36266a54202 Add getappdata, setappdata, isappdata, rmappdata functions to documentation. Rik <octave@nomad.inbox5.com> parents: 12522 diff changeset	1722 Octave has a provision for attaching application-defined data to a graphics
d36266a54202 Add getappdata, setappdata, isappdata, rmappdata functions to documentation. Rik <octave@nomad.inbox5.com> parents: 12522 diff changeset	1723 handle. The data can be anything which is meaningful to the application, and
d36266a54202 Add getappdata, setappdata, isappdata, rmappdata functions to documentation. Rik <octave@nomad.inbox5.com> parents: 12522 diff changeset	1724 will be completely ignored by Octave.
d36266a54202 Add getappdata, setappdata, isappdata, rmappdata functions to documentation. Rik <octave@nomad.inbox5.com> parents: 12522 diff changeset	1725
d36266a54202 Add getappdata, setappdata, isappdata, rmappdata functions to documentation. Rik <octave@nomad.inbox5.com> parents: 12522 diff changeset	1726 @DOCSTRING(setappdata)
d36266a54202 Add getappdata, setappdata, isappdata, rmappdata functions to documentation. Rik <octave@nomad.inbox5.com> parents: 12522 diff changeset	1727
d36266a54202 Add getappdata, setappdata, isappdata, rmappdata functions to documentation. Rik <octave@nomad.inbox5.com> parents: 12522 diff changeset	1728 @DOCSTRING(getappdata)
d36266a54202 Add getappdata, setappdata, isappdata, rmappdata functions to documentation. Rik <octave@nomad.inbox5.com> parents: 12522 diff changeset	1729
d36266a54202 Add getappdata, setappdata, isappdata, rmappdata functions to documentation. Rik <octave@nomad.inbox5.com> parents: 12522 diff changeset	1730 @DOCSTRING(rmappdata)
d36266a54202 Add getappdata, setappdata, isappdata, rmappdata functions to documentation. Rik <octave@nomad.inbox5.com> parents: 12522 diff changeset	1731
d36266a54202 Add getappdata, setappdata, isappdata, rmappdata functions to documentation. Rik <octave@nomad.inbox5.com> parents: 12522 diff changeset	1732 @DOCSTRING(isappdata)
d36266a54202 Add getappdata, setappdata, isappdata, rmappdata functions to documentation. Rik <octave@nomad.inbox5.com> parents: 12522 diff changeset	1733
8056 9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them David Bateman <dbateman@free.fr> parents: 8055 diff changeset	1734 @node Object Groups
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them David Bateman <dbateman@free.fr> parents: 8055 diff changeset	1735 @subsection Object Groups
8071 b6e85fb238c1 doc fixes John W. Eaton <jwe@octave.org> parents: 8070 diff changeset	1736 @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	1737
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them David Bateman <dbateman@free.fr> parents: 8055 diff changeset	1738 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	1739 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	1740 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	1741 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	1742 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	1743
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them David Bateman <dbateman@free.fr> parents: 8055 diff changeset	1744 @DOCSTRING(hggroup)
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them David Bateman <dbateman@free.fr> parents: 8055 diff changeset	1745
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them David Bateman <dbateman@free.fr> parents: 8055 diff changeset	1746 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	1747
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them David Bateman <dbateman@free.fr> parents: 8055 diff changeset	1748 @example
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them David Bateman <dbateman@free.fr> parents: 8055 diff changeset	1749 @group
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them David Bateman <dbateman@free.fr> parents: 8055 diff changeset	1750 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	1751 hg = hggroup ();
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them David Bateman <dbateman@free.fr> parents: 8055 diff changeset	1752 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	1753 hold on
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them David Bateman <dbateman@free.fr> parents: 8055 diff changeset	1754 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	1755 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	1756 @end group
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them David Bateman <dbateman@free.fr> parents: 8055 diff changeset	1757 @end example
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them David Bateman <dbateman@free.fr> parents: 8055 diff changeset	1758
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them David Bateman <dbateman@free.fr> parents: 8055 diff changeset	1759 @noindent
9040 dbd0c77e575e Cleanup documentation file plot.texi Rik <rdrider0-list@yahoo.com> parents: 9032 diff changeset	1760 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	1761 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	1762 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	1763 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	1764 function.
8056 9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them David Bateman <dbateman@free.fr> parents: 8055 diff changeset	1765
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them David Bateman <dbateman@free.fr> parents: 8055 diff changeset	1766 @DOCSTRING(addproperty)
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them David Bateman <dbateman@free.fr> parents: 8055 diff changeset	1767
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them David Bateman <dbateman@free.fr> parents: 8055 diff changeset	1768 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	1769 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	1770 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	1771 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	1772 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	1773
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them David Bateman <dbateman@free.fr> parents: 8055 diff changeset	1774 @DOCSTRING(addlistener)
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them David Bateman <dbateman@free.fr> parents: 8055 diff changeset	1775
8817 03b7f618ab3d include docstrings for new functions in the manual John W. Eaton <jwe@octave.org> parents: 8519 diff changeset	1776 @DOCSTRING(dellistener)
03b7f618ab3d include docstrings for new functions in the manual John W. Eaton <jwe@octave.org> parents: 8519 diff changeset	1777
8056 9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them David Bateman <dbateman@free.fr> parents: 8055 diff changeset	1778 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	1779
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them David Bateman <dbateman@free.fr> parents: 8055 diff changeset	1780 @example
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them David Bateman <dbateman@free.fr> parents: 8055 diff changeset	1781 @group
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them David Bateman <dbateman@free.fr> parents: 8055 diff changeset	1782 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	1783 hg = hggroup ();
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them David Bateman <dbateman@free.fr> parents: 8055 diff changeset	1784 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	1785 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	1786 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	1787 hold on
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them David Bateman <dbateman@free.fr> parents: 8055 diff changeset	1788 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	1789
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them David Bateman <dbateman@free.fr> parents: 8055 diff changeset	1790 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	1791 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	1792 endfunction
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them David Bateman <dbateman@free.fr> parents: 8055 diff changeset	1793 @end group
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them David Bateman <dbateman@free.fr> parents: 8055 diff changeset	1794 @end example
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them David Bateman <dbateman@free.fr> parents: 8055 diff changeset	1795
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them David Bateman <dbateman@free.fr> parents: 8055 diff changeset	1796 @noindent
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them David Bateman <dbateman@free.fr> parents: 8055 diff changeset	1797 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	1798 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	1799 @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	1800
3b53b25e2550 Add data sources and line series David Bateman <dbateman@free.fr> parents: 8057 diff changeset	1801 @example
3b53b25e2550 Add data sources and line series David Bateman <dbateman@free.fr> parents: 8057 diff changeset	1802 @group
3b53b25e2550 Add data sources and line series David Bateman <dbateman@free.fr> parents: 8057 diff changeset	1803 x = 0:0.1:10;
3b53b25e2550 Add data sources and line series David Bateman <dbateman@free.fr> parents: 8057 diff changeset	1804 hg = hggroup ();
3b53b25e2550 Add data sources and line series David Bateman <dbateman@free.fr> parents: 8057 diff changeset	1805 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	1806 addproperty ("linestyle", hg, "linelinestyle", get (h, "linestyle"));
3b53b25e2550 Add data sources and line series David Bateman <dbateman@free.fr> parents: 8057 diff changeset	1807 hold on
3b53b25e2550 Add data sources and line series David Bateman <dbateman@free.fr> parents: 8057 diff changeset	1808 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	1809 hlink = linkprop ([hg, h1, h2], "color");
8070 3b53b25e2550 Add data sources and line series David Bateman <dbateman@free.fr> parents: 8057 diff changeset	1810 @end group
3b53b25e2550 Add data sources and line series David Bateman <dbateman@free.fr> parents: 8057 diff changeset	1811 @end example
3b53b25e2550 Add data sources and line series David Bateman <dbateman@free.fr> parents: 8057 diff changeset	1812
3b53b25e2550 Add data sources and line series David Bateman <dbateman@free.fr> parents: 8057 diff changeset	1813 @DOCSTRING(linkprop)
8056 9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them David Bateman <dbateman@free.fr> parents: 8055 diff changeset	1814
18894 d1750be79dee linkaxes.m: Implement new function linkaxes. Willem Atsma <willem.atsma@tanglebridge.com> parents: 18715 diff changeset	1815 @DOCSTRING(linkaxes)
d1750be79dee linkaxes.m: Implement new function linkaxes. Willem Atsma <willem.atsma@tanglebridge.com> parents: 18715 diff changeset	1816
9672 43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	1817 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	1818 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	1819 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	1820
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them David Bateman <dbateman@free.fr> parents: 8055 diff changeset	1821 @itemize @bullet
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them David Bateman <dbateman@free.fr> parents: 8055 diff changeset	1822 @item group together multiple graphics objects,
10828 322f43e0e170 Grammarcheck .txi documentation files. Rik <octave@nomad.inbox5.com> parents: 10711 diff changeset	1823
8056 9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them David Bateman <dbateman@free.fr> parents: 8055 diff changeset	1824 @item create linked properties between different graphics objects, and
10828 322f43e0e170 Grammarcheck .txi documentation files. Rik <octave@nomad.inbox5.com> parents: 10711 diff changeset	1825
8056 9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them David Bateman <dbateman@free.fr> parents: 8055 diff changeset	1826 @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	1827 @end itemize
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them David Bateman <dbateman@free.fr> parents: 8055 diff changeset	1828
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them David Bateman <dbateman@free.fr> parents: 8055 diff changeset	1829 @noindent
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them David Bateman <dbateman@free.fr> parents: 8055 diff changeset	1830 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	1831 @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	1832 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	1833 @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	1834 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	1835 example
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them David Bateman <dbateman@free.fr> parents: 8055 diff changeset	1836
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them David Bateman <dbateman@free.fr> parents: 8055 diff changeset	1837 @example
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them David Bateman <dbateman@free.fr> parents: 8055 diff changeset	1838 @group
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them David Bateman <dbateman@free.fr> parents: 8055 diff changeset	1839 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	1840 get (h, "xdata")
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them David Bateman <dbateman@free.fr> parents: 8055 diff changeset	1841 @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	1842 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	1843 @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	1844 @end group
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them David Bateman <dbateman@free.fr> parents: 8055 diff changeset	1845 @end example
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them David Bateman <dbateman@free.fr> parents: 8055 diff changeset	1846
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them David Bateman <dbateman@free.fr> parents: 8055 diff changeset	1847 @noindent
9040 dbd0c77e575e Cleanup documentation file plot.texi Rik <rdrider0-list@yahoo.com> parents: 9032 diff changeset	1848 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	1849 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	1850
9672 43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	1851 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	1852 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	1853 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	1854 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	1855 member.
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them David Bateman <dbateman@free.fr> parents: 8055 diff changeset	1856
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them David Bateman <dbateman@free.fr> parents: 8055 diff changeset	1857 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	1858 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	1859 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	1860 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	1861 corresponding hggroup elements.
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them David Bateman <dbateman@free.fr> parents: 8055 diff changeset	1862
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them David Bateman <dbateman@free.fr> parents: 8055 diff changeset	1863 @menu
17152 f2a8592b8fbd doc: Shorten some long subsection names in Manual. Rik <rik@octave.org> parents: 17123 diff changeset	1864 * Data Sources in Object Groups::
f2a8592b8fbd doc: Shorten some long subsection names in Manual. Rik <rik@octave.org> parents: 17123 diff changeset	1865 * Area Series::
f2a8592b8fbd doc: Shorten some long subsection names in Manual. Rik <rik@octave.org> parents: 17123 diff changeset	1866 * Bar Series::
f2a8592b8fbd doc: Shorten some long subsection names in Manual. Rik <rik@octave.org> parents: 17123 diff changeset	1867 * Contour Groups::
f2a8592b8fbd doc: Shorten some long subsection names in Manual. Rik <rik@octave.org> parents: 17123 diff changeset	1868 * Error Bar Series::
f2a8592b8fbd doc: Shorten some long subsection names in Manual. Rik <rik@octave.org> parents: 17123 diff changeset	1869 * Line Series::
f2a8592b8fbd doc: Shorten some long subsection names in Manual. Rik <rik@octave.org> parents: 17123 diff changeset	1870 * Quiver Group::
f2a8592b8fbd doc: Shorten some long subsection names in Manual. Rik <rik@octave.org> parents: 17123 diff changeset	1871 * Scatter Group::
f2a8592b8fbd doc: Shorten some long subsection names in Manual. Rik <rik@octave.org> parents: 17123 diff changeset	1872 * Stair Group::
f2a8592b8fbd doc: Shorten some long subsection names in Manual. Rik <rik@octave.org> parents: 17123 diff changeset	1873 * Stem Series::
f2a8592b8fbd doc: Shorten some long subsection names in Manual. Rik <rik@octave.org> parents: 17123 diff changeset	1874 * Surface Group::
8056 9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them David Bateman <dbateman@free.fr> parents: 8055 diff changeset	1875 @end menu
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them David Bateman <dbateman@free.fr> parents: 8055 diff changeset	1876
11257 8d4c57258523 fix some menu problems in the manual John W. Eaton <jwe@octave.org> parents: 11255 diff changeset	1877 @node Data Sources in Object Groups
8d4c57258523 fix some menu problems in the manual John W. Eaton <jwe@octave.org> parents: 11255 diff changeset	1878 @subsubsection Data Sources in Object Groups
8071 b6e85fb238c1 doc fixes John W. Eaton <jwe@octave.org> parents: 8070 diff changeset	1879 @cindex data sources in object groups
17097 e7a059a9a644 doc: Use XREF as anchor prefix in documentation for clearer results in Info viewer. Rik <rik@octave.org> parents: 16923 diff changeset	1880 @anchor{XREFdatasources}
9040 dbd0c77e575e Cleanup documentation file plot.texi Rik <rdrider0-list@yahoo.com> parents: 9032 diff changeset	1881 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	1882 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	1883 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	1884 function is called.
8070 3b53b25e2550 Add data sources and line series David Bateman <dbateman@free.fr> parents: 8057 diff changeset	1885
3b53b25e2550 Add data sources and line series David Bateman <dbateman@free.fr> parents: 8057 diff changeset	1886 @DOCSTRING(refreshdata)
3b53b25e2550 Add data sources and line series David Bateman <dbateman@free.fr> parents: 8057 diff changeset	1887
17097 e7a059a9a644 doc: Use XREF as anchor prefix in documentation for clearer results in Info viewer. Rik <rik@octave.org> parents: 16923 diff changeset	1888 @anchor{XREFlinkdata}
8070 3b53b25e2550 Add data sources and line series David Bateman <dbateman@free.fr> parents: 8057 diff changeset	1889 @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	1890 @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	1891 @c command
8070 3b53b25e2550 Add data sources and line series David Bateman <dbateman@free.fr> parents: 8057 diff changeset	1892
11257 8d4c57258523 fix some menu problems in the manual John W. Eaton <jwe@octave.org> parents: 11255 diff changeset	1893 @node Area Series
8d4c57258523 fix some menu problems in the manual John W. Eaton <jwe@octave.org> parents: 11255 diff changeset	1894 @subsubsection Area Series
8071 b6e85fb238c1 doc fixes John W. Eaton <jwe@octave.org> parents: 8070 diff changeset	1895 @cindex series objects
b6e85fb238c1 doc fixes John W. Eaton <jwe@octave.org> parents: 8070 diff changeset	1896 @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	1897
9040 dbd0c77e575e Cleanup documentation file plot.texi Rik <rdrider0-list@yahoo.com> parents: 9032 diff changeset	1898 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	1899 @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	1900 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	1901
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them David Bateman <dbateman@free.fr> parents: 8055 diff changeset	1902 @table @code
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them David Bateman <dbateman@free.fr> parents: 8055 diff changeset	1903 @item basevalue
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them David Bateman <dbateman@free.fr> parents: 8055 diff changeset	1904 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	1905
17170 d6499c14021c doc: Periodic grammarcheck of documentation. Rik <rik@octave.org> parents: 17152 diff changeset	1906 @item linewidth
8056 9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them David Bateman <dbateman@free.fr> parents: 8055 diff changeset	1907 @itemx linestyle
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them David Bateman <dbateman@free.fr> parents: 8055 diff changeset	1908 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	1909 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	1910
17170 d6499c14021c doc: Periodic grammarcheck of documentation. Rik <rik@octave.org> parents: 17152 diff changeset	1911 @item edgecolor
8056 9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them David Bateman <dbateman@free.fr> parents: 8055 diff changeset	1912 @itemx facecolor
17469 710b3d5fe966 improve interpreter tex Tables Michael Godfrey <michaeldgodfrey@gmail.com> parents: 17281 diff changeset	1913 The line and fill color of the patch objects making up the areas.
10828 322f43e0e170 Grammarcheck .txi documentation files. Rik <octave@nomad.inbox5.com> parents: 10711 diff changeset	1914 @xref{Colors}.
8056 9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them David Bateman <dbateman@free.fr> parents: 8055 diff changeset	1915
17170 d6499c14021c doc: Periodic grammarcheck of documentation. Rik <rik@octave.org> parents: 17152 diff changeset	1916 @item xdata
8056 9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them David Bateman <dbateman@free.fr> parents: 8055 diff changeset	1917 @itemx ydata
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them David Bateman <dbateman@free.fr> parents: 8055 diff changeset	1918 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	1919 @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	1920 function.
8070 3b53b25e2550 Add data sources and line series David Bateman <dbateman@free.fr> parents: 8057 diff changeset	1921
17170 d6499c14021c doc: Periodic grammarcheck of documentation. Rik <rik@octave.org> parents: 17152 diff changeset	1922 @item xdatasource
8070 3b53b25e2550 Add data sources and line series David Bateman <dbateman@free.fr> parents: 8057 diff changeset	1923 @itemx ydatasource
3b53b25e2550 Add data sources and line series David Bateman <dbateman@free.fr> parents: 8057 diff changeset	1924 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	1925 @end table
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them David Bateman <dbateman@free.fr> parents: 8055 diff changeset	1926
11257 8d4c57258523 fix some menu problems in the manual John W. Eaton <jwe@octave.org> parents: 11255 diff changeset	1927 @node Bar Series
8d4c57258523 fix some menu problems in the manual John W. Eaton <jwe@octave.org> parents: 11255 diff changeset	1928 @subsubsection Bar Series
8071 b6e85fb238c1 doc fixes John W. Eaton <jwe@octave.org> parents: 8070 diff changeset	1929 @cindex series objects
b6e85fb238c1 doc fixes John W. Eaton <jwe@octave.org> parents: 8070 diff changeset	1930 @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	1931
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them David Bateman <dbateman@free.fr> parents: 8055 diff changeset	1932 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	1933 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	1934 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	1935
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them David Bateman <dbateman@free.fr> parents: 8055 diff changeset	1936 @table @code
17170 d6499c14021c doc: Periodic grammarcheck of documentation. Rik <rik@octave.org> parents: 17152 diff changeset	1937 @item showbaseline
8056 9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them David Bateman <dbateman@free.fr> parents: 8055 diff changeset	1938 @itemx baseline
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them David Bateman <dbateman@free.fr> parents: 8055 diff changeset	1939 @itemx basevalue
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them David Bateman <dbateman@free.fr> parents: 8055 diff changeset	1940 The property @code{showbaseline} flags whether the baseline of the bar
17281 bc924baa2c4e doc: Add new @qcode macro for code samples which are quoted. Rik <rik@octave.org> parents: 17170 diff changeset	1941 series is displayed (default is @qcode{"on"}). The handle of the graphics
bc924baa2c4e doc: Add new @qcode macro for code samples which are quoted. Rik <rik@octave.org> parents: 17170 diff changeset	1942 object representing the baseline is given by the @code{baseline} property and
9672 43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	1943 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	1944
18398 200851c87444 Edits to Manual and indicies Michael Godfrey <michaeldgodfrey@gmail.com> parents: 17957 diff changeset	1945 Changes to any of these properties are propagated to the other members of
200851c87444 Edits to Manual and indicies Michael Godfrey <michaeldgodfrey@gmail.com> parents: 17957 diff changeset	1946 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	1947 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	1948 corresponding bar series.
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them David Bateman <dbateman@free.fr> parents: 8055 diff changeset	1949
17170 d6499c14021c doc: Periodic grammarcheck of documentation. Rik <rik@octave.org> parents: 17152 diff changeset	1950 @item barwidth
8056 9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them David Bateman <dbateman@free.fr> parents: 8055 diff changeset	1951 @itemx barlayout
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them David Bateman <dbateman@free.fr> parents: 8055 diff changeset	1952 @itemx horizontal
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them David Bateman <dbateman@free.fr> parents: 8055 diff changeset	1953 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	1954 the @var{width} variable passed to @code{bar} or @var{barh}. Whether the
17281 bc924baa2c4e doc: Add new @qcode macro for code samples which are quoted. Rik <rik@octave.org> parents: 17170 diff changeset	1955 bar series is @qcode{"grouped"} or @qcode{"stacked"} is determined by the
8056 9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them David Bateman <dbateman@free.fr> parents: 8055 diff changeset	1956 @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	1957 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	1958
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them David Bateman <dbateman@free.fr> parents: 8055 diff changeset	1959 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	1960 the bar series.
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them David Bateman <dbateman@free.fr> parents: 8055 diff changeset	1961
17170 d6499c14021c doc: Periodic grammarcheck of documentation. Rik <rik@octave.org> parents: 17152 diff changeset	1962 @item linewidth
8056 9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them David Bateman <dbateman@free.fr> parents: 8055 diff changeset	1963 @itemx linestyle
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them David Bateman <dbateman@free.fr> parents: 8055 diff changeset	1964 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	1965 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	1966
17170 d6499c14021c doc: Periodic grammarcheck of documentation. Rik <rik@octave.org> parents: 17152 diff changeset	1967 @item edgecolor
8056 9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them David Bateman <dbateman@free.fr> parents: 8055 diff changeset	1968 @itemx facecolor
9040 dbd0c77e575e Cleanup documentation file plot.texi Rik <rdrider0-list@yahoo.com> parents: 9032 diff changeset	1969 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	1970
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them David Bateman <dbateman@free.fr> parents: 8055 diff changeset	1971 @item xdata
9040 dbd0c77e575e Cleanup documentation file plot.texi Rik <rdrider0-list@yahoo.com> parents: 9032 diff changeset	1972 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	1973 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	1974
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them David Bateman <dbateman@free.fr> parents: 8055 diff changeset	1975 @item ydata
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them David Bateman <dbateman@free.fr> parents: 8055 diff changeset	1976 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	1977
17170 d6499c14021c doc: Periodic grammarcheck of documentation. Rik <rik@octave.org> parents: 17152 diff changeset	1978 @item xdatasource
8070 3b53b25e2550 Add data sources and line series David Bateman <dbateman@free.fr> parents: 8057 diff changeset	1979 @itemx ydatasource
3b53b25e2550 Add data sources and line series David Bateman <dbateman@free.fr> parents: 8057 diff changeset	1980 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	1981 @end table
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them David Bateman <dbateman@free.fr> parents: 8055 diff changeset	1982
11257 8d4c57258523 fix some menu problems in the manual John W. Eaton <jwe@octave.org> parents: 11255 diff changeset	1983 @node Contour Groups
8d4c57258523 fix some menu problems in the manual John W. Eaton <jwe@octave.org> parents: 11255 diff changeset	1984 @subsubsection Contour Groups
8071 b6e85fb238c1 doc fixes John W. Eaton <jwe@octave.org> parents: 8070 diff changeset	1985 @cindex series objects
b6e85fb238c1 doc fixes John W. Eaton <jwe@octave.org> parents: 8070 diff changeset	1986 @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	1987
8289 ac7f334d9652 Add contour group objects and the clabel function David Bateman <dbateman@free.fr> parents: 8286 diff changeset	1988 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	1989 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	1990 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	1991 group are
ac7f334d9652 Add contour group objects and the clabel function David Bateman <dbateman@free.fr> parents: 8286 diff changeset	1992
ac7f334d9652 Add contour group objects and the clabel function David Bateman <dbateman@free.fr> parents: 8286 diff changeset	1993 @table @code
ac7f334d9652 Add contour group objects and the clabel function David Bateman <dbateman@free.fr> parents: 8286 diff changeset	1994 @item contourmatrix
ac7f334d9652 Add contour group objects and the clabel function David Bateman <dbateman@free.fr> parents: 8286 diff changeset	1995 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	1996 create the contours of the plot.
ac7f334d9652 Add contour group objects and the clabel function David Bateman <dbateman@free.fr> parents: 8286 diff changeset	1997
ac7f334d9652 Add contour group objects and the clabel function David Bateman <dbateman@free.fr> parents: 8286 diff changeset	1998 @item fill
17281 bc924baa2c4e doc: Add new @qcode macro for code samples which are quoted. Rik <rik@octave.org> parents: 17170 diff changeset	1999 A radio property that can have the values @qcode{"on"} or @qcode{"off"} that
bc924baa2c4e doc: Add new @qcode macro for code samples which are quoted. Rik <rik@octave.org> parents: 17170 diff changeset	2000 flags whether the contours to plot are to be filled.
8289 ac7f334d9652 Add contour group objects and the clabel function David Bateman <dbateman@free.fr> parents: 8286 diff changeset	2001
17170 d6499c14021c doc: Periodic grammarcheck of documentation. Rik <rik@octave.org> parents: 17152 diff changeset	2002 @item zlevelmode
8289 ac7f334d9652 Add contour group objects and the clabel function David Bateman <dbateman@free.fr> parents: 8286 diff changeset	2003 @itemx zlevel
17281 bc924baa2c4e doc: Add new @qcode macro for code samples which are quoted. Rik <rik@octave.org> parents: 17170 diff changeset	2004 The radio property @code{zlevelmode} can have the values @qcode{"none"},
bc924baa2c4e doc: Add new @qcode macro for code samples which are quoted. Rik <rik@octave.org> parents: 17170 diff changeset	2005 @qcode{"auto"}, or @qcode{"manual"}. When its value is @qcode{"none"} there is
bc924baa2c4e doc: Add new @qcode macro for code samples which are quoted. Rik <rik@octave.org> parents: 17170 diff changeset	2006 no z component to the plotted contours. When its value is @qcode{"auto"} the z
bc924baa2c4e doc: Add new @qcode macro for code samples which are quoted. Rik <rik@octave.org> parents: 17170 diff changeset	2007 value of the plotted contours is at the same value as the contour itself. If
bc924baa2c4e doc: Add new @qcode macro for code samples which are quoted. Rik <rik@octave.org> parents: 17170 diff changeset	2008 the value is @qcode{"manual"}, then the z value at which to plot the contour is
bc924baa2c4e doc: Add new @qcode macro for code samples which are quoted. Rik <rik@octave.org> parents: 17170 diff changeset	2009 determined by the @code{zlevel} property.
8289 ac7f334d9652 Add contour group objects and the clabel function David Bateman <dbateman@free.fr> parents: 8286 diff changeset	2010
17170 d6499c14021c doc: Periodic grammarcheck of documentation. Rik <rik@octave.org> parents: 17152 diff changeset	2011 @item levellistmode
8289 ac7f334d9652 Add contour group objects and the clabel function David Bateman <dbateman@free.fr> parents: 8286 diff changeset	2012 @itemx levellist
ac7f334d9652 Add contour group objects and the clabel function David Bateman <dbateman@free.fr> parents: 8286 diff changeset	2013 @itemx levelstepmode
ac7f334d9652 Add contour group objects and the clabel function David Bateman <dbateman@free.fr> parents: 8286 diff changeset	2014 @itemx levelstep
17281 bc924baa2c4e doc: Add new @qcode macro for code samples which are quoted. Rik <rik@octave.org> parents: 17170 diff changeset	2015 If @code{levellistmode} is @qcode{"manual"}, then the levels at which to plot
bc924baa2c4e doc: Add new @qcode macro for code samples which are quoted. Rik <rik@octave.org> parents: 17170 diff changeset	2016 the contours is determined by @code{levellist}. If @code{levellistmode} is set
bc924baa2c4e doc: Add new @qcode macro for code samples which are quoted. Rik <rik@octave.org> parents: 17170 diff changeset	2017 to @qcode{"auto"}, then the distance between contours is determined by
bc924baa2c4e doc: Add new @qcode macro for code samples which are quoted. Rik <rik@octave.org> parents: 17170 diff changeset	2018 @code{levelstep}. If both @code{levellistmode} and @code{levelstepmode} are
bc924baa2c4e doc: Add new @qcode macro for code samples which are quoted. Rik <rik@octave.org> parents: 17170 diff changeset	2019 set to @qcode{"auto"}, then there are assumed to be 10 equal spaced contours.
8289 ac7f334d9652 Add contour group objects and the clabel function David Bateman <dbateman@free.fr> parents: 8286 diff changeset	2020
17170 d6499c14021c doc: Periodic grammarcheck of documentation. Rik <rik@octave.org> parents: 17152 diff changeset	2021 @item textlistmode
8289 ac7f334d9652 Add contour group objects and the clabel function David Bateman <dbateman@free.fr> parents: 8286 diff changeset	2022 @itemx textlist
ac7f334d9652 Add contour group objects and the clabel function David Bateman <dbateman@free.fr> parents: 8286 diff changeset	2023 @itemx textstepmode
ac7f334d9652 Add contour group objects and the clabel function David Bateman <dbateman@free.fr> parents: 8286 diff changeset	2024 @itemx textstep
17281 bc924baa2c4e doc: Add new @qcode macro for code samples which are quoted. Rik <rik@octave.org> parents: 17170 diff changeset	2025 If @code{textlistmode} is @qcode{"manual"}, then the labeled contours
9672 43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	2026 is determined by @code{textlist}. If @code{textlistmode} is set to
17281 bc924baa2c4e doc: Add new @qcode macro for code samples which are quoted. Rik <rik@octave.org> parents: 17170 diff changeset	2027 @qcode{"auto"}, then the distance between labeled contours is determined by
9040 dbd0c77e575e Cleanup documentation file plot.texi Rik <rdrider0-list@yahoo.com> parents: 9032 diff changeset	2028 @code{textstep}. If both @code{textlistmode} and @code{textstepmode}
17281 bc924baa2c4e doc: Add new @qcode macro for code samples which are quoted. Rik <rik@octave.org> parents: 17170 diff changeset	2029 are set to @qcode{"auto"}, then there are assumed to be 10 equal spaced
9672 43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	2030 labeled contours.
8289 ac7f334d9652 Add contour group objects and the clabel function David Bateman <dbateman@free.fr> parents: 8286 diff changeset	2031
ac7f334d9652 Add contour group objects and the clabel function David Bateman <dbateman@free.fr> parents: 8286 diff changeset	2032 @item showtext
ac7f334d9652 Add contour group objects and the clabel function David Bateman <dbateman@free.fr> parents: 8286 diff changeset	2033 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	2034
ac7f334d9652 Add contour group objects and the clabel function David Bateman <dbateman@free.fr> parents: 8286 diff changeset	2035 @item labelspacing
ac7f334d9652 Add contour group objects and the clabel function David Bateman <dbateman@free.fr> parents: 8286 diff changeset	2036 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	2037
ac7f334d9652 Add contour group objects and the clabel function David Bateman <dbateman@free.fr> parents: 8286 diff changeset	2038 @item linewidth
10828 322f43e0e170 Grammarcheck .txi documentation files. Rik <octave@nomad.inbox5.com> parents: 10711 diff changeset	2039
8289 ac7f334d9652 Add contour group objects and the clabel function David Bateman <dbateman@free.fr> parents: 8286 diff changeset	2040 @item linestyle
10828 322f43e0e170 Grammarcheck .txi documentation files. Rik <octave@nomad.inbox5.com> parents: 10711 diff changeset	2041
8289 ac7f334d9652 Add contour group objects and the clabel function David Bateman <dbateman@free.fr> parents: 8286 diff changeset	2042 @item linecolor
9040 dbd0c77e575e Cleanup documentation file plot.texi Rik <rdrider0-list@yahoo.com> parents: 9032 diff changeset	2043 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	2044 @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	2045 property @code{linecolor} is a color property (@pxref{Colors}), that can also
17281 bc924baa2c4e doc: Add new @qcode macro for code samples which are quoted. Rik <rik@octave.org> parents: 17170 diff changeset	2046 have the values of @qcode{"none"} or @qcode{"auto"}. If @code{linecolor} is
bc924baa2c4e doc: Add new @qcode macro for code samples which are quoted. Rik <rik@octave.org> parents: 17170 diff changeset	2047 @qcode{"none"}, then no contour line is drawn. If @code{linecolor} is
bc924baa2c4e doc: Add new @qcode macro for code samples which are quoted. Rik <rik@octave.org> parents: 17170 diff changeset	2048 @qcode{"auto"} then the line color is determined by the colormap.
8289 ac7f334d9652 Add contour group objects and the clabel function David Bateman <dbateman@free.fr> parents: 8286 diff changeset	2049
17170 d6499c14021c doc: Periodic grammarcheck of documentation. Rik <rik@octave.org> parents: 17152 diff changeset	2050 @item xdata
8289 ac7f334d9652 Add contour group objects and the clabel function David Bateman <dbateman@free.fr> parents: 8286 diff changeset	2051 @itemx ydata
ac7f334d9652 Add contour group objects and the clabel function David Bateman <dbateman@free.fr> parents: 8286 diff changeset	2052 @itemx zdata
ac7f334d9652 Add contour group objects and the clabel function David Bateman <dbateman@free.fr> parents: 8286 diff changeset	2053 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	2054
17170 d6499c14021c doc: Periodic grammarcheck of documentation. Rik <rik@octave.org> parents: 17152 diff changeset	2055 @item xdatasource
8289 ac7f334d9652 Add contour group objects and the clabel function David Bateman <dbateman@free.fr> parents: 8286 diff changeset	2056 @itemx ydatasource
ac7f334d9652 Add contour group objects and the clabel function David Bateman <dbateman@free.fr> parents: 8286 diff changeset	2057 @itemx zdatasource
ac7f334d9652 Add contour group objects and the clabel function David Bateman <dbateman@free.fr> parents: 8286 diff changeset	2058 Data source variables.
ac7f334d9652 Add contour group objects and the clabel function David Bateman <dbateman@free.fr> parents: 8286 diff changeset	2059 @end table
8056 9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them David Bateman <dbateman@free.fr> parents: 8055 diff changeset	2060
11257 8d4c57258523 fix some menu problems in the manual John W. Eaton <jwe@octave.org> parents: 11255 diff changeset	2061 @node Error Bar Series
8d4c57258523 fix some menu problems in the manual John W. Eaton <jwe@octave.org> parents: 11255 diff changeset	2062 @subsubsection Error Bar Series
8071 b6e85fb238c1 doc fixes John W. Eaton <jwe@octave.org> parents: 8070 diff changeset	2063 @cindex series objects
b6e85fb238c1 doc fixes John W. Eaton <jwe@octave.org> parents: 8070 diff changeset	2064 @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	2065
9672 43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	2066 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	2067 @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	2068 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	2069
2b408bbd8904 Add error bar series David Bateman <dbateman@free.fr> parents: 8257 diff changeset	2070 @table @code
2b408bbd8904 Add error bar series David Bateman <dbateman@free.fr> parents: 8257 diff changeset	2071 @item color
17469 710b3d5fe966 improve interpreter tex Tables Michael Godfrey <michaeldgodfrey@gmail.com> parents: 17281 diff changeset	2072 The RGB color or color name of the line objects of the error bars.
10828 322f43e0e170 Grammarcheck .txi documentation files. Rik <octave@nomad.inbox5.com> parents: 10711 diff changeset	2073 @xref{Colors}.
8258 2b408bbd8904 Add error bar series David Bateman <dbateman@free.fr> parents: 8257 diff changeset	2074
17170 d6499c14021c doc: Periodic grammarcheck of documentation. Rik <rik@octave.org> parents: 17152 diff changeset	2075 @item linewidth
8258 2b408bbd8904 Add error bar series David Bateman <dbateman@free.fr> parents: 8257 diff changeset	2076 @itemx linestyle
10828 322f43e0e170 Grammarcheck .txi documentation files. Rik <octave@nomad.inbox5.com> parents: 10711 diff changeset	2077 The line width and style of the line objects of the error bars. @xref{Line
322f43e0e170 Grammarcheck .txi documentation files. Rik <octave@nomad.inbox5.com> parents: 10711 diff changeset	2078 Styles}.
8258 2b408bbd8904 Add error bar series David Bateman <dbateman@free.fr> parents: 8257 diff changeset	2079
17170 d6499c14021c doc: Periodic grammarcheck of documentation. Rik <rik@octave.org> parents: 17152 diff changeset	2080 @item marker
8258 2b408bbd8904 Add error bar series David Bateman <dbateman@free.fr> parents: 8257 diff changeset	2081 @itemx markeredgecolor
2b408bbd8904 Add error bar series David Bateman <dbateman@free.fr> parents: 8257 diff changeset	2082 @itemx markerfacecolor
2b408bbd8904 Add error bar series David Bateman <dbateman@free.fr> parents: 8257 diff changeset	2083 @itemx markersize
9040 dbd0c77e575e Cleanup documentation file plot.texi Rik <rdrider0-list@yahoo.com> parents: 9032 diff changeset	2084 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	2085
17170 d6499c14021c doc: Periodic grammarcheck of documentation. Rik <rik@octave.org> parents: 17152 diff changeset	2086 @item xdata
8258 2b408bbd8904 Add error bar series David Bateman <dbateman@free.fr> parents: 8257 diff changeset	2087 @itemx ydata
2b408bbd8904 Add error bar series David Bateman <dbateman@free.fr> parents: 8257 diff changeset	2088 @itemx ldata
2b408bbd8904 Add error bar series David Bateman <dbateman@free.fr> parents: 8257 diff changeset	2089 @itemx udata
2b408bbd8904 Add error bar series David Bateman <dbateman@free.fr> parents: 8257 diff changeset	2090 @itemx xldata
2b408bbd8904 Add error bar series David Bateman <dbateman@free.fr> parents: 8257 diff changeset	2091 @itemx xudata
2b408bbd8904 Add error bar series David Bateman <dbateman@free.fr> parents: 8257 diff changeset	2092 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	2093
17170 d6499c14021c doc: Periodic grammarcheck of documentation. Rik <rik@octave.org> parents: 17152 diff changeset	2094 @item xdatasource
8258 2b408bbd8904 Add error bar series David Bateman <dbateman@free.fr> parents: 8257 diff changeset	2095 @itemx ydatasource
2b408bbd8904 Add error bar series David Bateman <dbateman@free.fr> parents: 8257 diff changeset	2096 @itemx ldatasource
2b408bbd8904 Add error bar series David Bateman <dbateman@free.fr> parents: 8257 diff changeset	2097 @itemx udatasource
2b408bbd8904 Add error bar series David Bateman <dbateman@free.fr> parents: 8257 diff changeset	2098 @itemx xldatasource
2b408bbd8904 Add error bar series David Bateman <dbateman@free.fr> parents: 8257 diff changeset	2099 @itemx xudatasource
2b408bbd8904 Add error bar series David Bateman <dbateman@free.fr> parents: 8257 diff changeset	2100 Data source variables.
2b408bbd8904 Add error bar series David Bateman <dbateman@free.fr> parents: 8257 diff changeset	2101 @end table
2b408bbd8904 Add error bar series David Bateman <dbateman@free.fr> parents: 8257 diff changeset	2102
11257 8d4c57258523 fix some menu problems in the manual John W. Eaton <jwe@octave.org> parents: 11255 diff changeset	2103 @node Line Series
8d4c57258523 fix some menu problems in the manual John W. Eaton <jwe@octave.org> parents: 11255 diff changeset	2104 @subsubsection Line Series
8071 b6e85fb238c1 doc fixes John W. Eaton <jwe@octave.org> parents: 8070 diff changeset	2105 @cindex series objects
b6e85fb238c1 doc fixes John W. Eaton <jwe@octave.org> parents: 8070 diff changeset	2106 @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	2107
8257 79c874fe5100 More plot object updates David Bateman <dbateman@free.fr> parents: 8089 diff changeset	2108 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	2109 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	2110 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	2111
3b53b25e2550 Add data sources and line series David Bateman <dbateman@free.fr> parents: 8057 diff changeset	2112 @table @code
3b53b25e2550 Add data sources and line series David Bateman <dbateman@free.fr> parents: 8057 diff changeset	2113 @item color
9040 dbd0c77e575e Cleanup documentation file plot.texi Rik <rdrider0-list@yahoo.com> parents: 9032 diff changeset	2114 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	2115
17170 d6499c14021c doc: Periodic grammarcheck of documentation. Rik <rik@octave.org> parents: 17152 diff changeset	2116 @item linewidth
8070 3b53b25e2550 Add data sources and line series David Bateman <dbateman@free.fr> parents: 8057 diff changeset	2117 @itemx linestyle
9040 dbd0c77e575e Cleanup documentation file plot.texi Rik <rdrider0-list@yahoo.com> parents: 9032 diff changeset	2118 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	2119
17170 d6499c14021c doc: Periodic grammarcheck of documentation. Rik <rik@octave.org> parents: 17152 diff changeset	2120 @item marker
8070 3b53b25e2550 Add data sources and line series David Bateman <dbateman@free.fr> parents: 8057 diff changeset	2121 @itemx markeredgecolor
3b53b25e2550 Add data sources and line series David Bateman <dbateman@free.fr> parents: 8057 diff changeset	2122 @itemx markerfacecolor
3b53b25e2550 Add data sources and line series David Bateman <dbateman@free.fr> parents: 8057 diff changeset	2123 @itemx markersize
9040 dbd0c77e575e Cleanup documentation file plot.texi Rik <rdrider0-list@yahoo.com> parents: 9032 diff changeset	2124 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	2125
17170 d6499c14021c doc: Periodic grammarcheck of documentation. Rik <rik@octave.org> parents: 17152 diff changeset	2126 @item xdata
8070 3b53b25e2550 Add data sources and line series David Bateman <dbateman@free.fr> parents: 8057 diff changeset	2127 @itemx ydata
3b53b25e2550 Add data sources and line series David Bateman <dbateman@free.fr> parents: 8057 diff changeset	2128 @itemx zdata
8257 79c874fe5100 More plot object updates David Bateman <dbateman@free.fr> parents: 8089 diff changeset	2129 The original x, y and z data.
8070 3b53b25e2550 Add data sources and line series David Bateman <dbateman@free.fr> parents: 8057 diff changeset	2130
17170 d6499c14021c doc: Periodic grammarcheck of documentation. Rik <rik@octave.org> parents: 17152 diff changeset	2131 @item xdatasource
8070 3b53b25e2550 Add data sources and line series David Bateman <dbateman@free.fr> parents: 8057 diff changeset	2132 @itemx ydatasource
3b53b25e2550 Add data sources and line series David Bateman <dbateman@free.fr> parents: 8057 diff changeset	2133 @itemx zdatasource
3b53b25e2550 Add data sources and line series David Bateman <dbateman@free.fr> parents: 8057 diff changeset	2134 Data source variables.
3b53b25e2550 Add data sources and line series David Bateman <dbateman@free.fr> parents: 8057 diff changeset	2135 @end table
8056 9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them David Bateman <dbateman@free.fr> parents: 8055 diff changeset	2136
11257 8d4c57258523 fix some menu problems in the manual John W. Eaton <jwe@octave.org> parents: 11255 diff changeset	2137 @node Quiver Group
8d4c57258523 fix some menu problems in the manual John W. Eaton <jwe@octave.org> parents: 11255 diff changeset	2138 @subsubsection Quiver Group
8071 b6e85fb238c1 doc fixes John W. Eaton <jwe@octave.org> parents: 8070 diff changeset	2139 @cindex group objects
b6e85fb238c1 doc fixes John W. Eaton <jwe@octave.org> parents: 8070 diff changeset	2140 @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	2141
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them David Bateman <dbateman@free.fr> parents: 8055 diff changeset	2142 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	2143 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	2144 objects as children representing the body and head of the arrow,
11365 4b4d5a4d7d0e Fix typo in Quiver section of plot.txi Rik <octave@nomad.inbox5.com> parents: 11330 diff changeset	2145 together with a marker as the point of origin of the arrows. The
8056 9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them David Bateman <dbateman@free.fr> parents: 8055 diff changeset	2146 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	2147
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them David Bateman <dbateman@free.fr> parents: 8055 diff changeset	2148 @table @code
17170 d6499c14021c doc: Periodic grammarcheck of documentation. Rik <rik@octave.org> parents: 17152 diff changeset	2149 @item autoscale
8056 9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them David Bateman <dbateman@free.fr> parents: 8055 diff changeset	2150 @itemx autoscalefactor
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them David Bateman <dbateman@free.fr> parents: 8055 diff changeset	2151 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	2152 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	2153 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	2154 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	2155
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them David Bateman <dbateman@free.fr> parents: 8055 diff changeset	2156 @item maxheadsize
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them David Bateman <dbateman@free.fr> parents: 8055 diff changeset	2157 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	2158 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	2159
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them David Bateman <dbateman@free.fr> parents: 8055 diff changeset	2160 @item showarrowhead
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them David Bateman <dbateman@free.fr> parents: 8055 diff changeset	2161 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	2162
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them David Bateman <dbateman@free.fr> parents: 8055 diff changeset	2163 @item color
9040 dbd0c77e575e Cleanup documentation file plot.texi Rik <rdrider0-list@yahoo.com> parents: 9032 diff changeset	2164 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	2165
17170 d6499c14021c doc: Periodic grammarcheck of documentation. Rik <rik@octave.org> parents: 17152 diff changeset	2166 @item linewidth
8056 9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them David Bateman <dbateman@free.fr> parents: 8055 diff changeset	2167 @itemx linestyle
9040 dbd0c77e575e Cleanup documentation file plot.texi Rik <rdrider0-list@yahoo.com> parents: 9032 diff changeset	2168 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	2169
17170 d6499c14021c doc: Periodic grammarcheck of documentation. Rik <rik@octave.org> parents: 17152 diff changeset	2170 @item marker
8056 9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them David Bateman <dbateman@free.fr> parents: 8055 diff changeset	2171 @itemx markerfacecolor
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them David Bateman <dbateman@free.fr> parents: 8055 diff changeset	2172 @itemx markersize
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them David Bateman <dbateman@free.fr> parents: 8055 diff changeset	2173 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	2174 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	2175
17170 d6499c14021c doc: Periodic grammarcheck of documentation. Rik <rik@octave.org> parents: 17152 diff changeset	2176 @item xdata
8056 9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them David Bateman <dbateman@free.fr> parents: 8055 diff changeset	2177 @itemx ydata
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them David Bateman <dbateman@free.fr> parents: 8055 diff changeset	2178 @itemx zdata
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them David Bateman <dbateman@free.fr> parents: 8055 diff changeset	2179 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	2180
17170 d6499c14021c doc: Periodic grammarcheck of documentation. Rik <rik@octave.org> parents: 17152 diff changeset	2181 @item udata
8056 9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them David Bateman <dbateman@free.fr> parents: 8055 diff changeset	2182 @itemx vdata
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them David Bateman <dbateman@free.fr> parents: 8055 diff changeset	2183 @itemx wdata
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them David Bateman <dbateman@free.fr> parents: 8055 diff changeset	2184 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	2185
17170 d6499c14021c doc: Periodic grammarcheck of documentation. Rik <rik@octave.org> parents: 17152 diff changeset	2186 @item xdatasource
8070 3b53b25e2550 Add data sources and line series David Bateman <dbateman@free.fr> parents: 8057 diff changeset	2187 @itemx ydatasource
3b53b25e2550 Add data sources and line series David Bateman <dbateman@free.fr> parents: 8057 diff changeset	2188 @itemx zdatasource
3b53b25e2550 Add data sources and line series David Bateman <dbateman@free.fr> parents: 8057 diff changeset	2189 @itemx udatasource
3b53b25e2550 Add data sources and line series David Bateman <dbateman@free.fr> parents: 8057 diff changeset	2190 @itemx vdatasource
3b53b25e2550 Add data sources and line series David Bateman <dbateman@free.fr> parents: 8057 diff changeset	2191 @itemx wdatasource
3b53b25e2550 Add data sources and line series David Bateman <dbateman@free.fr> parents: 8057 diff changeset	2192 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	2193 @end table
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them David Bateman <dbateman@free.fr> parents: 8055 diff changeset	2194
11257 8d4c57258523 fix some menu problems in the manual John W. Eaton <jwe@octave.org> parents: 11255 diff changeset	2195 @node Scatter Group
8d4c57258523 fix some menu problems in the manual John W. Eaton <jwe@octave.org> parents: 11255 diff changeset	2196 @subsubsection Scatter Group
8071 b6e85fb238c1 doc fixes John W. Eaton <jwe@octave.org> parents: 8070 diff changeset	2197 @cindex group objects
b6e85fb238c1 doc fixes John W. Eaton <jwe@octave.org> parents: 8070 diff changeset	2198 @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	2199
8257 79c874fe5100 More plot object updates David Bateman <dbateman@free.fr> parents: 8089 diff changeset	2200 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	2201 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	2202 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	2203 The properties of the stem series are
79c874fe5100 More plot object updates David Bateman <dbateman@free.fr> parents: 8089 diff changeset	2204
79c874fe5100 More plot object updates David Bateman <dbateman@free.fr> parents: 8089 diff changeset	2205 @table @code
79c874fe5100 More plot object updates David Bateman <dbateman@free.fr> parents: 8089 diff changeset	2206 @item linewidth
9040 dbd0c77e575e Cleanup documentation file plot.texi Rik <rdrider0-list@yahoo.com> parents: 9032 diff changeset	2207 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	2208
17170 d6499c14021c doc: Periodic grammarcheck of documentation. Rik <rik@octave.org> parents: 17152 diff changeset	2209 @item marker
8257 79c874fe5100 More plot object updates David Bateman <dbateman@free.fr> parents: 8089 diff changeset	2210 @itemx markeredgecolor
79c874fe5100 More plot object updates David Bateman <dbateman@free.fr> parents: 8089 diff changeset	2211 @itemx markerfacecolor
9040 dbd0c77e575e Cleanup documentation file plot.texi Rik <rdrider0-list@yahoo.com> parents: 9032 diff changeset	2212 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	2213
17170 d6499c14021c doc: Periodic grammarcheck of documentation. Rik <rik@octave.org> parents: 17152 diff changeset	2214 @item xdata
8257 79c874fe5100 More plot object updates David Bateman <dbateman@free.fr> parents: 8089 diff changeset	2215 @itemx ydata
79c874fe5100 More plot object updates David Bateman <dbateman@free.fr> parents: 8089 diff changeset	2216 @itemx zdata
79c874fe5100 More plot object updates David Bateman <dbateman@free.fr> parents: 8089 diff changeset	2217 The original x, y and z data of the stems.
79c874fe5100 More plot object updates David Bateman <dbateman@free.fr> parents: 8089 diff changeset	2218
79c874fe5100 More plot object updates David Bateman <dbateman@free.fr> parents: 8089 diff changeset	2219 @item cdata
9040 dbd0c77e575e Cleanup documentation file plot.texi Rik <rdrider0-list@yahoo.com> parents: 9032 diff changeset	2220 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	2221 color, or a unique color can be specified.
79c874fe5100 More plot object updates David Bateman <dbateman@free.fr> parents: 8089 diff changeset	2222
79c874fe5100 More plot object updates David Bateman <dbateman@free.fr> parents: 8089 diff changeset	2223 @item sizedata
9672 43a07df0ed4c document graphics structures Michael D. Godfrey <godfrey@isl.stanford.edu> parents: 9316 diff changeset	2224 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	2225 unique size can be specified.
79c874fe5100 More plot object updates David Bateman <dbateman@free.fr> parents: 8089 diff changeset	2226
17170 d6499c14021c doc: Periodic grammarcheck of documentation. Rik <rik@octave.org> parents: 17152 diff changeset	2227 @item xdatasource
8257 79c874fe5100 More plot object updates David Bateman <dbateman@free.fr> parents: 8089 diff changeset	2228 @itemx ydatasource
79c874fe5100 More plot object updates David Bateman <dbateman@free.fr> parents: 8089 diff changeset	2229 @itemx zdatasource
79c874fe5100 More plot object updates David Bateman <dbateman@free.fr> parents: 8089 diff changeset	2230 @itemx cdatasource
79c874fe5100 More plot object updates David Bateman <dbateman@free.fr> parents: 8089 diff changeset	2231 @itemx sizedatasource
79c874fe5100 More plot object updates David Bateman <dbateman@free.fr> parents: 8089 diff changeset	2232 Data source variables.
79c874fe5100 More plot object updates David Bateman <dbateman@free.fr> parents: 8089 diff changeset	2233 @end table
8056 9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them David Bateman <dbateman@free.fr> parents: 8055 diff changeset	2234
11257 8d4c57258523 fix some menu problems in the manual John W. Eaton <jwe@octave.org> parents: 11255 diff changeset	2235 @node Stair Group
8d4c57258523 fix some menu problems in the manual John W. Eaton <jwe@octave.org> parents: 11255 diff changeset	2236 @subsubsection Stair Group
8071 b6e85fb238c1 doc fixes John W. Eaton <jwe@octave.org> parents: 8070 diff changeset	2237 @cindex group objects
b6e85fb238c1 doc fixes John W. Eaton <jwe@octave.org> parents: 8070 diff changeset	2238 @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	2239
9040 dbd0c77e575e Cleanup documentation file plot.texi Rik <rdrider0-list@yahoo.com> parents: 9032 diff changeset	2240 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	2241 @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	2242 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	2243
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them David Bateman <dbateman@free.fr> parents: 8055 diff changeset	2244 @table @code
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them David Bateman <dbateman@free.fr> parents: 8055 diff changeset	2245 @item color
9040 dbd0c77e575e Cleanup documentation file plot.texi Rik <rdrider0-list@yahoo.com> parents: 9032 diff changeset	2246 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	2247
17170 d6499c14021c doc: Periodic grammarcheck of documentation. Rik <rik@octave.org> parents: 17152 diff changeset	2248 @item linewidth
8056 9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them David Bateman <dbateman@free.fr> parents: 8055 diff changeset	2249 @itemx linestyle
9040 dbd0c77e575e Cleanup documentation file plot.texi Rik <rdrider0-list@yahoo.com> parents: 9032 diff changeset	2250 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	2251
17170 d6499c14021c doc: Periodic grammarcheck of documentation. Rik <rik@octave.org> parents: 17152 diff changeset	2252 @item marker
8056 9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them David Bateman <dbateman@free.fr> parents: 8055 diff changeset	2253 @itemx markeredgecolor
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them David Bateman <dbateman@free.fr> parents: 8055 diff changeset	2254 @itemx markerfacecolor
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them David Bateman <dbateman@free.fr> parents: 8055 diff changeset	2255 @itemx markersize
9040 dbd0c77e575e Cleanup documentation file plot.texi Rik <rdrider0-list@yahoo.com> parents: 9032 diff changeset	2256 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	2257
17170 d6499c14021c doc: Periodic grammarcheck of documentation. Rik <rik@octave.org> parents: 17152 diff changeset	2258 @item xdata
8056 9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them David Bateman <dbateman@free.fr> parents: 8055 diff changeset	2259 @itemx ydata
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them David Bateman <dbateman@free.fr> parents: 8055 diff changeset	2260 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	2261
17170 d6499c14021c doc: Periodic grammarcheck of documentation. Rik <rik@octave.org> parents: 17152 diff changeset	2262 @item xdatasource
8070 3b53b25e2550 Add data sources and line series David Bateman <dbateman@free.fr> parents: 8057 diff changeset	2263 @itemx ydatasource
3b53b25e2550 Add data sources and line series David Bateman <dbateman@free.fr> parents: 8057 diff changeset	2264 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	2265 @end table
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them David Bateman <dbateman@free.fr> parents: 8055 diff changeset	2266
8073 8468140fd997 doc fix John W. Eaton <jwe@octave.org> parents: 8071 diff changeset	2267 @node Stem Series
8468140fd997 doc fix John W. Eaton <jwe@octave.org> parents: 8071 diff changeset	2268 @subsubsection Stem Series
8468140fd997 doc fix John W. Eaton <jwe@octave.org> parents: 8071 diff changeset	2269 @cindex series objects
8468140fd997 doc fix John W. Eaton <jwe@octave.org> parents: 8071 diff changeset	2270 @cindex stem series
8468140fd997 doc fix John W. Eaton <jwe@octave.org> parents: 8071 diff changeset	2271
8257 79c874fe5100 More plot object updates David Bateman <dbateman@free.fr> parents: 8089 diff changeset	2272 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	2273 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	2274 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	2275 are
79c874fe5100 More plot object updates David Bateman <dbateman@free.fr> parents: 8089 diff changeset	2276
79c874fe5100 More plot object updates David Bateman <dbateman@free.fr> parents: 8089 diff changeset	2277 @table @code
17170 d6499c14021c doc: Periodic grammarcheck of documentation. Rik <rik@octave.org> parents: 17152 diff changeset	2278 @item showbaseline
8257 79c874fe5100 More plot object updates David Bateman <dbateman@free.fr> parents: 8089 diff changeset	2279 @itemx baseline
79c874fe5100 More plot object updates David Bateman <dbateman@free.fr> parents: 8089 diff changeset	2280 @itemx basevalue
79c874fe5100 More plot object updates David Bateman <dbateman@free.fr> parents: 8089 diff changeset	2281 The property @code{showbaseline} flags whether the baseline of the
17281 bc924baa2c4e doc: Add new @qcode macro for code samples which are quoted. Rik <rik@octave.org> parents: 17170 diff changeset	2282 stem series is displayed (default is @qcode{"on"}). The handle of the graphics
8257 79c874fe5100 More plot object updates David Bateman <dbateman@free.fr> parents: 8089 diff changeset	2283 object representing the baseline is given by the @code{baseline}
79c874fe5100 More plot object updates David Bateman <dbateman@free.fr> parents: 8089 diff changeset	2284 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	2285 by the @code{basevalue} property.
79c874fe5100 More plot object updates David Bateman <dbateman@free.fr> parents: 8089 diff changeset	2286
79c874fe5100 More plot object updates David Bateman <dbateman@free.fr> parents: 8089 diff changeset	2287 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	2288 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	2289 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	2290 corresponding stem series.
79c874fe5100 More plot object updates David Bateman <dbateman@free.fr> parents: 8089 diff changeset	2291
79c874fe5100 More plot object updates David Bateman <dbateman@free.fr> parents: 8089 diff changeset	2292 @item color
9040 dbd0c77e575e Cleanup documentation file plot.texi Rik <rdrider0-list@yahoo.com> parents: 9032 diff changeset	2293 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	2294
17170 d6499c14021c doc: Periodic grammarcheck of documentation. Rik <rik@octave.org> parents: 17152 diff changeset	2295 @item linewidth
8257 79c874fe5100 More plot object updates David Bateman <dbateman@free.fr> parents: 8089 diff changeset	2296 @itemx linestyle
9040 dbd0c77e575e Cleanup documentation file plot.texi Rik <rdrider0-list@yahoo.com> parents: 9032 diff changeset	2297 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	2298
17170 d6499c14021c doc: Periodic grammarcheck of documentation. Rik <rik@octave.org> parents: 17152 diff changeset	2299 @item marker
8257 79c874fe5100 More plot object updates David Bateman <dbateman@free.fr> parents: 8089 diff changeset	2300 @itemx markeredgecolor
79c874fe5100 More plot object updates David Bateman <dbateman@free.fr> parents: 8089 diff changeset	2301 @itemx markerfacecolor
79c874fe5100 More plot object updates David Bateman <dbateman@free.fr> parents: 8089 diff changeset	2302 @itemx markersize
9040 dbd0c77e575e Cleanup documentation file plot.texi Rik <rdrider0-list@yahoo.com> parents: 9032 diff changeset	2303 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	2304
17170 d6499c14021c doc: Periodic grammarcheck of documentation. Rik <rik@octave.org> parents: 17152 diff changeset	2305 @item xdata
8257 79c874fe5100 More plot object updates David Bateman <dbateman@free.fr> parents: 8089 diff changeset	2306 @itemx ydata
79c874fe5100 More plot object updates David Bateman <dbateman@free.fr> parents: 8089 diff changeset	2307 @itemx zdata
79c874fe5100 More plot object updates David Bateman <dbateman@free.fr> parents: 8089 diff changeset	2308 The original x, y and z data of the stems.
79c874fe5100 More plot object updates David Bateman <dbateman@free.fr> parents: 8089 diff changeset	2309
17170 d6499c14021c doc: Periodic grammarcheck of documentation. Rik <rik@octave.org> parents: 17152 diff changeset	2310 @item xdatasource
8257 79c874fe5100 More plot object updates David Bateman <dbateman@free.fr> parents: 8089 diff changeset	2311 @itemx ydatasource
79c874fe5100 More plot object updates David Bateman <dbateman@free.fr> parents: 8089 diff changeset	2312 @itemx zdatasource
79c874fe5100 More plot object updates David Bateman <dbateman@free.fr> parents: 8089 diff changeset	2313 Data source variables.
79c874fe5100 More plot object updates David Bateman <dbateman@free.fr> parents: 8089 diff changeset	2314 @end table
8073 8468140fd997 doc fix John W. Eaton <jwe@octave.org> parents: 8071 diff changeset	2315
11257 8d4c57258523 fix some menu problems in the manual John W. Eaton <jwe@octave.org> parents: 11255 diff changeset	2316 @node Surface Group
8d4c57258523 fix some menu problems in the manual John W. Eaton <jwe@octave.org> parents: 11255 diff changeset	2317 @subsubsection Surface Group
8071 b6e85fb238c1 doc fixes John W. Eaton <jwe@octave.org> parents: 8070 diff changeset	2318 @cindex group objects
b6e85fb238c1 doc fixes John W. Eaton <jwe@octave.org> parents: 8070 diff changeset	2319 @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	2320
8257 79c874fe5100 More plot object updates David Bateman <dbateman@free.fr> parents: 8089 diff changeset	2321 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	2322 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	2323 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	2324
79c874fe5100 More plot object updates David Bateman <dbateman@free.fr> parents: 8089 diff changeset	2325 The properties of the surface group are
79c874fe5100 More plot object updates David Bateman <dbateman@free.fr> parents: 8089 diff changeset	2326
79c874fe5100 More plot object updates David Bateman <dbateman@free.fr> parents: 8089 diff changeset	2327 @table @code
79c874fe5100 More plot object updates David Bateman <dbateman@free.fr> parents: 8089 diff changeset	2328 @item edgecolor
10828 322f43e0e170 Grammarcheck .txi documentation files. Rik <octave@nomad.inbox5.com> parents: 10711 diff changeset	2329
8257 79c874fe5100 More plot object updates David Bateman <dbateman@free.fr> parents: 8089 diff changeset	2330 @item facecolor
17469 710b3d5fe966 improve interpreter tex Tables Michael Godfrey <michaeldgodfrey@gmail.com> parents: 17281 diff changeset	2331 The RGB color or color name of the edges or faces of the surface.
10828 322f43e0e170 Grammarcheck .txi documentation files. Rik <octave@nomad.inbox5.com> parents: 10711 diff changeset	2332 @xref{Colors}.
8257 79c874fe5100 More plot object updates David Bateman <dbateman@free.fr> parents: 8089 diff changeset	2333
17170 d6499c14021c doc: Periodic grammarcheck of documentation. Rik <rik@octave.org> parents: 17152 diff changeset	2334 @item linewidth
8257 79c874fe5100 More plot object updates David Bateman <dbateman@free.fr> parents: 8089 diff changeset	2335 @itemx linestyle
9040 dbd0c77e575e Cleanup documentation file plot.texi Rik <rdrider0-list@yahoo.com> parents: 9032 diff changeset	2336 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	2337
17170 d6499c14021c doc: Periodic grammarcheck of documentation. Rik <rik@octave.org> parents: 17152 diff changeset	2338 @item marker
8257 79c874fe5100 More plot object updates David Bateman <dbateman@free.fr> parents: 8089 diff changeset	2339 @itemx markeredgecolor
79c874fe5100 More plot object updates David Bateman <dbateman@free.fr> parents: 8089 diff changeset	2340 @itemx markerfacecolor
79c874fe5100 More plot object updates David Bateman <dbateman@free.fr> parents: 8089 diff changeset	2341 @itemx markersize
9040 dbd0c77e575e Cleanup documentation file plot.texi Rik <rdrider0-list@yahoo.com> parents: 9032 diff changeset	2342 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	2343
17170 d6499c14021c doc: Periodic grammarcheck of documentation. Rik <rik@octave.org> parents: 17152 diff changeset	2344 @item xdata
8257 79c874fe5100 More plot object updates David Bateman <dbateman@free.fr> parents: 8089 diff changeset	2345 @itemx ydata
79c874fe5100 More plot object updates David Bateman <dbateman@free.fr> parents: 8089 diff changeset	2346 @itemx zdata
10828 322f43e0e170 Grammarcheck .txi documentation files. Rik <octave@nomad.inbox5.com> parents: 10711 diff changeset	2347 @itemx cdata
8257 79c874fe5100 More plot object updates David Bateman <dbateman@free.fr> parents: 8089 diff changeset	2348 The original x, y, z and c data.
79c874fe5100 More plot object updates David Bateman <dbateman@free.fr> parents: 8089 diff changeset	2349
17170 d6499c14021c doc: Periodic grammarcheck of documentation. Rik <rik@octave.org> parents: 17152 diff changeset	2350 @item xdatasource
8257 79c874fe5100 More plot object updates David Bateman <dbateman@free.fr> parents: 8089 diff changeset	2351 @itemx ydatasource
79c874fe5100 More plot object updates David Bateman <dbateman@free.fr> parents: 8089 diff changeset	2352 @itemx zdatasource
79c874fe5100 More plot object updates David Bateman <dbateman@free.fr> parents: 8089 diff changeset	2353 @itemx cdatasource
79c874fe5100 More plot object updates David Bateman <dbateman@free.fr> parents: 8089 diff changeset	2354 Data source variables.
79c874fe5100 More plot object updates David Bateman <dbateman@free.fr> parents: 8089 diff changeset	2355 @end table
8056 9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them David Bateman <dbateman@free.fr> parents: 8055 diff changeset	2356
11576 8ac9687dbe9f rename backend to graphics_toolkit John W. Eaton <jwe@octave.org> parents: 11573 diff changeset	2357 @node Graphics Toolkits
8ac9687dbe9f rename backend to graphics_toolkit John W. Eaton <jwe@octave.org> parents: 11573 diff changeset	2358 @subsection Graphics Toolkits
8ac9687dbe9f rename backend to graphics_toolkit John W. Eaton <jwe@octave.org> parents: 11573 diff changeset	2359 @cindex graphics toolkits
8ac9687dbe9f rename backend to graphics_toolkit John W. Eaton <jwe@octave.org> parents: 11573 diff changeset	2360 @cindex toolkits, graphics
8ac9687dbe9f rename backend to graphics_toolkit John W. Eaton <jwe@octave.org> parents: 11573 diff changeset	2361
8ac9687dbe9f rename backend to graphics_toolkit John W. Eaton <jwe@octave.org> parents: 11573 diff changeset	2362 @DOCSTRING(graphics_toolkit)
8ac9687dbe9f rename backend to graphics_toolkit John W. Eaton <jwe@octave.org> parents: 11573 diff changeset	2363
8ac9687dbe9f rename backend to graphics_toolkit John W. Eaton <jwe@octave.org> parents: 11573 diff changeset	2364 @DOCSTRING(available_graphics_toolkits)
8056 9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them David Bateman <dbateman@free.fr> parents: 8055 diff changeset	2365
14134 84f38aeb9f0e doc: Add register_graphics_toolkit() and loaded_graphics_toolkits() to documentation Rik <octave@nomad.inbox5.com> parents: 13947 diff changeset	2366 @DOCSTRING(loaded_graphics_toolkits)
84f38aeb9f0e doc: Add register_graphics_toolkit() and loaded_graphics_toolkits() to documentation Rik <octave@nomad.inbox5.com> parents: 13947 diff changeset	2367
84f38aeb9f0e doc: Add register_graphics_toolkit() and loaded_graphics_toolkits() to documentation Rik <octave@nomad.inbox5.com> parents: 13947 diff changeset	2368 @DOCSTRING(register_graphics_toolkit)
84f38aeb9f0e doc: Add register_graphics_toolkit() and loaded_graphics_toolkits() to documentation Rik <octave@nomad.inbox5.com> parents: 13947 diff changeset	2369
8056 9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them David Bateman <dbateman@free.fr> parents: 8055 diff changeset	2370 @menu
17152 f2a8592b8fbd doc: Shorten some long subsection names in Manual. Rik <rik@octave.org> parents: 17123 diff changeset	2371 * Customizing Toolkit Behavior::
8056 9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them David Bateman <dbateman@free.fr> parents: 8055 diff changeset	2372 @end menu
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them David Bateman <dbateman@free.fr> parents: 8055 diff changeset	2373
12226 8cc154f45e37 Rename fltk_mouse_wheel_zoom, fltk_gui_mode functions to remove fltk_ prefix. Rik <octave@nomad.inbox5.com> parents: 12215 diff changeset	2374 @node Customizing Toolkit Behavior
8cc154f45e37 Rename fltk_mouse_wheel_zoom, fltk_gui_mode functions to remove fltk_ prefix. Rik <octave@nomad.inbox5.com> parents: 12215 diff changeset	2375 @subsubsection Customizing Toolkit Behavior
8cc154f45e37 Rename fltk_mouse_wheel_zoom, fltk_gui_mode functions to remove fltk_ prefix. Rik <octave@nomad.inbox5.com> parents: 12215 diff changeset	2376 @cindex toolkit customization
8cc154f45e37 Rename fltk_mouse_wheel_zoom, fltk_gui_mode functions to remove fltk_ prefix. Rik <octave@nomad.inbox5.com> parents: 12215 diff changeset	2377
8cc154f45e37 Rename fltk_mouse_wheel_zoom, fltk_gui_mode functions to remove fltk_ prefix. Rik <octave@nomad.inbox5.com> parents: 12215 diff changeset	2378 The specific behavior of the backend toolkit may be modified using the
8cc154f45e37 Rename fltk_mouse_wheel_zoom, fltk_gui_mode functions to remove fltk_ prefix. Rik <octave@nomad.inbox5.com> parents: 12215 diff changeset	2379 following utility functions. Note: Not all functions apply to every
8cc154f45e37 Rename fltk_mouse_wheel_zoom, fltk_gui_mode functions to remove fltk_ prefix. Rik <octave@nomad.inbox5.com> parents: 12215 diff changeset	2380 graphics toolkit.
3428 5b77cf82393c [project @ 2000-01-14 02:54:53 by jwe] jwe parents: 3368 diff changeset	2381
5b77cf82393c [project @ 2000-01-14 02:54:53 by jwe] jwe parents: 3368 diff changeset	2382 @DOCSTRING(gnuplot_binary)