{ "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 display `event` content during our visualisation at different times. This can be useful for displaying additional information or images that are relevant to specific events.\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 specifying event content to appear at certain points during our visualisation. Plotapi Bar Fight expects a `list` of `dictionary` items to configure each event." ] }, { "cell_type": "code", "execution_count": 3, "metadata": {}, "outputs": [], "source": [ "events = [\n", " {\n", " \"order\": 0,\n", " \"event\": '

Event information content can be formatted with HTML!

You can even include CSS - the power of both are available.

'\n", " },\n", " {\n", " \"order\": 1,\n", " \"event\": 'Something Special

Something special happened here, probably!

'\n", " },\n", " {\n", " \"order\": 4,\n", " \"event\": '

By specifying a duration, an event can be displayed for longer than the default value - much like this one!

',\n", " \"duration\": 10000\n", " }\n", "]" ] }, { "cell_type": "markdown", "metadata": {}, "source": [ "We can see that each dictionary item has three properties:\n", "\n", "- `order`, which determines with time period this event belongs to. This should correspond to the orders specified in the `samples`.\n", "- `event`, the HTML content of the event information popup.\n", "- `duration`, the maximum display duration for the corresponding event content.\n", "\n", "By default, a Plotapi Bar Fight visualisation will pause for the duration of an event. However, it can be configured to either continue running or wait for the user to press a _continue_ button. Check the next section in the Plotapi Gallery for an example!" ] }, { "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", " events=events).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 }