St

ipyvizzustory.env.st

Streamlit environment dependent modules.

ipyvizzustory.env.st.story

A module for working with presentation stories in Streamlit environment.

Story

Bases: StoryLib

A class for representing a presentation story in Streamlit environment.

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

class Story(StoryLib):
    """A class for representing a presentation story in Streamlit 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)
        self.set_size(800, 480)

    def set_size(  # type: ignore  # pylint: disable=signature-differs
        self, width: int, height: int
    ) -> None:
        """
        A method for overwriting `ipyvizzustory.storylib.story.Story.set_size()` method.
        In Streamlit environment `width` and `height` must be specified in pixels.

        Args:
            width: Width of the presentation story in pixels.
            height: Height of the presentation story in pixels.

        Raises:
            ValueError: If `width` or `height` is not instance of `int`.
        """

        if any([not isinstance(width, int), not isinstance(height, int)]):
            raise ValueError("width and height should be in pixels as int")
        super().set_size(width=str(width) + "px", height=str(height) + "px")

    def play(self) -> None:
        """A method for displaying the assembled html code in Streamlit environment."""

        html(
            self.to_html(),
            width=int(self._size.width[:-2]),  # type: ignore
            height=int(self._size.height[:-2]),  # type: ignore
        )

__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/st/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)
    self.set_size(800, 480)

set_size(width, height)

A method for overwriting ipyvizzustory.storylib.story.Story.set_size() method. In Streamlit environment width and height must be specified in pixels.

Parameters:

Name	Type	Description	Default
width	int	Width of the presentation story in pixels.	required
height	int	Height of the presentation story in pixels.	required

Raises:

Type	Description
ValueError	If width or height is not instance of int.

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

def set_size(  # type: ignore  # pylint: disable=signature-differs
    self, width: int, height: int
) -> None:
    """
    A method for overwriting `ipyvizzustory.storylib.story.Story.set_size()` method.
    In Streamlit environment `width` and `height` must be specified in pixels.

    Args:
        width: Width of the presentation story in pixels.
        height: Height of the presentation story in pixels.

    Raises:
        ValueError: If `width` or `height` is not instance of `int`.
    """

    if any([not isinstance(width, int), not isinstance(height, int)]):
        raise ValueError("width and height should be in pixels as int")
    super().set_size(width=str(width) + "px", height=str(height) + "px")

play()

A method for displaying the assembled html code in Streamlit environment.

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

def play(self) -> None:
    """A method for displaying the assembled html code in Streamlit environment."""

    html(
        self.to_html(),
        width=int(self._size.width[:-2]),  # type: ignore
        height=int(self._size.height[:-2]),  # type: ignore
    )