annotate scripts/plot/grid.m @ 6895:76e3d985ae56

[project @ 2007-09-13 18:22:38 by jwe]
author jwe
date Thu, 13 Sep 2007 18:22:51 +0000
parents d069de22e9aa
children 93c65f2a5668
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
2847
8b262e771614 [project @ 1997-03-27 16:18:26 by jwe]
jwe
parents: 2520
diff changeset
1 ## Copyright (C) 1996, 1997 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 ##
5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe]
jwe
parents: 2311
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: 2311
diff changeset
6 ## under the terms of the GNU General Public License as published by
5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe]
jwe
parents: 2311
diff changeset
7 ## the Free Software Foundation; either version 2, or (at your option)
5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe]
jwe
parents: 2311
diff changeset
8 ## any later version.
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
5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe]
jwe
parents: 2311
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: 2311
diff changeset
13 ## General Public License for more details.
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
5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe]
jwe
parents: 2311
diff changeset
16 ## along with Octave; see the file COPYING. If not, write to the Free
5307
4c8a2e4e0717 [project @ 2005-04-26 19:24:27 by jwe]
jwe
parents: 5253
diff changeset
17 ## Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
4c8a2e4e0717 [project @ 2005-04-26 19:24:27 by jwe]
jwe
parents: 5253
diff changeset
18 ## 02110-1301, USA.
245
16a24e76d6e0 [project @ 1993-12-03 02:00:15 by jwe]
jwe
parents: 4
diff changeset
19
3368
a4cd1e9d9962 [project @ 1999-11-20 17:22:48 by jwe]
jwe
parents: 2847
diff changeset
20 ## -*- texinfo -*-
a4cd1e9d9962 [project @ 1999-11-20 17:22:48 by jwe]
jwe
parents: 2847
diff changeset
21 ## @deftypefn {Function File} {} grid (@var{arg})
5727
f0fbefd984f6 [project @ 2006-04-03 18:50:31 by jwe]
jwe
parents: 5642
diff changeset
22 ## @deftypefnx {Function File} {} grid ("minor", @var{arg2})
6257
44c91c5dfe1d [project @ 2007-01-30 19:16:52 by jwe]
jwe
parents: 6046
diff changeset
23 ## Force the display of a grid on the plot.
3368
a4cd1e9d9962 [project @ 1999-11-20 17:22:48 by jwe]
jwe
parents: 2847
diff changeset
24 ## 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: 6448
diff changeset
25 ## omitted, the current grid state is toggled.
5727
f0fbefd984f6 [project @ 2006-04-03 18:50:31 by jwe]
jwe
parents: 5642
diff changeset
26 ##
6895
76e3d985ae56 [project @ 2007-09-13 18:22:38 by jwe]
jwe
parents: 6828
diff changeset
27 ## If @var{arg} is @code{"minor"} then the minor grid is toggled. When
5727
f0fbefd984f6 [project @ 2006-04-03 18:50:31 by jwe]
jwe
parents: 5642
diff changeset
28 ## using a minor grid a second argument @var{arg2} is allowed, which can
f0fbefd984f6 [project @ 2006-04-03 18:50:31 by jwe]
jwe
parents: 5642
diff changeset
29 ## be either @code{"on"} or @code{"off"} to explicitly set the state of
6257
44c91c5dfe1d [project @ 2007-01-30 19:16:52 by jwe]
jwe
parents: 6046
diff changeset
30 ## the minor grid.
6895
76e3d985ae56 [project @ 2007-09-13 18:22:38 by jwe]
jwe
parents: 6828
diff changeset
31 ## @seealso{plot}
3368
a4cd1e9d9962 [project @ 1999-11-20 17:22:48 by jwe]
jwe
parents: 2847
diff changeset
32 ## @end deftypefn
4
b4df021f796c [project @ 1993-08-08 01:26:08 by jwe]
jwe
parents:
diff changeset
33
2314
949ab8eba8bc [project @ 1996-07-12 03:58:02 by jwe]
jwe
parents: 2313
diff changeset
34 ## Author: jwe
949ab8eba8bc [project @ 1996-07-12 03:58:02 by jwe]
jwe
parents: 2313
diff changeset
35
4264
4e2d2516da22 [project @ 2003-01-03 05:30:34 by jwe]
jwe
parents: 3457
diff changeset
36 ## PKG_ADD: mark_as_command grid
4e2d2516da22 [project @ 2003-01-03 05:30:34 by jwe]
jwe
parents: 3457
diff changeset
37
5727
f0fbefd984f6 [project @ 2006-04-03 18:50:31 by jwe]
jwe
parents: 5642
diff changeset
38 function grid (x, y)
f0fbefd984f6 [project @ 2006-04-03 18:50:31 by jwe]
jwe
parents: 5642
diff changeset
39
f0fbefd984f6 [project @ 2006-04-03 18:50:31 by jwe]
jwe
parents: 5642
diff changeset
40 persistent grid_on = false;
f0fbefd984f6 [project @ 2006-04-03 18:50:31 by jwe]
jwe
parents: 5642
diff changeset
41 persistent minor_on = false;
6257
44c91c5dfe1d [project @ 2007-01-30 19:16:52 by jwe]
jwe
parents: 6046
diff changeset
42
44c91c5dfe1d [project @ 2007-01-30 19:16:52 by jwe]
jwe
parents: 6046
diff changeset
43 nargs = nargin;
4
b4df021f796c [project @ 1993-08-08 01:26:08 by jwe]
jwe
parents:
diff changeset
44
6257
44c91c5dfe1d [project @ 2007-01-30 19:16:52 by jwe]
jwe
parents: 6046
diff changeset
45 if (nargs == 2)
44c91c5dfe1d [project @ 2007-01-30 19:16:52 by jwe]
jwe
parents: 6046
diff changeset
46 if (ishandle (x))
44c91c5dfe1d [project @ 2007-01-30 19:16:52 by jwe]
jwe
parents: 6046
diff changeset
47 ax = x;
44c91c5dfe1d [project @ 2007-01-30 19:16:52 by jwe]
jwe
parents: 6046
diff changeset
48 x = y;
44c91c5dfe1d [project @ 2007-01-30 19:16:52 by jwe]
jwe
parents: 6046
diff changeset
49 nargs--;
6828
d069de22e9aa [project @ 2007-08-24 16:59:47 by jwe]
jwe
parents: 6653
diff changeset
50 if (! strcmp (get (ax, "type"), "axes"))
6257
44c91c5dfe1d [project @ 2007-01-30 19:16:52 by jwe]
jwe
parents: 6046
diff changeset
51 error ("grid: expecting first argument to be an axes object");
44c91c5dfe1d [project @ 2007-01-30 19:16:52 by jwe]
jwe
parents: 6046
diff changeset
52 endif
44c91c5dfe1d [project @ 2007-01-30 19:16:52 by jwe]
jwe
parents: 6046
diff changeset
53 else
44c91c5dfe1d [project @ 2007-01-30 19:16:52 by jwe]
jwe
parents: 6046
diff changeset
54 print_usage ();
44c91c5dfe1d [project @ 2007-01-30 19:16:52 by jwe]
jwe
parents: 6046
diff changeset
55 endif
44c91c5dfe1d [project @ 2007-01-30 19:16:52 by jwe]
jwe
parents: 6046
diff changeset
56 else
44c91c5dfe1d [project @ 2007-01-30 19:16:52 by jwe]
jwe
parents: 6046
diff changeset
57 ax = gca ();
44c91c5dfe1d [project @ 2007-01-30 19:16:52 by jwe]
jwe
parents: 6046
diff changeset
58 endif
5152
b111ca4715c6 [project @ 2005-02-21 19:41:23 by jwe]
jwe
parents: 5053
diff changeset
59
6257
44c91c5dfe1d [project @ 2007-01-30 19:16:52 by jwe]
jwe
parents: 6046
diff changeset
60 if (nargs == 0)
5727
f0fbefd984f6 [project @ 2006-04-03 18:50:31 by jwe]
jwe
parents: 5642
diff changeset
61 grid_on = ! grid_on;
6257
44c91c5dfe1d [project @ 2007-01-30 19:16:52 by jwe]
jwe
parents: 6046
diff changeset
62 elseif (nargs == 1)
5443
ec8c33dcd1bf [project @ 2005-09-08 01:40:57 by jwe]
jwe
parents: 5307
diff changeset
63 if (ischar (x))
4
b4df021f796c [project @ 1993-08-08 01:26:08 by jwe]
jwe
parents:
diff changeset
64 if (strcmp ("off", x))
5727
f0fbefd984f6 [project @ 2006-04-03 18:50:31 by jwe]
jwe
parents: 5642
diff changeset
65 grid_on = false;
4
b4df021f796c [project @ 1993-08-08 01:26:08 by jwe]
jwe
parents:
diff changeset
66 elseif (strcmp ("on", x))
5727
f0fbefd984f6 [project @ 2006-04-03 18:50:31 by jwe]
jwe
parents: 5642
diff changeset
67 grid_on = true;
f0fbefd984f6 [project @ 2006-04-03 18:50:31 by jwe]
jwe
parents: 5642
diff changeset
68 elseif (strcmp ("minor", x))
f0fbefd984f6 [project @ 2006-04-03 18:50:31 by jwe]
jwe
parents: 5642
diff changeset
69 minor_on = ! minor_on;
f0fbefd984f6 [project @ 2006-04-03 18:50:31 by jwe]
jwe
parents: 5642
diff changeset
70 if (minor_on)
6257
44c91c5dfe1d [project @ 2007-01-30 19:16:52 by jwe]
jwe
parents: 6046
diff changeset
71 grid_on = true;
5727
f0fbefd984f6 [project @ 2006-04-03 18:50:31 by jwe]
jwe
parents: 5642
diff changeset
72 endif
4
b4df021f796c [project @ 1993-08-08 01:26:08 by jwe]
jwe
parents:
diff changeset
73 else
6046
34f96dd5441b [project @ 2006-10-10 16:10:25 by jwe]
jwe
parents: 5727
diff changeset
74 print_usage ();
4
b4df021f796c [project @ 1993-08-08 01:26:08 by jwe]
jwe
parents:
diff changeset
75 endif
b4df021f796c [project @ 1993-08-08 01:26:08 by jwe]
jwe
parents:
diff changeset
76 else
904
3470f1e25a79 [project @ 1994-11-09 21:22:15 by jwe]
jwe
parents: 245
diff changeset
77 error ("grid: argument must be a string");
4
b4df021f796c [project @ 1993-08-08 01:26:08 by jwe]
jwe
parents:
diff changeset
78 endif
6257
44c91c5dfe1d [project @ 2007-01-30 19:16:52 by jwe]
jwe
parents: 6046
diff changeset
79 else
44c91c5dfe1d [project @ 2007-01-30 19:16:52 by jwe]
jwe
parents: 6046
diff changeset
80 print_usage ();
44c91c5dfe1d [project @ 2007-01-30 19:16:52 by jwe]
jwe
parents: 6046
diff changeset
81 endif
44c91c5dfe1d [project @ 2007-01-30 19:16:52 by jwe]
jwe
parents: 6046
diff changeset
82
44c91c5dfe1d [project @ 2007-01-30 19:16:52 by jwe]
jwe
parents: 6046
diff changeset
83 if (grid_on)
44c91c5dfe1d [project @ 2007-01-30 19:16:52 by jwe]
jwe
parents: 6046
diff changeset
84 set (ax, "xgrid", "on", "ygrid", "on", "zgrid", "on");
44c91c5dfe1d [project @ 2007-01-30 19:16:52 by jwe]
jwe
parents: 6046
diff changeset
85 if (minor_on)
44c91c5dfe1d [project @ 2007-01-30 19:16:52 by jwe]
jwe
parents: 6046
diff changeset
86 set (ax, "xminorgrid", "on", "yminorgrid", "on", "zminorgrid", "on");
5727
f0fbefd984f6 [project @ 2006-04-03 18:50:31 by jwe]
jwe
parents: 5642
diff changeset
87 else
6257
44c91c5dfe1d [project @ 2007-01-30 19:16:52 by jwe]
jwe
parents: 6046
diff changeset
88 set (ax, "xminorgrid", "off", "yminorgrid", "off", "zminorgrid", "off");
44c91c5dfe1d [project @ 2007-01-30 19:16:52 by jwe]
jwe
parents: 6046
diff changeset
89 endif
4
b4df021f796c [project @ 1993-08-08 01:26:08 by jwe]
jwe
parents:
diff changeset
90 else
6257
44c91c5dfe1d [project @ 2007-01-30 19:16:52 by jwe]
jwe
parents: 6046
diff changeset
91 set (ax, "xgrid", "off", "ygrid", "off", "zgrid", "off");
44c91c5dfe1d [project @ 2007-01-30 19:16:52 by jwe]
jwe
parents: 6046
diff changeset
92 set (ax, "xminorgrid", "off", "yminorgrid", "off", "zminorgrid", "off");
5152
b111ca4715c6 [project @ 2005-02-21 19:41:23 by jwe]
jwe
parents: 5053
diff changeset
93 endif
b111ca4715c6 [project @ 2005-02-21 19:41:23 by jwe]
jwe
parents: 5053
diff changeset
94
4
b4df021f796c [project @ 1993-08-08 01:26:08 by jwe]
jwe
parents:
diff changeset
95 endfunction