Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly
Appearance settings

Document animation HTML writer. #16333

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Jan 26, 2020
Merged

Document animation HTML writer. #16333

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 8 additions & 0 deletions 8 doc/api/animation_api.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -168,6 +168,14 @@ all data in memory.

PillowWriter

The HTML writer generates JavaScript-based animations.

.. autosummary::
:toctree: _as_gen
:nosignatures:

HTMLWriter

The pipe-based writers stream the captured frames over a pipe to an external
process. The pipe-based variants tend to be more performant, but may not work
on all systems.
Expand Down
30 changes: 25 additions & 5 deletions 30 doc/missing-references.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -752,7 +752,7 @@
"doc/api/prev_api_changes/api_changes_1.5.0.rst:119"
],
"MovieWriter.saving": [
"doc/api/animation_api.rst:213"
"doc/api/animation_api.rst:221"
],
"MovieWriterBase": [
"lib/matplotlib/animation.py:docstring of matplotlib.animation.AVConvBase:4",
Expand Down Expand Up @@ -972,6 +972,9 @@
"cbook.warn_deprecated()": [
"doc/devel/contributing.rst:309"
],
"cleanup": [
"lib/matplotlib/animation.py:docstring of matplotlib.animation.HTMLWriter.setup:19"
],
"collections.LineCollection.get_segements()": [
"doc/api/prev_api_changes/api_changes_3.1.0.rst:280"
],
Expand Down Expand Up @@ -1316,9 +1319,26 @@
"matplotlib.animation.FuncAnimation.to_jshtml": [
"lib/matplotlib/animation.py:docstring of matplotlib.animation.FuncAnimation.new_frame_seq:1:<autosummary>:1"
],
"matplotlib.animation.HTMLWriter": [
"doc/users/prev_whats_new/whats_new_2.1.0.rst:40",
"doc/users/prev_whats_new/whats_new_2.1.0.rst:51"
"matplotlib.animation.HTMLWriter.args_key": [
"lib/matplotlib/animation.py:docstring of matplotlib.animation.HTMLWriter.finish:1:<autosummary>:1"
],
"matplotlib.animation.HTMLWriter.bin_path": [
"doc/api/_as_gen/matplotlib.animation.HTMLWriter.rst:28:<autosummary>:1"
],
"matplotlib.animation.HTMLWriter.cleanup": [
"doc/api/_as_gen/matplotlib.animation.HTMLWriter.rst:28:<autosummary>:1"
],
"matplotlib.animation.HTMLWriter.exec_key": [
"lib/matplotlib/animation.py:docstring of matplotlib.animation.HTMLWriter.finish:1:<autosummary>:1"
],
"matplotlib.animation.HTMLWriter.frame_format": [
"lib/matplotlib/animation.py:docstring of matplotlib.animation.HTMLWriter.finish:1:<autosummary>:1"
],
"matplotlib.animation.HTMLWriter.frame_size": [
"lib/matplotlib/animation.py:docstring of matplotlib.animation.HTMLWriter.finish:1:<autosummary>:1"
],
"matplotlib.animation.HTMLWriter.saving": [
"doc/api/_as_gen/matplotlib.animation.HTMLWriter.rst:28:<autosummary>:1"
],
"matplotlib.animation.ImageMagickFileWriter.args_key": [
"lib/matplotlib/animation.py:docstring of matplotlib.animation.ImageMagickFileWriter.supported_formats:1:<autosummary>:1"
Expand Down Expand Up @@ -1669,4 +1689,4 @@
"lib/mpl_toolkits/mplot3d/axes3d.py:docstring of mpl_toolkits.mplot3d.axes3d.Axes3D.get_ylim3d:24"
]
}
}
}
2 changes: 2 additions & 0 deletions 2 lib/matplotlib/animation.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -777,6 +777,8 @@ def _embedded_frames(frame_list, frame_format):

@writers.register('html')
class HTMLWriter(FileMovieWriter):
"""Writer for JavaScript-based HTML movies."""

supported_formats = ['png', 'jpeg', 'tiff', 'svg']
_args_key = 'animation.html_args'

Expand Down
Morty Proxy This is a proxified and sanitized view of the page, visit original site.