Skip to content

Mercury

Features

The features of ipyvizzu-story that are available in Mercury are marked with a green check.

  • Display the created Story (play method)

  • Display the created Story (_repr_html_ method)

  • Use fullscreen

  • Use navigation buttons

  • Set width/height of the Story

  • Export the Story into a html file

  • Get the html Story as a string

Live example

Open in Mercury

Installation

Add ipyvizzu-story to requirements.txt.

python-dotenv
pandas
mercury
ipyvizzu-story

Sample

Try ipyvizzu-story in Mercury with the following sample.

# import ipyvizzu and ipyvizzu-story
 
from ipyvizzu import Data, Config
from ipyvizzustory import Slide, Step
 
from ipyvizzustory import Story  # or
 
# from ipyvizzustory.env.ipy.story import Story
 
from IPython.display import display as display_html, HTML
 
import mercury as mr
 
 
# setup Mercury App
app = mr.App(
    title="ipyvizzu-story demo",
    description="ipyvizzu-story demo with mercury",
)
 
# add widget
selected = mr.MultiSelect(
    label="Select what you want to see",
    value=["animation"],
    choices=["animation", "code"],
)
 
 
# create data and initialize Story with the created data
 
data = Data()
data.add_series("Foo", ["Alice", "Bob", "Ted"])
data.add_series("Bar", [15, 32, 12])
data.add_series("Baz", [5, 3, 2])
 
# you can also add data with pandas
 
# import pandas as pd
#
# data = Data()
# df = pd.read_csv(
#     "https://ipyvizzu-story.vizzuhq.com/0.12/assets/data/data.csv"
# )
# data.add_df(df)
 
story = Story(data=data)
 
# create Slides and Steps and add them to the Story
 
slide1 = Slide(
    Step(
        Config({"x": "Foo", "y": "Bar"}),
    )
)
story.add_slide(slide1)
 
slide2 = Slide(
    Step(
        Config({"color": "Foo", "x": "Baz", "geometry": "circle"}),
    )
)
story.add_slide(slide2)
 
# you can set the width and height (CSS style)
 
story.set_size(width="800px", height="480px")
 
# you can get the html Story as a string
 
html = story.to_html()
 
if "animation" in selected.value:
    story.play()
if "code" in selected.value:
    display_html(html)

Check the Tutorial for more info.