backends

Projections module-attribute

Projections = Literal[
    "rectilinear", "polar", "aitoff", "hammer", "lambert", "mollweide", "3d"
]

plotting_backends module-attribute

plotting_backends: PlottingBackends = PlottingBackends(
    matplotlib=MatplotlibBackend(), bokeh=BokehBackend()
)

BokehBackend

Bases: PlottingBackend

legend_key property

legend_key: str

annotate

annotate(ax: 'BkFigure', *args, watermark: bool = False, **kwargs)

clear_axes

clear_axes(obj: Plottable)

create_subplots

create_subplots(
    nrows: int,
    ncols: int,
    figsize: Tuple[int | float, ...] | None = None,
    subfigsize: Tuple[int | float, ...] = (6, 4),
    projection: str | Projections | List[str | Projections] | None = None,
    **subplot_kw
) -> List["BkFigure"]

equal

equal(ax: 'BkFigure')

extract_axes

extract_axes(obj: Plottable) -> List['BkFigure']

line

line(ax: 'BkFigure', *args, watermark: bool = False, **kwargs)

scatter

scatter(ax: 'BkFigure', *args, watermark: bool = False, **kwargs)

scatter3D

scatter3D(ax: 'BkFigure', *args, watermark: bool = False, **kwargs)

setAxesProps

setAxesProps(ax, **kwargs)

set_xlabel

set_xlabel(ax: 'BkFigure', xlabel: str)

set_ylabel

set_ylabel(ax: 'BkFigure', ylabel: str)

surface

surface(ax: 'BkFigure', *args, watermark: bool = False, **kwargs)

text

text(ax: 'BkFigure', *args, watermark: bool = False, **kwargs)

trisurf

trisurf(ax: 'BkFigure', *args, watermark: bool = False, **kwargs)

watermark

watermark(ax, *args, **kwargs)

wireframe

wireframe(ax: 'BkFigure', *args, watermark: bool = False, **kwargs)

MatplotlibBackend

Bases: PlottingBackend

legend_key property

legend_key: str

annotate

annotate(ax: 'Axes', *args, watermark: bool = False, **kwargs)

clear_axes

clear_axes(obj: Plottable)

create_subplots

create_subplots(
    nrows: int,
    ncols: int,
    figsize: Tuple[int | float, ...] | None = None,
    subfigsize: Tuple[int | float, ...] = (6, 4),
    projection: str | Projections | List[str | Projections] | None = None,
    **subplot_kw
) -> List[Union["Axes", "Axes3D"]]

equal

equal(ax: 'Axes')

extract_axes

extract_axes(obj: Plottable) -> List[Union['Axes', 'Axes3D']]

line

line(ax: 'Axes', *args, watermark: bool = False, **kwargs)

scatter

scatter(ax: 'Axes', *args, watermark: bool = False, **kwargs)

scatter3D

scatter3D(ax: 'Axes', *args, watermark: bool = False, **kwargs)

setAxesProps

setAxesProps(ax, **kwargs)

set_xlabel

set_xlabel(ax: 'Axes', xlabel: str)

set_ylabel

set_ylabel(ax: 'Axes', ylabel: str)

surface

surface(ax: 'Axes3D', *args, watermark: bool = False, **kwargs)

text

text(ax: 'Axes', *args, watermark: bool = False, **kwargs)

trisurf

trisurf(ax: 'Axes3D', *args, watermark: bool = False, **kwargs)

watermark

watermark(ax: 'Axes', *args, **kwargs)

wireframe

wireframe(ax: 'Axes3D', *args, watermark: bool = False, **kwargs)

PlottingBackend

Bases: ABC

legend_key abstractmethod property

legend_key: str

Return the key for the legend label.

annotate abstractmethod

annotate(ax, *args, watermark: bool = False, **kwargs)

Add annotate to the plot.

clear_axes abstractmethod

clear_axes(obj: Plottable)

Clear the axes.

create_subplots abstractmethod

create_subplots(
    nrows: int,
    ncols: int,
    figsize: Tuple[int | float, ...] | None = None,
    subfigsize: Tuple[int | float, ...] = (6, 4),
    projection: str | Projections | List[str | Projections] | None = None,
    **subplot_kw
) -> List

Create subplots.

equal abstractmethod

equal(ax)

Set the aspect ratio to be equal.

extract_axes abstractmethod

extract_axes(obj: Plottable) -> List

Extract axes from the given object.

line abstractmethod

line(ax, *args, watermark: bool = False, **kwargs)

Plot a line.

plot

plot(ax, *args, watermark: bool = False, **kwargs)

Plot a line.

scatter abstractmethod

scatter(ax, *args, watermark: bool = False, **kwargs)

Plot scatter points.

scatter3D abstractmethod

scatter3D(ax, *args, watermark: bool = False, **kwargs)

Plot scatter points.

setAxesProps abstractmethod

setAxesProps(ax, **kwargs)

Set the properties for the axes.

set_xlabel abstractmethod

set_xlabel(ax, xlabel: str)

Set the x-axis label.

set_ylabel abstractmethod

set_ylabel(ax, ylabel: str)

Set the y-axis label.

surface abstractmethod

surface(ax, *args, watermark: bool = False, **kwargs)

Plot a surface.

text abstractmethod

text(ax, *args, watermark: bool = False, **kwargs)

Add text to the plot.

trisurf abstractmethod

trisurf(ax, *args, watermark: bool = False, **kwargs)

Plot a trisurf.

watermark abstractmethod

watermark(ax, *args, **kwargs)

Draw a watermark on the plot.

wireframe abstractmethod

wireframe(ax, *args, watermark: bool = False, **kwargs)

Plot a wireframe.

PlottingBackends

Bases: Dict[Any, PlottingBackend]

Backends registry.

bokeh property

bokeh: BokehBackend

Return the cpp backend.

current property

current: PlottingBackend

Return the current backend.

matplotlib property

matplotlib: MatplotlibBackend

Return the matplotlib backend.