X-Git-Url: https://git.creatis.insa-lyon.fr/pubgit/?p=CreaPhase.git;a=blobdiff_plain;f=octave_packages%2Fm%2Fplot%2Fxlabel.m;fp=octave_packages%2Fm%2Fplot%2Fxlabel.m;h=9344e3df6602ca98e06d388a95c85cecadb8097f;hp=0000000000000000000000000000000000000000;hb=1c0469ada9531828709108a4882a751d2816994a;hpb=63de9f36673d49121015e3695f2c336ea92bc278 diff --git a/octave_packages/m/plot/xlabel.m b/octave_packages/m/plot/xlabel.m new file mode 100644 index 0000000..9344e3d --- /dev/null +++ b/octave_packages/m/plot/xlabel.m @@ -0,0 +1,63 @@ +## Copyright (C) 1993-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} {} xlabel (@var{string}) +## @deftypefnx {Function File} {} xlabel (@var{h}, @var{string}) +## @deftypefnx {Function File} {@var{h} =} xlabel (@dots{}) +## @deftypefnx {Function File} {} ylabel (@dots{}) +## @deftypefnx {Function File} {} zlabel (@dots{}) +## Specify x-, y-, or z-axis labels for the current axis. If @var{h} is +## specified then label the axis defined by @var{h}. +## +## The optional return value @var{h} is a graphics handle to the created object. +## @seealso{title, text} +## @end deftypefn + +## Author: jwe + +function retval = xlabel (varargin) + + [h, varargin, nargin] = __plt_get_axis_arg__ ("xlabel", varargin{:}); + + if (rem (nargin, 2) != 1) + print_usage (); + endif + + tmp = __axis_label__ (h, "xlabel", varargin{:}, + "color", get (h, "xcolor")); + + if (nargout > 0) + retval = tmp; + endif + +endfunction + + +%!test +%! hf = figure ("visible", "off"); +%! unwind_protect +%! x = xlabel ("xlabel_string"); +%! assert (get (gca, "xlabel"), x); +%! assert (get (x, "type"), "text"); +%! assert (get (x, "visible"), "on"); +%! assert (get (x, "string"), "xlabel_string"); +%! unwind_protect_cleanup +%! close (hf); +%! end_unwind_protect +