Mercurial > hg > octave-lyh

comparison scripts/plot/cla.m @ 17126: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 86067af51d5e
children b5d6314314fc
comparison
equal deleted inserted replaced
17125:d4549655b92e 17126:eaab03308c0b
15 ## You should have received a copy of the GNU General Public License 15 ## You should have received a copy of the GNU General Public License
16 ## along with Octave; see the file COPYING. If not, see 16 ## along with Octave; see the file COPYING. If not, see
17 ## <http://www.gnu.org/licenses/>. 17 ## <http://www.gnu.org/licenses/>.
18 18
19 ## -*- texinfo -*- 19 ## -*- texinfo -*-
20 ## @deftypefn {Function File} {} cla 20 ## @deftypefn {Command} {} cla
21 ## @deftypefnx {Function File} {} cla reset 21 ## @deftypefnx {Command} {} cla reset
22 ## @deftypefnx {Function File} {} cla (@var{hax}) 22 ## @deftypefnx {Function File} {} cla (@var{hax})
23 ## @deftypefnx {Function File} {} cla (@var{hax}, "reset") 23 ## @deftypefnx {Function File} {} cla (@var{hax}, "reset")
24 ## Clear the current axes by deleting child graphic objects with visible 24 ## Clear the current axes.
25 ##
26 ## @code{cla} operates by deleting child graphic objects with visible
25 ## handles (HandleVisibility = "on"). 27 ## handles (HandleVisibility = "on").
26 ## 28 ##
27 ## If the optional argument "reset" is specified, delete all child objects 29 ## If the optional argument "reset" is specified, delete all child objects
28 ## including those with hidden handles and reset all axis properties to 30 ## including those with hidden handles and reset all axis properties to
29 ## their defaults. However, the following properties are not reset: 31 ## their defaults. However, the following properties are not reset:
30 ## Position, Units. 32 ## Position, Units.
31 ## 33 ##
32 ## If an axes object handle @var{hax} is specified, operate on it instead of 34 ## If the first argument @var{hax} is an axes handle, then operate on
33 ## the current axes. 35 ## this axis rather than the current axes returned by @code{gca}.
34 ## @seealso{clf} 36 ## @seealso{clf}
35 ## @end deftypefn 37 ## @end deftypefn
36 38
37 ## Author: Ben Abbott <bpabbott@mac.com> 39 ## Author: Ben Abbott <bpabbott@mac.com>
38 ## Created: 2008-10-03 40 ## Created: 2008-10-03
78 80
79 %!test 81 %!test
80 %! hf = figure ("visible", "off"); 82 %! hf = figure ("visible", "off");
81 %! unwind_protect 83 %! unwind_protect
82 %! plot (1:10); 84 %! plot (1:10);
85 %! assert (! isempty (get (gca, "children")));
83 %! cla (); 86 %! cla ();
84 %! kids = get (gca, "children"); 87 %! assert (isempty (get (gca, "children")));
85 %! cla ();
86 %! unwind_protect_cleanup 88 %! unwind_protect_cleanup
87 %! close (hf); 89 %! close (hf);
88 %! end_unwind_protect 90 %! end_unwind_protect
89 %! assert (numel (kids), 0);
90 91
91 %!test 92 %!test
92 %! hf = figure ("visible", "off"); 93 %! hf = figure ("visible", "off");
93 %! unwind_protect 94 %! unwind_protect
94 %! hax = gca; 95 %! hax = gca;