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

annotate scripts/plot/bar.m @ 17475:fd01c78caa0b

Added tag ss-3-7-7 for changeset cc13924a4266

author	John W. Eaton <jwe@octave.org>
date	Mon, 23 Sep 2013 13:31:11 -0400
parents	bc924baa2c4e
children

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 --
17126 eaab03308c0b doc: Rewrite docstrings for most plot functions. Rik <rik@octave.org> parents: 17032 diff changeset	20 ## @deftypefn {Function File} {} bar (@var{y})
eaab03308c0b doc: Rewrite docstrings for most plot functions. Rik <rik@octave.org> parents: 17032 diff changeset	21 ## @deftypefnx {Function File} {} bar (@var{x}, @var{y})
eaab03308c0b doc: Rewrite docstrings for most plot functions. Rik <rik@octave.org> parents: 17032 diff changeset	22 ## @deftypefnx {Function File} {} bar (@dots{}, @var{w})
eaab03308c0b doc: Rewrite docstrings for most plot functions. Rik <rik@octave.org> parents: 17032 diff changeset	23 ## @deftypefnx {Function File} {} bar (@dots{}, @var{style})
eaab03308c0b doc: Rewrite docstrings for most plot functions. Rik <rik@octave.org> parents: 17032 diff changeset	24 ## @deftypefnx {Function File} {} bar (@dots{}, @var{prop}, @var{val}, @dots{})
eaab03308c0b doc: Rewrite docstrings for most plot functions. Rik <rik@octave.org> parents: 17032 diff changeset	25 ## @deftypefnx {Function File} {} bar (@var{hax}, @dots{})
eaab03308c0b doc: Rewrite docstrings for most plot functions. Rik <rik@octave.org> parents: 17032 diff changeset	26 ## @deftypefnx {Function File} {@var{h} =} bar (@dots{}, @var{prop}, @var{val}, @dots{})
eaab03308c0b doc: Rewrite docstrings for most plot functions. Rik <rik@octave.org> parents: 17032 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 ##
17126 eaab03308c0b doc: Rewrite docstrings for most plot functions. Rik <rik@octave.org> parents: 17032 diff changeset	29 ## If only one argument is given, @var{y}, it is taken as a vector of Y values
eaab03308c0b doc: Rewrite docstrings for most plot functions. Rik <rik@octave.org> parents: 17032 diff changeset	30 ## and the X coordinates are the range @code{1:numel (@var{y})}.
3426 f8dde1807dee [project @ 2000-01-13 08:40:00 by jwe] jwe parents: 3408 diff changeset	31 ##
17126 eaab03308c0b doc: Rewrite docstrings for most plot functions. Rik <rik@octave.org> parents: 17032 diff changeset	32 ## The optional input @var{w} controls the width of the bars. A value of
eaab03308c0b doc: Rewrite docstrings for most plot functions. Rik <rik@octave.org> parents: 17032 diff changeset	33 ## 1.0 will cause each bar to exactly touch any adjacent bars.
eaab03308c0b doc: Rewrite docstrings for most plot functions. Rik <rik@octave.org> parents: 17032 diff changeset	34 ## The default width is 0.8.
7096 81bed50b9feb [project @ 2007-11-02 16:13:43 by jwe] jwe parents: 7086 diff changeset	35 ##
6540 9dcfc78da664 [project @ 2007-04-18 21:16:08 by dbateman] dbateman parents: 6448 diff changeset	36 ## 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	37 ## 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	38 ## are plotted side-by-side. This behavior can be changed by the @var{style}
17289 bc924baa2c4e doc: Add new @qcode macro for code samples which are quoted. Rik <rik@octave.org> parents: 17198 diff changeset	39 ## argument, which can take the values @qcode{"grouped"} (the default),
bc924baa2c4e doc: Add new @qcode macro for code samples which are quoted. Rik <rik@octave.org> parents: 17198 diff changeset	40 ## or @qcode{"stacked"}.
6540 9dcfc78da664 [project @ 2007-04-18 21:16:08 by dbateman] dbateman parents: 6448 diff changeset	41 ##
17126 eaab03308c0b doc: Rewrite docstrings for most plot functions. Rik <rik@octave.org> parents: 17032 diff changeset	42 ## Optional property/value pairs are passed directly to the underlying patch
eaab03308c0b doc: Rewrite docstrings for most plot functions. Rik <rik@octave.org> parents: 17032 diff changeset	43 ## objects.
eaab03308c0b doc: Rewrite docstrings for most plot functions. Rik <rik@octave.org> parents: 17032 diff changeset	44 ##
eaab03308c0b doc: Rewrite docstrings for most plot functions. Rik <rik@octave.org> parents: 17032 diff changeset	45 ## 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: 17032 diff changeset	46 ## rather than the current axes returned by @code{gca}.
16814 64e7bb01fce2 doc: Improve documentation for 2-D plot functions Rik <rik@octave.org> parents: 15565 diff changeset	47 ##
17126 eaab03308c0b doc: Rewrite docstrings for most plot functions. Rik <rik@octave.org> parents: 17032 diff changeset	48 ## The optional return value @var{h} is a vector of handles to the created
eaab03308c0b doc: Rewrite docstrings for most plot functions. Rik <rik@octave.org> parents: 17032 diff changeset	49 ## "bar series" hggroups with one handle per column of the variable @var{y}.
eaab03308c0b doc: Rewrite docstrings for most plot functions. Rik <rik@octave.org> parents: 17032 diff changeset	50 ## This series makes it possible to change a common element in one bar series
eaab03308c0b doc: Rewrite docstrings for most plot functions. Rik <rik@octave.org> parents: 17032 diff changeset	51 ## object and have the change reflected in the other "bar series".
eaab03308c0b doc: Rewrite docstrings for most plot functions. Rik <rik@octave.org> parents: 17032 diff changeset	52 ## For example,
8056 9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them David Bateman <dbateman@free.fr> parents: 7189 diff changeset	53 ##
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them David Bateman <dbateman@free.fr> parents: 7189 diff changeset	54 ## @example
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them David Bateman <dbateman@free.fr> parents: 7189 diff changeset	55 ## @group
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them David Bateman <dbateman@free.fr> parents: 7189 diff changeset	56 ## 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	57 ## 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	58 ## @end group
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them David Bateman <dbateman@free.fr> parents: 7189 diff changeset	59 ## @end example
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them David Bateman <dbateman@free.fr> parents: 7189 diff changeset	60 ##
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them David Bateman <dbateman@free.fr> parents: 7189 diff changeset	61 ## @noindent
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them David Bateman <dbateman@free.fr> parents: 7189 diff changeset	62 ## 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	63 ##
17126 eaab03308c0b doc: Rewrite docstrings for most plot functions. Rik <rik@octave.org> parents: 17032 diff changeset	64 ## The following example modifies the face and edge colors using
eaab03308c0b doc: Rewrite docstrings for most plot functions. Rik <rik@octave.org> parents: 17032 diff changeset	65 ## property/value pairs.
3426 f8dde1807dee [project @ 2000-01-13 08:40:00 by jwe] jwe parents: 3408 diff changeset	66 ##
11366 ad8966096e27 bar.m: Improve the docstring. Rik <octave@nomad.inbox5.com> parents: 10846 diff changeset	67 ## @example
17126 eaab03308c0b doc: Rewrite docstrings for most plot functions. Rik <rik@octave.org> parents: 17032 diff changeset	68 ## bar (randn (1, 100), "facecolor", "r", "edgecolor", "b");
11366 ad8966096e27 bar.m: Improve the docstring. Rik <octave@nomad.inbox5.com> parents: 10846 diff changeset	69 ## @end example
ad8966096e27 bar.m: Improve the docstring. Rik <octave@nomad.inbox5.com> parents: 10846 diff changeset	70 ##
ad8966096e27 bar.m: Improve the docstring. Rik <octave@nomad.inbox5.com> parents: 10846 diff changeset	71 ## @noindent
10572 148559d9d4ac Document the use of the colormap for bar plots David Bateman <dbateman@free.fr> parents: 9245 diff changeset	72 ## 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	73 ##
148559d9d4ac Document the use of the colormap for bar plots David Bateman <dbateman@free.fr> parents: 9245 diff changeset	74 ## @example
148559d9d4ac Document the use of the colormap for bar plots David Bateman <dbateman@free.fr> parents: 9245 diff changeset	75 ## @group
14327 4d917a6a858b doc: Use Octave coding conventions in @example blocks of docstrings. Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	76 ## bar (rand (10, 3));
4d917a6a858b doc: Use Octave coding conventions in @example blocks of docstrings. Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	77 ## colormap (summer (64));
10572 148559d9d4ac Document the use of the colormap for bar plots David Bateman <dbateman@free.fr> parents: 9245 diff changeset	78 ## @end group
148559d9d4ac Document the use of the colormap for bar plots David Bateman <dbateman@free.fr> parents: 9245 diff changeset	79 ## @end example
148559d9d4ac Document the use of the colormap for bar plots David Bateman <dbateman@free.fr> parents: 9245 diff changeset	80 ##
10846 a4f482e66b65 Grammarcheck more of the documentation. Rik <octave@nomad.inbox5.com> parents: 10793 diff changeset	81 ## @noindent
11366 ad8966096e27 bar.m: Improve the docstring. Rik <octave@nomad.inbox5.com> parents: 10846 diff changeset	82 ## will change the colors used for the bars. The color of bars can also be set
17289 bc924baa2c4e doc: Add new @qcode macro for code samples which are quoted. Rik <rik@octave.org> parents: 17198 diff changeset	83 ## manually using the @qcode{"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	84 ##
148559d9d4ac Document the use of the colormap for bar plots David Bateman <dbateman@free.fr> parents: 9245 diff changeset	85 ## @example
148559d9d4ac Document the use of the colormap for bar plots David Bateman <dbateman@free.fr> parents: 9245 diff changeset	86 ## @group
14327 4d917a6a858b doc: Use Octave coding conventions in @example blocks of docstrings. Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	87 ## 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	88 ## set (h(1), "facecolor", "r")
148559d9d4ac Document the use of the colormap for bar plots David Bateman <dbateman@free.fr> parents: 9245 diff changeset	89 ## set (h(2), "facecolor", "g")
148559d9d4ac Document the use of the colormap for bar plots David Bateman <dbateman@free.fr> parents: 9245 diff changeset	90 ## set (h(3), "facecolor", "b")
148559d9d4ac Document the use of the colormap for bar plots David Bateman <dbateman@free.fr> parents: 9245 diff changeset	91 ## @end group
148559d9d4ac Document the use of the colormap for bar plots David Bateman <dbateman@free.fr> parents: 9245 diff changeset	92 ## @end example
148559d9d4ac Document the use of the colormap for bar plots David Bateman <dbateman@free.fr> parents: 9245 diff changeset	93 ##
17126 eaab03308c0b doc: Rewrite docstrings for most plot functions. Rik <rik@octave.org> parents: 17032 diff changeset	94 ## @seealso{barh, hist, pie, plot, patch}
3368 a4cd1e9d9962 [project @ 1999-11-20 17:22:48 by jwe] jwe parents: 3260 diff changeset	95 ## @end deftypefn
4 b4df021f796c [project @ 1993-08-08 01:26:08 by jwe] jwe parents: diff changeset	96
2314 949ab8eba8bc [project @ 1996-07-12 03:58:02 by jwe] jwe parents: 2313 diff changeset	97 ## Author: jwe
949ab8eba8bc [project @ 1996-07-12 03:58:02 by jwe] jwe parents: 2313 diff changeset	98
6540 9dcfc78da664 [project @ 2007-04-18 21:16:08 by dbateman] dbateman parents: 6448 diff changeset	99 function varargout = bar (varargin)
9dcfc78da664 [project @ 2007-04-18 21:16:08 by dbateman] dbateman parents: 6448 diff changeset	100 varargout = cell (nargout, 1);
9dcfc78da664 [project @ 2007-04-18 21:16:08 by dbateman] dbateman parents: 6448 diff changeset	101 [varargout{:}] = __bar__ (true, "bar", varargin{:});
4 b4df021f796c [project @ 1993-08-08 01:26:08 by jwe] jwe parents: diff changeset	102 endfunction
14001 5f0bb45e615c doc: Update documentation for functions returning a graphics handle h (Bug #34761) Rik <octave@nomad.inbox5.com> parents: 11587 diff changeset	103
5f0bb45e615c doc: Update documentation for functions returning a graphics handle h (Bug #34761) Rik <octave@nomad.inbox5.com> parents: 11587 diff changeset	104
15565 de751531e548 test: Add demos for bar.m and barh.m Rik <rik@octave.org> parents: 14327 diff changeset	105 %!demo
de751531e548 test: Add demos for bar.m and barh.m Rik <rik@octave.org> parents: 14327 diff changeset	106 %! clf;
17032 53d6166f7867 Fix bar() update for ydata listener. Ben Abbott <bpabbott@mac.com> parents: 16814 diff changeset	107 %! y = rand (11, 1);
53d6166f7867 Fix bar() update for ydata listener. Ben Abbott <bpabbott@mac.com> parents: 16814 diff changeset	108 %! h = bar (y);
53d6166f7867 Fix bar() update for ydata listener. Ben Abbott <bpabbott@mac.com> parents: 16814 diff changeset	109 %! set (h, 'ydata', sort (rand (11, 1)));
17198 df4c4b7708a4 Add titles and clean-up plotting %!demos. Rik <rik@octave.org> parents: 17126 diff changeset	110 %! title ('bar() graph')
14001 5f0bb45e615c doc: Update documentation for functions returning a graphics handle h (Bug #34761) Rik <octave@nomad.inbox5.com> parents: 11587 diff changeset	111
15565 de751531e548 test: Add demos for bar.m and barh.m Rik <rik@octave.org> parents: 14327 diff changeset	112 %!demo
de751531e548 test: Add demos for bar.m and barh.m Rik <rik@octave.org> parents: 14327 diff changeset	113 %! clf;
de751531e548 test: Add demos for bar.m and barh.m Rik <rik@octave.org> parents: 14327 diff changeset	114 %! h = bar (rand (5, 3));
de751531e548 test: Add demos for bar.m and barh.m Rik <rik@octave.org> parents: 14327 diff changeset	115 %! set (h(1), 'facecolor', 'r')
de751531e548 test: Add demos for bar.m and barh.m Rik <rik@octave.org> parents: 14327 diff changeset	116 %! set (h(2), 'facecolor', 'g')
de751531e548 test: Add demos for bar.m and barh.m Rik <rik@octave.org> parents: 14327 diff changeset	117 %! set (h(3), 'facecolor', 'b')
17198 df4c4b7708a4 Add titles and clean-up plotting %!demos. Rik <rik@octave.org> parents: 17126 diff changeset	118 %! title ('bar() graph w/multiple bars')
15565 de751531e548 test: Add demos for bar.m and barh.m Rik <rik@octave.org> parents: 14327 diff changeset	119

Mercurial > hg > octave-lyh

annotate scripts/plot/bar.m @ 17475:fd01c78caa0b