ProvenanceTracker | @visualstorytelling/provenance-core

Provenance Graph Tracker implementation

param: The provenance graph to track (this will serve as storage construct)
param: Optional parameter to set current node for importing a provenance graph that is non-empty

Hierarchy

ProvenanceTracker

Implements

IProvenanceTracker

Index

Constructors

constructor

Properties

Accessors

Methods

applyAction

Constructors

constructor

new ProvenanceTracker(registry: IActionFunctionRegistry, graph: IProvenanceGraph, username?: string): ProvenanceTracker

- Defined in ProvenanceTracker.ts:33
Parameters
- registry: IActionFunctionRegistry
- graph: IProvenanceGraph
- Default value username: string = "Unknown"
Returns ProvenanceTracker

Properties

Private _autoScreenShot

_autoScreenShot: boolean = false

Private _screenShotProvider

_screenShotProvider: IScreenShotProvider | null = null

acceptActions

acceptActions: boolean = true

When acceptActions is false, the Tracker will ignore calls to applyAction

Private graph

graph: IProvenanceGraph

registry

registry: IActionFunctionRegistry

Private username

username: string

Accessors

autoScreenShot

autoScreenShot:

screenShotProvider

screenShotProvider:

Methods

applyAction

applyAction(action: Action, skipFirstDoFunctionCall?: boolean): Promise<StateNode>

Implementation of IProvenanceTracker.applyAction
- Defined in ProvenanceTracker.ts:54
Calls the action.do function with action.doArguments. This will also create a new StateNode in the graph corresponding to the action taken. Optionally, the label set in action.metadata.label will be taken as the label for this node.

Parameters
- action: Action
- Default value skipFirstDoFunctionCall: boolean = false
  
  If set to true, the do-function will not be called this time, it will only be called when traversing.
Returns Promise<StateNode>

Generated using TypeDoc