Plotapi, beautiful by default.

Let plotapi do the heavy lifting – enabling beautiful interactive visualisations with a single line of code (instead of hundreds).

Get Plotapi

Changing the Link Colour Mode


In [1]:
from plotapi import Sankey

Sankey.set_license("your username", "your license key")


By default, a Plotapi Sankey diagram colours its links with a gradient moving from the source node colour to the target node colour, with a default opacity of 0.45. This behaviour can be changed - let's see how below!

As we can see, we have set our license details in the preamble with Sankey.set_license().


Plotapi Sankey expects a list of dictionary items, these will define the flow between a source and a target.

In [2]:
links = [
    {"source":"Group A", "target":"Rank 1", "value": 1000},
    {"source":"Group B", "target":"Rank 1", "value": 300},
    {"source":"Group B", "target":"Rank 2", "value": 600},
    {"source":"Group B", "target":"Rank 3", "value": 400},
    {"source":"Rank 1", "target":"Club A", "value": 700},
    {"source":"Rank 1", "target":"Club B", "value": 400},
    {"source":"Rank 1", "target":"Club C", "value": 200},
    {"source":"Rank 2", "target":"Club B", "value": 200},
    {"source":"Rank 2", "target":"Club C", "value": 400},
    {"source":"Rank 3", "target":"Withdrawn", "value": 400},
    {"source":"Club A", "target":"The Most Amazing Prize", "value": 500},

We can add many source's and target's in any arrangement.


Link colour is controlled by the link_color_mode parameter which is set to "gradient" by default, and this gradient can be reversed with reverse_gradients=True if needed. The other options for link_color_mode are "source" which uses the source node's colour, or "target" which uses the target node's colour.

To change the foreground link colour opacity, we set link_opacity with a number between or including $0$ and $1$. The change in opacity is only noticeable when hovering over a node.

Let's demonstrate these below.

Here we're using .show() and show_png() which outputs to a Jupyter Notebook cell, however, we may want to output to a file with .to_html() or .to_png() instead. More on the different output methods later!

Be sure to interact with the visualisation to see what the settings can do!

In [8]:
Sankey(links, link_color_mode="target", link_opacity=0.75).show()
Plotapi - Sankey Diagram
In [4]:
Sankey(links, link_color_mode="source").show_png()
In [5]:
Sankey(links, reverse_gradients=True).show_png()
In [6]:

You can do so much more than what's presented in this example, and we'll cover this in later sections. If you want to see the full list of growing features, check out the Plotapi Documentation.

Made with Plotapi

You can create beautiful, interactive, and engaging visualisations like this one in any programming language with Plotapi.

Get the Books

Enjoying these notebooks and want more on the subject? Check out the practical books on Data Science, Visualisation, and Evolutionary Algorithms.

Get the books