pm4py.visualization.ocel.object_graph.variants 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.ocel.object_graph.variants.graphviz 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.ocel.object_graph.variants.graphviz.Parameters(value)[source]#

Bases: Enum

An enumeration.

FORMAT = 'format'#
BGCOLOR = 'bgcolor'#
RANKDIR = 'rankdir'#
DIRECTED = 'directed'#
pm4py.visualization.ocel.object_graph.variants.graphviz.ot_to_color(ot: str) str[source]#
pm4py.visualization.ocel.object_graph.variants.graphviz.apply(ocel: OCEL, graph: Set[Tuple[str, str]], parameters: Optional[Dict[Any, Any]] = None) Digraph[source]#

Visualizes an object graph

Parameters#

ocel

Object-centric event log

graph

Object graph

parameters
Variant-specific parameters:
  • Parameters.FORMAT => the format of the visualization (“png”, “svg”, …)

  • Parameters.BGCOLOR => the background color

  • Parameters.RANKDIR => the rank direction (LR = left-right, TB = top-bottom)

  • Parameters.DIRECTED => boolean value (draws a directed or undirected graph)

Returns#

gviz

Graphviz object