{{ message }}
-
Notifications
You must be signed in to change notification settings - Fork 62
Expand file tree
/
Copy pathmarkers_api.html
More file actions
461 lines (418 loc) · 19.4 KB
/
Copy pathmarkers_api.html
File metadata and controls
461 lines (418 loc) · 19.4 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<title>Markers — Matplotlib 1.5.0 documentation</title>
<link rel="stylesheet" href="../_static/mpl.css"
type="text/css" />
<link rel="stylesheet" href="../_static/pygments.css"
type="text/css" />
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT: '../',
VERSION: '1.5.0',
COLLAPSE_INDEX: false,
FILE_SUFFIX: '.html',
HAS_SOURCE: true
};
</script>
<script type="text/javascript" src="../_static/jquery.js"></script>
<script type="text/javascript" src="../_static/underscore.js"></script>
<script type="text/javascript" src="../_static/doctools.js"></script>
<link rel="search" type="application/opensearchdescription+xml"
title="Search within Matplotlib 1.5.0 documentation"
href="../_static/opensearch.xml"/>
<link rel="top" title="Matplotlib 1.5.0 documentation" href="../index.html" />
<link rel="up" title="The Matplotlib API" href="index.html" />
<link rel="next" title="mathtext" href="mathtext_api.html" />
<link rel="prev" title="lines" href="lines_api.html" />
<link href="https://fonts.googleapis.com/css?family=Raleway" rel="stylesheet" type="text/css">
<link rel="canonical" href="https://matplotlib.org/stable/api/markers_api.html" />
<script data-domain="matplotlib.org" defer="defer" src="https://views.scientific-python.org/js/script.js"></script>
</head>
<body>
<div id="unreleased-message"> You are reading an old version of the documentation (v1.5.0). For the latest version see <a href="https://matplotlib.org/stable/api/markers_api.html">https://matplotlib.org/stable/api/markers_api.html</a></div>
<div class="alert" style="background-color: #FEA46C; padding: 10px 0;
">
<h3>We're updating the default styles for Matplotlib 2.0</h3>
<p>Learn what to expect in the <a href="/style_changes.html" style="font-weight: bold;
color: #11557C;">new updates</a></p>
</div>
<link rel="shortcut icon" href="/_static/favicon.ico">
<!-- The "Fork me on github" ribbon -->
<img style="float: right; margin-bottom: -40px; top: 0; right: 0; border: 0;" src="https://s3.amazonaws.com/github/ribbons/forkme_right_orange_ff7600.png" usemap="#ribbonmap"/>
<map name="ribbonmap">
<area shape="poly" coords="15,0,148,-1,148,135" href="https://github.com/matplotlib/matplotlib" title="Fork me on GitHub" />
</map>
<div style="background-color: white; text-align: left; padding: 10px 10px 15px 15px">
<a href="../index.html"><img src="../_static/logo2.png" border="0" alt="matplotlib"/></a>
</div>
<div class="related">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="../genindex.html" title="General Index"
accesskey="I">index</a></li>
<li class="right" >
<a href="../py-modindex.html" title="Python Module Index"
>modules</a> |</li>
<li class="right" >
<a href="mathtext_api.html" title="mathtext"
accesskey="N">next</a> |</li>
<li class="right" >
<a href="lines_api.html" title="lines"
accesskey="P">previous</a> |</li>
<li><a href="../index.html">home</a>| </li>
<li><a href="../examples/index.html">examples</a>| </li>
<li><a href="../gallery.html">gallery</a>| </li>
<li><a href="pyplot_summary.html">pyplot</a>| </li>
<li><a href="../contents.html">docs</a> »</li>
<li><a href="index.html" accesskey="U">The Matplotlib API</a> »</li>
</ul>
</div>
<div class="sphinxsidebar">
<div class="sphinxsidebarwrapper">
<h3><a href="../contents.html">Table Of Contents</a></h3>
<ul>
<li><a class="reference internal" href="#">Markers</a><ul>
<li><a class="reference internal" href="#module-matplotlib.markers"><code class="docutils literal"><span class="pre">matplotlib.markers</span></code></a></li>
</ul>
</li>
</ul>
<h4>Previous topic</h4>
<p class="topless"><a href="lines_api.html"
title="previous chapter">lines</a></p>
<h4>Next topic</h4>
<p class="topless"><a href="mathtext_api.html"
title="next chapter">mathtext</a></p>
<div role="note" aria-label="source link">
<h3>This Page</h3>
<ul class="this-page-menu">
<li><a href="../_sources/api/markers_api.txt"
rel="nofollow">Show Source</a></li>
</ul>
</div>
<div id="searchbox" style="display: none" role="search">
<h3>Quick search</h3>
<form class="search" action="../search.html" method="get">
<input type="text" name="q" />
<input type="submit" value="Go" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
<p class="searchtip" style="font-size: 90%">
Enter search terms or a module, class or function name.
</p>
</div>
<script type="text/javascript">$('#searchbox').show(0);</script>
</div>
</div>
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body">
<div class="section" id="markers">
<h1>Markers<a class="headerlink" href="#markers" title="Permalink to this headline">¶</a></h1>
<div class="section" id="module-matplotlib.markers">
<span id="matplotlib-markers"></span><h2><a class="reference internal" href="#module-matplotlib.markers" title="matplotlib.markers"><code class="xref py py-mod docutils literal"><span class="pre">matplotlib.markers</span></code></a><a class="headerlink" href="#module-matplotlib.markers" title="Permalink to this headline">¶</a></h2>
<p>This module contains functions to handle markers. Used by both the
marker functionality of <a class="reference internal" href="axes_api.html#matplotlib.axes.Axes.plot" title="matplotlib.axes.Axes.plot"><code class="xref py py-obj docutils literal"><span class="pre">plot</span></code></a> and
<a class="reference internal" href="axes_api.html#matplotlib.axes.Axes.scatter" title="matplotlib.axes.Axes.scatter"><code class="xref py py-obj docutils literal"><span class="pre">scatter</span></code></a>.</p>
<p>All possible markers are defined here:</p>
<table border="1" class="docutils">
<colgroup>
<col width="38%" />
<col width="62%" />
</colgroup>
<thead valign="bottom">
<tr class="row-odd"><th class="head">marker</th>
<th class="head">description</th>
</tr>
</thead>
<tbody valign="top">
<tr class="row-even"><td>”.”</td>
<td>point</td>
</tr>
<tr class="row-odd"><td>”,”</td>
<td>pixel</td>
</tr>
<tr class="row-even"><td>“o”</td>
<td>circle</td>
</tr>
<tr class="row-odd"><td>“v”</td>
<td>triangle_down</td>
</tr>
<tr class="row-even"><td>“^”</td>
<td>triangle_up</td>
</tr>
<tr class="row-odd"><td>“<”</td>
<td>triangle_left</td>
</tr>
<tr class="row-even"><td>“>”</td>
<td>triangle_right</td>
</tr>
<tr class="row-odd"><td>“1”</td>
<td>tri_down</td>
</tr>
<tr class="row-even"><td>“2”</td>
<td>tri_up</td>
</tr>
<tr class="row-odd"><td>“3”</td>
<td>tri_left</td>
</tr>
<tr class="row-even"><td>“4”</td>
<td>tri_right</td>
</tr>
<tr class="row-odd"><td>“8”</td>
<td>octagon</td>
</tr>
<tr class="row-even"><td>“s”</td>
<td>square</td>
</tr>
<tr class="row-odd"><td>“p”</td>
<td>pentagon</td>
</tr>
<tr class="row-even"><td>“*”</td>
<td>star</td>
</tr>
<tr class="row-odd"><td>“h”</td>
<td>hexagon1</td>
</tr>
<tr class="row-even"><td>“H”</td>
<td>hexagon2</td>
</tr>
<tr class="row-odd"><td>“+”</td>
<td>plus</td>
</tr>
<tr class="row-even"><td>“x”</td>
<td>x</td>
</tr>
<tr class="row-odd"><td>“D”</td>
<td>diamond</td>
</tr>
<tr class="row-even"><td>“d”</td>
<td>thin_diamond</td>
</tr>
<tr class="row-odd"><td>“|”</td>
<td>vline</td>
</tr>
<tr class="row-even"><td>“_”</td>
<td>hline</td>
</tr>
<tr class="row-odd"><td>TICKLEFT</td>
<td>tickleft</td>
</tr>
<tr class="row-even"><td>TICKRIGHT</td>
<td>tickright</td>
</tr>
<tr class="row-odd"><td>TICKUP</td>
<td>tickup</td>
</tr>
<tr class="row-even"><td>TICKDOWN</td>
<td>tickdown</td>
</tr>
<tr class="row-odd"><td>CARETLEFT</td>
<td>caretleft</td>
</tr>
<tr class="row-even"><td>CARETRIGHT</td>
<td>caretright</td>
</tr>
<tr class="row-odd"><td>CARETUP</td>
<td>caretup</td>
</tr>
<tr class="row-even"><td>CARETDOWN</td>
<td>caretdown</td>
</tr>
<tr class="row-odd"><td>“None”</td>
<td>nothing</td>
</tr>
<tr class="row-even"><td>None</td>
<td>nothing</td>
</tr>
<tr class="row-odd"><td>” “</td>
<td>nothing</td>
</tr>
<tr class="row-even"><td>“”</td>
<td>nothing</td>
</tr>
<tr class="row-odd"><td><code class="docutils literal"><span class="pre">'$...$'</span></code></td>
<td>render the string using mathtext.</td>
</tr>
<tr class="row-even"><td><code class="xref py py-obj docutils literal"><span class="pre">verts</span></code></td>
<td>a list of (x, y) pairs used for Path vertices.
The center of the marker is located at (0,0) and
the size is normalized.</td>
</tr>
<tr class="row-odd"><td>path</td>
<td>a <a class="reference internal" href="path_api.html#matplotlib.path.Path" title="matplotlib.path.Path"><code class="xref py py-obj docutils literal"><span class="pre">Path</span></code></a> instance.</td>
</tr>
<tr class="row-even"><td>(<code class="xref py py-obj docutils literal"><span class="pre">numsides</span></code>, <code class="xref py py-obj docutils literal"><span class="pre">style</span></code>, <code class="xref py py-obj docutils literal"><span class="pre">angle</span></code>)</td>
<td>see below</td>
</tr>
</tbody>
</table>
<p>The marker can also be a tuple (<code class="xref py py-obj docutils literal"><span class="pre">numsides</span></code>, <code class="xref py py-obj docutils literal"><span class="pre">style</span></code>, <code class="xref py py-obj docutils literal"><span class="pre">angle</span></code>), which
will create a custom, regular symbol.</p>
<blockquote>
<div><dl class="docutils">
<dt><code class="xref py py-obj docutils literal"><span class="pre">numsides</span></code>:</dt>
<dd>the number of sides</dd>
<dt><code class="xref py py-obj docutils literal"><span class="pre">style</span></code>:</dt>
<dd><p class="first">the style of the regular symbol:</p>
<table border="1" class="last docutils">
<colgroup>
<col width="10%" />
<col width="90%" />
</colgroup>
<thead valign="bottom">
<tr class="row-odd"><th class="head">Value</th>
<th class="head">Description</th>
</tr>
</thead>
<tbody valign="top">
<tr class="row-even"><td>0</td>
<td>a regular polygon</td>
</tr>
<tr class="row-odd"><td>1</td>
<td>a star-like symbol</td>
</tr>
<tr class="row-even"><td>2</td>
<td>an asterisk</td>
</tr>
<tr class="row-odd"><td>3</td>
<td>a circle (<code class="xref py py-obj docutils literal"><span class="pre">numsides</span></code> and <code class="xref py py-obj docutils literal"><span class="pre">angle</span></code> is ignored)</td>
</tr>
</tbody>
</table>
</dd>
<dt><code class="xref py py-obj docutils literal"><span class="pre">angle</span></code>:</dt>
<dd>the angle of rotation of the symbol, in degrees</dd>
</dl>
</div></blockquote>
<p>For backward compatibility, the form (<code class="xref py py-obj docutils literal"><span class="pre">verts</span></code>, 0) is also accepted,
but it is equivalent to just <code class="xref py py-obj docutils literal"><span class="pre">verts</span></code> for giving a raw set of vertices
that define the shape.</p>
<dl class="class">
<dt id="matplotlib.markers.MarkerStyle">
<em class="property">class </em><code class="descclassname">matplotlib.markers.</code><code class="descname">MarkerStyle</code><span class="sig-paren">(</span><em>marker=None</em>, <em>fillstyle=None</em><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.markers.MarkerStyle" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal"><span class="pre">object</span></code></p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><p class="first"><strong>marker</strong> : string or array_like, optional, default: None</p>
<blockquote>
<div><p>See the descriptions of possible markers in the module docstring.</p>
</div></blockquote>
<p><strong>fillstyle</strong> : string, optional, default: ‘full’</p>
<blockquote class="last">
<div><p>‘full’, ‘left”, ‘right’, ‘bottom’, ‘top’, ‘none’</p>
</div></blockquote>
</td>
</tr>
</tbody>
</table>
<p class="rubric">Attributes</p>
<table border="1" class="docutils">
<colgroup>
<col width="31%" />
<col width="69%" />
</colgroup>
<tbody valign="top">
<tr class="row-odd"><td>markers</td>
<td>(list of known markes)</td>
</tr>
<tr class="row-even"><td>fillstyles</td>
<td>(list of known fillstyles)</td>
</tr>
<tr class="row-odd"><td>filled_markers</td>
<td>(list of known filled markers.)</td>
</tr>
</tbody>
</table>
<dl class="attribute">
<dt id="matplotlib.markers.MarkerStyle.filled_markers">
<code class="descname">filled_markers</code><em class="property"> = ('o', 'v', '^', '<', '>', '8', 's', 'p', '*', 'h', 'H', 'D', 'd')</em><a class="headerlink" href="#matplotlib.markers.MarkerStyle.filled_markers" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="matplotlib.markers.MarkerStyle.fillstyles">
<code class="descname">fillstyles</code><em class="property"> = ('full', 'left', 'right', 'bottom', 'top', 'none')</em><a class="headerlink" href="#matplotlib.markers.MarkerStyle.fillstyles" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="matplotlib.markers.MarkerStyle.get_alt_path">
<code class="descname">get_alt_path</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.markers.MarkerStyle.get_alt_path" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="matplotlib.markers.MarkerStyle.get_alt_transform">
<code class="descname">get_alt_transform</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.markers.MarkerStyle.get_alt_transform" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="matplotlib.markers.MarkerStyle.get_capstyle">
<code class="descname">get_capstyle</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.markers.MarkerStyle.get_capstyle" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="matplotlib.markers.MarkerStyle.get_fillstyle">
<code class="descname">get_fillstyle</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.markers.MarkerStyle.get_fillstyle" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="matplotlib.markers.MarkerStyle.get_joinstyle">
<code class="descname">get_joinstyle</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.markers.MarkerStyle.get_joinstyle" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="matplotlib.markers.MarkerStyle.get_marker">
<code class="descname">get_marker</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.markers.MarkerStyle.get_marker" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="matplotlib.markers.MarkerStyle.get_path">
<code class="descname">get_path</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.markers.MarkerStyle.get_path" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="matplotlib.markers.MarkerStyle.get_snap_threshold">
<code class="descname">get_snap_threshold</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.markers.MarkerStyle.get_snap_threshold" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="matplotlib.markers.MarkerStyle.get_transform">
<code class="descname">get_transform</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.markers.MarkerStyle.get_transform" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="matplotlib.markers.MarkerStyle.is_filled">
<code class="descname">is_filled</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.markers.MarkerStyle.is_filled" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="attribute">
<dt id="matplotlib.markers.MarkerStyle.markers">
<code class="descname">markers</code><em class="property"> = {0: 'tickleft', '|': 'vline', 2: 'tickup', 3: 'tickdown', 4: 'caretleft', 5: 'caretright', ',': 'pixel', 1: 'tickright', '+': 'plus', 'D': 'diamond', 'v': 'triangle_down', '1': 'tri_down', None: 'nothing', 'h': 'hexagon1', '*': 'star', 'None': 'nothing', '<': 'triangle_left', '': 'nothing', '2': 'tri_up', 's': 'square', ' ': 'nothing', 6: 'caretup', 'H': 'hexagon2', '3': 'tri_left', 'x': 'x', 7: 'caretdown', '4': 'tri_right', 'p': 'pentagon', '>': 'triangle_right', '8': 'octagon', 'o': 'circle', '.': 'point', 'd': 'thin_diamond', '^': 'triangle_up', '_': 'hline'}</em><a class="headerlink" href="#matplotlib.markers.MarkerStyle.markers" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<dl class="method">
<dt id="matplotlib.markers.MarkerStyle.set_fillstyle">
<code class="descname">set_fillstyle</code><span class="sig-paren">(</span><em>fillstyle</em><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.markers.MarkerStyle.set_fillstyle" title="Permalink to this definition">¶</a></dt>
<dd><p>Sets fillstyle</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>fillstyle</strong> : string amongst known fillstyles</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="method">
<dt id="matplotlib.markers.MarkerStyle.set_marker">
<code class="descname">set_marker</code><span class="sig-paren">(</span><em>marker</em><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.markers.MarkerStyle.set_marker" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
</dd></dl>
</div>
</div>
</div>
</div>
</div>
<div class="clearer"></div>
</div>
<div class="footer">
© Copyright 2002 - 2012 John Hunter, Darren Dale, Eric Firing, Michael Droettboom and the matplotlib development team; 2012 - 2014 The matplotlib development team.
Last updated on Oct 29, 2015.
Created using <a
href="http://sphinx-doc.org/">Sphinx</a> 1.3.1.
</div>
</body>
</html>
You can’t perform that action at this time.