X-Git-Url: https://git.creatis.insa-lyon.fr/pubgit/?p=CreaPhase.git;a=blobdiff_plain;f=octave_packages%2Fm%2Fplot%2Fbarh.m;fp=octave_packages%2Fm%2Fplot%2Fbarh.m;h=f7f4ee9ba1dc992b9dc494dcb9b8f046eafcfc31;hp=0000000000000000000000000000000000000000;hb=1c0469ada9531828709108a4882a751d2816994a;hpb=63de9f36673d49121015e3695f2c336ea92bc278 diff --git a/octave_packages/m/plot/barh.m b/octave_packages/m/plot/barh.m new file mode 100644 index 0000000..f7f4ee9 --- /dev/null +++ b/octave_packages/m/plot/barh.m @@ -0,0 +1,58 @@ +## Copyright (C) 1996-2012 John W. Eaton +## +## This file is part of Octave. +## +## Octave is free software; you can redistribute it and/or modify it +## under the terms of the GNU General Public License as published by +## the Free Software Foundation; either version 3 of the License, or (at +## your option) any later version. +## +## Octave is distributed in the hope that it will be useful, but +## WITHOUT ANY WARRANTY; without even the implied warranty of +## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU +## General Public License for more details. +## +## You should have received a copy of the GNU General Public License +## along with Octave; see the file COPYING. If not, see +## . + +## -*- texinfo -*- +## @deftypefn {Function File} {} barh (@var{x}, @var{y}) +## @deftypefnx {Function File} {} barh (@var{y}) +## @deftypefnx {Function File} {} barh (@var{x}, @var{y}, @var{w}) +## @deftypefnx {Function File} {} barh (@var{x}, @var{y}, @var{w}, @var{style}) +## @deftypefnx {Function File} {@var{h} =} barh (@dots{}, @var{prop}, @var{val}) +## @deftypefnx {Function File} {} barh (@var{h}, @dots{}) +## Produce a horizontal 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 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. +## +## The optional return value @var{h} is a graphics handle to the created +## bar series object. See @code{bar} for a description of the use of the +## bar series. +## @seealso{bar, plot} +## @end deftypefn + +## Author: jwe + +function varargout = barh (varargin) + varargout = cell (nargout, 1); + [varargout{:}] = __bar__ (false, "barh", varargin{:}); +endfunction + + +%% FIXME: Need demo or test for function +