Mercurial > octave-nkf
annotate scripts/plot/xlabel.m @ 13800:5acb5c25e4ae
allow axes handle to be passed to title function
* __axis_label__.m: Accept axes handle argument. Don't call gca.
* xlabel.m, ylabel.m, zlabel.m: Pass axes handle to __axis_label__
instead of calling axes to temporaritly set currentaxes. Eliminate
unneeded unwind_protect block.
* title.m: Accept axes handle. Pass axes handle to __axis_label__.
| author | John W. Eaton <jwe@octave.org> |
|---|---|
| date | Thu, 03 Nov 2011 04:41:40 -0400 |
| parents | e81ddf9cacd5 |
| children | 5f0bb45e615c |
| rev | line source |
|---|---|
| 11523 | 1 ## Copyright (C) 1993-2011 John W. Eaton |
| 2313 | 2 ## |
| 3 ## This file is part of Octave. | |
| 4 ## | |
| 5 ## Octave is free software; you can redistribute it and/or modify it | |
| 6 ## under the terms of the GNU General Public License as published by | |
| 7016 | 7 ## the Free Software Foundation; either version 3 of the License, or (at |
| 8 ## your option) any later version. | |
| 2313 | 9 ## |
| 10 ## Octave is distributed in the hope that it will be useful, but | |
| 11 ## WITHOUT ANY WARRANTY; without even the implied warranty of | |
| 12 ## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU | |
| 13 ## General Public License for more details. | |
| 14 ## | |
| 15 ## You should have received a copy of the GNU General Public License | |
| 7016 | 16 ## along with Octave; see the file COPYING. If not, see |
| 17 ## <http://www.gnu.org/licenses/>. | |
| 245 | 18 |
| 3368 | 19 ## -*- texinfo -*- |
|
10793
be55736a0783
Grammarcheck the documentation from m-files.
Rik <octave@nomad.inbox5.com>
parents:
9758
diff
changeset
|
20 ## @deftypefn {Function File} {} xlabel (@var{string}) |
| 7194 | 21 ## @deftypefnx {Function File} {} xlabel (@var{h}, @var{string}) |
|
11315
c715816f4539
Add additional calling form to docstring for [xyz]label functions.
Rik <octave@nomad.inbox5.com>
parents:
10793
diff
changeset
|
22 ## @deftypefnx {Function File} {@var{h} =} xlabel (@dots{}) |
|
c715816f4539
Add additional calling form to docstring for [xyz]label functions.
Rik <octave@nomad.inbox5.com>
parents:
10793
diff
changeset
|
23 ## @deftypefnx {Function File} {} ylabel (@dots{}) |
|
c715816f4539
Add additional calling form to docstring for [xyz]label functions.
Rik <octave@nomad.inbox5.com>
parents:
10793
diff
changeset
|
24 ## @deftypefnx {Function File} {} zlabel (@dots{}) |
|
c715816f4539
Add additional calling form to docstring for [xyz]label functions.
Rik <octave@nomad.inbox5.com>
parents:
10793
diff
changeset
|
25 ## Specify x-, y-, or z-axis labels for the current axis. If @var{h} is |
|
c715816f4539
Add additional calling form to docstring for [xyz]label functions.
Rik <octave@nomad.inbox5.com>
parents:
10793
diff
changeset
|
26 ## specified then label the axis defined by @var{h}. The optional return |
|
c715816f4539
Add additional calling form to docstring for [xyz]label functions.
Rik <octave@nomad.inbox5.com>
parents:
10793
diff
changeset
|
27 ## value @var{h} provides a handle to the created label. |
| 5642 | 28 ## @seealso{plot, semilogx, semilogy, loglog, polar, mesh, contour, |
|
8286
6f2d95255911
fix @seealso references to point to existing anchors
Thorsten Meyer <thorsten.meyier@gmx.de>
parents:
7425
diff
changeset
|
29 ## bar, stairs, title} |
| 3368 | 30 ## @end deftypefn |
| 4 | 31 |
| 2314 | 32 ## Author: jwe |
| 33 | |
| 7215 | 34 function retval = xlabel (varargin) |
| 4529 | 35 |
| 7215 | 36 [h, varargin, nargin] = __plt_get_axis_arg__ ("xlabel", varargin{:}); |
| 37 | |
| 38 if (rem (nargin, 2) != 1) | |
| 39 print_usage (); | |
| 7194 | 40 endif |
| 41 | |
|
13800
5acb5c25e4ae
allow axes handle to be passed to title function
John W. Eaton <jwe@octave.org>
parents:
13141
diff
changeset
|
42 tmp = __axis_label__ (h, "xlabel", varargin{:}, |
|
5acb5c25e4ae
allow axes handle to be passed to title function
John W. Eaton <jwe@octave.org>
parents:
13141
diff
changeset
|
43 "color", get (h, "xcolor")); |
| 7215 | 44 |
| 7194 | 45 if (nargout > 0) |
| 7425 | 46 retval = tmp; |
| 4529 | 47 endif |
| 4 | 48 |
| 49 endfunction | |
|
13136
79b9a7669bb8
Tests added for scripts/plot
Kai Habel <kai.habel@gmx.de>
parents:
11598
diff
changeset
|
50 |
|
79b9a7669bb8
Tests added for scripts/plot
Kai Habel <kai.habel@gmx.de>
parents:
11598
diff
changeset
|
51 %!test |
|
79b9a7669bb8
Tests added for scripts/plot
Kai Habel <kai.habel@gmx.de>
parents:
11598
diff
changeset
|
52 %! 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
|
53 %! unwind_protect |
|
13136
79b9a7669bb8
Tests added for scripts/plot
Kai Habel <kai.habel@gmx.de>
parents:
11598
diff
changeset
|
54 %! x = xlabel ("xlabel_string"); |
|
79b9a7669bb8
Tests added for scripts/plot
Kai Habel <kai.habel@gmx.de>
parents:
11598
diff
changeset
|
55 %! assert (get(gca, "xlabel"), x); |
|
79b9a7669bb8
Tests added for scripts/plot
Kai Habel <kai.habel@gmx.de>
parents:
11598
diff
changeset
|
56 %! assert (get(x, "type"), "text"); |
|
79b9a7669bb8
Tests added for scripts/plot
Kai Habel <kai.habel@gmx.de>
parents:
11598
diff
changeset
|
57 %! assert (get(x, "visible"), "on"); |
|
79b9a7669bb8
Tests added for scripts/plot
Kai Habel <kai.habel@gmx.de>
parents:
11598
diff
changeset
|
58 %! assert (get(x, "string"), "xlabel_string"); |
|
79b9a7669bb8
Tests added for scripts/plot
Kai Habel <kai.habel@gmx.de>
parents:
11598
diff
changeset
|
59 %! unwind_protect_cleanup |
|
79b9a7669bb8
Tests added for scripts/plot
Kai Habel <kai.habel@gmx.de>
parents:
11598
diff
changeset
|
60 %! close (hf); |
|
79b9a7669bb8
Tests added for scripts/plot
Kai Habel <kai.habel@gmx.de>
parents:
11598
diff
changeset
|
61 %! end_unwind_protect |