1 ## Copyright (C) 2007-2012 David Bateman
3 ## This file is part of Octave.
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.
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.
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/>.
20 ## @deftypefn {Function File} {} plotyy (@var{x1}, @var{y1}, @var{x2}, @var{y2})
21 ## @deftypefnx {Function File} {} plotyy (@dots{}, @var{fun})
22 ## @deftypefnx {Function File} {} plotyy (@dots{}, @var{fun1}, @var{fun2})
23 ## @deftypefnx {Function File} {} plotyy (@var{h}, @dots{})
24 ## @deftypefnx {Function File} {[@var{ax}, @var{h1}, @var{h2}] =} plotyy (@dots{})
25 ## Plot two sets of data with independent y-axes. The arguments @var{x1} and
26 ## @var{y1} define the arguments for the first plot and @var{x1} and @var{y2}
29 ## By default the arguments are evaluated with
30 ## @code{feval (@@plot, @var{x}, @var{y})}. However the type of plot can be
31 ## modified with the @var{fun} argument, in which case the plots are
32 ## generated by @code{feval (@var{fun}, @var{x}, @var{y})}. @var{fun} can be
33 ## a function handle, an inline function or a string of a function name.
35 ## The function to use for each of the plots can be independently defined
36 ## with @var{fun1} and @var{fun2}.
38 ## If given, @var{h} defines the principal axis in which to plot the @var{x1}
39 ## and @var{y1} data. The return value @var{ax} is a two element vector with
40 ## the axis handles of the two plots. @var{h1} and @var{h2} are handles to
41 ## the objects generated by the plot commands.
48 ## ax = plotyy (x, y1, x - 1, y2, @@plot, @@semilogy);
50 ## ylabel (ax(1), "Axis 1");
51 ## ylabel (ax(2), "Axis 2");
56 function [Ax, H1, H2] = plotyy (varargin)
58 ## Don't use __plt_get_axis_arg__ here as ax is a two vector for plotyy
59 if (nargin > 1 && length (varargin{1}) == 2 && ishandle(varargin{1}(1))
60 && ishandle(varargin{1}(2))
61 && all (floor (varargin{1}) != varargin{1}))
62 obj1 = get (varargin{1}(1));
63 obj2 = get (varargin{1}(2));
64 if (strcmp (obj1.type, "axes") || strcmp (obj2.type, "axes"))
67 if (isempty (varargin))
71 error ("plotyy: expecting first argument to be axes handle");
75 f = get (0, "currentfigure");
79 ca = get (f, "currentaxes");
82 elseif (ishandle (ca) && isprop (ca, "__plotyy_axes__"))
83 ax = get (ca, "__plotyy_axes__");
88 for i = 3 : length (ax)
92 elseif (length (ax) == 1)
110 [ax, h1, h2] = __plotyy__ (ax, varargin{:});
111 unwind_protect_cleanup
112 ## Only change back to the old axis if we didn't delete it
113 if (ishandle(oldh) && strcmp (get (oldh, "type"), "axes"))
126 function [ax, h1, h2] = __plotyy__ (ax, x1, y1, x2, y2, varargin)
138 xlim = [min([x1(:); x2(:)]), max([x1(:); x2(:)])];
140 if (ishandle(ax(1)) && strcmp (get (ax(1), "type"), "axes"))
146 h1 = feval (fun1, x1, y1);
148 set (ax(1), "ycolor", getcolor (h1(1)));
149 set (ax(1), "xlim", xlim);
150 set (ax(1), "color", "none");
153 set (cf, "nextplot", "add");
155 if (ishandle(ax(2)) && strcmp (get (ax(2), "type"), "axes"))
162 colors = get (ax(1), "colororder");
163 set (ax(2), "colororder", [colors(2:end,:); colors(1,:)]);
165 if (strcmp (get (ax(1), "autopos_tag"), "subplot"))
166 set (ax(2), "autopos_tag", "subplot");
168 set (ax, "activepositionproperty", "position");
171 h2 = feval (fun2, x2, y2);
172 set (ax(2), "yaxislocation", "right");
173 set (ax(2), "ycolor", getcolor (h2(1)));
176 if (strcmp (get(ax(1), "activepositionproperty"), "position"))
177 set (ax(2), "position", get (ax(1), "position"));
179 set (ax(2), "outerposition", get (ax(1), "outerposition"));
180 set (ax(2), "looseinset", get (ax(1), "looseinset"));
183 set (ax(2), "xlim", xlim);
184 set (ax(2), "color", "none");
185 set (ax(2), "box", "off");
187 ## Add invisible text objects that when destroyed,
188 ## also remove the other axis
189 t1 = text (0, 0, "", "parent", ax(1), "tag", "plotyy",
190 "handlevisibility", "off", "visible", "off",
191 "xliminclude", "off", "yliminclude", "off");
192 t2 = text (0, 0, "", "parent", ax(2), "tag", "plotyy",
193 "handlevisibility", "off", "visible", "off",
194 "xliminclude", "off", "yliminclude", "off");
196 set (t1, "deletefcn", {@deleteplotyy, ax(2), t2});
197 set (t2, "deletefcn", {@deleteplotyy, ax(1), t1});
199 addlistener (ax(1), "position", {@update_position, ax(2)});
200 addlistener (ax(2), "position", {@update_position, ax(1)});
201 addlistener (ax(1), "outerposition", {@update_position, ax(2)});
202 addlistener (ax(2), "outerposition", {@update_position, ax(1)});
203 addlistener (ax(1), "looseinset", {@update_position, ax(2)});
204 addlistener (ax(2), "looseinset", {@update_position, ax(1)});
205 addlistener (ax(1), "view", {@update_position, ax(2)});
206 addlistener (ax(2), "view", {@update_position, ax(1)});
207 addlistener (ax(1), "plotboxaspectratio", {@update_position, ax(2)});
208 addlistener (ax(2), "plotboxaspectratio", {@update_position, ax(1)});
209 addlistener (ax(1), "plotboxaspectratiomode", {@update_position, ax(2)});
210 addlistener (ax(2), "plotboxaspectratiomode", {@update_position, ax(1)});
212 ## Store the axes handles for the sister axes.
213 if (ishandle (ax(1)) && ! isprop (ax(1), "__plotyy_axes__"))
214 addproperty ("__plotyy_axes__", ax(1), "data", ax);
215 elseif (ishandle (ax(1)))
216 set (ax(1), "__plotyy_axes__", ax);
218 error ("plotyy.m: This shouldn't happen. File a bug report.")
220 if (ishandle (ax(2)) && ! isprop (ax(2), "__plotyy_axes__"))
221 addproperty ("__plotyy_axes__", ax(2), "data", ax);
222 elseif (ishandle (ax(2)))
223 set (ax(2), "__plotyy_axes__", ax);
225 error ("plotyy.m: This shouldn't happen. File a bug report.")
234 %! ax = plotyy (x, y1, x - 1, y2, @plot, @semilogy);
236 %! ylabel (ax(1), "Axis 1");
237 %! ylabel (ax(2), "Axis 2");
239 %! text (0.5, 0.5, "Left Axis", ...
240 %! "color", [0 0 1], "horizontalalignment", "center")
242 %! text (4.5, 80, "Right Axis", ...
243 %! "color", [0 0.5 0], "horizontalalignment", "center")
247 %! x = linspace (-1, 1, 201);
249 %! plotyy (x, sin(pi*x), x, 10*cos(pi*x))
253 %! contour (peaks (25))
255 %! plotyy (x, 10*sin(2*pi*x), x, cos(2*pi*x))
260 %! x = linspace (-1, 1, 201);
261 %! subplot (1, 1, 1);
262 %! hax = plotyy (x, sin(pi*x), x, cos(pi*x));
263 %! ylabel ("Blue and on the Left")
264 %! ylabel (hax(2), "Green and on the Right")
267 function deleteplotyy (h, d, ax2, t2)
268 if (ishandle (ax2) && strcmp (get (ax2, "type"), "axes")
269 && (isempty (gcbf()) || strcmp (get (gcbf(), "beingdeleted"),"off"))
270 && strcmp (get (ax2, "beingdeleted"), "off"))
271 set (t2, "deletefcn", []);
276 function update_position (h, d, ax2)
277 persistent recursion = false;
279 ## Don't allow recursion
283 view = get (h, "view");
284 oldview = get (ax2, "view");
285 plotboxaspectratio = get (h, "plotboxaspectratio");
286 oldplotboxaspectratio = get (ax2, "plotboxaspectratio");
287 plotboxaspectratiomode = get (h, "plotboxaspectratiomode");
288 oldplotboxaspectratiomode = get (ax2, "plotboxaspectratiomode");
290 if (strcmp (get(h, "activepositionproperty"), "position"))
291 position = get (h, "position");
292 oldposition = get (ax2, "position");
293 if (! (isequal (position, oldposition) && isequal (view, oldview)))
294 set (ax2, "position", position, "view", view);
297 outerposition = get (h, "outerposition");
298 oldouterposition = get (ax2, "outerposition");
299 if (! (isequal (outerposition, oldouterposition) && isequal (view, oldview)))
300 set (ax2, "outerposition", outerposition, "view", view);
304 if (! (isequal (plotboxaspectratio, oldplotboxaspectratio)
305 && isequal (plotboxaspectratiomode, oldplotboxaspectratiomode)))
306 set (ax2, "plotboxaspectratio", plotboxaspectratio);
307 set (ax2, "plotboxaspectratiomode", plotboxaspectratiomode);
309 unwind_protect_cleanup
315 function color = getcolor (ax)
317 if (isfield (obj, "color"))
319 elseif (isfield (obj, "facecolor") && ! ischar (obj.facecolor))
320 color = obj.facecolor;
321 elseif (isfield (obj, "edgecolor") && ! ischar (obj.edgecolor))
322 color = obj.edgecolor;