Debian Codegraph @

texmf-dist/doc/latex/mercatormap/mercatormap.doc.marker.tex

raw
1 % !TeX root = mercatormap.tex
2 % !TeX encoding=UTF-8
3 % !TeX spellcheck=en_US
4 % include file of mercatormap.tex (manual of the LaTeX package mercatormap)
5 \clearpage
6 \section{Markers}%
7 As described before, a map can be amended by arbitrary \tikzname\ code
8 using map coordinates.
9 For highlighting places or adding markers, the \refCom{mrcmarker} macro
10 may be helpful which provides some predefined marker types.
11
12 %-------------------------------------------------------------------------------
13 \subsection{Marker Settings}
14
15 \begin{docCommand}{mrcmarker}{\marg{options}}
16 Places a marker according to the given \meta{options} on the map.
17 All \meta{options} share the common prefix |mermap/marker/|.
18 Different \refKey{mermap/marker/type} settings are available which are
19 more or less customizable.
20
21 \tikzsetnextfilename{marker_mrcmarker}%
22 \begin{dispExample}
23 % \mrcsetapikey{thunderforest}{YOUR-API-KEY} % registered key
24 \begin{tikzpicture}
25 \mrcmap[type=reference, position=48.15:11.6,
26 flex reference scale=500 000,
27 source=thunderforest neighbourhood,
28 tex width=\linewidth,tex height=4cm]{marker_mrcmarker}
29 \mrcdrawmap
30 \node[below,font=\fontsize{7pt}{7pt}\sffamily] at (mrcmap.south)
31 {\mrcmapattribution};
32 \mrcdrawnetwork
33 \mrcclipmap
34 \mermapsetmarker{draw=red, fill=red!20!white, font=\sffamily\footnotesize}
35 \mrcmarker{type=classic, position=48.15:11.2, contents={A}, radius=0.5mm}
36 \mrcmarker{type=pin, position=48.15:11.3, contents={B}}
37 \mrcmarker{type=pinflip, position=48.15:11.4, contents={C}}
38 \mrcmarker{type=drop, position=48.15:11.5, contents={D}}
39 \mrcmarker{type=knob, position=48.15:11.6, contents={E}}
40 \mrcmarker{type=pictodropring, position=48.15:11.7, contents={F}}
41 \mrcmarker{type=pictoknobring, position=48.15:11.8, contents={G}}
42 \mrcmarker{type=ringx, position=48.15:11.9, contents={H}}
43 \mrcmarker{type=markx, position=48.15:12, contents={I}}
44 \end{tikzpicture}
45 \end{dispExample}
46 \end{docCommand}
47
48
49 \begin{docCommand}{mermapsetmarker}{\marg{options}}
50 Sets \meta{options} for all following markers inside the current \TeX\ group.
51 All options share the common prefix |mermap/marker/|, e.g. for setting
52 \refKey{mermap/marker/type} use
53 \begin{dispListing}
54 \mermapsetmarker{type=pin}
55 \end{dispListing}
56 Also see \refCom{mermapset} and \refCom{mermapsetsupply}.
57 \end{docCommand}
58
59 \pagebreak
60
61 \begin{docMrcKey}[marker]{first options}{=\meta{options}}{no default, initially unset}
62 The given list of \meta{options} is used inside every \refCom{mrcmarker}
63 \emph{before} the options of \refCom{mrcmarker}.
64 \end{docMrcKey}
65
66 \begin{docMrcKey}[marker]{last options}{=\meta{options}}{no default, initially unset}
67 The given list of \meta{options} is used inside every \refCom{mrcmarker}
68 \emph{after} the options of \refCom{mrcmarker}.
69 \end{docMrcKey}
70
71 \begin{docMrcKey}[marker]{latitude}{=\meta{latitude}}{no default, initially |12|}
72 Latitude degree of the place marker.
73 It is accessible as \docAuxCommand{mrcmarkerlatitude} (use read-only).
74 \end{docMrcKey}
75
76 \begin{docMrcKey}[marker]{lat}{=\meta{latitude}}{no default, initially |12|}
77 Alias for \refKey{mermap/marker/latitude}.
78 \end{docMrcKey}
79
80 \begin{docMrcKey}[marker]{longitude}{=\meta{longitude}}{no default, initially |49|}
81 Longitude degree of the place marker.
82 It is accessible as \docAuxCommand{mrcmarkerlongitude} (use read-only).
83 \end{docMrcKey}
84
85 \begin{docMrcKey}[marker]{lon}{=\meta{longitude}}{no default, initially |49|}
86 Alias for \refKey{mermap/marker/longitude}.
87 \end{docMrcKey}
88
89 \begin{docMrcKey}[marker]{position}{=\meta{place latitude}:\meta{place longitude}}{no default, initially |12:49|}
90 Sets the latitude degree and the longitude degree of the place marker.
91 \end{docMrcKey}
92
93 \begin{docMrcKey}[marker]{named position}{=\meta{name}}{style, no default}
94 Sets the latitude degree and the longitude degree of the place marker
95 to the \emph{named position} denoted by \meta{name}, see \Fullref{sec:names_positions}.
96 \end{docMrcKey}
97
98 \begin{docMrcKey}[marker]{use inside}{=\meta{area}}{no default, initially |map|}
99 The place marker is used or ignored according to its belonging inside the
100 given \meta{area}. Feasible values for \meta{area} are:
101 \begin{itemize}
102 \item\docValue{map}: Use inside map.
103 \item\docValue{vicinity}: Use inside map plus vicinity, see \refKey{mermap/vicinity}.
104 \end{itemize}
105 \end{docMrcKey}
106
107
108 \begin{docMrcKey}[marker]{contents}{=\meta{text}}{no default, initially empty}
109 Sets \meta{text} for displaying inside the marker, if
110 the marker type supports such a thing.
111 It is accessible as \docAuxCommand{mrcmarkercontents} (use read-only).
112 \end{docMrcKey}
113
114 \begin{docMrcKey}[marker]{pictocontents}{=\meta{code}}{no default, initially empty}
115 Sets \tikzname\ \meta{code} for displaying inside the marker, if
116 the marker type supports such a thing.
117 It is accessible as \docAuxCommand{mrcmarkerpictocontents} (use read-only).
118 \end{docMrcKey}
119
120 \begin{docMrcKey}[marker]{alias}{=\meta{text}}{no default, initially |noname|}
121 The position of the marker is available as \tikzname\ coordinate by
122 the given \meta{text}, e.g. to draw to or from the marker.
123 \end{docMrcKey}
124
125 \begin{docMrcKey}[marker][doc updated=2020-05-04]{uuid}{=\meta{uuid}}{no default, initially empty}
126 Sets a \meta{uuid} for unique identification of markers.
127 It is accessible as \docAuxCommand{mrcmarkeruuid} (use read-only)
128 and \docAuxCommand[doc sort index=mermap_marker_uuid_tl]{l_mermap_marker_uuid_tl} (use read-only).
129 The \meta{uuid} is provided for user applications.
130 \end{docMrcKey}
131
132 \begin{docMrcKeys}[
133 doc keypath = marker,
134 doc name = generic,
135 doc parameter = {=\meta{text}},
136 doc description = {no default, initially empty},
137 doc new = 2020-05-04,
138 ]{}
139 Sets \meta{text} as generic content for user applications.
140 It is accessible as \docAuxCommand{mrcmarkergeneric} (use read-only)
141 and \docAuxCommand[doc sort index=mermap_marker_generic_tl]{l_mermap_marker_generic_tl} (use read-only).
142 \end{docMrcKeys}
143
144
145 \begin{docMrcKey}[marker]{category}{=\meta{category}}{no default, initially empty}
146 Sets a \meta{category} to group markers.
147 It is accessible as \docAuxCommand{mrcmarkercategory} (use read-only).
148 \end{docMrcKey}
149
150 \clearpage
151
152 \begin{docMrcKey}[marker]{show}{\colOpt{=true\textbar false}}{default |true|, initially |true|}
153 If set to |true|, the marker is shown, if it lies inside the map (or vicinity).
154 Otherwise, the place marker is not used.
155 \end{docMrcKey}
156
157
158 \begin{docMrcKey}[marker]{hide}{\colOpt{=true\textbar false}}{default |true|, initially |false|}
159 If set to |true|, the marker is not used.
160 \refKey{mermap/marker/hide} is inverse to \refKey{mermap/marker/show}.
161 \end{docMrcKey}
162
163
164
165 \begin{docMrcKey}[marker]{show category}{=\meta{category}}{style, no default}
166 Sets \refKey{mermap/marker/show} to |true|, if \refKey{mermap/marker/category} equals \meta{category}.
167 Otherwise, nothing happens.
168 \refKey{mermap/marker/category} has to be set \emph{before}.
169 \end{docMrcKey}
170
171
172 \begin{docMrcKey}[marker]{show all but category}{=\meta{category}}{style, no default}
173 Sets \refKey{mermap/marker/show} to |true|, if \refKey{mermap/marker/category} does not equal \meta{category}.
174 Otherwise, nothing happens.
175 \refKey{mermap/marker/category} has to be set \emph{before}.
176 \end{docMrcKey}
177
178
179 \begin{docMrcKey}[marker]{hide category}{=\meta{category}}{style, no default}
180 Sets \refKey{mermap/marker/show} to |false|, if \refKey{mermap/marker/category} equals \meta{category}.
181 Otherwise, nothing happens.
182 \refKey{mermap/marker/category} has to be set \emph{before}.
183 \end{docMrcKey}
184
185
186 \begin{docMrcKey}[marker]{hide all but category}{=\meta{category}}{style, no default}
187 Sets \refKey{mermap/marker/show} to |false|, if \refKey{mermap/marker/category} does not equal \meta{category}.
188 Otherwise, nothing happens.
189 \refKey{mermap/marker/category} has to be set \emph{before}.
190 \tikzsetnextfilename{marker_hide}%
191 \begin{dispExample}
192 \begin{tikzpicture}
193 \mrcmap[tex width=4cm, tex height=4cm,
194 latitude=48.14, longitude=11.57, target=none]{marker_hide}
195 \mrcdrawmap[draw=path]
196 \mermapsetmarker{last options={hide all but category=A}}
197 \mrcmarker{type=knob,position=48.00:11.43,fill=blue,category=A}
198 \mrcmarker{type=knob,position=48.28:11.43,fill=red,category=B}
199 \mrcmarker{type=knob,position=48.00:11.71,fill=blue,category=A}
200 \mrcmarker{type=knob,position=48.28:11.71,fill=red,category=B}
201 \end{tikzpicture}
202 \end{dispExample}
203 \end{docMrcKey}
204
205
206 \clearpage
207
208 The following options require the package |hyperref| to be loaded.
209 If |hyperref| is not loaded, \refKey{mermap/marker/url} and
210 \refKey{mermap/marker/link} are ignored.\\
211 Note that if \refKey{mermap/marker/url} and \refKey{mermap/marker/link}
212 are applied concurrently, then \refKey{mermap/marker/link} will win.
213
214
215 \begin{docMrcKeys}[
216 doc keypath = marker,
217 doc name = url,
218 doc parameter = {=\meta{URL}},
219 doc description = {no default, initially empty},
220 doc new = 2020-05-04,
221 ]{}
222 Sets \meta{URL} as external link of the marker.
223 The package is required for this option.
224 For an own marker type, it is applied as \tikzname\ option \docValue{mrchyperpath}.
225
226 \tikzsetnextfilename{marker_url}%
227 \begin{dispExample}
228 \begin{tikzpicture}
229 \mrcNPdef{unibwm}{48.0802826}{11.6381048}
230 \mrcmap[type=reference, named position=unibwm,
231 flex reference scale=100000,
232 source=topplusopen web grau,
233 tex width=\linewidth,tex height=4cm]{marker_url}
234 \mrcdrawmap
235 \node[below,font=\fontsize{7pt}{7pt}\sffamily] at (mrcmap.south)
236 {\mrcmapattribution};
237 \mrcdrawnetwork
238 \mrcclipmap
239 \mrcmarker{ named position = unibwm,
240 type = pin,
241 draw = red,
242 fill = red!20!white,
243 url = {https://www.unibw.de},
244 contents = {Universit\"at der Bundeswehr M\"unchen},
245 }
246 \end{tikzpicture}
247 \end{dispExample}
248
249
250 \end{docMrcKeys}
251
252
253 \begin{docMrcKeys}[
254 doc keypath = marker,
255 doc name = link,
256 doc parameter = {=\meta{name}},
257 doc description = {no default, initially empty},
258 doc new = 2020-05-04,
259 ]{}
260 Sets an internal link of the marker to a document target with
261 the given \meta{name}.
262 The package |hyperref| is required for this option.
263 For an own marker type, it is applied as \tikzname\ option \docValue{mrchyperpath}.
264 \end{docMrcKeys}
265
266
267
268 \begin{docMrcKeys}[
269 doc keypath = marker,
270 doc parameter = {\colOpt{=true\textbar false}},
271 doc new = 2020-05-04,
272 ]{
273 {
274 doc name = use urls,
275 doc description = {default |true|, initially |true|},
276 },
277 {
278 doc name = ignore urls,
279 doc description = {default |true|, initially |false|},
280 },
281 }
282 If \refKey{mermap/marker/use urls} is set to |false|, external links
283 with \refKey{mermap/marker/url} are ignored.\\
284 \refKey{mermap/marker/ignore urls} is inverse to \refKey{mermap/marker/use urls}.
285 \end{docMrcKeys}
286
287
288 \begin{docMrcKeys}[
289 doc keypath = marker,
290 doc parameter = {\colOpt{=true\textbar false}},
291 doc new = 2020-05-04,
292 ]{
293 {
294 doc name = use links,
295 doc description = {default |true|, initially |true|},
296 },
297 {
298 doc name = ignore links,
299 doc description = {default |true|, initially |false|},
300 },
301 }
302 If \refKey{mermap/marker/use links} is set to |false|, internal links
303 with \refKey{mermap/marker/link} are ignored.\\
304 \refKey{mermap/marker/ignore links} is inverse to \refKey{mermap/marker/use links}.
305 \end{docMrcKeys}
306
307
308
309 \clearpage
310 %-------------------------------------------------------------------------------
311 \subsection{Marker Types}
312
313 \begin{docMrcKey}[marker]{type}{=\meta{type}}{no default, initially |classic|}
314 Decides about the basic shape and style of the marker.
315 Feasible values for \meta{type} are listed in the following.
316 More values can be defined by \refCom{mrcnewmarkertype}.
317 \begin{itemize}
318 %
319 \item\docValue{classic}:
320 \tikzsetnextfilename{marker_classic}%
321 \begin{dispExample}
322 \begin{tikzpicture}
323 \mrcmap[tex width=8cm, tex height=4cm, zoom=10,
324 latitude=48.14, longitude=11.48, target=none]{marker_classic}
325 \mrcdrawmap[draw=path]
326 \mermapsetmarker{type=classic}
327 \mrcmarker{position=48.14:11.36, contents={Germering}}
328 \mermapsetmarker{type=classic, text=blue, font=\sffamily\footnotesize}
329 \mrcmarker{position=48.14:11.57, contents={M\"unchen}, angle=-30}
330 \end{tikzpicture}
331 \end{dispExample}
332 %
333 \item\docValue{pin}:
334 \tikzsetnextfilename{marker_pin}%
335 \begin{dispExample}
336 \begin{tikzpicture}
337 \mrcmap[tex width=8cm, tex height=4cm, zoom=10,
338 latitude=48.14, longitude=11.48, target=none]{marker_pin}
339 \mrcdrawmap[draw=path]
340 \mermapsetmarker{type=pin}
341 \mrcmarker{position=48.14:11.36, contents={Germering}}
342 \mermapsetmarker{type=pin, draw=blue, fill=blue!20!white,
343 font=\sffamily\footnotesize}
344 \mrcmarker{position=48.14:11.57, contents={M\"unchen}, alias={munich}}
345 \end{tikzpicture}
346 \end{dispExample}
347 %
348 \clearpage
349 \item\docValue{pinflip}:
350 \tikzsetnextfilename{marker_pinflip}%
351 \begin{dispExample}
352 \begin{tikzpicture}
353 \mrcmap[tex width=8cm, tex height=4cm, zoom=10,
354 latitude=48.14, longitude=11.48, target=none]{marker_pinflip}
355 \mrcdrawmap[draw=path]
356 \mermapsetmarker{type=pinflip}
357 \mrcmarker{position=48.14:11.36, contents={Germering}}
358 \mermapsetmarker{type=pinflip, draw=red, fill=red!20!white,
359 font=\sffamily\footnotesize}
360 \mrcmarker{position=48.14:11.57, contents={M\"unchen}, shift=4mm}
361 \end{tikzpicture}
362 \end{dispExample}
363 %
364 \item\docValue{drop}:
365 \tikzsetnextfilename{marker_drop}%
366 \begin{dispExample}
367 \begin{tikzpicture}
368 \mrcmap[tex width=8cm, tex height=4cm, zoom=10,
369 latitude=48.14, longitude=11.48, target=none]{marker_drop}
370 \mrcdrawmap[draw=path]
371 \mermapsetmarker{type=drop}
372 \mrcmarker{position=48.14:11.36, contents={Germering}}
373 \mermapsetmarker{type=drop, fill=blue, draw=blue!20!white, text=white,
374 font=\sffamily\small\bfseries,
375 path style={line join=round, thin, draw=mrcmarkerfill,
376 double=mrcmarkerdraw,double distance=0.6pt} }
377 \mrcmarker{position=48.14:11.57, contents={M}, alias={munich}}
378 \end{tikzpicture}
379 \end{dispExample}
380 %
381 \clearpage
382 \item\docValue{pictodrop}:
383 \tikzsetnextfilename{marker_pictodrop}%
384 \begin{dispExample}
385 \begin{tikzpicture}
386 \mrcmap[tex width=8cm, tex height=4cm, zoom=10,
387 latitude=48.14, longitude=11.48, target=none]{marker_pictodrop}
388 \mrcdrawmap[draw=path]
389 \mermapsetmarker{type=pictodrop, pictocontents={
390 \draw[fill=red!70!gray,draw=white]
391 (-0.2,-0.2)--(0.2,-0.2)--(0.2,0.1)--(0,0.2)--(-0.2,0.1) -- cycle;
392 }}
393 \mrcmarker{position=48.14:11.36, contents={Germering}}
394 \mermapsetmarker{type=pictodrop,
395 fill=blue!75!gray!30, draw=blue,
396 radius=4mm, shift=-1mm}
397 \mrcmarker{position=48.14:11.57,
398 pictocontents={
399 \node {\includegraphics[width=6mm]{alertmessage-warning.png}};
400 }}
401 \end{tikzpicture}
402 \end{dispExample}
403 %
404 \item\docValue{pictodropring}:
405 \tikzsetnextfilename{marker_pictodropring}%
406 \begin{dispExample}
407 \begin{tikzpicture}
408 \mrcmap[tex width=8cm, tex height=4cm, zoom=10,
409 latitude=48.14, longitude=11.48, target=none]{marker_pictodropring}
410 \mrcdrawmap[draw=path]
411 \mermapsetmarker{type=pictodropring}
412 \mrcmarker{position=48.14:11.36, contents={Germering}}
413 \mermapsetmarker{type=pictodropring,
414 fill=red!50!gray, draw=red!75!white,
415 shift=-1mm}
416 \mrcmarker{position=48.14:11.57}
417 \end{tikzpicture}
418 \end{dispExample}
419 %
420 \clearpage
421 \item\docValue{knob}:
422 \tikzsetnextfilename{marker_knob}%
423 \begin{dispExample}
424 \begin{tikzpicture}
425 \mrcmap[tex width=8cm, tex height=4cm, zoom=10,
426 latitude=48.14, longitude=11.48, target=none]{marker_knob}
427 \mrcdrawmap[draw=path]
428 \mermapsetmarker{type=knob}
429 \mrcmarker{position=48.14:11.36, contents={Germering}}
430 \mermapsetmarker{type=knob, radius=2mm,
431 fill=blue, draw=blue!20!white,
432 text=white, path style={draw=mrcmarkerfill, double=mrcmarkerdraw,
433 double distance=0.6pt} }
434 \mrcmarker{position=48.14:11.57, contents={M}}
435 \end{tikzpicture}
436 \end{dispExample}
437 %
438 \item\docValue{pictoknob}:
439 \tikzsetnextfilename{marker_pictoknob}%
440 \begin{dispExample}
441 \begin{tikzpicture}
442 \mrcmap[tex width=8cm, tex height=4cm, zoom=10,
443 latitude=48.14, longitude=11.48, target=none]{marker_pictoknob}
444 \mrcdrawmap[draw=path]
445 \mermapsetmarker{type=pictoknob}
446 \mrcmarker{position=48.14:11.36, contents={Germering}}
447 \mermapsetmarker{type=pictoknob, radius=2mm,
448 fill=blue, draw=blue!20!white,
449 path style={draw=mrcmarkerfill, double=mrcmarkerdraw,
450 double distance=0.6pt} }
451 \mrcmarker{position=48.14:11.57, alias={munich}}
452 \end{tikzpicture}
453 \end{dispExample}
454 %
455 \clearpage
456 \item\docValue{pictoknobring}:
457 \tikzsetnextfilename{marker_pictoknobring}%
458 \begin{dispExample}
459 \begin{tikzpicture}
460 \mrcmap[tex width=8cm, tex height=4cm, zoom=10,
461 latitude=48.14, longitude=11.48, target=none]{marker_pictoknobring}
462 \mrcdrawmap[draw=path]
463 \mermapsetmarker{type=pictoknobring}
464 \mrcmarker{position=48.14:11.36, contents={Germering}}
465 \mermapsetmarker{type=pictoknobring, radius=2mm, inner radius=1mm,
466 draw=blue, fill=blue!20!white,
467 pictocontents={\node[above] at (0,\mrcmarkerradius)
468 {\mrcmarkercontents};}
469 }
470 \mrcmarker{position=48.14:11.57, contents={M\"unchen}}
471 \end{tikzpicture}
472 \end{dispExample}
473 %
474 \item\docValue{ringx}:
475 \tikzsetnextfilename{marker_ringx}%
476 \begin{dispExample}
477 \begin{tikzpicture}
478 \mrcmap[tex width=8cm, tex height=4cm, zoom=10,
479 latitude=48.14, longitude=11.48, target=none]{marker_ringx}
480 \mrcdrawmap[draw=path]
481 \mermapsetmarker{type=ringx}
482 \mrcmarker{position=48.14:11.36, contents={Germering}}
483 \mermapsetmarker{type=ringx, radius=4mm, inner radius=3mm,
484 draw=red, fill=red!50!white,
485 path style={draw=mrcmarkerdraw, very thin, double=white,
486 double distance=0.6pt}
487 }
488 \mrcmarker{position=48.14:11.57, alias={munich}}
489 \end{tikzpicture}
490 \end{dispExample}
491 %
492 \clearpage
493 \item\docValue{markx}:
494 \tikzsetnextfilename{marker_markx}%
495 \begin{dispExample}
496 \begin{tikzpicture}
497 \mrcmap[tex width=8cm, tex height=4cm, zoom=10,
498 latitude=48.14, longitude=11.48, target=none]{marker_markx}
499 \mrcdrawmap[draw=path]
500 \mermapsetmarker{type=markx}
501 \mrcmarker{position=48.14:11.36, contents={Germering}}
502 \mermapsetmarker{type=markx, radius=4mm, inner radius=3mm,
503 draw=red, fill=red!50!white, path style={very thin}
504 }
505 \mrcmarker{position=48.14:11.57, alias={munich}}
506 \end{tikzpicture}
507 \end{dispExample}
508 %
509 \end{itemize}
510 \end{docMrcKey}
511
512 \medskip
513 The different marker types can be customized by some additional options:
514
515 \begin{docMrcKey}[marker]{font}{=\meta{font}}{no default, initially \texttt{\textbackslash sffamily\textbackslash small}}
516 Font of the marker text
517 (\docValue{classic}, \docValue{pin}, \docValue{pinflip}, \docValue{drop}, \docValue{knob}).
518 It is accessible as \docAuxCommand{mrcmarkerfont} (use read-only).
519 \end{docMrcKey}
520
521 \begin{docMrcKey}[marker]{text}{=\meta{color}}{no default, initially |black|}
522 Color of the marker text
523 (\docValue{classic}, \docValue{pin}, \docValue{pinflip}, \docValue{drop}, \docValue{knob}).
524 It is accessible as \docColor{mrcmarkertext} (use read-only).
525 \end{docMrcKey}
526
527 \begin{docMrcKey}[marker]{draw}{=\meta{color}}{no default, initially |gray|}
528 Color of the marker frame
529 (\docValue{pin}, \docValue{pinflip}, \docValue{drop}, \docValue{pictodrop},
530 \docValue{pictodropring}, \docValue{knob}, \docValue{pictoknob}, \docValue{pictoknobring},
531 \docValue{ringx}, \docValue{markx}).
532 It is accessible as \docColor{mrcmarkerdraw} (use read-only).
533 \end{docMrcKey}
534
535 \begin{docMrcKey}[marker]{fill}{=\meta{color}}{no default, initially |gray!20|}
536 Color of the marker interior
537 (\docValue{pin}, \docValue{pinflip}, \docValue{drop}, \docValue{pictodrop},
538 \docValue{pictodropring}, \docValue{knob}, \docValue{pictoknob}, \docValue{pictoknobring},
539 \docValue{ringx}, \docValue{markx}).
540 It is accessible as \docColor{mrcmarkerfill} (use read-only).
541 \end{docMrcKey}
542
543 \begin{docMrcKey}[marker]{angle}{=\meta{angle}}{no default, initially |90|}
544 Angle of the marker (\docValue{classic}).
545 It is accessible as \docAuxCommand{mrcmarkerangle} (use read-only).
546 \end{docMrcKey}
547
548 \begin{docMrcKey}[marker]{shift}{=\meta{length}}{no default, initially |0pt|}
549 Shift of the marker text
550 (\docValue{pin}, \docValue{pinflip}).
551 It also shifts the drop center
552 (\docValue{drop}, \docValue{pictodrop}, \docValue{pictodropring}).
553 It is accessible as \docAuxCommand{mrcmarkershift} (use read-only).
554 \end{docMrcKey}
555
556 \begin{docMrcKey}[marker][doc new=2020-08-06]{distance}{=\meta{length}}{no default, initially |5mm|}
557 Length of the marker needle (\docValue{pin}, \docValue{pinflip}).
558 It is accessible as \docAuxCommand{mrcmarkerdistance} (use read-only).
559 \end{docMrcKey}
560
561 \clearpage
562
563 \begin{docMrcKey}[marker]{radius}{=\meta{length}}{no default, initially |3mm|}
564 Radius of the marker
565 (\docValue{classic}, \docValue{drop}, \docValue{pictodrop},
566 \docValue{pictodropring}, \docValue{knob}, \docValue{pictoknob}, \docValue{pictoknobring},
567 \docValue{ringx}, \docValue{markx}).
568 It is accessible as \docAuxCommand{mrcmarkerradius} (use read-only).
569 \end{docMrcKey}
570
571 \begin{docMrcKey}[marker]{inner radius}{=\meta{length}}{no default, initially |2.25mm|}
572 Inner radius of the marker
573 (\docValue{pictodropring}, \docValue{pictoknobring}, \docValue{ringx}).
574 It is accessible as \docAuxCommand{mrcmarkerinnerradius} (use read-only).
575 \end{docMrcKey}
576
577 \begin{docMrcKey}[marker]{path style}{=\marg{options}}{no default, initially empty}
578 \tikzname\ \meta{options} which are added to (some) path elements of
579 of the marker
580 (\docValue{pin}, \docValue{pinflip}, \docValue{drop}, \docValue{pictodrop},
581 \docValue{pictodropring}, \docValue{knob}, \docValue{pictoknob}, \docValue{pictoknobring},
582 \docValue{ringx}, \docValue{markx}).
583 It is accessible as \tikzname\ option \docValue{mrcpathstyle} (use read-only).
584 \end{docMrcKey}
585
586 \begin{docMrcKey}[marker]{node style}{=\marg{options}}{no default, initially empty}
587 \tikzname\ \meta{options} which are added to the node element of
588 of the marker
589 (\docValue{classic}, \docValue{pin}, \docValue{pinflip}, \docValue{drop}, \docValue{knob}).
590 It is accessible as \tikzname\ option \docValue{mrcnodestyle} (use read-only).
591 \end{docMrcKey}
592
593
594
595 %-------------------------------------------------------------------------------
596 \subsection{New Marker Types}
597
598 \begin{docCommand}{mrcnewmarkertype}{\marg{type name}\marg{\tikzname\ code}}
599 Creates a new \refKey{mermap/marker/type} value \meta{type name} using the
600 given \meta{\tikzname\ code} for drawing a place marker.
601 To avoid future name clashes, you should start a private \meta{type name}
602 with letter |x|. For \meta{\tikzname\ code} settings like
603 \docAuxCommand{mrcmarkercontents},
604 \docAuxCommand{mrcmarkerfont}, or \docColor{mrcmarkerfill} may be used
605 or ignored.
606
607 \tikzsetnextfilename{marker_xmark}%
608 \begin{dispExample}
609 \mrcnewmarkertype{xmark}{
610 \path[draw=mrcmarkerdraw,thick] circle (\mrcmarkerradius);
611 \path[draw=mrcmarkerdraw,thick]
612 (45:2*\mrcmarkerradius)--(225:2*\mrcmarkerradius)
613 (135:2*\mrcmarkerradius)--(315:2*\mrcmarkerradius);
614 }
615 \begin{tikzpicture}
616 \mrcmap[tex width=4cm, tex height=4cm,
617 latitude=48.14, longitude=11.57, target=none]{marker_xmark}
618 \mrcdrawmap[draw=path]
619 \mrcmarker{type=xmark,
620 position=48.14:11.57,alias={munich},
621 draw=red}
622 \end{tikzpicture}
623 \end{dispExample}
624 \end{docCommand}
625
626
627
628 \clearpage
629 %-------------------------------------------------------------------------------
630 \subsection{New Marker Styles}
631
632 \begin{docCommand}{mrcnewmarkerstyle}{\marg{style name}\marg{options}}
633 Creates a new \refKey{mermap/marker/style} value \meta{style name} using the
634 given \meta{options} for drawing a place marker.
635 All \meta{options} share the common prefix |mermap/marker/|. Here, a \emph{style}
636 has the same concept as a \tikzname\ style.
637
638 \tikzsetnextfilename{marker_markerstyle}%
639 \begin{dispExample}
640 \begin{tikzpicture}
641 \mrcmap[tex width=8cm, tex height=4cm, zoom=10,
642 latitude=48.14, longitude=11.48, target=none]{marker_markerstyle}
643 \mrcdrawmap[draw=path]
644 \mrcnewmarkerstyle{one}{type=pin, draw=blue, fill=blue!20!white,
645 font=\sffamily\footnotesize}
646 \mrcnewmarkerstyle{two}{type=pinflip, draw=red, fill=red!20!white,
647 font=\sffamily\footnotesize}
648 \mrcmarker{style=one, position=48.14:11.36, contents={Germering}}
649 \mrcmarker{style=two, position=48.14:11.57, contents={M\"unchen}}
650 \end{tikzpicture}
651 \end{dispExample}
652
653 A \emph{style} can have one parameter, but note the small difference
654 in applying this parameter compared to \tikzname:
655
656 \tikzsetnextfilename{marker_markerstyle2}%
657 \begin{dispExample}
658 \begin{tikzpicture}
659 \mrcmap[tex width=8cm, tex height=4cm, zoom=10,
660 latitude=48.14, longitude=11.48, target=none]{marker_markerstyle2}
661 \mrcdrawmap[draw=path]
662 \mrcnewmarkerstyle{color}{type=pin, draw=#1, fill=#1!20!white,
663 font=\sffamily\footnotesize}
664 \mrcmarker{style/color=blue, position=48.14:11.36, contents={Germering}}
665 \mrcmarker{style/color=red, position=48.14:11.57, contents={M\"unchen}}
666 \end{tikzpicture}
667 \end{dispExample}
668 \end{docCommand}
669
670
671 \begin{docMrcKey}[marker]{style}{=\meta{style name}}{no default, initially unset}
672 Applies a given \meta{style name}, i.e. all options which were stored
673 by \refCom{mrcnewmarkerstyle} under this name.
674 \end{docMrcKey}
675