Namespace Joint.dia.uml

Holds functionality related to UML diagrams.
Defined in: joint.dia.uml.js.

Namespace Summary
Constructor Attributes	Constructor Name and Description
	Joint.dia.uml

Field Summary
Field Attributes	Field Name and Description
<static>	Joint.dia.uml.aggregationArrow Predefined aggregation arrow for Class diagram.
<static>	Joint.dia.uml.arrow Predefined arrow for StateChart.
<static>	Joint.dia.uml.dependencyArrow Predefined dependency arrow for Class diagram.
<static>	Joint.dia.uml.generalizationArrow Predefined generalization arrow for Class diagram.

Method Summary
Method Attributes	Method Name and Description
<static>	Joint.dia.uml.Class.create(properties) UML StateChart class.
<static>	Joint.dia.uml.EndState.create(properties) UML StateChart end state.
<static>	Joint.dia.uml.StartState.create(properties) UML StateChart start state.
<static>	Joint.dia.uml.State.create(properties) UML StateChart state.

Namespace Detail

Joint.dia.uml

Field Detail

<static> Joint.dia.uml.aggregationArrow

Predefined aggregation arrow for Class diagram.

c1.joint(c2, Joint.dia.uml.aggregationArrow);

<static> Joint.dia.uml.arrow

Predefined arrow for StateChart.

s1.joint(s2, Joint.dia.uml.arrow);

<static> Joint.dia.uml.dependencyArrow

Predefined dependency arrow for Class diagram.

c1.joint(c2, Joint.dia.uml.dependencyArrow);

<static> Joint.dia.uml.generalizationArrow

Predefined generalization arrow for Class diagram.

c1.joint(c2, Joint.dia.uml.generalizationArrow);

Method Detail

<static> Joint.dia.uml.Class.create(properties)

UML StateChart class.

var c1 = Joint.dia.uml.Class.create({
  rect: {x: 120, y: 70, width: 120, height: 80},
  label: "MyClass",
  attrs: {
    fill: "90-#000-yellow:1-#fff"
  },
  attributes: ["-position"],
  methods: ["+createIterator()"]
});

Parameters:
{Object} properties
{Object} properties.rect: Bounding box of the Class (e.g. {x: 50, y: 100, width: 100, height: 80}).
{String} properties.label Optional: The name of the class.
{Number} properties.labelOffsetX Optional: Offset in x-axis of the label from the class rectangle origin.
{Number} properties.labelOffsetY Optional: Offset in y-axis of the label from the class rectangle origin.
{Number} properties.swimlane1OffsetY Optional: Offset in y-axis of the swimlane shown after the class label.
{Number} properties.swimlane2OffsetY Optional: Offset in y-axis of the swimlane shown after the class attributes.
{Object} properties.attrs Optional: SVG attributes of the appearance of the state.
{array} properties.attributes Optional: Attributes of the class.
{array} properties.methods Optional: Methods of the class.
{Number} properties.attributesOffsetX Optional: Offset in x-axis of the attributes.
{Number} properties.attributesOffsetY Optional: Offset in y-axis of the attributes.
{Number} properties.methodsOffsetX Optional: Offset in x-axis of the methods.
{Number} properties.methodsOffsetY Optional: Offset in y-axis of the methods.

<static> Joint.dia.uml.EndState.create(properties)

UML StateChart end state.

var s0 = Joint.dia.uml.EndState.create({
  position: {x: 120, y: 70},
  radius: 15,
  innerRadius: 8,
  attrs: {
    stroke: "blue",
    fill: "yellow"
  },
  innerAttrs: {
    fill: "red"
  }
});

Parameters:
{Object} properties
{Object} properties.position: Position of the end state (e.g. {x: 50, y: 100}).
{Number} properties.radius Optional: Radius of the circle of the end state.
{Number} properties.innerRadius Optional: Radius of the inner circle of the end state.
{Object} properties.attrs Optional: SVG attributes of the appearance of the end state.
{Object} properties.innerAttrs Optional: SVG attributes of the appearance of the inner circle of the end state.

<static> Joint.dia.uml.StartState.create(properties)

UML StateChart start state.

var s0 = Joint.dia.uml.StartState.create({
  position: {x: 120, y: 70},
  radius: 15,
  attrs: {
    stroke: "blue",
    fill: "yellow"
  }
});

Parameters:
{Object} properties
{Object} properties.position: Position of the start state (e.g. {x: 50, y: 100}).
{Number} properties.radius Optional: Radius of the circle of the start state.
{Object} properties.attrs Optional: SVG attributes of the appearance of the start state.

<static> Joint.dia.uml.State.create(properties)

UML StateChart state.

var s1 = Joint.dia.uml.State.create({
  rect: {x: 120, y: 70, width: 100, height: 60},
  label: "state 1",
  attrs: {
    fill: "90-#000-green:1-#fff"
  },
  actions: {
    entry: "init()",
    exit: "destroy()",
    inner: ["Evt1", "foo()", "Evt2", "bar()"]
  }
});

Parameters:
{Object} properties
{Object} properties.rect: Bounding box of the State (e.g. {x: 50, y: 100, width: 100, height: 80}).
{Number} properties.radius Optional: Radius of the corners of the state rectangle.
{String} properties.label Optional: The name of the state.
{Number} properties.labelOffsetX Optional: Offset in x-axis of the label from the state rectangle origin.
{Number} properties.labelOffsetY Optional: Offset in y-axis of the label from the state rectangle origin.
{Number} properties.swimlaneOffsetY Optional: Offset in y-axis of the swimlane shown after the state label.
{Object} properties.attrs Optional: SVG attributes of the appearance of the state.
{Object} properties.actions Optional: Actions of the state.
{String} properties.actions.entry Optional: Entry action of the state.
{String} properties.actions.exit Optional: Exit action of the state.
{array} properties.actions.inner Optional: Actions of the state (e.g. ["Evt1", "Action1()", "Evt2", "Action2()"])
{Number} properties.actionsOffsetX Optional: Offset in x-axis of the actions.
{Number} properties.actionsOffsetY Optional: Offset in y-axis of the actions.

Classes

Namespace Joint.dia.uml