Animatplot is build on top of three main classes:

• Animation
• Block
• Timeline

A Timeline holds the information and logic to actually control the timing of all animations.

A Block represents any "thing" that is to be animated.

An Animation is a composition of a list of blocks and a timeline. This class builds the final animation.

.. currentmodule:: animatplot

.. autosummary::
    :toctree: _as_gen/

    Animation

.. autosummary::
    :toctree: _as_gen/

    Timeline

Blocks handle the animation of different types of data. The following blocks are available in animatplot.blocks.

These blocks are built to animate data.

.. currentmodule:: animatplot.blocks

.. autosummary::
    :toctree: _as_gen/

    Line
    Quiver
    Pcolormesh
    Imshow
    Scatter

These blocks are for animating non-data features on an axis.

.. autosummary::
    :toctree: _as_gen/

    Title

These blocks are for more advanced use. These allow you to write more custom animations.

.. autosummary::
    :toctree: _as_gen/

    Block
    Update
    Nuke

These blocks are amalgamations of other blocks. These are actually functions that return lists of blocks.

.. autosummary::
    :toctree: _as_gen/

    vector_comp

The animations subpackage is an opinionated subpackage that contains a number of convenience functions for specific use cases. These functions wrap around different combinations of blocks.

In general, these functions will take some data to be animated, some parameters to tell animatplot what to do, then dictionaries of parameters to pass to the underlying blocks.

This submodule contains the following functions.

.. currentmodule:: animatplot.animations

.. autosummary::
    :toctree: _as_gen/

    vector_plot