Mercurial > hg > octave-nkf

annotate scripts/plot/refreshdata.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 5d3a684236b0
children b90915ba489d
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: 14092
diff changeset
1 ## Copyright (C) 2008-2012 David Bateman
8070
3b53b25e2550 Add data sources and line series
David Bateman <dbateman@free.fr>
parents:
diff changeset
2 ##
3b53b25e2550 Add data sources and line series
David Bateman <dbateman@free.fr>
parents:
diff changeset
3 ## This file is part of Octave.
3b53b25e2550 Add data sources and line series
David Bateman <dbateman@free.fr>
parents:
diff changeset
4 ##
3b53b25e2550 Add data sources and line series
David Bateman <dbateman@free.fr>
parents:
diff changeset
5 ## Octave is free software; you can redistribute it and/or modify it
3b53b25e2550 Add data sources and line series
David Bateman <dbateman@free.fr>
parents:
diff changeset
6 ## under the terms of the GNU General Public License as published by
3b53b25e2550 Add data sources and line series
David Bateman <dbateman@free.fr>
parents:
diff changeset
7 ## the Free Software Foundation; either version 3 of the License, or (at
3b53b25e2550 Add data sources and line series
David Bateman <dbateman@free.fr>
parents:
diff changeset
8 ## your option) any later version.
3b53b25e2550 Add data sources and line series
David Bateman <dbateman@free.fr>
parents:
diff changeset
9 ##
3b53b25e2550 Add data sources and line series
David Bateman <dbateman@free.fr>
parents:
diff changeset
10 ## Octave is distributed in the hope that it will be useful, but
3b53b25e2550 Add data sources and line series
David Bateman <dbateman@free.fr>
parents:
diff changeset
11 ## WITHOUT ANY WARRANTY; without even the implied warranty of
3b53b25e2550 Add data sources and line series
David Bateman <dbateman@free.fr>
parents:
diff changeset
12 ## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
3b53b25e2550 Add data sources and line series
David Bateman <dbateman@free.fr>
parents:
diff changeset
13 ## General Public License for more details.
3b53b25e2550 Add data sources and line series
David Bateman <dbateman@free.fr>
parents:
diff changeset
14 ##
3b53b25e2550 Add data sources and line series
David Bateman <dbateman@free.fr>
parents:
diff changeset
15 ## You should have received a copy of the GNU General Public License
3b53b25e2550 Add data sources and line series
David Bateman <dbateman@free.fr>
parents:
diff changeset
16 ## along with Octave; see the file COPYING. If not, see
3b53b25e2550 Add data sources and line series
David Bateman <dbateman@free.fr>
parents:
diff changeset
17 ## <http://www.gnu.org/licenses/>.
3b53b25e2550 Add data sources and line series
David Bateman <dbateman@free.fr>
parents:
diff changeset
18
3b53b25e2550 Add data sources and line series
David Bateman <dbateman@free.fr>
parents:
diff changeset
19 ## -*- texinfo -*-
9316
c539ec5726e7 Update some of Advanced Plotting documentation.
Rik <rdrider0-list@yahoo.com>
parents: 9245
diff changeset
20 ## @deftypefn {Function File} {} refreshdata ()
8070
3b53b25e2550 Add data sources and line series
David Bateman <dbateman@free.fr>
parents:
diff changeset
21 ## @deftypefnx {Function File} {} refreshdata (@var{h})
9316
c539ec5726e7 Update some of Advanced Plotting documentation.
Rik <rdrider0-list@yahoo.com>
parents: 9245
diff changeset
22 ## @deftypefnx {Function File} {} refreshdata (@var{h}, @var{workspace})
c539ec5726e7 Update some of Advanced Plotting documentation.
Rik <rdrider0-list@yahoo.com>
parents: 9245
diff changeset
23 ## Evaluate any @samp{datasource} properties of the current figure and update
17122
eaab03308c0b doc: Rewrite docstrings for most plot functions.
Rik <rik@octave.org>
parents: 14868
diff changeset
24 ## the plot if the corresponding data has changed.
eaab03308c0b doc: Rewrite docstrings for most plot functions.
Rik <rik@octave.org>
parents: 14868
diff changeset
25 ##
eaab03308c0b doc: Rewrite docstrings for most plot functions.
Rik <rik@octave.org>
parents: 14868
diff changeset
26 ## If the first argument @var{h} is a list of graphic handles, then operate
eaab03308c0b doc: Rewrite docstrings for most plot functions.
Rik <rik@octave.org>
parents: 14868
diff changeset
27 ## on these objects rather than the current figure returned by @code{gcf}.
eaab03308c0b doc: Rewrite docstrings for most plot functions.
Rik <rik@octave.org>
parents: 14868
diff changeset
28 ##
eaab03308c0b doc: Rewrite docstrings for most plot functions.
Rik <rik@octave.org>
parents: 14868
diff changeset
29 ## The optional second argument @var{workspace} can take the following values:
8070
3b53b25e2550 Add data sources and line series
David Bateman <dbateman@free.fr>
parents:
diff changeset
30 ##
11595
5ec6aa05638d Prevent doubled quotes around @table items in Info.
Rik <octave@nomad.inbox5.com>
parents: 11587
diff changeset
31 ## @table @asis
9316
c539ec5726e7 Update some of Advanced Plotting documentation.
Rik <rdrider0-list@yahoo.com>
parents: 9245
diff changeset
32 ## @item "base"
c539ec5726e7 Update some of Advanced Plotting documentation.
Rik <rdrider0-list@yahoo.com>
parents: 9245
diff changeset
33 ## Evaluate the datasource properties in the base workspace. (default).
10821
693e22af08ae Grammarcheck documentation of m-files
Rik <octave@nomad.inbox5.com>
parents: 10549
diff changeset
34 ##
9316
c539ec5726e7 Update some of Advanced Plotting documentation.
Rik <rdrider0-list@yahoo.com>
parents: 9245
diff changeset
35 ## @item "caller"
c539ec5726e7 Update some of Advanced Plotting documentation.
Rik <rdrider0-list@yahoo.com>
parents: 9245
diff changeset
36 ## Evaluate the datasource properties in the workspace of the function
c539ec5726e7 Update some of Advanced Plotting documentation.
Rik <rdrider0-list@yahoo.com>
parents: 9245
diff changeset
37 ## that called @code{refreshdata}.
c539ec5726e7 Update some of Advanced Plotting documentation.
Rik <rdrider0-list@yahoo.com>
parents: 9245
diff changeset
38 ## @end table
c539ec5726e7 Update some of Advanced Plotting documentation.
Rik <rdrider0-list@yahoo.com>
parents: 9245
diff changeset
39 ##
c539ec5726e7 Update some of Advanced Plotting documentation.
Rik <rdrider0-list@yahoo.com>
parents: 9245
diff changeset
40 ## An example of the use of @code{refreshdata} is:
8070
3b53b25e2550 Add data sources and line series
David Bateman <dbateman@free.fr>
parents:
diff changeset
41 ##
3b53b25e2550 Add data sources and line series
David Bateman <dbateman@free.fr>
parents:
diff changeset
42 ## @example
3b53b25e2550 Add data sources and line series
David Bateman <dbateman@free.fr>
parents:
diff changeset
43 ## @group
3b53b25e2550 Add data sources and line series
David Bateman <dbateman@free.fr>
parents:
diff changeset
44 ## x = 0:0.1:10;
3b53b25e2550 Add data sources and line series
David Bateman <dbateman@free.fr>
parents:
diff changeset
45 ## y = sin (x);
3b53b25e2550 Add data sources and line series
David Bateman <dbateman@free.fr>
parents:
diff changeset
46 ## plot (x, y, "ydatasource", "y");
3b53b25e2550 Add data sources and line series
David Bateman <dbateman@free.fr>
parents:
diff changeset
47 ## for i = 1 : 100
14327
4d917a6a858b doc: Use Octave coding conventions in @example blocks of docstrings.
Rik <octave@nomad.inbox5.com>
parents: 14138
diff changeset
48 ## pause (0.1);
4d917a6a858b doc: Use Octave coding conventions in @example blocks of docstrings.
Rik <octave@nomad.inbox5.com>
parents: 14138
diff changeset
49 ## y = sin (x + 0.1*i);
4d917a6a858b doc: Use Octave coding conventions in @example blocks of docstrings.
Rik <octave@nomad.inbox5.com>
parents: 14138
diff changeset
50 ## refreshdata ();
8070
3b53b25e2550 Add data sources and line series
David Bateman <dbateman@free.fr>
parents:
diff changeset
51 ## endfor
3b53b25e2550 Add data sources and line series
David Bateman <dbateman@free.fr>
parents:
diff changeset
52 ## @end group
3b53b25e2550 Add data sources and line series
David Bateman <dbateman@free.fr>
parents:
diff changeset
53 ## @end example
3b53b25e2550 Add data sources and line series
David Bateman <dbateman@free.fr>
parents:
diff changeset
54 ## @end deftypefn
3b53b25e2550 Add data sources and line series
David Bateman <dbateman@free.fr>
parents:
diff changeset
55
11469
c776f063fefe Overhaul m-script files to use common variable name between code and documentation.
Rik <octave@nomad.inbox5.com>
parents: 11032
diff changeset
56 function refreshdata (h, workspace)
8070
3b53b25e2550 Add data sources and line series
David Bateman <dbateman@free.fr>
parents:
diff changeset
57
3b53b25e2550 Add data sources and line series
David Bateman <dbateman@free.fr>
parents:
diff changeset
58 if (nargin == 0)
3b53b25e2550 Add data sources and line series
David Bateman <dbateman@free.fr>
parents:
diff changeset
59 h = gcf ();
11469
c776f063fefe Overhaul m-script files to use common variable name between code and documentation.
Rik <octave@nomad.inbox5.com>
parents: 11032
diff changeset
60 workspace = "base";
8070
3b53b25e2550 Add data sources and line series
David Bateman <dbateman@free.fr>
parents:
diff changeset
61 else
3b53b25e2550 Add data sources and line series
David Bateman <dbateman@free.fr>
parents:
diff changeset
62 if (iscell (h))
3b53b25e2550 Add data sources and line series
David Bateman <dbateman@free.fr>
parents:
diff changeset
63 h = [h{:}];
3b53b25e2550 Add data sources and line series
David Bateman <dbateman@free.fr>
parents:
diff changeset
64 endif
3b53b25e2550 Add data sources and line series
David Bateman <dbateman@free.fr>
parents:
diff changeset
65 if (!all (ishandle (h)) || !all (strcmp (get (h, "type"), "figure")))
3b53b25e2550 Add data sources and line series
David Bateman <dbateman@free.fr>
parents:
diff changeset
66 error ("refreshdata: expecting a list of figure handles");
3b53b25e2550 Add data sources and line series
David Bateman <dbateman@free.fr>
parents:
diff changeset
67 endif
3b53b25e2550 Add data sources and line series
David Bateman <dbateman@free.fr>
parents:
diff changeset
68 if (nargin < 2)
11469
c776f063fefe Overhaul m-script files to use common variable name between code and documentation.
Rik <octave@nomad.inbox5.com>
parents: 11032
diff changeset
69 workspace = "base";
8070
3b53b25e2550 Add data sources and line series
David Bateman <dbateman@free.fr>
parents:
diff changeset
70 else
11587
c792872f8942 all script files: untabify and strip trailing whitespace
John W. Eaton <jwe@octave.org>
parents: 11523
diff changeset
71 if ( !ischar (workspace)
11469
c776f063fefe Overhaul m-script files to use common variable name between code and documentation.
Rik <octave@nomad.inbox5.com>
parents: 11032
diff changeset
72 || !(strcmpi (workspace, "base")
c776f063fefe Overhaul m-script files to use common variable name between code and documentation.
Rik <octave@nomad.inbox5.com>
parents: 11032
diff changeset
73 || strcmpi (workspace, "caller")))
11472
1740012184f9 Use uppercase for variable names in error() strings to match Info documentation. Only m-files done.
Rik <octave@nomad.inbox5.com>
parents: 11469
diff changeset
74 error ("refreshdata: expecting WORKSPACE to be \"base\" or ""caller\"");
8070
3b53b25e2550 Add data sources and line series
David Bateman <dbateman@free.fr>
parents:
diff changeset
75 else
11469
c776f063fefe Overhaul m-script files to use common variable name between code and documentation.
Rik <octave@nomad.inbox5.com>
parents: 11032
diff changeset
76 workspace = tolower (workspace);
8070
3b53b25e2550 Add data sources and line series
David Bateman <dbateman@free.fr>
parents:
diff changeset
77 endif
3b53b25e2550 Add data sources and line series
David Bateman <dbateman@free.fr>
parents:
diff changeset
78 endif
3b53b25e2550 Add data sources and line series
David Bateman <dbateman@free.fr>
parents:
diff changeset
79 endif
3b53b25e2550 Add data sources and line series
David Bateman <dbateman@free.fr>
parents:
diff changeset
80
3b53b25e2550 Add data sources and line series
David Bateman <dbateman@free.fr>
parents:
diff changeset
81 h = findall (h);
3b53b25e2550 Add data sources and line series
David Bateman <dbateman@free.fr>
parents:
diff changeset
82 objs = [];
3b53b25e2550 Add data sources and line series
David Bateman <dbateman@free.fr>
parents:
diff changeset
83 props = {};
3b53b25e2550 Add data sources and line series
David Bateman <dbateman@free.fr>
parents:
diff changeset
84
3b53b25e2550 Add data sources and line series
David Bateman <dbateman@free.fr>
parents:
diff changeset
85 for i = 1 : numel (h)
3b53b25e2550 Add data sources and line series
David Bateman <dbateman@free.fr>
parents:
diff changeset
86 obj = get (h (i));
3b53b25e2550 Add data sources and line series
David Bateman <dbateman@free.fr>
parents:
diff changeset
87 fldnames = fieldnames (obj);
14868
5d3a684236b0 maint: Use Octave coding conventions for cuddling parentheses in scripts directory
Rik <octave@nomad.inbox5.com>
parents: 14363
diff changeset
88 m = regexpi (fieldnames (obj), '^.+datasource$', "match");
12931
cefd568ea073 Replace function handles with function names in cellfun calls for 15% speedup.
Rik <octave@nomad.inbox5.com>
parents: 11595
diff changeset
89 idx = ! cellfun ("isempty", m);
8070
3b53b25e2550 Add data sources and line series
David Bateman <dbateman@free.fr>
parents:
diff changeset
90 if (any (idx))
10439
59967776ed4a make refreshdata work again
John W. Eaton <jwe@octave.org>
parents: 9316
diff changeset
91 tmp = m(idx);
59967776ed4a make refreshdata work again
John W. Eaton <jwe@octave.org>
parents: 9316
diff changeset
92 props = [props; {vertcat(tmp{:})}];
8070
3b53b25e2550 Add data sources and line series
David Bateman <dbateman@free.fr>
parents:
diff changeset
93 objs = [objs ; h(i)];
3b53b25e2550 Add data sources and line series
David Bateman <dbateman@free.fr>
parents:
diff changeset
94 endif
3b53b25e2550 Add data sources and line series
David Bateman <dbateman@free.fr>
parents:
diff changeset
95 endfor
3b53b25e2550 Add data sources and line series
David Bateman <dbateman@free.fr>
parents:
diff changeset
96
3b53b25e2550 Add data sources and line series
David Bateman <dbateman@free.fr>
parents:
diff changeset
97 for i = 1 : length (objs)
3b53b25e2550 Add data sources and line series
David Bateman <dbateman@free.fr>
parents:
diff changeset
98 for j = 1 : length (props {i})
3b53b25e2550 Add data sources and line series
David Bateman <dbateman@free.fr>
parents:
diff changeset
99 expr = get (objs(i), props{i}{j});
3b53b25e2550 Add data sources and line series
David Bateman <dbateman@free.fr>
parents:
diff changeset
100 if (!isempty (expr))
11469
c776f063fefe Overhaul m-script files to use common variable name between code and documentation.
Rik <octave@nomad.inbox5.com>
parents: 11032
diff changeset
101 val = evalin (workspace, expr);
10549
95c3e38098bf Untabify .m scripts
Rik <code@nomad.inbox5.com>
parents: 10439
diff changeset
102 prop = props{i}{j}(1:end-6);
8070
3b53b25e2550 Add data sources and line series
David Bateman <dbateman@free.fr>
parents:
diff changeset
103 if (! isequal (get (objs(i), prop), val))
10549
95c3e38098bf Untabify .m scripts
Rik <code@nomad.inbox5.com>
parents: 10439
diff changeset
104 set (objs(i), props{i}{j}(1:end-6), val);
8070
3b53b25e2550 Add data sources and line series
David Bateman <dbateman@free.fr>
parents:
diff changeset
105 endif
3b53b25e2550 Add data sources and line series
David Bateman <dbateman@free.fr>
parents:
diff changeset
106 endif
3b53b25e2550 Add data sources and line series
David Bateman <dbateman@free.fr>
parents:
diff changeset
107 endfor
3b53b25e2550 Add data sources and line series
David Bateman <dbateman@free.fr>
parents:
diff changeset
108 endfor
14237
11949c9795a0 Revamp %!demos in m-files to use Octave coding conventions on spacing, etc.
Rik <octave@nomad.inbox5.com>
parents: 14138
diff changeset
109
8070
3b53b25e2550 Add data sources and line series
David Bateman <dbateman@free.fr>
parents:
diff changeset
110 endfunction
3b53b25e2550 Add data sources and line series
David Bateman <dbateman@free.fr>
parents:
diff changeset
111
14237
11949c9795a0 Revamp %!demos in m-files to use Octave coding conventions on spacing, etc.
Rik <octave@nomad.inbox5.com>
parents: 14138
diff changeset
112
8070
3b53b25e2550 Add data sources and line series
David Bateman <dbateman@free.fr>
parents:
diff changeset
113 %!demo
14237
11949c9795a0 Revamp %!demos in m-files to use Octave coding conventions on spacing, etc.
Rik <octave@nomad.inbox5.com>
parents: 14138
diff changeset
114 %! clf;
8070
3b53b25e2550 Add data sources and line series
David Bateman <dbateman@free.fr>
parents:
diff changeset
115 %! x = 0:0.1:10;
3b53b25e2550 Add data sources and line series
David Bateman <dbateman@free.fr>
parents:
diff changeset
116 %! y = sin (x);
14245
4506eade9f04 Use Matlab coding conventions for demos in plot/ directory.
Rik <octave@nomad.inbox5.com>
parents: 14237
diff changeset
117 %! plot (x, y, 'ydatasource', 'y');
8070
3b53b25e2550 Add data sources and line series
David Bateman <dbateman@free.fr>
parents:
diff changeset
118 %! for i = 1 : 100
14237
11949c9795a0 Revamp %!demos in m-files to use Octave coding conventions on spacing, etc.
Rik <octave@nomad.inbox5.com>
parents: 14138
diff changeset
119 %! pause (0.1);
8070
3b53b25e2550 Add data sources and line series
David Bateman <dbateman@free.fr>
parents:
diff changeset
120 %! y = sin (x + 0.1 * i);
14363
f3d52523cde1 Use Octave coding conventions in all m-file %!test blocks
Rik <octave@nomad.inbox5.com>
parents: 14335
diff changeset
121 %! refreshdata (gcf, 'caller');
14245
4506eade9f04 Use Matlab coding conventions for demos in plot/ directory.
Rik <octave@nomad.inbox5.com>
parents: 14237
diff changeset
122 %! end
14237
11949c9795a0 Revamp %!demos in m-files to use Octave coding conventions on spacing, etc.
Rik <octave@nomad.inbox5.com>
parents: 14138
diff changeset
123