Swim lane in JQuery Diagram widget

Swim-lane Diagrams are typically used to visualize the relationship between a business process and the department responsible for it by focusing on the logical relationships between activities. Swimlanes may be arranged either horizontally or vertically.

Initialize Diagram

Add a placeholder div element that can be used to initialize the diagram widget as shown below.

  • html
  • <body>
    	<div id="diagram"></div>
    	<script type="text/javascript">
    		$("#diagram").ejDiagram({
    			width: "100%",
    			height: "600px",
    		});
    	</script>
    </body>

    Create a swimlane

    To create a swimlane, you need to define an object with isSwimlane property that helps identify the object as a swimlane. By default, the swimlanes are arranged vertically. You can change that with the orientation property of swimlane.

    The following code example illustrates how to define a swimlane object.

  • javascript
  • var swimlane = {
    	name: "swimlaneNode",
    	//Changes the orientation
    	orientation: "horizontal",
    	//Sets the position and size
    	offsetX: 400,
    	offsetY: 200,
    	height: 100,
    	width: 700,
    	//Sets the type of object as swimlane
    	isSwimlane: true
    };

    Add swimlane into diagram

    Adding a swimlane to the Diagram is same as adding a node. You can add either through the nodes collection or through the client side method add. You can also drag and drop a swimlane from symbol palette.
    For more information about adding a node/swimlane to the Diagram, refer to Add Nodes.

    The following code example illustrates how to add a swimlane to the Diagram through nodes collection.

  • javascript
  • $("#diagram").ejDiagram({
    	nodes: [swimlane]
    });

    Adding swimlane to diagram

    Headers

    Swimlane allows to define a header to textually describe it. The header property of swimlane allows you to define its textual description(text) and to customize its appearance. The following code example illustrates how to define swimlane header.

  • javascript
  • //Defines the header and format its text
    var header = {
    	text: "Swimlane",
    	height: 50,
    	fillColor: "#C7D4DF",
    	fontColor: "black", fontSize: 11, fontFamily: "Arial",
    	bold: true, italic: true, textDecoration: "underline"
    };
    
    //Initializes swimlane with header
    var swimlane = {
    	type: "swimlane",
    	name: "swimlaneNode",
    	orientation: "horizontal",
    	offsetX: 400,
    	offsetY: 200,
    	height: 100,
    	width: 700,
    	isSwimlane: true,
    	//Defines header
    	header:header
    };
    
    $("#diagram").ejDiagram({
    	nodes: [swimlane],
    });
    
    //Updates the swimlane header at runtime
    var diagram = $("#diagram").ejDiagram("instance");
    diagram.updateNode("swimlaneName", { header: {fontColor:"white"} })

    Headers for Swimlane

    Update Header

    Swimlane headers can be updated at runtime with the client side method updateNode. The following code example illustrates how to update a lane’s header at runtime.

  • javascript
  • var diagram = $("#diagram").ejDiagram("instance");
    
    //Defines the header and format its text
    var header = {
    	text: "swimlane",
    	bold: true,
    	italic: true
    };
    
    diagram.updateNode("swimlane", { header: header });

    Disable headers

    You can hide the swimlane headers. The following code example illustrates how to hide headers.

  • javascript
  • var header = {
    	text: "Swimlane",
    	//Sets "0" to hide header
    	height: 0
    };

    Lane

    Lane is a functional unit or a responsible department of a business process that helps to map a process within the functional unit or in between other functional units.
    You can add any number of lanes to a swimlane and the lanes are automatically stacked inside a swimlane based in the order they are added.

    Create an empty lane

    • To create an empty lane, you need to define an object with isLane property that helps identify the object as a lane.

    • The lane’s name property is used to define the name of the lane and its further used to find the lane at runtime and do any customization.

    The following example illustrates how to define a swimlane with a lane.

  • javascript
  • //Defines an empty lane
    var lane = {
    	name: "lane1",
    	fillColor: "#f5f5f5",
    	height: 120,
    
    	//Sets the object as Lane
    	isLane:"true"
    };
    
    //Initializes swimlane with a header and a lane
    var swimlane = {
    	type: "swimlane",
    	name: "swimlaneNode",
    	orientation: "horizontal",
    	offsetX: 400,
    	offsetY: 200,
    	height: 100,
    	width: 700,
    	isSwimlane: true,
    	//Defines header - header defined in the headers section
    	header:header,
    	//Defines lanes collection
    	lanes: [lane]
    };

    Create a lane with header

    • The header property of the lane allows you to textually describe the lane(text) and to customize the appearance of the description. The following code example illustrates how to define a lane header.

    • The size of the lane can be controlled by using its width and height properties. Also you can limit the size of a lane with its minWidth, minHeight, maxWidth, and maxHeight properties.

  • javascript
  • //Defines the lane header
    var laneHeader = {
    	text: "swimlane label",
    	fillColor: "#C7D4DF",
    	fontColor: "black", fontSize: 15, fontFamily: "Arial",
    	bold: false, italic: false, textDecoration: "none"
    };
    
    //Initializes the lane
    var lane = {
    	name: "lane1",
    	fillColor: "#f5f5f5",
    	height: 120,
    	isLane: true,
    	//Specifies the lane header
    	header: laneHeader,
    	//Specifies the minimum and maximum size of the lane
    	minWidth: 500,
    	maxWidth: 700,
    	minHeight: 120,
    	maxHeight: 200,
    };
    
    //Adds lanes to swimlane
    var swimlane = {
    	type: "swimlane",
    	name: "swimlaneNode",
    	orientation: "horizontal",
    	offsetX: 400,
    	offsetY: 200,
    	height: 100,
    	width: 700,
    	isSwimlane: true,
    	//Defines header - header defined in the headers section
    	header:header,
    	//Adds lanes to swimlane
    	lanes: [lane]
    };

    Disable/Update header

    You can disable/update the lane header at runtime with the client side method, updateNode. The following code example illustrates how to disable the lane header at run time.

  • javascript
  • var diagram = $("#diagram").ejDiagram("instance");
    
    //Sets "0" to hide header
    diagram.updateNode("laneName", { header: {height: 0} })

    Add nodes to a lane

    To add nodes to a lane, You need to add them to the children collection of lane. The following code example illustrates how to add nodes to a lane.

  • javascript
  • //Defines children of lane
    var children = [
    {
    	name: "node",
    	width: 70,
    	height: 30,
    	labels: [{
    		text: "Node",
    	}],
    	// Specifies the margin values of the child
    	marginLeft: 70,
    	marginTop: 1
    }];
    
    //Initializes the lane
    var lane = {
    	name: "lane1",
    	fillColor: "#f5f5f5",
    	height: 120,
    	isLane: true,
    	//Defines header - as above snippet
    	header: laneHeader,
    	//Adds nodes to lane
    	children:children,
    	//Specifies the minimum and maximum size of the lane
    	minWidth: 500,
    	maxWidth: 700,
    	minHeight: 120,
    	maxHeight: 200,
    };
    
    //Adds lanes to swimlane
    var swimlane = {
    	type: "swimlane",
    	name: "swimlaneNode",
    	orientation: "horizontal",
    	offsetX: 400,
    	offsetY: 200,
    	height: 100,
    	width: 700,
    	isSwimlane: true,
    	//Defines header - header defined in the headers section
    	header:header,
    	//Adds lanes to swimlane
    	lanes: [lane]
    };

    Adding nodes to a lane

    Add lane at runtime

    We can add a lane at runtime width client side API method addLane. please refer to the below link which shows how to use addLane method in diagram.

    addLane.

    Customizing Lanes appearance

    • To set a background color for an lane, use fillColor property.

    • The lanes cssClass property is used to customize the style of lanes using user defined CSS class.

    Custom Properties

    The addInfo property of lane allows to maintain additional information to lane.

    Stack Order

    The lanes zOrder property specifies the stack order of an lane. An lane with greater stack order is always in front of an lane with a lower stack order.

    Phase

    Phases are the sub-processes that are used to break the swimlane into multiple smaller regions.

    Add phase

    • To define a phase, you have to set the length of the region to the offset property of phase. Every region can be textually described with the label property of phase.

    • The phase’s name property is used to define the name of the phase and its further used to find the phase from swimlane at runtime and do any customization.

    • The swimlane phaseSize property is used to set the height/width of the phase header based on orientation property of swimlane.

    The following code example illustrates how to add a phase on initializing swimlane.

  • javascript
  • //Creates a phase
    var phase1 = {
    	name: "Phase1",
    	//Length of the first region
    	offset: 300,
    	//Initializes labels for phases
    	label: { text: "Phase1" },
    	//Specifies the appearance of separator
    	lineWidth: 1,
    	lineDashArray: "3,3",
    	lineColor: "#606060"
    };
    
    var phase2 = {
    	name: "Phase2",
    	label: { text: "Phase2" }
    };
    
    var swimlane = {
    	type: "swimlane",
    	name: "swimlaneNode",
    	orientation: "horizontal",
    	offsetX: 400, offsetY: 200,
    	height: 100,width: 500,
    	//Initializes the phase collection
    	phases: [phase1, phase2],
    	//Adds lanes and header as mentioned in header and lane section
    	lanes: [lane],
    	header: header
    };

    Adding new phase to the lane

    Add phase at runtime

    You can add a region at runtime with the client side method, addPhase. The following code example illustrates how to add a phase at runtime.

  • javascript
  • var phase = {
    	name: "Phase3",
    	label: { text: "Phase3" }
    };
    
    var diagram = $("#diagram").ejDiagram("instance");
    diagram.addPhase("swimlaneName", phase);

    A phase can be updated at runtime with the client side API updateNode. The following code example illustrates how to a update phase at runtime.

  • javascript
  • var diagram = $("#diagram").ejDiagram("instance");
    var options = {
    	//Specifies the style of the phase to be updated
    	lineDashArray: "3,3",
    	lineColor: "#C7D4DF",
    	lineWidth: 2
    }
    diagram.updateNode("phaseName", options);

    NOTE

    A default phase is added, when the phase collection of the swimlane is empty. When the phase collection is initialized, a default phase is appended at the end of swimlane.

    Customizing phase appearance

    Limitations

    • You cannot add connectors as the children of lanes.