grogupy.viz.plot_magnetic_entities

grogupy.viz.plot_magnetic_entities(magnetic_entities: Builder | list[MagneticEntity] | MagneticEntityList, tags: None | list[str] = None, colors: None | list[str] = None, marker_size: float = 5, marker_opacity: float = 1, show_cell: bool = True, width: int = 800, height: int = 500, title: None | str = None, legend: bool = True) → Figure

Creates a plot from a list of magnetic entities.

Parameters

magnetic_entitiesUnion[Builder, list[MagneticEntity], MagneticEntityList]

The magnetic entities that contain the tags and coordinates

tagsUnion[None, list[str]], optional

The tags of the markers, if None, then it is autogenerated, by default None

colors: Union[None, list[str]], optional

The colors of the markers, if None, then it is autogenerated, by default None

marker_sizefloat, optional

Size of the markers, by default 10

marker_opacityfloat, optional

Opacity of the markers, by default 1

show_cellbool, optional

Whether to show the cell or not, by default True

widthint, optional

Width of the figure, by default 800

heightint, optional

Height of the figure, by default 500

titleUnion[None, str], optional

Title of the figure, if set to None, then title is not generated, by default None

legendbool, optional

Whether to show the legend, by default True

Returns

plotly.graph_objs.go.Figure

The created figure