Skip to content

Commit 0657c02

Browse files
committed
Add the merge of JSAnimation to what's new.
1 parent f734fe0 commit 0657c02

File tree

1 file changed

+14
-3
lines changed

1 file changed

+14
-3
lines changed

doc/users/whats_new.rst

+14-3
Original file line numberDiff line numberDiff line change
@@ -87,9 +87,9 @@ Display hook for animations in the IPython notebook
8787
`matplotlib.animation.Animation` instances gained a ``_repr_html_`` method
8888
to support inline display of animations in the notebook. The method used
8989
to display is controlled by the ``animation.html`` rc parameter, which
90-
currently supports values of ``none`` and ``html5``. ``none`` is the
91-
default, performing no display. ``html5`` converts the animation to an
92-
h264 encoded video, which is embedded directly in the notebook.
90+
currently supports values of ``none``, ``jshtml``, and ``html5``. ``none``
91+
is the default, performing no display. ``html5`` converts the animation to an
92+
h264 encoded video, which is embedded directly in the notebook.
9393

9494
Users not wishing to use the ``_repr_html_`` display hook can also manually
9595
call the `to_html5_video` method to get the HTML and display using
@@ -98,6 +98,17 @@ IPython's ``HTML`` display class::
9898
from IPython.display import HTML
9999
HTML(anim.to_html5_video())
100100

101+
Jake Vanderplas' JSAnimation package was also merged into matplotlib. This
102+
adds to matplotlib the ``matplotlib.animation.HTMLWriter`` class for
103+
generating a javascript HTML animation, suitable for the IPython notebook.
104+
This can be activated by default by setting the ``animation.html`` rc
105+
parameter to ``jshtml``. One can also call the ``anim_to_jshtml`` function
106+
to manually convert an animation. This can be displayed using IPython's
107+
``HTML`` display class::
108+
109+
from IPython.display import HTML
110+
HTML(animation.anim_to_jshtml(anim))
111+
101112

102113
.. _whats-new-1-4:
103114

0 commit comments

Comments
 (0)