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
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
|
########################################################################
##
## Copyright (C) 1993-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 {} {} title (@var{string})
## @deftypefnx {} {} title (@var{string}, @var{prop}, @var{val}, @dots{})
## @deftypefnx {} {} title (@var{hax}, @dots{})
## @deftypefnx {} {@var{h} =} title (@dots{})
## Specify the string used as a title for the current axis.
##
## An optional list of @var{property}/@var{value} pairs can be used to change
## the appearance of the created title text object.
##
## If the first argument @var{hax} is an axes or legend handle, then add a
## title to this object, 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, zlabel, text}
## @end deftypefn
function h = title (varargin)
[hax, varargin, nargin] = __plt_get_axis_arg__ ("title", varargin{:});
if (isempty (hax))
if (! isempty (varargin) && isscalar (varargin{1})
&& ishghandle (varargin{1})
&& strcmp (get (varargin{1}, "tag"), "legend"))
hax = varargin{1};
varargin(1) = [];
nargin--;
else
hax = gca ();
endif
endif
if (rem (nargin, 2) != 1)
print_usage ();
endif
htmp = __axis_label__ (hax, "title", varargin{:});
if (nargout > 0)
h = htmp;
endif
endfunction
%!demo
%! clf;
%! title ("Test Title Text");
%!demo
%! clf;
%! title ({"Multi-line"; "Title"; "Text"});
%!demo
%! clf;
%! plot3 ([0,1], [0,1], [0,1]);
%! title ("Test FontSize Property", "fontsize", 16);
%!test
%! hf = figure ("visible", "off");
%! unwind_protect
%! title ("Test Title Text");
%! h = get (gca, "title");
%! assert (get (h, "string"), "Test Title Text");
%! unwind_protect_cleanup
%! close (hf);
%! end_unwind_protect
%!test
%! hf = figure ("visible", "off");
%! unwind_protect
%! title ({"Multi-line"; "Title"; "Text"});
%! h = get (gca, "title");
%! assert (get (h, "string"), {"Multi-line"; "Title"; "Text"});
%! unwind_protect_cleanup
%! close (hf);
%! end_unwind_protect
%!test
%! hf = figure ("visible", "off");
%! unwind_protect
%! set (gca, "fontsize", 5, "titlefontsizemultiplier", 3);
%! ht = title ("title_string", "color", "r");
%! assert (get (ht, "fontsize"), 15);
%! assert (get (ht, "color"), [1 0 0]);
%! unwind_protect_cleanup
%! close (hf);
%! end_unwind_protect
%!test
%! hf = figure ("visible", "off");
%! unwind_protect
%! plot3 ([0,1], [0,1], [0,1]);
%! title ("Test FontSize Property", "fontsize", 16);
%! h = get (gca, "title");
%! assert (get (h, "string"), "Test FontSize Property");
%! assert (get (h, "fontsize"), 16);
%! unwind_protect_cleanup
%! close (hf);
%! end_unwind_protect
%!test <*49469>
%! hf = figure ("visible", "off");
%! unwind_protect
%! ht = title ("Test FontSize Property");
%! set (gca, "fontname", "Liberation Serif")
%! set (gca, "fontsize", 13)
%! assert (get (ht, "fontname"), "Liberation Serif");
%! assert (get (ht, "fontsize"), 13 * get (gca, "titlefontsizemultiplier"));
%! unwind_protect_cleanup
%! close (hf);
%! end_unwind_protect
%!test <*57372>
%! hf = figure ("visible", "off");
%! unwind_protect
%! plot (1:10);
%! hl = legend ("legend text");
%! ht = title (hl, "Legend Title");
%! assert (get (ht, "string"), "Legend Title");
%! assert (get (ht, "parent"), hl);
%! unwind_protect_cleanup
%! close (hf);
%! end_unwind_protect
|
