Skip to content

Commit 9e0ccb6

Browse files
committed
Updated whats new for nbagg and legend/patheffects docs.
1 parent 0ce5259 commit 9e0ccb6

File tree

1 file changed

+34
-3
lines changed

1 file changed

+34
-3
lines changed

doc/users/whats_new.rst

Lines changed: 34 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -41,10 +41,28 @@ legibility through brightness variations. See
4141
`here <https://github.com/wistia/heatmap-palette>`_
4242
for more information.
4343

44-
Documentation changes
45-
---------------------
44+
The nbagg backend
45+
-----------------
46+
Phil Elson added a new backend, named "nbagg", which enables interactive
47+
figures in a live IPython notebook session. The backend makes use of the
48+
infrastructure developed for the webagg backend, which itself gives
49+
standalone server backed interactive figures in the browser, however nbagg
50+
does not require a dedicated matplotlib server as all communications are
51+
handled through the IPython Comm machinery.
52+
53+
As with other backends nbagg can be enabled inside the IPython notebook with::
54+
55+
import matplotlib
56+
matplotlib.use('nbagg')
57+
58+
Once figures are created and then subsequently shown, they will placed in an
59+
interactive widget inside the notebook allowing panning and zooming in the
60+
same way as any other matplotlib backend. Because figures require a connection
61+
to the IPython notebook server for their interactivity, once the notebook is
62+
saved, each figure will be rendered as a static image - thus allowing
63+
non-interactive viewing of figures on services such as
64+
`nbviewer <http://nbviewer.ipython.org/>`_.
4665

47-
Phil Elson rewrote of the documentation and userguide for both Legend and PathEffects (links needed).
4866

4967

5068
New plotting features
@@ -269,6 +287,7 @@ Controls whether figures are saved with a transparent
269287
background by default. Previously `savefig` always defaulted
270288
to a non-transparent background.
271289

290+
272291
``axes.titleweight``
273292
````````````````````
274293
Added rcParam to control the weight of the title
@@ -281,6 +300,12 @@ an offset will be determined such that the tick labels are
281300
meaningful. If `False` then the full number will be formatted in all
282301
conditions.
283302

303+
``nbagg.transparent`` added
304+
`````````````````````````````
305+
Controls whether nbagg figures have a transparent
306+
background. ``nbagg.transparent`` is ``True`` by default.
307+
308+
284309
XDG compliance
285310
``````````````
286311
Matplotlib now looks for configuration files (both rcparams and style) in XDG
@@ -387,6 +412,12 @@ cause the context to be reset. This allows more than one distinct context to
387412
be present in documentation. To enable this option, use ``:context: reset``
388413
instead of ``:context:`` any time you want to reset the context.
389414

415+
Legend and PathEffects documentation
416+
------------------------------------
417+
The :ref:`plotting-guide-legend` and :ref:`patheffects-guide` have both been
418+
updated to better reflect the full potential of each of these powerful
419+
features.
420+
390421
Widgets
391422
-------
392423

0 commit comments

Comments
 (0)