Mercurial > hg > octave-lyh

comparison scripts/plot/newplot.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 08dd9458684a
children d87179b38bcf
comparison
equal deleted inserted replaced
17125:d4549655b92e 17126:eaab03308c0b
54 ## @item "replacechildren" @tab Delete child objects whose HandleVisibility is 54 ## @item "replacechildren" @tab Delete child objects whose HandleVisibility is
55 ## set to "on", but leave axis properties unmodified. This typically clears a 55 ## set to "on", but leave axis properties unmodified. This typically clears a
56 ## plot, but preserves special settings such as log scaling for axes. 56 ## plot, but preserves special settings such as log scaling for axes.
57 ## This is equivalent to @code{cla}. 57 ## This is equivalent to @code{cla}.
58 ## 58 ##
59 ## @item "replace" (default) @tab Delete all child objects of the axis and reset all axis 59 ## @item "replace" (default) @tab Delete all child objects of the axis and
60 ## properties to their defaults. However, the following properties 60 ## reset all axis properties to their defaults. However, the following
61 ## are not reset: Position, Units. This is equivalent to @code{cla reset}. 61 ## properties are not reset: Position, Units. This is equivalent to
62 ## @code{cla reset}.
62 ## 63 ##
63 ## @end multitable 64 ## @end multitable
64 ## 65 ##
65 ## If the optional input @var{hfig} or @var{hax} is given then prepare the 66 ## If the optional input @var{hfig} or @var{hax} is given then prepare the
66 ## specified figure or axes rather than the current figure and axes. 67 ## specified figure or axes rather than the current figure and axes.
74 75
75 ## FIXME: The Matlab function takes an optional list of file handles, hsave, 76 ## FIXME: The Matlab function takes an optional list of file handles, hsave,
76 ## which are not deleted when the figure and axes are prepared. 77 ## which are not deleted when the figure and axes are prepared.
77 ## I'm sure there is a good reason for that, but coding such 78 ## I'm sure there is a good reason for that, but coding such
78 ## compatibility is really tricky and doesn't serve much purpose since 79 ## compatibility is really tricky and doesn't serve much purpose since
79 ## newplot is nearly exclusively used by Octave internal plotting 80 ## newplot is nearly exclusively used by Octave's internal plotting
80 ## functions. In Octave's case the argument is almost always null, 81 ## functions. In Octave's case the argument is almost always null,
81 ## or occasionally the axis handle to plot into. 82 ## or occasionally the axis handle to plot into.
82 83
83 function hax = newplot (hsave = []) 84 function hax = newplot (hsave = [])
84 85