-
Notifications
You must be signed in to change notification settings - Fork 60
Expand file tree
/
Copy pathsankey_api.html
More file actions
572 lines (541 loc) · 33.6 KB
/
sankey_api.html
File metadata and controls
572 lines (541 loc) · 33.6 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
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
<!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>sankey — Matplotlib 1.5.1 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.1',
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.1 documentation"
href="../_static/opensearch.xml"/>
<link rel="shortcut icon" href="../_static/favicon.ico"/>
<link rel="top" title="Matplotlib 1.5.1 documentation" href="../index.html" />
<link rel="up" title="The Matplotlib API" href="index.html" />
<link rel="next" title="spines" href="spines_api.html" />
<link rel="prev" title="pyplot" href="pyplot_api.html" />
<link rel="canonical" href="https://matplotlib.org/stable/api/sankey_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.1). For the latest version see <a href="https://matplotlib.org/stable/api/sankey_api.html">https://matplotlib.org/stable/api/sankey_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>
<!-- 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.svg" width="540px" 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="spines_api.html" title="spines"
accesskey="N">next</a> |</li>
<li class="right" >
<a href="pyplot_api.html" title="pyplot"
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">
<a href="http://depsy.org/package/python/matplotlib">
<img src="http://depsy.org/api/package/pypi/matplotlib/badge.svg">
</a>
<br/>
Travis-CI: <a href="https://travis-ci.org/matplotlib/matplotlib">
<img src="https://travis-ci.org/matplotlib/matplotlib.svg?branch=master"/>
</a>
<br/>
<h3><a href="../contents.html">Table Of Contents</a></h3>
<ul>
<li><a class="reference internal" href="#">sankey</a><ul>
<li><a class="reference internal" href="#module-matplotlib.sankey"><code class="docutils literal"><span class="pre">matplotlib.sankey</span></code></a></li>
</ul>
</li>
</ul>
<div class="relations">
<h3>Related Topics</h3>
<ul>
<li><a href="../contents.html">Documentation overview</a><ul>
<li><a href="index.html">The Matplotlib API</a><ul>
<li>Previous: <a href="pyplot_api.html" title="previous chapter">pyplot</a></li>
<li>Next: <a href="spines_api.html" title="next chapter">spines</a></li>
</ul></li>
</ul></li>
</ul>
</div>
<div role="note" aria-label="source link">
<h3>This Page</h3>
<ul class="this-page-menu">
<li><a href="../_sources/api/sankey_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="sankey">
<h1>sankey<a class="headerlink" href="#sankey" title="Permalink to this headline">¶</a></h1>
<div class="section" id="module-matplotlib.sankey">
<span id="matplotlib-sankey"></span><h2><a class="reference internal" href="#module-matplotlib.sankey" title="matplotlib.sankey"><code class="xref py py-mod docutils literal"><span class="pre">matplotlib.sankey</span></code></a><a class="headerlink" href="#module-matplotlib.sankey" title="Permalink to this headline">¶</a></h2>
<p>Module for creating Sankey diagrams using matplotlib</p>
<dl class="class">
<dt id="matplotlib.sankey.Sankey">
<em class="property">class </em><code class="descclassname">matplotlib.sankey.</code><code class="descname">Sankey</code><span class="sig-paren">(</span><em>ax=None</em>, <em>scale=1.0</em>, <em>unit=''</em>, <em>format='%G'</em>, <em>gap=0.25</em>, <em>radius=0.1</em>, <em>shoulder=0.03</em>, <em>offset=0.15</em>, <em>head_angle=100</em>, <em>margin=0.4</em>, <em>tolerance=1e-06</em>, <em>**kwargs</em><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.sankey.Sankey" 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>
<p>Sankey diagram in matplotlib</p>
<blockquote>
<div>Sankey diagrams are a specific type of flow diagram, in which
the width of the arrows is shown proportionally to the flow
quantity. They are typically used to visualize energy or
material or cost transfers between processes.
<a class="reference external" href="http://en.wikipedia.org/wiki/Sankey_diagram">Wikipedia (6/1/2011)</a></div></blockquote>
<p>Create a new Sankey instance.</p>
<p>Optional keyword arguments:</p>
<blockquote>
<div><table border="1" class="docutils">
<colgroup>
<col width="23%" />
<col width="77%" />
</colgroup>
<thead valign="bottom">
<tr class="row-odd"><th class="head">Field</th>
<th class="head">Description</th>
</tr>
</thead>
<tbody valign="top">
<tr class="row-even"><td><em>ax</em></td>
<td>axes onto which the data should be plotted
If <em>ax</em> isn’t provided, new axes will be created.</td>
</tr>
<tr class="row-odd"><td><em>scale</em></td>
<td>scaling factor for the flows
<em>scale</em> sizes the width of the paths in order to
maintain proper layout. The same scale is applied
to all subdiagrams. The value should be chosen
such that the product of the scale and the sum of
the inputs is approximately 1.0 (and the product of
the scale and the sum of the outputs is
approximately -1.0).</td>
</tr>
<tr class="row-even"><td><em>unit</em></td>
<td>string representing the physical unit associated
with the flow quantities
If <em>unit</em> is None, then none of the quantities are
labeled.</td>
</tr>
<tr class="row-odd"><td><em>format</em></td>
<td>a Python number formatting string to be used in
labeling the flow as a quantity (i.e., a number
times a unit, where the unit is given)</td>
</tr>
<tr class="row-even"><td><em>gap</em></td>
<td>space between paths that break in/break away
to/from the top or bottom</td>
</tr>
<tr class="row-odd"><td><em>radius</em></td>
<td>inner radius of the vertical paths</td>
</tr>
<tr class="row-even"><td><em>shoulder</em></td>
<td>size of the shoulders of output arrowS</td>
</tr>
<tr class="row-odd"><td><em>offset</em></td>
<td>text offset (from the dip or tip of the arrow)</td>
</tr>
<tr class="row-even"><td><em>head_angle</em></td>
<td>angle of the arrow heads (and negative of the angle
of the tails) [deg]</td>
</tr>
<tr class="row-odd"><td><em>margin</em></td>
<td>minimum space between Sankey outlines and the edge
of the plot area</td>
</tr>
<tr class="row-even"><td><em>tolerance</em></td>
<td>acceptable maximum of the magnitude of the sum of
flows
The magnitude of the sum of connected flows cannot
be greater than <em>tolerance</em>.</td>
</tr>
</tbody>
</table>
</div></blockquote>
<p>The optional arguments listed above are applied to all subdiagrams so
that there is consistent alignment and formatting.</p>
<p>If <a class="reference internal" href="#matplotlib.sankey.Sankey" title="matplotlib.sankey.Sankey"><code class="xref py py-class docutils literal"><span class="pre">Sankey</span></code></a> is instantiated with any keyword arguments other
than those explicitly listed above (<code class="docutils literal"><span class="pre">**kwargs</span></code>), they will be passed
to <a class="reference internal" href="#matplotlib.sankey.Sankey.add" title="matplotlib.sankey.Sankey.add"><code class="xref py py-meth docutils literal"><span class="pre">add()</span></code></a>, which will create the first subdiagram.</p>
<p>In order to draw a complex Sankey diagram, create an instance of
<a class="reference internal" href="#matplotlib.sankey.Sankey" title="matplotlib.sankey.Sankey"><code class="xref py py-class docutils literal"><span class="pre">Sankey</span></code></a> by calling it without any kwargs:</p>
<div class="highlight-python"><div class="highlight"><pre><span class="n">sankey</span> <span class="o">=</span> <span class="n">Sankey</span><span class="p">()</span>
</pre></div>
</div>
<p>Then add simple Sankey sub-diagrams:</p>
<div class="highlight-python"><div class="highlight"><pre><span class="n">sankey</span><span class="o">.</span><span class="n">add</span><span class="p">()</span> <span class="c1"># 1</span>
<span class="n">sankey</span><span class="o">.</span><span class="n">add</span><span class="p">()</span> <span class="c1"># 2</span>
<span class="c1">#...</span>
<span class="n">sankey</span><span class="o">.</span><span class="n">add</span><span class="p">()</span> <span class="c1"># n</span>
</pre></div>
</div>
<p>Finally, create the full diagram:</p>
<div class="highlight-python"><div class="highlight"><pre><span class="n">sankey</span><span class="o">.</span><span class="n">finish</span><span class="p">()</span>
</pre></div>
</div>
<p>Or, instead, simply daisy-chain those calls:</p>
<div class="highlight-python"><div class="highlight"><pre><span class="n">Sankey</span><span class="p">()</span><span class="o">.</span><span class="n">add</span><span class="p">()</span><span class="o">.</span><span class="n">add</span><span class="o">...</span> <span class="o">.</span><span class="n">add</span><span class="p">()</span><span class="o">.</span><span class="n">finish</span><span class="p">()</span>
</pre></div>
</div>
<div class="admonition seealso">
<p class="first admonition-title">See also</p>
<p class="last"><a class="reference internal" href="#matplotlib.sankey.Sankey.add" title="matplotlib.sankey.Sankey.add"><code class="xref py py-meth docutils literal"><span class="pre">add()</span></code></a>
<a class="reference internal" href="#matplotlib.sankey.Sankey.finish" title="matplotlib.sankey.Sankey.finish"><code class="xref py py-meth docutils literal"><span class="pre">finish()</span></code></a></p>
</div>
<p><strong>Examples:</strong></p>
<blockquote>
<div><p>(<a class="reference external" href="../mpl_examples/api/sankey_demo_basics.py">Source code</a>)</p>
<div class="figure" id="id1">
<img alt="../_images/sankey_demo_basics_00.png" src="../_images/sankey_demo_basics_00.png" />
<p class="caption"><span class="caption-text">(<a class="reference external" href="../mpl_examples/api/sankey_demo_basics_00.png">png</a>, <a class="reference external" href="../mpl_examples/api/sankey_demo_basics_00.hires.png">hires.png</a>, <a class="reference external" href="../mpl_examples/api/sankey_demo_basics_00.pdf">pdf</a>)</span></p>
</div>
<div class="figure" id="id2">
<img alt="../_images/sankey_demo_basics_01.png" src="../_images/sankey_demo_basics_01.png" />
<p class="caption"><span class="caption-text">(<a class="reference external" href="../mpl_examples/api/sankey_demo_basics_01.png">png</a>, <a class="reference external" href="../mpl_examples/api/sankey_demo_basics_01.hires.png">hires.png</a>, <a class="reference external" href="../mpl_examples/api/sankey_demo_basics_01.pdf">pdf</a>)</span></p>
</div>
<div class="figure" id="id3">
<img alt="../_images/sankey_demo_basics_02.png" src="../_images/sankey_demo_basics_02.png" />
<p class="caption"><span class="caption-text">(<a class="reference external" href="../mpl_examples/api/sankey_demo_basics_02.png">png</a>, <a class="reference external" href="../mpl_examples/api/sankey_demo_basics_02.hires.png">hires.png</a>, <a class="reference external" href="../mpl_examples/api/sankey_demo_basics_02.pdf">pdf</a>)</span></p>
</div>
</div></blockquote>
<dl class="method">
<dt id="matplotlib.sankey.Sankey.add">
<code class="descname">add</code><span class="sig-paren">(</span><em>patchlabel=''</em>, <em>flows=None</em>, <em>orientations=None</em>, <em>labels=''</em>, <em>trunklength=1.0</em>, <em>pathlengths=0.25</em>, <em>prior=None</em>, <em>connect=(0</em>, <em>0)</em>, <em>rotation=0</em>, <em>**kwargs</em><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.sankey.Sankey.add" title="Permalink to this definition">¶</a></dt>
<dd><p>Add a simple Sankey diagram with flows at the same hierarchical level.</p>
<p>Return value is the instance of <a class="reference internal" href="#matplotlib.sankey.Sankey" title="matplotlib.sankey.Sankey"><code class="xref py py-class docutils literal"><span class="pre">Sankey</span></code></a>.</p>
<p>Optional keyword arguments:</p>
<blockquote>
<div><table border="1" class="docutils">
<colgroup>
<col width="23%" />
<col width="77%" />
</colgroup>
<thead valign="bottom">
<tr class="row-odd"><th class="head">Keyword</th>
<th class="head">Description</th>
</tr>
</thead>
<tbody valign="top">
<tr class="row-even"><td><em>patchlabel</em></td>
<td>label to be placed at the center of the diagram
Note: <em>label</em> (not <em>patchlabel</em>) will be passed to
the patch through <code class="docutils literal"><span class="pre">**kwargs</span></code> and can be used to
create an entry in the legend.</td>
</tr>
<tr class="row-odd"><td><em>flows</em></td>
<td>array of flow values
By convention, inputs are positive and outputs are
negative.</td>
</tr>
<tr class="row-even"><td><em>orientations</em></td>
<td>list of orientations of the paths
Valid values are 1 (from/to the top), 0 (from/to
the left or right), or -1 (from/to the bottom). If
<em>orientations</em> == 0, inputs will break in from the
left and outputs will break away to the right.</td>
</tr>
<tr class="row-odd"><td><em>labels</em></td>
<td>list of specifications of the labels for the flows
Each value may be <em>None</em> (no labels), ‘’ (just
label the quantities), or a labeling string. If a
single value is provided, it will be applied to all
flows. If an entry is a non-empty string, then the
quantity for the corresponding flow will be shown
below the string. However, if the <em>unit</em> of the
main diagram is None, then quantities are never
shown, regardless of the value of this argument.</td>
</tr>
<tr class="row-even"><td><em>trunklength</em></td>
<td>length between the bases of the input and output
groups</td>
</tr>
<tr class="row-odd"><td><em>pathlengths</em></td>
<td>list of lengths of the arrows before break-in or
after break-away
If a single value is given, then it will be applied
to the first (inside) paths on the top and bottom,
and the length of all other arrows will be
justified accordingly. The <em>pathlengths</em> are not
applied to the horizontal inputs and outputs.</td>
</tr>
<tr class="row-even"><td><em>prior</em></td>
<td>index of the prior diagram to which this diagram
should be connected</td>
</tr>
<tr class="row-odd"><td><em>connect</em></td>
<td>a (prior, this) tuple indexing the flow of the
prior diagram and the flow of this diagram which
should be connected
If this is the first diagram or <em>prior</em> is <em>None</em>,
<em>connect</em> will be ignored.</td>
</tr>
<tr class="row-even"><td><em>rotation</em></td>
<td>angle of rotation of the diagram [deg]
<em>rotation</em> is ignored if this diagram is connected
to an existing one (using <em>prior</em> and <em>connect</em>).
The interpretation of the <em>orientations</em> argument
will be rotated accordingly (e.g., if <em>rotation</em>
== 90, an <em>orientations</em> entry of 1 means to/from
the left).</td>
</tr>
</tbody>
</table>
</div></blockquote>
<p>Valid kwargs are <a class="reference internal" href="patches_api.html#matplotlib.patches.PathPatch" title="matplotlib.patches.PathPatch"><code class="xref py py-meth docutils literal"><span class="pre">matplotlib.patches.PathPatch()</span></code></a> arguments:</p>
<blockquote>
<div><table border="1" class="docutils">
<colgroup>
<col width="32%" />
<col width="68%" />
</colgroup>
<thead valign="bottom">
<tr class="row-odd"><th class="head">Property</th>
<th class="head">Description</th>
</tr>
</thead>
<tbody valign="top">
<tr class="row-even"><td><a class="reference internal" href="artist_api.html#matplotlib.artist.Artist.set_agg_filter" title="matplotlib.artist.Artist.set_agg_filter"><code class="xref py py-meth docutils literal"><span class="pre">agg_filter</span></code></a></td>
<td>unknown</td>
</tr>
<tr class="row-odd"><td><a class="reference internal" href="patches_api.html#matplotlib.patches.Patch.set_alpha" title="matplotlib.patches.Patch.set_alpha"><code class="xref py py-meth docutils literal"><span class="pre">alpha</span></code></a></td>
<td>float or None</td>
</tr>
<tr class="row-even"><td><a class="reference internal" href="artist_api.html#matplotlib.artist.Artist.set_animated" title="matplotlib.artist.Artist.set_animated"><code class="xref py py-meth docutils literal"><span class="pre">animated</span></code></a></td>
<td>[True | False]</td>
</tr>
<tr class="row-odd"><td><a class="reference internal" href="patches_api.html#matplotlib.patches.Patch.set_antialiased" title="matplotlib.patches.Patch.set_antialiased"><code class="xref py py-meth docutils literal"><span class="pre">antialiased</span></code></a> or aa</td>
<td>[True | False] or None for default</td>
</tr>
<tr class="row-even"><td><a class="reference internal" href="artist_api.html#matplotlib.artist.Artist.set_axes" title="matplotlib.artist.Artist.set_axes"><code class="xref py py-meth docutils literal"><span class="pre">axes</span></code></a></td>
<td>an <a class="reference internal" href="axes_api.html#matplotlib.axes.Axes" title="matplotlib.axes.Axes"><code class="xref py py-class docutils literal"><span class="pre">Axes</span></code></a> instance</td>
</tr>
<tr class="row-odd"><td><a class="reference internal" href="patches_api.html#matplotlib.patches.Patch.set_capstyle" title="matplotlib.patches.Patch.set_capstyle"><code class="xref py py-meth docutils literal"><span class="pre">capstyle</span></code></a></td>
<td>[‘butt’ | ‘round’ | ‘projecting’]</td>
</tr>
<tr class="row-even"><td><a class="reference internal" href="artist_api.html#matplotlib.artist.Artist.set_clip_box" title="matplotlib.artist.Artist.set_clip_box"><code class="xref py py-meth docutils literal"><span class="pre">clip_box</span></code></a></td>
<td>a <a class="reference internal" href="../devel/transformations.html#matplotlib.transforms.Bbox" title="matplotlib.transforms.Bbox"><code class="xref py py-class docutils literal"><span class="pre">matplotlib.transforms.Bbox</span></code></a> instance</td>
</tr>
<tr class="row-odd"><td><a class="reference internal" href="artist_api.html#matplotlib.artist.Artist.set_clip_on" title="matplotlib.artist.Artist.set_clip_on"><code class="xref py py-meth docutils literal"><span class="pre">clip_on</span></code></a></td>
<td>[True | False]</td>
</tr>
<tr class="row-even"><td><a class="reference internal" href="artist_api.html#matplotlib.artist.Artist.set_clip_path" title="matplotlib.artist.Artist.set_clip_path"><code class="xref py py-meth docutils literal"><span class="pre">clip_path</span></code></a></td>
<td>[ (<a class="reference internal" href="path_api.html#matplotlib.path.Path" title="matplotlib.path.Path"><code class="xref py py-class docutils literal"><span class="pre">Path</span></code></a>, <a class="reference internal" href="../devel/transformations.html#matplotlib.transforms.Transform" title="matplotlib.transforms.Transform"><code class="xref py py-class docutils literal"><span class="pre">Transform</span></code></a>) | <a class="reference internal" href="patches_api.html#matplotlib.patches.Patch" title="matplotlib.patches.Patch"><code class="xref py py-class docutils literal"><span class="pre">Patch</span></code></a> | None ]</td>
</tr>
<tr class="row-odd"><td><a class="reference internal" href="patches_api.html#matplotlib.patches.Patch.set_color" title="matplotlib.patches.Patch.set_color"><code class="xref py py-meth docutils literal"><span class="pre">color</span></code></a></td>
<td>matplotlib color spec</td>
</tr>
<tr class="row-even"><td><a class="reference internal" href="artist_api.html#matplotlib.artist.Artist.set_contains" title="matplotlib.artist.Artist.set_contains"><code class="xref py py-meth docutils literal"><span class="pre">contains</span></code></a></td>
<td>a callable function</td>
</tr>
<tr class="row-odd"><td><a class="reference internal" href="patches_api.html#matplotlib.patches.Patch.set_edgecolor" title="matplotlib.patches.Patch.set_edgecolor"><code class="xref py py-meth docutils literal"><span class="pre">edgecolor</span></code></a> or ec</td>
<td>mpl color spec, or None for default, or ‘none’ for no color</td>
</tr>
<tr class="row-even"><td><a class="reference internal" href="patches_api.html#matplotlib.patches.Patch.set_facecolor" title="matplotlib.patches.Patch.set_facecolor"><code class="xref py py-meth docutils literal"><span class="pre">facecolor</span></code></a> or fc</td>
<td>mpl color spec, or None for default, or ‘none’ for no color</td>
</tr>
<tr class="row-odd"><td><a class="reference internal" href="artist_api.html#matplotlib.artist.Artist.set_figure" title="matplotlib.artist.Artist.set_figure"><code class="xref py py-meth docutils literal"><span class="pre">figure</span></code></a></td>
<td>a <a class="reference internal" href="figure_api.html#matplotlib.figure.Figure" title="matplotlib.figure.Figure"><code class="xref py py-class docutils literal"><span class="pre">matplotlib.figure.Figure</span></code></a> instance</td>
</tr>
<tr class="row-even"><td><a class="reference internal" href="patches_api.html#matplotlib.patches.Patch.set_fill" title="matplotlib.patches.Patch.set_fill"><code class="xref py py-meth docutils literal"><span class="pre">fill</span></code></a></td>
<td>[True | False]</td>
</tr>
<tr class="row-odd"><td><a class="reference internal" href="artist_api.html#matplotlib.artist.Artist.set_gid" title="matplotlib.artist.Artist.set_gid"><code class="xref py py-meth docutils literal"><span class="pre">gid</span></code></a></td>
<td>an id string</td>
</tr>
<tr class="row-even"><td><a class="reference internal" href="patches_api.html#matplotlib.patches.Patch.set_hatch" title="matplotlib.patches.Patch.set_hatch"><code class="xref py py-meth docutils literal"><span class="pre">hatch</span></code></a></td>
<td>[‘/’ | ‘\’ | ‘|’ | ‘-‘ | ‘+’ | ‘x’ | ‘o’ | ‘O’ | ‘.’ | ‘*’]</td>
</tr>
<tr class="row-odd"><td><a class="reference internal" href="patches_api.html#matplotlib.patches.Patch.set_joinstyle" title="matplotlib.patches.Patch.set_joinstyle"><code class="xref py py-meth docutils literal"><span class="pre">joinstyle</span></code></a></td>
<td>[‘miter’ | ‘round’ | ‘bevel’]</td>
</tr>
<tr class="row-even"><td><a class="reference internal" href="artist_api.html#matplotlib.artist.Artist.set_label" title="matplotlib.artist.Artist.set_label"><code class="xref py py-meth docutils literal"><span class="pre">label</span></code></a></td>
<td>string or anything printable with ‘%s’ conversion.</td>
</tr>
<tr class="row-odd"><td><a class="reference internal" href="patches_api.html#matplotlib.patches.Patch.set_linestyle" title="matplotlib.patches.Patch.set_linestyle"><code class="xref py py-meth docutils literal"><span class="pre">linestyle</span></code></a> or ls</td>
<td>[‘solid’ | ‘dashed’, ‘dashdot’, ‘dotted’ | (offset, on-off-dash-seq) | <code class="docutils literal"><span class="pre">'-'</span></code> | <code class="docutils literal"><span class="pre">'--'</span></code> | <code class="docutils literal"><span class="pre">'-.'</span></code> | <code class="docutils literal"><span class="pre">':'</span></code> | <code class="docutils literal"><span class="pre">'None'</span></code> | <code class="docutils literal"><span class="pre">'</span> <span class="pre">'</span></code> | <code class="docutils literal"><span class="pre">''</span></code>]</td>
</tr>
<tr class="row-even"><td><a class="reference internal" href="patches_api.html#matplotlib.patches.Patch.set_linewidth" title="matplotlib.patches.Patch.set_linewidth"><code class="xref py py-meth docutils literal"><span class="pre">linewidth</span></code></a> or lw</td>
<td>float or None for default</td>
</tr>
<tr class="row-odd"><td><a class="reference internal" href="artist_api.html#matplotlib.artist.Artist.set_path_effects" title="matplotlib.artist.Artist.set_path_effects"><code class="xref py py-meth docutils literal"><span class="pre">path_effects</span></code></a></td>
<td>unknown</td>
</tr>
<tr class="row-even"><td><a class="reference internal" href="artist_api.html#matplotlib.artist.Artist.set_picker" title="matplotlib.artist.Artist.set_picker"><code class="xref py py-meth docutils literal"><span class="pre">picker</span></code></a></td>
<td>[None|float|boolean|callable]</td>
</tr>
<tr class="row-odd"><td><a class="reference internal" href="artist_api.html#matplotlib.artist.Artist.set_rasterized" title="matplotlib.artist.Artist.set_rasterized"><code class="xref py py-meth docutils literal"><span class="pre">rasterized</span></code></a></td>
<td>[True | False | None]</td>
</tr>
<tr class="row-even"><td><a class="reference internal" href="artist_api.html#matplotlib.artist.Artist.set_sketch_params" title="matplotlib.artist.Artist.set_sketch_params"><code class="xref py py-meth docutils literal"><span class="pre">sketch_params</span></code></a></td>
<td>unknown</td>
</tr>
<tr class="row-odd"><td><a class="reference internal" href="artist_api.html#matplotlib.artist.Artist.set_snap" title="matplotlib.artist.Artist.set_snap"><code class="xref py py-meth docutils literal"><span class="pre">snap</span></code></a></td>
<td>unknown</td>
</tr>
<tr class="row-even"><td><a class="reference internal" href="artist_api.html#matplotlib.artist.Artist.set_transform" title="matplotlib.artist.Artist.set_transform"><code class="xref py py-meth docutils literal"><span class="pre">transform</span></code></a></td>
<td><a class="reference internal" href="../devel/transformations.html#matplotlib.transforms.Transform" title="matplotlib.transforms.Transform"><code class="xref py py-class docutils literal"><span class="pre">Transform</span></code></a> instance</td>
</tr>
<tr class="row-odd"><td><a class="reference internal" href="artist_api.html#matplotlib.artist.Artist.set_url" title="matplotlib.artist.Artist.set_url"><code class="xref py py-meth docutils literal"><span class="pre">url</span></code></a></td>
<td>a url string</td>
</tr>
<tr class="row-even"><td><a class="reference internal" href="artist_api.html#matplotlib.artist.Artist.set_visible" title="matplotlib.artist.Artist.set_visible"><code class="xref py py-meth docutils literal"><span class="pre">visible</span></code></a></td>
<td>[True | False]</td>
</tr>
<tr class="row-odd"><td><a class="reference internal" href="artist_api.html#matplotlib.artist.Artist.set_zorder" title="matplotlib.artist.Artist.set_zorder"><code class="xref py py-meth docutils literal"><span class="pre">zorder</span></code></a></td>
<td>any number</td>
</tr>
</tbody>
</table>
</div></blockquote>
<p>As examples, <code class="docutils literal"><span class="pre">fill=False</span></code> and <code class="docutils literal"><span class="pre">label='A</span> <span class="pre">legend</span> <span class="pre">entry'</span></code>.
By default, <code class="docutils literal"><span class="pre">facecolor='#bfd1d4'</span></code> (light blue) and
<code class="docutils literal"><span class="pre">linewidth=0.5</span></code>.</p>
<p>The indexing parameters (<em>prior</em> and <em>connect</em>) are zero-based.</p>
<p>The flows are placed along the top of the diagram from the inside out
in order of their index within the <em>flows</em> list or array. They are
placed along the sides of the diagram from the top down and along the
bottom from the outside in.</p>
<p>If the sum of the inputs and outputs is nonzero, the discrepancy
will appear as a cubic Bezier curve along the top and bottom edges of
the trunk.</p>
<div class="admonition seealso">
<p class="first admonition-title">See also</p>
<p class="last"><a class="reference internal" href="#matplotlib.sankey.Sankey.finish" title="matplotlib.sankey.Sankey.finish"><code class="xref py py-meth docutils literal"><span class="pre">finish()</span></code></a></p>
</div>
</dd></dl>
<dl class="method">
<dt id="matplotlib.sankey.Sankey.finish">
<code class="descname">finish</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#matplotlib.sankey.Sankey.finish" title="Permalink to this definition">¶</a></dt>
<dd><p>Adjust the axes and return a list of information about the Sankey
subdiagram(s).</p>
<p>Return value is a list of subdiagrams represented with the following
fields:</p>
<blockquote>
<div><table border="1" class="docutils">
<colgroup>
<col width="23%" />
<col width="77%" />
</colgroup>
<thead valign="bottom">
<tr class="row-odd"><th class="head">Field</th>
<th class="head">Description</th>
</tr>
</thead>
<tbody valign="top">
<tr class="row-even"><td><em>patch</em></td>
<td>Sankey outline (an instance of
<code class="xref py py-class docutils literal"><span class="pre">PathPatch</span></code>)</td>
</tr>
<tr class="row-odd"><td><em>flows</em></td>
<td>values of the flows (positive for input, negative
for output)</td>
</tr>
<tr class="row-even"><td><em>angles</em></td>
<td>list of angles of the arrows [deg/90]
For example, if the diagram has not been rotated,
an input to the top side will have an angle of 3
(DOWN), and an output from the top side will have
an angle of 1 (UP). If a flow has been skipped
(because its magnitude is less than <em>tolerance</em>),
then its angle will be <em>None</em>.</td>
</tr>
<tr class="row-odd"><td><em>tips</em></td>
<td>array in which each row is an [x, y] pair
indicating the positions of the tips (or “dips”) of
the flow paths
If the magnitude of a flow is less the <em>tolerance</em>
for the instance of <a class="reference internal" href="#matplotlib.sankey.Sankey" title="matplotlib.sankey.Sankey"><code class="xref py py-class docutils literal"><span class="pre">Sankey</span></code></a>, the flow is
skipped and its tip will be at the center of the
diagram.</td>
</tr>
<tr class="row-even"><td><em>text</em></td>
<td><a class="reference internal" href="text_api.html#matplotlib.text.Text" title="matplotlib.text.Text"><code class="xref py py-class docutils literal"><span class="pre">Text</span></code></a> instance for the
label of the diagram</td>
</tr>
<tr class="row-odd"><td><em>texts</em></td>
<td>list of <a class="reference internal" href="text_api.html#matplotlib.text.Text" title="matplotlib.text.Text"><code class="xref py py-class docutils literal"><span class="pre">Text</span></code></a> instances
for the labels of flows</td>
</tr>
</tbody>
</table>
</div></blockquote>
<div class="admonition seealso">
<p class="first admonition-title">See also</p>
<p class="last"><a class="reference internal" href="#matplotlib.sankey.Sankey.add" title="matplotlib.sankey.Sankey.add"><code class="xref py py-meth docutils literal"><span class="pre">add()</span></code></a></p>
</div>
</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 Jun 18, 2016.
Created using <a
href="http://sphinx-doc.org/">Sphinx</a> 1.3.5.
</div>
</body>
<footer>
</footer>
</html>