Mercurial > hg > octave-lyh

annotate scripts/plot/zlabel.m @ 17487:f0f4b524b6d0

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
maint: Correct indentation for several plot routines. * scripts/plot/ellipsoid.m, scripts/plot/rose.m, scripts/plot/sphere.m, scripts/plot/surfnorm.m: maint: Correct indentation for several plot routines.
author Rik <rik@octave.org>
date Wed, 25 Sep 2013 07:48:58 -0700
parents b81b9d079515
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
14138
72c96de7a403 maint: update copyright notices for 2012
John W. Eaton <jwe@octave.org>
parents: 14001
diff changeset
1 ## Copyright (C) 1995-2012 John W. Eaton
2313
5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe]
jwe
parents: 2312
diff changeset
2 ##
5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe]
jwe
parents: 2312
diff changeset
3 ## This file is part of Octave.
5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe]
jwe
parents: 2312
diff changeset
4 ##
5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe]
jwe
parents: 2312
diff changeset
5 ## Octave is free software; you can redistribute it and/or modify it
5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe]
jwe
parents: 2312
diff changeset
6 ## under the terms of the GNU General Public License as published by
7016
93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe]
jwe
parents: 6412
diff changeset
7 ## the Free Software Foundation; either version 3 of the License, or (at
93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe]
jwe
parents: 6412
diff changeset
8 ## your option) any later version.
2313
5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe]
jwe
parents: 2312
diff changeset
9 ##
5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe]
jwe
parents: 2312
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: 2312
diff changeset
11 ## WITHOUT ANY WARRANTY; without even the implied warranty of
5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe]
jwe
parents: 2312
diff changeset
12 ## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe]
jwe
parents: 2312
diff changeset
13 ## General Public License for more details.
5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe]
jwe
parents: 2312
diff changeset
14 ##
5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe]
jwe
parents: 2312
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: 6412
diff changeset
16 ## along with Octave; see the file COPYING. If not, see
93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe]
jwe
parents: 6412
diff changeset
17 ## <http://www.gnu.org/licenses/>.
1540
749b8b19733f [project @ 1995-10-06 03:10:34 by jwe]
jwe
parents:
diff changeset
18
3458
d25bc039237b [project @ 2000-01-19 09:36:14 by jwe]
jwe
parents: 3446
diff changeset
19 ## -*- texinfo -*-
10793
be55736a0783 Grammarcheck the documentation from m-files.
Rik <octave@nomad.inbox5.com>
parents: 8920
diff changeset
20 ## @deftypefn {Function File} {} zlabel (@var{string})
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
21 ## @deftypefnx {Function File} {} zlabel (@var{string}, @var{property}, @var{val}, @dots{})
17126
eaab03308c0b doc: Rewrite docstrings for most plot functions.
Rik <rik@octave.org>
parents: 17048
diff changeset
22 ## @deftypefnx {Function File} {} zlabel (@var{hax}, @dots{})
11315
c715816f4539 Add additional calling form to docstring for [xyz]label functions.
Rik <octave@nomad.inbox5.com>
parents: 11152
diff changeset
23 ## @deftypefnx {Function File} {@var{h} =} zlabel (@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 z-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 ##
17126
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
eaab03308c0b doc: Rewrite docstrings for most plot functions.
Rik <rik@octave.org>
parents: 17048
diff changeset
30 ## this axis rather than the current axes returned by @code{gca}.
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.
17126
eaab03308c0b doc: Rewrite docstrings for most plot functions.
Rik <rik@octave.org>
parents: 17048
diff changeset
34 ## @seealso{xlabel, ylabel, datetick, title, text}
3458
d25bc039237b [project @ 2000-01-19 09:36:14 by jwe]
jwe
parents: 3446
diff changeset
35 ## @end deftypefn
6257
44c91c5dfe1d [project @ 2007-01-30 19:16:52 by jwe]
jwe
parents: 5775
diff changeset
36 ## Author: jwe
1540
749b8b19733f [project @ 1995-10-06 03:10:34 by jwe]
jwe
parents:
diff changeset
37
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
38 function h = zlabel (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
39
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
40 [hax, varargin, nargin] = __plt_get_axis_arg__ ("zlabel", varargin{:});
4529
78954aeaf321 [project @ 2003-10-04 19:35:36 by jwe]
jwe
parents: 3979
diff changeset
41
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
42 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
43 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
44 endif
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
45
7215
dd88d61d443f [project @ 2007-11-29 16:44:45 by jwe]
jwe
parents: 7208
diff changeset
46 if (rem (nargin, 2) != 1)
dd88d61d443f [project @ 2007-11-29 16:44:45 by jwe]
jwe
parents: 7208
diff changeset
47 print_usage ();
7194
a927a2871a93 [project @ 2007-11-26 23:06:12 by jwe]
jwe
parents: 7017
diff changeset
48 endif
a927a2871a93 [project @ 2007-11-26 23:06:12 by jwe]
jwe
parents: 7017
diff changeset
49
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
50 htmp = __axis_label__ (hax, "zlabel", varargin{1},
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
51 "color", get (hax, "zcolor"), 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
1540
749b8b19733f [project @ 1995-10-06 03:10:34 by jwe]
jwe
parents:
diff changeset
56
749b8b19733f [project @ 1995-10-06 03:10:34 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
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
63 %! z = zlabel ("zlabel_string", "color", "r");
14001
5f0bb45e615c doc: Update documentation for functions returning a graphics handle h (Bug #34761)
Rik <octave@nomad.inbox5.com>
parents: 13800
diff changeset
64 %! assert (get (gca, "zlabel"), z);
5f0bb45e615c doc: Update documentation for functions returning a graphics handle h (Bug #34761)
Rik <octave@nomad.inbox5.com>
parents: 13800
diff changeset
65 %! assert (get (z, "type"), "text");
5f0bb45e615c doc: Update documentation for functions returning a graphics handle h (Bug #34761)
Rik <octave@nomad.inbox5.com>
parents: 13800
diff changeset
66 %! assert (get (z, "visible"), "off");
5f0bb45e615c doc: Update documentation for functions returning a graphics handle h (Bug #34761)
Rik <octave@nomad.inbox5.com>
parents: 13800
diff changeset
67 %! assert (get (z, "string"), "zlabel_string");
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
68 %! assert (get (z, "color"), [1 0 0]);
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
79b9a7669bb8 Tests added for scripts/plot
Kai Habel <kai.habel@gmx.de>
parents: 11598
diff changeset
72
79b9a7669bb8 Tests added for scripts/plot
Kai Habel <kai.habel@gmx.de>
parents: 11598
diff changeset
73 %!test
79b9a7669bb8 Tests added for scripts/plot
Kai Habel <kai.habel@gmx.de>
parents: 11598
diff changeset
74 %! hf = figure ("visible", "off");
17129
b5d6314314fc Change various plot functions to take advantage of new isaxes() function.
Rik <rik@octave.org>
parents: 17126
diff changeset
75 %! plot3 (0, 0, 0);
13141
e81ddf9cacd5 maint: untabify and remove trailing whitespace from source files
John W. Eaton <jwe@octave.org>
parents: 13136
diff changeset
76 %! unwind_protect
13136
79b9a7669bb8 Tests added for scripts/plot
Kai Habel <kai.habel@gmx.de>
parents: 11598
diff changeset
77 %! z = zlabel ("zlabel_string");
14001
5f0bb45e615c doc: Update documentation for functions returning a graphics handle h (Bug #34761)
Rik <octave@nomad.inbox5.com>
parents: 13800
diff changeset
78 %! assert (get (gca, "zlabel"), z);
5f0bb45e615c doc: Update documentation for functions returning a graphics handle h (Bug #34761)
Rik <octave@nomad.inbox5.com>
parents: 13800
diff changeset
79 %! assert (get (z, "type"), "text");
5f0bb45e615c doc: Update documentation for functions returning a graphics handle h (Bug #34761)
Rik <octave@nomad.inbox5.com>
parents: 13800
diff changeset
80 %! assert (get (z, "string"), "zlabel_string");
13136
79b9a7669bb8 Tests added for scripts/plot
Kai Habel <kai.habel@gmx.de>
parents: 11598
diff changeset
81 %! unwind_protect_cleanup
79b9a7669bb8 Tests added for scripts/plot
Kai Habel <kai.habel@gmx.de>
parents: 11598
diff changeset
82 %! close (hf);
79b9a7669bb8 Tests added for scripts/plot
Kai Habel <kai.habel@gmx.de>
parents: 11598
diff changeset
83 %! 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
84