octave-lyh: scripts/plot/newplot.m annotate

annotate scripts/plot/newplot.m @ 17126: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	08dd9458684a
children	d87179b38bcf

rev	line source
14138 72c96de7a403 maint: update copyright notices for 2012 John W. Eaton <jwe@octave.org> parents: 13204 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: 6895 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: 6895 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: 6895 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: 6895 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 --
16076 c90c9623b20f newplot.m: Return handle to created axes for Matlab compatibility (Bug #38146) Rik <rik@octave.org> parents: 14363 diff changeset	20 ## @deftypefn {Function File} {} newplot ()
17036 08dd9458684a Overhaul __plt_get_axis_arg__ and newplot functions to avoid creating unnecessary axes. Rik <rik@octave.org> parents: 16076 diff changeset	21 ## @deftypefnx {Function File} {} newplot (@var{hfig})
08dd9458684a Overhaul __plt_get_axis_arg__ and newplot functions to avoid creating unnecessary axes. Rik <rik@octave.org> parents: 16076 diff changeset	22 ## @deftypefnx {Function File} {} newplot (@var{hax})
08dd9458684a Overhaul __plt_get_axis_arg__ and newplot functions to avoid creating unnecessary axes. Rik <rik@octave.org> parents: 16076 diff changeset	23 ## @deftypefnx {Function File} {@var{hax} =} newplot (@dots{})
08dd9458684a Overhaul __plt_get_axis_arg__ and newplot functions to avoid creating unnecessary axes. Rik <rik@octave.org> parents: 16076 diff changeset	24 ## Prepare graphics engine to produce a new plot.
08dd9458684a Overhaul __plt_get_axis_arg__ and newplot functions to avoid creating unnecessary axes. Rik <rik@octave.org> parents: 16076 diff changeset	25 ##
08dd9458684a Overhaul __plt_get_axis_arg__ and newplot functions to avoid creating unnecessary axes. Rik <rik@octave.org> parents: 16076 diff changeset	26 ## This function is called at the beginning of all high-level plotting
08dd9458684a Overhaul __plt_get_axis_arg__ and newplot functions to avoid creating unnecessary axes. Rik <rik@octave.org> parents: 16076 diff changeset	27 ## functions. It is not normally required in user programs. @code{newplot}
08dd9458684a Overhaul __plt_get_axis_arg__ and newplot functions to avoid creating unnecessary axes. Rik <rik@octave.org> parents: 16076 diff changeset	28 ## queries the "NextPlot" field of the current figure and axis to determine
08dd9458684a Overhaul __plt_get_axis_arg__ and newplot functions to avoid creating unnecessary axes. Rik <rik@octave.org> parents: 16076 diff changeset	29 ## what to do.
08dd9458684a Overhaul __plt_get_axis_arg__ and newplot functions to avoid creating unnecessary axes. Rik <rik@octave.org> parents: 16076 diff changeset	30 ##
08dd9458684a Overhaul __plt_get_axis_arg__ and newplot functions to avoid creating unnecessary axes. Rik <rik@octave.org> parents: 16076 diff changeset	31 ## @multitable @columnfractions .25 .75
08dd9458684a Overhaul __plt_get_axis_arg__ and newplot functions to avoid creating unnecessary axes. Rik <rik@octave.org> parents: 16076 diff changeset	32 ## @headitem Figure NextPlot @tab Action
08dd9458684a Overhaul __plt_get_axis_arg__ and newplot functions to avoid creating unnecessary axes. Rik <rik@octave.org> parents: 16076 diff changeset	33 ## @item "new" @tab Create a new figure and make it the current figure.
08dd9458684a Overhaul __plt_get_axis_arg__ and newplot functions to avoid creating unnecessary axes. Rik <rik@octave.org> parents: 16076 diff changeset	34 ##
08dd9458684a Overhaul __plt_get_axis_arg__ and newplot functions to avoid creating unnecessary axes. Rik <rik@octave.org> parents: 16076 diff changeset	35 ## @item "add" (default) @tab Add new graphic objects to the current figure.
08dd9458684a Overhaul __plt_get_axis_arg__ and newplot functions to avoid creating unnecessary axes. Rik <rik@octave.org> parents: 16076 diff changeset	36 ##
08dd9458684a Overhaul __plt_get_axis_arg__ and newplot functions to avoid creating unnecessary axes. Rik <rik@octave.org> parents: 16076 diff changeset	37 ## @item "replacechildren" @tab Delete child objects whose HandleVisibility is
08dd9458684a Overhaul __plt_get_axis_arg__ and newplot functions to avoid creating unnecessary axes. Rik <rik@octave.org> parents: 16076 diff changeset	38 ## set to "on". Set NextPlot property to "add". This typically clears a
08dd9458684a Overhaul __plt_get_axis_arg__ and newplot functions to avoid creating unnecessary axes. Rik <rik@octave.org> parents: 16076 diff changeset	39 ## figure, but leaves in place hidden objects such as menubars. This is
08dd9458684a Overhaul __plt_get_axis_arg__ and newplot functions to avoid creating unnecessary axes. Rik <rik@octave.org> parents: 16076 diff changeset	40 ## equivalent to @code{clf}.
08dd9458684a Overhaul __plt_get_axis_arg__ and newplot functions to avoid creating unnecessary axes. Rik <rik@octave.org> parents: 16076 diff changeset	41 ##
08dd9458684a Overhaul __plt_get_axis_arg__ and newplot functions to avoid creating unnecessary axes. Rik <rik@octave.org> parents: 16076 diff changeset	42 ## @item "replace" @tab Delete all child objects of the figure and reset all
08dd9458684a Overhaul __plt_get_axis_arg__ and newplot functions to avoid creating unnecessary axes. Rik <rik@octave.org> parents: 16076 diff changeset	43 ## figure properties to their defaults. However, the following four properties
08dd9458684a Overhaul __plt_get_axis_arg__ and newplot functions to avoid creating unnecessary axes. Rik <rik@octave.org> parents: 16076 diff changeset	44 ## are not reset: Position, Units, PaperPosition, PaperUnits. This is
08dd9458684a Overhaul __plt_get_axis_arg__ and newplot functions to avoid creating unnecessary axes. Rik <rik@octave.org> parents: 16076 diff changeset	45 ## equivalent to @code{clf reset}.
16076 c90c9623b20f newplot.m: Return handle to created axes for Matlab compatibility (Bug #38146) Rik <rik@octave.org> parents: 14363 diff changeset	46 ##
17036 08dd9458684a Overhaul __plt_get_axis_arg__ and newplot functions to avoid creating unnecessary axes. Rik <rik@octave.org> parents: 16076 diff changeset	47 ## @end multitable
08dd9458684a Overhaul __plt_get_axis_arg__ and newplot functions to avoid creating unnecessary axes. Rik <rik@octave.org> parents: 16076 diff changeset	48 ##
08dd9458684a Overhaul __plt_get_axis_arg__ and newplot functions to avoid creating unnecessary axes. Rik <rik@octave.org> parents: 16076 diff changeset	49 ## @multitable @columnfractions .25 .75
08dd9458684a Overhaul __plt_get_axis_arg__ and newplot functions to avoid creating unnecessary axes. Rik <rik@octave.org> parents: 16076 diff changeset	50 ## @headitem Axis NextPlot @tab Action
08dd9458684a Overhaul __plt_get_axis_arg__ and newplot functions to avoid creating unnecessary axes. Rik <rik@octave.org> parents: 16076 diff changeset	51 ## @item "add" @tab Add new graphic objects to the current axes. This is
08dd9458684a Overhaul __plt_get_axis_arg__ and newplot functions to avoid creating unnecessary axes. Rik <rik@octave.org> parents: 16076 diff changeset	52 ## equivalent to @code{hold on}.
08dd9458684a Overhaul __plt_get_axis_arg__ and newplot functions to avoid creating unnecessary axes. Rik <rik@octave.org> parents: 16076 diff changeset	53 ##
08dd9458684a Overhaul __plt_get_axis_arg__ and newplot functions to avoid creating unnecessary axes. Rik <rik@octave.org> parents: 16076 diff changeset	54 ## @item "replacechildren" @tab Delete child objects whose HandleVisibility is
08dd9458684a Overhaul __plt_get_axis_arg__ and newplot functions to avoid creating unnecessary axes. Rik <rik@octave.org> parents: 16076 diff changeset	55 ## set to "on", but leave axis properties unmodified. This typically clears a
08dd9458684a Overhaul __plt_get_axis_arg__ and newplot functions to avoid creating unnecessary axes. Rik <rik@octave.org> parents: 16076 diff changeset	56 ## plot, but preserves special settings such as log scaling for axes.
08dd9458684a Overhaul __plt_get_axis_arg__ and newplot functions to avoid creating unnecessary axes. Rik <rik@octave.org> parents: 16076 diff changeset	57 ## This is equivalent to @code{cla}.
08dd9458684a Overhaul __plt_get_axis_arg__ and newplot functions to avoid creating unnecessary axes. Rik <rik@octave.org> parents: 16076 diff changeset	58 ##
17126 eaab03308c0b doc: Rewrite docstrings for most plot functions. Rik <rik@octave.org> parents: 17036 diff changeset	59 ## @item "replace" (default) @tab Delete all child objects of the axis and
eaab03308c0b doc: Rewrite docstrings for most plot functions. Rik <rik@octave.org> parents: 17036 diff changeset	60 ## reset all axis properties to their defaults. However, the following
eaab03308c0b doc: Rewrite docstrings for most plot functions. Rik <rik@octave.org> parents: 17036 diff changeset	61 ## properties are not reset: Position, Units. This is equivalent to
eaab03308c0b doc: Rewrite docstrings for most plot functions. Rik <rik@octave.org> parents: 17036 diff changeset	62 ## @code{cla reset}.
17036 08dd9458684a Overhaul __plt_get_axis_arg__ and newplot functions to avoid creating unnecessary axes. Rik <rik@octave.org> parents: 16076 diff changeset	63 ##
08dd9458684a Overhaul __plt_get_axis_arg__ and newplot functions to avoid creating unnecessary axes. Rik <rik@octave.org> parents: 16076 diff changeset	64 ## @end multitable
08dd9458684a Overhaul __plt_get_axis_arg__ and newplot functions to avoid creating unnecessary axes. Rik <rik@octave.org> parents: 16076 diff changeset	65 ##
08dd9458684a Overhaul __plt_get_axis_arg__ and newplot functions to avoid creating unnecessary axes. Rik <rik@octave.org> parents: 16076 diff changeset	66 ## If the optional input @var{hfig} or @var{hax} is given then prepare the
08dd9458684a Overhaul __plt_get_axis_arg__ and newplot functions to avoid creating unnecessary axes. Rik <rik@octave.org> parents: 16076 diff changeset	67 ## specified figure or axes rather than the current figure and axes.
08dd9458684a Overhaul __plt_get_axis_arg__ and newplot functions to avoid creating unnecessary axes. Rik <rik@octave.org> parents: 16076 diff changeset	68 ##
08dd9458684a Overhaul __plt_get_axis_arg__ and newplot functions to avoid creating unnecessary axes. Rik <rik@octave.org> parents: 16076 diff changeset	69 ## The optional return value @var{hax} is a graphics handle to the created
08dd9458684a Overhaul __plt_get_axis_arg__ and newplot functions to avoid creating unnecessary axes. Rik <rik@octave.org> parents: 16076 diff changeset	70 ## axes object (not figure).
08dd9458684a Overhaul __plt_get_axis_arg__ and newplot functions to avoid creating unnecessary axes. Rik <rik@octave.org> parents: 16076 diff changeset	71 ##
08dd9458684a Overhaul __plt_get_axis_arg__ and newplot functions to avoid creating unnecessary axes. Rik <rik@octave.org> parents: 16076 diff changeset	72 ## @strong{Caution:} Calling @code{newplot} may change the current figure and
08dd9458684a Overhaul __plt_get_axis_arg__ and newplot functions to avoid creating unnecessary axes. Rik <rik@octave.org> parents: 16076 diff changeset	73 ## current axis.
6257 44c91c5dfe1d [project @ 2007-01-30 19:16:52 by jwe] jwe parents: diff changeset	74 ## @end deftypefn
44c91c5dfe1d [project @ 2007-01-30 19:16:52 by jwe] jwe parents: diff changeset	75
17036 08dd9458684a Overhaul __plt_get_axis_arg__ and newplot functions to avoid creating unnecessary axes. Rik <rik@octave.org> parents: 16076 diff changeset	76 ## FIXME: The Matlab function takes an optional list of file handles, hsave,
08dd9458684a Overhaul __plt_get_axis_arg__ and newplot functions to avoid creating unnecessary axes. Rik <rik@octave.org> parents: 16076 diff changeset	77 ## which are not deleted when the figure and axes are prepared.
08dd9458684a Overhaul __plt_get_axis_arg__ and newplot functions to avoid creating unnecessary axes. Rik <rik@octave.org> parents: 16076 diff changeset	78 ## I'm sure there is a good reason for that, but coding such
08dd9458684a Overhaul __plt_get_axis_arg__ and newplot functions to avoid creating unnecessary axes. Rik <rik@octave.org> parents: 16076 diff changeset	79 ## compatibility is really tricky and doesn't serve much purpose since
17126 eaab03308c0b doc: Rewrite docstrings for most plot functions. Rik <rik@octave.org> parents: 17036 diff changeset	80 ## newplot is nearly exclusively used by Octave's internal plotting
17036 08dd9458684a Overhaul __plt_get_axis_arg__ and newplot functions to avoid creating unnecessary axes. Rik <rik@octave.org> parents: 16076 diff changeset	81 ## functions. In Octave's case the argument is almost always null,
08dd9458684a Overhaul __plt_get_axis_arg__ and newplot functions to avoid creating unnecessary axes. Rik <rik@octave.org> parents: 16076 diff changeset	82 ## or occasionally the axis handle to plot into.
08dd9458684a Overhaul __plt_get_axis_arg__ and newplot functions to avoid creating unnecessary axes. Rik <rik@octave.org> parents: 16076 diff changeset	83
08dd9458684a Overhaul __plt_get_axis_arg__ and newplot functions to avoid creating unnecessary axes. Rik <rik@octave.org> parents: 16076 diff changeset	84 function hax = newplot (hsave = [])
08dd9458684a Overhaul __plt_get_axis_arg__ and newplot functions to avoid creating unnecessary axes. Rik <rik@octave.org> parents: 16076 diff changeset	85
08dd9458684a Overhaul __plt_get_axis_arg__ and newplot functions to avoid creating unnecessary axes. Rik <rik@octave.org> parents: 16076 diff changeset	86 if (nargin > 1)
08dd9458684a Overhaul __plt_get_axis_arg__ and newplot functions to avoid creating unnecessary axes. Rik <rik@octave.org> parents: 16076 diff changeset	87 print_usage ();
08dd9458684a Overhaul __plt_get_axis_arg__ and newplot functions to avoid creating unnecessary axes. Rik <rik@octave.org> parents: 16076 diff changeset	88 endif
6257 44c91c5dfe1d [project @ 2007-01-30 19:16:52 by jwe] jwe parents: diff changeset	89
17036 08dd9458684a Overhaul __plt_get_axis_arg__ and newplot functions to avoid creating unnecessary axes. Rik <rik@octave.org> parents: 16076 diff changeset	90 cf = [];
08dd9458684a Overhaul __plt_get_axis_arg__ and newplot functions to avoid creating unnecessary axes. Rik <rik@octave.org> parents: 16076 diff changeset	91 ca = [];
08dd9458684a Overhaul __plt_get_axis_arg__ and newplot functions to avoid creating unnecessary axes. Rik <rik@octave.org> parents: 16076 diff changeset	92
08dd9458684a Overhaul __plt_get_axis_arg__ and newplot functions to avoid creating unnecessary axes. Rik <rik@octave.org> parents: 16076 diff changeset	93 if (! isempty (hsave))
08dd9458684a Overhaul __plt_get_axis_arg__ and newplot functions to avoid creating unnecessary axes. Rik <rik@octave.org> parents: 16076 diff changeset	94 ## Find the first valid axes
08dd9458684a Overhaul __plt_get_axis_arg__ and newplot functions to avoid creating unnecessary axes. Rik <rik@octave.org> parents: 16076 diff changeset	95 ca = ancestor (hsave, "axes", "toplevel");
08dd9458684a Overhaul __plt_get_axis_arg__ and newplot functions to avoid creating unnecessary axes. Rik <rik@octave.org> parents: 16076 diff changeset	96 ca = ca(find (ca, 1));
08dd9458684a Overhaul __plt_get_axis_arg__ and newplot functions to avoid creating unnecessary axes. Rik <rik@octave.org> parents: 16076 diff changeset	97 ## Next, find the figure associated with any axis found
08dd9458684a Overhaul __plt_get_axis_arg__ and newplot functions to avoid creating unnecessary axes. Rik <rik@octave.org> parents: 16076 diff changeset	98 if (! isempty (ca))
08dd9458684a Overhaul __plt_get_axis_arg__ and newplot functions to avoid creating unnecessary axes. Rik <rik@octave.org> parents: 16076 diff changeset	99 cf = ancestor (ca, "figure", "toplevel");
08dd9458684a Overhaul __plt_get_axis_arg__ and newplot functions to avoid creating unnecessary axes. Rik <rik@octave.org> parents: 16076 diff changeset	100 else
08dd9458684a Overhaul __plt_get_axis_arg__ and newplot functions to avoid creating unnecessary axes. Rik <rik@octave.org> parents: 16076 diff changeset	101 cf = ancestor (hsave, "figure", "toplevel");
08dd9458684a Overhaul __plt_get_axis_arg__ and newplot functions to avoid creating unnecessary axes. Rik <rik@octave.org> parents: 16076 diff changeset	102 cf = cf(find (cf, 1));
08dd9458684a Overhaul __plt_get_axis_arg__ and newplot functions to avoid creating unnecessary axes. Rik <rik@octave.org> parents: 16076 diff changeset	103 endif
08dd9458684a Overhaul __plt_get_axis_arg__ and newplot functions to avoid creating unnecessary axes. Rik <rik@octave.org> parents: 16076 diff changeset	104 endif
08dd9458684a Overhaul __plt_get_axis_arg__ and newplot functions to avoid creating unnecessary axes. Rik <rik@octave.org> parents: 16076 diff changeset	105
08dd9458684a Overhaul __plt_get_axis_arg__ and newplot functions to avoid creating unnecessary axes. Rik <rik@octave.org> parents: 16076 diff changeset	106 if (isempty (cf))
08dd9458684a Overhaul __plt_get_axis_arg__ and newplot functions to avoid creating unnecessary axes. Rik <rik@octave.org> parents: 16076 diff changeset	107 ## get current figure, or create a new one if necessary
6257 44c91c5dfe1d [project @ 2007-01-30 19:16:52 by jwe] jwe parents: diff changeset	108 cf = gcf ();
17036 08dd9458684a Overhaul __plt_get_axis_arg__ and newplot functions to avoid creating unnecessary axes. Rik <rik@octave.org> parents: 16076 diff changeset	109 else
08dd9458684a Overhaul __plt_get_axis_arg__ and newplot functions to avoid creating unnecessary axes. Rik <rik@octave.org> parents: 16076 diff changeset	110 ## switch to figure provided without causing other updates
08dd9458684a Overhaul __plt_get_axis_arg__ and newplot functions to avoid creating unnecessary axes. Rik <rik@octave.org> parents: 16076 diff changeset	111 set (0, "currentfigure", cf);
08dd9458684a Overhaul __plt_get_axis_arg__ and newplot functions to avoid creating unnecessary axes. Rik <rik@octave.org> parents: 16076 diff changeset	112 endif
08dd9458684a Overhaul __plt_get_axis_arg__ and newplot functions to avoid creating unnecessary axes. Rik <rik@octave.org> parents: 16076 diff changeset	113
08dd9458684a Overhaul __plt_get_axis_arg__ and newplot functions to avoid creating unnecessary axes. Rik <rik@octave.org> parents: 16076 diff changeset	114 fnp = get (cf, "nextplot");
08dd9458684a Overhaul __plt_get_axis_arg__ and newplot functions to avoid creating unnecessary axes. Rik <rik@octave.org> parents: 16076 diff changeset	115 switch (fnp)
08dd9458684a Overhaul __plt_get_axis_arg__ and newplot functions to avoid creating unnecessary axes. Rik <rik@octave.org> parents: 16076 diff changeset	116 case "add"
08dd9458684a Overhaul __plt_get_axis_arg__ and newplot functions to avoid creating unnecessary axes. Rik <rik@octave.org> parents: 16076 diff changeset	117 ## Default case. Doesn't require action.
08dd9458684a Overhaul __plt_get_axis_arg__ and newplot functions to avoid creating unnecessary axes. Rik <rik@octave.org> parents: 16076 diff changeset	118 case "new"
08dd9458684a Overhaul __plt_get_axis_arg__ and newplot functions to avoid creating unnecessary axes. Rik <rik@octave.org> parents: 16076 diff changeset	119 ## Ordinarily, create a new figure to hold plot.
08dd9458684a Overhaul __plt_get_axis_arg__ and newplot functions to avoid creating unnecessary axes. Rik <rik@octave.org> parents: 16076 diff changeset	120 ## But, if user has requested preparing a specific axis, then
08dd9458684a Overhaul __plt_get_axis_arg__ and newplot functions to avoid creating unnecessary axes. Rik <rik@octave.org> parents: 16076 diff changeset	121 ## use the existing figure to hold the requested axis.
08dd9458684a Overhaul __plt_get_axis_arg__ and newplot functions to avoid creating unnecessary axes. Rik <rik@octave.org> parents: 16076 diff changeset	122 if (isempty (ca))
08dd9458684a Overhaul __plt_get_axis_arg__ and newplot functions to avoid creating unnecessary axes. Rik <rik@octave.org> parents: 16076 diff changeset	123 cf = figure ();
08dd9458684a Overhaul __plt_get_axis_arg__ and newplot functions to avoid creating unnecessary axes. Rik <rik@octave.org> parents: 16076 diff changeset	124 endif
08dd9458684a Overhaul __plt_get_axis_arg__ and newplot functions to avoid creating unnecessary axes. Rik <rik@octave.org> parents: 16076 diff changeset	125 case "replacechildren"
08dd9458684a Overhaul __plt_get_axis_arg__ and newplot functions to avoid creating unnecessary axes. Rik <rik@octave.org> parents: 16076 diff changeset	126 kids = get (cf, "children");
08dd9458684a Overhaul __plt_get_axis_arg__ and newplot functions to avoid creating unnecessary axes. Rik <rik@octave.org> parents: 16076 diff changeset	127 if (! isempty (ca))
08dd9458684a Overhaul __plt_get_axis_arg__ and newplot functions to avoid creating unnecessary axes. Rik <rik@octave.org> parents: 16076 diff changeset	128 kids(kids == ca) = [];
08dd9458684a Overhaul __plt_get_axis_arg__ and newplot functions to avoid creating unnecessary axes. Rik <rik@octave.org> parents: 16076 diff changeset	129 endif
08dd9458684a Overhaul __plt_get_axis_arg__ and newplot functions to avoid creating unnecessary axes. Rik <rik@octave.org> parents: 16076 diff changeset	130 delete (kids);
08dd9458684a Overhaul __plt_get_axis_arg__ and newplot functions to avoid creating unnecessary axes. Rik <rik@octave.org> parents: 16076 diff changeset	131 case "replace"
08dd9458684a Overhaul __plt_get_axis_arg__ and newplot functions to avoid creating unnecessary axes. Rik <rik@octave.org> parents: 16076 diff changeset	132 kids = allchild (cf);
08dd9458684a Overhaul __plt_get_axis_arg__ and newplot functions to avoid creating unnecessary axes. Rik <rik@octave.org> parents: 16076 diff changeset	133 if (! isempty (ca))
08dd9458684a Overhaul __plt_get_axis_arg__ and newplot functions to avoid creating unnecessary axes. Rik <rik@octave.org> parents: 16076 diff changeset	134 kids(kids == ca) = [];
08dd9458684a Overhaul __plt_get_axis_arg__ and newplot functions to avoid creating unnecessary axes. Rik <rik@octave.org> parents: 16076 diff changeset	135 endif
08dd9458684a Overhaul __plt_get_axis_arg__ and newplot functions to avoid creating unnecessary axes. Rik <rik@octave.org> parents: 16076 diff changeset	136 delete (kids);
08dd9458684a Overhaul __plt_get_axis_arg__ and newplot functions to avoid creating unnecessary axes. Rik <rik@octave.org> parents: 16076 diff changeset	137 reset (cf);
08dd9458684a Overhaul __plt_get_axis_arg__ and newplot functions to avoid creating unnecessary axes. Rik <rik@octave.org> parents: 16076 diff changeset	138 endswitch
08dd9458684a Overhaul __plt_get_axis_arg__ and newplot functions to avoid creating unnecessary axes. Rik <rik@octave.org> parents: 16076 diff changeset	139 set (cf, "nextplot", "add"); # Matlab compatibility
08dd9458684a Overhaul __plt_get_axis_arg__ and newplot functions to avoid creating unnecessary axes. Rik <rik@octave.org> parents: 16076 diff changeset	140
08dd9458684a Overhaul __plt_get_axis_arg__ and newplot functions to avoid creating unnecessary axes. Rik <rik@octave.org> parents: 16076 diff changeset	141 if (isempty (ca))
6257 44c91c5dfe1d [project @ 2007-01-30 19:16:52 by jwe] jwe parents: diff changeset	142 ca = gca ();
17036 08dd9458684a Overhaul __plt_get_axis_arg__ and newplot functions to avoid creating unnecessary axes. Rik <rik@octave.org> parents: 16076 diff changeset	143 else
08dd9458684a Overhaul __plt_get_axis_arg__ and newplot functions to avoid creating unnecessary axes. Rik <rik@octave.org> parents: 16076 diff changeset	144 set (cf, "currentaxes", ca);
08dd9458684a Overhaul __plt_get_axis_arg__ and newplot functions to avoid creating unnecessary axes. Rik <rik@octave.org> parents: 16076 diff changeset	145 endif
08dd9458684a Overhaul __plt_get_axis_arg__ and newplot functions to avoid creating unnecessary axes. Rik <rik@octave.org> parents: 16076 diff changeset	146
08dd9458684a Overhaul __plt_get_axis_arg__ and newplot functions to avoid creating unnecessary axes. Rik <rik@octave.org> parents: 16076 diff changeset	147 ## FIXME: Is this necessary anymore?
08dd9458684a Overhaul __plt_get_axis_arg__ and newplot functions to avoid creating unnecessary axes. Rik <rik@octave.org> parents: 16076 diff changeset	148 ## It seems like a kluge that belongs somewhere else.
08dd9458684a Overhaul __plt_get_axis_arg__ and newplot functions to avoid creating unnecessary axes. Rik <rik@octave.org> parents: 16076 diff changeset	149 if (strcmp (get (ca, "__hold_all__"), "off"))
08dd9458684a Overhaul __plt_get_axis_arg__ and newplot functions to avoid creating unnecessary axes. Rik <rik@octave.org> parents: 16076 diff changeset	150 __next_line_color__ (true);
08dd9458684a Overhaul __plt_get_axis_arg__ and newplot functions to avoid creating unnecessary axes. Rik <rik@octave.org> parents: 16076 diff changeset	151 __next_line_style__ (true);
6257 44c91c5dfe1d [project @ 2007-01-30 19:16:52 by jwe] jwe parents: diff changeset	152 else
17036 08dd9458684a Overhaul __plt_get_axis_arg__ and newplot functions to avoid creating unnecessary axes. Rik <rik@octave.org> parents: 16076 diff changeset	153 __next_line_color__ (false);
08dd9458684a Overhaul __plt_get_axis_arg__ and newplot functions to avoid creating unnecessary axes. Rik <rik@octave.org> parents: 16076 diff changeset	154 __next_line_style__ (false);
08dd9458684a Overhaul __plt_get_axis_arg__ and newplot functions to avoid creating unnecessary axes. Rik <rik@octave.org> parents: 16076 diff changeset	155 endif
08dd9458684a Overhaul __plt_get_axis_arg__ and newplot functions to avoid creating unnecessary axes. Rik <rik@octave.org> parents: 16076 diff changeset	156
08dd9458684a Overhaul __plt_get_axis_arg__ and newplot functions to avoid creating unnecessary axes. Rik <rik@octave.org> parents: 16076 diff changeset	157 anp = get (ca, "nextplot");
08dd9458684a Overhaul __plt_get_axis_arg__ and newplot functions to avoid creating unnecessary axes. Rik <rik@octave.org> parents: 16076 diff changeset	158 switch (anp)
08dd9458684a Overhaul __plt_get_axis_arg__ and newplot functions to avoid creating unnecessary axes. Rik <rik@octave.org> parents: 16076 diff changeset	159 case "add"
08dd9458684a Overhaul __plt_get_axis_arg__ and newplot functions to avoid creating unnecessary axes. Rik <rik@octave.org> parents: 16076 diff changeset	160 ## Default case. Doesn't require action.
08dd9458684a Overhaul __plt_get_axis_arg__ and newplot functions to avoid creating unnecessary axes. Rik <rik@octave.org> parents: 16076 diff changeset	161 case "replacechildren"
08dd9458684a Overhaul __plt_get_axis_arg__ and newplot functions to avoid creating unnecessary axes. Rik <rik@octave.org> parents: 16076 diff changeset	162 delete (get (ca, "children"));
08dd9458684a Overhaul __plt_get_axis_arg__ and newplot functions to avoid creating unnecessary axes. Rik <rik@octave.org> parents: 16076 diff changeset	163 case "replace"
08dd9458684a Overhaul __plt_get_axis_arg__ and newplot functions to avoid creating unnecessary axes. Rik <rik@octave.org> parents: 16076 diff changeset	164 __go_axes_init__ (ca, "replace");
08dd9458684a Overhaul __plt_get_axis_arg__ and newplot functions to avoid creating unnecessary axes. Rik <rik@octave.org> parents: 16076 diff changeset	165 __request_drawnow__ ();
08dd9458684a Overhaul __plt_get_axis_arg__ and newplot functions to avoid creating unnecessary axes. Rik <rik@octave.org> parents: 16076 diff changeset	166 ## FIXME: The code above should perform the following:
08dd9458684a Overhaul __plt_get_axis_arg__ and newplot functions to avoid creating unnecessary axes. Rik <rik@octave.org> parents: 16076 diff changeset	167 ###########################
08dd9458684a Overhaul __plt_get_axis_arg__ and newplot functions to avoid creating unnecessary axes. Rik <rik@octave.org> parents: 16076 diff changeset	168 ## delete (allchild (ca));
08dd9458684a Overhaul __plt_get_axis_arg__ and newplot functions to avoid creating unnecessary axes. Rik <rik@octave.org> parents: 16076 diff changeset	169 ## reset (ca);
08dd9458684a Overhaul __plt_get_axis_arg__ and newplot functions to avoid creating unnecessary axes. Rik <rik@octave.org> parents: 16076 diff changeset	170 ###########################
08dd9458684a Overhaul __plt_get_axis_arg__ and newplot functions to avoid creating unnecessary axes. Rik <rik@octave.org> parents: 16076 diff changeset	171 ## Actually, __go_axes_init__ does both less and more.
08dd9458684a Overhaul __plt_get_axis_arg__ and newplot functions to avoid creating unnecessary axes. Rik <rik@octave.org> parents: 16076 diff changeset	172 ## It doesn't really remove all children since it re-instantiates
08dd9458684a Overhaul __plt_get_axis_arg__ and newplot functions to avoid creating unnecessary axes. Rik <rik@octave.org> parents: 16076 diff changeset	173 ## xlabel, ylabel, zlabel, and title text objects.
08dd9458684a Overhaul __plt_get_axis_arg__ and newplot functions to avoid creating unnecessary axes. Rik <rik@octave.org> parents: 16076 diff changeset	174 ## Also it preserves font properties like fontsize.
08dd9458684a Overhaul __plt_get_axis_arg__ and newplot functions to avoid creating unnecessary axes. Rik <rik@octave.org> parents: 16076 diff changeset	175 ## For the time being, in order to have axis labels and title work,
08dd9458684a Overhaul __plt_get_axis_arg__ and newplot functions to avoid creating unnecessary axes. Rik <rik@octave.org> parents: 16076 diff changeset	176 ## the above code is is required.
08dd9458684a Overhaul __plt_get_axis_arg__ and newplot functions to avoid creating unnecessary axes. Rik <rik@octave.org> parents: 16076 diff changeset	177 endswitch
08dd9458684a Overhaul __plt_get_axis_arg__ and newplot functions to avoid creating unnecessary axes. Rik <rik@octave.org> parents: 16076 diff changeset	178
08dd9458684a Overhaul __plt_get_axis_arg__ and newplot functions to avoid creating unnecessary axes. Rik <rik@octave.org> parents: 16076 diff changeset	179 if (nargout > 0)
08dd9458684a Overhaul __plt_get_axis_arg__ and newplot functions to avoid creating unnecessary axes. Rik <rik@octave.org> parents: 16076 diff changeset	180 hax = ca;
6257 44c91c5dfe1d [project @ 2007-01-30 19:16:52 by jwe] jwe parents: diff changeset	181 endif
8252 b12a2975bf7e newplot.m: delete stray debugging code John W. Eaton <jwe@octave.org> parents: 8228 diff changeset	182
6257 44c91c5dfe1d [project @ 2007-01-30 19:16:52 by jwe] jwe parents: diff changeset	183 endfunction
13204 be7bfd59300a Add tests for scripts/plot Kai Habel <kai.habel@gmx.de> parents: 11589 diff changeset	184
14363 f3d52523cde1 Use Octave coding conventions in all m-file %!test blocks Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	185
13204 be7bfd59300a Add tests for scripts/plot Kai Habel <kai.habel@gmx.de> parents: 11589 diff changeset	186 %!test
be7bfd59300a Add tests for scripts/plot Kai Habel <kai.habel@gmx.de> parents: 11589 diff changeset	187 %! hf = figure ("visible", "off");
be7bfd59300a Add tests for scripts/plot Kai Habel <kai.habel@gmx.de> parents: 11589 diff changeset	188 %! unwind_protect
be7bfd59300a Add tests for scripts/plot Kai Habel <kai.habel@gmx.de> parents: 11589 diff changeset	189 %! p = plot ([0, 1]);
17036 08dd9458684a Overhaul __plt_get_axis_arg__ and newplot functions to avoid creating unnecessary axes. Rik <rik@octave.org> parents: 16076 diff changeset	190 %! hax = newplot ();
08dd9458684a Overhaul __plt_get_axis_arg__ and newplot functions to avoid creating unnecessary axes. Rik <rik@octave.org> parents: 16076 diff changeset	191 %! assert (hax, gca);
13204 be7bfd59300a Add tests for scripts/plot Kai Habel <kai.habel@gmx.de> parents: 11589 diff changeset	192 %! assert (isempty (get (gca, "children")));
be7bfd59300a Add tests for scripts/plot Kai Habel <kai.habel@gmx.de> parents: 11589 diff changeset	193 %! unwind_protect_cleanup
be7bfd59300a Add tests for scripts/plot Kai Habel <kai.habel@gmx.de> parents: 11589 diff changeset	194 %! close (hf);
be7bfd59300a Add tests for scripts/plot Kai Habel <kai.habel@gmx.de> parents: 11589 diff changeset	195 %! end_unwind_protect
14363 f3d52523cde1 Use Octave coding conventions in all m-file %!test blocks Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	196

Mercurial > hg > octave-lyh

annotate scripts/plot/newplot.m @ 17126:eaab03308c0b