Namespace Joint.dia
Holds functionality related to all diagrams and their elements.
Defined in: joint.dia.js.
| Constructor Attributes | Constructor Name and Description |
|---|---|
| Method Attributes | Method Name and Description |
|---|---|
| <static> |
Joint.dia.clone()
Clones diagram in the current paper.
|
| <static> |
Joint.dia.Joint(args)
Create new joint and register it.
|
| <static> |
Joint.dia.parse(JSON)
Construct a diagram from the JSON representation.
|
| <static> |
Joint.dia.register(obj)
Register object to the current paper.
|
| <static> |
Joint.dia.registeredElements()
Returns registered elements of the current paper.
|
| <static> |
Joint.dia.registeredJoints()
Returns registered joints of the current paper.
|
| <static> |
Joint.dia.registerJoint(j)
Register joint to the current paper.
|
| <static> |
Joint.dia.stringify(paper)
Stringify the whole diagram (occupying a paper).
|
| <static> |
Joint.dia.unregister(obj)
Cancel registration of an element in the current paper.
|
| <static> |
Joint.dia.unregisterJoint(j)
Cancel registration of a joint in the current paper.
|
Method Detail
<static>
{Array}
Joint.dia.clone()
Clones diagram in the current paper.
Defined in: joint.dia.serializer.js.
Defined in: joint.dia.serializer.js.
- Returns:
- {Array} Array of the constructed elements.
<static>
{Joint}
Joint.dia.Joint(args)
Create new joint and register it. All joints appearing in a diagram should
be created using this function. Otherwise they won't be registered and
therefore not serialized when needed.
- Parameters:
- {Object} args
- Joint parameters.
- Returns:
- {Joint}
- See:
- Joint
<static>
{Array}
Joint.dia.parse(JSON)
Construct a diagram from the JSON representation.
Defined in: joint.dia.serializer.js.
Defined in: joint.dia.serializer.js.
- Parameters:
- {String} JSON
- Returns:
- {Array} Array of the constructed elements.
<static>
{Element|Joint}
Joint.dia.register(obj)
Register object to the current paper.
You don't have to use this method unless you really know what you're doing.
- Parameters:
- {Element|Joint} obj
- Object to be registered.
- Returns:
- {Element|Joint} Registered object.
<static>
{array}
Joint.dia.registeredElements()
Returns registered elements of the current paper.
- Returns:
- {array} Array of registered elements.
<static>
{array}
Joint.dia.registeredJoints()
Returns registered joints of the current paper.
- Returns:
- {array} Array of registered joints.
<static>
Joint.dia.registerJoint(j)
Register joint to the current paper. Avoid registering the the same joint twice.
You don't have to use this method unless you really know what you're doing.
- Parameters:
- {Joint} j
- Joint object to be registered.
<static>
{String}
Joint.dia.stringify(paper)
Stringify the whole diagram (occupying a paper).
Defined in: joint.dia.serializer.js.
Defined in: joint.dia.serializer.js.
- Parameters:
- {RaphaelPaper} paper
- Raphael paper the diagram belongs to.
- Returns:
- {String} JSON representation of the diagram.
<static>
Joint.dia.unregister(obj)
Cancel registration of an element in the current paper.
- Parameters:
- {Element} obj
- Object to be unregistered.
<static>
Joint.dia.unregisterJoint(j)
Cancel registration of a joint in the current paper.
- Parameters:
- {Joint} j
- Joint to be unregistered.