|
6146
|
1 ## Copyright (C) 2001 Laurent Mazet |
|
|
2 ## Copyright (C) 2006 John W. Eaton |
|
|
3 ## |
|
|
4 ## This program is free software; it is distributed in the hope that it |
|
|
5 ## will be useful, but WITHOUT ANY WARRANTY; without even the implied |
|
|
6 ## warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See |
|
|
7 ## the GNU General Public License for more details. |
|
|
8 ## |
|
|
9 ## You should have received a copy of the GNU General Public License |
|
|
10 ## along with this file; see the file COPYING. If not, write to the |
|
|
11 ## Free Software Foundation, 59 Temple Place - Suite 330, Boston, MA |
|
|
12 ## 02111-1307, USA. |
|
|
13 |
|
|
14 ## -*- texinfo -*- |
|
|
15 ## @deftypefn {Function File} {} legend (@var{st1}, @var{st2}, @var{st3}, @var{...}) |
|
|
16 ## @deftypefnx {Function File} {} legend (@var{st1}, @var{st2}, @var{st3}, @var{...}, @var{pos}) |
|
|
17 ## @deftypefnx {Function File} {} legend (@var{matstr}) |
|
|
18 ## @deftypefnx {Function File} {} legend (@var{matstr}, @var{pos}) |
|
|
19 ## @deftypefnx {Function File} {} legend (@var{cell}) |
|
|
20 ## @deftypefnx {Function File} {} legend (@var{cell}, @var{pos}) |
|
|
21 ## @deftypefnx {Function File} {} legend ('@var{func}') |
|
|
22 ## |
|
|
23 ## Legend puts a legend on the current plot using the specified strings |
|
|
24 ## as labels. Use independant strings (@var{st1}, @var{st2}, @var{st3}...), a |
|
|
25 ## matrix of strings (@var{matstr}), or a cell array of strings (@var{cell}) to |
|
|
26 ## specify legends. Legend works on line graphs, bar graphs, etc... |
|
|
27 ## Be sure to call plot before calling legend. |
|
|
28 ## |
|
|
29 ## @var{pos} optionally places the legend in the specified location: |
|
|
30 ## |
|
|
31 ## @multitable @columnfractions 0.1 0.1 0.8 |
|
6395
|
32 ## @item @tab -1 @tab |
|
|
33 ## To the top right of the plot |
|
6146
|
34 ## @item @tab 0 @tab |
|
|
35 ## Don't move the legend box (default) |
|
|
36 ## @item @tab 1 @tab |
|
|
37 ## Upper right-hand corner |
|
|
38 ## @item @tab 2 @tab |
|
|
39 ## Upper left-hand corner |
|
|
40 ## @item @tab 3 @tab |
|
|
41 ## Lower left-hand corner |
|
|
42 ## @item @tab 4 @tab |
|
|
43 ## Lower right-hand corner |
|
|
44 ## @end multitable |
|
|
45 ## |
|
|
46 ## Some specific functions are directely avaliable using @var{func}: |
|
|
47 ## |
|
|
48 ## @table @code |
|
|
49 ## @item show |
|
|
50 ## Show legends from the plot |
|
|
51 ## @item hide |
|
|
52 ## @itemx off |
|
|
53 ## Hide legends from the plot |
|
|
54 ## @item boxon |
|
|
55 ## Draw a box around legends |
|
|
56 ## @item boxoff |
|
|
57 ## Withdraw the box around legends |
|
|
58 ## @item left |
|
|
59 ## Text is to the left of the keys |
|
|
60 ## @item right |
|
|
61 ## Text is to the right of the keys |
|
|
62 ## @end table |
|
|
63 ## @end deftypefn |
|
|
64 |
|
|
65 ## PKG_ADD mark_as_command legend |
|
|
66 |
|
|
67 function legend (varargin) |
|
|
68 |
|
6257
|
69 nargs = nargin; |
|
6146
|
70 |
|
6257
|
71 ca = gca (); |
|
6146
|
72 |
|
|
73 if (nargs > 0) |
|
|
74 pos = varargin{nargs}; |
|
|
75 if (isnumeric (pos) && isscalar (pos) && round (pos) == pos) |
|
6395
|
76 if (pos >= -1 && pos <= 4) |
|
6257
|
77 set (ca, "keypos", pos); |
|
6146
|
78 nargs--; |
|
|
79 else |
|
|
80 error ("legend: invalid position specified"); |
|
|
81 endif |
|
|
82 endif |
|
|
83 endif |
|
|
84 |
|
6257
|
85 kids = get (ca, "children"); |
|
|
86 nkids = numel (kids); |
|
|
87 k = 1; |
|
|
88 turn_on_legend = false; |
|
|
89 |
|
6146
|
90 if (nargs == 1) |
|
|
91 arg = varargin{1}; |
|
|
92 if (ischar (arg)) |
|
|
93 if (rows (arg) == 1) |
|
|
94 str = tolower (deblank (arg)); |
|
|
95 switch (str) |
|
|
96 case {"off", "hide"} |
|
6257
|
97 set (ca, "key", "off"); |
|
6146
|
98 case "show" |
|
6257
|
99 set (ca, "key", "on"); |
|
6146
|
100 case "toggle" |
|
6257
|
101 val = get (ca, "key"); |
|
|
102 if (strcmp (val, "on")) |
|
|
103 set (ca, "key", "off"); |
|
|
104 else |
|
|
105 set (ca, "key", "on"); |
|
|
106 endif |
|
6146
|
107 case "boxon" |
|
6257
|
108 set (ca, "key", "on", "keybox", "on"); |
|
6146
|
109 case "boxoff" |
|
6257
|
110 set (ca, "keybox", "off"); |
|
6146
|
111 otherwise |
|
6257
|
112 while (k <= nkids && ! strcmp (get (kids(k), "type"), "line")) |
|
|
113 k++; |
|
|
114 endwhile |
|
|
115 if (k <= nkids) |
|
|
116 turn_on_legend = true; |
|
|
117 set (kids(k), "keylabel", arg); |
|
|
118 else |
|
|
119 warning ("legend: ignoring extra labels"); |
|
|
120 endif |
|
6146
|
121 endswitch |
|
|
122 nargs--; |
|
|
123 else |
|
|
124 varargin = cellstr (arg); |
|
|
125 nargs = numel (vargin); |
|
|
126 endif |
|
|
127 elseif (iscellstr (arg)) |
|
|
128 varargin = arg; |
|
|
129 nargs = numel (varargin); |
|
|
130 else |
|
|
131 error ("legend: expecting argument to be a character string"); |
|
|
132 endif |
|
|
133 endif |
|
|
134 |
|
6272
|
135 if (nargs > 0) |
|
|
136 have_data = false; |
|
|
137 for i = 1:nkids |
|
|
138 if (strcmp (get (kids(k), "type"), "line")) |
|
|
139 have_data = true; |
|
|
140 break; |
|
|
141 endif |
|
|
142 endfor |
|
|
143 if (! have_data) |
|
|
144 warning ("legend: plot data is empty; setting key labels has no effect"); |
|
|
145 endif |
|
6147
|
146 endif |
|
|
147 |
|
6146
|
148 for i = 1:nargs |
|
|
149 arg = varargin{i}; |
|
|
150 if (ischar (arg)) |
|
6257
|
151 while (k <= nkids && ! strcmp (get (kids(k), "type"), "line")) |
|
|
152 k++; |
|
|
153 endwhile |
|
|
154 if (k <= nkids) |
|
|
155 set (kids(k), "keylabel", arg); |
|
|
156 turn_on_legend = true; |
|
|
157 elseif (! warned) |
|
|
158 warned = true; |
|
|
159 warning ("legend: ignoring extra labels"); |
|
|
160 endif |
|
6146
|
161 else |
|
|
162 error ("legend: expecting argument to be a character string"); |
|
|
163 endif |
|
|
164 endfor |
|
|
165 |
|
6257
|
166 if (turn_on_legend) |
|
|
167 set (ca, "key", "on"); |
|
6146
|
168 endif |
|
|
169 |
|
|
170 endfunction |
|
|
171 |
|
|
172 %!demo |
|
|
173 %! close all; |
|
|
174 %! plot(1:10, 1:10); |
|
|
175 %! title("a very long label can sometimes cause problems"); |
|
|
176 %! legend({"hello world"}, -1) |
|
|
177 |
|
|
178 %!demo |
|
|
179 %! close all; |
|
|
180 %! labels = {}; |
|
|
181 %! for i = 1:5 |
|
|
182 %! plot(1:100, i + rand(100,1)); hold on; |
|
|
183 %! labels = {labels{:}, strcat("Signal ", num2str(i))}; |
|
|
184 %! endfor; hold off; |
|
|
185 %! title("Signals with random offset and uniform noise") |
|
|
186 %! xlabel("Sample Nr [k]"); ylabel("Amplitude [V]"); |
|
|
187 %! legend(labels, -1) |
|
|
188 %! legend("boxon") |
