Mercurial > hg > octave-nkf

annotate scripts/plot/axes.m @ 17122:eaab03308c0b

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
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 62d5f73e840c
children b5d6314314fc
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: 13327
diff changeset
1 ## Copyright (C) 2005-2012 John W. Eaton
6257
44c91c5dfe1d [project @ 2007-01-30 19:16:52 by jwe]
jwe
parents:
diff changeset
2 ##
44c91c5dfe1d [project @ 2007-01-30 19:16:52 by jwe]
jwe
parents:
diff changeset
3 ## This file is part of Octave.
44c91c5dfe1d [project @ 2007-01-30 19:16:52 by jwe]
jwe
parents:
diff changeset
4 ##
44c91c5dfe1d [project @ 2007-01-30 19:16:52 by jwe]
jwe
parents:
diff changeset
5 ## Octave is free software; you can redistribute it and/or modify it
44c91c5dfe1d [project @ 2007-01-30 19:16:52 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: 6851
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: 6851
diff changeset
8 ## your option) any later version.
6257
44c91c5dfe1d [project @ 2007-01-30 19:16:52 by jwe]
jwe
parents:
diff changeset
9 ##
44c91c5dfe1d [project @ 2007-01-30 19:16:52 by jwe]
jwe
parents:
diff changeset
10 ## Octave is distributed in the hope that it will be useful, but
44c91c5dfe1d [project @ 2007-01-30 19:16:52 by jwe]
jwe
parents:
diff changeset
11 ## WITHOUT ANY WARRANTY; without even the implied warranty of
44c91c5dfe1d [project @ 2007-01-30 19:16:52 by jwe]
jwe
parents:
diff changeset
12 ## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
44c91c5dfe1d [project @ 2007-01-30 19:16:52 by jwe]
jwe
parents:
diff changeset
13 ## General Public License for more details.
44c91c5dfe1d [project @ 2007-01-30 19:16:52 by jwe]
jwe
parents:
diff changeset
14 ##
44c91c5dfe1d [project @ 2007-01-30 19:16:52 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: 6851
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: 6851
diff changeset
17 ## <http://www.gnu.org/licenses/>.
6257
44c91c5dfe1d [project @ 2007-01-30 19:16:52 by jwe]
jwe
parents:
diff changeset
18
44c91c5dfe1d [project @ 2007-01-30 19:16:52 by jwe]
jwe
parents:
diff changeset
19 ## -*- texinfo -*-
10793
be55736a0783 Grammarcheck the documentation from m-files.
Rik <octave@nomad.inbox5.com>
parents: 10549
diff changeset
20 ## @deftypefn {Function File} {} axes ()
6257
44c91c5dfe1d [project @ 2007-01-30 19:16:52 by jwe]
jwe
parents:
diff changeset
21 ## @deftypefnx {Function File} {} axes (@var{property}, @var{value}, @dots{})
17122
eaab03308c0b doc: Rewrite docstrings for most plot functions.
Rik <rik@octave.org>
parents: 17042
diff changeset
22 ## @deftypefnx {Function File} {} axes (@var{hax})
17042
62d5f73e840c axes.m: reorder figure children after setting the currentaxes (bug #39539).
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents: 14868
diff changeset
23 ## @deftypefnx {Function File} {@var{h} =} axes (@dots{})
62d5f73e840c axes.m: reorder figure children after setting the currentaxes (bug #39539).
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents: 14868
diff changeset
24 ## Create an axes object and return a handle to it, or set the current
17122
eaab03308c0b doc: Rewrite docstrings for most plot functions.
Rik <rik@octave.org>
parents: 17042
diff changeset
25 ## axes to @var{hax}.
17042
62d5f73e840c axes.m: reorder figure children after setting the currentaxes (bug #39539).
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents: 14868
diff changeset
26 ##
62d5f73e840c axes.m: reorder figure children after setting the currentaxes (bug #39539).
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents: 14868
diff changeset
27 ## Called without any arguments, or with @var{property}/@var{value} pairs,
17122
eaab03308c0b doc: Rewrite docstrings for most plot functions.
Rik <rik@octave.org>
parents: 17042
diff changeset
28 ## construct a new axes. For accepted properties and corresponding
eaab03308c0b doc: Rewrite docstrings for most plot functions.
Rik <rik@octave.org>
parents: 17042
diff changeset
29 ## values, @pxref{XREFset,,set}.
17042
62d5f73e840c axes.m: reorder figure children after setting the currentaxes (bug #39539).
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents: 14868
diff changeset
30 ##
17122
eaab03308c0b doc: Rewrite docstrings for most plot functions.
Rik <rik@octave.org>
parents: 17042
diff changeset
31 ## Called with a single axes handle argument @var{hax}, the function makes
eaab03308c0b doc: Rewrite docstrings for most plot functions.
Rik <rik@octave.org>
parents: 17042
diff changeset
32 ## @var{hax} the current axis. It also restacks the axes in the
eaab03308c0b doc: Rewrite docstrings for most plot functions.
Rik <rik@octave.org>
parents: 17042
diff changeset
33 ## corresponding figure so that @var{hax} is the first entry in the list
eaab03308c0b doc: Rewrite docstrings for most plot functions.
Rik <rik@octave.org>
parents: 17042
diff changeset
34 ## of children. This causes @var{hax} to be displayed on top of any other
17042
62d5f73e840c axes.m: reorder figure children after setting the currentaxes (bug #39539).
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents: 14868
diff changeset
35 ## axes objects (Z-order stacking).
62d5f73e840c axes.m: reorder figure children after setting the currentaxes (bug #39539).
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents: 14868
diff changeset
36 ##
62d5f73e840c axes.m: reorder figure children after setting the currentaxes (bug #39539).
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents: 14868
diff changeset
37 ## @seealso {gca, set, get}
6257
44c91c5dfe1d [project @ 2007-01-30 19:16:52 by jwe]
jwe
parents:
diff changeset
38 ## @end deftypefn
44c91c5dfe1d [project @ 2007-01-30 19:16:52 by jwe]
jwe
parents:
diff changeset
39
44c91c5dfe1d [project @ 2007-01-30 19:16:52 by jwe]
jwe
parents:
diff changeset
40 ## Author: jwe
44c91c5dfe1d [project @ 2007-01-30 19:16:52 by jwe]
jwe
parents:
diff changeset
41
44c91c5dfe1d [project @ 2007-01-30 19:16:52 by jwe]
jwe
parents:
diff changeset
42 function h = axes (varargin)
44c91c5dfe1d [project @ 2007-01-30 19:16:52 by jwe]
jwe
parents:
diff changeset
43
44c91c5dfe1d [project @ 2007-01-30 19:16:52 by jwe]
jwe
parents:
diff changeset
44 if (nargin == 0 || nargin > 1)
13327
f81fcceb394c axes: only update the currentaxes property of the parent figure if the axes object is visible
John W. Eaton <jwe@octave.org>
parents: 11523
diff changeset
45 ## Create an axes object.
6851
05f6f120a65f [project @ 2007-08-31 17:58:00 by jwe]
jwe
parents: 6688
diff changeset
46 idx = find (strcmpi (varargin(1:2:end), "parent"), 1, "first");
05f6f120a65f [project @ 2007-08-31 17:58:00 by jwe]
jwe
parents: 6688
diff changeset
47 if (! isempty (idx) && length (varargin) >= 2*idx)
05f6f120a65f [project @ 2007-08-31 17:58:00 by jwe]
jwe
parents: 6688
diff changeset
48 cf = varargin{2*idx};
05f6f120a65f [project @ 2007-08-31 17:58:00 by jwe]
jwe
parents: 6688
diff changeset
49 varargin([2*idx-1, 2*idx]) = [];
05f6f120a65f [project @ 2007-08-31 17:58:00 by jwe]
jwe
parents: 6688
diff changeset
50 else
05f6f120a65f [project @ 2007-08-31 17:58:00 by jwe]
jwe
parents: 6688
diff changeset
51 cf = gcf ();
05f6f120a65f [project @ 2007-08-31 17:58:00 by jwe]
jwe
parents: 6688
diff changeset
52 endif
17042
62d5f73e840c axes.m: reorder figure children after setting the currentaxes (bug #39539).
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents: 14868
diff changeset
53 htmp = __go_axes__ (cf, varargin{:});
62d5f73e840c axes.m: reorder figure children after setting the currentaxes (bug #39539).
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents: 14868
diff changeset
54 if (__is_handle_visible__ (htmp))
62d5f73e840c axes.m: reorder figure children after setting the currentaxes (bug #39539).
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents: 14868
diff changeset
55 set (ancestor (cf, "figure"), "currentaxes", htmp);
13327
f81fcceb394c axes: only update the currentaxes property of the parent figure if the axes object is visible
John W. Eaton <jwe@octave.org>
parents: 11523
diff changeset
56 endif
6688
b26a8e0e42cd [project @ 2007-06-04 06:25:21 by jwe]
jwe
parents: 6405
diff changeset
57 else
17042
62d5f73e840c axes.m: reorder figure children after setting the currentaxes (bug #39539).
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents: 14868
diff changeset
58 ## ARG is axes handle.
62d5f73e840c axes.m: reorder figure children after setting the currentaxes (bug #39539).
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents: 14868
diff changeset
59 htmp = varargin{1};
62d5f73e840c axes.m: reorder figure children after setting the currentaxes (bug #39539).
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents: 14868
diff changeset
60 if (isscalar (htmp) && ishandle (htmp)
62d5f73e840c axes.m: reorder figure children after setting the currentaxes (bug #39539).
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents: 14868
diff changeset
61 && strcmp (get (htmp, "type"), "axes"))
62d5f73e840c axes.m: reorder figure children after setting the currentaxes (bug #39539).
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents: 14868
diff changeset
62 if (__is_handle_visible__ (htmp))
62d5f73e840c axes.m: reorder figure children after setting the currentaxes (bug #39539).
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents: 14868
diff changeset
63 parent = ancestor (htmp, "figure");
13327
f81fcceb394c axes: only update the currentaxes property of the parent figure if the axes object is visible
John W. Eaton <jwe@octave.org>
parents: 11523
diff changeset
64 set (0, "currentfigure", parent);
17042
62d5f73e840c axes.m: reorder figure children after setting the currentaxes (bug #39539).
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents: 14868
diff changeset
65 set (parent, "currentaxes", htmp);
62d5f73e840c axes.m: reorder figure children after setting the currentaxes (bug #39539).
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents: 14868
diff changeset
66
62d5f73e840c axes.m: reorder figure children after setting the currentaxes (bug #39539).
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents: 14868
diff changeset
67 ## restack
62d5f73e840c axes.m: reorder figure children after setting the currentaxes (bug #39539).
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents: 14868
diff changeset
68 ch = get (parent, "children")(:);
62d5f73e840c axes.m: reorder figure children after setting the currentaxes (bug #39539).
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents: 14868
diff changeset
69 idx = (ch == htmp);
62d5f73e840c axes.m: reorder figure children after setting the currentaxes (bug #39539).
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents: 14868
diff changeset
70 ch = [ch(idx); ch(!idx)];
62d5f73e840c axes.m: reorder figure children after setting the currentaxes (bug #39539).
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents: 14868
diff changeset
71 set (parent, "children", ch);
13327
f81fcceb394c axes: only update the currentaxes property of the parent figure if the axes object is visible
John W. Eaton <jwe@octave.org>
parents: 11523
diff changeset
72 endif
6257
44c91c5dfe1d [project @ 2007-01-30 19:16:52 by jwe]
jwe
parents:
diff changeset
73 else
17042
62d5f73e840c axes.m: reorder figure children after setting the currentaxes (bug #39539).
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents: 14868
diff changeset
74 error ("axes: H must be a scalar axes handle");
6257
44c91c5dfe1d [project @ 2007-01-30 19:16:52 by jwe]
jwe
parents:
diff changeset
75 endif
44c91c5dfe1d [project @ 2007-01-30 19:16:52 by jwe]
jwe
parents:
diff changeset
76 endif
44c91c5dfe1d [project @ 2007-01-30 19:16:52 by jwe]
jwe
parents:
diff changeset
77
44c91c5dfe1d [project @ 2007-01-30 19:16:52 by jwe]
jwe
parents:
diff changeset
78 if (nargout > 0)
17042
62d5f73e840c axes.m: reorder figure children after setting the currentaxes (bug #39539).
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents: 14868
diff changeset
79 h = htmp;
6257
44c91c5dfe1d [project @ 2007-01-30 19:16:52 by jwe]
jwe
parents:
diff changeset
80 endif
44c91c5dfe1d [project @ 2007-01-30 19:16:52 by jwe]
jwe
parents:
diff changeset
81
44c91c5dfe1d [project @ 2007-01-30 19:16:52 by jwe]
jwe
parents:
diff changeset
82 endfunction