octave-antonio: scripts/plot/legend.m comparison

comparison scripts/plot/legend.m @ 11587:c792872f8942

all script files: untabify and strip trailing whitespace

author	John W. Eaton <jwe@octave.org>
date	Thu, 20 Jan 2011 17:35:29 -0500
parents	3c6e8aaa9555
children	eda5eabd5d0b

comparison

equal deleted inserted replaced

-:12df7854fa7c
+:c792872f8942
 ## @deftypefnx {Function File} {} legend (@var{hobjs}, @dots{})
 ## @deftypefnx {Function File} {} legend (@var{hax}, @var{hobjs}, @dots{})
 ## @deftypefnx {Function File} {} legend ("@var{option}")
 ##
 ## Display a legend for the axes with handle @var{hax}, or the current axes,
 ## using the specified strings as labels.  Legend entries may be specified
 ## as individual character string arguments, a character array, or a cell
 ## array of character strings.  If the handles, @var{hobjs}, are not specified
 ## then the legend's strings will be associated with the axes' descendants.
 ## Legend works on line graphs, bar graphs, etc.
 ## A plot must exist before legend is called.
 ##   right bottom
 ##
 ## @item @tab southwest @tab
 ##   left bottom
 ##
 ## @item
 ##
 ## @item @tab outside @tab
 ##   can be appended to any location string
 ## @end multitable
 ##
 if (strcmp (get (ca, "tag"), "plotyy"))
 plty = get(ca (strcmp (get (ca, "tag"), "plotyy")), "userdata");
 if (isscalar (plty))
 ca = [ca, plty];
 else
 ca = [ca, plty{:}];
 endif
 endif
 if (nargin > 0 && all (ishandle (varargin{1})))
 else
 error ("legend: invalid position specified");
 endif
 endif
 endif
 while (nargs > 1)
 pos = varargin{nargs-1};
 str = varargin{nargs};
 if (strcmpi (pos, "location")  && ischar (str))
 position = lower (str);
 else
 break;
 endif
 endwhile
 ## Validate the orientation
 switch (orientation)
 case {"vertical", "horizontal","default"}
 otherwise
 error ("legend: unrecognized legend orientation");
 endswitch
 endswitch
 hlegend = [];
 fkids = get (fig, "children");
 for i = 1 : numel(fkids)
 if (ishandle (fkids (i)) && strcmp (get (fkids (i), "type"), "axes")
 && (strcmp (get (fkids (i), "tag"), "legend")))
 udata = get (fkids (i), "userdata");
 if (! isempty (intersect (udata.handle, ca)))
 hlegend = fkids (i);
 break;
 if (k > 0)
 if (strcmp (get (kids(k), "type"), "hggroup"))
 hgkids = get (kids(k), "children");
 for j = 1 : length (hgkids)
 hgobj = get (hgkids (j));
 if (isfield (hgobj, "displayname")
 && ! isempty (hgobj.displayname))
 hplots = [hplots, hgkids(j)];
 text_strings = {text_strings{:}, hbobj.displayname};
 break;
 endif
 if (strcmp (orientation, "default"))
 orientation = "vertical";
 endif
 box = "off";
 endif
 ## Get axis size and fontsize in points.
 ## Rely on listener to handle coversion.
 units = get (ca(1), "units");
 fontunits = get (ca(1), "fontunits");
 unwind_protect
 set (ca(1), "units", "points");
 if (isempty (hlegend))
 addprops = true;
 hlegend = axes ("tag", "legend", "userdata", struct ("handle", ud),
 "box", box, "outerposition", [0, 0, 0, 0],
 "xtick", [], "ytick", [], "xticklabel", "",
 "yticklabel", "", "zticklabel", "",
 "xlim", [0, 1], "ylim", [0, 1], "visible", "off",
 "activepositionproperty", "position");
 else
 addprops = false;
 axes (hlegend);
 texthandle = [];
 maxwidth = 0;
 maxheight = 0;
 for k = 1 : nentries
 if (strcmp (textpos, "right"))
 texthandle = [texthandle, text(0, 0, text_strings {k},
 "horizontalalignment", "left",
 "userdata", hplots(k))];
 else
 texthandle = [texthandle, text(0, 0, text_strings {k},
 "horizontalalignment", "right",
 lpos = [ca_pos(1) + ypad, ...
 ca_pos(2) + ca_pos(4) - lpos(4) - ypad, lpos(3), lpos(4)];
 endif
 case "southeast"
 if (outside)
 lpos = [ca_outpos(1) + ca_outpos(3) - lpos(3), ca_outpos(2),
 lpos(3), lpos(4)];
 new_pos = [ca_pos(1), ca_pos(2) + lpos(4), ...
 ca_pos(3) - lpos(3), ca_pos(4) - lpos(4)];
 new_outpos = [ca_outpos(1), ca_outpos(2) + lpos(4), ...
 ca_outpos(3) - lpos(3), ca_outpos(4) - lpos(4)];
 case "line"
 color = get (hplots(k), "color");
 style = get (hplots(k), "linestyle");
 if (! strcmp (style, "none"))
 l1 = line ("xdata", ([xoffset, xoffset + linelength] + xk * xstep) / lpos(3),
 "ydata", [1, 1] .* (lpos(4) - yoffset - yk * ystep) / lpos(4),
 "color", color, "linestyle", style, "marker", "none",
 "userdata", hplots (k));
 hobjects = [hobjects, l1];
 endif
 marker = get (hplots(k), "marker");
 if (! strcmp (marker, "none"))
 l1 = line ("xdata", (xoffset + 0.5 * linelength  + xk * xstep) / lpos(3),
 "ydata", (lpos(4) - yoffset - yk * ystep) / lpos(4),
 "color", color, "linestyle", "none", "marker", marker,
 "markeredgecolor", get (hplots (k), "markeredgecolor"),
 "markerfacecolor", get (hplots (k), "markerfacecolor"),
 "markersize", get (hplots (k), "markersize"),
 "userdata", hplots (k));
 endif
 endfor
 ## Add an invisible text object to original axis
 ## that when it is destroyed will remove the legend
 t1 = text (0, 0, "", "parent", ca(1), "tag", "legend",
 "handlevisibility", "off", "visible", "off",
 "xliminclude", "off", "yliminclude", "off");
 set (t1, "deletefcn", {@deletelegend1, hlegend});
 ## Resize the axis the legend is attached to if the
 ## legend is "outside" the plot and create listener to
 ## resize axis to original size if the legend is deleted,
 ## hidden or shown
 if (outside)
 for i = 1 : numel (ca)
 units = get (ca(i), "units");
 unwind_protect
 if (addprops)
 addproperty ("edgecolor", hlegend, "color", [0, 0, 0]);
 addproperty ("textcolor", hlegend, "color", [0, 0, 0]);
 addproperty ("location", hlegend, "radio", "north|south|east|west|{northeast}|southeast|northwest|southwest|northoutside|southoutside|eastoutside|westoutside|northeastoutside|southeastoutside|northwestoutside|southwestoutside");
 addproperty ("orientation", hlegend, "radio",
 "{vertical}|horizontal");
 addproperty ("string", hlegend, "any", text_strings);
 addproperty ("textposition", hlegend, "radio", "{left}|right");
 else
 set (hlegend, "string", text_strings);
 endif
 if (outside)
 set (hlegend, "location", strcat (position, "outside"),
 "orientation", orientation, "textposition", textpos);
 else
 set (hlegend, "location", position, "orientation", orientation,
 "textposition", textpos);
 endif
 function updateline (h, d, hlegend, linelength)
 lm = [];
 ll = [];
 kids = get (hlegend, "children");
 for i = 1 : numel (kids)
 if (get (kids (i), "userdata") == h
 && strcmp (get (kids(i), "type"), "line"))
 if (strcmp (get (kids (i), "marker"), "none"))
 ll = kids (i);
 else
 lm = kids (i);
 linestyle = get (h, "linestyle");
 marker = get (h, "marker");
 displayname = get (h, "displayname");
 if ((isempty (displayname)
 || (strcmp (marker, "none") && strcmp (linestyle, "none")))
 && (! isempty (lm) || isempty (ll)))
 ## An element was removed from the legend. Need to recall the
 ## legend function to recreate a new legend
 [hplots, text_strings] = getlegenddata (hlegend);
 text_strings(i) = [];
 break;
 endif
 endfor
 legend (hplots, text_strings);
 elseif ((!isempty (displayname)
 && (! strcmp (marker, "none") || ! strcmp (linestyle, "none")))
 && isempty (lm) && isempty (ll))
 ## An element was added to the legend. Need to recall the
 ## legend function to recreate a new legend
 [hplots, text_strings] = getlegenddata (hlegend);
 ypos1 = [ypos2, ypos2];
 xpos1 = xpos2 + [-0.5, 0.5] * linelength;
 delete (lm);
 endif
 if (! strcmp (linestyle, "none"))
 line ("xdata", xpos1, "ydata", ypos1, "color", get (h, "color"),
 "linestyle", get (h, "linestyle"), "marker", "none",
 "userdata", h, "parent", hlegend);
 endif
 if (! strcmp (marker, "none"))
 line ("xdata", xpos2, "ydata", ypos2, "color", get (h, "color"),
 "marker", marker, "markeredgecolor", get (h, "markeredgecolor"),
 "markerfacecolor", get (h, "markerfacecolor"),
 "markersize", get (h, "markersize"), "linestyle", "none",
 "userdata", h, "parent", hlegend);
 endif
 if (k > 0)
 if (strcmp (get (kids(k), "type"), "hggroup"))
 hgkids = get (kids(k), "children");
 for j = 1 : length (hgkids)
 hgobj = get (hgkids (j));
 if (isfield (hgobj, "displayname")
 && ! isempty (hgobj.displayname))
 hplots = [hplots, hgkids(j)];
 text_strings = {text_strings{:}, hbobj.displayname};
 break;
 endif

Mercurial > octave-antonio

comparison scripts/plot/legend.m @ 11587:c792872f8942