Mercurial > hg > octave-nkf
annotate scripts/plot/bar.m @ 17122:eaab03308c0b
doc: Rewrite docstrings for most plot functions.
Emphasize clarity, use common "voice", and increase density of seealso links.
* doc/interpreter/plot.txi: Add @findex entries that were in xlim.m
* scripts/miscellaneous/getappdata.m scripts/miscellaneous/setappdata.m,
scripts/plot/allchild.m, scripts/plot/ancestor.m, scripts/plot/area.m,
scripts/plot/axes.m, scripts/plot/axis.m, scripts/plot/bar.m,
scripts/plot/barh.m, scripts/plot/box.m, scripts/plot/caxis.m,
scripts/plot/cla.m, scripts/plot/clabel.m, scripts/plot/clf.m,
scripts/plot/close.m, scripts/plot/closereq.m, scripts/plot/colorbar.m,
scripts/plot/comet.m, scripts/plot/comet3.m, scripts/plot/compass.m,
scripts/plot/contour.m, scripts/plot/contour3.m, scripts/plot/contourc.m,
scripts/plot/contourf.m, scripts/plot/copyobj.m, scripts/plot/cylinder.m,
scripts/plot/daspect.m, scripts/plot/diffuse.m, scripts/plot/ellipsoid.m,
scripts/plot/errorbar.m, scripts/plot/ezcontour.m, scripts/plot/ezcontourf.m,
scripts/plot/ezmesh.m, scripts/plot/ezmeshc.m, scripts/plot/ezplot.m,
scripts/plot/ezplot3.m, scripts/plot/ezpolar.m, scripts/plot/ezsurf.m,
scripts/plot/ezsurfc.m, scripts/plot/feather.m, scripts/plot/figure.m,
scripts/plot/fill.m, scripts/plot/findall.m, scripts/plot/findobj.m,
scripts/plot/fplot.m, scripts/plot/gca.m, scripts/plot/gcbf.m,
scripts/plot/gcbo.m, scripts/plot/gcf.m, scripts/plot/gco.m,
scripts/plot/ginput.m, scripts/plot/graphics_toolkit.m, scripts/plot/grid.m,
scripts/plot/gtext.m, scripts/plot/guidata.m, scripts/plot/guihandles.m,
scripts/plot/hdl2struct.m, scripts/plot/hggroup.m, scripts/plot/hidden.m,
scripts/plot/hist.m, scripts/plot/hold.m, scripts/plot/ishghandle.m,
scripts/plot/ishold.m, scripts/plot/isocolors.m, scripts/plot/isprop.m,
scripts/plot/legend.m, scripts/plot/line.m, scripts/plot/linkprop.m,
scripts/plot/loglog.m, scripts/plot/loglogerr.m, scripts/plot/mesh.m,
scripts/plot/meshc.m, scripts/plot/meshgrid.m, scripts/plot/meshz.m,
scripts/plot/newplot.m, scripts/plot/orient.m, scripts/plot/pareto.m,
scripts/plot/patch.m, scripts/plot/pcolor.m, scripts/plot/peaks.m,
scripts/plot/pie.m, scripts/plot/pie3.m, scripts/plot/plot.m,
scripts/plot/plot3.m, scripts/plot/plotmatrix.m, scripts/plot/plotyy.m,
scripts/plot/polar.m, scripts/plot/print.m, scripts/plot/quiver.m,
scripts/plot/quiver3.m, scripts/plot/rectangle.m, scripts/plot/refresh.m,
scripts/plot/refreshdata.m, scripts/plot/ribbon.m, scripts/plot/rose.m,
scripts/plot/saveas.m, scripts/plot/scatter.m, scripts/plot/scatter3.m,
scripts/plot/semilogx.m, scripts/plot/semilogxerr.m, scripts/plot/semilogy.m,
scripts/plot/semilogyerr.m, scripts/plot/shading.m, scripts/plot/shg.m,
scripts/plot/shrinkfaces.m, scripts/plot/slice.m, scripts/plot/specular.m,
scripts/plot/sphere.m, scripts/plot/stairs.m, scripts/plot/stem.m,
scripts/plot/stem3.m, scripts/plot/struct2hdl.m, scripts/plot/subplot.m,
scripts/plot/surf.m, scripts/plot/surface.m, scripts/plot/surfc.m,
scripts/plot/surfl.m, scripts/plot/tetramesh.m, scripts/plot/text.m,
scripts/plot/title.m, scripts/plot/trimesh.m, scripts/plot/triplot.m,
scripts/plot/trisurf.m, scripts/plot/view.m, scripts/plot/waitbar.m,
scripts/plot/waitforbuttonpress.m, scripts/plot/waterfall.m,
scripts/plot/whitebg.m, scripts/plot/xlabel.m, scripts/plot/xlim.m,
scripts/plot/ylabel.m, scripts/plot/ylim.m, scripts/plot/zlabel.m,
scripts/plot/zlim.m: Rewrite docstrings for most plot functions.
Emphasize clarity, use common "voice", and increase density of seealso links.
author | Rik <rik@octave.org> |
---|---|
date | Wed, 31 Jul 2013 13:53:30 -0700 |
parents | 53d6166f7867 |
children | df4c4b7708a4 |
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 | 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. | |
2313 | 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/>. | |
245 | 18 |
3368 | 19 ## -*- texinfo -*- |
17122
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 | 28 ## |
17122
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 | 31 ## |
17122
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 | 35 ## |
6540 | 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} |
7086 | 39 ## argument, which can take the values @code{"grouped"} (the default), |
40 ## or @code{"stacked"}. | |
6540 | 41 ## |
17122
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 ## |
17122
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 ## |
17122
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 | 66 ## |
11366
ad8966096e27
bar.m: Improve the docstring.
Rik <octave@nomad.inbox5.com>
parents:
10846
diff
changeset
|
67 ## @example |
17122
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 |
ad8966096e27
bar.m: Improve the docstring.
Rik <octave@nomad.inbox5.com>
parents:
10846
diff
changeset
|
83 ## 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
|
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 ## |
17122
eaab03308c0b
doc: Rewrite docstrings for most plot functions.
Rik <rik@octave.org>
parents:
17032
diff
changeset
|
94 ## @seealso{barh, hist, pie, plot, patch} |
3368 | 95 ## @end deftypefn |
4 | 96 |
2314 | 97 ## Author: jwe |
98 | |
6540 | 99 function varargout = bar (varargin) |
100 varargout = cell (nargout, 1); | |
101 [varargout{:}] = __bar__ (true, "bar", varargin{:}); | |
4 | 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))); |
14001
5f0bb45e615c
doc: Update documentation for functions returning a graphics handle h (Bug #34761)
Rik <octave@nomad.inbox5.com>
parents:
11587
diff
changeset
|
110 |
15565
de751531e548
test: Add demos for bar.m and barh.m
Rik <rik@octave.org>
parents:
14327
diff
changeset
|
111 %!demo |
de751531e548
test: Add demos for bar.m and barh.m
Rik <rik@octave.org>
parents:
14327
diff
changeset
|
112 %! clf; |
de751531e548
test: Add demos for bar.m and barh.m
Rik <rik@octave.org>
parents:
14327
diff
changeset
|
113 %! h = bar (rand (5, 3)); |
de751531e548
test: Add demos for bar.m and barh.m
Rik <rik@octave.org>
parents:
14327
diff
changeset
|
114 %! set (h(1), 'facecolor', 'r') |
de751531e548
test: Add demos for bar.m and barh.m
Rik <rik@octave.org>
parents:
14327
diff
changeset
|
115 %! set (h(2), 'facecolor', 'g') |
de751531e548
test: Add demos for bar.m and barh.m
Rik <rik@octave.org>
parents:
14327
diff
changeset
|
116 %! set (h(3), 'facecolor', 'b') |
de751531e548
test: Add demos for bar.m and barh.m
Rik <rik@octave.org>
parents:
14327
diff
changeset
|
117 |