Mercurial > octave-nkf
annotate scripts/plot/barh.m @ 8920:eb63fbe60fab
update copyright notices
| author | John W. Eaton <jwe@octave.org> |
|---|---|
| date | Sat, 07 Mar 2009 10:41:27 -0500 |
| parents | 9a6f4713f765 |
| children | dbd0c77e575e |
| rev | line source |
|---|---|
| 8920 | 1 ## Copyright (C) 1996, 1997, 2007, 2008 John W. Eaton |
| 6633 | 2 ## |
| 3 ## This file is part of Octave. | |
| 4 ## | |
| 5 ## Octave is free software; you can redistribute it and/or modify it | |
| 6 ## under the terms of the GNU General Public License as published by | |
| 7016 | 7 ## the Free Software Foundation; either version 3 of the License, or (at |
| 8 ## your option) any later version. | |
| 6633 | 9 ## |
| 10 ## Octave is distributed in the hope that it will be useful, but | |
| 11 ## WITHOUT ANY WARRANTY; without even the implied warranty of | |
| 12 ## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU | |
| 13 ## General Public License for more details. | |
| 14 ## | |
| 15 ## You should have received a copy of the GNU General Public License | |
| 7016 | 16 ## along with Octave; see the file COPYING. If not, see |
| 17 ## <http://www.gnu.org/licenses/>. | |
| 6633 | 18 |
| 19 ## -*- texinfo -*- | |
| 7106 | 20 ## @deftypefn {Function File} {} barh (@var{x}, @var{y}) |
| 21 ## @deftypefnx {Function File} {} barh (@var{y}) | |
| 22 ## @deftypefnx {Function File} {} barh (@var{x}, @var{y}, @var{w}) | |
| 23 ## @deftypefnx {Function File} {} barh (@var{x}, @var{y}, @var{w}, @var{style}) | |
| 24 ## @deftypefnx {Function File} {@var{h} =} barh (@dots{}, @var{prop}, @var{val}) | |
| 7189 | 25 ## @deftypefnx {Function File} {} barh (@var{h}, @dots{}) |
| 7096 | 26 ## Produce a horizontal bar graph from two vectors of x-y data. |
| 6633 | 27 ## |
| 28 ## If only one argument is given, it is taken as a vector of y-values | |
| 29 ## and the x coordinates are taken to be the indices of the elements. | |
| 30 ## | |
| 7096 | 31 ## The default width of 0.8 for the bars can be changed using @var{w}. |
| 32 ## | |
| 6633 | 33 ## If @var{y} is a matrix, then each column of @var{y} is taken to be a |
| 34 ## separate bar graph plotted on the same graph. By default the columns | |
| 35 ## are plotted side-by-side. This behavior can be changed by the @var{style} | |
| 7086 | 36 ## argument, which can take the values @code{"grouped"} (the default), |
| 37 ## or @code{"stacked"}. | |
| 6633 | 38 ## |
|
8056
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
7189
diff
changeset
|
39 ## The optional return value @var{h} provides a handle to the bar series |
|
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
7189
diff
changeset
|
40 ## object. See @code{bar} for a description of the use 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
|
41 ## |
|
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
7189
diff
changeset
|
42 ## The optional input handle @var{h} allows an axis handle to be passed. |
|
9a6f4713f765
Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents:
7189
diff
changeset
|
43 ## Properties of the patch graphics object can be changed using |
| 7096 | 44 ## @var{prop}, @var{val} pairs. |
| 6633 | 45 ## |
| 6895 | 46 ## @seealso{bar, plot} |
| 6633 | 47 ## @end deftypefn |
| 48 | |
| 49 ## Author: jwe | |
| 50 | |
| 51 function varargout = barh (varargin) | |
| 52 varargout = cell (nargout, 1); | |
| 53 [varargout{:}] = __bar__ (false, "barh", varargin{:}); | |
| 54 endfunction |