matplotlib.backends.backend_nbagg

Interactive figures in the IPython notebook.

classmatplotlib.backends.backend_nbagg.CommSocket(manager)[source]

Bases: object

Manages the Comm connection between IPython and the browser (client).

Comms are 2 way, with the CommSocket being able to publish a message via the send_json method, and handle a message with on_message. On the JS side figure.send_message and figure.ws.onmessage do the sending and receiving respectively.

is_open()[source]

on_close()[source]

on_message(message)[source]

send_binary(blob)[source]

send_json(content)[source]

matplotlib.backends.backend_nbagg.FigureCanvas[source]

alias of FigureCanvasNbAgg

classmatplotlib.backends.backend_nbagg.FigureCanvasNbAgg(*args, **kwargs)[source]

Bases: FigureCanvasWebAggCore

manager_class[source]

alias of FigureManagerNbAgg

matplotlib.backends.backend_nbagg.FigureManager[source]

alias of FigureManagerNbAgg

classmatplotlib.backends.backend_nbagg.FigureManagerNbAgg(canvas, num)[source]

Bases: FigureManagerWebAgg

ToolbarCls[source]

alias of NavigationIPy

clearup_closed()[source]

Clear up any closed Comms.

propertyconnected

classmethodcreate_with_canvas(canvas_class, figure, num)[source]

Create a manager for a given figure using a specific canvas_class.

Backends should override this method if they have specific needs for setting up the canvas or the manager.

destroy()[source]

display_js()[source]

classmethodget_javascript(stream=None)[source]

remove_comm(comm_id)[source]

reshow()[source]

A special method to re-show the figure in the notebook.

show()[source]

For GUI backends, show the figure window and redraw. For non-GUI backends, raise an exception, unless running headless (i.e. on Linux with an unset DISPLAY); this exception is converted to a warning in Figure.show.

classmatplotlib.backends.backend_nbagg.NavigationIPy(canvas)[source]

Bases: NavigationToolbar2WebAgg

toolitems=[('Home', 'Reset original view', 'fa fa-home', 'home'), ('Back', 'Back to previous view', 'fa fa-arrow-left', 'back'), ('Forward', 'Forward to next view', 'fa fa-arrow-right', 'forward'), (None, None, None, None), ('Pan', 'Left button pans, Right button zooms\nx/y fixes axis, CTRL fixes aspect', 'fa fa-arrows', 'pan'), ('Zoom', 'Zoom to rectangle\nx/y fixes axis', 'fa fa-square-o', 'zoom'), (None, None, None, None), ('Download', 'Download plot', 'fa fa-floppy-o', 'download')]

matplotlib.backends.backend_nbagg.connection_info()[source]

Return a string showing the figure and connection status for the backend.

This is intended as a diagnostic tool, and not for general use.