plopp.backends.plotly.canvas.Canvas

class plopp.backends.plotly.canvas.Canvas(figsize=None, title=None, user_vmin=None, user_vmax=None, xmin=None, xmax=None, ymin=None, ymax=None, logx=None, logy=None, xlabel=None, ylabel=None, norm=None, **ignored)

Plotly-based canvas used to render 2D graphics. It provides a figure and some axes, as well as functions for controlling the zoom, panning, and the scale of the axes.

Parameters:

• figsize (tuple[float, float] | None, default: None) – The width and height of the figure, in inches.

• title (str | None, default: None) – The title to be placed above the figure.

• user_vmin (Variable | float | None, default: None) – The minimum value for the vertical axis. If a number (without a unit) is supplied, it is assumed that the unit is the same as the current vertical axis unit.

• user_vmax (Variable | float | None, default: None) – The maximum value for the vertical axis. If a number (without a unit) is supplied, it is assumed that the unit is the same as the current vertical axis unit.

__init__(figsize=None, title=None, user_vmin=None, user_vmax=None, xmin=None, xmax=None, ymin=None, ymax=None, logx=None, logy=None, xlabel=None, ylabel=None, norm=None, **ignored)

Methods

__init__([figsize, title, user_vmin, ...])
download_figure()	Save the figure to a PNG file via a pop-up dialog.
draw()
has_user_xlabel()	Return True if the user has set an x-axis label.
has_user_ylabel()	Return True if the user has set a y-axis label.
pan()	Activate the underlying Plotly pan tool.
panzoom(value)	Activate or deactivate the pan or zoom tool, depending on the input value.
reset_mode()	Reset the modebar mode to nothing, to disable all zoom/pan tools.
save(filename)	Save the figure to file.
set_axes(dims, units, dtypes)	Set the axes dimensions and units.
to_widget()
toggle_logx()	Toggle the scale between linear and log along the horizontal axis.
toggle_logy()	Toggle the scale between linear and log along the vertical axis.
update_legend()
zoom()	Activate the underlying Plotly zoom tool.

Attributes

empty	Check if the canvas is empty.
logx	Get or set whether the x-axis is in logarithmic scale.
logy	Get or set whether the y-axis is in logarithmic scale.
title	Get or set the title of the plot.
xlabel	Get or set the label of the x-axis.
xmax	Get or set the upper (right) bound of the x-axis.
xmin	Get or set the lower (left) bound of the x-axis.
xrange	Get or set the range/limits of the x-axis.
xscale	Get or set the scale of the x-axis ('linear' or 'log').
ylabel	Get or set the label of the y-axis.
ymax	Get or set the upper (top) bound of the y-axis.
ymin	Get or set the lower (bottom) bound of the y-axis.
yrange	Get or set the range/limits of the y-axis.
yscale	Get or set the scale of the y-axis ('linear' or 'log').