SaveGifButton

class ansys.tools.visualization_interface.backends.pyvista.widgets.save_gif_button.SaveGifButton(plotter: pyvista.Plotter, animation, dark_mode: bool = False)

Bases: ansys.tools.visualization_interface.backends.pyvista.widgets.button.Button

Provides GIF export control for animations.

This button exports the animation as a timestamped GIF file.

Parameters:

plotterPlotter

Plotter to draw the button on.

animationAnimation

Animation instance to control.

dark_modebool, optional

Whether to activate the dark mode or not.

Overview

Methods

callback

Export animation as GIF file.

Import detail

from ansys.tools.visualization_interface.backends.pyvista.widgets.save_gif_button import SaveGifButton

Method detail

SaveGifButton.callback(state: bool) → None

Export animation as GIF file.

Parameters:

statebool

Whether the button is active.