Animationcontrol

ipyvizzu.animationcontrol

A module for working with animation control.

ipyvizzu.animationcontrol.AnimationControl

A class for controlling animations.

Source code in src/ipyvizzu/animationcontrol.py

class AnimationControl:
    """
    A class for controlling animations.
    """

    def __init__(self, prev_id: str, last_id: str, display_method: Callable):
        """
        AnimationControl constructor.

        Args:
            prev_id: Id of the previous animation promise.
            last_id: Id of the animation to be controlled.
            display_method: Displaying function.
        """

        self._ids = ", ".join([f"'{prev_id}'", f"'{last_id}'"])
        self._display = display_method

    def cancel(self) -> None:
        """Cancels the animation, will reject the animation promise."""

        self._display(
            DisplayTemplate.CONTROL.format(
                method="cancel",
                params=self._ids,
            )
        )

    def pause(self) -> None:
        """Pauses the controlled animation."""

        self._display(
            DisplayTemplate.CONTROL.format(
                method="pause",
                params=self._ids,
            )
        )

    def play(self) -> None:
        """Plays/resumes playing of the controlled animation."""

        self._display(
            DisplayTemplate.CONTROL.format(
                method="play",
                params=self._ids,
            )
        )

    def reverse(self) -> None:
        """Changes the direction of the controlled animation."""

        self._display(
            DisplayTemplate.CONTROL.format(
                method="reverse",
                params=self._ids,
            )
        )

    def seek(self, value: Union[int, str]) -> None:
        """
        Seeks the animation to the position specified by time or progress percentage.

        Args:
            value: The position specified by time or progress percentage.
        """

        params = ", ".join([self._ids, f"'{value}'"])
        self._display(
            DisplayTemplate.CONTROL.format(
                method="seek",
                params=params,
            )
        )

    def stop(self) -> None:
        """Stops the current animation seeking it back to its start position."""

        self._display(
            DisplayTemplate.CONTROL.format(
                method="stop",
                params=self._ids,
            )
        )

    def store(self) -> Animation:
        """
        A method for saving and storing the actual state of the animation.

        Returns:
            An `Animation` object wich stores the actual state of the animation.
        """

        animation_id = uuid.uuid4().hex[:7]
        params = ", ".join([self._ids, f"'{animation_id}'"])
        self._display(
            DisplayTemplate.CONTROL.format(
                method="store",
                params=params,
            )
        )
        return Animation(animation_id)

__init__(prev_id, last_id, display_method)

AnimationControl constructor.

Parameters:

Name	Type	Description	Default
prev_id	str	Id of the previous animation promise.	required
last_id	str	Id of the animation to be controlled.	required
display_method	Callable	Displaying function.	required

Source code in src/ipyvizzu/animationcontrol.py

def __init__(self, prev_id: str, last_id: str, display_method: Callable):
    """
    AnimationControl constructor.

    Args:
        prev_id: Id of the previous animation promise.
        last_id: Id of the animation to be controlled.
        display_method: Displaying function.
    """

    self._ids = ", ".join([f"'{prev_id}'", f"'{last_id}'"])
    self._display = display_method

cancel()

Cancels the animation, will reject the animation promise.

Source code in src/ipyvizzu/animationcontrol.py

def cancel(self) -> None:
    """Cancels the animation, will reject the animation promise."""

    self._display(
        DisplayTemplate.CONTROL.format(
            method="cancel",
            params=self._ids,
        )
    )

pause()

Pauses the controlled animation.

Source code in src/ipyvizzu/animationcontrol.py

def pause(self) -> None:
    """Pauses the controlled animation."""

    self._display(
        DisplayTemplate.CONTROL.format(
            method="pause",
            params=self._ids,
        )
    )

play()

Plays/resumes playing of the controlled animation.

Source code in src/ipyvizzu/animationcontrol.py

def play(self) -> None:
    """Plays/resumes playing of the controlled animation."""

    self._display(
        DisplayTemplate.CONTROL.format(
            method="play",
            params=self._ids,
        )
    )

reverse()

Changes the direction of the controlled animation.

Source code in src/ipyvizzu/animationcontrol.py

def reverse(self) -> None:
    """Changes the direction of the controlled animation."""

    self._display(
        DisplayTemplate.CONTROL.format(
            method="reverse",
            params=self._ids,
        )
    )

seek(value)

Seeks the animation to the position specified by time or progress percentage.

Parameters:

Name	Type	Description	Default
value	Union[int, str]	The position specified by time or progress percentage.	required

Source code in src/ipyvizzu/animationcontrol.py

def seek(self, value: Union[int, str]) -> None:
    """
    Seeks the animation to the position specified by time or progress percentage.

    Args:
        value: The position specified by time or progress percentage.
    """

    params = ", ".join([self._ids, f"'{value}'"])
    self._display(
        DisplayTemplate.CONTROL.format(
            method="seek",
            params=params,
        )
    )

stop()

Stops the current animation seeking it back to its start position.

Source code in src/ipyvizzu/animationcontrol.py

def stop(self) -> None:
    """Stops the current animation seeking it back to its start position."""

    self._display(
        DisplayTemplate.CONTROL.format(
            method="stop",
            params=self._ids,
        )
    )

store()

A method for saving and storing the actual state of the animation.

Returns:

Type	Description
Animation	An Animation object wich stores the actual state of the animation.

Source code in src/ipyvizzu/animationcontrol.py

def store(self) -> Animation:
    """
    A method for saving and storing the actual state of the animation.

    Returns:
        An `Animation` object wich stores the actual state of the animation.
    """

    animation_id = uuid.uuid4().hex[:7]
    params = ", ".join([self._ids, f"'{animation_id}'"])
    self._display(
        DisplayTemplate.CONTROL.format(
            method="store",
            params=params,
        )
    )
    return Animation(animation_id)