chartbook.plotting.backends

Backend loading and plugin management for chartbook.plotting.

Package Contents

Functions

get_backend	Get a plotting backend by name.
get_plugin_manager	Get or create the plugin manager.
list_backends	List all available backend names.
register_backend	Register a custom plotting backend.

API

chartbook.plotting.backends.get_backend(name: str = 'plotly') → chartbook.plotting.backends._base.PlottingBackend

Get a plotting backend by name.

Parameters

name : str Backend name. Options: “plotly”, “matplotlib”, or any registered plugin name.

Returns

PlottingBackend The requested backend implementation.

Raises

ValueError If the backend name is not found.

chartbook.plotting.backends.get_plugin_manager() → pluggy.PluginManager

Get or create the plugin manager.

chartbook.plotting.backends.list_backends() → list[str]

List all available backend names.

Returns

list[str] Names of all registered backends.

chartbook.plotting.backends.register_backend(backend: chartbook.plotting.backends._base.PlottingBackend, name: str | None = None) → None

Register a custom plotting backend.

Parameters

backend : PlottingBackend Backend instance to register. name : str, optional Name for the backend. If not provided, uses backend.name.

Examples

Third-party packages can also register via entry points:

[project.entry-points.chartbook_plotting]
my_backend = "mypackage.backend:MyBackend"