IProvenanceGraph | @visualstorytelling/provenance-core

Provenance graph stores the nodes, the current pointer and is bound to a specific application

Hierarchy

IProvenanceGraph

Implemented by

ProvenanceGraph

Index

Properties

Methods

Properties

application

application: Application

Application metadata

current

current: ProvenanceNode

Pointer to the currently active node

root

Methods

addNode

addNode(node: ProvenanceNode): void

- Defined in api.ts:227
Add a new node to the provenance graph

Parameters
- node: ProvenanceNode
  
  ProvenanceNode to add
Returns void

emitNodeChangedEvent

emitNodeChangedEvent(node: ProvenanceNode): void

- Defined in api.ts:235
Parameters
- node: ProvenanceNode
Returns void

getNode

getNode(id: NodeIdentifier): ProvenanceNode

- Defined in api.ts:233
Find a node by a given identifier and return the node if found

Parameters
- id: NodeIdentifier
  
  ProvenanceNode identifier
Returns ProvenanceNode

off

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

- Defined in api.ts:247
Parameters
- type: string
- handler: Handler
Returns void

on

on(type: string, handler: Handler): void

- Defined in api.ts:246
Available events:
- nodeAdded, emitted when node is added via this.addNode()
- currentChanged, emitted when this.current is changed
- nodeChanged, emitted when this.emitNodeChangedEvent() is called
Parameters
- type: string
- handler: Handler
Returns void

Generated using TypeDoc