annotate scripts/plot/draw/bar.m @ 17572:7bb76a22cde1

maint: Split scripts/plot directory into 4 pieces. scripts/gui : user-interface functions scripts/plot/appearance : functions controlling plot appearance scripts/plot/draw : plotting functions which produce graphs scripts/plot/util : low-level plotting functions and utilities. * scripts/gui/guidata.m, scripts/gui/guihandles.m, scripts/gui/module.mk, scripts/gui/private/__file_filter__.m, scripts/gui/private/__fltk_file_filter__.m, scripts/gui/private/__is_function__.m, scripts/gui/private/__uigetdir_fltk__.m, scripts/gui/private/__uigetfile_fltk__.m, scripts/gui/private/__uiobject_split_args__.m, scripts/gui/private/__uiputfile_fltk__.m, scripts/gui/uicontextmenu.m, scripts/gui/uicontrol.m, scripts/gui/uigetdir.m, scripts/gui/uigetfile.m, scripts/gui/uimenu.m, scripts/gui/uipanel.m, scripts/gui/uipushtool.m, scripts/gui/uiputfile.m, scripts/gui/uiresume.m, scripts/gui/uitoggletool.m, scripts/gui/uitoolbar.m, scripts/gui/uiwait.m, scripts/gui/waitbar.m, scripts/gui/waitforbuttonpress.m: Moved from scripts/plot to scripts/gui * scripts/plot/appearance/__clabel__.m, scripts/plot/appearance/__getlegenddata__.m, scripts/plot/appearance/axis.m, scripts/plot/appearance/box.m, scripts/plot/appearance/caxis.m, scripts/plot/appearance/clabel.m, scripts/plot/appearance/daspect.m, scripts/plot/appearance/diffuse.m, scripts/plot/appearance/grid.m, scripts/plot/appearance/gtext.m, scripts/plot/appearance/hidden.m, scripts/plot/appearance/legend.m, scripts/plot/appearance/orient.m, scripts/plot/appearance/pbaspect.m, scripts/plot/appearance/private/__axis_label__.m, scripts/plot/appearance/private/__axis_limits__.m, scripts/plot/appearance/shading.m, scripts/plot/appearance/specular.m, scripts/plot/appearance/text.m, scripts/plot/appearance/title.m, scripts/plot/appearance/view.m, scripts/plot/appearance/whitebg.m, scripts/plot/appearance/xlabel.m, scripts/plot/appearance/xlim.m, scripts/plot/appearance/ylabel.m, scripts/plot/appearance/ylim.m, scripts/plot/appearance/zlabel.m, scripts/plot/appearance/zlim.m: Moved from scripts/plot to subdir appearance. * scripts/plot/draw/area.m, scripts/plot/draw/bar.m, scripts/plot/draw/barh.m, scripts/plot/draw/colorbar.m, scripts/plot/draw/comet.m, scripts/plot/draw/comet3.m, scripts/plot/draw/compass.m, scripts/plot/draw/contour.m, scripts/plot/draw/contour3.m, scripts/plot/draw/contourc.m, scripts/plot/draw/contourf.m, scripts/plot/draw/cylinder.m, scripts/plot/draw/ellipsoid.m, scripts/plot/draw/errorbar.m, scripts/plot/draw/ezcontour.m, scripts/plot/draw/ezcontourf.m, scripts/plot/draw/ezmesh.m, scripts/plot/draw/ezmeshc.m, scripts/plot/draw/ezplot.m, scripts/plot/draw/ezplot3.m, scripts/plot/draw/ezpolar.m, scripts/plot/draw/ezsurf.m, scripts/plot/draw/ezsurfc.m, scripts/plot/draw/feather.m, scripts/plot/draw/fill.m, scripts/plot/draw/fplot.m, scripts/plot/draw/hist.m, scripts/plot/draw/isocolors.m, scripts/plot/draw/isonormals.m, scripts/plot/draw/isosurface.m, scripts/plot/draw/line.m, scripts/plot/draw/loglog.m, scripts/plot/draw/loglogerr.m, scripts/plot/draw/mesh.m, scripts/plot/draw/meshc.m, scripts/plot/draw/meshz.m, scripts/plot/draw/pareto.m, scripts/plot/draw/patch.m, scripts/plot/draw/pcolor.m, scripts/plot/draw/peaks.m, scripts/plot/draw/pie.m, scripts/plot/draw/pie3.m, scripts/plot/draw/plot.m, scripts/plot/draw/plot3.m, scripts/plot/draw/plotmatrix.m, scripts/plot/draw/plotyy.m, scripts/plot/draw/polar.m, scripts/plot/draw/private/__add_datasource__.m, scripts/plot/draw/private/__bar__.m, scripts/plot/draw/private/__contour__.m, scripts/plot/draw/private/__errcomm__.m, scripts/plot/draw/private/__errplot__.m, scripts/plot/draw/private/__ezplot__.m, scripts/plot/draw/private/__interp_cube__.m, scripts/plot/draw/private/__line__.m, scripts/plot/draw/private/__marching_cube__.m, scripts/plot/draw/private/__patch__.m, scripts/plot/draw/private/__pie__.m, scripts/plot/draw/private/__plt__.m, scripts/plot/draw/private/__quiver__.m, scripts/plot/draw/private/__scatter__.m, scripts/plot/draw/private/__stem__.m, scripts/plot/draw/quiver.m, scripts/plot/draw/quiver3.m, scripts/plot/draw/rectangle.m, scripts/plot/draw/ribbon.m, scripts/plot/draw/rose.m, scripts/plot/draw/scatter.m, scripts/plot/draw/scatter3.m, scripts/plot/draw/semilogx.m, scripts/plot/draw/semilogxerr.m, scripts/plot/draw/semilogy.m, scripts/plot/draw/semilogyerr.m, scripts/plot/draw/shrinkfaces.m, scripts/plot/draw/slice.m, scripts/plot/draw/sombrero.m, scripts/plot/draw/sphere.m, scripts/plot/draw/stairs.m, scripts/plot/draw/stem.m, scripts/plot/draw/stem3.m, scripts/plot/draw/stemleaf.m, scripts/plot/draw/surf.m, scripts/plot/draw/surface.m, scripts/plot/draw/surfc.m, scripts/plot/draw/surfl.m, scripts/plot/draw/surfnorm.m, scripts/plot/draw/tetramesh.m, scripts/plot/draw/trimesh.m, scripts/plot/draw/triplot.m, scripts/plot/draw/trisurf.m, scripts/plot/draw/waterfall.m: Moved from plot/ to subdir draw. * scripts/plot/util/__actual_axis_position__.m, scripts/plot/util/__default_plot_options__.m, scripts/plot/util/__gnuplot_drawnow__.m, scripts/plot/util/__next_line_color__.m, scripts/plot/util/__next_line_style__.m, scripts/plot/util/__plt_get_axis_arg__.m, scripts/plot/util/__pltopt__.m, scripts/plot/util/allchild.m, scripts/plot/util/ancestor.m, scripts/plot/util/axes.m, scripts/plot/util/cla.m, scripts/plot/util/clf.m, scripts/plot/util/close.m, scripts/plot/util/closereq.m, scripts/plot/util/colstyle.m, scripts/plot/util/copyobj.m, scripts/plot/util/figure.m, scripts/plot/util/findall.m, scripts/plot/util/findfigs.m, scripts/plot/util/findobj.m, scripts/plot/util/gca.m, scripts/plot/util/gcbf.m, scripts/plot/util/gcbo.m, scripts/plot/util/gcf.m, scripts/plot/util/gco.m, scripts/plot/util/ginput.m, scripts/plot/util/gnuplot_binary.in, scripts/plot/util/graphics_toolkit.m, scripts/plot/util/hdl2struct.m, scripts/plot/util/hggroup.m, scripts/plot/util/hold.m, scripts/plot/util/isaxes.m, scripts/plot/util/isfigure.m, scripts/plot/util/ishghandle.m, scripts/plot/util/ishold.m, scripts/plot/util/isprop.m, scripts/plot/util/linkprop.m, scripts/plot/util/meshgrid.m, scripts/plot/util/ndgrid.m, scripts/plot/util/newplot.m, scripts/plot/util/print.m, scripts/plot/util/printd.m, scripts/plot/util/private/__add_default_menu__.m, scripts/plot/util/private/__fltk_ginput__.m, scripts/plot/util/private/__fltk_print__.m, scripts/plot/util/private/__ghostscript__.m, scripts/plot/util/private/__gnuplot_get_var__.m, scripts/plot/util/private/__gnuplot_ginput__.m, scripts/plot/util/private/__gnuplot_has_feature__.m, scripts/plot/util/private/__gnuplot_has_terminal__.m, scripts/plot/util/private/__gnuplot_open_stream__.m, scripts/plot/util/private/__gnuplot_print__.m, scripts/plot/util/private/__gnuplot_version__.m, scripts/plot/util/private/__go_draw_axes__.m, scripts/plot/util/private/__go_draw_figure__.m, scripts/plot/util/private/__print_parse_opts__.m, scripts/plot/util/private/__tight_eps_bbox__.m, scripts/plot/util/refresh.m, scripts/plot/util/refreshdata.m, scripts/plot/util/saveas.m, scripts/plot/util/shg.m, scripts/plot/util/struct2hdl.m, scripts/plot/util/subplot.m: Moved from plot to subdir util. * etc/HACKING: Updated directory structure info. * scripts/Makefile.am, scripts/plot/appearance/module.mk, scripts/plot/draw/module.mk, scripts/plot/util/module.mk: Added new directories to build system.
author Rik <rik@octave.org>
date Fri, 04 Oct 2013 17:09:08 -0700
parents scripts/plot/bar.m@cc9befe5d271
children d63878346099
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) 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 -*-
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
f8dde1807dee [project @ 2000-01-13 08:40:00 by jwe]
jwe
parents: 3408
diff changeset
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
f8dde1807dee [project @ 2000-01-13 08:40:00 by jwe]
jwe
parents: 3408
diff changeset
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
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}
17519
cc9befe5d271 Overhaul bar family of plot functions.
Rik <rik@octave.org>
parents: 17281
diff changeset
39 ## argument which can take the following values:
cc9befe5d271 Overhaul bar family of plot functions.
Rik <rik@octave.org>
parents: 17281
diff changeset
40 ##
cc9befe5d271 Overhaul bar family of plot functions.
Rik <rik@octave.org>
parents: 17281
diff changeset
41 ## @table @asis
cc9befe5d271 Overhaul bar family of plot functions.
Rik <rik@octave.org>
parents: 17281
diff changeset
42 ## @item @qcode{"grouped"} (default)
cc9befe5d271 Overhaul bar family of plot functions.
Rik <rik@octave.org>
parents: 17281
diff changeset
43 ## Side-by-side bars with a gap between bars and centered over the X-coordinate.
cc9befe5d271 Overhaul bar family of plot functions.
Rik <rik@octave.org>
parents: 17281
diff changeset
44 ##
cc9befe5d271 Overhaul bar family of plot functions.
Rik <rik@octave.org>
parents: 17281
diff changeset
45 ## @item @qcode{"stacked"}
cc9befe5d271 Overhaul bar family of plot functions.
Rik <rik@octave.org>
parents: 17281
diff changeset
46 ## Bars are stacked so that each X value has a single bar composed of
cc9befe5d271 Overhaul bar family of plot functions.
Rik <rik@octave.org>
parents: 17281
diff changeset
47 ## multiple segments.
cc9befe5d271 Overhaul bar family of plot functions.
Rik <rik@octave.org>
parents: 17281
diff changeset
48 ##
cc9befe5d271 Overhaul bar family of plot functions.
Rik <rik@octave.org>
parents: 17281
diff changeset
49 ## @item @qcode{"hist"}
cc9befe5d271 Overhaul bar family of plot functions.
Rik <rik@octave.org>
parents: 17281
diff changeset
50 ## Side-by-side bars with no gap between bars and centered over the
cc9befe5d271 Overhaul bar family of plot functions.
Rik <rik@octave.org>
parents: 17281
diff changeset
51 ## X-coordinate.
cc9befe5d271 Overhaul bar family of plot functions.
Rik <rik@octave.org>
parents: 17281
diff changeset
52 ##
cc9befe5d271 Overhaul bar family of plot functions.
Rik <rik@octave.org>
parents: 17281
diff changeset
53 ## @item @qcode{"histc"}
cc9befe5d271 Overhaul bar family of plot functions.
Rik <rik@octave.org>
parents: 17281
diff changeset
54 ## Side-by-side bars with no gap between bars and left-aligned to the
cc9befe5d271 Overhaul bar family of plot functions.
Rik <rik@octave.org>
parents: 17281
diff changeset
55 ## X-coordinate.
cc9befe5d271 Overhaul bar family of plot functions.
Rik <rik@octave.org>
parents: 17281
diff changeset
56 ## @end table
6540
9dcfc78da664 [project @ 2007-04-18 21:16:08 by dbateman]
dbateman
parents: 6448
diff changeset
57 ##
17122
eaab03308c0b doc: Rewrite docstrings for most plot functions.
Rik <rik@octave.org>
parents: 17032
diff changeset
58 ## 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
59 ## objects.
eaab03308c0b doc: Rewrite docstrings for most plot functions.
Rik <rik@octave.org>
parents: 17032
diff changeset
60 ##
eaab03308c0b doc: Rewrite docstrings for most plot functions.
Rik <rik@octave.org>
parents: 17032
diff changeset
61 ## 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
62 ## 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
63 ##
17122
eaab03308c0b doc: Rewrite docstrings for most plot functions.
Rik <rik@octave.org>
parents: 17032
diff changeset
64 ## 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
65 ## "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
66 ## 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
67 ## 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
68 ## For example,
8056
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents: 7189
diff changeset
69 ##
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents: 7189
diff changeset
70 ## @example
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents: 7189
diff changeset
71 ## @group
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents: 7189
diff changeset
72 ## 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
73 ## 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
74 ## @end group
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents: 7189
diff changeset
75 ## @end example
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents: 7189
diff changeset
76 ##
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents: 7189
diff changeset
77 ## @noindent
9a6f4713f765 Add area, bar, quiver and stair series graphics objects. Document them
David Bateman <dbateman@free.fr>
parents: 7189
diff changeset
78 ## 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
79 ##
17122
eaab03308c0b doc: Rewrite docstrings for most plot functions.
Rik <rik@octave.org>
parents: 17032
diff changeset
80 ## 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
81 ## property/value pairs.
3426
f8dde1807dee [project @ 2000-01-13 08:40:00 by jwe]
jwe
parents: 3408
diff changeset
82 ##
11366
ad8966096e27 bar.m: Improve the docstring.
Rik <octave@nomad.inbox5.com>
parents: 10846
diff changeset
83 ## @example
17122
eaab03308c0b doc: Rewrite docstrings for most plot functions.
Rik <rik@octave.org>
parents: 17032
diff changeset
84 ## bar (randn (1, 100), "facecolor", "r", "edgecolor", "b");
11366
ad8966096e27 bar.m: Improve the docstring.
Rik <octave@nomad.inbox5.com>
parents: 10846
diff changeset
85 ## @end example
ad8966096e27 bar.m: Improve the docstring.
Rik <octave@nomad.inbox5.com>
parents: 10846
diff changeset
86 ##
ad8966096e27 bar.m: Improve the docstring.
Rik <octave@nomad.inbox5.com>
parents: 10846
diff changeset
87 ## @noindent
10572
148559d9d4ac Document the use of the colormap for bar plots
David Bateman <dbateman@free.fr>
parents: 9245
diff changeset
88 ## 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
89 ##
148559d9d4ac Document the use of the colormap for bar plots
David Bateman <dbateman@free.fr>
parents: 9245
diff changeset
90 ## @example
148559d9d4ac Document the use of the colormap for bar plots
David Bateman <dbateman@free.fr>
parents: 9245
diff changeset
91 ## @group
14327
4d917a6a858b doc: Use Octave coding conventions in @example blocks of docstrings.
Rik <octave@nomad.inbox5.com>
parents: 14138
diff changeset
92 ## bar (rand (10, 3));
4d917a6a858b doc: Use Octave coding conventions in @example blocks of docstrings.
Rik <octave@nomad.inbox5.com>
parents: 14138
diff changeset
93 ## colormap (summer (64));
10572
148559d9d4ac Document the use of the colormap for bar plots
David Bateman <dbateman@free.fr>
parents: 9245
diff changeset
94 ## @end group
148559d9d4ac Document the use of the colormap for bar plots
David Bateman <dbateman@free.fr>
parents: 9245
diff changeset
95 ## @end example
148559d9d4ac Document the use of the colormap for bar plots
David Bateman <dbateman@free.fr>
parents: 9245
diff changeset
96 ##
10846
a4f482e66b65 Grammarcheck more of the documentation.
Rik <octave@nomad.inbox5.com>
parents: 10793
diff changeset
97 ## @noindent
11366
ad8966096e27 bar.m: Improve the docstring.
Rik <octave@nomad.inbox5.com>
parents: 10846
diff changeset
98 ## will change the colors used for the bars. The color of bars can also be set
17281
bc924baa2c4e doc: Add new @qcode macro for code samples which are quoted.
Rik <rik@octave.org>
parents: 17190
diff changeset
99 ## 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
100 ##
148559d9d4ac Document the use of the colormap for bar plots
David Bateman <dbateman@free.fr>
parents: 9245
diff changeset
101 ## @example
148559d9d4ac Document the use of the colormap for bar plots
David Bateman <dbateman@free.fr>
parents: 9245
diff changeset
102 ## @group
14327
4d917a6a858b doc: Use Octave coding conventions in @example blocks of docstrings.
Rik <octave@nomad.inbox5.com>
parents: 14138
diff changeset
103 ## 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
104 ## set (h(1), "facecolor", "r")
148559d9d4ac Document the use of the colormap for bar plots
David Bateman <dbateman@free.fr>
parents: 9245
diff changeset
105 ## set (h(2), "facecolor", "g")
148559d9d4ac Document the use of the colormap for bar plots
David Bateman <dbateman@free.fr>
parents: 9245
diff changeset
106 ## set (h(3), "facecolor", "b")
148559d9d4ac Document the use of the colormap for bar plots
David Bateman <dbateman@free.fr>
parents: 9245
diff changeset
107 ## @end group
148559d9d4ac Document the use of the colormap for bar plots
David Bateman <dbateman@free.fr>
parents: 9245
diff changeset
108 ## @end example
148559d9d4ac Document the use of the colormap for bar plots
David Bateman <dbateman@free.fr>
parents: 9245
diff changeset
109 ##
17122
eaab03308c0b doc: Rewrite docstrings for most plot functions.
Rik <rik@octave.org>
parents: 17032
diff changeset
110 ## @seealso{barh, hist, pie, plot, patch}
3368
a4cd1e9d9962 [project @ 1999-11-20 17:22:48 by jwe]
jwe
parents: 3260
diff changeset
111 ## @end deftypefn
4
b4df021f796c [project @ 1993-08-08 01:26:08 by jwe]
jwe
parents:
diff changeset
112
2314
949ab8eba8bc [project @ 1996-07-12 03:58:02 by jwe]
jwe
parents: 2313
diff changeset
113 ## Author: jwe
949ab8eba8bc [project @ 1996-07-12 03:58:02 by jwe]
jwe
parents: 2313
diff changeset
114
6540
9dcfc78da664 [project @ 2007-04-18 21:16:08 by dbateman]
dbateman
parents: 6448
diff changeset
115 function varargout = bar (varargin)
9dcfc78da664 [project @ 2007-04-18 21:16:08 by dbateman]
dbateman
parents: 6448
diff changeset
116 varargout = cell (nargout, 1);
9dcfc78da664 [project @ 2007-04-18 21:16:08 by dbateman]
dbateman
parents: 6448
diff changeset
117 [varargout{:}] = __bar__ (true, "bar", varargin{:});
4
b4df021f796c [project @ 1993-08-08 01:26:08 by jwe]
jwe
parents:
diff changeset
118 endfunction
14001
5f0bb45e615c doc: Update documentation for functions returning a graphics handle h (Bug #34761)
Rik <octave@nomad.inbox5.com>
parents: 11587
diff changeset
119
5f0bb45e615c doc: Update documentation for functions returning a graphics handle h (Bug #34761)
Rik <octave@nomad.inbox5.com>
parents: 11587
diff changeset
120
15565
de751531e548 test: Add demos for bar.m and barh.m
Rik <rik@octave.org>
parents: 14327
diff changeset
121 %!demo
de751531e548 test: Add demos for bar.m and barh.m
Rik <rik@octave.org>
parents: 14327
diff changeset
122 %! clf;
17032
53d6166f7867 Fix bar() update for ydata listener.
Ben Abbott <bpabbott@mac.com>
parents: 16814
diff changeset
123 %! y = rand (11, 1);
53d6166f7867 Fix bar() update for ydata listener.
Ben Abbott <bpabbott@mac.com>
parents: 16814
diff changeset
124 %! h = bar (y);
53d6166f7867 Fix bar() update for ydata listener.
Ben Abbott <bpabbott@mac.com>
parents: 16814
diff changeset
125 %! set (h, 'ydata', sort (rand (11, 1)));
17519
cc9befe5d271 Overhaul bar family of plot functions.
Rik <rik@octave.org>
parents: 17281
diff changeset
126 %! 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
127
15565
de751531e548 test: Add demos for bar.m and barh.m
Rik <rik@octave.org>
parents: 14327
diff changeset
128 %!demo
de751531e548 test: Add demos for bar.m and barh.m
Rik <rik@octave.org>
parents: 14327
diff changeset
129 %! clf;
de751531e548 test: Add demos for bar.m and barh.m
Rik <rik@octave.org>
parents: 14327
diff changeset
130 %! h = bar (rand (5, 3));
17519
cc9befe5d271 Overhaul bar family of plot functions.
Rik <rik@octave.org>
parents: 17281
diff changeset
131 %! set (h(1), 'facecolor', 'r');
cc9befe5d271 Overhaul bar family of plot functions.
Rik <rik@octave.org>
parents: 17281
diff changeset
132 %! set (h(2), 'facecolor', 'g');
cc9befe5d271 Overhaul bar family of plot functions.
Rik <rik@octave.org>
parents: 17281
diff changeset
133 %! set (h(3), 'facecolor', 'b');
cc9befe5d271 Overhaul bar family of plot functions.
Rik <rik@octave.org>
parents: 17281
diff changeset
134 %! 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
135
17519
cc9befe5d271 Overhaul bar family of plot functions.
Rik <rik@octave.org>
parents: 17281
diff changeset
136 %!demo
cc9befe5d271 Overhaul bar family of plot functions.
Rik <rik@octave.org>
parents: 17281
diff changeset
137 %! clf;
cc9befe5d271 Overhaul bar family of plot functions.
Rik <rik@octave.org>
parents: 17281
diff changeset
138 %! h = bar (rand (5, 3), 'stacked');
cc9befe5d271 Overhaul bar family of plot functions.
Rik <rik@octave.org>
parents: 17281
diff changeset
139 %! title ('bar() graph with stacked style');
cc9befe5d271 Overhaul bar family of plot functions.
Rik <rik@octave.org>
parents: 17281
diff changeset
140