Mercurial > octave
view scripts/plot/appearance/xlabel.m @ 22323:bac0d6f07a3e
maint: Update copyright notices for 2016.
author | John W. Eaton <jwe@octave.org> |
---|---|
date | Wed, 17 Aug 2016 01:05:19 -0400 |
parents | 378f8c0de848 |
children | 3a2b891d0b33 e9a0469dedd9 |
line wrap: on
line source
## Copyright (C) 1993-2016 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 {} {} xlabel (@var{string}) ## @deftypefnx {} {} xlabel (@var{string}, @var{property}, @var{val}, @dots{}) ## @deftypefnx {} {} xlabel (@var{hax}, @dots{}) ## @deftypefnx {} {@var{h} =} xlabel (@dots{}) ## Specify the string used to label the x-axis of the current axis. ## ## An optional list of @var{property}/@var{value} pairs can be used to change ## the properties of the created text label. ## ## If the first argument @var{hax} is an axes handle, then operate on ## this axis rather than the current axes returned by @code{gca}. ## ## The optional return value @var{h} is a graphics handle to the created text ## object. ## @seealso{ylabel, zlabel, datetick, title, text} ## @end deftypefn ## Author: jwe function h = xlabel (varargin) [hax, varargin, nargin] = __plt_get_axis_arg__ ("xlabel", varargin{:}); if (isempty (hax)) hax = gca (); endif if (rem (nargin, 2) != 1) print_usage (); endif htmp = __axis_label__ (hax, "xlabel", varargin{1}, "color", get (hax, "xcolor"), varargin{2:end}); if (nargout > 0) h = htmp; endif endfunction %!test %! hf = figure ("visible", "off"); %! unwind_protect %! hx = xlabel ("xlabel_string"); %! assert (get (gca, "xlabel"), hx); %! assert (get (hx, "type"), "text"); %! assert (get (hx, "visible"), "on"); %! assert (get (hx, "string"), "xlabel_string"); %! assert (get (hx, "color"), get (0, "defaultaxesxcolor")); %! unwind_protect_cleanup %! close (hf); %! end_unwind_protect %!test %! hf = figure ("visible", "off"); %! unwind_protect %! set (gca, "fontsize", 5, "labelfontsizemultiplier", 3); %! hx = xlabel ("xlabel_string", "color", "r"); %! assert (get (hx, "fontsize"), 15); %! assert (get (hx, "color"), [1 0 0]); %! unwind_protect_cleanup %! close (hf); %! end_unwind_protect