ProcessMiningModel

The ProcessMiningModel provides common functionality to interact with the ProcessMining component.

Props

NameDescriptionType
applyLayout
Refreshes the layout of the process mining diagram. It optionally accepts layout options and a flag indicating whether to morph the layout. Note that, to optimize performance and depending on the implementation, it might be necessary to memoize the layout options.
(
  layoutOptions: LayoutOptions,
  morphLayout: boolean
) => Promise<void>
exportToPng
Exports the process mining diagram to a PNG Image. It throws an exception if the diagram cannot be exported. The exception may occur when the diagram contains images from cross-origin sources. In this case, disable ExportSettings.inlineImages and encode the icons manually to base64.
(
  exportSettings: ExportSettings
) => Promise<void>
exportToSvg
Exports the process mining diagram to an SVG file. It throws an exception if the diagram cannot be exported. The exception may occur when the diagram contains images from cross-origin sources. In this case, disable ExportSettings.inlineImages and encode the icons manually to base64.
(
  exportSettings: ExportSettings
) => Promise<void>
fitContent
Fits the diagram inside the viewport.
(insets: number) => void
getSearchHits
Retrieves the items that match the search currently.
() => ProcessStep[]
graphComponent
The yFiles GraphComponent used by the ProcessMining component to display the graph. This property is intended for advanced users who have a familiarity with the yFiles for HTML library.
GraphComponent
print
Exports and prints the process mining diagram.
(
  printSettings: PrintSettings
) => Promise<void>
refresh
Triggers a re-rendering of the diagram. This may become useful if properties in the data change and the visualization should update accordingly.
() => void
startAnimation
Starts the animation. It takes a callback function to report the progress back, where the progress is the current timestamp in the animation. The start time, end time, and duration parameters define the timing properties of the animation.
(
  progressCallback: (
    progress: number
  ) => void,
  startTimestamp: number,
  endTimestamp: number,
  duration: number
) => Promise<void>
stopAnimation
Stops the animation.
() => void
zoomIn
Increases the zoom level.
() => void
zoomOut
Decreases the zoom level.
() => void
zoomTo
Pans the viewport to the center of the given items.
(
  items: (
    | ProcessStep
    | Transition
  )[]
) => void
zoomToItem
Pans the viewport to center the given item.
(
  item:
    | ProcessStep
    | Transition
) => void
zoomToOriginal
Resets the zoom level to 1.
() => void