Mercurial > octave-nkf

comparison scripts/plot/util/hold.m @ 17572:7bb76a22cde1

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
maint: Split scripts/plot directory into 4 pieces. scripts/gui : user-interface functions scripts/plot/appearance : functions controlling plot appearance scripts/plot/draw : plotting functions which produce graphs scripts/plot/util : low-level plotting functions and utilities. * scripts/gui/guidata.m, scripts/gui/guihandles.m, scripts/gui/module.mk, scripts/gui/private/__file_filter__.m, scripts/gui/private/__fltk_file_filter__.m, scripts/gui/private/__is_function__.m, scripts/gui/private/__uigetdir_fltk__.m, scripts/gui/private/__uigetfile_fltk__.m, scripts/gui/private/__uiobject_split_args__.m, scripts/gui/private/__uiputfile_fltk__.m, scripts/gui/uicontextmenu.m, scripts/gui/uicontrol.m, scripts/gui/uigetdir.m, scripts/gui/uigetfile.m, scripts/gui/uimenu.m, scripts/gui/uipanel.m, scripts/gui/uipushtool.m, scripts/gui/uiputfile.m, scripts/gui/uiresume.m, scripts/gui/uitoggletool.m, scripts/gui/uitoolbar.m, scripts/gui/uiwait.m, scripts/gui/waitbar.m, scripts/gui/waitforbuttonpress.m: Moved from scripts/plot to scripts/gui * scripts/plot/appearance/__clabel__.m, scripts/plot/appearance/__getlegenddata__.m, scripts/plot/appearance/axis.m, scripts/plot/appearance/box.m, scripts/plot/appearance/caxis.m, scripts/plot/appearance/clabel.m, scripts/plot/appearance/daspect.m, scripts/plot/appearance/diffuse.m, scripts/plot/appearance/grid.m, scripts/plot/appearance/gtext.m, scripts/plot/appearance/hidden.m, scripts/plot/appearance/legend.m, scripts/plot/appearance/orient.m, scripts/plot/appearance/pbaspect.m, scripts/plot/appearance/private/__axis_label__.m, scripts/plot/appearance/private/__axis_limits__.m, scripts/plot/appearance/shading.m, scripts/plot/appearance/specular.m, scripts/plot/appearance/text.m, scripts/plot/appearance/title.m, scripts/plot/appearance/view.m, scripts/plot/appearance/whitebg.m, scripts/plot/appearance/xlabel.m, scripts/plot/appearance/xlim.m, scripts/plot/appearance/ylabel.m, scripts/plot/appearance/ylim.m, scripts/plot/appearance/zlabel.m, scripts/plot/appearance/zlim.m: Moved from scripts/plot to subdir appearance. * scripts/plot/draw/area.m, scripts/plot/draw/bar.m, scripts/plot/draw/barh.m, scripts/plot/draw/colorbar.m, scripts/plot/draw/comet.m, scripts/plot/draw/comet3.m, scripts/plot/draw/compass.m, scripts/plot/draw/contour.m, scripts/plot/draw/contour3.m, scripts/plot/draw/contourc.m, scripts/plot/draw/contourf.m, scripts/plot/draw/cylinder.m, scripts/plot/draw/ellipsoid.m, scripts/plot/draw/errorbar.m, scripts/plot/draw/ezcontour.m, scripts/plot/draw/ezcontourf.m, scripts/plot/draw/ezmesh.m, scripts/plot/draw/ezmeshc.m, scripts/plot/draw/ezplot.m, scripts/plot/draw/ezplot3.m, scripts/plot/draw/ezpolar.m, scripts/plot/draw/ezsurf.m, scripts/plot/draw/ezsurfc.m, scripts/plot/draw/feather.m, scripts/plot/draw/fill.m, scripts/plot/draw/fplot.m, scripts/plot/draw/hist.m, scripts/plot/draw/isocolors.m, scripts/plot/draw/isonormals.m, scripts/plot/draw/isosurface.m, scripts/plot/draw/line.m, scripts/plot/draw/loglog.m, scripts/plot/draw/loglogerr.m, scripts/plot/draw/mesh.m, scripts/plot/draw/meshc.m, scripts/plot/draw/meshz.m, scripts/plot/draw/pareto.m, scripts/plot/draw/patch.m, scripts/plot/draw/pcolor.m, scripts/plot/draw/peaks.m, scripts/plot/draw/pie.m, scripts/plot/draw/pie3.m, scripts/plot/draw/plot.m, scripts/plot/draw/plot3.m, scripts/plot/draw/plotmatrix.m, scripts/plot/draw/plotyy.m, scripts/plot/draw/polar.m, scripts/plot/draw/private/__add_datasource__.m, scripts/plot/draw/private/__bar__.m, scripts/plot/draw/private/__contour__.m, scripts/plot/draw/private/__errcomm__.m, scripts/plot/draw/private/__errplot__.m, scripts/plot/draw/private/__ezplot__.m, scripts/plot/draw/private/__interp_cube__.m, scripts/plot/draw/private/__line__.m, scripts/plot/draw/private/__marching_cube__.m, scripts/plot/draw/private/__patch__.m, scripts/plot/draw/private/__pie__.m, scripts/plot/draw/private/__plt__.m, scripts/plot/draw/private/__quiver__.m, scripts/plot/draw/private/__scatter__.m, scripts/plot/draw/private/__stem__.m, scripts/plot/draw/quiver.m, scripts/plot/draw/quiver3.m, scripts/plot/draw/rectangle.m, scripts/plot/draw/ribbon.m, scripts/plot/draw/rose.m, scripts/plot/draw/scatter.m, scripts/plot/draw/scatter3.m, scripts/plot/draw/semilogx.m, scripts/plot/draw/semilogxerr.m, scripts/plot/draw/semilogy.m, scripts/plot/draw/semilogyerr.m, scripts/plot/draw/shrinkfaces.m, scripts/plot/draw/slice.m, scripts/plot/draw/sombrero.m, scripts/plot/draw/sphere.m, scripts/plot/draw/stairs.m, scripts/plot/draw/stem.m, scripts/plot/draw/stem3.m, scripts/plot/draw/stemleaf.m, scripts/plot/draw/surf.m, scripts/plot/draw/surface.m, scripts/plot/draw/surfc.m, scripts/plot/draw/surfl.m, scripts/plot/draw/surfnorm.m, scripts/plot/draw/tetramesh.m, scripts/plot/draw/trimesh.m, scripts/plot/draw/triplot.m, scripts/plot/draw/trisurf.m, scripts/plot/draw/waterfall.m: Moved from plot/ to subdir draw. * scripts/plot/util/__actual_axis_position__.m, scripts/plot/util/__default_plot_options__.m, scripts/plot/util/__gnuplot_drawnow__.m, scripts/plot/util/__next_line_color__.m, scripts/plot/util/__next_line_style__.m, scripts/plot/util/__plt_get_axis_arg__.m, scripts/plot/util/__pltopt__.m, scripts/plot/util/allchild.m, scripts/plot/util/ancestor.m, scripts/plot/util/axes.m, scripts/plot/util/cla.m, scripts/plot/util/clf.m, scripts/plot/util/close.m, scripts/plot/util/closereq.m, scripts/plot/util/colstyle.m, scripts/plot/util/copyobj.m, scripts/plot/util/figure.m, scripts/plot/util/findall.m, scripts/plot/util/findfigs.m, scripts/plot/util/findobj.m, scripts/plot/util/gca.m, scripts/plot/util/gcbf.m, scripts/plot/util/gcbo.m, scripts/plot/util/gcf.m, scripts/plot/util/gco.m, scripts/plot/util/ginput.m, scripts/plot/util/gnuplot_binary.in, scripts/plot/util/graphics_toolkit.m, scripts/plot/util/hdl2struct.m, scripts/plot/util/hggroup.m, scripts/plot/util/hold.m, scripts/plot/util/isaxes.m, scripts/plot/util/isfigure.m, scripts/plot/util/ishghandle.m, scripts/plot/util/ishold.m, scripts/plot/util/isprop.m, scripts/plot/util/linkprop.m, scripts/plot/util/meshgrid.m, scripts/plot/util/ndgrid.m, scripts/plot/util/newplot.m, scripts/plot/util/print.m, scripts/plot/util/printd.m, scripts/plot/util/private/__add_default_menu__.m, scripts/plot/util/private/__fltk_ginput__.m, scripts/plot/util/private/__fltk_print__.m, scripts/plot/util/private/__ghostscript__.m, scripts/plot/util/private/__gnuplot_get_var__.m, scripts/plot/util/private/__gnuplot_ginput__.m, scripts/plot/util/private/__gnuplot_has_feature__.m, scripts/plot/util/private/__gnuplot_has_terminal__.m, scripts/plot/util/private/__gnuplot_open_stream__.m, scripts/plot/util/private/__gnuplot_print__.m, scripts/plot/util/private/__gnuplot_version__.m, scripts/plot/util/private/__go_draw_axes__.m, scripts/plot/util/private/__go_draw_figure__.m, scripts/plot/util/private/__print_parse_opts__.m, scripts/plot/util/private/__tight_eps_bbox__.m, scripts/plot/util/refresh.m, scripts/plot/util/refreshdata.m, scripts/plot/util/saveas.m, scripts/plot/util/shg.m, scripts/plot/util/struct2hdl.m, scripts/plot/util/subplot.m: Moved from plot to subdir util. * etc/HACKING: Updated directory structure info. * scripts/Makefile.am, scripts/plot/appearance/module.mk, scripts/plot/draw/module.mk, scripts/plot/util/module.mk: Added new directories to build system.
author Rik <rik@octave.org>
date Fri, 04 Oct 2013 17:09:08 -0700
parents scripts/plot/hold.m@bc924baa2c4e
children d63878346099
comparison
equal deleted inserted replaced
17571:6e4ea5c8a4bb 17572:7bb76a22cde1
1 ## Copyright (C) 2005-2012 John W. Eaton
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
7 ## the Free Software Foundation; either version 3 of the License, or (at
8 ## your option) any later version.
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
16 ## along with Octave; see the file COPYING. If not, see
17 ## <http://www.gnu.org/licenses/>.
18
19 ## -*- texinfo -*-
20 ## @deftypefn {Command} {} hold
21 ## @deftypefnx {Command} {} hold on
22 ## @deftypefnx {Command} {} hold off
23 ## @deftypefnx {Command} {} hold all
24 ## @deftypefnx {Function File} {} hold (@var{hax}, @dots{})
25 ## Toggle or set the @qcode{"hold"} state of the plotting engine which
26 ## determines whether new graphic objects are added to the plot or replace
27 ## the existing objects.
28 ##
29 ## @table @code
30 ## @item hold on
31 ## Retain plot data and settings so that subsequent plot commands are displayed
32 ## on a single graph.
33 ##
34 ## @item hold all
35 ## Retain plot line color, line style, data, and settings so that subsequent
36 ## plot commands are displayed on a single graph with the next line color and
37 ## style.
38 ##
39 ## @item hold off
40 ## Restore default graphics settings which clear the graph and reset axis
41 ## properties before each new plot command. (default).
42 ##
43 ## @item hold
44 ## Toggle the current hold state.
45 ## @end table
46 ##
47 ## When given the additional argument @var{hax}, the hold state is modified
48 ## for this axis rather than the current axes returned by @code{gca}.
49 ##
50 ## To query the current hold state use the @code{ishold} function.
51 ## @seealso{ishold, cla, clf, newplot}
52 ## @end deftypefn
53
54 function hold (varargin)
55
56 if (nargin > 0 && isscalar (varargin{1}) && isaxes (varargin{1}))
57 hax = varargin{1};
58 varargin(1) = [];
59 nargs = numel (varargin);
60 ## FIXME: Should this be ancestor (hax, "parent")?
61 hfig = get (hax, "parent");
62 elseif (nargin > 0 && numel (varargin{1}) > 1 && ishandle (varargin{1}))
63 print_usage ();
64 else
65 hax = gca ();
66 hfig = gcf ();
67 nargs = numel (varargin);
68 endif
69
70 hold_all = false;
71 if (nargs == 0)
72 turn_hold_off = ishold (hax);
73 elseif (nargs == 1)
74 state = tolower (varargin{1});
75 switch (state)
76 case "off"
77 turn_hold_off = true;
78 case "all"
79 turn_hold_off = false;
80 hold_all = true;
81 case "on"
82 turn_hold_off = false;
83 otherwise
84 error ("hold: invalid hold STATE");
85 endswitch
86 else
87 print_usage ();
88 endif
89
90 if (turn_hold_off)
91 set (hax, "nextplot", "replace");
92 else
93 set (hax, "nextplot", "add");
94 set (hfig, "nextplot", "add");
95 endif
96 set (hax, "__hold_all__", hold_all);
97
98 endfunction
99
100
101 %!demo
102 %! clf;
103 %! t = linspace (0, 2*pi, 100);
104 %! plot (t, sin (t));
105 %! hold on;
106 %! plot (t, cos (t));
107 %! title ({'hold on', '2 plots shown on same graph'});
108 %! hold off;
109
110 %!demo
111 %! clf;
112 %! t = linspace (0, 2*pi, 100);
113 %! plot (t, sin (t));
114 %! hold all;
115 %! plot (t, cos (t));
116 %! title ({'hold all', '2 plots shown on same graph with linestyle also preserved'});
117 %! hold off;
118
119 %!demo
120 %! clf;
121 %! A = rand (100);
122 %! [X, Y] = find (A > 0.95);
123 %! imshow (A);
124 %! hold on;
125 %! plot (X, Y, 'o');
126 %! hold off;
127 %! title ('hold with image and plot');
128
129 %!demo
130 %! clf;
131 %! colormap ('default');
132 %! hold on;
133 %! imagesc (1 ./ hilb (4));
134 %! plot (1:4, '-s');
135 %! hold off;
136
137 %!demo
138 %! clf;
139 %! colormap ('default');
140 %! hold on;
141 %! imagesc (1 ./ hilb (2));
142 %! imagesc (1 ./ hilb (4));
143 %! hold off;
144
145 %!demo
146 %! clf;
147 %! colormap ('default');
148 %! hold on;
149 %! plot (1:4, '-s');
150 %! imagesc (1 ./ hilb (4));
151 %! hold off;
152
153 %!demo
154 %! clf;
155 %! colormap ('default');
156 %! t = linspace (-3, 3, 50);
157 %! [x, y] = meshgrid (t, t);
158 %! z = peaks (x, y);
159 %! contourf (x, y, z, 10);
160 %! hold on;
161 %! plot (x(:), y(:), '^');
162 %! patch ([-1.0 1.0 1.0 -1.0 -1.0], [-1.0 -1.0 1.0 1.0 -1.0], 'red');
163 %! xlim ([-2.0 2.0]);
164 %! ylim ([-2.0 2.0]);
165 %! colorbar ('SouthOutside');
166 %! title ('Test script for some plot functions');
167
168 ## hold on test
169 %!test
170 %! hf = figure ("visible", "off");
171 %! unwind_protect
172 %! p = plot ([0 1]);
173 %! assert (! ishold);
174 %! hold on;
175 %! assert (ishold);
176 %! p1 = fill ([0 1 1], [0 0 1], "black");
177 %! p2 = fill ([0 1 0], [0 1 1], "red");
178 %! assert (length (get (hf, "children")), 1);
179 %! assert (length (get (gca, "children")), 3);
180 %! unwind_protect_cleanup
181 %! close (hf);
182 %! end_unwind_protect
183
184 ## hold off test
185 %!test
186 %! hf = figure ("visible", "off");
187 %! unwind_protect
188 %! p = plot ([0 1]);
189 %! assert (! ishold);
190 %! hold on;
191 %! assert (ishold);
192 %! p1 = fill ([0 1 1], [0 0 1], "black");
193 %! hold off;
194 %! p2 = fill ([0 1 0], [0 1 1], "red");
195 %! assert (length (get (hf, "children")), 1);
196 %! assert (length (get (gca, "children")), 1);
197 %! unwind_protect_cleanup
198 %! close (hf);
199 %! end_unwind_protect
200