gojs

<!doctype html> <html class="default no-js"> <head> <meta charset="utf-8"> <meta http-equiv="X-UA-Compatible" content="IE=edge"> <title>SwimLaneLayout | GoJS API</title> <meta name="description" content=""> <meta name="viewport" content="width=device-width, initial-scale=1"> <link rel="stylesheet" href="../../assets/css/bootstrap.min.css"> <link rel="stylesheet" href="../assets/css/main.css"> </head> <body> <header>  <nav id="non-fixed-nav" class="navbar navbar-inverse navbar-top"> <div class="container-fluid"> <div class="navbar-header"> <div class="navheader-container"> <div class="navheader-collapse" data-toggle="collapse" data-target="#navbar"> <a id="toplogo" class="navbar-brand" href="../../index.html">GoJS</a> <button type="button" class="navbar-toggle" data-toggle="collapse" data-target="#navbar"> <span class="sr-only">Toggle navigation</span> <span class="icon-bar"></span> <span class="icon-bar"></span> <span class="icon-bar"></span> </button> </div> </div> </div> <div id="navbar" class="navbar-collapse collapse"> <ul class="nav navbar-nav navbar-right"> <li><a href="../../index.html">Home</a></li> <li><a href="../../learn/index.html">Learn</a></li> <li><a href="../../samples/index.html">Samples</a></li> <li><a href="../../intro/index.html">Intro</a></li> <li><a href="../../api/index.html" target="api">API</a></li> <li><a href="https://www.nwoods.com/components/evalform.htm">Register</a></li> <li><a href="../../download.html">Download</a></li> <li><a href="https://forum.nwoods.com/c/gojs">Forum</a></li> <li><a href="https://www.nwoods.com/contact.html" onclick="ga('send','event','Outbound Link','click','contact');">Contact</a></li> <li class="buy"><a href="https://www.nwoods.com/sales/index.html" onclick="ga('send','event','Outbound Link','click','buy');">Buy</a></li> <li class="activate"><a href="https://www.nwoods.com/app/activate.aspx?sku=gojs">Activate</a></li> </ul> </div> </div> </nav> <div class="tsd-page-header"> <div class="tsd-page-toolbar"> <div class="container-fluid plr15"> <div class="table-wrap"> <div class="table-cell" id="tsd-search" data-index="../assets/js/search.js" data-base=".."> <div class="field"> <label for="tsd-search-field" class="tsd-widget search no-caption">Search</label> <input id="tsd-search-field" type="text" /> </div> <ul class="results"> <li class="state loading">Preparing search index...</li> <li class="state failure">The search index is not available</li> </ul> <a href="../index.html" class="title">GoJS API</a> </div> <div class="table-cell" id="tsd-widgets"> <div id="tsd-filter"> <a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a> <div class="tsd-filter-group"> <div class="tsd-select" id="tsd-filter-visibility"> <span class="tsd-select-label">All</span> <ul class="tsd-select-list"> <li data-value="public">Public</li> <li data-value="protected">Public/Protected</li> <li data-value="private" class="selected">All</li> </ul> </div> </div> </div> <a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a> </div> </div> </div> </div> <div class="tsd-page-title"> <div class="container-fluid plr15"> <div class="top-copyright">  <b>GoJS</b>® Diagramming Components<br/>version 2.1.27<br/>by <a href="https://www.nwoods.com/">Northwoods Software®</a> </div> <div> <h1>Class SwimLaneLayout</h1> </div> </div> </div> </div> </header> <div class="container-fluid container-main plr15"> <div class="row"> <div class="col-8 col-content"> <section class="tsd-panel tsd-extension"> <p> This is an extension and not part of the main GoJS library. Note that the API for this class may change at any time. If you intend to use an extension in production, you should copy the code to your own source directory. Extensions can be found in the GoJS kit under the <code>extensions</code> or <code>extensionsTS</code> folders. See the <a href="../../intro/extensions.html">Extensions intro page</a> for more information. </p> </section> <section class="tsd-panel tsd-hierarchy"> <h3>Hierarchy</h3> <ul class="tsd-hierarchy"> <li> <a href="Layout.html" class="tsd-signature-type">Layout</a> <ul class="tsd-hierarchy"> <li> <a href="LayeredDigraphLayout.html" class="tsd-signature-type">LayeredDigraphLayout</a> <ul class="tsd-hierarchy"> <li> <span class="target">SwimLaneLayout</span> </li> </ul> </li> </ul> </li> </ul> </section> <section class="tsd-panel tsd-comment"> <div class="tsd-comment tsd-typography"> <p>A custom LayeredDigraphLayout that knows about "lanes" and that positions each node in its respective lane.</p> <p>This assumes that each Node.data.lane property is a string that names the lane the node should be in. You can set the <a href="SwimLaneLayout.html#laneProperty">laneProperty</a> property to use a different data property name. It is commonplace to set this property to be the same as the <a href="GraphLinksModel.html#nodeGroupKeyProperty">GraphLinksModel.nodeGroupKeyProperty</a>, so that the one property indicates that a particular node data is a member of a particular group and thus that that group represents a lane.</p> <p>The lanes can be sorted by specifying the <a href="SwimLaneLayout.html#laneComparer">laneComparer</a> function.</p> <p>You can add extra space between the lanes by increasing <a href="SwimLaneLayout.html#laneSpacing">laneSpacing</a> from its default of zero. That number's unit is columns, <a href="LayeredDigraphLayout.html#columnSpacing">LayeredDigraphLayout.columnSpacing</a>, not in document coordinates.</p> </div> </section> <section class="tsd-panel-group tsd-index-group"> <h2>Index</h2> <section class="tsd-panel tsd-index-panel"> <div class="tsd-index-content"> <section class="tsd-index-section "> <h3>Properties</h3> <ul class="tsd-index-list"> <li class="tsd-kind-get-signature tsd-parent-kind-class tsd-is-protected"><a href="SwimLaneLayout.html#laneBreadths" class="tsd-kind-icon">lane<wbr>Breadths</a></li> <li class="tsd-kind-accessor tsd-parent-kind-class"><a href="SwimLaneLayout.html#laneComparer" class="tsd-kind-icon">lane<wbr>Comparer</a></li> <li class="tsd-kind-accessor tsd-parent-kind-class"><a href="SwimLaneLayout.html#laneNames" class="tsd-kind-icon">lane<wbr>Names</a></li> <li class="tsd-kind-get-signature tsd-parent-kind-class tsd-is-protected"><a href="SwimLaneLayout.html#lanePositions" class="tsd-kind-icon">lane<wbr>Positions</a></li> <li class="tsd-kind-accessor tsd-parent-kind-class"><a href="SwimLaneLayout.html#laneProperty" class="tsd-kind-icon">lane<wbr>Property</a></li> <li class="tsd-kind-accessor tsd-parent-kind-class"><a href="SwimLaneLayout.html#laneSpacing" class="tsd-kind-icon">lane<wbr>Spacing</a></li> </ul> </section> <section class="tsd-index-section "> <h3>Methods</h3> <ul class="tsd-index-list"> <li class="tsd-kind-method tsd-parent-kind-class"><a href="SwimLaneLayout.html#computeMinLaneWidth" class="tsd-kind-icon">compute<wbr>Min<wbr>Lane<wbr>Width</a></li> <li class="tsd-kind-method tsd-parent-kind-class tsd-is-protected"><a href="SwimLaneLayout.html#findLane" class="tsd-kind-icon">find<wbr>Lane</a></li> <li class="tsd-kind-method tsd-parent-kind-class tsd-is-protected"><a href="SwimLaneLayout.html#getLane" class="tsd-kind-icon">get<wbr>Lane</a></li> </ul> </section> </div> </section> </section> <section class="tsd-panel-group tsd-member-group "> <h2>Properties</h2> <section class="tsd-panel tsd-member tsd-kind-get-signature tsd-parent-kind-class tsd-is-protected"> <a name="laneBreadths" class="tsd-anchor"></a> <h3> <span class="tsd-flag ts-flagProtected">Protected</span> <span class="tsd-flag ts-flagReadOnly">Read-only</span> lane<wbr>Breadths <span class="tsd-signature-symbol">: </span><a href="Map.html" class="tsd-signature-type">Map</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">></span> </h3> <ul class="tsd-descriptions"> <li class="tsd-description"> <div class="tsd-comment tsd-typography"> <p>The computed breadths (widths or heights depending on the direction) of each lane, in the form of a <a href="Map.html">Map</a> mapping lane names (strings) to numbers.</p> </div> </li> </ul> </section> <section class="tsd-panel tsd-member tsd-kind-accessor tsd-parent-kind-class"> <a name="laneComparer" class="tsd-anchor"></a> <h3> lane<wbr>Comparer <span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">function</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">a</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-symbol">b</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">null</span> </h3> <ul class="tsd-descriptions"> <li class="tsd-description"> <div class="tsd-comment tsd-typography"> <p>Gets or sets a function by which to compare lane names, for ordering the lanes within the <a href="SwimLaneLayout.html#laneNames">laneNames</a> Array. By default the function is null -- the lanes are not sorted.</p> </div> </li> </ul> </section> <section class="tsd-panel tsd-member tsd-kind-accessor tsd-parent-kind-class"> <a name="laneNames" class="tsd-anchor"></a> <h3> lane<wbr>Names <span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Array</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">></span> </h3> <ul class="tsd-descriptions"> <li class="tsd-description"> <div class="tsd-comment tsd-typography"> <p>Gets or sets an Array of lane names. If you set this before a layout happens, it will use those lanes in that order. Any additional lane names that it discovers will be added to the end of this Array.</p> <p>This property is reset to an empty Array at the end of each layout. The default value is an empty Array.</p> </div> </li> </ul> </section> <section class="tsd-panel tsd-member tsd-kind-get-signature tsd-parent-kind-class tsd-is-protected"> <a name="lanePositions" class="tsd-anchor"></a> <h3> <span class="tsd-flag ts-flagProtected">Protected</span> <span class="tsd-flag ts-flagReadOnly">Read-only</span> lane<wbr>Positions <span class="tsd-signature-symbol">: </span><a href="Map.html" class="tsd-signature-type">Map</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">></span> </h3> <ul class="tsd-descriptions"> <li class="tsd-description"> <div class="tsd-comment tsd-typography"> <p>The computed positions of each lane, in the form of a <a href="Map.html">Map</a> mapping lane names (strings) to numbers.</p> </div> </li> </ul> </section> <section class="tsd-panel tsd-member tsd-kind-accessor tsd-parent-kind-class"> <a name="laneProperty" class="tsd-anchor"></a> <h3> lane<wbr>Property <span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">function</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">d</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span> </h3> <ul class="tsd-descriptions"> <li class="tsd-description"> <div class="tsd-comment tsd-typography"> <p>Gets or sets the name of the data property that holds the string which is the name of the lane that the node should be in. The default value is "lane".</p> </div> </li> </ul> </section> <section class="tsd-panel tsd-member tsd-kind-accessor tsd-parent-kind-class"> <a name="laneSpacing" class="tsd-anchor"></a> <h3> lane<wbr>Spacing <span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span> </h3> <ul class="tsd-descriptions"> <li class="tsd-description"> <div class="tsd-comment tsd-typography"> <p>Gets or sets the amount of additional space it allocates between the lanes. This number specifies the number of columns, with the same meaning as <a href="LayeredDigraphLayout.html#columnSpacing">LayeredDigraphLayout.columnSpacing</a>. The number unit is not in document coordinate or pixels. The default value is zero columns.</p> </div> </li> </ul> </section> </section> <section class="tsd-panel-group tsd-member-group "> <h2>Methods</h2> <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"> <a name="computeMinLaneWidth" class="tsd-anchor"></a> <h3> compute<wbr>Min<wbr>Lane<wbr>Width </h3> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"> <li class="tsd-signature tsd-kind-icon">compute<wbr>Min<wbr>Lane<wbr>Width<span class="tsd-signature-symbol">(</span>lane<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <div class="tsd-comment tsd-typography"> <p>Return the minimum lane width, in columns</p> </div> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5>lane: <span class="tsd-signature-type">string</span></h5> <div class="tsd-comment tsd-typography"> </div> </li> </ul> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">number</span></h4> </li> </ul> </section> <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-protected"> <a name="findLane" class="tsd-anchor"></a> <h3> <span class="tsd-flag ts-flagProtected">Protected</span> find<wbr>Lane </h3> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-protected"> <li class="tsd-signature tsd-kind-icon">find<wbr>Lane<span class="tsd-signature-symbol">(</span>v<span class="tsd-signature-symbol">: </span><a href="LayeredDigraphVertex.html" class="tsd-signature-type">LayeredDigraphVertex</a><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">null</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">null</span></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <div class="tsd-comment tsd-typography"> <p>This is just like <a href="SwimLaneLayout.html#getLane">getLane</a> but handles dummy vertexes for which the <a href="SwimLaneLayout.html#getLane">getLane</a> returns null by returning the lane of the edge's source or destination vertex. This can only be called after the lanes have been set up internally.</p> </div> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5>v: <a href="LayeredDigraphVertex.html" class="tsd-signature-type">LayeredDigraphVertex</a><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">null</span></h5> <div class="tsd-comment tsd-typography"> </div> </li> </ul> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span> <span class="tsd-signature-symbol"> | </span> <span class="tsd-signature-type">null</span> </h4> </li> </ul> </section> <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-protected"> <a name="getLane" class="tsd-anchor"></a> <h3> <span class="tsd-flag ts-flagProtected">Protected</span> get<wbr>Lane </h3> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-protected"> <li class="tsd-signature tsd-kind-icon">get<wbr>Lane<span class="tsd-signature-symbol">(</span>v<span class="tsd-signature-symbol">: </span><a href="LayeredDigraphVertex.html" class="tsd-signature-type">LayeredDigraphVertex</a><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">null</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">null</span></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <div class="tsd-comment tsd-typography"> <p>Given a vertex, get the lane (name) that its node belongs in. If the lane appears to be undefined, this returns the empty string. For dummy vertexes (with no node) this will return null.</p> </div> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5>v: <a href="LayeredDigraphVertex.html" class="tsd-signature-type">LayeredDigraphVertex</a><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">null</span></h5> <div class="tsd-comment tsd-typography"> </div> </li> </ul> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span> <span class="tsd-signature-symbol"> | </span> <span class="tsd-signature-type">null</span> </h4> </li> </ul> </section> </section> </div> <div class="col-4 col-menu menu-sticky-wrap menu-highlight"> <nav class="tsd-navigation primary"> <ul> <li class="globals "> <a href="../index.html"><em>GoJS <wbr>Class <wbr>Index</em></a> </li> </ul> </nav> <nav class="tsd-navigation secondary menu-sticky"> <ul class="before-current"> </ul> <ul class="current"> <li class="current tsd-kind-class tsd-is-extension"> <a href="SwimLaneLayout.html" class="tsd-kind-icon">Swim<wbr>Lane<wbr>Layout</a> <ul> <li class=" tsd-kind-get-signature tsd-parent-kind-class tsd-is-protected"> <a href="SwimLaneLayout.html#laneBreadths" class="tsd-kind-icon">lane<wbr>Breadths</a> </li> <li class=" tsd-kind-accessor tsd-parent-kind-class"> <a href="SwimLaneLayout.html#laneComparer" class="tsd-kind-icon">lane<wbr>Comparer</a> </li> <li class=" tsd-kind-accessor tsd-parent-kind-class"> <a href="SwimLaneLayout.html#laneNames" class="tsd-kind-icon">lane<wbr>Names</a> </li> <li class=" tsd-kind-get-signature tsd-parent-kind-class tsd-is-protected"> <a href="SwimLaneLayout.html#lanePositions" class="tsd-kind-icon">lane<wbr>Positions</a> </li> <li class=" tsd-kind-accessor tsd-parent-kind-class"> <a href="SwimLaneLayout.html#laneProperty" class="tsd-kind-icon">lane<wbr>Property</a> </li> <li class=" tsd-kind-accessor tsd-parent-kind-class"> <a href="SwimLaneLayout.html#laneSpacing" class="tsd-kind-icon">lane<wbr>Spacing</a> </li> <li class=" tsd-kind-method tsd-parent-kind-class"> <a href="SwimLaneLayout.html#computeMinLaneWidth" class="tsd-kind-icon">compute<wbr>Min<wbr>Lane<wbr>Width</a> </li> <li class=" tsd-kind-method tsd-parent-kind-class tsd-is-protected"> <a href="SwimLaneLayout.html#findLane" class="tsd-kind-icon">find<wbr>Lane</a> </li> <li class=" tsd-kind-method tsd-parent-kind-class tsd-is-protected"> <a href="SwimLaneLayout.html#getLane" class="tsd-kind-icon">get<wbr>Lane</a> </li> </ul> </li> </ul> <ul class="after-current"> </ul> </nav> </div> </div> </div> <div class="container-fluid bottom-copyright plr15"> Copyright © 1998-2020 by Northwoods Software Corporation. </div> <div class="overlay"></div> <script src="../assets/js/main.js"></script> <script src="../../assets/js/api.js"></script> <script src="../../assets/js/bootstrap.min.js"></script> <script>if (location.protocol == 'file:') document.write('<script src="../assets/js/search.js"><' + '/script>');</script> <script> (function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){ (i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o), m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m) })(window,document,'script','https://www.google-analytics.com/analytics.js','ga'); ga('create', 'UA-1506307-5', 'auto'); ga('send', 'pageview'); </script> </body> </html>