Home > freetb4matlab > plot > bar.m

bar

PURPOSE ^

% Produce a bar graph from two vectors of x-y data.

SYNOPSIS ^

function varargout = bar (varargin)

DESCRIPTION ^

% -*- texinfo -*-
% @deftypefn {Function File} {} bar (@var{x}, @var{y})
% @deftypefnx {Function File} {} bar (@var{y})
% @deftypefnx {Function File} {} bar (@var{x}, @var{y}, @var{w})
% @deftypefnx {Function File} {} bar (@var{x}, @var{y}, @var{w}, @var{style})
% @deftypefnx {Function File} {@var{h} =} bar (@dots{}, @var{prop}, @var{val})
% @deftypefnx {Function File} {} bar (@var{h}, @dots{})
% Produce a bar graph from two vectors of x-y data.
%
% If only one argument is given, it is taken as a vector of y-values
% and the x coordinates are taken to be the indices of the elements.
%
% The default width of 0.8 for the bars can be changed using @var{w}. 
%
% If @var{y} is a matrix, then each column of @var{y} is taken to be a
% separate bar graph plotted on the same graph.  By default the columns
% are plotted side-by-side.  This behavior can be changed by the @var{style}
% argument, which can take the values @code{'grouped'} (the default),
% or @code{'stacked'}.
%
% The optional return value @var{h} provides a handle to the 'bar series'
% object with one handle per column of the variable @var{y}.  This
% series allows common elements of the group of bar series objects to
% be changed in a single bar series and the same properties are changed
% in the other 'bar series'.  For example
%
% @example
% @group
% h = bar (rand (5, 10));
% set (h(1), 'basevalue', 0.5);
% @end group
% @end example
%
% @noindent
% changes the position on the base of all of the bar series.
%
% The optional input handle @var{h} allows an axis handle to be passed.
% Properties of the patch graphics object can be changed using
% @var{prop}, @var{val} pairs.
%
% @seealso{barh, plot} 
% @end deftypefn

CROSS-REFERENCE INFORMATION ^

This function calls: This function is called by:
Generated on Sat 16-May-2009 00:04:49 by m2html © 2003