matplotlib.github.com/1.4.2/api/sankey_api.html at main · matplotlib/matplotlib.github.com

551 lines (523 loc) · 32.8 KB
<!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">
    <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
    <title>sankey &mdash; Matplotlib 1.4.2 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.4.2',
        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.4.2 documentation"
          href="../_static/opensearch.xml"/>
    <link rel="top" title="Matplotlib 1.4.2 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 href="https://fonts.googleapis.com/css?family=Raleway" rel="stylesheet" type="text/css">
    <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>
<div id="unreleased-message"> You are reading an old version of the documentation (v1.4.2).  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>
<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" />
<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 class="related">
      <h3>Navigation</h3>
        <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>|&nbsp;</li>
        <li><a href="../examples/index.html">examples</a>|&nbsp;</li>
        <li><a href="../gallery.html">gallery</a>|&nbsp;</li>
        <li><a href="pyplot_summary.html">pyplot</a>|&nbsp;</li>
        <li><a href="../contents.html">docs</a> &raquo;</li>
          <li><a href="index.html" accesskey="U">The Matplotlib API</a> &raquo;</li> 
      </ul>
      <div class="sphinxsidebar">
        <div class="sphinxsidebarwrapper">
  <h3><a href="../contents.html">Table Of Contents</a></h3>
<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>
  <h4>Previous topic</h4>
  <p class="topless"><a href="pyplot_api.html"
                        title="previous chapter">pyplot</a></p>
  <h4>Next topic</h4>
  <p class="topless"><a href="spines_api.html"
                        title="next chapter">spines</a></p>
  <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>
<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.
<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=u''</em>, <em>format=u'%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>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">
<col width="23%" />
<col width="77%" />
</colgroup>
<thead valign="bottom">
<tr class="row-odd"><th class="head">Field</th>
<th class="head">Description</th>
<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&#8217;t provided, new axes will be created.</td>
<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 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 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 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 class="row-odd"><td><em>radius</em></td>
<td>inner radius of the vertical paths</td>
<tr class="row-even"><td><em>shoulder</em></td>
<td>size of the shoulders of output arrowS</td>
<tr class="row-odd"><td><em>offset</em></td>
<td>text offset (from the dip or tip of the arrow)</td>
<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 class="row-odd"><td><em>margin</em></td>
<td>minimum space between Sankey outlines and the edge
of the plot area</td>
<tr class="row-even"><td><em>tolerance</em></td>
<td>acceptable maximum of the magnitude of the sum of
The magnitude of the sum of connected flows cannot
be greater than <em>tolerance</em>.</td>
</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>
<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="c"># 1</span>
<span class="n">sankey</span><span class="o">.</span><span class="n">add</span><span class="p">()</span> <span class="c"># 2</span>
<span class="c">#...</span>
<span class="n">sankey</span><span class="o">.</span><span class="n">add</span><span class="p">()</span> <span class="c"># n</span>
</pre></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>
<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 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>
<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><a class="headerlink" href="#id1" title="Permalink to this image">¶</a></p>
<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><a class="headerlink" href="#id2" title="Permalink to this image">¶</a></p>
<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><a class="headerlink" href="#id3" title="Permalink to this image">¶</a></p>
</div></blockquote>
<dl class="method">
<dt id="matplotlib.sankey.Sankey.add">
<code class="descname">add</code><span class="sig-paren">(</span><em>patchlabel=u''</em>, <em>flows=None</em>, <em>orientations=None</em>, <em>labels=u''</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">
<col width="23%" />
<col width="77%" />
</colgroup>
<thead valign="bottom">
<tr class="row-odd"><th class="head">Keyword</th>
<th class="head">Description</th>
<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 class="row-odd"><td><em>flows</em></td>
<td>array of flow values
By convention, inputs are positive and outputs are
negative.</td>
<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 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), &#8216;&#8217; (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 class="row-even"><td><em>trunklength</em></td>
<td>length between the bases of the input and output
groups</td>
<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 class="row-even"><td><em>prior</em></td>
<td>index of the prior diagram to which this diagram
should be connected</td>
<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 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>
</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">
<col width="31%" />
<col width="69%" />
</colgroup>
<thead valign="bottom">
<tr class="row-odd"><th class="head">Property</th>
<th class="head">Description</th>
<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 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 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 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 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 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>[&#8216;butt&#8217; | &#8216;round&#8217; | &#8216;projecting&#8217;]</td>
<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 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 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 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 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 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 &#8216;none&#8217; for no color</td>
<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 &#8216;none&#8217; for no color</td>
<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 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 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 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>[&#8216;/&#8217; | &#8216;\&#8217; | &#8216;|&#8217; | &#8216;-&#8216; | &#8216;+&#8217; | &#8216;x&#8217; | &#8216;o&#8217; | &#8216;O&#8217; | &#8216;.&#8217; | &#8216;*&#8217;]</td>
<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>[&#8216;miter&#8217; | &#8216;round&#8217; | &#8216;bevel&#8217;]</td>
<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 &#8216;%s&#8217; conversion.</td>
<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>[&#8216;solid&#8217; | &#8216;dashed&#8217; | &#8216;dashdot&#8217; | &#8216;dotted&#8217;]</td>
<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 class="row-odd"><td><a class="reference internal" href="artist_api.html#matplotlib.artist.Artist.set_lod" title="matplotlib.artist.Artist.set_lod"><code class="xref py py-meth docutils literal"><span class="pre">lod</span></code></a></td>
<td>[True | False]</td>
<tr class="row-even"><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 class="row-odd"><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 class="row-even"><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 class="row-odd"><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 class="row-even"><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 class="row-odd"><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 class="row-even"><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 class="row-odd"><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 class="row-even"><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>
</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 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>
<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">
<col width="23%" />
<col width="77%" />
</colgroup>
<thead valign="bottom">
<tr class="row-odd"><th class="head">Field</th>
<th class="head">Description</th>
<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 class="row-odd"><td><em>flows</em></td>
<td>values of the flows (positive for input, negative
for output)</td>
<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 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 &#8220;dips&#8221;) 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 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 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>
</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>
        </div>
      </div>
      <div class="clearer"></div>
    <div class="footer">
        &copy; 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 25, 2014.
      Created using <a
href="http://sphinx-doc.org/">Sphinx</a> 1.3b2.
Provide feedback

Saved searches

Use saved searches to filter your results more quickly

FilesExpand file tree

sankey_api.html

Latest commit

History

sankey_api.html

File metadata and controls
