Skip to content

core

Generic matplotlib plot class.

MatplotlibPlot

Bases: pathpyG.visualisations.plot.PathPyPlot

Base class for plotting matplotlib objects.

Source code in src/pathpyG/visualisations/_matplotlib/core.py 
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
class MatplotlibPlot(PathPyPlot):
    """Base class for plotting matplotlib objects."""

    def generate(self) -> None:
        """Generate the plot."""
        raise NotImplementedError

    def save(self, filename: str, **kwargs: Any) -> None:  # type: ignore
        """Save the plot to the hard drive."""
        self.to_fig().savefig(filename)

    def show(self, **kwargs: Any) -> None:  # type: ignore
        """Show the plot on the device."""
        self.to_fig().show()

    def to_fig(self) -> Any:  # type: ignore
        """Convert to matplotlib figure."""
        raise NotImplementedError

generate

Generate the plot.

Source code in src/pathpyG/visualisations/_matplotlib/core.py 
24
25
26
def generate(self) -> None:
    """Generate the plot."""
    raise NotImplementedError

save

Save the plot to the hard drive.

Source code in src/pathpyG/visualisations/_matplotlib/core.py 
28
29
30
def save(self, filename: str, **kwargs: Any) -> None:  # type: ignore
    """Save the plot to the hard drive."""
    self.to_fig().savefig(filename)

show

Show the plot on the device.

Source code in src/pathpyG/visualisations/_matplotlib/core.py 
32
33
34
def show(self, **kwargs: Any) -> None:  # type: ignore
    """Show the plot on the device."""
    self.to_fig().show()

to_fig

Convert to matplotlib figure.

Source code in src/pathpyG/visualisations/_matplotlib/core.py 
36
37
38
def to_fig(self) -> Any:  # type: ignore
    """Convert to matplotlib figure."""
    raise NotImplementedError