pm4py.visualization.common package#

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

Submodules#

pm4py.visualization.common.dot_util 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/>.

pm4py.visualization.common.dot_util.check_dot_installed()[source]#

Check if Graphviz’s dot is installed correctly in the system

Returns#

boolean

Boolean telling if Graphviz’s dot is installed correctly

pm4py.visualization.common.gview 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/>.

pm4py.visualization.common.gview.view(gviz, parameters=None)[source]#

View the diagram

Parameters#

gviz

GraphViz diagram

pm4py.visualization.common.gview.matplotlib_view(gviz, parameters=None)[source]#

Views the diagram using Matplotlib

Parameters#

gviz

Graphviz

pm4py.visualization.common.gview.serialize_dot(gviz: Digraph, parameters=None) bytes[source]#

Serialize the DOT instructions of a Graphviz object

Parameters#

gviz

Graphviz object

Returns#

bytes_string

String containing the DOT instructions

pm4py.visualization.common.gview.serialize(gviz: Digraph, parameters=None) bytes[source]#

Serialize the image rendered from a Graphviz object

Parameters#

gviz

Graphviz object

Returns#

bytes_string

String containing the picture

pm4py.visualization.common.html 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.common.html.Parameters(value)[source]#

Bases: Enum

An enumeration.

IFRAME_WIDTH = 'iframe_width'#
IFRAME_HEIGHT = 'iframe_height'#
LOCAL_JUPYTER_FILE_NAME = 'local_jupyter_file_name'#
pm4py.visualization.common.html.form_html(gviz, name=None)[source]#

Forms the HTML page using GraphvizJS

Parameters#

gviz

GraphViz diagram

name

(optional) path where the GraphViz output should be saved

Returns#

name

Path where the GraphvizJS output is saved

pm4py.visualization.common.html.save(gviz, output_file_path, parameters=None)[source]#

Saves the diagram in HTML format

Parameters#

gviz

GraphViz diagram

output_file_path

Path where the GraphViz output should be saved

pm4py.visualization.common.html.view(gviz, parameters=None)[source]#

View the diagram in HTML format

Parameters#

gviz

GraphViz diagram

pm4py.visualization.common.save 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/>.

pm4py.visualization.common.save.save(gviz, output_file_path, parameters=None)[source]#

Save the diagram

Parameters#

gviz

GraphViz diagram

output_file_path

Path where the GraphViz output should be saved

pm4py.visualization.common.svg_pos_parser 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/>.

pm4py.visualization.common.svg_pos_parser.apply(file_name: str) Tuple[Dict[str, Any], Dict[str, Any]][source]#

pm4py.visualization.common.utils 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/>.

pm4py.visualization.common.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/>.

pm4py.visualization.common.visualizer.save(gviz, output_file_path)[source]#

Save the diagram

Parameters#

gviz

GraphViz diagram

output_file_path

Path where the GraphViz output should be saved

pm4py.visualization.common.visualizer.view(gviz)[source]#

View the diagram

Parameters#

gviz

GraphViz diagram