Story

ipyvizzustory.env.py.story

A module for working with presentation stories in Python environment.

ipyvizzustory.env.py.story.Story

Bases: StoryLib

A class for representing a presentation story in Python environment.

Source code in ipyvizzustory/env/py/story.py

class Story(StoryLib):
    """A class for representing a presentation story in Python environment."""

    def __init__(self, data: Data, style: Optional[Style] = None):
        """
        Presentation Story constructor.

        Args:
            data: Data set for the whole presentation story.
                After initialization `data` can not be modified,
                but it can be filtered.
            style (optional): Style settings for the presentation story.
                `style` can be changed at each presentation step.
        """

        super().__init__(data=data, style=style)

    def play(self) -> str:
        """
        A method for returning the assembled html code in Python environment.

        Returns:
            The assembled html code as string.
        """

        return self.to_html()

__init__(data, style=None)

Presentation Story constructor.

Parameters:

Name	Type	Description	Default
data	Data	Data set for the whole presentation story. After initialization data can not be modified, but it can be filtered.	required
style	optional	Style settings for the presentation story. style can be changed at each presentation step.	None

Source code in ipyvizzustory/env/py/story.py

def __init__(self, data: Data, style: Optional[Style] = None):
    """
    Presentation Story constructor.

    Args:
        data: Data set for the whole presentation story.
            After initialization `data` can not be modified,
            but it can be filtered.
        style (optional): Style settings for the presentation story.
            `style` can be changed at each presentation step.
    """

    super().__init__(data=data, style=style)

play()

A method for returning the assembled html code in Python environment.

Returns:

Type	Description
str	The assembled html code as string.

Source code in ipyvizzustory/env/py/story.py

def play(self) -> str:
    """
    A method for returning the assembled html code in Python environment.

    Returns:
        The assembled html code as string.
    """

    return self.to_html()