5

Link Label Templates and Colours

 3 years ago
source link: https://datacrayon.com/posts/plotapi/sankey/link-label-templates-and-colours/
Go to the source link to view the article. You can view the picture content, updated content and better typesetting reading experience. If the link is broken, please click the button below to view the snapshot at that time.
neoserver,ios ssh client

Preamble

from plotapi import Sankey

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

Introduction

We can hide the link labels, change how they're presented using a template, and the text colour.

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

Dataset

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

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.

Visualisation

  • We can set the link label colour by passing a HEX colour code or string alias into the link_label_color parameter.
  • We can change the label template by setting link_numbers_template to a string that includes <plotapi_value> where we want the value to appear.
  • We can disable the link labels entirely by setting link_numbers=False.

Let's demonstrate these options below.

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 settings can do!

Sankey(links, link_numbers_template="$<plotapi_value>", link_label_color="white").show()

Plotapi - Sankey Diagram

Group AGroup BRank 1Rank 2Rank 3Club AClub BClub CWithdrawnThe MostAmazingPrize$1000$300$600$400$700$400$200$200$400$400$500Produced with Plotapi
Sankey(links, link_numbers=False).show_png()

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.


About Joyk


Aggregate valuable and interesting links.
Joyk means Joy of geeK