{ "cells": [ { "cell_type": "markdown", "metadata": {}, "source": [ "# Preamble" ] }, { "cell_type": "code", "execution_count": null, "metadata": {}, "outputs": [], "source": [ "from plotapi import Sankey\n", "\n", "Sankey.set_license(\"your username\", \"your license key\")" ] }, { "cell_type": "markdown", "metadata": {}, "source": [ "# Introduction\n", "\n", "Let's take a look at some parameters that control the layout of our diagram.\n", "\n", "As we can see, we have set our license details in the preamble with `Sankey.set_license()`." ] }, { "cell_type": "markdown", "metadata": {}, "source": [ "# Dataset" ] }, { "cell_type": "markdown", "metadata": {}, "source": [ "Plotapi Sankey expects a `list` of `dictionary` items, these will define the flow between a `source` and a `target`." ] }, { "cell_type": "code", "execution_count": null, "metadata": {}, "outputs": [], "source": [ "links = [\n", " {\"source\":\"Group A\", \"target\":\"Rank 1\", \"value\": 1002},\n", " {\"source\":\"Group B\", \"target\":\"Rank 1\", \"value\": 300},\n", " {\"source\":\"Group B\", \"target\":\"Rank 2\", \"value\": 600},\n", " {\"source\":\"Group B\", \"target\":\"Rank 3\", \"value\": 400},\n", " {\"source\":\"Rank 1\", \"target\":\"Club A\", \"value\": 700},\n", " {\"source\":\"Rank 1\", \"target\":\"Club B\", \"value\": 400},\n", " {\"source\":\"Rank 1\", \"target\":\"Club C\", \"value\": 200},\n", " {\"source\":\"Rank 2\", \"target\":\"Club B\", \"value\": 200},\n", " {\"source\":\"Rank 2\", \"target\":\"Club C\", \"value\": 400},\n", " {\"source\":\"Rank 3\", \"target\":\"Withdrawn\", \"value\": 400},\n", " {\"source\":\"Club A\", \"target\":\"The Most Amazing Prize\", \"value\": 500},\n", "]" ] }, { "cell_type": "markdown", "metadata": {}, "source": [ "We can add many `source`'s and `target`'s in any arrangement." ] }, { "cell_type": "markdown", "metadata": {}, "source": [ "# Visualisation" ] }, { "cell_type": "markdown", "metadata": {}, "source": [ "We can modify the `width`, `height`, and `margin` of our diagram. \n", "\n", "The `margin` is a single `float` value that is applied as an equal margin of that size.\n", "\n", "The `background_color` and `border` can be changed too.\n", "\n", "By default a Plotapi Sankey diagram is centered, but this can be disabled with `center=False`.\n", "\n", "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!\n", "\n", "Be sure to interact with the visualisation to see what the settings can do!\n", "
" ] }, { "cell_type": "code", "execution_count": 5, "metadata": {}, "outputs": [ { "data": { "text/html": [ "\n", "\n", "\n", "Plotapi - Sankey Diagram\n", "\n", "\n", " \n", " \n", " \n", "\n", "\n", "\n", "
\n", " \n", "\n", "\n", "\n", "" ], "text/plain": [ "" ] }, "metadata": {}, "output_type": "display_data" } ], "source": [ "Sankey(links, colors=\"turbo\", link_numbers=False,\n", " width=800, height=400, margin=0, center=False,\n", " background_color=\"#f1f1f1\", border=\"#333 dashed\").show()" ] }, { "cell_type": "markdown", "metadata": {}, "source": [ "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." ] } ], "metadata": { "kernelspec": { "display_name": "Python 3 (ipykernel)", "language": "python", "name": "python3" }, "language_info": { "codemirror_mode": { "name": "ipython", "version": 3 }, "file_extension": ".py", "mimetype": "text/x-python", "name": "python", "nbconvert_exporter": "python", "pygments_lexer": "ipython3", "version": "3.9.1" } }, "nbformat": 4, "nbformat_minor": 4 }