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

Linked Data Table


In [1]:
from plotapi import Sankey

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


Plotapi Sankey supports a linked data table. This means as you hover over nodes and links in the Sankey diagram, a data table will be filtering in real-time to show more information.

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.

To make use of the linked data table, we need to provide some data in CSV format. This could be loaded through a file, directly in a strong, or using a pandas DataFrame (.to_csv(index=False)).

In [16]:
data_table = '''Start,Destination,TV Rating,Image
Group A,,9.0,<img src=''>
Group A,Rank 1,6.0,<img src=''>
Group A,Rank 1,5.0,<img src=''>'''


We'll enable the linked data table by passing data into the data_table parameter, and we'll modify the data_table_column_width by setting it to a smaller value of $80$.

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

Be sure to interact with the visualisation to see what the default settings can do! Try hovering over Group A and its link to Rank 1.

In [27]:
Sankey(links, width=400, link_numbers=False, 
       horizontal_labels_at_shallowest=False, horizontal_labels_at_deepest=False,
       data_table=data_table, data_table_column_width=100).show()

Data table mode includes the "locking" feature. Try clicking on the Group A node and you will see a padlock icon appear in the top right, and until you click somewhere again the current selection will persist.

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