{ "cells": [ { "cell_type": "markdown", "metadata": {}, "source": [ "# Preamble" ] }, { "cell_type": "code", "execution_count": 1, "metadata": {}, "outputs": [], "source": [ "from plotapi import BarFight\n", "\n", "BarFight.set_license(\"your username\", \"your license key\")" ] }, { "cell_type": "markdown", "metadata": {}, "source": [ "# Introduction\n", "\n", "Let's take a look at how we can change the colours and icons for nodes in our Bar Fight diagram.\n", "\n", "Plotapi Bar Fight is a beautiful and feature rich take on the popular Bar Chart Race. As we can see, we have set our license details in the preamble with `BarFight.set_license()`." ] }, { "cell_type": "markdown", "metadata": {}, "source": [ "# Dataset" ] }, { "cell_type": "markdown", "metadata": {}, "source": [ "Plotapi Bar Fight expects at minimum a `list` of `dictionary` items, these will define the value of our segments over time." ] }, { "cell_type": "code", "execution_count": 2, "metadata": {}, "outputs": [], "source": [ "samples = [\n", " {\"order\": 0, \"name\": \"Sankey\", \"value\": 10},\n", " {\"order\": 0, \"name\": \"Terminus\", \"value\": 12},\n", " {\"order\": 0, \"name\": \"Chord\", \"value\": 8},\n", " {\"order\": 0, \"name\": \"Bar Fight\", \"value\": 9},\n", " {\"order\": 0, \"name\": \"Pie Fight\", \"value\": 12},\n", "\n", " {\"order\": 1, \"name\": \"Sankey\", \"value\": 18},\n", " {\"order\": 1, \"name\": \"Terminus\", \"value\": 24},\n", " {\"order\": 1, \"name\": \"Chord\", \"value\": 22},\n", " {\"order\": 1, \"name\": \"Bar Fight\", \"value\": 14},\n", " {\"order\": 1, \"name\": \"Pie Fight\", \"value\": 17},\n", "\n", " {\"order\": 2, \"name\": \"Sankey\", \"value\": 24},\n", " {\"order\": 2, \"name\": \"Terminus\", \"value\": 40},\n", " {\"order\": 2, \"name\": \"Chord\", \"value\": 32},\n", " {\"order\": 2, \"name\": \"Bar Fight\", \"value\": 19},\n", " {\"order\": 2, \"name\": \"Pie Fight\", \"value\": 42},\n", "\n", " {\"order\": 3, \"name\": \"Sankey\", \"value\": 32},\n", " {\"order\": 3, \"name\": \"Terminus\", \"value\": 62},\n", " {\"order\": 3, \"name\": \"Chord\", \"value\": 40},\n", " {\"order\": 3, \"name\": \"Bar Fight\", \"value\": 25},\n", " {\"order\": 3, \"name\": \"Pie Fight\", \"value\": 64},\n", "\n", " {\"order\": 4, \"name\": \"Sankey\", \"value\": 38},\n", " {\"order\": 4, \"name\": \"Terminus\", \"value\": 75},\n", " {\"order\": 4, \"name\": \"Chord\", \"value\": 55},\n", " {\"order\": 4, \"name\": \"Bar Fight\", \"value\": 45},\n", " {\"order\": 4, \"name\": \"Pie Fight\", \"value\": 120},\n", "]" ] }, { "cell_type": "markdown", "metadata": {}, "source": [ "We can see that each dictionary item has three properties:\n", "- `order` which determines with _time period_ this item belongs to. This should be numerical, but can be formatted e.g. as dates.\n", "- `name` the name of the item, and the text that appears on the bar.\n", "- `value` the value of the bar at the associated point in time." ] }, { "cell_type": "markdown", "metadata": {}, "source": [ "Next, we'll start customising the bars, or _nodes_, that will represent our data over time. Plotapi Bar Fight expects a `list` of `dictionary` items to configure each node." ] }, { "cell_type": "code", "execution_count": 3, "metadata": {}, "outputs": [], "source": [ "nodes = [\n", " {\n", " \"name\": \"Sankey\",\n", " \"color\": \"#ffd166\", \n", " \"icon\": \"https://datacrayon.com/datasets/pokemon_img/003.png\"\n", " },\n", " {\n", " \"name\": \"Terminus\",\n", " \"color\": \"#06d6a0\", \n", " \"icon\": \"https://datacrayon.com/datasets/pokemon_img/004.png\"\n", " },\n", " {\n", " \"name\": \"Chord\",\n", " \"color\": \"#118ab2\", \n", " \"icon\": \"https://datacrayon.com/datasets/pokemon_img/025.png\"\n", " },\n", " {\n", " \"name\": \"Bar Fight\",\n", " \"color\": \"#073b4c\", \n", " \"icon\": \"https://datacrayon.com/datasets/pokemon_img/151.png\"\n", " },\n", " {\n", " \"name\": \"Pie Fight\",\n", " \"color\": \"#ef476f\", \n", " \"icon\": \"https://datacrayon.com/datasets/pokemon_img/232.png\"\n", " }\n", "]" ] }, { "cell_type": "markdown", "metadata": {}, "source": [ "We can see that each dictionary item has three properties:\n", "\n", "- `name`, the name of the item, which corresponds to names specified in the `samples` definitions above.\n", "- `color`, the desired colour of the bars (CSS colour e.g. \"#073b4c\" or \"red\").\n", "- `icon`, the location of the image to use for the icon." ] }, { "cell_type": "markdown", "metadata": {}, "source": [ "# Visualisation" ] }, { "cell_type": "markdown", "metadata": {}, "source": [ "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 default settings can do!\n", "
" ] }, { "cell_type": "code", "execution_count": 4, "metadata": {}, "outputs": [ { "data": { "text/html": [ "\n", "\n", "\n", "\n", " \n", " Plotapi - Bar Fight Diagram\n", "\n", " \n", "\n", " \n", "\n", "\n", "\n", "
\n", " \n", "\n", "\n", "" ], "text/plain": [ "" ] }, "metadata": {}, "output_type": "display_data" } ], "source": [ "BarFight(samples,\n", " nodes=nodes).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 }