Text of matplotlib.org › stable › api › backend_webagg_api.html as Styx crawled it on Nov 18, 2026. The page may have changed since. Only its words are kept, without pictures or layout.

Open the live page

matplotlib.backends.backend_webagg — Matplotlib 3.11.2 documentation

Skip to main content Plot types User guide Tutorials Examples Reference Contribute Releases Gitter Discourse GitHub matplotlib.backends.backend_webagg # Displays Agg images in the browser, with interactivity. matplotlib.backends.backend_webagg. FigureCanvas [source] # alias of FigureCanvasWebAgg class matplotlib.backends.backend_webagg. FigureCanvasWebAgg ( * args , ** kwargs ) [source] # Bases: FigureCanvasWebAggCore manager_class [source] # alias of FigureManagerWebAgg matplotlib.backends.backend_webagg.

FigureManager [source] # alias of FigureManagerWebAgg class matplotlib.backends.backend_webagg. FigureManagerWebAgg ( canvas , num ) [source] # Bases: FigureManagerWebAgg classmethod pyplot_show ( * , block = None ) [source] # Show all figures. This method is the implementation of pyplot.show . To customize the behavior of pyplot.show , interactive backends should usually override start_main_loop ; if more customized logic is necessary, pyplot_show can also be overridden.

Parameters : block bool, optional Whether to block by calling start_main_loop . The default, None, means to block if we are neither in IPython's %pylab mode nor in interactive mode. class matplotlib.backends.backend_webagg. WebAggApplication ( url_prefix = '' ) [source] # Bases: Application class AllFiguresPage ( application , request , * , url_prefix = '' , ** kwargs ) [source] # Bases: RequestHandler get ( ) [source] # class Download ( application , request , ** kwargs ) [source] # Bases: RequestHandler get ( fignum , fmt ) [source] # class FavIcon ( application , request , ** kwargs ) [source] # Bases: RequestHandler get ( ) [source] # class MplJs ( application , request , ** kwargs ) [source] # Bases: RequestHandler get ( ) [source] # class SingleFigurePage ( application , request , * , url_prefix = '' , ** kwargs ) [source] # Bases: RequestHandler get ( fignum ) [source] # class WebSocket ( application , request , ** kwargs ) [source] # Bases: WebSocketHandler on_close ( ) [source] # Invoked when the WebSocket is closed.

If the connection was closed cleanly and a status code or reason phrase was supplied, these values will be available as the attributes self.close_code and self.close_reason . Changed in version 4.0: Added close_code and close_reason attributes. on_message ( message ) [source] # Handle incoming messages on the WebSocket This method must be overridden. Changed in version 4.5: on_message can be a coroutine. open ( fignum ) [source] # Invoked when a new WebSocket is opened.

The arguments to open are extracted from the tornado.web.URLSpec regular expression, just like the arguments to tornado.web.RequestHandler.get . open may be a coroutine. on_message will not be called until open has returned. Changed in version 5.1: open may be a coroutine. send_binary ( blob ) [source] # send_json ( content ) [source] # supports_binary = True # classmethod initialize ( url_prefix = '' , port = None , address = None ) [source] # initialized = False # classmethod start ( ) [source] # started = False # matplotlib.backends.backend_webagg. ipython_inline_display ( figure ) [source] # On this page