From 9e0ccb673711254f81ee75606a6abb337658aae9 Mon Sep 17 00:00:00 2001 From: Phil Elson Date: Wed, 24 Sep 2014 13:41:11 +0100 Subject: [PATCH] Updated whats new for nbagg and legend/patheffects docs. --- doc/users/whats_new.rst | 37 ++++++++++++++++++++++++++++++++++--- 1 file changed, 34 insertions(+), 3 deletions(-) diff --git a/doc/users/whats_new.rst b/doc/users/whats_new.rst index b5e4680c1b1f..eaf65947d543 100644 --- a/doc/users/whats_new.rst +++ b/doc/users/whats_new.rst @@ -41,10 +41,28 @@ legibility through brightness variations. See `here `_ for more information. -Documentation changes ---------------------- +The nbagg backend +----------------- +Phil Elson added a new backend, named "nbagg", which enables interactive +figures in a live IPython notebook session. The backend makes use of the +infrastructure developed for the webagg backend, which itself gives +standalone server backed interactive figures in the browser, however nbagg +does not require a dedicated matplotlib server as all communications are +handled through the IPython Comm machinery. + +As with other backends nbagg can be enabled inside the IPython notebook with:: + + import matplotlib + matplotlib.use('nbagg') + +Once figures are created and then subsequently shown, they will placed in an +interactive widget inside the notebook allowing panning and zooming in the +same way as any other matplotlib backend. Because figures require a connection +to the IPython notebook server for their interactivity, once the notebook is +saved, each figure will be rendered as a static image - thus allowing +non-interactive viewing of figures on services such as +`nbviewer `_. -Phil Elson rewrote of the documentation and userguide for both Legend and PathEffects (links needed). New plotting features @@ -269,6 +287,7 @@ Controls whether figures are saved with a transparent background by default. Previously `savefig` always defaulted to a non-transparent background. + ``axes.titleweight`` ```````````````````` Added rcParam to control the weight of the title @@ -281,6 +300,12 @@ an offset will be determined such that the tick labels are meaningful. If `False` then the full number will be formatted in all conditions. +``nbagg.transparent`` added +````````````````````````````` +Controls whether nbagg figures have a transparent +background. ``nbagg.transparent`` is ``True`` by default. + + XDG compliance `````````````` 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 be present in documentation. To enable this option, use ``:context: reset`` instead of ``:context:`` any time you want to reset the context. +Legend and PathEffects documentation +------------------------------------ +The :ref:`plotting-guide-legend` and :ref:`patheffects-guide` have both been +updated to better reflect the full potential of each of these powerful +features. + Widgets -------