Mercurial > hg > octave-nkf
annotate scripts/plot/box.m @ 17122:eaab03308c0b
doc: Rewrite docstrings for most plot functions.
Emphasize clarity, use common "voice", and increase density of seealso links.
* doc/interpreter/plot.txi: Add @findex entries that were in xlim.m
* scripts/miscellaneous/getappdata.m scripts/miscellaneous/setappdata.m,
scripts/plot/allchild.m, scripts/plot/ancestor.m, scripts/plot/area.m,
scripts/plot/axes.m, scripts/plot/axis.m, scripts/plot/bar.m,
scripts/plot/barh.m, scripts/plot/box.m, scripts/plot/caxis.m,
scripts/plot/cla.m, scripts/plot/clabel.m, scripts/plot/clf.m,
scripts/plot/close.m, scripts/plot/closereq.m, scripts/plot/colorbar.m,
scripts/plot/comet.m, scripts/plot/comet3.m, scripts/plot/compass.m,
scripts/plot/contour.m, scripts/plot/contour3.m, scripts/plot/contourc.m,
scripts/plot/contourf.m, scripts/plot/copyobj.m, scripts/plot/cylinder.m,
scripts/plot/daspect.m, scripts/plot/diffuse.m, scripts/plot/ellipsoid.m,
scripts/plot/errorbar.m, scripts/plot/ezcontour.m, scripts/plot/ezcontourf.m,
scripts/plot/ezmesh.m, scripts/plot/ezmeshc.m, scripts/plot/ezplot.m,
scripts/plot/ezplot3.m, scripts/plot/ezpolar.m, scripts/plot/ezsurf.m,
scripts/plot/ezsurfc.m, scripts/plot/feather.m, scripts/plot/figure.m,
scripts/plot/fill.m, scripts/plot/findall.m, scripts/plot/findobj.m,
scripts/plot/fplot.m, scripts/plot/gca.m, scripts/plot/gcbf.m,
scripts/plot/gcbo.m, scripts/plot/gcf.m, scripts/plot/gco.m,
scripts/plot/ginput.m, scripts/plot/graphics_toolkit.m, scripts/plot/grid.m,
scripts/plot/gtext.m, scripts/plot/guidata.m, scripts/plot/guihandles.m,
scripts/plot/hdl2struct.m, scripts/plot/hggroup.m, scripts/plot/hidden.m,
scripts/plot/hist.m, scripts/plot/hold.m, scripts/plot/ishghandle.m,
scripts/plot/ishold.m, scripts/plot/isocolors.m, scripts/plot/isprop.m,
scripts/plot/legend.m, scripts/plot/line.m, scripts/plot/linkprop.m,
scripts/plot/loglog.m, scripts/plot/loglogerr.m, scripts/plot/mesh.m,
scripts/plot/meshc.m, scripts/plot/meshgrid.m, scripts/plot/meshz.m,
scripts/plot/newplot.m, scripts/plot/orient.m, scripts/plot/pareto.m,
scripts/plot/patch.m, scripts/plot/pcolor.m, scripts/plot/peaks.m,
scripts/plot/pie.m, scripts/plot/pie3.m, scripts/plot/plot.m,
scripts/plot/plot3.m, scripts/plot/plotmatrix.m, scripts/plot/plotyy.m,
scripts/plot/polar.m, scripts/plot/print.m, scripts/plot/quiver.m,
scripts/plot/quiver3.m, scripts/plot/rectangle.m, scripts/plot/refresh.m,
scripts/plot/refreshdata.m, scripts/plot/ribbon.m, scripts/plot/rose.m,
scripts/plot/saveas.m, scripts/plot/scatter.m, scripts/plot/scatter3.m,
scripts/plot/semilogx.m, scripts/plot/semilogxerr.m, scripts/plot/semilogy.m,
scripts/plot/semilogyerr.m, scripts/plot/shading.m, scripts/plot/shg.m,
scripts/plot/shrinkfaces.m, scripts/plot/slice.m, scripts/plot/specular.m,
scripts/plot/sphere.m, scripts/plot/stairs.m, scripts/plot/stem.m,
scripts/plot/stem3.m, scripts/plot/struct2hdl.m, scripts/plot/subplot.m,
scripts/plot/surf.m, scripts/plot/surface.m, scripts/plot/surfc.m,
scripts/plot/surfl.m, scripts/plot/tetramesh.m, scripts/plot/text.m,
scripts/plot/title.m, scripts/plot/trimesh.m, scripts/plot/triplot.m,
scripts/plot/trisurf.m, scripts/plot/view.m, scripts/plot/waitbar.m,
scripts/plot/waitforbuttonpress.m, scripts/plot/waterfall.m,
scripts/plot/whitebg.m, scripts/plot/xlabel.m, scripts/plot/xlim.m,
scripts/plot/ylabel.m, scripts/plot/ylim.m, scripts/plot/zlabel.m,
scripts/plot/zlim.m: Rewrite docstrings for most plot functions.
Emphasize clarity, use common "voice", and increase density of seealso links.
| author | Rik <rik@octave.org> |
|---|---|
| date | Wed, 31 Jul 2013 13:53:30 -0700 |
| parents | 0322e057697f |
| children | bc924baa2c4e |
| 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 -*- | |
|
17122
eaab03308c0b
doc: Rewrite docstrings for most plot functions.
Rik <rik@octave.org>
parents:
17049
diff
changeset
|
20 ## @deftypefn {Command} {} box on |
|
eaab03308c0b
doc: Rewrite docstrings for most plot functions.
Rik <rik@octave.org>
parents:
17049
diff
changeset
|
21 ## @deftypefnx {Command} {} box off |
|
eaab03308c0b
doc: Rewrite docstrings for most plot functions.
Rik <rik@octave.org>
parents:
17049
diff
changeset
|
22 ## @deftypefnx {Command} {} 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{}) |
|
17122
eaab03308c0b
doc: Rewrite docstrings for most plot functions.
Rik <rik@octave.org>
parents:
17049
diff
changeset
|
24 ## Control display of the axis border. |
|
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
|
25 ## |
|
17122
eaab03308c0b
doc: Rewrite docstrings for most plot functions.
Rik <rik@octave.org>
parents:
17049
diff
changeset
|
26 ## The argument may be either "on" or "off". If it is omitted, the current |
|
eaab03308c0b
doc: Rewrite docstrings for most plot functions.
Rik <rik@octave.org>
parents:
17049
diff
changeset
|
27 ## 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 ## |
|
17122
eaab03308c0b
doc: Rewrite docstrings for most plot functions.
Rik <rik@octave.org>
parents:
17049
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:
17049
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:
17049
diff
changeset
|
31 ## @seealso{axis, grid} |
| 6052 | 32 ## @end deftypefn |
| 33 | |
| 34 ## Author: jwe | |
| 35 | |
| 6257 | 36 function box (varargin) |
| 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 | 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 | 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 | 47 box_state = "off"; |
| 48 else | |
| 49 box_state = "on"; | |
| 50 endif | |
| 51 elseif (nargs == 1) | |
| 52 state = varargin{1}; | |
| 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 | 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 | 57 box_state = "on"; |
| 6257 | 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 | 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 | 63 endif |
| 64 else | |
| 65 print_usage (); | |
| 66 endif | |
| 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 | 69 |
| 70 endfunction |