You are reading documentation for the unreleased version of Matplotlib. Try searching for the released version of this page instead?
Version 2.0.0b1.post7580.dev0+ge487118
matplotlib
Fork me on GitHub

This Page

matplotlib.backends.backend_nbagg

Interactive figures in the IPython notebook

class matplotlib.backends.backend_nbagg.CommSocket(manager)

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()
on_close()
on_message(message)
send_binary(blob)
send_json(content)
matplotlib.backends.backend_nbagg.FigureCanvas

alias of FigureCanvasNbAgg

class matplotlib.backends.backend_nbagg.FigureCanvasNbAgg(*args, **kwargs)

Bases: matplotlib.backends.backend_webagg_core.FigureCanvasWebAggCore

new_timer(*args, **kwargs)
matplotlib.backends.backend_nbagg.FigureManager

alias of FigureManagerNbAgg

class matplotlib.backends.backend_nbagg.FigureManagerNbAgg(canvas, num)

Bases: matplotlib.backends.backend_webagg_core.FigureManagerWebAgg

ToolbarCls

alias of NavigationIPy

clearup_closed()

Clear up any closed Comms.

connected
destroy()
display_js()
classmethod get_javascript(stream=None)
remove_comm(comm_id)
reshow()

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

show()
class matplotlib.backends.backend_nbagg.NavigationIPy(canvas)

Bases: matplotlib.backends.backend_webagg_core.NavigationToolbar2WebAgg

toolitems = [('Home', 'Reset original view', 'fa fa-home icon-home', 'home'), ('Back', 'Back to previous view', 'fa fa-arrow-left icon-arrow-left', 'back'), ('Forward', 'Forward to next view', 'fa fa-arrow-right icon-arrow-right', 'forward'), (None, None, None, None), ('Pan', 'Pan axes with left mouse, zoom with right', 'fa fa-arrows icon-move', 'pan'), ('Zoom', 'Zoom to rectangle', 'fa fa-square-o icon-check-empty', 'zoom'), (None, None, None, None), ('Download', 'Download plot', 'fa fa-floppy-o icon-save', 'download')]
matplotlib.backends.backend_nbagg.connection_info()

Return a string showing the figure and connection status for the backend. This is intended as a diagnostic tool, and not for general use.

matplotlib.backends.backend_nbagg.new_figure_manager_given_figure(num, figure)
matplotlib.backends.backend_nbagg.show(*args, **kwargs)