Mercurial > hg > octave-lyh

annotate scripts/plot/bar.m @ 14327:4d917a6a858b stable

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
doc: Use Octave coding conventions in @example blocks of docstrings. * accumarray.m, accumdim.m, bar.m, base2dec.m, bincoeff.m, bitcmp.m, bitset.m, celldisp.m, chop.m, clabel.m, cloglog.m, colon.m, compass.m, computer.m, contour3.m, contourc.m, corr.m, cstrcat.m, ctime.m, cylinder.m, date.m, dec2base.m, demo.m, dir.m, dlmwrite.m, expm.m, ezcontourf.m, ezcontour.m, ezmeshc.m, ezmesh.m, ezplot.m, ezsurfc.m, ezsurf.m, feather.m, findobj.m, flipdim.m, fplot.m, genvarname.m, getfield.m, hankel.m, hilb.m, hist.m, idivide.m, index.m, int2str.m, interp1.m, is_leap_year.m, ismember.m, isocolors.m, isonormals.m, isosurface.m, kurtosis.m, legendre.m, linkprop.m, logit.m, logm.m, __makeinfo__.m, __marching_cube__.m, median.m, mkoctfile.m, moment.m, mpoles.m, orderfields.m, pcg.m, pcr.m, plot3.m, plotmatrix.m, polyaffine.m, polygcd.m, poly.m, polyout.m, print.m, qp.m, quadgk.m, qzhess.m, randi.m, rat.m, refreshdata.m, residue.m, rose.m, rot90.m, saveas.m, saveobj.m, shiftdim.m, skewness.m, spaugment.m, spdiags.m, sqp.m, stem.m, str2num.m, strcat.m, strjust.m, strread.m, strsplit.m, structfun.m, subplot.m, subsindex.m, substruct.m, surfl.m, surfnorm.m, svds.m, uimenu.m, union.m, voronoi.m, warning_ids.m, wblpdf.m: Use Octave coding conventions in @example blocks of docstrings.
author Rik <octave@nomad.inbox5.com>
date Sat, 04 Feb 2012 22:12:50 -0800
parents 72c96de7a403
children de751531e548
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: 131
diff changeset
18
3368
a4cd1e9d9962 [project @ 1999-11-20 17:22:48 by jwe]
jwe
parents: 3260
diff changeset
19 ## -*- texinfo -*-
10793
be55736a0783 Grammarcheck the documentation from m-files.
Rik <octave@nomad.inbox5.com>
parents: 10711
diff changeset
20 ## @deftypefn {Function File} {} bar (@var{x}, @var{y})
7106
33ed85dcfaa8 [project @ 2007-11-06 18:03:08 by jwe]
jwe
parents: 7096
diff changeset
21 ## @deftypefnx {Function File} {} bar (@var{y})
33ed85dcfaa8 [project @ 2007-11-06 18:03:08 by jwe]
jwe
parents: 7096
diff changeset
22 ## @deftypefnx {Function File} {} bar (@var{x}, @var{y}, @var{w})
33ed85dcfaa8 [project @ 2007-11-06 18:03:08 by jwe]
jwe
parents: 7096
diff changeset
23 ## @deftypefnx {Function File} {} bar (@var{x}, @var{y}, @var{w}, @var{style})
33ed85dcfaa8 [project @ 2007-11-06 18:03:08 by jwe]
jwe
parents: 7096
diff changeset
24 ## @deftypefnx {Function File} {@var{h} =} bar (@dots{}, @var{prop}, @var{val})
7189
e8d953d03f6a [project @ 2007-11-26 20:42:09 by dbateman]
dbateman
parents: 7106
diff changeset
25 ## @deftypefnx {Function File} {} bar (@var{h}, @dots{})
7096
81bed50b9feb [project @ 2007-11-02 16:13:43 by jwe]
jwe
parents: 7086
diff changeset
26 ## Produce a bar graph from two vectors of x-y data.
3426
f8dde1807dee [project @ 2000-01-13 08:40:00 by jwe]
jwe
parents: 3408
diff changeset
27 ##
11366
ad8966096e27 bar.m: Improve the docstring.
Rik <octave@nomad.inbox5.com>
parents: 10846
diff changeset
28 ## If only one argument is given, @var{y}, it is taken as a vector of y-values
2311
2b5788792cad [project @ 1996-07-11 20:18:38 by jwe]
jwe
parents: 2303
diff changeset
29 ## and the x coordinates are taken to be the indices of the elements.
3426
f8dde1807dee [project @ 2000-01-13 08:40:00 by jwe]
jwe
parents: 3408
diff changeset
30 ##
11587
c792872f8942 all script files: untabify and strip trailing whitespace
John W. Eaton <jwe@octave.org>
parents: 11575
diff changeset
31 ## The default width of 0.8 for the bars can be changed using @var{w}.
7096
81bed50b9feb [project @ 2007-11-02 16:13:43 by jwe]
jwe
parents: 7086
diff changeset
32 ##
6540
9dcfc78da664 [project @ 2007-04-18 21:16:08 by dbateman]
dbateman
parents: 6448
diff changeset
33 ## If @var{y} is a matrix, then each column of @var{y} is taken to be a
9040
dbd0c77e575e Cleanup documentation file plot.texi
Rik <rdrider0-list@yahoo.com>
parents: 8920
diff changeset
34 ## separate bar graph plotted on the same graph. By default the columns
dbd0c77e575e Cleanup documentation file plot.texi
Rik <rdrider0-list@yahoo.com>
parents: 8920
diff changeset
35 ## are plotted side-by-side. This behavior can be changed by the @var{style}
7086
625891845df5 [project @ 2007-10-31 17:11:49 by jwe]
jwe
parents: 7017
diff changeset
36 ## argument, which can take the values @code{"grouped"} (the default),
625891845df5 [project @ 2007-10-31 17:11:49 by jwe]
jwe
parents: 7017
diff changeset
37 ## or @code{"stacked"}.
6540
9dcfc78da664 [project @ 2007-04-18 21:16:08 by dbateman]
dbateman
parents: 6448
diff changeset
38 ##
14001
5f0bb45e615c doc: Update documentation for functions returning a graphics handle h (Bug #34761)
Rik <octave@nomad.inbox5.com>
parents: 11587
diff changeset
39 ## The optional return value @var{h} is a handle to the created "bar series"
9040
dbd0c77e575e Cleanup documentation file plot.texi
Rik <rdrider0-list@yahoo.com>
parents: 8920
diff changeset
40 ## object with one handle per column of the variable @var{y}. This
8056
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents: 7189
diff changeset
41 ## series allows common elements of the group of bar series objects to
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents: 7189
diff changeset
42 ## be changed in a single bar series and the same properties are changed
10846
a4f482e66b65 Grammarcheck more of the documentation.
Rik <octave@nomad.inbox5.com>
parents: 10793
diff changeset
43 ## in the other "bar series". For example,
8056
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents: 7189
diff changeset
44 ##
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents: 7189
diff changeset
45 ## @example
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents: 7189
diff changeset
46 ## @group
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents: 7189
diff changeset
47 ## h = bar (rand (5, 10));
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents: 7189
diff changeset
48 ## set (h(1), "basevalue", 0.5);
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents: 7189
diff changeset
49 ## @end group
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents: 7189
diff changeset
50 ## @end example
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents: 7189
diff changeset
51 ##
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents: 7189
diff changeset
52 ## @noindent
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents: 7189
diff changeset
53 ## changes the position on the base of all of the bar series.
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents: 7189
diff changeset
54 ##
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents: 7189
diff changeset
55 ## The optional input handle @var{h} allows an axis handle to be passed.
11366
ad8966096e27 bar.m: Improve the docstring.
Rik <octave@nomad.inbox5.com>
parents: 10846
diff changeset
56 ##
11575
d6619410e79c Spellcheck documentation before 3.4 release.
Rik <octave@nomad.inbox5.com>
parents: 11523
diff changeset
57 ## The bar graph's appearance may be modified by specifying property/value
11366
ad8966096e27 bar.m: Improve the docstring.
Rik <octave@nomad.inbox5.com>
parents: 10846
diff changeset
58 ## pairs. The following example modifies the face and edge colors.
3426
f8dde1807dee [project @ 2000-01-13 08:40:00 by jwe]
jwe
parents: 3408
diff changeset
59 ##
11366
ad8966096e27 bar.m: Improve the docstring.
Rik <octave@nomad.inbox5.com>
parents: 10846
diff changeset
60 ## @example
ad8966096e27 bar.m: Improve the docstring.
Rik <octave@nomad.inbox5.com>
parents: 10846
diff changeset
61 ## bar (randn (1, 100), "facecolor", "r", "edgecolor", "b")
ad8966096e27 bar.m: Improve the docstring.
Rik <octave@nomad.inbox5.com>
parents: 10846
diff changeset
62 ## @end example
ad8966096e27 bar.m: Improve the docstring.
Rik <octave@nomad.inbox5.com>
parents: 10846
diff changeset
63 ##
ad8966096e27 bar.m: Improve the docstring.
Rik <octave@nomad.inbox5.com>
parents: 10846
diff changeset
64 ## @noindent
10572
148559d9d4ac Document the use of the colormap for bar plots
David Bateman <dbateman@free.fr>
parents: 9245
diff changeset
65 ## The color of the bars is taken from the figure's colormap, such that
148559d9d4ac Document the use of the colormap for bar plots
David Bateman <dbateman@free.fr>
parents: 9245
diff changeset
66 ##
148559d9d4ac Document the use of the colormap for bar plots
David Bateman <dbateman@free.fr>
parents: 9245
diff changeset
67 ## @example
148559d9d4ac Document the use of the colormap for bar plots
David Bateman <dbateman@free.fr>
parents: 9245
diff changeset
68 ## @group
14327
4d917a6a858b doc: Use Octave coding conventions in @example blocks of docstrings.
Rik <octave@nomad.inbox5.com>
parents: 14138
diff changeset
69 ## bar (rand (10, 3));
4d917a6a858b doc: Use Octave coding conventions in @example blocks of docstrings.
Rik <octave@nomad.inbox5.com>
parents: 14138
diff changeset
70 ## colormap (summer (64));
10572
148559d9d4ac Document the use of the colormap for bar plots
David Bateman <dbateman@free.fr>
parents: 9245
diff changeset
71 ## @end group
148559d9d4ac Document the use of the colormap for bar plots
David Bateman <dbateman@free.fr>
parents: 9245
diff changeset
72 ## @end example
148559d9d4ac Document the use of the colormap for bar plots
David Bateman <dbateman@free.fr>
parents: 9245
diff changeset
73 ##
10846
a4f482e66b65 Grammarcheck more of the documentation.
Rik <octave@nomad.inbox5.com>
parents: 10793
diff changeset
74 ## @noindent
11366
ad8966096e27 bar.m: Improve the docstring.
Rik <octave@nomad.inbox5.com>
parents: 10846
diff changeset
75 ## will change the colors used for the bars. The color of bars can also be set
ad8966096e27 bar.m: Improve the docstring.
Rik <octave@nomad.inbox5.com>
parents: 10846
diff changeset
76 ## manually using the "facecolor" property as shown below.
10572
148559d9d4ac Document the use of the colormap for bar plots
David Bateman <dbateman@free.fr>
parents: 9245
diff changeset
77 ##
148559d9d4ac Document the use of the colormap for bar plots
David Bateman <dbateman@free.fr>
parents: 9245
diff changeset
78 ## @example
148559d9d4ac Document the use of the colormap for bar plots
David Bateman <dbateman@free.fr>
parents: 9245
diff changeset
79 ## @group
14327
4d917a6a858b doc: Use Octave coding conventions in @example blocks of docstrings.
Rik <octave@nomad.inbox5.com>
parents: 14138
diff changeset
80 ## h = bar (rand (10, 3));
10572
148559d9d4ac Document the use of the colormap for bar plots
David Bateman <dbateman@free.fr>
parents: 9245
diff changeset
81 ## set (h(1), "facecolor", "r")
148559d9d4ac Document the use of the colormap for bar plots
David Bateman <dbateman@free.fr>
parents: 9245
diff changeset
82 ## set (h(2), "facecolor", "g")
148559d9d4ac Document the use of the colormap for bar plots
David Bateman <dbateman@free.fr>
parents: 9245
diff changeset
83 ## set (h(3), "facecolor", "b")
148559d9d4ac Document the use of the colormap for bar plots
David Bateman <dbateman@free.fr>
parents: 9245
diff changeset
84 ## @end group
148559d9d4ac Document the use of the colormap for bar plots
David Bateman <dbateman@free.fr>
parents: 9245
diff changeset
85 ## @end example
148559d9d4ac Document the use of the colormap for bar plots
David Bateman <dbateman@free.fr>
parents: 9245
diff changeset
86 ##
11587
c792872f8942 all script files: untabify and strip trailing whitespace
John W. Eaton <jwe@octave.org>
parents: 11575
diff changeset
87 ## @seealso{barh, plot}
3368
a4cd1e9d9962 [project @ 1999-11-20 17:22:48 by jwe]
jwe
parents: 3260
diff changeset
88 ## @end deftypefn
4
b4df021f796c [project @ 1993-08-08 01:26:08 by jwe]
jwe
parents:
diff changeset
89
2314
949ab8eba8bc [project @ 1996-07-12 03:58:02 by jwe]
jwe
parents: 2313
diff changeset
90 ## Author: jwe
949ab8eba8bc [project @ 1996-07-12 03:58:02 by jwe]
jwe
parents: 2313
diff changeset
91
6540
9dcfc78da664 [project @ 2007-04-18 21:16:08 by dbateman]
dbateman
parents: 6448
diff changeset
92 function varargout = bar (varargin)
9dcfc78da664 [project @ 2007-04-18 21:16:08 by dbateman]
dbateman
parents: 6448
diff changeset
93 varargout = cell (nargout, 1);
9dcfc78da664 [project @ 2007-04-18 21:16:08 by dbateman]
dbateman
parents: 6448
diff changeset
94 [varargout{:}] = __bar__ (true, "bar", varargin{:});
4
b4df021f796c [project @ 1993-08-08 01:26:08 by jwe]
jwe
parents:
diff changeset
95 endfunction
14001
5f0bb45e615c doc: Update documentation for functions returning a graphics handle h (Bug #34761)
Rik <octave@nomad.inbox5.com>
parents: 11587
diff changeset
96
5f0bb45e615c doc: Update documentation for functions returning a graphics handle h (Bug #34761)
Rik <octave@nomad.inbox5.com>
parents: 11587
diff changeset
97
5f0bb45e615c doc: Update documentation for functions returning a graphics handle h (Bug #34761)
Rik <octave@nomad.inbox5.com>
parents: 11587
diff changeset
98 %% FIXME: Need demo or test for function
5f0bb45e615c doc: Update documentation for functions returning a graphics handle h (Bug #34761)
Rik <octave@nomad.inbox5.com>
parents: 11587
diff changeset
99