matplotlib.animation.FuncAnimation
-
class matplotlib.animation.FuncAnimation(fig, func, frames=None, init_func=None, fargs=None, save_count=None, *, cache_frame_data=True, **kwargs)[source] -
Создаёт анимацию, многократно вызывая функцию func.
Параметры: -
figFigure -
Объект figure, используемый для получения событий рисования, изменения размера и других необходимых событий.
-
funccallable -
Функция, вызываемая на каждом кадре. Первым аргументом будет следующее значение из frames. Дополнительные позиционные аргументы можно передать через параметр fargs.
Необходимая сигнатура:
def func(frame, *fargs) -> iterable_of_artists
Если
blit == True, func должна возвращать итерируемый объект всех изменённых или созданных художников. Эта информация используется алгоритмом blitting для определения частей фигуры, которые необходимо обновить. Возвращаемое значение игнорируется, еслиblit == Falseи может быть опущено в этом случае. -
framesiterable, int, generator function, or None, optional -
Источник данных для передачи функции func и каждого кадра анимации
- Если итерируемый объект, то просто используются предоставленные значения. Если итерируемый объект имеет длину, он переопределит параметр save_count.
- Если целое число, то эквивалентно передаче
range(frames) -
Если функция-генератор, то должна иметь сигнатуру:
def gen_function() -> obj
- Если None, то эквивалентно передаче
itertools.count.
Во всех этих случаях значения в frames просто передаются в предоставленную пользователем функцию func, и, таким образом, они могут быть любого типа.
-
init_funccallable, optional -
Функция, используемая для рисования чистого кадра. Если не указана, используются результаты рисования из первого элемента последовательности кадров. Эта функция вызывается один раз перед первым кадром.
Необходимая сигнатура:
def init_func() -> iterable_of_artists
Если
blit == True, init_func должна возвращать итерируемый объект художников, которые нужно перерисовать. Эта информация используется алгоритмом blitting для определения частей фигуры, которые необходимо обновить. Возвращаемое значение игнорируется, еслиblit == Falseи может быть опущено в этом случае. -
fargstuple or None, optional -
Дополнительные аргументы для передачи каждой функции вызова func.
-
save_countint, default: 100 -
Запасное значение для количества значений из frames для кэширования. Используется только в том случае, если количество кадров нельзя определить из frames, т. е. когда это итератор без длины или генератор.
-
intervalnumber, optional -
Задержка между кадрами в миллисекундах. По умолчанию 200.
-
repeat_delaynumber, optional -
Если анимация повторяется, добавляет задержку в миллисекундах перед повторением анимации. По умолчанию None.
-
repeatbool, optional -
Определяет, должна ли анимация повторяться после завершения последовательности кадров. По умолчанию True.
-
blitbool, optional -
Определяет, использовать ли blitting для оптимизации рисования. Примечание: при использовании blitting, все анимированные художники будут нарисованы в соответствии с их z-порядком. Однако они будут нарисованы поверх любых предыдущих художников, независимо от их z-порядка. По умолчанию False.
-
cache_frame_databool, optional -
Определяет, кэшировать ли данные кадров. По умолчанию True. Отключение кэширования может быть полезно, когда кадры содержат большие объекты.
-
__init__(self, fig, func, frames=None, init_func=None, fargs=None, save_count=None, *, cache_frame_data=True, **kwargs)[source] -
Инициализировать self. См. help(type(self)) для точной сигнатуры.
Методы
__init__(self, fig, func[, frames, ...])Инициализировать self. new_frame_seq(self)Возвращает новую последовательность информации о кадре. new_saved_frame_seq(self)Возвращает новую последовательность информации о сохранённых/кэшированных кадрах. save(self, filename[, writer, fps, dpi, ...])Сохранить анимацию как файл фильма, нарисовав каждый кадр. to_html5_video(self[, embed_limit])Преобразовать анимацию в HTML5 тег <video>.to_jshtml(self[, fps, embed_frames, ...])Генерировать HTML-представление анимации -
new_frame_seq(self)[source] -
Возвращает новую последовательность информации о кадре.
-
new_saved_frame_seq(self)[source] -
Возвращает новую последовательность информации о сохранённых/кэшированных кадрах.
-
© 2012–2018 Matplotlib Development Team. All rights reserved.
Licensed under the Matplotlib License Agreement.
https://matplotlib.org/3.2.2/api/_as_gen/matplotlib.animation.FuncAnimation.html