pm4py.visualization.dotted_chart package

Subpackages

• pm4py.visualization.dotted_chart.variants package
  • Submodules
  • pm4py.visualization.dotted_chart.variants.classic module
  • Module contents

Submodules

pm4py.visualization.dotted_chart.visualizer module

This file is part of PM4Py (More Info: https://pm4py.fit.fraunhofer.de).

PM4Py is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.

PM4Py is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with PM4Py. If not, see <https://www.gnu.org/licenses/>.

class pm4py.visualization.dotted_chart.visualizer.Variants

Bases: enum.Enum

An enumeration.

CLASSIC = <module 'pm4py.visualization.dotted_chart.variants.classic' from '/home/docs/checkouts/readthedocs.org/user_builds/pm4py-source/checkouts/stable/pm4py/visualization/dotted_chart/variants/classic.py'>

pm4py.visualization.dotted_chart.visualizer.apply(log_obj: Union[pandas.core.frame.DataFrame, pm4py.objects.log.obj.EventLog], attributes: List[str], variant=<Variants.CLASSIC: <module 'pm4py.visualization.dotted_chart.variants.classic' from '/home/docs/checkouts/readthedocs.org/user_builds/pm4py-source/checkouts/stable/pm4py/visualization/dotted_chart/variants/classic.py'>>, parameters: Optional[Dict[Any, Any]] = None) → str

Creates the dotted chart with the log objects and the provided attributes

Parameters:

• log_obj – Log object
• attributes – List of attributes that should be included in the dotted chart
• parameters – Variant-specific parameters

Returns:

Path to the dotted chart visualization

Return type:

file_path

pm4py.visualization.dotted_chart.visualizer.matplotlib_view(figure: str)

Views the dotted chart on the screen using Matplotlib

Parameters:figure – Path to the dotted chart

pm4py.visualization.dotted_chart.visualizer.save(figure: str, output_file_path: str)

Saves the dotted chart to a specified path

Parameters:

• figure – Current path to the dotted chart
• output_file_path – Destination path

pm4py.visualization.dotted_chart.visualizer.serialize(figure: str)

Performs the serialization of the dotted chart visualization

Parameters:figure – Current path to the dotted chart

pm4py.visualization.dotted_chart.visualizer.view(figure: str)

Views the dotted chart on the screen

Parameters:figure – Path to the dotted chart

Module contents

This file is part of PM4Py (More Info: https://pm4py.fit.fraunhofer.de).

PM4Py is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.

PM4Py is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with PM4Py. If not, see <https://www.gnu.org/licenses/>.