animation

sisl.viz.animation(*figures: Figure, frame_duration: float = 500, interpolated_frames: int = 5, backend: Literal['plotly', 'matplotlib', 'py3dmol', 'blender'] = 'plotly', **kwargs) → Figure

Combines multiple plots into a single figure using an animation.

Parameters:

• *figures (Figure) – The figures (or plots) to combine.

• frame_duration (float, optional) – Number of milliseconds each frame should be displayed.

• interpolated_frames (int, optional) – Number of interpolated frames to add between each frame. This only works with the blender backend.

• backend ({"plotly", "matplotlib", "py3dmol", "blender"}, optional) – The backend to use for the merged figure.

• **kwargs – Additional arguments that will be passed to the _init_figure_* method of the Figure class. The arguments accepted here are basically backend specific, but for subplots all backends should support rows and cols to specify the number of rows and columns of the subplots, and arrange which controls the arrangement (“rows”, “cols” or “square”).

See also

merge_plots

The function that is called to merge the plots.