octave-lyh: scripts/plot/bar.m annotate

annotate scripts/plot/bar.m @ 11366:ad8966096e27

bar.m: Improve the docstring.

author	Rik <octave@nomad.inbox5.com>
date	Tue, 14 Dec 2010 18:40:38 -0800
parents	a4f482e66b65
children	fd0a3ac60b0e

rev	line source
7017 a1dbe9d80eee [project @ 2007-10-12 21:27:11 by jwe] jwe parents: 7016 diff changeset	1 ## Copyright (C) 1993, 1994, 1995, 1996, 1997, 1999, 2000, 2002, 2004,
9245 16f53d29049f update copyright notices John W. Eaton <jwe@octave.org> parents: 9040 diff changeset	2 ## 2005, 2006, 2007, 2008, 2009 John W. Eaton
2313 5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe] jwe parents: 2311 diff changeset	3 ##
5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe] jwe parents: 2311 diff changeset	4 ## This file is part of Octave.
5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe] jwe parents: 2311 diff changeset	5 ##
5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe] jwe parents: 2311 diff changeset	6 ## 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	7 ## 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	8 ## 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	9 ## your option) any later version.
2313 5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe] jwe parents: 2311 diff changeset	10 ##
5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe] jwe parents: 2311 diff changeset	11 ## 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	12 ## WITHOUT ANY WARRANTY; without even the implied warranty of
5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe] jwe parents: 2311 diff changeset	13 ## 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	14 ## General Public License for more details.
5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe] jwe parents: 2311 diff changeset	15 ##
5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe] jwe parents: 2311 diff changeset	16 ## 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	17 ## 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	18 ## <http://www.gnu.org/licenses/>.
245 16a24e76d6e0 [project @ 1993-12-03 02:00:15 by jwe] jwe parents: 131 diff changeset	19
3368 a4cd1e9d9962 [project @ 1999-11-20 17:22:48 by jwe] jwe parents: 3260 diff changeset	20 ## -- texinfo --
10793 be55736a0783 Grammarcheck the documentation from m-files. Rik <octave@nomad.inbox5.com> parents: 10711 diff changeset	21 ## @deftypefn {Function File} {} bar (@var{x}, @var{y})
7106 33ed85dcfaa8 [project @ 2007-11-06 18:03:08 by jwe] jwe parents: 7096 diff changeset	22 ## @deftypefnx {Function File} {} bar (@var{y})
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})
33ed85dcfaa8 [project @ 2007-11-06 18:03:08 by jwe] jwe parents: 7096 diff changeset	24 ## @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	25 ## @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	26 ## @deftypefnx {Function File} {} bar (@var{h}, @dots{})
7096 81bed50b9feb [project @ 2007-11-02 16:13:43 by jwe] jwe parents: 7086 diff changeset	27 ## 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	28 ##
11366 ad8966096e27 bar.m: Improve the docstring. Rik <octave@nomad.inbox5.com> parents: 10846 diff changeset	29 ## 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	30 ## 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	31 ##
7096 81bed50b9feb [project @ 2007-11-02 16:13:43 by jwe] jwe parents: 7086 diff changeset	32 ## The default width of 0.8 for the bars can be changed using @var{w}.
81bed50b9feb [project @ 2007-11-02 16:13:43 by jwe] jwe parents: 7086 diff changeset	33 ##
6540 9dcfc78da664 [project @ 2007-04-18 21:16:08 by dbateman] dbateman parents: 6448 diff changeset	34 ## 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	35 ## 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	36 ## 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	37 ## 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	38 ## or @code{"stacked"}.
6540 9dcfc78da664 [project @ 2007-04-18 21:16:08 by dbateman] dbateman parents: 6448 diff changeset	39 ##
8056 9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them David Bateman <dbateman@free.fr> parents: 7189 diff changeset	40 ## The optional return value @var{h} provides a handle to the "bar series"
9040 dbd0c77e575e Cleanup documentation file plot.texi Rik <rdrider0-list@yahoo.com> parents: 8920 diff changeset	41 ## 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	42 ## 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	43 ## 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	44 ## 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	45 ##
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them David Bateman <dbateman@free.fr> parents: 7189 diff changeset	46 ## @example
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them David Bateman <dbateman@free.fr> parents: 7189 diff changeset	47 ## @group
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them David Bateman <dbateman@free.fr> parents: 7189 diff changeset	48 ## 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	49 ## 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	50 ## @end group
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them David Bateman <dbateman@free.fr> parents: 7189 diff changeset	51 ## @end example
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them David Bateman <dbateman@free.fr> parents: 7189 diff changeset	52 ##
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them David Bateman <dbateman@free.fr> parents: 7189 diff changeset	53 ## @noindent
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them David Bateman <dbateman@free.fr> parents: 7189 diff changeset	54 ## 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	55 ##
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them David Bateman <dbateman@free.fr> parents: 7189 diff changeset	56 ## 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	57 ##
ad8966096e27 bar.m: Improve the docstring. Rik <octave@nomad.inbox5.com> parents: 10846 diff changeset	58 ## The bargraph's appearance may be modified by specifying property/value
ad8966096e27 bar.m: Improve the docstring. Rik <octave@nomad.inbox5.com> parents: 10846 diff changeset	59 ## 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	60 ##
11366 ad8966096e27 bar.m: Improve the docstring. Rik <octave@nomad.inbox5.com> parents: 10846 diff changeset	61 ## @example
ad8966096e27 bar.m: Improve the docstring. Rik <octave@nomad.inbox5.com> parents: 10846 diff changeset	62 ## bar (randn (1, 100), "facecolor", "r", "edgecolor", "b")
ad8966096e27 bar.m: Improve the docstring. Rik <octave@nomad.inbox5.com> parents: 10846 diff changeset	63 ## @end example
ad8966096e27 bar.m: Improve the docstring. Rik <octave@nomad.inbox5.com> parents: 10846 diff changeset	64 ##
ad8966096e27 bar.m: Improve the docstring. Rik <octave@nomad.inbox5.com> parents: 10846 diff changeset	65 ## @noindent
10572 148559d9d4ac Document the use of the colormap for bar plots David Bateman <dbateman@free.fr> parents: 9245 diff changeset	66 ## 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	67 ##
148559d9d4ac Document the use of the colormap for bar plots David Bateman <dbateman@free.fr> parents: 9245 diff changeset	68 ## @example
148559d9d4ac Document the use of the colormap for bar plots David Bateman <dbateman@free.fr> parents: 9245 diff changeset	69 ## @group
148559d9d4ac Document the use of the colormap for bar plots David Bateman <dbateman@free.fr> parents: 9245 diff changeset	70 ## bar (rand(10,3))
148559d9d4ac Document the use of the colormap for bar plots David Bateman <dbateman@free.fr> parents: 9245 diff changeset	71 ## colormap (summer ())
148559d9d4ac Document the use of the colormap for bar plots David Bateman <dbateman@free.fr> parents: 9245 diff changeset	72 ## @end group
148559d9d4ac Document the use of the colormap for bar plots David Bateman <dbateman@free.fr> parents: 9245 diff changeset	73 ## @end example
148559d9d4ac Document the use of the colormap for bar plots David Bateman <dbateman@free.fr> parents: 9245 diff changeset	74 ##
10846 a4f482e66b65 Grammarcheck more of the documentation. Rik <octave@nomad.inbox5.com> parents: 10793 diff changeset	75 ## @noindent
11366 ad8966096e27 bar.m: Improve the docstring. Rik <octave@nomad.inbox5.com> parents: 10846 diff changeset	76 ## 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	77 ## 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	78 ##
148559d9d4ac Document the use of the colormap for bar plots David Bateman <dbateman@free.fr> parents: 9245 diff changeset	79 ## @example
148559d9d4ac Document the use of the colormap for bar plots David Bateman <dbateman@free.fr> parents: 9245 diff changeset	80 ## @group
148559d9d4ac Document the use of the colormap for bar plots David Bateman <dbateman@free.fr> parents: 9245 diff changeset	81 ## h = bar (rand(10,3))
148559d9d4ac Document the use of the colormap for bar plots David Bateman <dbateman@free.fr> parents: 9245 diff changeset	82 ## set (h(1), "facecolor", "r")
148559d9d4ac Document the use of the colormap for bar plots David Bateman <dbateman@free.fr> parents: 9245 diff changeset	83 ## set (h(2), "facecolor", "g")
148559d9d4ac Document the use of the colormap for bar plots David Bateman <dbateman@free.fr> parents: 9245 diff changeset	84 ## set (h(3), "facecolor", "b")
148559d9d4ac Document the use of the colormap for bar plots David Bateman <dbateman@free.fr> parents: 9245 diff changeset	85 ## @end group
148559d9d4ac Document the use of the colormap for bar plots David Bateman <dbateman@free.fr> parents: 9245 diff changeset	86 ## @end example
148559d9d4ac Document the use of the colormap for bar plots David Bateman <dbateman@free.fr> parents: 9245 diff changeset	87 ##
8056 9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them David Bateman <dbateman@free.fr> parents: 7189 diff changeset	88 ## @seealso{barh, plot}
3368 a4cd1e9d9962 [project @ 1999-11-20 17:22:48 by jwe] jwe parents: 3260 diff changeset	89 ## @end deftypefn
4 b4df021f796c [project @ 1993-08-08 01:26:08 by jwe] jwe parents: diff changeset	90
2314 949ab8eba8bc [project @ 1996-07-12 03:58:02 by jwe] jwe parents: 2313 diff changeset	91 ## Author: jwe
949ab8eba8bc [project @ 1996-07-12 03:58:02 by jwe] jwe parents: 2313 diff changeset	92
6540 9dcfc78da664 [project @ 2007-04-18 21:16:08 by dbateman] dbateman parents: 6448 diff changeset	93 function varargout = bar (varargin)
9dcfc78da664 [project @ 2007-04-18 21:16:08 by dbateman] dbateman parents: 6448 diff changeset	94 varargout = cell (nargout, 1);
9dcfc78da664 [project @ 2007-04-18 21:16:08 by dbateman] dbateman parents: 6448 diff changeset	95 [varargout{:}] = __bar__ (true, "bar", varargin{:});
4 b4df021f796c [project @ 1993-08-08 01:26:08 by jwe] jwe parents: diff changeset	96 endfunction

Mercurial > hg > octave-lyh

annotate scripts/plot/bar.m @ 11366:ad8966096e27