Mercurial > hg > octave-lyh
annotate scripts/plot/barh.m @ 14001:5f0bb45e615c
doc: Update documentation for functions returning a graphics handle h (Bug #34761)
* voronoi.m, image.m, imagesc.m, imshow.m, area.m, bar.m, barh.m, clabel.m,
clf.m, compass.m, ezcontour.m, ezcontourf.m, ezmesh.m, ezmeshc.m, ezplot.m,
ezplot3.m, ezpolar.m, ezsurf.m, ezsurfc.m, feather.m, fill.m, findall.m,
findobj.m, loglog.m, mesh.m, pareto.m, patch.m, pie.m, pie3.m, plot.m, polar.m,
quiver.m, quiver3.m, rectangle.m, ribbon.m, rose.m, scatter.m, scatter3.m,
semilogx.m, semilogy.m, slice.m, stem.m, surf.m, surface.m, text.m, title.m,
trimesh.m, triplot.m, trisurf.m, xlabel.m, ylabel.m, zlabel.m:
Update documentation for functions returning a graphics handle h.
| author | Rik <octave@nomad.inbox5.com> |
|---|---|
| date | Tue, 06 Dec 2011 13:09:17 -0800 |
| parents | c792872f8942 |
| children | 72c96de7a403 |
| rev | line source |
|---|---|
| 11523 | 1 ## Copyright (C) 1996-2011 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 -*- | |
|
10793
be55736a0783
Grammarcheck the documentation from m-files.
Rik <octave@nomad.inbox5.com>
parents:
9245
diff
changeset
|
20 ## @deftypefn {Function File} {} barh (@var{x}, @var{y}) |
| 7106 | 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 ## | |
|
11587
c792872f8942
all script files: untabify and strip trailing whitespace
John W. Eaton <jwe@octave.org>
parents:
11523
diff
changeset
|
31 ## The default width of 0.8 for the bars can be changed using @var{w}. |
| 7096 | 32 ## |
| 6633 | 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 | 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 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
|
40 ## Properties of the patch graphics object can be changed using |
| 7096 | 41 ## @var{prop}, @var{val} pairs. |
| 6633 | 42 ## |
|
14001
5f0bb45e615c
doc: Update documentation for functions returning a graphics handle h (Bug #34761)
Rik <octave@nomad.inbox5.com>
parents:
11587
diff
changeset
|
43 ## The optional return value @var{h} is a graphics handle to the created |
|
5f0bb45e615c
doc: Update documentation for functions returning a graphics handle h (Bug #34761)
Rik <octave@nomad.inbox5.com>
parents:
11587
diff
changeset
|
44 ## bar series object. See @code{bar} for a description of the use of the |
|
5f0bb45e615c
doc: Update documentation for functions returning a graphics handle h (Bug #34761)
Rik <octave@nomad.inbox5.com>
parents:
11587
diff
changeset
|
45 ## bar series. |
| 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 | |
|
14001
5f0bb45e615c
doc: Update documentation for functions returning a graphics handle h (Bug #34761)
Rik <octave@nomad.inbox5.com>
parents:
11587
diff
changeset
|
55 |
|
5f0bb45e615c
doc: Update documentation for functions returning a graphics handle h (Bug #34761)
Rik <octave@nomad.inbox5.com>
parents:
11587
diff
changeset
|
56 |
|
5f0bb45e615c
doc: Update documentation for functions returning a graphics handle h (Bug #34761)
Rik <octave@nomad.inbox5.com>
parents:
11587
diff
changeset
|
57 %% 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
|
58 |