Options
All
  • Public
  • Public/Protected
  • All
Menu

The traverser changes the current node in the provenance graph and executes the undo/redo function while moving through the graph structure.

Hierarchy

  • IProvenanceGraphTraverser

Implemented by

Index

Properties

graph

trackingWhenTraversing

trackingWhenTraversing: boolean

trackingWhenTraversing === false disables tracking when traversing to prevent feedback. When applying an action, the object we're tracking might trigger its event listeners. This means that more Nodes are added to the ProvenanceGraph when traversing, which is most likely unwanted behaviour.

It will enable/disable immediately before/after calling the action. So if the event is emitted asynchronously after the action, it will not work.

Methods

off

  • off(type: string, handler: Handler): void

on

  • on(type: string, handler: Handler): void
  • Available events:

    • invalidTraversal, emitted when node is invalid to traverse to, because of a irreversible node or disconnected graph.

    Parameters

    Returns void

toStateNode

  • Finds shortest path between current node and node with request identifer. Calls the do/undo functions of actions on the path.

    Parameters

    Returns Promise<ProvenanceNode | undefined>

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