Mercurial > hg > octave-lyh
annotate scripts/plot/private/__pltopt__.m @ 17053:27062be131d6
__axis_label__.m: Rename ax to hax. Align spacing in code.
* scripts/plot/private/__axis_label__.m: Rename ax to hax.
Align spacing in code. Set "fontunits" before "fontsize"
to avoid triggering unnecessary listeners.
author | Rik <rik@octave.org> |
---|---|
date | Wed, 24 Jul 2013 23:12:46 -0700 |
parents | 049e8bbff782 |
children | abf384f5d243 |
rev | line source |
---|---|
14138
72c96de7a403
maint: update copyright notices for 2012
John W. Eaton <jwe@octave.org>
parents:
11587
diff
changeset
|
1 ## Copyright (C) 1994-2012 John W. Eaton |
2313 | 2 ## |
3 ## This file is part of Octave. | |
4 ## | |
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 | |
7016 | 7 ## the Free Software Foundation; either version 3 of the License, or (at |
8 ## your option) any later version. | |
2313 | 9 ## |
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. | |
14 ## | |
15 ## You should have received a copy of the GNU General Public License | |
7016 | 16 ## along with Octave; see the file COPYING. If not, see |
17 ## <http://www.gnu.org/licenses/>. | |
933 | 18 |
8812
7d48766c21a5
use consistent format for doc strings of internal functions
John W. Eaton <jwe@octave.org>
parents:
7017
diff
changeset
|
19 ## -*- texinfo -*- |
7d48766c21a5
use consistent format for doc strings of internal functions
John W. Eaton <jwe@octave.org>
parents:
7017
diff
changeset
|
20 ## @deftypefn {Function File} {} __pltopt__ (@var{caller}, @var{opt}) |
6895 | 21 ## Undocumented internal function. |
8812
7d48766c21a5
use consistent format for doc strings of internal functions
John W. Eaton <jwe@octave.org>
parents:
7017
diff
changeset
|
22 ## @end deftypefn |
6895 | 23 |
3500 | 24 ## @deftypefn {Function File} {} __pltopt__ (@var{caller}, @var{opt}) |
6895 | 25 ## |
2311 | 26 ## Decode plot option strings. |
27 ## | |
3449 | 28 ## @var{opt} can currently be some combination of the following: |
2311 | 29 ## |
3449 | 30 ## @table @code |
31 ## @item "-" | |
6267 | 32 ## For solid linestyle (default). |
3717 | 33 ## |
6267 | 34 ## @item "--" |
35 ## For dashed line style. | |
3717 | 36 ## |
6267 | 37 ## @item "-." |
3717 | 38 ## For linespoints plot style. |
39 ## | |
6267 | 40 ## @item ":" |
41 ## For dots plot style. | |
3717 | 42 ## |
6267 | 43 ## @item "r" |
44 ## Red line color. | |
3717 | 45 ## |
6267 | 46 ## @item "g" |
47 ## Green line color. | |
3717 | 48 ## |
6267 | 49 ## @item "b" |
50 ## Blue line color. | |
3717 | 51 ## |
6267 | 52 ## @item "c" |
53 ## Cyan line color. | |
3717 | 54 ## |
6267 | 55 ## @item "m" |
56 ## Magenta line color. | |
4006 | 57 ## |
6267 | 58 ## @item "y" |
59 ## Yellow line color. | |
3717 | 60 ## |
6267 | 61 ## @item "k" |
62 ## Black line color. | |
3717 | 63 ## |
6267 | 64 ## @item "w" |
65 ## White line color. | |
3717 | 66 ## |
3449 | 67 ## @item ";title;" |
68 ## Here @code{"title"} is the label for the key. | |
3717 | 69 ## |
6267 | 70 ## @item "+" |
71 ## @itemx "o" | |
72 ## @itemx "*" | |
73 ## @itemx "." | |
74 ## @itemx "x" | |
75 ## @itemx "s" | |
76 ## @itemx "d" | |
77 ## @itemx "^" | |
78 ## @itemx "v" | |
79 ## @itemx ">" | |
80 ## @itemx "<" | |
81 ## @itemx "p" | |
82 ## @itemx "h" | |
3717 | 83 ## Used in combination with the points or linespoints styles, set the point |
84 ## style. | |
3449 | 85 ## @end table |
2311 | 86 ## |
3449 | 87 ## The legend may be fixed to include the name of the variable |
88 ## plotted in some future version of Octave. | |
933 | 89 |
3162 | 90 ## Author: jwe |
2314 | 91 |
6459 | 92 function [options, valid] = __pltopt__ (caller, opt, err_on_invalid) |
93 | |
94 valid = true; | |
95 options = __default_plot_options__ (); | |
933 | 96 |
6459 | 97 if ((nargin == 2 || nargin == 3) && (nargout == 1 || nargout == 2)) |
98 if (nargin == 2) | |
99 err_on_invalid = true; | |
100 endif | |
6146 | 101 if (ischar (opt)) |
102 nel = rows (opt); | |
103 elseif (iscellstr (opt)) | |
104 nel = numel (opt); | |
105 else | |
106 error ("__pltopt__: expecting argument to be character string or cell array of character strings"); | |
107 endif | |
108 if (ischar (opt)) | |
109 opt = cellstr (opt); | |
110 endif | |
6264 | 111 for i = nel:-1:1 |
6459 | 112 [options(i), valid] = __pltopt1__ (caller, opt{i}, err_on_invalid); |
113 if (! err_on_invalid && ! valid) | |
10549 | 114 return; |
6459 | 115 endif |
6146 | 116 endfor |
117 else | |
6046 | 118 print_usage (); |
933 | 119 endif |
120 | |
121 endfunction | |
9896
1aeb39118764
convert some plot functions to subfunctions or make some them private
John W. Eaton <jwe@octave.org>
parents:
8920
diff
changeset
|
122 |
1aeb39118764
convert some plot functions to subfunctions or make some them private
John W. Eaton <jwe@octave.org>
parents:
8920
diff
changeset
|
123 ## Really decode plot option strings. |
1aeb39118764
convert some plot functions to subfunctions or make some them private
John W. Eaton <jwe@octave.org>
parents:
8920
diff
changeset
|
124 |
1aeb39118764
convert some plot functions to subfunctions or make some them private
John W. Eaton <jwe@octave.org>
parents:
8920
diff
changeset
|
125 ## Author: Rick Niles <niles@axp745.gsfc.nasa.gov> |
1aeb39118764
convert some plot functions to subfunctions or make some them private
John W. Eaton <jwe@octave.org>
parents:
8920
diff
changeset
|
126 ## Adapted-By: jwe |
1aeb39118764
convert some plot functions to subfunctions or make some them private
John W. Eaton <jwe@octave.org>
parents:
8920
diff
changeset
|
127 ## Maintainer: jwe |
1aeb39118764
convert some plot functions to subfunctions or make some them private
John W. Eaton <jwe@octave.org>
parents:
8920
diff
changeset
|
128 |
1aeb39118764
convert some plot functions to subfunctions or make some them private
John W. Eaton <jwe@octave.org>
parents:
8920
diff
changeset
|
129 function [options, valid] = __pltopt1__ (caller, opt, err_on_invalid) |
1aeb39118764
convert some plot functions to subfunctions or make some them private
John W. Eaton <jwe@octave.org>
parents:
8920
diff
changeset
|
130 |
1aeb39118764
convert some plot functions to subfunctions or make some them private
John W. Eaton <jwe@octave.org>
parents:
8920
diff
changeset
|
131 options = __default_plot_options__ (); |
1aeb39118764
convert some plot functions to subfunctions or make some them private
John W. Eaton <jwe@octave.org>
parents:
8920
diff
changeset
|
132 valid = true; |
1aeb39118764
convert some plot functions to subfunctions or make some them private
John W. Eaton <jwe@octave.org>
parents:
8920
diff
changeset
|
133 |
1aeb39118764
convert some plot functions to subfunctions or make some them private
John W. Eaton <jwe@octave.org>
parents:
8920
diff
changeset
|
134 more_opts = 1; |
1aeb39118764
convert some plot functions to subfunctions or make some them private
John W. Eaton <jwe@octave.org>
parents:
8920
diff
changeset
|
135 |
1aeb39118764
convert some plot functions to subfunctions or make some them private
John W. Eaton <jwe@octave.org>
parents:
8920
diff
changeset
|
136 if (nargin != 2 && nargin != 3) |
1aeb39118764
convert some plot functions to subfunctions or make some them private
John W. Eaton <jwe@octave.org>
parents:
8920
diff
changeset
|
137 print_usage (); |
1aeb39118764
convert some plot functions to subfunctions or make some them private
John W. Eaton <jwe@octave.org>
parents:
8920
diff
changeset
|
138 endif |
1aeb39118764
convert some plot functions to subfunctions or make some them private
John W. Eaton <jwe@octave.org>
parents:
8920
diff
changeset
|
139 |
1aeb39118764
convert some plot functions to subfunctions or make some them private
John W. Eaton <jwe@octave.org>
parents:
8920
diff
changeset
|
140 if (! ischar (opt)) |
1aeb39118764
convert some plot functions to subfunctions or make some them private
John W. Eaton <jwe@octave.org>
parents:
8920
diff
changeset
|
141 return; |
1aeb39118764
convert some plot functions to subfunctions or make some them private
John W. Eaton <jwe@octave.org>
parents:
8920
diff
changeset
|
142 endif |
1aeb39118764
convert some plot functions to subfunctions or make some them private
John W. Eaton <jwe@octave.org>
parents:
8920
diff
changeset
|
143 |
1aeb39118764
convert some plot functions to subfunctions or make some them private
John W. Eaton <jwe@octave.org>
parents:
8920
diff
changeset
|
144 have_linestyle = false; |
1aeb39118764
convert some plot functions to subfunctions or make some them private
John W. Eaton <jwe@octave.org>
parents:
8920
diff
changeset
|
145 have_marker = false; |
1aeb39118764
convert some plot functions to subfunctions or make some them private
John W. Eaton <jwe@octave.org>
parents:
8920
diff
changeset
|
146 |
1aeb39118764
convert some plot functions to subfunctions or make some them private
John W. Eaton <jwe@octave.org>
parents:
8920
diff
changeset
|
147 ## If called by __errplot__, extract the linestyle before proceeding. |
1aeb39118764
convert some plot functions to subfunctions or make some them private
John W. Eaton <jwe@octave.org>
parents:
8920
diff
changeset
|
148 if (strcmp (caller,"__errplot__")) |
1aeb39118764
convert some plot functions to subfunctions or make some them private
John W. Eaton <jwe@octave.org>
parents:
8920
diff
changeset
|
149 if (strncmp (opt, "#~>", 3)) |
1aeb39118764
convert some plot functions to subfunctions or make some them private
John W. Eaton <jwe@octave.org>
parents:
8920
diff
changeset
|
150 n = 3; |
1aeb39118764
convert some plot functions to subfunctions or make some them private
John W. Eaton <jwe@octave.org>
parents:
8920
diff
changeset
|
151 elseif (strncmp (opt, "#~", 2) || strncmp (opt, "~>", 2)) |
1aeb39118764
convert some plot functions to subfunctions or make some them private
John W. Eaton <jwe@octave.org>
parents:
8920
diff
changeset
|
152 n = 2; |
11587
c792872f8942
all script files: untabify and strip trailing whitespace
John W. Eaton <jwe@octave.org>
parents:
11523
diff
changeset
|
153 elseif (strncmp (opt, "~", 1) || strncmp (opt, ">", 1) |
10549 | 154 || strncmp (opt, "#", 1)) |
9896
1aeb39118764
convert some plot functions to subfunctions or make some them private
John W. Eaton <jwe@octave.org>
parents:
8920
diff
changeset
|
155 n = 1; |
10575
3eba2cc7cbda
Allow matlab style linestyles in errorbar plots
David Bateman <dbateman@free.fr>
parents:
10549
diff
changeset
|
156 else |
3eba2cc7cbda
Allow matlab style linestyles in errorbar plots
David Bateman <dbateman@free.fr>
parents:
10549
diff
changeset
|
157 n = 0; |
9896
1aeb39118764
convert some plot functions to subfunctions or make some them private
John W. Eaton <jwe@octave.org>
parents:
8920
diff
changeset
|
158 endif |
10580
1479b93ee655
Respect linestyleorder in errorbar plots
David Bateman <dbateman@free.fr>
parents:
10575
diff
changeset
|
159 options.errorstyle = opt(1:n); |
10135
4516a0c97ced
Handle linestyleorder. Remove @ markers. Treat edgecolor, markeredgecolor and markerfacecolor correctly in scatter.
David Bateman <dbateman@free.fr>
parents:
10121
diff
changeset
|
160 opt(1:n) = []; |
10580
1479b93ee655
Respect linestyleorder in errorbar plots
David Bateman <dbateman@free.fr>
parents:
10575
diff
changeset
|
161 else |
1479b93ee655
Respect linestyleorder in errorbar plots
David Bateman <dbateman@free.fr>
parents:
10575
diff
changeset
|
162 options.errorstyle = "~"; |
9896
1aeb39118764
convert some plot functions to subfunctions or make some them private
John W. Eaton <jwe@octave.org>
parents:
8920
diff
changeset
|
163 endif |
1aeb39118764
convert some plot functions to subfunctions or make some them private
John W. Eaton <jwe@octave.org>
parents:
8920
diff
changeset
|
164 |
1aeb39118764
convert some plot functions to subfunctions or make some them private
John W. Eaton <jwe@octave.org>
parents:
8920
diff
changeset
|
165 while (! isempty (opt)) |
1aeb39118764
convert some plot functions to subfunctions or make some them private
John W. Eaton <jwe@octave.org>
parents:
8920
diff
changeset
|
166 if (strncmp (opt, "--", 2) || strncmp (opt, "-.", 2)) |
1aeb39118764
convert some plot functions to subfunctions or make some them private
John W. Eaton <jwe@octave.org>
parents:
8920
diff
changeset
|
167 options.linestyle = opt(1:2); |
1aeb39118764
convert some plot functions to subfunctions or make some them private
John W. Eaton <jwe@octave.org>
parents:
8920
diff
changeset
|
168 have_linestyle = true; |
1aeb39118764
convert some plot functions to subfunctions or make some them private
John W. Eaton <jwe@octave.org>
parents:
8920
diff
changeset
|
169 n = 2; |
1aeb39118764
convert some plot functions to subfunctions or make some them private
John W. Eaton <jwe@octave.org>
parents:
8920
diff
changeset
|
170 else |
1aeb39118764
convert some plot functions to subfunctions or make some them private
John W. Eaton <jwe@octave.org>
parents:
8920
diff
changeset
|
171 topt = opt(1); |
1aeb39118764
convert some plot functions to subfunctions or make some them private
John W. Eaton <jwe@octave.org>
parents:
8920
diff
changeset
|
172 n = 1; |
1aeb39118764
convert some plot functions to subfunctions or make some them private
John W. Eaton <jwe@octave.org>
parents:
8920
diff
changeset
|
173 if (topt == "-" || topt == ":") |
10549 | 174 have_linestyle = true; |
175 options.linestyle = topt; | |
9896
1aeb39118764
convert some plot functions to subfunctions or make some them private
John W. Eaton <jwe@octave.org>
parents:
8920
diff
changeset
|
176 elseif (topt == "+" || topt == "o" || topt == "*" |
10549 | 177 || topt == "." || topt == "x" || topt == "s" |
178 || topt == "d" || topt == "^" || topt == "v" | |
179 || topt == ">" || topt == "<" || topt == "p" | |
180 || topt == "h" || topt == "@") | |
181 have_marker = true; | |
10135
4516a0c97ced
Handle linestyleorder. Remove @ markers. Treat edgecolor, markeredgecolor and markerfacecolor correctly in scatter.
David Bateman <dbateman@free.fr>
parents:
10121
diff
changeset
|
182 ## Backward compatibility. Leave undocumented. |
10549 | 183 if (topt == "@") |
184 topt = "+"; | |
185 endif | |
186 options.marker = topt; | |
9896
1aeb39118764
convert some plot functions to subfunctions or make some them private
John W. Eaton <jwe@octave.org>
parents:
8920
diff
changeset
|
187 ### Numeric color specs for backward compatibility. Leave undocumented. |
1aeb39118764
convert some plot functions to subfunctions or make some them private
John W. Eaton <jwe@octave.org>
parents:
8920
diff
changeset
|
188 elseif (topt == "k" || topt == "0") |
10549 | 189 options.color = [0, 0, 0]; |
9896
1aeb39118764
convert some plot functions to subfunctions or make some them private
John W. Eaton <jwe@octave.org>
parents:
8920
diff
changeset
|
190 elseif (topt == "r" || topt == "1") |
10549 | 191 options.color = [1, 0, 0]; |
9896
1aeb39118764
convert some plot functions to subfunctions or make some them private
John W. Eaton <jwe@octave.org>
parents:
8920
diff
changeset
|
192 elseif (topt == "g" || topt == "2") |
10549 | 193 options.color = [0, 1, 0]; |
9896
1aeb39118764
convert some plot functions to subfunctions or make some them private
John W. Eaton <jwe@octave.org>
parents:
8920
diff
changeset
|
194 elseif (topt == "b" || topt == "3") |
10549 | 195 options.color = [0, 0, 1]; |
9896
1aeb39118764
convert some plot functions to subfunctions or make some them private
John W. Eaton <jwe@octave.org>
parents:
8920
diff
changeset
|
196 elseif (topt == "y") |
10549 | 197 options.color = [1, 1, 0]; |
9896
1aeb39118764
convert some plot functions to subfunctions or make some them private
John W. Eaton <jwe@octave.org>
parents:
8920
diff
changeset
|
198 elseif (topt == "m" || topt == "4") |
10549 | 199 options.color = [1, 0, 1]; |
9896
1aeb39118764
convert some plot functions to subfunctions or make some them private
John W. Eaton <jwe@octave.org>
parents:
8920
diff
changeset
|
200 elseif (topt == "c" || topt == "5") |
10549 | 201 options.color = [0, 1, 1]; |
9896
1aeb39118764
convert some plot functions to subfunctions or make some them private
John W. Eaton <jwe@octave.org>
parents:
8920
diff
changeset
|
202 elseif (topt == "w" || topt == "6") |
10549 | 203 options.color = [1, 1, 1]; |
9896
1aeb39118764
convert some plot functions to subfunctions or make some them private
John W. Eaton <jwe@octave.org>
parents:
8920
diff
changeset
|
204 elseif (isspace (topt)) |
10549 | 205 ## Do nothing. |
9896
1aeb39118764
convert some plot functions to subfunctions or make some them private
John W. Eaton <jwe@octave.org>
parents:
8920
diff
changeset
|
206 elseif (topt == ";") |
10549 | 207 t = index (opt(2:end), ";"); |
208 if (t) | |
14236
35903f035390
Escaping strings for legend entries are handled by __go_draw_axes__.
Ben Abbott <bpabbott@mac.com>
parents:
14138
diff
changeset
|
209 options.key = opt(2:t); |
10549 | 210 n = t+1; |
211 else | |
212 if (err_on_invalid) | |
9896
1aeb39118764
convert some plot functions to subfunctions or make some them private
John W. Eaton <jwe@octave.org>
parents:
8920
diff
changeset
|
213 error ("%s: unfinished key label", caller); |
10549 | 214 else |
215 valid = false; | |
216 options = __default_plot_options__ (); | |
217 return; | |
218 endif | |
9896
1aeb39118764
convert some plot functions to subfunctions or make some them private
John W. Eaton <jwe@octave.org>
parents:
8920
diff
changeset
|
219 endif |
1aeb39118764
convert some plot functions to subfunctions or make some them private
John W. Eaton <jwe@octave.org>
parents:
8920
diff
changeset
|
220 else |
10549 | 221 if (err_on_invalid) |
15466
d174210ce1ec
use ' instead of ` in error messages, warnings and most comments
John W. Eaton <jwe@octave.org>
parents:
14138
diff
changeset
|
222 error ("%s: unrecognized format character: '%s'", caller, topt); |
10549 | 223 else |
224 valid = false; | |
225 options = __default_plot_options__ (); | |
226 return; | |
227 endif | |
9896
1aeb39118764
convert some plot functions to subfunctions or make some them private
John W. Eaton <jwe@octave.org>
parents:
8920
diff
changeset
|
228 endif |
1aeb39118764
convert some plot functions to subfunctions or make some them private
John W. Eaton <jwe@octave.org>
parents:
8920
diff
changeset
|
229 endif |
1aeb39118764
convert some plot functions to subfunctions or make some them private
John W. Eaton <jwe@octave.org>
parents:
8920
diff
changeset
|
230 opt(1:n) = []; |
1aeb39118764
convert some plot functions to subfunctions or make some them private
John W. Eaton <jwe@octave.org>
parents:
8920
diff
changeset
|
231 endwhile |
1aeb39118764
convert some plot functions to subfunctions or make some them private
John W. Eaton <jwe@octave.org>
parents:
8920
diff
changeset
|
232 |
10135
4516a0c97ced
Handle linestyleorder. Remove @ markers. Treat edgecolor, markeredgecolor and markerfacecolor correctly in scatter.
David Bateman <dbateman@free.fr>
parents:
10121
diff
changeset
|
233 if (! have_linestyle && have_marker) |
9896
1aeb39118764
convert some plot functions to subfunctions or make some them private
John W. Eaton <jwe@octave.org>
parents:
8920
diff
changeset
|
234 options.linestyle = "none"; |
1aeb39118764
convert some plot functions to subfunctions or make some them private
John W. Eaton <jwe@octave.org>
parents:
8920
diff
changeset
|
235 endif |
1aeb39118764
convert some plot functions to subfunctions or make some them private
John W. Eaton <jwe@octave.org>
parents:
8920
diff
changeset
|
236 |
10135
4516a0c97ced
Handle linestyleorder. Remove @ markers. Treat edgecolor, markeredgecolor and markerfacecolor correctly in scatter.
David Bateman <dbateman@free.fr>
parents:
10121
diff
changeset
|
237 if (have_linestyle && ! have_marker) |
4516a0c97ced
Handle linestyleorder. Remove @ markers. Treat edgecolor, markeredgecolor and markerfacecolor correctly in scatter.
David Bateman <dbateman@free.fr>
parents:
10121
diff
changeset
|
238 options.marker = "none"; |
4516a0c97ced
Handle linestyleorder. Remove @ markers. Treat edgecolor, markeredgecolor and markerfacecolor correctly in scatter.
David Bateman <dbateman@free.fr>
parents:
10121
diff
changeset
|
239 endif |
4516a0c97ced
Handle linestyleorder. Remove @ markers. Treat edgecolor, markeredgecolor and markerfacecolor correctly in scatter.
David Bateman <dbateman@free.fr>
parents:
10121
diff
changeset
|
240 |
9896
1aeb39118764
convert some plot functions to subfunctions or make some them private
John W. Eaton <jwe@octave.org>
parents:
8920
diff
changeset
|
241 endfunction |