Mercurial > hg > octave-lyh

annotate scripts/plot/barh.m @ 17455:359366a4994f

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
waitbar.m: Use Octave coding conventions. * scripts/plot/waitbar.m: Rename 'retval' to 'h' to match documentation. Use 'hf', 'hp' for figure and patch graphics handles.
author Rik <rik@octave.org>
date Thu, 19 Sep 2013 14:26:47 -0700
parents bc924baa2c4e
children
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) 1996-2012 John W. Eaton
6633
5af6275fbca9 [project @ 2007-05-17 19:44:28 by dbateman]
dbateman
parents:
diff changeset
2 ##
5af6275fbca9 [project @ 2007-05-17 19:44:28 by dbateman]
dbateman
parents:
diff changeset
3 ## This file is part of Octave.
5af6275fbca9 [project @ 2007-05-17 19:44:28 by dbateman]
dbateman
parents:
diff changeset
4 ##
5af6275fbca9 [project @ 2007-05-17 19:44:28 by dbateman]
dbateman
parents:
diff changeset
5 ## Octave is free software; you can redistribute it and/or modify it
5af6275fbca9 [project @ 2007-05-17 19:44:28 by dbateman]
dbateman
parents:
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.
6633
5af6275fbca9 [project @ 2007-05-17 19:44:28 by dbateman]
dbateman
parents:
diff changeset
9 ##
5af6275fbca9 [project @ 2007-05-17 19:44:28 by dbateman]
dbateman
parents:
diff changeset
10 ## Octave is distributed in the hope that it will be useful, but
5af6275fbca9 [project @ 2007-05-17 19:44:28 by dbateman]
dbateman
parents:
diff changeset
11 ## WITHOUT ANY WARRANTY; without even the implied warranty of
5af6275fbca9 [project @ 2007-05-17 19:44:28 by dbateman]
dbateman
parents:
diff changeset
12 ## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
5af6275fbca9 [project @ 2007-05-17 19:44:28 by dbateman]
dbateman
parents:
diff changeset
13 ## General Public License for more details.
5af6275fbca9 [project @ 2007-05-17 19:44:28 by dbateman]
dbateman
parents:
diff changeset
14 ##
5af6275fbca9 [project @ 2007-05-17 19:44:28 by dbateman]
dbateman
parents:
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/>.
6633
5af6275fbca9 [project @ 2007-05-17 19:44:28 by dbateman]
dbateman
parents:
diff changeset
18
5af6275fbca9 [project @ 2007-05-17 19:44:28 by dbateman]
dbateman
parents:
diff changeset
19 ## -*- texinfo -*-
17126
eaab03308c0b doc: Rewrite docstrings for most plot functions.
Rik <rik@octave.org>
parents: 16814
diff changeset
20 ## @deftypefn {Function File} {} barh (@var{y})
eaab03308c0b doc: Rewrite docstrings for most plot functions.
Rik <rik@octave.org>
parents: 16814
diff changeset
21 ## @deftypefnx {Function File} {} barh (@var{x}, @var{y})
eaab03308c0b doc: Rewrite docstrings for most plot functions.
Rik <rik@octave.org>
parents: 16814
diff changeset
22 ## @deftypefnx {Function File} {} barh (@dots{}, @var{w})
eaab03308c0b doc: Rewrite docstrings for most plot functions.
Rik <rik@octave.org>
parents: 16814
diff changeset
23 ## @deftypefnx {Function File} {} barh (@dots{}, @var{style})
eaab03308c0b doc: Rewrite docstrings for most plot functions.
Rik <rik@octave.org>
parents: 16814
diff changeset
24 ## @deftypefnx {Function File} {} barh (@dots{}, @var{prop}, @var{val}, @dots{})
eaab03308c0b doc: Rewrite docstrings for most plot functions.
Rik <rik@octave.org>
parents: 16814
diff changeset
25 ## @deftypefnx {Function File} {} barh (@var{hax}, @dots{})
eaab03308c0b doc: Rewrite docstrings for most plot functions.
Rik <rik@octave.org>
parents: 16814
diff changeset
26 ## @deftypefnx {Function File} {@var{h} =} barh (@dots{}, @var{prop}, @var{val}, @dots{})
eaab03308c0b doc: Rewrite docstrings for most plot functions.
Rik <rik@octave.org>
parents: 16814
diff changeset
27 ## Produce a horizontal bar graph from two vectors of X-Y data.
6633
5af6275fbca9 [project @ 2007-05-17 19:44:28 by dbateman]
dbateman
parents:
diff changeset
28 ##
17126
eaab03308c0b doc: Rewrite docstrings for most plot functions.
Rik <rik@octave.org>
parents: 16814
diff changeset
29 ## If only one argument is given, it is taken as a vector of Y values
eaab03308c0b doc: Rewrite docstrings for most plot functions.
Rik <rik@octave.org>
parents: 16814
diff changeset
30 ## and the X coordinates are the range @code{1:numel (@var{y})}.
6633
5af6275fbca9 [project @ 2007-05-17 19:44:28 by dbateman]
dbateman
parents:
diff changeset
31 ##
17126
eaab03308c0b doc: Rewrite docstrings for most plot functions.
Rik <rik@octave.org>
parents: 16814
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: 16814
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: 16814
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 ##
6633
5af6275fbca9 [project @ 2007-05-17 19:44:28 by dbateman]
dbateman
parents:
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"}.
6633
5af6275fbca9 [project @ 2007-05-17 19:44:28 by dbateman]
dbateman
parents:
diff changeset
41 ##
17126
eaab03308c0b doc: Rewrite docstrings for most plot functions.
Rik <rik@octave.org>
parents: 16814
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: 16814
diff changeset
43 ## objects.
eaab03308c0b doc: Rewrite docstrings for most plot functions.
Rik <rik@octave.org>
parents: 16814
diff changeset
44 ##
eaab03308c0b doc: Rewrite docstrings for most plot functions.
Rik <rik@octave.org>
parents: 16814
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: 16814
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 ##
14001
5f0bb45e615c doc: Update documentation for functions returning a graphics handle h (Bug #34761)
Rik <octave@nomad.inbox5.com>
parents: 11587
diff changeset
48 ## The optional return value @var{h} is a graphics handle to the created
17126
eaab03308c0b doc: Rewrite docstrings for most plot functions.
Rik <rik@octave.org>
parents: 16814
diff changeset
49 ## bar series hggroup. For a description of the use of the
eaab03308c0b doc: Rewrite docstrings for most plot functions.
Rik <rik@octave.org>
parents: 16814
diff changeset
50 ## bar series, @pxref{XREFbar,,bar}.
eaab03308c0b doc: Rewrite docstrings for most plot functions.
Rik <rik@octave.org>
parents: 16814
diff changeset
51 ## @seealso{bar, hist, pie, plot, patch}
6633
5af6275fbca9 [project @ 2007-05-17 19:44:28 by dbateman]
dbateman
parents:
diff changeset
52 ## @end deftypefn
5af6275fbca9 [project @ 2007-05-17 19:44:28 by dbateman]
dbateman
parents:
diff changeset
53
5af6275fbca9 [project @ 2007-05-17 19:44:28 by dbateman]
dbateman
parents:
diff changeset
54 ## Author: jwe
5af6275fbca9 [project @ 2007-05-17 19:44:28 by dbateman]
dbateman
parents:
diff changeset
55
5af6275fbca9 [project @ 2007-05-17 19:44:28 by dbateman]
dbateman
parents:
diff changeset
56 function varargout = barh (varargin)
5af6275fbca9 [project @ 2007-05-17 19:44:28 by dbateman]
dbateman
parents:
diff changeset
57 varargout = cell (nargout, 1);
5af6275fbca9 [project @ 2007-05-17 19:44:28 by dbateman]
dbateman
parents:
diff changeset
58 [varargout{:}] = __bar__ (false, "barh", varargin{:});
5af6275fbca9 [project @ 2007-05-17 19:44:28 by dbateman]
dbateman
parents:
diff changeset
59 endfunction
14001
5f0bb45e615c doc: Update documentation for functions returning a graphics handle h (Bug #34761)
Rik <octave@nomad.inbox5.com>
parents: 11587
diff changeset
60
5f0bb45e615c doc: Update documentation for functions returning a graphics handle h (Bug #34761)
Rik <octave@nomad.inbox5.com>
parents: 11587
diff changeset
61
15565
de751531e548 test: Add demos for bar.m and barh.m
Rik <rik@octave.org>
parents: 14138
diff changeset
62 %!demo
de751531e548 test: Add demos for bar.m and barh.m
Rik <rik@octave.org>
parents: 14138
diff changeset
63 %! clf;
de751531e548 test: Add demos for bar.m and barh.m
Rik <rik@octave.org>
parents: 14138
diff changeset
64 %! x = rand (10, 1);
de751531e548 test: Add demos for bar.m and barh.m
Rik <rik@octave.org>
parents: 14138
diff changeset
65 %! barh (x);
17198
df4c4b7708a4 Add titles and clean-up plotting %!demos.
Rik <rik@octave.org>
parents: 17126
diff changeset
66 %! title ('barh() graph')
14001
5f0bb45e615c doc: Update documentation for functions returning a graphics handle h (Bug #34761)
Rik <octave@nomad.inbox5.com>
parents: 11587
diff changeset
67
15565
de751531e548 test: Add demos for bar.m and barh.m
Rik <rik@octave.org>
parents: 14138
diff changeset
68 %!demo
de751531e548 test: Add demos for bar.m and barh.m
Rik <rik@octave.org>
parents: 14138
diff changeset
69 %! clf;
de751531e548 test: Add demos for bar.m and barh.m
Rik <rik@octave.org>
parents: 14138
diff changeset
70 %! h = barh (rand (5, 3));
de751531e548 test: Add demos for bar.m and barh.m
Rik <rik@octave.org>
parents: 14138
diff changeset
71 %! set (h(1), 'facecolor', 'r')
de751531e548 test: Add demos for bar.m and barh.m
Rik <rik@octave.org>
parents: 14138
diff changeset
72 %! set (h(2), 'facecolor', 'g')
de751531e548 test: Add demos for bar.m and barh.m
Rik <rik@octave.org>
parents: 14138
diff changeset
73 %! set (h(3), 'facecolor', 'b')
17198
df4c4b7708a4 Add titles and clean-up plotting %!demos.
Rik <rik@octave.org>
parents: 17126
diff changeset
74 %! title ('barh() graph w/multiple bars')
15565
de751531e548 test: Add demos for bar.m and barh.m
Rik <rik@octave.org>
parents: 14138
diff changeset
75