pm4py.visualization.bpmn package

PM4Py – A Process Mining Library for Python

Copyright (C) 2024 Process Intelligence Solutions UG (haftungsbeschränkt)

This program is free software: you can redistribute it and/or modify it under the terms of the GNU Affero General Public License as published by the Free Software Foundation, either version 3 of the License, or any later version.

This program 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 Affero General Public License for more details.

You should have received a copy of the GNU Affero General Public License along with this program. If not, see this software project’s root or visit <https://www.gnu.org/licenses/>.

Website: https://processintelligence.solutions Contact: info@processintelligence.solutions

Subpackages

• pm4py.visualization.bpmn.util package
• pm4py.visualization.bpmn.variants package
  • Submodules
  • pm4py.visualization.bpmn.variants.classic module
    • Parameters
      • Parameters.FORMAT
      • Parameters.RANKDIR
      • Parameters.FONT_SIZE
      • Parameters.BGCOLOR
      • Parameters.ENABLE_SWIMLANES
      • Parameters.INCLUDE_NAME_IN_EVENTS
      • Parameters.SWIMLANES_MARGIN
      • Parameters.ENDPOINTS_SHAPE
    • add_bpmn_node()
    • apply()
    • save()
    • view()
    • matplotlib_view()
  • pm4py.visualization.bpmn.variants.dagrejs module
    • Parameters
      • Parameters.ENCODING
      • Parameters.IFRAME_WIDTH
      • Parameters.IFRAME_HEIGHT
      • Parameters.LOCAL_JUPYTER_FILE_NAME
    • get_html_file_contents()
    • apply()
    • view()
    • save()

Submodules

pm4py.visualization.bpmn.visualizer module

PM4Py – A Process Mining Library for Python

Copyright (C) 2024 Process Intelligence Solutions UG (haftungsbeschränkt)

This program is free software: you can redistribute it and/or modify it under the terms of the GNU Affero General Public License as published by the Free Software Foundation, either version 3 of the License, or any later version.

This program 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 Affero General Public License for more details.

You should have received a copy of the GNU Affero General Public License along with this program. If not, see this software project’s root or visit <https://www.gnu.org/licenses/>.

Website: https://processintelligence.solutions Contact: info@processintelligence.solutions

class pm4py.visualization.bpmn.visualizer.Variants(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)

Bases: Enum

CLASSIC = <module 'pm4py.visualization.bpmn.variants.classic' from 'C:\\Users\\berti\\pm4py-core\\pm4py\\visualization\\bpmn\\variants\\classic.py'>

DAGREJS = <module 'pm4py.visualization.bpmn.variants.dagrejs' from 'C:\\Users\\berti\\pm4py-core\\pm4py\\visualization\\bpmn\\variants\\dagrejs.py'>

pm4py.visualization.bpmn.visualizer.apply(bpmn_graph: BPMN, variant=Variants.CLASSIC, parameters: Dict[Any, Any] | None = None) → Digraph

Visualize a BPMN graph

Parameters

bpmn_graph

BPMN graph

variant

Variant of the visualization, possible values:

• Variants.CLASSIC

parameters

Version-specific parameters

Returns

gviz

Graphviz representation

pm4py.visualization.bpmn.visualizer.save(gviz: Digraph, output_file_path: str, variant=Variants.CLASSIC, parameters=None)

Save the diagram

Parameters

gviz

GraphViz diagram

output_file_path

Path where the GraphViz output should be saved

pm4py.visualization.bpmn.visualizer.view(gviz: Digraph, variant=Variants.CLASSIC, parameters=None)

View the diagram

Parameters

gviz

GraphViz diagram

pm4py.visualization.bpmn.visualizer.matplotlib_view(gviz: Digraph, variant=Variants.CLASSIC, parameters=None)

Views the diagram using Matplotlib

Parameters

gviz

Graphviz