Mercurial > hg > octave-nkf

annotate scripts/plot/plot.m @ 17204:d87179b38bcf

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
doc: Touch up alignment of @multitables in plot, legend, newplot. * scripts/plot/legend.m, scripts/plot/newplot.m, scripts/plot/plot.m: Don't use spacer rows between multitable items.
author Rik <rik@octave.org>
date Wed, 07 Aug 2013 22:20:32 -0700
parents 85e55da61409
children 87ba70043bfc
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
14138
72c96de7a403 maint: update copyright notices for 2012
John W. Eaton <jwe@octave.org>
parents: 14001
diff changeset
1 ## Copyright (C) 1993-2012 John W. Eaton
2313
5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe]
jwe
parents: 2311
diff changeset
2 ##
5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe]
jwe
parents: 2311
diff changeset
3 ## This file is part of Octave.
5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe]
jwe
parents: 2311
diff changeset
4 ##
5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe]
jwe
parents: 2311
diff changeset
5 ## Octave is free software; you can redistribute it and/or modify it
5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe]
jwe
parents: 2311
diff changeset
6 ## under the terms of the GNU General Public License as published by
7016
93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe]
jwe
parents: 6895
diff changeset
7 ## the Free Software Foundation; either version 3 of the License, or (at
93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe]
jwe
parents: 6895
diff changeset
8 ## your option) any later version.
2313
5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe]
jwe
parents: 2311
diff changeset
9 ##
5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe]
jwe
parents: 2311
diff changeset
10 ## Octave is distributed in the hope that it will be useful, but
5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe]
jwe
parents: 2311
diff changeset
11 ## WITHOUT ANY WARRANTY; without even the implied warranty of
5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe]
jwe
parents: 2311
diff changeset
12 ## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe]
jwe
parents: 2311
diff changeset
13 ## General Public License for more details.
5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe]
jwe
parents: 2311
diff changeset
14 ##
5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe]
jwe
parents: 2311
diff changeset
15 ## You should have received a copy of the GNU General Public License
7016
93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe]
jwe
parents: 6895
diff changeset
16 ## along with Octave; see the file COPYING. If not, see
93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe]
jwe
parents: 6895
diff changeset
17 ## <http://www.gnu.org/licenses/>.
245
16a24e76d6e0 [project @ 1993-12-03 02:00:15 by jwe]
jwe
parents: 4
diff changeset
18
3368
a4cd1e9d9962 [project @ 1999-11-20 17:22:48 by jwe]
jwe
parents: 3063
diff changeset
19 ## -*- texinfo -*-
10687
a8ce6bdecce5 Improve documentation strings.
Rik <octave@nomad.inbox5.com>
parents: 10121
diff changeset
20 ## @deftypefn {Function File} {} plot (@var{y})
6895
76e3d985ae56 [project @ 2007-09-13 18:22:38 by jwe]
jwe
parents: 6828
diff changeset
21 ## @deftypefnx {Function File} {} plot (@var{x}, @var{y})
76e3d985ae56 [project @ 2007-09-13 18:22:38 by jwe]
jwe
parents: 6828
diff changeset
22 ## @deftypefnx {Function File} {} plot (@var{x}, @var{y}, @var{fmt})
17191
85e55da61409 doc: Clarify description of plot format.
Rik <rik@octave.org>
parents: 17190
diff changeset
23 ## @deftypefnx {Function File} {} plot (@dots{}, @var{property}, @var{value}, @dots{})
85e55da61409 doc: Clarify description of plot format.
Rik <rik@octave.org>
parents: 17190
diff changeset
24 ## @deftypefnx {Function File} {} plot (@var{x1}, @var{y1}, @dots{}, @var{xn}, @var{yn})
17122
eaab03308c0b doc: Rewrite docstrings for most plot functions.
Rik <rik@octave.org>
parents: 17036
diff changeset
25 ## @deftypefnx {Function File} {} plot (@var{hax}, @dots{})
10687
a8ce6bdecce5 Improve documentation strings.
Rik <octave@nomad.inbox5.com>
parents: 10121
diff changeset
26 ## @deftypefnx {Function File} {@var{h} =} plot (@dots{})
17122
eaab03308c0b doc: Rewrite docstrings for most plot functions.
Rik <rik@octave.org>
parents: 17036
diff changeset
27 ## Produce 2-D plots.
11587
c792872f8942 all script files: untabify and strip trailing whitespace
John W. Eaton <jwe@octave.org>
parents: 11523
diff changeset
28 ##
11316
b7ff4a51ea88 plot.m: Eliminate present tense in first sentence of docstring.
Rik <octave@nomad.inbox5.com>
parents: 10791
diff changeset
29 ## Many different combinations of arguments are possible. The simplest
b7ff4a51ea88 plot.m: Eliminate present tense in first sentence of docstring.
Rik <octave@nomad.inbox5.com>
parents: 10791
diff changeset
30 ## form is
3426
f8dde1807dee [project @ 2000-01-13 08:40:00 by jwe]
jwe
parents: 3408
diff changeset
31 ##
3368
a4cd1e9d9962 [project @ 1999-11-20 17:22:48 by jwe]
jwe
parents: 3063
diff changeset
32 ## @example
a4cd1e9d9962 [project @ 1999-11-20 17:22:48 by jwe]
jwe
parents: 3063
diff changeset
33 ## plot (@var{y})
a4cd1e9d9962 [project @ 1999-11-20 17:22:48 by jwe]
jwe
parents: 3063
diff changeset
34 ## @end example
3426
f8dde1807dee [project @ 2000-01-13 08:40:00 by jwe]
jwe
parents: 3408
diff changeset
35 ##
3368
a4cd1e9d9962 [project @ 1999-11-20 17:22:48 by jwe]
jwe
parents: 3063
diff changeset
36 ## @noindent
a4cd1e9d9962 [project @ 1999-11-20 17:22:48 by jwe]
jwe
parents: 3063
diff changeset
37 ## where the argument is taken as the set of @var{y} coordinates and the
17191
85e55da61409 doc: Clarify description of plot format.
Rik <rik@octave.org>
parents: 17190
diff changeset
38 ## @var{x} coordinates are taken to be the range @code{1:numel (@var{y})}.
5798
7e7ed81f5566 [project @ 2006-05-09 17:24:33 by jwe]
jwe
parents: 5775
diff changeset
39 ##
3368
a4cd1e9d9962 [project @ 1999-11-20 17:22:48 by jwe]
jwe
parents: 3063
diff changeset
40 ## If more than one argument is given, they are interpreted as
3426
f8dde1807dee [project @ 2000-01-13 08:40:00 by jwe]
jwe
parents: 3408
diff changeset
41 ##
3368
a4cd1e9d9962 [project @ 1999-11-20 17:22:48 by jwe]
jwe
parents: 3063
diff changeset
42 ## @example
6895
76e3d985ae56 [project @ 2007-09-13 18:22:38 by jwe]
jwe
parents: 6828
diff changeset
43 ## plot (@var{y}, @var{property}, @var{value}, @dots{})
3368
a4cd1e9d9962 [project @ 1999-11-20 17:22:48 by jwe]
jwe
parents: 3063
diff changeset
44 ## @end example
3426
f8dde1807dee [project @ 2000-01-13 08:40:00 by jwe]
jwe
parents: 3408
diff changeset
45 ##
3368
a4cd1e9d9962 [project @ 1999-11-20 17:22:48 by jwe]
jwe
parents: 3063
diff changeset
46 ## @noindent
6895
76e3d985ae56 [project @ 2007-09-13 18:22:38 by jwe]
jwe
parents: 6828
diff changeset
47 ## or
6459
5dc550e1f419 [project @ 2007-03-26 18:11:58 by jwe]
jwe
parents: 6448
diff changeset
48 ##
5dc550e1f419 [project @ 2007-03-26 18:11:58 by jwe]
jwe
parents: 6448
diff changeset
49 ## @example
5dc550e1f419 [project @ 2007-03-26 18:11:58 by jwe]
jwe
parents: 6448
diff changeset
50 ## plot (@var{x}, @var{y}, @var{property}, @var{value}, @dots{})
5dc550e1f419 [project @ 2007-03-26 18:11:58 by jwe]
jwe
parents: 6448
diff changeset
51 ## @end example
5dc550e1f419 [project @ 2007-03-26 18:11:58 by jwe]
jwe
parents: 6448
diff changeset
52 ##
5dc550e1f419 [project @ 2007-03-26 18:11:58 by jwe]
jwe
parents: 6448
diff changeset
53 ## @noindent
6895
76e3d985ae56 [project @ 2007-09-13 18:22:38 by jwe]
jwe
parents: 6828
diff changeset
54 ## or
76e3d985ae56 [project @ 2007-09-13 18:22:38 by jwe]
jwe
parents: 6828
diff changeset
55 ##
76e3d985ae56 [project @ 2007-09-13 18:22:38 by jwe]
jwe
parents: 6828
diff changeset
56 ## @example
76e3d985ae56 [project @ 2007-09-13 18:22:38 by jwe]
jwe
parents: 6828
diff changeset
57 ## plot (@var{x}, @var{y}, @var{fmt}, @dots{})
76e3d985ae56 [project @ 2007-09-13 18:22:38 by jwe]
jwe
parents: 6828
diff changeset
58 ## @end example
76e3d985ae56 [project @ 2007-09-13 18:22:38 by jwe]
jwe
parents: 6828
diff changeset
59 ##
76e3d985ae56 [project @ 2007-09-13 18:22:38 by jwe]
jwe
parents: 6828
diff changeset
60 ## @noindent
76e3d985ae56 [project @ 2007-09-13 18:22:38 by jwe]
jwe
parents: 6828
diff changeset
61 ## and so on. Any number of argument sets may appear. The @var{x} and
76e3d985ae56 [project @ 2007-09-13 18:22:38 by jwe]
jwe
parents: 6828
diff changeset
62 ## @var{y} values are interpreted as follows:
3426
f8dde1807dee [project @ 2000-01-13 08:40:00 by jwe]
jwe
parents: 3408
diff changeset
63 ##
3368
a4cd1e9d9962 [project @ 1999-11-20 17:22:48 by jwe]
jwe
parents: 3063
diff changeset
64 ## @itemize @bullet
a4cd1e9d9962 [project @ 1999-11-20 17:22:48 by jwe]
jwe
parents: 3063
diff changeset
65 ## @item
a4cd1e9d9962 [project @ 1999-11-20 17:22:48 by jwe]
jwe
parents: 3063
diff changeset
66 ## If a single data argument is supplied, it is taken as the set of @var{y}
a4cd1e9d9962 [project @ 1999-11-20 17:22:48 by jwe]
jwe
parents: 3063
diff changeset
67 ## coordinates and the @var{x} coordinates are taken to be the indices of
a4cd1e9d9962 [project @ 1999-11-20 17:22:48 by jwe]
jwe
parents: 3063
diff changeset
68 ## the elements, starting with 1.
3426
f8dde1807dee [project @ 2000-01-13 08:40:00 by jwe]
jwe
parents: 3408
diff changeset
69 ##
3368
a4cd1e9d9962 [project @ 1999-11-20 17:22:48 by jwe]
jwe
parents: 3063
diff changeset
70 ## @item
17191
85e55da61409 doc: Clarify description of plot format.
Rik <rik@octave.org>
parents: 17190
diff changeset
71 ## If @var{x} and @var{y} are scalars, a single point is plotted.
85e55da61409 doc: Clarify description of plot format.
Rik <rik@octave.org>
parents: 17190
diff changeset
72 ##
85e55da61409 doc: Clarify description of plot format.
Rik <rik@octave.org>
parents: 17190
diff changeset
73 ## @item
85e55da61409 doc: Clarify description of plot format.
Rik <rik@octave.org>
parents: 17190
diff changeset
74 ## If both arguments are vectors, the elements of @var{y} are plotted versus
85e55da61409 doc: Clarify description of plot format.
Rik <rik@octave.org>
parents: 17190
diff changeset
75 ## the elements of @var{x}.
85e55da61409 doc: Clarify description of plot format.
Rik <rik@octave.org>
parents: 17190
diff changeset
76 ##
85e55da61409 doc: Clarify description of plot format.
Rik <rik@octave.org>
parents: 17190
diff changeset
77 ## @item
85e55da61409 doc: Clarify description of plot format.
Rik <rik@octave.org>
parents: 17190
diff changeset
78 ## If @var{x} is a vector and @var{y} is a matrix, then
6177
6ac0c826459e [project @ 2006-11-16 18:49:38 by jwe]
jwe
parents: 5798
diff changeset
79 ## the columns (or rows) of @var{y} are plotted versus @var{x}.
2311
2b5788792cad [project @ 1996-07-11 20:18:38 by jwe]
jwe
parents: 2303
diff changeset
80 ## (using whichever combination matches, with columns tried first.)
3426
f8dde1807dee [project @ 2000-01-13 08:40:00 by jwe]
jwe
parents: 3408
diff changeset
81 ##
3368
a4cd1e9d9962 [project @ 1999-11-20 17:22:48 by jwe]
jwe
parents: 3063
diff changeset
82 ## @item
6177
6ac0c826459e [project @ 2006-11-16 18:49:38 by jwe]
jwe
parents: 5798
diff changeset
83 ## If the @var{x} is a matrix and @var{y} is a vector,
6ac0c826459e [project @ 2006-11-16 18:49:38 by jwe]
jwe
parents: 5798
diff changeset
84 ## @var{y} is plotted versus the columns (or rows) of @var{x}.
2311
2b5788792cad [project @ 1996-07-11 20:18:38 by jwe]
jwe
parents: 2303
diff changeset
85 ## (using whichever combination matches, with columns tried first.)
3426
f8dde1807dee [project @ 2000-01-13 08:40:00 by jwe]
jwe
parents: 3408
diff changeset
86 ##
3368
a4cd1e9d9962 [project @ 1999-11-20 17:22:48 by jwe]
jwe
parents: 3063
diff changeset
87 ## @item
a4cd1e9d9962 [project @ 1999-11-20 17:22:48 by jwe]
jwe
parents: 3063
diff changeset
88 ## If both arguments are matrices, the columns of @var{y} are plotted
a4cd1e9d9962 [project @ 1999-11-20 17:22:48 by jwe]
jwe
parents: 3063
diff changeset
89 ## versus the columns of @var{x}. In this case, both matrices must have
a4cd1e9d9962 [project @ 1999-11-20 17:22:48 by jwe]
jwe
parents: 3063
diff changeset
90 ## the same number of rows and columns and no attempt is made to transpose
a4cd1e9d9962 [project @ 1999-11-20 17:22:48 by jwe]
jwe
parents: 3063
diff changeset
91 ## the arguments to make the number of rows match.
a4cd1e9d9962 [project @ 1999-11-20 17:22:48 by jwe]
jwe
parents: 3063
diff changeset
92 ## @end itemize
3426
f8dde1807dee [project @ 2000-01-13 08:40:00 by jwe]
jwe
parents: 3408
diff changeset
93 ##
6895
76e3d985ae56 [project @ 2007-09-13 18:22:38 by jwe]
jwe
parents: 6828
diff changeset
94 ## Multiple property-value pairs may be specified, but they must appear
17122
eaab03308c0b doc: Rewrite docstrings for most plot functions.
Rik <rik@octave.org>
parents: 17036
diff changeset
95 ## in pairs. These arguments are applied to the line objects drawn by
17191
85e55da61409 doc: Clarify description of plot format.
Rik <rik@octave.org>
parents: 17190
diff changeset
96 ## @code{plot}. Useful properties to modify are "linestyle", "linewidth",
85e55da61409 doc: Clarify description of plot format.
Rik <rik@octave.org>
parents: 17190
diff changeset
97 ## "color", "marker", "markersize", "markeredgecolor", "markerfacecolor".
3426
f8dde1807dee [project @ 2000-01-13 08:40:00 by jwe]
jwe
parents: 3408
diff changeset
98 ##
17191
85e55da61409 doc: Clarify description of plot format.
Rik <rik@octave.org>
parents: 17190
diff changeset
99 ## The @var{fmt} format argument can also be used to control the plot style.
85e55da61409 doc: Clarify description of plot format.
Rik <rik@octave.org>
parents: 17190
diff changeset
100 ## The format is composed of three parts: linestyle, markerstyle, color.
85e55da61409 doc: Clarify description of plot format.
Rik <rik@octave.org>
parents: 17190
diff changeset
101 ## When a markerstyle is specified, but no linestyle, only the markers are
85e55da61409 doc: Clarify description of plot format.
Rik <rik@octave.org>
parents: 17190
diff changeset
102 ## plotted. Similarly, if a linestyle is specified, but no markerstyle, then
85e55da61409 doc: Clarify description of plot format.
Rik <rik@octave.org>
parents: 17190
diff changeset
103 ## only lines are drawn. If both are specified then lines and markers will
85e55da61409 doc: Clarify description of plot format.
Rik <rik@octave.org>
parents: 17190
diff changeset
104 ## be plotted. If no @var{fmt} and no @var{property}/@var{value} pairs are
85e55da61409 doc: Clarify description of plot format.
Rik <rik@octave.org>
parents: 17190
diff changeset
105 ## given, then the default plot style is solid lines with no markers and the
85e55da61409 doc: Clarify description of plot format.
Rik <rik@octave.org>
parents: 17190
diff changeset
106 ## color determined by the "colororder" property of the current axes.
3426
f8dde1807dee [project @ 2000-01-13 08:40:00 by jwe]
jwe
parents: 3408
diff changeset
107 ##
17191
85e55da61409 doc: Clarify description of plot format.
Rik <rik@octave.org>
parents: 17190
diff changeset
108 ## Format arguments:
3426
f8dde1807dee [project @ 2000-01-13 08:40:00 by jwe]
jwe
parents: 3408
diff changeset
109 ##
17191
85e55da61409 doc: Clarify description of plot format.
Rik <rik@octave.org>
parents: 17190
diff changeset
110 ## @table @asis
85e55da61409 doc: Clarify description of plot format.
Rik <rik@octave.org>
parents: 17190
diff changeset
111 ## @item linestyle
3426
f8dde1807dee [project @ 2000-01-13 08:40:00 by jwe]
jwe
parents: 3408
diff changeset
112 ##
17204
d87179b38bcf doc: Touch up alignment of @multitables in plot, legend, newplot.
Rik <rik@octave.org>
parents: 17191
diff changeset
113 ## @multitable @columnfractions 0.06 0.94
d87179b38bcf doc: Touch up alignment of @multitables in plot, legend, newplot.
Rik <rik@octave.org>
parents: 17191
diff changeset
114 ## @item @samp{-} @tab Use solid lines (default).
d87179b38bcf doc: Touch up alignment of @multitables in plot, legend, newplot.
Rik <rik@octave.org>
parents: 17191
diff changeset
115 ## @item @samp{--} @tab Use dashed lines.
d87179b38bcf doc: Touch up alignment of @multitables in plot, legend, newplot.
Rik <rik@octave.org>
parents: 17191
diff changeset
116 ## @item @samp{:} @tab Use dotted lines.
d87179b38bcf doc: Touch up alignment of @multitables in plot, legend, newplot.
Rik <rik@octave.org>
parents: 17191
diff changeset
117 ## @item @samp{-.} @tab Use dash-dotted lines.
d87179b38bcf doc: Touch up alignment of @multitables in plot, legend, newplot.
Rik <rik@octave.org>
parents: 17191
diff changeset
118 ## @end multitable
3426
f8dde1807dee [project @ 2000-01-13 08:40:00 by jwe]
jwe
parents: 3408
diff changeset
119 ##
17191
85e55da61409 doc: Clarify description of plot format.
Rik <rik@octave.org>
parents: 17190
diff changeset
120 ## @item markerstyle
85e55da61409 doc: Clarify description of plot format.
Rik <rik@octave.org>
parents: 17190
diff changeset
121 ##
17204
d87179b38bcf doc: Touch up alignment of @multitables in plot, legend, newplot.
Rik <rik@octave.org>
parents: 17191
diff changeset
122 ## @multitable @columnfractions 0.06 0.94
d87179b38bcf doc: Touch up alignment of @multitables in plot, legend, newplot.
Rik <rik@octave.org>
parents: 17191
diff changeset
123 ## @item @samp{+} @tab crosshair
d87179b38bcf doc: Touch up alignment of @multitables in plot, legend, newplot.
Rik <rik@octave.org>
parents: 17191
diff changeset
124 ## @item @samp{o} @tab circle
d87179b38bcf doc: Touch up alignment of @multitables in plot, legend, newplot.
Rik <rik@octave.org>
parents: 17191
diff changeset
125 ## @item @samp{*} @tab star
d87179b38bcf doc: Touch up alignment of @multitables in plot, legend, newplot.
Rik <rik@octave.org>
parents: 17191
diff changeset
126 ## @item @samp{.} @tab point
d87179b38bcf doc: Touch up alignment of @multitables in plot, legend, newplot.
Rik <rik@octave.org>
parents: 17191
diff changeset
127 ## @item @samp{x} @tab cross
d87179b38bcf doc: Touch up alignment of @multitables in plot, legend, newplot.
Rik <rik@octave.org>
parents: 17191
diff changeset
128 ## @item @samp{s} @tab square
d87179b38bcf doc: Touch up alignment of @multitables in plot, legend, newplot.
Rik <rik@octave.org>
parents: 17191
diff changeset
129 ## @item @samp{d} @tab diamond
d87179b38bcf doc: Touch up alignment of @multitables in plot, legend, newplot.
Rik <rik@octave.org>
parents: 17191
diff changeset
130 ## @item @samp{^} @tab upward-facing triangle
d87179b38bcf doc: Touch up alignment of @multitables in plot, legend, newplot.
Rik <rik@octave.org>
parents: 17191
diff changeset
131 ## @item @samp{v} @tab downward-facing triangle
d87179b38bcf doc: Touch up alignment of @multitables in plot, legend, newplot.
Rik <rik@octave.org>
parents: 17191
diff changeset
132 ## @item @samp{>} @tab right-facing triangle
d87179b38bcf doc: Touch up alignment of @multitables in plot, legend, newplot.
Rik <rik@octave.org>
parents: 17191
diff changeset
133 ## @item @samp{<} @tab left-facing triangle
d87179b38bcf doc: Touch up alignment of @multitables in plot, legend, newplot.
Rik <rik@octave.org>
parents: 17191
diff changeset
134 ## @item @samp{p} @tab pentagram
d87179b38bcf doc: Touch up alignment of @multitables in plot, legend, newplot.
Rik <rik@octave.org>
parents: 17191
diff changeset
135 ## @item @samp{h} @tab hexagram
d87179b38bcf doc: Touch up alignment of @multitables in plot, legend, newplot.
Rik <rik@octave.org>
parents: 17191
diff changeset
136 ## @end multitable
17191
85e55da61409 doc: Clarify description of plot format.
Rik <rik@octave.org>
parents: 17190
diff changeset
137 ##
85e55da61409 doc: Clarify description of plot format.
Rik <rik@octave.org>
parents: 17190
diff changeset
138 ## @item color
85e55da61409 doc: Clarify description of plot format.
Rik <rik@octave.org>
parents: 17190
diff changeset
139 ##
17204
d87179b38bcf doc: Touch up alignment of @multitables in plot, legend, newplot.
Rik <rik@octave.org>
parents: 17191
diff changeset
140 ## @multitable @columnfractions 0.06 0.94
d87179b38bcf doc: Touch up alignment of @multitables in plot, legend, newplot.
Rik <rik@octave.org>
parents: 17191
diff changeset
141 ## @item @samp{k} @tab blacK
d87179b38bcf doc: Touch up alignment of @multitables in plot, legend, newplot.
Rik <rik@octave.org>
parents: 17191
diff changeset
142 ## @item @samp{r} @tab Red
d87179b38bcf doc: Touch up alignment of @multitables in plot, legend, newplot.
Rik <rik@octave.org>
parents: 17191
diff changeset
143 ## @item @samp{g} @tab Green
d87179b38bcf doc: Touch up alignment of @multitables in plot, legend, newplot.
Rik <rik@octave.org>
parents: 17191
diff changeset
144 ## @item @samp{b} @tab Blue
d87179b38bcf doc: Touch up alignment of @multitables in plot, legend, newplot.
Rik <rik@octave.org>
parents: 17191
diff changeset
145 ## @item @samp{m} @tab Magenta
d87179b38bcf doc: Touch up alignment of @multitables in plot, legend, newplot.
Rik <rik@octave.org>
parents: 17191
diff changeset
146 ## @item @samp{c} @tab Cyan
d87179b38bcf doc: Touch up alignment of @multitables in plot, legend, newplot.
Rik <rik@octave.org>
parents: 17191
diff changeset
147 ## @item @samp{w} @tab White
d87179b38bcf doc: Touch up alignment of @multitables in plot, legend, newplot.
Rik <rik@octave.org>
parents: 17191
diff changeset
148 ## @end multitable
17191
85e55da61409 doc: Clarify description of plot format.
Rik <rik@octave.org>
parents: 17190
diff changeset
149 ##
85e55da61409 doc: Clarify description of plot format.
Rik <rik@octave.org>
parents: 17190
diff changeset
150 ## @item ";key;"
85e55da61409 doc: Clarify description of plot format.
Rik <rik@octave.org>
parents: 17190
diff changeset
151 ## Here "key" is the label to use for the plot legend.
85e55da61409 doc: Clarify description of plot format.
Rik <rik@octave.org>
parents: 17190
diff changeset
152 ## @end table
85e55da61409 doc: Clarify description of plot format.
Rik <rik@octave.org>
parents: 17190
diff changeset
153 ##
85e55da61409 doc: Clarify description of plot format.
Rik <rik@octave.org>
parents: 17190
diff changeset
154 ## The @var{fmt} argument may also be used to assign legend keys.
85e55da61409 doc: Clarify description of plot format.
Rik <rik@octave.org>
parents: 17190
diff changeset
155 ## To do so, include the desired label between semicolons after the
17204
d87179b38bcf doc: Touch up alignment of @multitables in plot, legend, newplot.
Rik <rik@octave.org>
parents: 17191
diff changeset
156 ## formatting sequence described above, e.g., "+b;Key Title;".
d87179b38bcf doc: Touch up alignment of @multitables in plot, legend, newplot.
Rik <rik@octave.org>
parents: 17191
diff changeset
157 ## Note that the last semicolon is required and Octave will generate
d87179b38bcf doc: Touch up alignment of @multitables in plot, legend, newplot.
Rik <rik@octave.org>
parents: 17191
diff changeset
158 ## an error if it is left out.
3683
505f5c35a2c9 [project @ 2000-06-27 20:19:47 by jwe]
jwe
parents: 3426
diff changeset
159 ##
3368
a4cd1e9d9962 [project @ 1999-11-20 17:22:48 by jwe]
jwe
parents: 3063
diff changeset
160 ## Here are some plot examples:
3426
f8dde1807dee [project @ 2000-01-13 08:40:00 by jwe]
jwe
parents: 3408
diff changeset
161 ##
3368
a4cd1e9d9962 [project @ 1999-11-20 17:22:48 by jwe]
jwe
parents: 3063
diff changeset
162 ## @example
17191
85e55da61409 doc: Clarify description of plot format.
Rik <rik@octave.org>
parents: 17190
diff changeset
163 ## plot (x, y, "or", x, y2, x, y3, "m", x, y4, "+")
3368
a4cd1e9d9962 [project @ 1999-11-20 17:22:48 by jwe]
jwe
parents: 3063
diff changeset
164 ## @end example
3426
f8dde1807dee [project @ 2000-01-13 08:40:00 by jwe]
jwe
parents: 3408
diff changeset
165 ##
17191
85e55da61409 doc: Clarify description of plot format.
Rik <rik@octave.org>
parents: 17190
diff changeset
166 ## This command will plot @code{y} with red circles, @code{y2} with solid
85e55da61409 doc: Clarify description of plot format.
Rik <rik@octave.org>
parents: 17190
diff changeset
167 ## lines, @code{y3} with solid magenta lines, and @code{y4} with points
85e55da61409 doc: Clarify description of plot format.
Rik <rik@octave.org>
parents: 17190
diff changeset
168 ## displayed as @samp{+}.
3426
f8dde1807dee [project @ 2000-01-13 08:40:00 by jwe]
jwe
parents: 3408
diff changeset
169 ##
3368
a4cd1e9d9962 [project @ 1999-11-20 17:22:48 by jwe]
jwe
parents: 3063
diff changeset
170 ## @example
17191
85e55da61409 doc: Clarify description of plot format.
Rik <rik@octave.org>
parents: 17190
diff changeset
171 ## plot (b, "*", "markersize", 10)
3368
a4cd1e9d9962 [project @ 1999-11-20 17:22:48 by jwe]
jwe
parents: 3063
diff changeset
172 ## @end example
3426
f8dde1807dee [project @ 2000-01-13 08:40:00 by jwe]
jwe
parents: 3408
diff changeset
173 ##
6672
2f0abcba669c [project @ 2007-05-30 06:42:22 by jwe]
jwe
parents: 6459
diff changeset
174 ## This command will plot the data in the variable @code{b},
17204
d87179b38bcf doc: Touch up alignment of @multitables in plot, legend, newplot.
Rik <rik@octave.org>
parents: 17191
diff changeset
175 ## with points displayed as @samp{*} and a marker size of 10.
3683
505f5c35a2c9 [project @ 2000-06-27 20:19:47 by jwe]
jwe
parents: 3426
diff changeset
176 ##
505f5c35a2c9 [project @ 2000-06-27 20:19:47 by jwe]
jwe
parents: 3426
diff changeset
177 ## @example
9051
1bf0ce0930be Grammar check TexInfo in all .m files
Rik <rdrider0-list@yahoo.com>
parents: 9040
diff changeset
178 ## @group
3683
505f5c35a2c9 [project @ 2000-06-27 20:19:47 by jwe]
jwe
parents: 3426
diff changeset
179 ## t = 0:0.1:6.3;
17191
85e55da61409 doc: Clarify description of plot format.
Rik <rik@octave.org>
parents: 17190
diff changeset
180 ## plot (t, cos(t), "-;cos(t);", t, sin(t), "-b;sin(t);");
9051
1bf0ce0930be Grammar check TexInfo in all .m files
Rik <rdrider0-list@yahoo.com>
parents: 9040
diff changeset
181 ## @end group
3683
505f5c35a2c9 [project @ 2000-06-27 20:19:47 by jwe]
jwe
parents: 3426
diff changeset
182 ## @end example
505f5c35a2c9 [project @ 2000-06-27 20:19:47 by jwe]
jwe
parents: 3426
diff changeset
183 ##
505f5c35a2c9 [project @ 2000-06-27 20:19:47 by jwe]
jwe
parents: 3426
diff changeset
184 ## This will plot the cosine and sine functions and label them accordingly
17204
d87179b38bcf doc: Touch up alignment of @multitables in plot, legend, newplot.
Rik <rik@octave.org>
parents: 17191
diff changeset
185 ## in the legend.
6820
65d0fa83261a [project @ 2007-08-23 16:14:51 by jwe]
jwe
parents: 6672
diff changeset
186 ##
17122
eaab03308c0b doc: Rewrite docstrings for most plot functions.
Rik <rik@octave.org>
parents: 17036
diff changeset
187 ## If the first argument @var{hax} is an axes handle, then plot into this axis,
eaab03308c0b doc: Rewrite docstrings for most plot functions.
Rik <rik@octave.org>
parents: 17036
diff changeset
188 ## rather than the current axes returned by @code{gca}.
11587
c792872f8942 all script files: untabify and strip trailing whitespace
John W. Eaton <jwe@octave.org>
parents: 11523
diff changeset
189 ##
17122
eaab03308c0b doc: Rewrite docstrings for most plot functions.
Rik <rik@octave.org>
parents: 17036
diff changeset
190 ## The optional return value @var{h} is a vector of graphics handles to
eaab03308c0b doc: Rewrite docstrings for most plot functions.
Rik <rik@octave.org>
parents: 17036
diff changeset
191 ## the created line objects.
14001
5f0bb45e615c doc: Update documentation for functions returning a graphics handle h (Bug #34761)
Rik <octave@nomad.inbox5.com>
parents: 11587
diff changeset
192 ##
17191
85e55da61409 doc: Clarify description of plot format.
Rik <rik@octave.org>
parents: 17190
diff changeset
193 ## To save a plot, in one of several image formats such as PostScript
85e55da61409 doc: Clarify description of plot format.
Rik <rik@octave.org>
parents: 17190
diff changeset
194 ## or PNG, use the @code{print} command.
85e55da61409 doc: Clarify description of plot format.
Rik <rik@octave.org>
parents: 17190
diff changeset
195 ##
17122
eaab03308c0b doc: Rewrite docstrings for most plot functions.
Rik <rik@octave.org>
parents: 17036
diff changeset
196 ## @seealso{axis, box, grid, hold, legend, title, xlabel, ylabel, xlim, ylim, ezplot, errorbar, fplot, line, plot3, polar, loglog, semilogx, semilogy, subplot}
3368
a4cd1e9d9962 [project @ 1999-11-20 17:22:48 by jwe]
jwe
parents: 3063
diff changeset
197 ## @end deftypefn
4
b4df021f796c [project @ 1993-08-08 01:26:08 by jwe]
jwe
parents:
diff changeset
198
2314
949ab8eba8bc [project @ 1996-07-12 03:58:02 by jwe]
jwe
parents: 2313
diff changeset
199 ## Author: jwe
949ab8eba8bc [project @ 1996-07-12 03:58:02 by jwe]
jwe
parents: 2313
diff changeset
200
17036
08dd9458684a Overhaul __plt_get_axis_arg__ and newplot functions to avoid creating unnecessary axes.
Rik <rik@octave.org>
parents: 15015
diff changeset
201 function h = plot (varargin)
4
b4df021f796c [project @ 1993-08-08 01:26:08 by jwe]
jwe
parents:
diff changeset
202
17036
08dd9458684a Overhaul __plt_get_axis_arg__ and newplot functions to avoid creating unnecessary axes.
Rik <rik@octave.org>
parents: 15015
diff changeset
203 [hax, varargin, nargs] = __plt_get_axis_arg__ ("plot", varargin{:});
10730
390d93e20531 Plot commands now print usage information without errors
Rik <octave@nomad.inbox5.com>
parents: 10687
diff changeset
204
390d93e20531 Plot commands now print usage information without errors
Rik <octave@nomad.inbox5.com>
parents: 10687
diff changeset
205 if (nargs < 1)
14846
460a3c6d8bf1 maint: Use Octave coding convention for cuddled parenthis in function calls with empty argument lists.
Rik <octave@nomad.inbox5.com>
parents: 14138
diff changeset
206 print_usage ();
10730
390d93e20531 Plot commands now print usage information without errors
Rik <octave@nomad.inbox5.com>
parents: 10687
diff changeset
207 endif
7216
5389a52df87b [project @ 2007-11-29 19:07:29 by jwe]
jwe
parents: 7215
diff changeset
208
17036
08dd9458684a Overhaul __plt_get_axis_arg__ and newplot functions to avoid creating unnecessary axes.
Rik <rik@octave.org>
parents: 15015
diff changeset
209 oldfig = ifelse (isempty (hax), [], get (0, "currentfigure"));
7215
dd88d61d443f [project @ 2007-11-29 16:44:45 by jwe]
jwe
parents: 7208
diff changeset
210 unwind_protect
17036
08dd9458684a Overhaul __plt_get_axis_arg__ and newplot functions to avoid creating unnecessary axes.
Rik <rik@octave.org>
parents: 15015
diff changeset
211 hax = newplot (hax);
08dd9458684a Overhaul __plt_get_axis_arg__ and newplot functions to avoid creating unnecessary axes.
Rik <rik@octave.org>
parents: 15015
diff changeset
212 htmp = __plt__ ("plot", hax, varargin{:});
7215
dd88d61d443f [project @ 2007-11-29 16:44:45 by jwe]
jwe
parents: 7208
diff changeset
213 unwind_protect_cleanup
17036
08dd9458684a Overhaul __plt_get_axis_arg__ and newplot functions to avoid creating unnecessary axes.
Rik <rik@octave.org>
parents: 15015
diff changeset
214 if (! isempty (oldfig))
08dd9458684a Overhaul __plt_get_axis_arg__ and newplot functions to avoid creating unnecessary axes.
Rik <rik@octave.org>
parents: 15015
diff changeset
215 set (0, "currentfigure", oldfig);
08dd9458684a Overhaul __plt_get_axis_arg__ and newplot functions to avoid creating unnecessary axes.
Rik <rik@octave.org>
parents: 15015
diff changeset
216 endif
7215
dd88d61d443f [project @ 2007-11-29 16:44:45 by jwe]
jwe
parents: 7208
diff changeset
217 end_unwind_protect
6302
a5cd8b77e892 [project @ 2007-02-13 08:08:33 by jwe]
jwe
parents: 6263
diff changeset
218
a5cd8b77e892 [project @ 2007-02-13 08:08:33 by jwe]
jwe
parents: 6263
diff changeset
219 if (nargout > 0)
17036
08dd9458684a Overhaul __plt_get_axis_arg__ and newplot functions to avoid creating unnecessary axes.
Rik <rik@octave.org>
parents: 15015
diff changeset
220 h = htmp;
6302
a5cd8b77e892 [project @ 2007-02-13 08:08:33 by jwe]
jwe
parents: 6263
diff changeset
221 endif
4
b4df021f796c [project @ 1993-08-08 01:26:08 by jwe]
jwe
parents:
diff changeset
222
b4df021f796c [project @ 1993-08-08 01:26:08 by jwe]
jwe
parents:
diff changeset
223 endfunction
14001
5f0bb45e615c doc: Update documentation for functions returning a graphics handle h (Bug #34761)
Rik <octave@nomad.inbox5.com>
parents: 11587
diff changeset
224
5f0bb45e615c doc: Update documentation for functions returning a graphics handle h (Bug #34761)
Rik <octave@nomad.inbox5.com>
parents: 11587
diff changeset
225
15015
fee211d42c5c Add demos for plot.m (bug #36939).
Rik <rik@octave.org>
parents: 14846
diff changeset
226 %!demo
fee211d42c5c Add demos for plot.m (bug #36939).
Rik <rik@octave.org>
parents: 14846
diff changeset
227 %! x = 1:5; y = 1:5;
fee211d42c5c Add demos for plot.m (bug #36939).
Rik <rik@octave.org>
parents: 14846
diff changeset
228 %! plot (x,y,'g');
17190
df4c4b7708a4 Add titles and clean-up plotting %!demos.
Rik <rik@octave.org>
parents: 17122
diff changeset
229 %! title ('plot() of green line at 45 degrees');
14001
5f0bb45e615c doc: Update documentation for functions returning a graphics handle h (Bug #34761)
Rik <octave@nomad.inbox5.com>
parents: 11587
diff changeset
230
15015
fee211d42c5c Add demos for plot.m (bug #36939).
Rik <rik@octave.org>
parents: 14846
diff changeset
231 %!demo
fee211d42c5c Add demos for plot.m (bug #36939).
Rik <rik@octave.org>
parents: 14846
diff changeset
232 %! x = 1:5; y = 1:5;
fee211d42c5c Add demos for plot.m (bug #36939).
Rik <rik@octave.org>
parents: 14846
diff changeset
233 %! plot (x,y,'g*');
17190
df4c4b7708a4 Add titles and clean-up plotting %!demos.
Rik <rik@octave.org>
parents: 17122
diff changeset
234 %! title ('plot() of green stars along a line at 45 degrees');
15015
fee211d42c5c Add demos for plot.m (bug #36939).
Rik <rik@octave.org>
parents: 14846
diff changeset
235
fee211d42c5c Add demos for plot.m (bug #36939).
Rik <rik@octave.org>
parents: 14846
diff changeset
236 %!demo
fee211d42c5c Add demos for plot.m (bug #36939).
Rik <rik@octave.org>
parents: 14846
diff changeset
237 %! x1 = 1:5; y1 = 1:5;
fee211d42c5c Add demos for plot.m (bug #36939).
Rik <rik@octave.org>
parents: 14846
diff changeset
238 %! x2 = 5:9; y2 = 5:-1:1;
fee211d42c5c Add demos for plot.m (bug #36939).
Rik <rik@octave.org>
parents: 14846
diff changeset
239 %! plot (x1,y1,'bo-', x2,y2,'rs-');
fee211d42c5c Add demos for plot.m (bug #36939).
Rik <rik@octave.org>
parents: 14846
diff changeset
240 %! axis ('tight');
17190
df4c4b7708a4 Add titles and clean-up plotting %!demos.
Rik <rik@octave.org>
parents: 17122
diff changeset
241 %! title ({'plot() of blue circles ascending and red squares descending';
df4c4b7708a4 Add titles and clean-up plotting %!demos.
Rik <rik@octave.org>
parents: 17122
diff changeset
242 %! 'connecting lines drawn'});
15015
fee211d42c5c Add demos for plot.m (bug #36939).
Rik <rik@octave.org>
parents: 14846
diff changeset
243