pm4py.visualization.bpmn.variants 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
Submodules#
pm4py.visualization.bpmn.variants.classic 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.variants.classic.Parameters(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)[source]#
Bases:
Enum- FORMAT = 'format'#
- RANKDIR = 'rankdir'#
- FONT_SIZE = 'font_size'#
- BGCOLOR = 'bgcolor'#
- ENABLE_SWIMLANES = 'enable_swimlanes'#
- INCLUDE_NAME_IN_EVENTS = 'include_name_in_events'#
- SWIMLANES_MARGIN = 'swimlanes_margin'#
- ENDPOINTS_SHAPE = 'endpoints_shape'#
- pm4py.visualization.bpmn.variants.classic.add_bpmn_node(graph, n, font_size, include_name_in_events, endpoints_shape)[source]#
- pm4py.visualization.bpmn.variants.classic.apply(bpmn_graph: BPMN, parameters: Dict[Any, Any] | None = None) Digraph[source]#
Visualize a BPMN graph
Parameters#
- bpmn_graph
BPMN graph
- parameters
- Parameters of the visualization, including:
Parameters.FORMAT: the format of the visualization
Parameters.RANKDIR: the direction of the representation (default: LR)
Returns#
- gviz
Graphviz representation
- pm4py.visualization.bpmn.variants.classic.save(gviz: Digraph, output_file_path: str, parameters=None)[source]#
Save the diagram
Parameters#
- gviz
GraphViz diagram
- output_file_path
Path where the GraphViz output should be saved
pm4py.visualization.bpmn.variants.dagrejs 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.variants.dagrejs.Parameters(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)[source]#
Bases:
Enum- ENCODING = 'encoding'#
- IFRAME_WIDTH = 'iframe_width'#
- IFRAME_HEIGHT = 'iframe_height'#
- LOCAL_JUPYTER_FILE_NAME = 'local_jupyter_file_name'#
- pm4py.visualization.bpmn.variants.dagrejs.apply(bpmn_graph: BPMN, parameters: Dict[Any, Any] | None = None) str[source]#
Visualizes a BPMN graph by rendering it inside a HTML/Javascript file
Parameters#
- bpmn_graph
BPMN graph
- parameters
Parameters of the algorithm, including: - Parameters.ENCODING => the encoding of the HTML to be used
Returns#
- tmp_file_path
Path to the HTML file
- pm4py.visualization.bpmn.variants.dagrejs.view(temp_file_name, parameters=None)[source]#
View the SNA visualization on the screen
Parameters#
- temp_file_name
Temporary file name
- parameters
Possible parameters of the algorithm
- pm4py.visualization.bpmn.variants.dagrejs.save(temp_file_name, dest_file, parameters=None)[source]#
Save the SNA visualization from a temporary file to a well-defined destination file
Parameters#
- temp_file_name
Temporary file name
- dest_file
Destination file
- parameters
Possible parameters of the algorithm