whitecanvas package
Subpackages
- whitecanvas.backend package
- Subpackages
- whitecanvas.backend.bokeh package
- whitecanvas.backend.matplotlib package
- Submodules
- whitecanvas.backend.matplotlib.band module
- whitecanvas.backend.matplotlib.bars module
- whitecanvas.backend.matplotlib.canvas module
- whitecanvas.backend.matplotlib.image module
- whitecanvas.backend.matplotlib.line module
- whitecanvas.backend.matplotlib.markers module
- whitecanvas.backend.matplotlib.text module
- Module contents
- whitecanvas.backend.plotly package
- Submodules
- whitecanvas.backend.plotly.band module
- whitecanvas.backend.plotly.bars module
- whitecanvas.backend.plotly.canvas module
- whitecanvas.backend.plotly.image module
- whitecanvas.backend.plotly.line module
- whitecanvas.backend.plotly.markers module
- whitecanvas.backend.plotly.text module
- Module contents
- whitecanvas.backend.pyqtgraph package
- Submodules
- whitecanvas.backend.pyqtgraph.band module
- whitecanvas.backend.pyqtgraph.bars module
- whitecanvas.backend.pyqtgraph.canvas module
- whitecanvas.backend.pyqtgraph.image module
- whitecanvas.backend.pyqtgraph.line module
- whitecanvas.backend.pyqtgraph.markers module
- whitecanvas.backend.pyqtgraph.text module
- Module contents
- whitecanvas.backend.vispy package
- Module contents
- Subpackages
- whitecanvas.canvas package
- whitecanvas.layers package
- Subpackages
- whitecanvas.layers.group package
- Submodules
- whitecanvas.layers.group.boxplot module
- whitecanvas.layers.group.colorbar module
- whitecanvas.layers.group.graph module
- whitecanvas.layers.group.labeled module
- whitecanvas.layers.group.line_band module
- whitecanvas.layers.group.line_markers module
- whitecanvas.layers.group.marker_collection module
- whitecanvas.layers.group.stemplot module
- whitecanvas.layers.group.textinfo module
- whitecanvas.layers.group.violinplot module
- Module contents
- whitecanvas.layers.primitive package
- Submodules
- whitecanvas.layers.primitive.band module
- whitecanvas.layers.primitive.bars module
- whitecanvas.layers.primitive.errorbars module
- whitecanvas.layers.primitive.image module
- whitecanvas.layers.primitive.inf_curve module
- whitecanvas.layers.primitive.line module
- whitecanvas.layers.primitive.markers module
- whitecanvas.layers.primitive.rug module
- whitecanvas.layers.primitive.spans module
- whitecanvas.layers.primitive.text module
- Module contents
- whitecanvas.layers.group package
- Module contents
- Subpackages
- whitecanvas.protocols package
- whitecanvas.theme package
- whitecanvas.types package
- whitecanvas.utils package
Submodules
whitecanvas.core module
- whitecanvas.core.grid(nrows: int = 1, ncols: int = 1, *, link_x: bool = False, link_y: bool = False, backend: whitecanvas.backend._instance.Backend | str | None = None) whitecanvas.canvas._grid.CanvasGrid [source]
Create a canvas grid with uniform cell sizes.
- Parameters
nrows (int, optional) – Number of rows, by default 1
ncols (int, optional) – Number of columns, by default 1
link_x (bool, optional) – Whether to link x axes, by default False
link_y (bool, optional) – Whether to link y axes, by default False
backend (Backend or str, optional) – Backend name.
- Returns
Grid of empty canvases.
- Return type
- whitecanvas.core.grid_nonuniform(heights: list[int], widths: list[int], *, link_x: bool = False, link_y: bool = False, backend: whitecanvas.backend._instance.Backend | str | None = None) whitecanvas.canvas._grid.CanvasGrid [source]
- whitecanvas.core.hgrid(ncols: int = 1, *, link_x: bool = False, link_y: bool = False, backend: whitecanvas.backend._instance.Backend | str | None = None) whitecanvas.canvas._grid.CanvasHGrid [source]
- whitecanvas.core.hgrid_nonuniform(widths: list[int], *, link_x: bool = False, link_y: bool = False, backend: whitecanvas.backend._instance.Backend | str | None = None) whitecanvas.canvas._grid.CanvasHGrid [source]
- whitecanvas.core.new_canvas(backend: whitecanvas.backend._instance.Backend | str | None = None, *, size: tuple[int, int] | None = None, palette: Optional[Union[str, cmap._colormap.Colormap, Any]] = None) whitecanvas.canvas._grid.SingleCanvas [source]
Create a new canvas with a single cell.
- whitecanvas.core.vgrid(nrows: int = 1, *, link_x: bool = False, link_y: bool = False, backend: whitecanvas.backend._instance.Backend | str | None = None) whitecanvas.canvas._grid.CanvasVGrid [source]
- whitecanvas.core.vgrid_nonuniform(heights: list[int], *, link_x: bool = False, link_y: bool = False, backend: whitecanvas.backend._instance.Backend | str | None = None) whitecanvas.canvas._grid.CanvasVGrid [source]
- whitecanvas.core.wrap_canvas(obj: Any, palette=None) whitecanvas.canvas._base.Canvas [source]
Wrap a backend object into a whitecanvas Canvas.
>>> import matplotlib.pyplot as plt >>> canvas = wrap_canvas(plt.gca())
Module contents
- class whitecanvas.Canvas(backend: str | None = None, *, palette: Optional[Union[str, cmap._colormap.Colormap, Any]] = None)[source]
Bases:
whitecanvas.canvas._base.CanvasBase
- classmethod from_backend(obj: protocols.CanvasProtocol, *, palette: ColormapType | None = None, backend: str | None = None) Self [source]
Create a canvas object from a backend object.
- class whitecanvas.CanvasGrid(heights: list[int], widths: list[int], *, link_x: bool = False, link_y: bool = False, backend: whitecanvas.backend._instance.Backend | str | None = None)[source]
Bases:
object
- add_canvas(row: int, col: int, rowspan: int = 1, colspan: int = 1, palette: str | None = None) whitecanvas.canvas._base.Canvas [source]
Add a canvas to the grid at the given position
- property background_color: numpy.ndarray[Any, numpy.dtype[numpy.floating]]
Background color of the canvas.
- iter_add_canvas(**kwargs) Iterator[whitecanvas.canvas._base.Canvas] [source]
- iter_canvas() Iterator[tuple[tuple[int, int], whitecanvas.canvas._base.Canvas]] [source]
- screenshot() numpy.ndarray[Any, numpy.dtype[numpy.uint8]] [source]
Return a screenshot of the grid.
- property shape: tuple[int, int]
The (row, col) shape of the grid
- property size: tuple[float, float]
- classmethod uniform(nrows: int = 1, ncols: int = 1, *, link_x: bool = False, link_y: bool = False, backend: whitecanvas.backend._instance.Backend | str | None = None) whitecanvas.canvas._grid.CanvasGrid [source]
Create a canvas grid with uniform row and column sizes.
- Parameters
nrows (int) – The number of rows in the grid.
ncols (int) – The number of columns in the grid.
backend (backend-like, optional) – The backend to use for the grid.
- property x_linked: bool
Whether the x-axis of all canvases are linked.
- property y_linked: bool
Whether the y-axis of all canvases are linked.
- whitecanvas.grid(nrows: int = 1, ncols: int = 1, *, link_x: bool = False, link_y: bool = False, backend: whitecanvas.backend._instance.Backend | str | None = None) whitecanvas.canvas._grid.CanvasGrid [source]
Create a canvas grid with uniform cell sizes.
- Parameters
nrows (int, optional) – Number of rows, by default 1
ncols (int, optional) – Number of columns, by default 1
link_x (bool, optional) – Whether to link x axes, by default False
link_y (bool, optional) – Whether to link y axes, by default False
backend (Backend or str, optional) – Backend name.
- Returns
Grid of empty canvases.
- Return type
- whitecanvas.grid_nonuniform(heights: list[int], widths: list[int], *, link_x: bool = False, link_y: bool = False, backend: whitecanvas.backend._instance.Backend | str | None = None) whitecanvas.canvas._grid.CanvasGrid [source]
- whitecanvas.hgrid(ncols: int = 1, *, link_x: bool = False, link_y: bool = False, backend: whitecanvas.backend._instance.Backend | str | None = None) whitecanvas.canvas._grid.CanvasHGrid [source]
- whitecanvas.hgrid_nonuniform(widths: list[int], *, link_x: bool = False, link_y: bool = False, backend: whitecanvas.backend._instance.Backend | str | None = None) whitecanvas.canvas._grid.CanvasHGrid [source]
- whitecanvas.new_canvas(backend: whitecanvas.backend._instance.Backend | str | None = None, *, size: tuple[int, int] | None = None, palette: Optional[Union[str, cmap._colormap.Colormap, Any]] = None) whitecanvas.canvas._grid.SingleCanvas [source]
Create a new canvas with a single cell.
- whitecanvas.vgrid(nrows: int = 1, *, link_x: bool = False, link_y: bool = False, backend: whitecanvas.backend._instance.Backend | str | None = None) whitecanvas.canvas._grid.CanvasVGrid [source]
- whitecanvas.vgrid_nonuniform(heights: list[int], *, link_x: bool = False, link_y: bool = False, backend: whitecanvas.backend._instance.Backend | str | None = None) whitecanvas.canvas._grid.CanvasVGrid [source]
- whitecanvas.wrap_canvas(obj: Any, palette=None) whitecanvas.canvas._base.Canvas [source]
Wrap a backend object into a whitecanvas Canvas.
>>> import matplotlib.pyplot as plt >>> canvas = wrap_canvas(plt.gca())