Class SwimLane

Typically used to visualize the relationship between a business process and the department responsible for it by focusing on the logical relationships between activities.

Inheritance
System.Object
EJTagHelper
SwimLane
Inherited Members
System.Object.ToString()
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.GetHashCode()
System.Object.GetType()
System.Object.MemberwiseClone()
Namespace: Syncfusion.JavaScript.DataVisualization.Models.Diagram
Assembly: Syncfusion.EJ.dll
Syntax
public class SwimLane : EJTagHelper

Constructors

SwimLane()

Declaration
public SwimLane()

Properties

AddInfo

Gets or sets additional information about swimlane

Declaration
[JsonProperty("addInfo")]
public object AddInfo { get; set; }
Property Value
Type Description
System.Object

null
Examples
           DiagramProperties Model = new DiagramProperties();
           SwimLane SwimLane = new SwimLane();
           SwimLane.Width = 500;
           SwimLane.OffsetX = 100;
           SwimLane.OffsetY = 100;
           Dictionary<string, string> AddInfo = new Dictionary<string, string>();
           AddInfo.Add("TooltipData", "Shares the information with the customer");
           SwimLane.AddInfo = AddInfo;
           Model.Nodes.Add(SwimLane);

Constraints

Gets or sets the default behaviors of the swimlane node

Declaration
[JsonConverter(typeof(StringEnumConverter))]
[JsonProperty("constraints")]
public NodeConstraints Constraints { get; set; }
Property Value
Type Description
NodeConstraints

DefaultValue(NodeConstraints.Default |
NodeConstraints.AllowDrop & ~(NodeConstraints.ResizeNorth |
          NodeConstraints.ResizeWest | NodeConstraints.ResizeNorthWest |
      NodeConstraints.ResizeNorthEast | NodeConstraints.ResizeSouthWest))
Examples
           DiagramProperties Model = new DiagramProperties();
           SwimLane SwimLane = new SwimLane();
           SwimLane.Width = 500;
           SwimLane.OffsetX = 100;
           SwimLane.OffsetY = 100;
           SwimLane.Constraints = NodeConstraints.Default;
           SwimLane.Phases.Add(new Phase() { Name = "Phas1", Offset = 150, Orientation = "vertical", Type = "phase" });
           Model.Nodes.Add(SwimLane);

CssClass

Gets or sets the style properties of the swimlane

Declaration
[JsonProperty("cssClass")]
public string CssClass { get; set; }
Property Value
Type Description
System.String

String.Empty
Examples
           DiagramProperties Model = new DiagramProperties();
           SwimLane SwimLane = new SwimLane();
           SwimLane.Width = 500;
           SwimLane.OffsetX = 100;
           SwimLane.OffsetY = 100;
           SwimLane.CssClass = "className";
           Model.Nodes.Add(SwimLane);

FillColor

Gets or sets the fillColor of the swimlane node

Declaration
[JsonProperty("fillColor")]
public string FillColor { get; set; }
Property Value
Type Description
System.String

"transparent"
Examples
           SwimLane SwimLane = new SwimLane();
           SwimLane.FillColor = "red";

Header

Gets or sets  the header of a swimlane/lane

Declaration
[JsonProperty("header")]
public Header Header { get; set; }
Property Value
Type Description
Header

null
Examples
           DiagramProperties Model = new DiagramProperties();
           SwimLane Node = new SwimLane();
           Node.Name = "swimlane";
           Node.Header.Text = "swimlane";
           Node.Header.FontSize = 12;
           Node.Header.Bold = true;
           Model.Nodes.Add(Node);

Height

Gets or sets the height of the node

Declaration
[JsonProperty("height")]
public double Height { get; set; }
Property Value
Type Description
System.Double

100
Examples
            DiagramProperties Model = new DiagramProperties();
           SwimLane SwimLane = new SwimLane();
           Dictionary<string, string> AddInfo = new Dictionary<string, string>();
           AddInfo.Add("customvalue", "lane");
           Collection Children = new Collection();
           Children.Add(new Node() { Name = "node1", Height = 100,  });
           SwimLane.Lanes.Add(new Lane() { Name = "lane1", Width = 300, Orientation = "vertical" });
           Model.Nodes.Add(SwimLane);
           ViewData["diagramModel"] = Model;

IsGroup

Declaration
[Obsolete("Use Type")]
[JsonProperty("isGroup")]
public bool IsGroup { get; set; }
Property Value
Type Description
System.Boolean

IsSwimlane

Gets or sets the indicate the node as swimlane

Declaration
[JsonProperty("isSwimlane")]
public bool IsSwimlane { get; set; }
Property Value
Type Description
System.Boolean

true
Examples
           SwimLane SwimLane = new SwimLane();
           SwimLane.IsSwimlane = true;

Lanes

Gets or sets collection of objects where each object represents a lane. Appilicable, if the node is a swimlane.

Declaration
[JsonProperty("lanes")]
public Collection Lanes { get; set; }
Property Value
Type Description
Collection

Collection()
Examples
           DiagramProperties Model = new DiagramProperties();
           SwimLane SwimLane = new SwimLane();
           SwimLane.IsSwimlane = true;
           SwimLane.Lanes.Add(new Lane() { Name = "lane1", Width = 300 });
           SwimLane.Lanes.Add(new Lane() { Name = "lane2", Height = 300 });
           Model.Nodes.Add(SwimLane);

MaxHeight

Gets or sets the maximum height limit of the node

Declaration
[JsonProperty("maxHeight")]
public double MaxHeight { get; set; }
Property Value
Type Description
System.Double

100
Examples
            DiagramProperties Model = new DiagramProperties();
           SwimLane SwimLane = new SwimLane();
           Dictionary<string, string> AddInfo = new Dictionary<string, string>();
           AddInfo.Add("customvalue", "lane");
           Collection Children = new Collection();
           Children.Add(new Node() { Name = "node1", Height = 100, MaxHeight = 150 });
           SwimLane.Lanes.Add(new Lane() { Name = "lane1", Width = 300, Orientation = "vertical" });
           Model.Nodes.Add(SwimLane);
           ViewData["diagramModel"] = Model;

MaxWidth

Gets or sets  the maximum width limit of the node

Declaration
[JsonProperty("maxWidth")]
public double MaxWidth { get; set; }
Property Value
Type Description
System.Double

100
Examples
            DiagramProperties Model = new DiagramProperties();
           SwimLane SwimLane = new SwimLane();
           Dictionary<string, string> AddInfo = new Dictionary<string, string>();
           AddInfo.Add("customvalue", "lane");
           Collection Children = new Collection();
           Children.Add(new Node() { Name = "node1", Height = 100, MaxWidth = 150 });
           SwimLane.Lanes.Add(new Lane() { Name = "lane1", Width = 300, Orientation = "vertical" });
           Model.Nodes.Add(SwimLane);
           ViewData["diagramModel"] = Model;

MinHeight

Gets or sets  the minimum height limit of the node

Declaration
[JsonProperty("minHeight")]
public double MinHeight { get; set; }
Property Value
Type Description
System.Double

100
Examples
            DiagramProperties Model = new DiagramProperties();
           SwimLane SwimLane = new SwimLane();
           Dictionary<string, string> AddInfo = new Dictionary<string, string>();
           AddInfo.Add("customvalue", "lane");
           Collection Children = new Collection();
           Children.Add(new Node() { Name = "node1", Height = 100, MinHeight = 150 });
           SwimLane.Lanes.Add(new Lane() { Name = "lane1", Width = 300, Orientation = "vertical" });
           Model.Nodes.Add(SwimLane);
           ViewData["diagramModel"] = Model;

MinWidth

Gets or sets  the minimum width limit of the node

Declaration
[JsonProperty("minWidth")]
public double MinWidth { get; set; }
Property Value
Type Description
System.Double

100
Examples
            DiagramProperties Model = new DiagramProperties();
           SwimLane SwimLane = new SwimLane();
           Dictionary<string, string> AddInfo = new Dictionary<string, string>();
           AddInfo.Add("customvalue", "lane");
           Collection Children = new Collection();
           Children.Add(new Node() { Name = "node1", Height = 100, MinWidth = 150 });
           SwimLane.Lanes.Add(new Lane() { Name = "lane1", Width = 300, Orientation = "vertical" });
           Model.Nodes.Add(SwimLane);
           ViewData["diagramModel"] = Model;

Name

Gets or sets the unique identifier for swimlane

Declaration
[JsonProperty("name")]
public string Name { get; set; }
Property Value
Type Description
System.String

String.Empty
Examples
          SwimLane SwimLane = new SwimLane();
          SwimLane.name = "SwimLane";

OffsetX

Gets or sets the position of the node on X-Axis

Declaration
[JsonProperty("offsetX")]
public double OffsetX { get; set; }
Property Value
Type Description
System.Double

100
Examples
           DiagramProperties Model = new DiagramProperties();
           SwimLane SwimLane = new SwimLane();
           SwimLane.Width = 500;
           SwimLane.OffsetX = 100;
           SwimLane.OffsetY = 100;
           SwimLane.Phases.Add(new Phase() { Name = "Phas1", Offset = 150, Orientation = "vertical", Type = "phase" });
           Model.Nodes.Add(SwimLane);

OffsetY

Gets or sets the position of the node on Y-Axis

Declaration
[JsonProperty("offsetY")]
public double OffsetY { get; set; }
Property Value
Type Description
System.Double

100
Examples
           DiagramProperties Model = new DiagramProperties();
           SwimLane SwimLane = new SwimLane();
           SwimLane.Width = 500;
           SwimLane.OffsetX = 100;
           SwimLane.OffsetY = 100;
           SwimLane.Phases.Add(new Phase() { Name = "Phas1", Offset = 150, Orientation = "vertical", Type = "phase" });
           Model.Nodes.Add(SwimLane);

Orientation

Gets or sets the wether the swimlane should be in either vertically or horizontally.

Declaration
[JsonProperty("orientation")]
public string Orientation { get; set; }
Property Value
Type Description
System.String

"vertical"
Examples
           SwimLane SwimLane = new SwimLane();
           SwimLane.Orientation = "vertical";

Phases

Gets or sets array of objects, where each object represents a smaller region(phase) of a swimlane.

Declaration
[JsonProperty("phases")]
public Collection Phases { get; set; }
Property Value
Type Description
Collection

Collection()
Examples
           DiagramProperties Model = new DiagramProperties();
           SwimLane SwimLane = new SwimLane();
           SwimLane.Width = 500;            
           SwimLane.Phases.Add(new Phase() { Name = "Phas1", Offset = 150 });
           Model.Nodes.Add(SwimLane);

PhaseSize

Gets or sets  the height of the phase headers

Declaration
[JsonProperty("phaseSize")]
public double PhaseSize { get; set; }
Property Value
Type Description
System.Double

0
Examples
            DiagramProperties Model = new DiagramProperties();
           SwimLane SwimLane = new SwimLane();
           SwimLane.Width = 500;
           SwimLane.Phases.Add(new Phase() { Name = "Phas1", Offset = 150, Orientation = "vertical", Type = "phase" });
           SwimLane.PhaseSize = 20;
           Model.Nodes.Add(SwimLane);

Type

Gets or sets the type as "swimlane"

Declaration
[JsonProperty("type")]
public string Type { get; set; }
Property Value
Type Description
System.String

String.Empty
Examples
          SwimLane SwimLane = new SwimLane();
          SwimLane.Type = "SwimLane";

Width

Gets or sets the width of the node

Declaration
[JsonProperty("width")]
public double Width { get; set; }
Property Value
Type Description
System.Double

100
Examples
            DiagramProperties Model = new DiagramProperties();
           SwimLane SwimLane = new SwimLane();
           Dictionary<string, string> AddInfo = new Dictionary<string, string>();
           AddInfo.Add("customvalue", "lane");
           Collection Children = new Collection();
           Children.Add(new Node() { Name = "node1", Width = 100,  });
           SwimLane.Lanes.Add(new Lane() { Name = "lane1", Width = 300, Orientation = "vertical" });
           Model.Nodes.Add(SwimLane);
           ViewData["diagramModel"] = Model;

ZOrder

Gets or sets the z-index of the swimlane

Declaration
[JsonProperty("zOrder")]
public double ZOrder { get; set; }
Property Value
Type Description
System.Double

-1
Examples
           DiagramProperties Model = new DiagramProperties();
           SwimLane SwimLane = new SwimLane();
           SwimLane.Width = 500;
           SwimLane.OffsetX = 100;
           SwimLane.OffsetY = 100;
           SwimLane.CssClass = "className";
           Model.Nodes.Add(SwimLane);