GraphAdapter.md

GraphAdapter

The GraphAdapter creates a two-way data binding between a JointJS Graph (joint.dia.Graph) and a Convergence RealTimeObject or RealTimeModel. Once the GraphAdapter has been configured, any changes to the Graph (either by the user or via the API) will be synchronized into the Convergence RealTimeModel and distributed to any other connected clients. Any incoming changes to the Convergence RealTimeModel will be automatically reflected in the JointJS Graph.

Namespace

ConvergenceJointUtils.GraphAdapter

#Example

const realTimeObject = realTimeModel.root();
const graph = new joint.dia.Graph();

const adapter = new ConvergenceJointUtils.GraphAdapter(graph, realTimeObject);
adapter.bind();

// Use the graph adapter and the real time model.

adapter.unbind();  // When done.

#API

Method	Description
static create(realTimeObject)	Creates a new GraphAdapter with the specified real time object and a new graph.
constructor(graph, realTimeObject)	Creates a new GraphAdapter with the specified graph and object.
getGraph()	Gets the JointJS Graph used by the adapter.
getGraphObject()	Gets the RealTimeObject used by the adapter.
isBound()	Determines if the adapter is bound.
bind()	Binds the adapter if it is unbound.
unbind()	Unbinds the adapter if it is bound

Static Methods

##create(realTimeObject)

This static method will create a new GraphAdapter using the supplied RealTimeObject. A RealTimeModel can also be passed in, in which case the root object of the model will be used. The GraphAdapter will be constructed with a new JointJS graph. The graph can then be accessed using the getGraph() method.

Note: The GraphAdapter is not bound at this point. You must still call the bind() method to activate the two way binding.

const adapter = ConvergenceJointUtils.GraphAdapter.create(someObject);
adapater.bind();

Constructor

GraphAdapter(graph, realTimeObject) Constructs a new GraphAdapter using the supplied JointJS Graph and Convergence RealTimeObject. A RealTimeModel can also be passed in, in which case the root object of the model will be used.

Note: The GraphAdapter is not bound at this point. You must still call the bind() method to activate the two way binding.

const adapter = new ConvergenceJointUtils.GraphAdapter(graph, someObject);
adapater.bind();

Prototype Methods

getGraph()

Gets the JointJS Graph that this adapter is using.

const adapter = ConvergenceJointUtils.GraphAdapter.create(someObject);
const graph = adapter.getGraph();

getGraphObject()

Gets the Convergence RealTimeModel that this adapter is using.

const adapter = ConvergenceJointUtils.GraphAdapter.create(someObject);
const realTimeObject = adapter.getGraphObject();

isBound()

Determines if the GraphAdapter is currently bound. If the adapter is bound, then two-way data binding is active and changes to the model or graph will be reflected in the other. Returns true if two-way data binding is active, or false if it is not.

const adapter = ConvergenceJointUtils.GraphAdapter.create(someObject);
console.log(adapter.isBound()) // prints: false

adapter.bind();
console.log(adapter.isBound()) // prints: true

bind()

Binds the JointJS Graph to the Convergence RealTimeModel. The current value of the RealTimeModel will be imported into the Graph.

Note: Any data currently in the Graph will be replaced by the data in the RealTimeModel. This method should only be called when the GraphAdapter is not already bound. If it is already bound, the method call will be ignored.

const adapter = ConvergenceJointUtils.GraphAdapter.create(someObject);
adapter.bind();

unbind()

Unbinds the JointJS Graph from the Convergence RealTimeModel. The current value of the RealTimeModel and Graph will remain unchanged, but they will no longer be connected.

Note: This method should only be called when the GraphAdapter is bound. If it is not bound, the method call will be ignored.

const adapter = ConvergenceJointUtils.GraphAdapter.create(someObject);
adapter.bind();
adapter.unbind();