radtools.PlotlyBackend

class radtools.PlotlyBackend(fig=None)

Plotting engine for the lattice with Plotly.

Added in version 0.8.5.

Parameters:

figplotly graph object

Figure to plot on. If not provided, a new figure is created.

Attributes:

figplotly graph object

Figure to plot on.

Notes

Plotly is not in the dependencies of the package. To use this backend, install it with pip:

pip install plotly

or pip3

pip3 install plotly

Methods:

clear(*args, **kwargs)
legend(*args, **kwargs)
plot(*args, kind, **kwargs)	Main plotting entry point.
plot_brillouin(*args[, color])	Plot brillouin zone.
plot_brillouin_kpath(*args[, zone_color, ...])	Plot brillouin zone and kpath.
plot_conventional(*args, **kwargs)	Plot conventional unit cell.
plot_kpath(lattice[, color, label, normalize])	Plot k path in the reciprocal space.
plot_primitive(*args, **kwargs)	Plot primitive unit cell.
plot_unit_cell(lattice[, vectors, color, ...])	Plot real or reciprocal space unit cell.
plot_wigner_seitz(lattice[, vectors, label, ...])	Plot Wigner-Seitz unit cell.
remove(*args, **kwargs)
save([output_name, kwargs_update_layout, ...])	Save the figure in the html file.
show(**kwargs)	Show the figure in the interactive mode.