Reprents the given state of an application as defined in initProvenance.
Reprents the given event types in your application. Event types are used to differentiate between different actions that create nodes.
Reprents the given "extra" type for storing metadata. Extra is a way to store customized metadata.
Function for creating new nodes in the graph. Creates and returns an Action object which can be further customized before applying the action, which created a new node. For further documentation on the Action object, see Action.ts
Stores the given annotation string in the artifacts of the node with the given NodeID
Adds one extra object to the node with the given NodeID. Can be called multiple times on the same node to store multiple extras.
Global observer which is called whenever the state of the application changes whatsoever.
Adds an observer to the key in the state Object which propPath leads to. For example, if your state looked like { selected: 'A', position: { A: 10 B: 5 C: 13 } }
And you wanted an observer which was called whenever a node is selected, your propPath would be ['selected'].
If you wanted an observer strictly for when the position of A changed, your propPath would be ['position', 'A']
Second parameter is associated subscriber function which is called when the observer is triggered
OUTDATED Old way to apply an action. addAction combined with the functions in Action.ts replace this.
Returns the current Provenance Node object
Function to call when finished setting up observers. Allows for url state sharing easily.
Exports the entire provenance graph in JSON form. Not compressed.
Exports the current nodes state. Returns a compressed string representing the JSON form of the current state
Gets the bookmark of the node with the given ID.
Returns the deep-diff of a node compared to its parent
Returns all extras stored on the node with the given NodeID
Goes N step backwards in the provenance graph. Calls the Global Observer if there is one. Also calls any observers for which their associated state has changed with the new node.
Goes one step backwards in the provenance graph. Equivalent to 'undo' Calls the Global Observer if there is one. Also calls any observers for which their associated state has changed with the new node.
Traverses up the graph until the most recent node which is not ephemeral is found. Sets that node to current.
Goes one step forward in the provenance graph. Equivalent to 'redo' Calls the Global Observer if there is one. Also calls any observers for which their associated state has changed with the new node.
Traverses down the graph until the most recent node which is not ephemeral is found. Sets that node to current.
Jumps to the node in the provenance graph with the given id. Calls the Global Observer if there is one. Also calls any observers for which their associated state has changed with the new node.
Returns the ProvenanceGraph object
Given a series of linear states, constructs a new provenance graph. Designed mostly for recreating old provenance graphs. Using exportProvenanceGraph and importProvenanceGraph is preferred
Imports an entire, non compressed provenance graph in JSON form. Replaces the current provenance graph with the new one.
Imports the given state. Decompresses the given string and creates a new node with that state.
Returns to the root node.
Returns the Root Node object
Sets the bookmark of the node with the given ID. the bookmark is set to true or false, equivalent on the second parameter.
Generated using TypeDoc