view scripts/plot/zlabel.m @ 14001:5f0bb45e615c

doc: Update documentation for functions returning a graphics handle h (Bug #34761) * voronoi.m, image.m, imagesc.m, imshow.m, area.m, bar.m, barh.m, clabel.m, clf.m, compass.m, ezcontour.m, ezcontourf.m, ezmesh.m, ezmeshc.m, ezplot.m, ezplot3.m, ezpolar.m, ezsurf.m, ezsurfc.m, feather.m, fill.m, findall.m, findobj.m, loglog.m, mesh.m, pareto.m, patch.m, pie.m, pie3.m, plot.m, polar.m, quiver.m, quiver3.m, rectangle.m, ribbon.m, rose.m, scatter.m, scatter3.m, semilogx.m, semilogy.m, slice.m, stem.m, surf.m, surface.m, text.m, title.m, trimesh.m, triplot.m, trisurf.m, xlabel.m, ylabel.m, zlabel.m: Update documentation for functions returning a graphics handle h.
author Rik <octave@nomad.inbox5.com>
date Tue, 06 Dec 2011 13:09:17 -0800
parents 5acb5c25e4ae
children 72c96de7a403
line wrap: on
line source

## Copyright (C) 1995-2011 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
## <http://www.gnu.org/licenses/>.

## -*- texinfo -*-
## @deftypefn  {Function File} {} zlabel (@var{string})
## @deftypefnx {Function File} {} zlabel (@var{h}, @var{string})
## @deftypefnx {Function File} {@var{h} =} zlabel (@dots{})
## @seealso{xlabel}
## @end deftypefn

## Author: jwe

function retval = zlabel (varargin)

  [h, varargin, nargin] = __plt_get_axis_arg__ ("zlabel", varargin{:});

  if (rem (nargin, 2) != 1)
    print_usage ();
  endif

  tmp = __axis_label__ (h, "zlabel", varargin{:},
                        "color", get (h, "zcolor"));

  if (nargout > 0)
    retval = tmp;
  endif

endfunction


%!test
%! hf = figure ("visible", "off");
%! unwind_protect
%!   z = zlabel ("zlabel_string");
%!   assert (get (gca, "zlabel"), z);
%!   assert (get (z, "type"), "text");
%!   assert (get (z, "visible"), "off");
%!   assert (get (z, "string"), "zlabel_string");
%! unwind_protect_cleanup
%!   close (hf);
%! end_unwind_protect

%!test
%! hf = figure ("visible", "off");
%! plot3 (0, 0, 0);
%! unwind_protect
%!   z = zlabel ("zlabel_string");
%!   assert (get (gca, "zlabel"), z);
%!   assert (get (z, "type"), "text");
%!   assert (get (z, "visible"), "off");
%!   assert (get (z, "string"), "zlabel_string");
%! unwind_protect_cleanup
%!   close (hf);
%! end_unwind_protect