Mercurial > octave-nkf

annotate scripts/plot/box.m @ 17049:0322e057697f

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
hold.m, grid.m, box.m: Update to use new __plt_get_axis_arg__. * scripts/plot/box.m: Update to use new __plt_get_axis_arg__. Use hax instead of ax. Redo docstring. * scripts/plot/grid.m: Update to use new __plt_get_axis_arg__. Use hax instead of ax. Redo docstring. Move input validation to front of function. * scripts/plot/hold.m: Update to use new __plt_get_axis_arg__. Use hax instead of ax. Redo docstring. Add 2 new %!demos.
author Pantxo Diribarne <pantxo.diribarne@gmail.com>
date Tue, 23 Jul 2013 15:10:57 +0200
parents 310039bc3dd3
children eaab03308c0b
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: 11523
diff changeset
1 ## Copyright (C) 2006-2012 John W. Eaton
6052
89d3cd848ca3 [project @ 2006-10-13 20:50:08 by jwe]
jwe
parents:
diff changeset
2 ##
89d3cd848ca3 [project @ 2006-10-13 20:50:08 by jwe]
jwe
parents:
diff changeset
3 ## This file is part of Octave.
89d3cd848ca3 [project @ 2006-10-13 20:50:08 by jwe]
jwe
parents:
diff changeset
4 ##
89d3cd848ca3 [project @ 2006-10-13 20:50:08 by jwe]
jwe
parents:
diff changeset
5 ## Octave is free software; you can redistribute it and/or modify it
89d3cd848ca3 [project @ 2006-10-13 20:50:08 by jwe]
jwe
parents:
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: 6849
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: 6849
diff changeset
8 ## your option) any later version.
6052
89d3cd848ca3 [project @ 2006-10-13 20:50:08 by jwe]
jwe
parents:
diff changeset
9 ##
89d3cd848ca3 [project @ 2006-10-13 20:50:08 by jwe]
jwe
parents:
diff changeset
10 ## Octave is distributed in the hope that it will be useful, but
89d3cd848ca3 [project @ 2006-10-13 20:50:08 by jwe]
jwe
parents:
diff changeset
11 ## WITHOUT ANY WARRANTY; without even the implied warranty of
89d3cd848ca3 [project @ 2006-10-13 20:50:08 by jwe]
jwe
parents:
diff changeset
12 ## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
89d3cd848ca3 [project @ 2006-10-13 20:50:08 by jwe]
jwe
parents:
diff changeset
13 ## General Public License for more details.
89d3cd848ca3 [project @ 2006-10-13 20:50:08 by jwe]
jwe
parents:
diff changeset
14 ##
89d3cd848ca3 [project @ 2006-10-13 20:50:08 by jwe]
jwe
parents:
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: 6849
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: 6849
diff changeset
17 ## <http://www.gnu.org/licenses/>.
6052
89d3cd848ca3 [project @ 2006-10-13 20:50:08 by jwe]
jwe
parents:
diff changeset
18
89d3cd848ca3 [project @ 2006-10-13 20:50:08 by jwe]
jwe
parents:
diff changeset
19 ## -*- texinfo -*-
17049
0322e057697f hold.m, grid.m, box.m: Update to use new __plt_get_axis_arg__.
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents: 14385
diff changeset
20 ## @deftypefn {Function File} {} box on
0322e057697f hold.m, grid.m, box.m: Update to use new __plt_get_axis_arg__.
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents: 14385
diff changeset
21 ## @deftypefnx {Function File} {} box off
0322e057697f hold.m, grid.m, box.m: Update to use new __plt_get_axis_arg__.
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents: 14385
diff changeset
22 ## @deftypefnx {Function File} {} box
14385
310039bc3dd3 box.m: Allow specification of a graphics axis to act on (bug #35486).
Garrett G Euler <ggeuler@gmail.com>
parents: 14138
diff changeset
23 ## @deftypefnx {Function File} {} box (@var{hax}, @dots{})
17049
0322e057697f hold.m, grid.m, box.m: Update to use new __plt_get_axis_arg__.
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents: 14385
diff changeset
24 ## Control the display of a border around the current axis.
0322e057697f hold.m, grid.m, box.m: Update to use new __plt_get_axis_arg__.
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents: 14385
diff changeset
25 ##
6052
89d3cd848ca3 [project @ 2006-10-13 20:50:08 by jwe]
jwe
parents:
diff changeset
26 ## The argument may be either @code{"on"} or @code{"off"}. If it is
6653
673686daec87 [project @ 2007-05-22 15:36:09 by jwe]
jwe
parents: 6567
diff changeset
27 ## omitted, the current box state is toggled.
14385
310039bc3dd3 box.m: Allow specification of a graphics axis to act on (bug #35486).
Garrett G Euler <ggeuler@gmail.com>
parents: 14138
diff changeset
28 ##
310039bc3dd3 box.m: Allow specification of a graphics axis to act on (bug #35486).
Garrett G Euler <ggeuler@gmail.com>
parents: 14138
diff changeset
29 ## If the first argument is an axis handle, @var{hax}, operate on the
310039bc3dd3 box.m: Allow specification of a graphics axis to act on (bug #35486).
Garrett G Euler <ggeuler@gmail.com>
parents: 14138
diff changeset
30 ## specified axis object.
6052
89d3cd848ca3 [project @ 2006-10-13 20:50:08 by jwe]
jwe
parents:
diff changeset
31 ## @seealso{grid}
89d3cd848ca3 [project @ 2006-10-13 20:50:08 by jwe]
jwe
parents:
diff changeset
32 ## @end deftypefn
89d3cd848ca3 [project @ 2006-10-13 20:50:08 by jwe]
jwe
parents:
diff changeset
33
89d3cd848ca3 [project @ 2006-10-13 20:50:08 by jwe]
jwe
parents:
diff changeset
34 ## Author: jwe
89d3cd848ca3 [project @ 2006-10-13 20:50:08 by jwe]
jwe
parents:
diff changeset
35
6257
44c91c5dfe1d [project @ 2007-01-30 19:16:52 by jwe]
jwe
parents: 6052
diff changeset
36 function box (varargin)
44c91c5dfe1d [project @ 2007-01-30 19:16:52 by jwe]
jwe
parents: 6052
diff changeset
37
17049
0322e057697f hold.m, grid.m, box.m: Update to use new __plt_get_axis_arg__.
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents: 14385
diff changeset
38 [hax, varargin, nargs] = __plt_get_axis_arg__ ("box", varargin{:});
6257
44c91c5dfe1d [project @ 2007-01-30 19:16:52 by jwe]
jwe
parents: 6052
diff changeset
39
17049
0322e057697f hold.m, grid.m, box.m: Update to use new __plt_get_axis_arg__.
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents: 14385
diff changeset
40 if (isempty (hax))
0322e057697f hold.m, grid.m, box.m: Update to use new __plt_get_axis_arg__.
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents: 14385
diff changeset
41 hax = gca ();
0322e057697f hold.m, grid.m, box.m: Update to use new __plt_get_axis_arg__.
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents: 14385
diff changeset
42 endif
0322e057697f hold.m, grid.m, box.m: Update to use new __plt_get_axis_arg__.
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents: 14385
diff changeset
43
6257
44c91c5dfe1d [project @ 2007-01-30 19:16:52 by jwe]
jwe
parents: 6052
diff changeset
44 if (nargs == 0)
17049
0322e057697f hold.m, grid.m, box.m: Update to use new __plt_get_axis_arg__.
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents: 14385
diff changeset
45 box_state = get (hax, "box");
14385
310039bc3dd3 box.m: Allow specification of a graphics axis to act on (bug #35486).
Garrett G Euler <ggeuler@gmail.com>
parents: 14138
diff changeset
46 if (strcmp (box_state, "on"))
6257
44c91c5dfe1d [project @ 2007-01-30 19:16:52 by jwe]
jwe
parents: 6052
diff changeset
47 box_state = "off";
44c91c5dfe1d [project @ 2007-01-30 19:16:52 by jwe]
jwe
parents: 6052
diff changeset
48 else
44c91c5dfe1d [project @ 2007-01-30 19:16:52 by jwe]
jwe
parents: 6052
diff changeset
49 box_state = "on";
44c91c5dfe1d [project @ 2007-01-30 19:16:52 by jwe]
jwe
parents: 6052
diff changeset
50 endif
44c91c5dfe1d [project @ 2007-01-30 19:16:52 by jwe]
jwe
parents: 6052
diff changeset
51 elseif (nargs == 1)
44c91c5dfe1d [project @ 2007-01-30 19:16:52 by jwe]
jwe
parents: 6052
diff changeset
52 state = varargin{1};
44c91c5dfe1d [project @ 2007-01-30 19:16:52 by jwe]
jwe
parents: 6052
diff changeset
53 if (ischar (state))
8190
73d6b71788c0 use case-insensitive comparison for graphics properties; misc style fixes
John W. Eaton <jwe@octave.org>
parents: 7017
diff changeset
54 if (strcmpi (state, "off"))
10549
95c3e38098bf Untabify .m scripts
Rik <code@nomad.inbox5.com>
parents: 8920
diff changeset
55 box_state = "off";
8190
73d6b71788c0 use case-insensitive comparison for graphics properties; misc style fixes
John W. Eaton <jwe@octave.org>
parents: 7017
diff changeset
56 elseif (strcmpi (state, "on"))
10549
95c3e38098bf Untabify .m scripts
Rik <code@nomad.inbox5.com>
parents: 8920
diff changeset
57 box_state = "on";
6257
44c91c5dfe1d [project @ 2007-01-30 19:16:52 by jwe]
jwe
parents: 6052
diff changeset
58 else
14385
310039bc3dd3 box.m: Allow specification of a graphics axis to act on (bug #35486).
Garrett G Euler <ggeuler@gmail.com>
parents: 14138
diff changeset
59 error ('box: argument must be "on" or "off"');
6257
44c91c5dfe1d [project @ 2007-01-30 19:16:52 by jwe]
jwe
parents: 6052
diff changeset
60 endif
14385
310039bc3dd3 box.m: Allow specification of a graphics axis to act on (bug #35486).
Garrett G Euler <ggeuler@gmail.com>
parents: 14138
diff changeset
61 else
310039bc3dd3 box.m: Allow specification of a graphics axis to act on (bug #35486).
Garrett G Euler <ggeuler@gmail.com>
parents: 14138
diff changeset
62 error ('box: argument must be "on" or "off"');
6257
44c91c5dfe1d [project @ 2007-01-30 19:16:52 by jwe]
jwe
parents: 6052
diff changeset
63 endif
44c91c5dfe1d [project @ 2007-01-30 19:16:52 by jwe]
jwe
parents: 6052
diff changeset
64 else
44c91c5dfe1d [project @ 2007-01-30 19:16:52 by jwe]
jwe
parents: 6052
diff changeset
65 print_usage ();
44c91c5dfe1d [project @ 2007-01-30 19:16:52 by jwe]
jwe
parents: 6052
diff changeset
66 endif
44c91c5dfe1d [project @ 2007-01-30 19:16:52 by jwe]
jwe
parents: 6052
diff changeset
67
17049
0322e057697f hold.m, grid.m, box.m: Update to use new __plt_get_axis_arg__.
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents: 14385
diff changeset
68 set (hax, "box", box_state);
6052
89d3cd848ca3 [project @ 2006-10-13 20:50:08 by jwe]
jwe
parents:
diff changeset
69
89d3cd848ca3 [project @ 2006-10-13 20:50:08 by jwe]
jwe
parents:
diff changeset
70 endfunction