pm4py.visualization.bpmn package

Subpackages

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

Submodules

pm4py.visualization.bpmn.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.bpmn.visualizer.Variants

Bases: enum.Enum

An enumeration.

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

pm4py.visualization.bpmn.visualizer.apply(bpmn_graph: pm4py.objects.bpmn.obj.BPMN, variant=<Variants.CLASSIC: <module 'pm4py.visualization.bpmn.variants.classic' from '/home/docs/checkouts/readthedocs.org/user_builds/pm4py-source/checkouts/latest/pm4py/visualization/bpmn/variants/classic.py'>>, parameters: Optional[Dict[Any, Any]] = None) → graphviz.graphs.Digraph

Visualize a BPMN graph

Parameters:

• bpmn_graph – BPMN graph

• variant –

  Variant of the visualization, possible values:

  • Variants.CLASSIC

• parameters – Version-specific parameters

Returns:

Graphviz representation

Return type:

gviz

pm4py.visualization.bpmn.visualizer.matplotlib_view(gviz: graphviz.graphs.Digraph)

Views the diagram using Matplotlib

Parameters:gviz – Graphviz

pm4py.visualization.bpmn.visualizer.save(gviz: graphviz.graphs.Digraph, output_file_path: str)

Save the diagram

Parameters:

• gviz – GraphViz diagram
• output_file_path – Path where the GraphViz output should be saved

pm4py.visualization.bpmn.visualizer.view(gviz: graphviz.graphs.Digraph)

View the diagram

Parameters:gviz – GraphViz diagram

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/>.