annotate scripts/plot/appearance/xlabel.m @ 27898:4d6d21839dfd

remove Author: jwe and Adapted-by: jwe lines from source files These lines have little meaning now in the age of modern version control systems. Files affected: url-transfer.cc, url-transfer.h, acot.m, acoth.m, acsc.m, acsch.m, asec.m, asech.m, cot.m, coth.m, csc.m, csch.m, sec.m, sech.m, cart2pol.m, cart2sph.m, deal.m, fliplr.m, flipud.m, int2str.m, logspace.m, num2str.m, pol2cart.m, rot90.m, sortrows.m, sph2cart.m, waitbar.m, doc.m, hsv2rgb.m, rgb2hsv.m, beep.m, isstr.m, setstr.m, strmatch.m, cond.m, rank.m, trace.m, bug_report.m, cast.m, delete.m, dir.m, list_primes.m, ls.m, ls_command.m, menu.m, pack.m, recycle.m, substruct.m, version.m, glpk.m, axis.m, box.m, grid.m, __axis_label__.m, text.m, title.m, view.m, xlabel.m, ylabel.m, zlabel.m, bar.m, barh.m, comet3.m, hist.m, line.m, loglog.m, mesh.m, patch.m, plot.m, polar.m, __bar__.m, __line__.m, __plt__.m, __stem__.m, semilogx.m, semilogy.m, sombrero.m, stairs.m, stem.m, surface.m, __default_plot_options__.m, __gnuplot_drawnow__.m, __next_line_color__.m, __plt_get_axis_arg__.m, __pltopt__.m, clf.m, closereq.m, gca.m, gnuplot_binary.in.m, isfigure.m, meshgrid.m, __gnuplot_draw_axes__.m, __gnuplot_draw_figure__.m, shg.m, addpref.m, getpref.m, ispref.m, loadprefs.m, prefsfile.m, saveprefs.m, rmpref.m, setpref.m, ismember.m, setdiff.m, union.m, hankel.m, hilb.m, vander.m, median.m, std.m, cstrcat.m, isletter.m, str2num.m, strcat.m, oruntests.m, rundemos.m, asctime.m, clock.m, ctime.m, date.m, etime.m, is_leap_year.m.
author John W. Eaton <jwe@octave.org>
date Thu, 02 Jan 2020 15:43:01 -0500
parents 00f796120a6d
children b442ec6dda5c
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
26376
00f796120a6d maint: Update copyright dates in all source files.
John W. Eaton <jwe@octave.org>
parents: 25054
diff changeset
1 ## Copyright (C) 1993-2019 John W. Eaton
2313
5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe]
jwe
parents: 2311
diff changeset
2 ##
5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe]
jwe
parents: 2311
diff changeset
3 ## This file is part of Octave.
5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe]
jwe
parents: 2311
diff changeset
4 ##
24534
194eb4bd202b maint: Update punctuation for GPL v3 license text.
Rik <rik@octave.org>
parents: 24432
diff changeset
5 ## Octave is free software: you can redistribute it and/or modify it
2313
5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe]
jwe
parents: 2311
diff changeset
6 ## under the terms of the GNU General Public License as published by
24534
194eb4bd202b maint: Update punctuation for GPL v3 license text.
Rik <rik@octave.org>
parents: 24432
diff changeset
7 ## the Free Software Foundation, either version 3 of the License, or
22755
3a2b891d0b33 maint: Standardize Copyright formatting.
Rik <rik@octave.org>
parents: 22323
diff changeset
8 ## (at your option) any later version.
2313
5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe]
jwe
parents: 2311
diff changeset
9 ##
5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe]
jwe
parents: 2311
diff changeset
10 ## Octave is distributed in the hope that it will be useful, but
5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe]
jwe
parents: 2311
diff changeset
11 ## WITHOUT ANY WARRANTY; without even the implied warranty of
22755
3a2b891d0b33 maint: Standardize Copyright formatting.
Rik <rik@octave.org>
parents: 22323
diff changeset
12 ## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
3a2b891d0b33 maint: Standardize Copyright formatting.
Rik <rik@octave.org>
parents: 22323
diff changeset
13 ## GNU General Public License for more details.
2313
5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe]
jwe
parents: 2311
diff changeset
14 ##
5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe]
jwe
parents: 2311
diff changeset
15 ## You should have received a copy of the GNU General Public License
7016
93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe]
jwe
parents: 6895
diff changeset
16 ## along with Octave; see the file COPYING. If not, see
24534
194eb4bd202b maint: Update punctuation for GPL v3 license text.
Rik <rik@octave.org>
parents: 24432
diff changeset
17 ## <https://www.gnu.org/licenses/>.
245
16a24e76d6e0 [project @ 1993-12-03 02:00:15 by jwe]
jwe
parents: 4
diff changeset
18
3368
a4cd1e9d9962 [project @ 1999-11-20 17:22:48 by jwe]
jwe
parents: 2847
diff changeset
19 ## -*- texinfo -*-
20852
516bb87ea72e 2015 Code Sprint: remove class of function from docstring for all m-files.
Rik <rik@octave.org>
parents: 19697
diff changeset
20 ## @deftypefn {} {} xlabel (@var{string})
516bb87ea72e 2015 Code Sprint: remove class of function from docstring for all m-files.
Rik <rik@octave.org>
parents: 19697
diff changeset
21 ## @deftypefnx {} {} xlabel (@var{string}, @var{property}, @var{val}, @dots{})
516bb87ea72e 2015 Code Sprint: remove class of function from docstring for all m-files.
Rik <rik@octave.org>
parents: 19697
diff changeset
22 ## @deftypefnx {} {} xlabel (@var{hax}, @dots{})
516bb87ea72e 2015 Code Sprint: remove class of function from docstring for all m-files.
Rik <rik@octave.org>
parents: 19697
diff changeset
23 ## @deftypefnx {} {@var{h} =} xlabel (@dots{})
17048
3f99d7d22bd0 x(yz)label.m, title.m: Update to use new __plt_get_axis_arg__.
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents: 14138
diff changeset
24 ## Specify the string used to label the x-axis of the current axis.
3f99d7d22bd0 x(yz)label.m, title.m: Update to use new __plt_get_axis_arg__.
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents: 14138
diff changeset
25 ##
3f99d7d22bd0 x(yz)label.m, title.m: Update to use new __plt_get_axis_arg__.
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents: 14138
diff changeset
26 ## An optional list of @var{property}/@var{value} pairs can be used to change
3f99d7d22bd0 x(yz)label.m, title.m: Update to use new __plt_get_axis_arg__.
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents: 14138
diff changeset
27 ## the properties of the created text label.
3f99d7d22bd0 x(yz)label.m, title.m: Update to use new __plt_get_axis_arg__.
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents: 14138
diff changeset
28 ##
17122
eaab03308c0b doc: Rewrite docstrings for most plot functions.
Rik <rik@octave.org>
parents: 17048
diff changeset
29 ## If the first argument @var{hax} is an axes handle, then operate on
24431
0c6cedafc71e doc: Use 'axes' rather than 'axis' appropriately in docstrings.
Rik <rik@octave.org>
parents: 23219
diff changeset
30 ## this axes rather than the current axes returned by @code{gca}.
17122
eaab03308c0b doc: Rewrite docstrings for most plot functions.
Rik <rik@octave.org>
parents: 17048
diff changeset
31 ##
17048
3f99d7d22bd0 x(yz)label.m, title.m: Update to use new __plt_get_axis_arg__.
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents: 14138
diff changeset
32 ## The optional return value @var{h} is a graphics handle to the created text
3f99d7d22bd0 x(yz)label.m, title.m: Update to use new __plt_get_axis_arg__.
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents: 14138
diff changeset
33 ## object.
17122
eaab03308c0b doc: Rewrite docstrings for most plot functions.
Rik <rik@octave.org>
parents: 17048
diff changeset
34 ## @seealso{ylabel, zlabel, datetick, title, text}
3368
a4cd1e9d9962 [project @ 1999-11-20 17:22:48 by jwe]
jwe
parents: 2847
diff changeset
35 ## @end deftypefn
4
b4df021f796c [project @ 1993-08-08 01:26:08 by jwe]
jwe
parents:
diff changeset
36
17048
3f99d7d22bd0 x(yz)label.m, title.m: Update to use new __plt_get_axis_arg__.
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents: 14138
diff changeset
37 function h = xlabel (varargin)
3f99d7d22bd0 x(yz)label.m, title.m: Update to use new __plt_get_axis_arg__.
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents: 14138
diff changeset
38
3f99d7d22bd0 x(yz)label.m, title.m: Update to use new __plt_get_axis_arg__.
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents: 14138
diff changeset
39 [hax, varargin, nargin] = __plt_get_axis_arg__ ("xlabel", varargin{:});
4529
78954aeaf321 [project @ 2003-10-04 19:35:36 by jwe]
jwe
parents: 3979
diff changeset
40
17048
3f99d7d22bd0 x(yz)label.m, title.m: Update to use new __plt_get_axis_arg__.
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents: 14138
diff changeset
41 if (isempty (hax))
3f99d7d22bd0 x(yz)label.m, title.m: Update to use new __plt_get_axis_arg__.
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents: 14138
diff changeset
42 hax = gca ();
3f99d7d22bd0 x(yz)label.m, title.m: Update to use new __plt_get_axis_arg__.
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents: 14138
diff changeset
43 endif
19593
446c46af4b42 strip trailing whitespace from most source files
John W. Eaton <jwe@octave.org>
parents: 17744
diff changeset
44
7215
dd88d61d443f [project @ 2007-11-29 16:44:45 by jwe]
jwe
parents: 7208
diff changeset
45 if (rem (nargin, 2) != 1)
dd88d61d443f [project @ 2007-11-29 16:44:45 by jwe]
jwe
parents: 7208
diff changeset
46 print_usage ();
7194
a927a2871a93 [project @ 2007-11-26 23:06:12 by jwe]
jwe
parents: 7017
diff changeset
47 endif
a927a2871a93 [project @ 2007-11-26 23:06:12 by jwe]
jwe
parents: 7017
diff changeset
48
17048
3f99d7d22bd0 x(yz)label.m, title.m: Update to use new __plt_get_axis_arg__.
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents: 14138
diff changeset
49 htmp = __axis_label__ (hax, "xlabel", varargin{1},
22292
378f8c0de848 Implement TitleFontSizeMultiplier, LabelFontSizeMultiplier, TitleFontWeight props.
Rik <rik@octave.org>
parents: 20852
diff changeset
50 "color", get (hax, "xcolor"),
378f8c0de848 Implement TitleFontSizeMultiplier, LabelFontSizeMultiplier, TitleFontWeight props.
Rik <rik@octave.org>
parents: 20852
diff changeset
51 varargin{2:end});
7215
dd88d61d443f [project @ 2007-11-29 16:44:45 by jwe]
jwe
parents: 7208
diff changeset
52
7194
a927a2871a93 [project @ 2007-11-26 23:06:12 by jwe]
jwe
parents: 7017
diff changeset
53 if (nargout > 0)
17048
3f99d7d22bd0 x(yz)label.m, title.m: Update to use new __plt_get_axis_arg__.
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents: 14138
diff changeset
54 h = htmp;
4529
78954aeaf321 [project @ 2003-10-04 19:35:36 by jwe]
jwe
parents: 3979
diff changeset
55 endif
4
b4df021f796c [project @ 1993-08-08 01:26:08 by jwe]
jwe
parents:
diff changeset
56
b4df021f796c [project @ 1993-08-08 01:26:08 by jwe]
jwe
parents:
diff changeset
57 endfunction
13136
79b9a7669bb8 Tests added for scripts/plot
Kai Habel <kai.habel@gmx.de>
parents: 11598
diff changeset
58
14001
5f0bb45e615c doc: Update documentation for functions returning a graphics handle h (Bug #34761)
Rik <octave@nomad.inbox5.com>
parents: 13800
diff changeset
59
13136
79b9a7669bb8 Tests added for scripts/plot
Kai Habel <kai.habel@gmx.de>
parents: 11598
diff changeset
60 %!test
79b9a7669bb8 Tests added for scripts/plot
Kai Habel <kai.habel@gmx.de>
parents: 11598
diff changeset
61 %! hf = figure ("visible", "off");
13141
e81ddf9cacd5 maint: untabify and remove trailing whitespace from source files
John W. Eaton <jwe@octave.org>
parents: 13136
diff changeset
62 %! unwind_protect
22292
378f8c0de848 Implement TitleFontSizeMultiplier, LabelFontSizeMultiplier, TitleFontWeight props.
Rik <rik@octave.org>
parents: 20852
diff changeset
63 %! hx = xlabel ("xlabel_string");
378f8c0de848 Implement TitleFontSizeMultiplier, LabelFontSizeMultiplier, TitleFontWeight props.
Rik <rik@octave.org>
parents: 20852
diff changeset
64 %! assert (get (gca, "xlabel"), hx);
378f8c0de848 Implement TitleFontSizeMultiplier, LabelFontSizeMultiplier, TitleFontWeight props.
Rik <rik@octave.org>
parents: 20852
diff changeset
65 %! assert (get (hx, "type"), "text");
378f8c0de848 Implement TitleFontSizeMultiplier, LabelFontSizeMultiplier, TitleFontWeight props.
Rik <rik@octave.org>
parents: 20852
diff changeset
66 %! assert (get (hx, "visible"), "on");
378f8c0de848 Implement TitleFontSizeMultiplier, LabelFontSizeMultiplier, TitleFontWeight props.
Rik <rik@octave.org>
parents: 20852
diff changeset
67 %! assert (get (hx, "string"), "xlabel_string");
378f8c0de848 Implement TitleFontSizeMultiplier, LabelFontSizeMultiplier, TitleFontWeight props.
Rik <rik@octave.org>
parents: 20852
diff changeset
68 %! assert (get (hx, "color"), get (0, "defaultaxesxcolor"));
13136
79b9a7669bb8 Tests added for scripts/plot
Kai Habel <kai.habel@gmx.de>
parents: 11598
diff changeset
69 %! unwind_protect_cleanup
79b9a7669bb8 Tests added for scripts/plot
Kai Habel <kai.habel@gmx.de>
parents: 11598
diff changeset
70 %! close (hf);
79b9a7669bb8 Tests added for scripts/plot
Kai Habel <kai.habel@gmx.de>
parents: 11598
diff changeset
71 %! end_unwind_protect
14001
5f0bb45e615c doc: Update documentation for functions returning a graphics handle h (Bug #34761)
Rik <octave@nomad.inbox5.com>
parents: 13800
diff changeset
72
22292
378f8c0de848 Implement TitleFontSizeMultiplier, LabelFontSizeMultiplier, TitleFontWeight props.
Rik <rik@octave.org>
parents: 20852
diff changeset
73 %!test
378f8c0de848 Implement TitleFontSizeMultiplier, LabelFontSizeMultiplier, TitleFontWeight props.
Rik <rik@octave.org>
parents: 20852
diff changeset
74 %! hf = figure ("visible", "off");
378f8c0de848 Implement TitleFontSizeMultiplier, LabelFontSizeMultiplier, TitleFontWeight props.
Rik <rik@octave.org>
parents: 20852
diff changeset
75 %! unwind_protect
378f8c0de848 Implement TitleFontSizeMultiplier, LabelFontSizeMultiplier, TitleFontWeight props.
Rik <rik@octave.org>
parents: 20852
diff changeset
76 %! set (gca, "fontsize", 5, "labelfontsizemultiplier", 3);
378f8c0de848 Implement TitleFontSizeMultiplier, LabelFontSizeMultiplier, TitleFontWeight props.
Rik <rik@octave.org>
parents: 20852
diff changeset
77 %! hx = xlabel ("xlabel_string", "color", "r");
378f8c0de848 Implement TitleFontSizeMultiplier, LabelFontSizeMultiplier, TitleFontWeight props.
Rik <rik@octave.org>
parents: 20852
diff changeset
78 %! assert (get (hx, "fontsize"), 15);
378f8c0de848 Implement TitleFontSizeMultiplier, LabelFontSizeMultiplier, TitleFontWeight props.
Rik <rik@octave.org>
parents: 20852
diff changeset
79 %! assert (get (hx, "color"), [1 0 0]);
378f8c0de848 Implement TitleFontSizeMultiplier, LabelFontSizeMultiplier, TitleFontWeight props.
Rik <rik@octave.org>
parents: 20852
diff changeset
80 %! unwind_protect_cleanup
378f8c0de848 Implement TitleFontSizeMultiplier, LabelFontSizeMultiplier, TitleFontWeight props.
Rik <rik@octave.org>
parents: 20852
diff changeset
81 %! close (hf);
378f8c0de848 Implement TitleFontSizeMultiplier, LabelFontSizeMultiplier, TitleFontWeight props.
Rik <rik@octave.org>
parents: 20852
diff changeset
82 %! end_unwind_protect