Class 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.
Inherited Members
Namespace: Syncfusion.JavaScript.DataVisualization.Models.Diagram
Assembly: Syncfusion.EJ.dll
Syntax
public class Lane : EJTagHelper
Constructors
Lane()
Declaration
public Lane()
Properties
AddInfo
Gets or sets the additional information about the lane
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.IsSwimlane = true;
Dictionary<string, object> AddInfo = new Dictionary<string, object>();
AddInfo.Add("Description", "Additional lane description");
SwimLane.Lanes.Add(new Lane() { Name = "lane1", Width = 300, Height = 100, AddInfo = addInfo });
Model.Nodes.Add(SwimLane);
Children
Gets or sets array of objects where each object represents a child node of the lane
Declaration
[JsonProperty("children")]
public Collection Children { get; set; }
Property Value
Type | Description |
---|---|
Collection | Collection |
Examples
DiagramProperties Model = new DiagramProperties();
SwimLane SwimLane = new SwimLane();
SwimLane.IsSwimlane = true;
Collection Children = new Collection();
Children.Add(new Node() { Name = "node1", Height = 100, MarginLeft = 200 });
Children.Add(new Node() { Name = "node1", Height = 100, MarginLeft = 200 });
SwimLane.Lanes.Add(new Lane() { Name = "lane1", Width = 300, Children = children });
Model.Nodes.Add(SwimLane);
Constraints
Gets or sets enables or disables the default behaviors of the node.
Declaration
[JsonConverter(typeof(StringEnumConverter))]
[JsonProperty("constraints")]
public NodeConstraints Constraints { get; set; }
Property Value
Type | Description |
---|---|
NodeConstraints | DefaultValue(NodeConstraints.Default | |
Examples
DiagramProperties Model = new DiagramProperties();
SwimLane SwimLane = new SwimLane();
SwimLane.IsSwimlane = true;
SwimLane.Lanes.Add(new Lane() { Name = "lane1", Width = 300, Type = "lane", Constraints = NodeConstraints.Default });
Model.Nodes.Add(SwimLane);
CssClass
Gets or sets the style configuration of the lane
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.IsSwimlane = true;
swimlane.Lanes.Add(new Lane() { Name = "lane1", Width = 300, Height = 100, CssClass = "classname" });
Model.Nodes.Add(swimlane);
FillColor
Gets or sets the fill color of the lane
Declaration
[JsonProperty("fillColor")]
public string FillColor { get; set; }
Property Value
Type | Description |
---|---|
System.String | "white" |
Examples
DiagramProperties Model = new DiagramProperties();
SwimLane SwimLane = new SwimLane();
SwimLane.IsSwimlane = true;
SwimLane.Lanes.Add(new Lane() { Name = "lane1", Width = 300, FillColor = "red" });
Model.Nodes.Add(SwimLane);
Header
Gets or sets the header of the lane
Declaration
[JsonProperty("header")]
public Header Header { get; set; }
Property Value
Type | Description |
---|---|
Header | null |
Examples
DiagramProperties Model = new DiagramProperties();
SwimLane SwimLane = new SwimLane();
SwimLane.IsSwimlane = true;
SwimLane.Lanes.Add(new Lane() { Name = "lane1", Width = 300, FillColor = "red", Header = new Header() { Text = "funtion" } });
Model.Nodes.Add(SwimLane);
ViewData["diagramModel"] = Model;
Height
Declaration
[JsonProperty("height")]
public double Height { get; set; }
Property Value
Type | Description |
---|---|
System.Double |
IsGroup
Declaration
[Obsolete("Use Type")]
[JsonProperty("isGroup")]
public bool IsGroup { get; set; }
Property Value
Type | Description |
---|---|
System.Boolean |
IsLane
Gets or sets the object as a lane
Declaration
[JsonProperty("isLane")]
public bool IsLane { get; set; }
Property Value
Type | Description |
---|---|
System.Boolean | null |
Examples
DiagramProperties Model = new DiagramProperties();
SwimLane SwimLane = new SwimLane();
SwimLane.IsSwimlane = true;
SwimLane.Lanes.Add(new Lane() { Name = "lane1", Width = 300, IsLane = true });
Model.Nodes.Add(SwimLane);
Labels
Gets or sets collection of label objects
Declaration
[JsonProperty("labels")]
public Collection Labels { get; set; }
Property Value
Type | Description |
---|---|
Collection | [ ] |
Examples
DiagramProperties Model = new DiagramProperties();
SwimLane SwimLane = new SwimLane();
SwimLane.IsSwimlane = true;
Collection Labels = new Collection();
Labels.Add(new Label() { Text = "lane label" });
SwimLane.Lanes.Add(new Lane() { Name = "lane1", Width = 300, Height = 100, });
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();
SwimLane.IsSwimlane = true;
SwimLane.Lanes.Add(new Lane() { Name = "lane1", Width = 300, Height = 100, MinHeight = 100, MaxHeight = 200, MinWidth = 100, MaxWidth = 100 });
Model.Nodes.Add(SwimLane);
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();
SwimLane.IsSwimlane = true;
SwimLane.Lanes.Add(new Lane() { Name = "lane1", Width = 300, Height = 100, MinHeight = 100, MaxHeight = 200, MinWidth = 100, MaxWidth = 100 });
Model.Nodes.Add(SwimLane);
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();
SwimLane.IsSwimlane = true;
SwimLane.Lanes.Add(new Lane() { Name = "lane1", Width = 300, Height = 100, MinHeight = 100, MaxHeight = 200, MinWidth = 100, MaxWidth = 100 });
Model.Nodes.Add(SwimLane);
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();
SwimLane.IsSwimlane = true;
SwimLane.Lanes.Add(new Lane() { Name = "lane1", Width = 300, Height = 100, MinHeight = 100, MaxHeight = 200, MinWidth = 100, MaxWidth = 100 });
Model.Nodes.Add(SwimLane);
Name
Gets or sets the unique identifier of the lane
Declaration
[JsonProperty("name")]
public string Name { get; set; }
Property Value
Type | Description |
---|---|
System.String | String.Empty |
Examples
DiagramProperties Model = new DiagramProperties();
SwimLane SwimLane = new SwimLane();
SwimLane.IsSwimlane = true;
SwimLane.Lanes.Add(new Lane() { Name = "lane1", Width = 300, IsLane = true });
Model.Nodes.Add(SwimLane);
ViewData["diagramModel"] = Model;
OffsetX
Declaration
[JsonProperty("offsetX")]
public double OffsetX { get; set; }
Property Value
Type | Description |
---|---|
System.Double |
OffsetY
Declaration
[JsonProperty("offsetY")]
public double OffsetY { get; set; }
Property Value
Type | Description |
---|---|
System.Double |
Orientation
Gets or sets the orientation of the lane.
Declaration
[JsonProperty("orientation")]
public string Orientation { get; set; }
Property Value
Type | Description |
---|---|
System.String | "vertical" |
Examples
DiagramProperties Model = new DiagramProperties();
SwimLane SwimLane = new SwimLane();
Dictionary<string, string> AddInfo = new Dictionary<string, string>();
AddInfo.Add("customvalue", "lane");
SwimLane.Lanes.Add(new Lane() { Name = "lane1", Width = 300, Orientation = "vertical" });
Model.Nodes.Add(SwimLane);
PaletteItem
Gets or sets size and preview size of the node to add that to symbol palette
Declaration
[JsonProperty("paletteItem")]
public PaletteItem PaletteItem { get; set; }
Property Value
Type | Description |
---|---|
PaletteItem | null |
Examples
SymbolPaletteProperties SymbolPalette = new SymbolPaletteProperties();
SymbolPalette.Palettes = new Collection();
Palette Palette = new Palette("Connectors");
Palette.Expanded = true;
Palette.Items.Add(new Lane() { Name = "lane", Orientation = "horizontal" });
ViewData["PaletteModel"] = SymbolPalette;
Type
Gets or sets the type as lane
Declaration
[JsonProperty("type")]
public string Type { get; set; }
Property Value
Type | Description |
---|---|
System.String | "lane" |
Examples
DiagramProperties Model = new DiagramProperties();
SwimLane SwimLane = new SwimLane();
SwimLane.IsSwimlane = true;
SwimLane.Lanes.Add(new Lane() { Name = "lane1", Width = 300, Type = "lane" });
Model.Nodes.Add(SwimLane);
Width
Declaration
[JsonProperty("width")]
public double Width { get; set; }
Property Value
Type | Description |
---|---|
System.Double |
ZOrder
Gets or sets the z-index of the lane
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.IsSwimlane = true;
SwimLane.Lanes.Add(new Lane() { Name = "lane1", Width = 300, Height = 100, ZOrder = 2 });
Model.Nodes.Add(SwimLane);