@visualstorytelling/provenance-core
Options
All
  • Public
  • Public/Protected
  • All
Menu

The provenance tracker takes a action function registry. New actions are executed and if successful stored as new StateNode in the graph.

Hierarchy

  • IProvenanceTracker

Implemented by

Index

Properties

Methods

Properties

acceptActions

acceptActions: boolean

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

autoScreenShot

autoScreenShot: boolean

If true, adds a screenshot to all provenance nodes metadata (if screenShotProvider is set)

registry

registry: IActionFunctionRegistry

Action function registry

screenShotProvider

screenShotProvider: IScreenShotProvider | null

Methods

applyAction

  • applyAction(action: Action, skipFirstDoFunctionCall: boolean): Promise<StateNode>
    1. Calls the action.do function with action.doArguments
    2. Append action to graph via a StateEdge and StateNode
    3. Makes the created StateNode the current state node

    Parameters

    • action: Action
    • skipFirstDoFunctionCall: boolean

      If set to true, the do-function will not be called this time, it will only be called when traversing.

    Returns Promise<StateNode>

Legend

  • Module
  • Object literal
  • Variable
  • Function
  • Function with type parameter
  • Index signature
  • Type alias
  • Enumeration
  • Enumeration member
  • Property
  • Method
  • Interface
  • Interface with type parameter
  • Constructor
  • Property
  • Method
  • Index signature
  • Class
  • Class with type parameter
  • Constructor
  • Property
  • Method
  • Accessor
  • Index signature
  • Inherited constructor
  • Inherited property
  • Inherited method
  • Inherited accessor
  • Protected property
  • Protected method
  • Protected accessor
  • Private property
  • Private method
  • Private accessor
  • Static property
  • Static method

Generated using TypeDoc