Mercurial > hg > octave-lyh
annotate scripts/plot/box.m @ 14872:c2dbdeaa25df
maint: use rows() and columns() to clarify m-files.
* gradient.m, interp1q.m, rat.m, tsearchn.m, image.m, imwrite.m, area.m,
contourc.m, hist.m, isocolors.m, isonormals.m, meshz.m, print.m, __bar__.m,
__go_draw_axes__.m, __interp_cube__.m, __marching_cube__.m, __patch__.m,
__print_parse_opts__.m, __quiver__.m, rose.m, shrinkfaces.m, stairs.m,
surfnorm.m, tetramesh.m, text.m, deconv.m, spline.m, intersect.m, setdiff.m,
setxor.m, union.m, periodogram.m, pcg.m, perms.m: Replace size (x,1) with
rows (x) and size(x,2) with columns(x).
author | Rik <octave@nomad.inbox5.com> |
---|---|
date | Tue, 17 Jul 2012 13:34:19 -0700 |
parents | 310039bc3dd3 |
children | 0322e057697f |
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 | 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. | |
6052 | 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/>. | |
6052 | 18 |
19 ## -*- texinfo -*- | |
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
|
20 ## @deftypefn {Function File} {} box |
310039bc3dd3
box.m: Allow specification of a graphics axis to act on (bug #35486).
Garrett G Euler <ggeuler@gmail.com>
parents:
14138
diff
changeset
|
21 ## @deftypefnx {Function File} {} box ("on") |
310039bc3dd3
box.m: Allow specification of a graphics axis to act on (bug #35486).
Garrett G Euler <ggeuler@gmail.com>
parents:
14138
diff
changeset
|
22 ## @deftypefnx {Function File} {} box ("off") |
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{}) |
6052 | 24 ## Control the display of a border around the plot. |
25 ## The argument may be either @code{"on"} or @code{"off"}. If it is | |
6653 | 26 ## 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
|
27 ## |
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 ## 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
|
29 ## specified axis object. |
6052 | 30 ## @seealso{grid} |
31 ## @end deftypefn | |
32 | |
33 ## Author: jwe | |
34 | |
6257 | 35 function box (varargin) |
36 | |
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
|
37 [ax, varargin, nargs] = __plt_get_axis_arg__ ("box", varargin{:}); |
6257 | 38 |
39 if (nargs == 0) | |
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
|
40 box_state = get (ax, "box"); |
310039bc3dd3
box.m: Allow specification of a graphics axis to act on (bug #35486).
Garrett G Euler <ggeuler@gmail.com>
parents:
14138
diff
changeset
|
41 if (strcmp (box_state, "on")) |
6257 | 42 box_state = "off"; |
43 else | |
44 box_state = "on"; | |
45 endif | |
46 elseif (nargs == 1) | |
47 state = varargin{1}; | |
48 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
|
49 if (strcmpi (state, "off")) |
10549 | 50 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
|
51 elseif (strcmpi (state, "on")) |
10549 | 52 box_state = "on"; |
6257 | 53 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
|
54 error ('box: argument must be "on" or "off"'); |
6257 | 55 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
|
56 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
|
57 error ('box: argument must be "on" or "off"'); |
6257 | 58 endif |
59 else | |
60 print_usage (); | |
61 endif | |
62 | |
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
|
63 set (ax, "box", box_state); |
6052 | 64 |
65 endfunction |