Displays Agg images in the browser, with interactivity


alias of FigureCanvasWebAgg

class matplotlib.backends.backend_webagg.FigureCanvasWebAgg(*args, **kwargs)[source]#

Bases: FigureCanvasWebAggCore


alias of FigureManagerWebAgg


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

To customize the behavior of, interactive backends should usually override start_main_loop; if more customized logic is necessary, pyplot_show can also be overridden.

blockbool, 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.ServerThread(group=None, target=None, name=None, args=(), kwargs=None, *, daemon=None)[source]#

Bases: Thread



Deprecated since version 3.7:

This constructor should always be called with keyword arguments. Arguments are:

group should be None; reserved for future extension when a ThreadGroup class is implemented.

target is the callable object to be invoked by the run() method. Defaults to None, meaning nothing is called.

name is the thread name. By default, a unique name is constructed of the form "Thread-N" where N is a small decimal number.

args is the argument tuple for the target invocation. Defaults to ().

kwargs is a dictionary of keyword arguments for the target invocation. Defaults to {}.

If a subclass overrides the constructor, it must make sure to invoke the base class constructor (Thread.__init__()) before doing anything else to the thread.


Method representing the thread's activity.

You may override this method in a subclass. The standard run() method invokes the callable object passed to the object's constructor as the target argument, if any, with sequential and keyword arguments taken from the args and kwargs arguments, respectively.

class matplotlib.backends.backend_webagg.WebAggApplication(url_prefix='')[source]#

Bases: Application

class AllFiguresPage(application, request, *, url_prefix='', **kwargs)[source]#

Bases: RequestHandler

class Download(application: Application, request: HTTPServerRequest, **kwargs: Any)[source]#

Bases: RequestHandler

get(fignum, fmt)[source]#
class FavIcon(application: Application, request: HTTPServerRequest, **kwargs: Any)[source]#

Bases: RequestHandler

class MplJs(application: Application, request: HTTPServerRequest, **kwargs: Any)[source]#

Bases: RequestHandler

class SingleFigurePage(application, request, *, url_prefix='', **kwargs)[source]#

Bases: RequestHandler

class WebSocket(application: Application, request: HTTPServerRequest, **kwargs: Any)[source]#

Bases: WebSocketHandler


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.


Handle incoming messages on the WebSocket

This method must be overridden.

Changed in version 4.5: on_message can be a coroutine.


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.

supports_binary = True#
classmethod initialize(url_prefix='', port=None, address=None)[source]#
initialized = False#
classmethod start()[source]#
started = False#