1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
|
########################################################################
##
## Copyright (C) 1995-2024 The Octave Project Developers
##
## See the file COPYRIGHT.md in the top-level directory of this
## distribution or <https://octave.org/copyright/>.
##
## 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
## <https://www.gnu.org/licenses/>.
##
########################################################################
## -*- texinfo -*-
## @deftypefn {} {} zlabel (@var{string})
## @deftypefnx {} {} zlabel (@var{string}, @var{property}, @var{val}, @dots{})
## @deftypefnx {} {} zlabel (@var{hax}, @dots{})
## @deftypefnx {} {@var{h} =} zlabel (@dots{})
## Specify the string used to label the z-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.
##
## The full list of text object properties is documented at
## @ref{Text Properties}.
##
## If the first argument @var{hax} is an axes handle, then operate on
## this axes 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{xlabel, ylabel, datetick, title, text}
## @end deftypefn
function h = zlabel (varargin)
[hax, varargin, nargin] = __plt_get_axis_arg__ ("zlabel", varargin{:});
if (isempty (hax))
hax = gca ();
endif
if (rem (nargin, 2) != 1)
print_usage ();
endif
htmp = __axis_label__ (hax, "zlabel", varargin{1},
"color", get (hax, "zcolor"),
varargin{2:end});
if (nargout > 0)
h = htmp;
endif
endfunction
%!test
%! hf = figure ("visible", "off");
%! unwind_protect
%! view (3);
%! hz = zlabel ("zlabel_string");
%! assert (get (gca, "zlabel"), hz);
%! assert (get (hz, "type"), "text");
%! assert (get (hz, "visible"), "off");
%! assert (get (hz, "string"), "zlabel_string");
%! assert (get (hz, "color"), get (0, "defaultaxeszcolor"));
%! unwind_protect_cleanup
%! close (hf);
%! end_unwind_protect
%!test
%! hf = figure ("visible", "off");
%! unwind_protect
%! set (gca, "fontsize", 5, "labelfontsizemultiplier", 3);
%! hz = zlabel ("zlabel_string", "color", "r");
%! assert (get (hz, "fontsize"), 15);
%! assert (get (hz, "color"), [1 0 0]);
%! unwind_protect_cleanup
%! close (hf);
%! end_unwind_protect
|
