Mercurial > octave-nkf

annotate scripts/plot/refreshdata.m @ 10821:693e22af08ae

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Grammarcheck documentation of m-files Add newlines between @item fields for readability.
author Rik <octave@nomad.inbox5.com>
date Mon, 26 Jul 2010 21:25:36 -0700
parents 95c3e38098bf
children c9b0a75b02e8
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
9245
16f53d29049f update copyright notices
John W. Eaton <jwe@octave.org>
parents: 9040
diff changeset
1 ## Copyright (C) 2008, 2009 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
c539ec5726e7 Update some of Advanced Plotting documentation.
Rik <rdrider0-list@yahoo.com>
parents: 9245
diff changeset
24 ## the plot if the corresponding data has changed. If called with one or more
c539ec5726e7 Update some of Advanced Plotting documentation.
Rik <rdrider0-list@yahoo.com>
parents: 9245
diff changeset
25 ## arguments @var{h} is a scalar or array of figure handles to refresh. The
c539ec5726e7 Update some of Advanced Plotting documentation.
Rik <rdrider0-list@yahoo.com>
parents: 9245
diff changeset
26 ## 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
27 ##
9316
c539ec5726e7 Update some of Advanced Plotting documentation.
Rik <rdrider0-list@yahoo.com>
parents: 9245
diff changeset
28 ## @table @code
c539ec5726e7 Update some of Advanced Plotting documentation.
Rik <rdrider0-list@yahoo.com>
parents: 9245
diff changeset
29 ## @item "base"
c539ec5726e7 Update some of Advanced Plotting documentation.
Rik <rdrider0-list@yahoo.com>
parents: 9245
diff changeset
30 ## 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
31 ##
9316
c539ec5726e7 Update some of Advanced Plotting documentation.
Rik <rdrider0-list@yahoo.com>
parents: 9245
diff changeset
32 ## @item "caller"
c539ec5726e7 Update some of Advanced Plotting documentation.
Rik <rdrider0-list@yahoo.com>
parents: 9245
diff changeset
33 ## 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
34 ## that called @code{refreshdata}.
c539ec5726e7 Update some of Advanced Plotting documentation.
Rik <rdrider0-list@yahoo.com>
parents: 9245
diff changeset
35 ## @end table
c539ec5726e7 Update some of Advanced Plotting documentation.
Rik <rdrider0-list@yahoo.com>
parents: 9245
diff changeset
36 ##
c539ec5726e7 Update some of Advanced Plotting documentation.
Rik <rdrider0-list@yahoo.com>
parents: 9245
diff changeset
37 ## 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
38 ##
3b53b25e2550 Add data sources and line series
David Bateman <dbateman@free.fr>
parents:
diff changeset
39 ## @example
3b53b25e2550 Add data sources and line series
David Bateman <dbateman@free.fr>
parents:
diff changeset
40 ## @group
3b53b25e2550 Add data sources and line series
David Bateman <dbateman@free.fr>
parents:
diff changeset
41 ## x = 0:0.1:10;
3b53b25e2550 Add data sources and line series
David Bateman <dbateman@free.fr>
parents:
diff changeset
42 ## y = sin (x);
3b53b25e2550 Add data sources and line series
David Bateman <dbateman@free.fr>
parents:
diff changeset
43 ## plot (x, y, "ydatasource", "y");
3b53b25e2550 Add data sources and line series
David Bateman <dbateman@free.fr>
parents:
diff changeset
44 ## for i = 1 : 100
3b53b25e2550 Add data sources and line series
David Bateman <dbateman@free.fr>
parents:
diff changeset
45 ## pause(0.1)
3b53b25e2550 Add data sources and line series
David Bateman <dbateman@free.fr>
parents:
diff changeset
46 ## y = sin (x + 0.1 * i);
3b53b25e2550 Add data sources and line series
David Bateman <dbateman@free.fr>
parents:
diff changeset
47 ## refreshdata();
3b53b25e2550 Add data sources and line series
David Bateman <dbateman@free.fr>
parents:
diff changeset
48 ## endfor
3b53b25e2550 Add data sources and line series
David Bateman <dbateman@free.fr>
parents:
diff changeset
49 ## @end group
3b53b25e2550 Add data sources and line series
David Bateman <dbateman@free.fr>
parents:
diff changeset
50 ## @end example
3b53b25e2550 Add data sources and line series
David Bateman <dbateman@free.fr>
parents:
diff changeset
51 ## @end deftypefn
3b53b25e2550 Add data sources and line series
David Bateman <dbateman@free.fr>
parents:
diff changeset
52
3b53b25e2550 Add data sources and line series
David Bateman <dbateman@free.fr>
parents:
diff changeset
53 function refreshdata (h, ws)
3b53b25e2550 Add data sources and line series
David Bateman <dbateman@free.fr>
parents:
diff changeset
54
3b53b25e2550 Add data sources and line series
David Bateman <dbateman@free.fr>
parents:
diff changeset
55 if (nargin == 0)
3b53b25e2550 Add data sources and line series
David Bateman <dbateman@free.fr>
parents:
diff changeset
56 h = gcf ();
3b53b25e2550 Add data sources and line series
David Bateman <dbateman@free.fr>
parents:
diff changeset
57 ws = "base";
3b53b25e2550 Add data sources and line series
David Bateman <dbateman@free.fr>
parents:
diff changeset
58 else
3b53b25e2550 Add data sources and line series
David Bateman <dbateman@free.fr>
parents:
diff changeset
59 if (iscell (h))
3b53b25e2550 Add data sources and line series
David Bateman <dbateman@free.fr>
parents:
diff changeset
60 h = [h{:}];
3b53b25e2550 Add data sources and line series
David Bateman <dbateman@free.fr>
parents:
diff changeset
61 endif
3b53b25e2550 Add data sources and line series
David Bateman <dbateman@free.fr>
parents:
diff changeset
62 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
63 error ("refreshdata: expecting a list of figure handles");
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 (nargin < 2)
3b53b25e2550 Add data sources and line series
David Bateman <dbateman@free.fr>
parents:
diff changeset
66 ws = "base";
3b53b25e2550 Add data sources and line series
David Bateman <dbateman@free.fr>
parents:
diff changeset
67 else
3b53b25e2550 Add data sources and line series
David Bateman <dbateman@free.fr>
parents:
diff changeset
68 if (!ischar (ws) || !(strcmpi (ws, "base") || strcmpi (ws, "caller")))
10549
95c3e38098bf Untabify .m scripts
Rik <code@nomad.inbox5.com>
parents: 10439
diff changeset
69 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
70 else
10549
95c3e38098bf Untabify .m scripts
Rik <code@nomad.inbox5.com>
parents: 10439
diff changeset
71 ws = tolower (ws);
8070
3b53b25e2550 Add data sources and line series
David Bateman <dbateman@free.fr>
parents:
diff changeset
72 endif
3b53b25e2550 Add data sources and line series
David Bateman <dbateman@free.fr>
parents:
diff changeset
73 endif
3b53b25e2550 Add data sources and line series
David Bateman <dbateman@free.fr>
parents:
diff changeset
74 endif
3b53b25e2550 Add data sources and line series
David Bateman <dbateman@free.fr>
parents:
diff changeset
75
3b53b25e2550 Add data sources and line series
David Bateman <dbateman@free.fr>
parents:
diff changeset
76 h = findall (h);
3b53b25e2550 Add data sources and line series
David Bateman <dbateman@free.fr>
parents:
diff changeset
77 objs = [];
3b53b25e2550 Add data sources and line series
David Bateman <dbateman@free.fr>
parents:
diff changeset
78 props = {};
3b53b25e2550 Add data sources and line series
David Bateman <dbateman@free.fr>
parents:
diff changeset
79
3b53b25e2550 Add data sources and line series
David Bateman <dbateman@free.fr>
parents:
diff changeset
80 for i = 1 : numel (h)
3b53b25e2550 Add data sources and line series
David Bateman <dbateman@free.fr>
parents:
diff changeset
81 obj = get (h (i));
3b53b25e2550 Add data sources and line series
David Bateman <dbateman@free.fr>
parents:
diff changeset
82 fldnames = fieldnames (obj);
8257
79c874fe5100 More plot object updates
David Bateman <dbateman@free.fr>
parents: 8070
diff changeset
83 m = regexpi (fieldnames(obj), "^.+datasource$", "match");
8070
3b53b25e2550 Add data sources and line series
David Bateman <dbateman@free.fr>
parents:
diff changeset
84 idx = cellfun (@(x) !isempty(x), m);
3b53b25e2550 Add data sources and line series
David Bateman <dbateman@free.fr>
parents:
diff changeset
85 if (any (idx))
10439
59967776ed4a make refreshdata work again
John W. Eaton <jwe@octave.org>
parents: 9316
diff changeset
86 tmp = m(idx);
59967776ed4a make refreshdata work again
John W. Eaton <jwe@octave.org>
parents: 9316
diff changeset
87 props = [props; {vertcat(tmp{:})}];
8070
3b53b25e2550 Add data sources and line series
David Bateman <dbateman@free.fr>
parents:
diff changeset
88 objs = [objs ; h(i)];
3b53b25e2550 Add data sources and line series
David Bateman <dbateman@free.fr>
parents:
diff changeset
89 endif
3b53b25e2550 Add data sources and line series
David Bateman <dbateman@free.fr>
parents:
diff changeset
90 endfor
3b53b25e2550 Add data sources and line series
David Bateman <dbateman@free.fr>
parents:
diff changeset
91
3b53b25e2550 Add data sources and line series
David Bateman <dbateman@free.fr>
parents:
diff changeset
92 for i = 1 : length (objs)
3b53b25e2550 Add data sources and line series
David Bateman <dbateman@free.fr>
parents:
diff changeset
93 for j = 1 : length (props {i})
3b53b25e2550 Add data sources and line series
David Bateman <dbateman@free.fr>
parents:
diff changeset
94 expr = get (objs(i), props{i}{j});
3b53b25e2550 Add data sources and line series
David Bateman <dbateman@free.fr>
parents:
diff changeset
95 if (!isempty (expr))
10549
95c3e38098bf Untabify .m scripts
Rik <code@nomad.inbox5.com>
parents: 10439
diff changeset
96 val = evalin (ws, expr);
95c3e38098bf Untabify .m scripts
Rik <code@nomad.inbox5.com>
parents: 10439
diff changeset
97 prop = props{i}{j}(1:end-6);
8070
3b53b25e2550 Add data sources and line series
David Bateman <dbateman@free.fr>
parents:
diff changeset
98 if (! isequal (get (objs(i), prop), val))
10549
95c3e38098bf Untabify .m scripts
Rik <code@nomad.inbox5.com>
parents: 10439
diff changeset
99 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
100 endif
3b53b25e2550 Add data sources and line series
David Bateman <dbateman@free.fr>
parents:
diff changeset
101 endif
3b53b25e2550 Add data sources and line series
David Bateman <dbateman@free.fr>
parents:
diff changeset
102 endfor
3b53b25e2550 Add data sources and line series
David Bateman <dbateman@free.fr>
parents:
diff changeset
103 endfor
3b53b25e2550 Add data sources and line series
David Bateman <dbateman@free.fr>
parents:
diff changeset
104 endfunction
3b53b25e2550 Add data sources and line series
David Bateman <dbateman@free.fr>
parents:
diff changeset
105
3b53b25e2550 Add data sources and line series
David Bateman <dbateman@free.fr>
parents:
diff changeset
106 %!demo
3b53b25e2550 Add data sources and line series
David Bateman <dbateman@free.fr>
parents:
diff changeset
107 %! x = 0:0.1:10;
3b53b25e2550 Add data sources and line series
David Bateman <dbateman@free.fr>
parents:
diff changeset
108 %! y = sin (x);
3b53b25e2550 Add data sources and line series
David Bateman <dbateman@free.fr>
parents:
diff changeset
109 %! plot (x, y, "ydatasource", "y");
3b53b25e2550 Add data sources and line series
David Bateman <dbateman@free.fr>
parents:
diff changeset
110 %! for i = 1 : 100
3b53b25e2550 Add data sources and line series
David Bateman <dbateman@free.fr>
parents:
diff changeset
111 %! pause(0.1)
3b53b25e2550 Add data sources and line series
David Bateman <dbateman@free.fr>
parents:
diff changeset
112 %! y = sin (x + 0.1 * i);
8260
a7b83ced7a7a Fix for refreshdata demo
David Bateman <dbateman@free.fr>
parents: 8257
diff changeset
113 %! refreshdata(gcf(), "caller");
8070
3b53b25e2550 Add data sources and line series
David Bateman <dbateman@free.fr>
parents:
diff changeset
114 %! endfor