UNPKG

gojs

Version:

Interactive diagrams, charts, and graphs, such as trees, flowcharts, orgcharts, UML, BPMN, or business diagrams

465 lines (464 loc) 25.3 kB
<!doctype html> <html class="default no-js"> <head> <meta charset="utf-8"> <meta http-equiv="X-UA-Compatible" content="IE=edge"> <title>PanelLayout | GoJS API</title> <meta name="description" content="Documentation for GoJS API"> <meta name="viewport" content="width=device-width, initial-scale=1"> <link rel="stylesheet" href="../assets/css/main.css"> <link rel="stylesheet" href="../../assets/css/style.css"> <script async src="../assets/js/search.js" id="search-script"></script> </head> <body> <header> <nav id="navTop" class="w-full z-30 top-0 text-white bg-nwoods-primary"> <div class="w-full container max-w-screen-lg mx-auto flex flex-wrap sm:flex-nowrap items-center justify-between mt-0 py-2"> <div class="md:pl-4"> <a class="text-white hover:text-white no-underline hover:no-underline font-bold text-2xl lg:text-4xl rounded-lg hover:bg-nwoods-secondary" href="../"> <h1 class="mb-0 p-1">GoJS</h1> </a> </div> <button id="topnavButton" class="rounded-lg sm:hidden focus:outline-none focus:ring" aria-label="Navigation"> <svg fill="currentColor" viewBox="0 0 20 20" class="w-6 h-6"> <path id="topnavOpen" fill-rule="evenodd" d="M3 5a1 1 0 011-1h12a1 1 0 110 2H4a1 1 0 01-1-1zM3 10a1 1 0 011-1h12a1 1 0 110 2H4a1 1 0 01-1-1zM9 15a1 1 0 011-1h6a1 1 0 110 2h-6a1 1 0 01-1-1z" clip-rule="evenodd"></path> <path id="topnavClosed" class="hidden" fill-rule="evenodd" d="M4.293 4.293a1 1 0 011.414 0L10 8.586l4.293-4.293a1 1 0 111.414 1.414L11.414 10l4.293 4.293a1 1 0 01-1.414 1.414L10 11.414l-4.293 4.293a1 1 0 01-1.414-1.414L8.586 10 4.293 5.707a1 1 0 010-1.414z" clip-rule="evenodd"></path> </svg> </button> <div id="topnavList" class="hidden sm:block items-center w-auto mt-0 text-white p-0 z-20"> <ul class="list-reset list-none flex justify-end flex-wrap sm:flex-nowrap items-center px-0 pb-0"> <li class="p-1 sm:p-0"><a class="topnav-link" href="../learn/">Learn</a></li> <li class="p-1 sm:p-0"><a class="topnav-link" href="../samples/">Samples</a></li> <li class="p-1 sm:p-0"><a class="topnav-link" href="../intro/">Intro</a></li> <li class="p-1 sm:p-0"><a class="topnav-link" href="../api/">API</a></li> <li class="p-1 sm:p-0"><a class="topnav-link" href="https://www.nwoods.com/products/register.html">Register</a></li> <li class="p-1 sm:p-0"><a class="topnav-link" href="../download.html">Download</a></li> <li class="p-1 sm:p-0"><a class="topnav-link" href="https://forum.nwoods.com/c/gojs/11">Forum</a></li> <li class="p-1 sm:p-0"><a class="topnav-link" href="https://www.nwoods.com/contact.html">Contact</a></li> <li class="p-1 sm:p-0"><a class="topnav-link" href="https://www.nwoods.com/sales/index.html">Buy</a></li> </ul> </div> </div> <hr class="border-b border-gray-600 opacity-50 my-0 py-0" /> </nav> <div class="tsd-page-header"> <div class="tsd-page-toolbar"> <div class="container plr15"> <div class="table-wrap"> <div class="table-cell" id="tsd-search" data-index="../assets/js/search.json" 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 plr15"> <div class="top-copyright"> <b>GoJS</b>&reg; Diagramming Components<br/>version 2.1.39<br/>by <a href="https://www.nwoods.com/">Northwoods Software&reg;</a> </div> <div> <h1>Class PanelLayout</h1> </div> </div> </div> </div> </header> <div class="container container-main plr-15"> <div class="row"> <div class="col-8 col-content"> <section class="tsd-panel tsd-hierarchy"> <h3>Hierarchy</h3> <ul class="tsd-hierarchy"> <li> <span class="target">PanelLayout</span> </li> </ul> </section> <section class="tsd-panel tsd-comment"> <div class="tsd-comment tsd-typography"> <p>This is the abstract base class for all Panel Layouts, which inform the possible Panel types. It is possible to create your own Panel type by creating a subclass of PanelLayout, though this is not common and not recommended for beginners.</p> <p>By default, GoJS has 12 panel types, each corresponding to a PanelLayout subclass:</p> <ul> <li><code>&#39;Position&#39;, PanelLayoutPosition</code></li> <li><code>&#39;Horizontal&#39;, PanelLayoutHorizontal</code></li> <li><code>&#39;Vertical&#39;, PanelLayoutVertical</code></li> <li><code>&#39;Spot&#39;, PanelLayoutSpot</code></li> <li><code>&#39;Auto&#39;, PanelLayoutAuto</code></li> <li><code>&#39;Table&#39;, PanelLayoutTable</code></li> <li><code>&#39;Viewbox&#39;, PanelLayoutViewbox</code></li> <li><code>&#39;TableRow&#39;, PanelLayoutTableRow</code></li> <li><code>&#39;TableColumn&#39;, PanelLayoutTableColumn</code></li> <li><code>&#39;Link&#39;, PanelLayoutLink</code></li> <li><code>&#39;Grid&#39;, PanelLayoutGrid</code></li> <li><code>&#39;Graduated&#39;, PanelLayoutGraduated</code></li> </ul> <p>These are included by default in builds of <code>go.js</code> and <code>go-debug.js</code>. When building from source, you can optionally exclude all of them except <code>Position</code>, <code>Vertical</code>, <code>Auto</code>, <code>Link</code>, and <code>Grid</code>. This is demonstrated in <code>minimalSource</code> and <code>maximalSource</code>, in the <code>/projects</code> folder.</p> <p>Adding a new Layout is done by calling the static function, <a href="Panel.html#static-definePanelLayout">Panel.definePanelLayout</a>:</p> <pre><code class="language-js"><span style="color: #9CDCFE">Panel</span><span style="color: #D4D4D4">.</span><span style="color: #DCDCAA">definePanelLayout</span><span style="color: #D4D4D4">(</span><span style="color: #CE9178">&#039;Table&#039;</span><span style="color: #D4D4D4">, </span><span style="color: #569CD6">new</span><span style="color: #D4D4D4"> </span><span style="color: #DCDCAA">PanelLayoutTable</span><span style="color: #D4D4D4">());</span> </code></pre> <p>Each PanelLayout defines a <a href="PanelLayout.html#measure">measure</a> and <a href="PanelLayout.html#arrange">arrange</a> routine. The measure routine must call <a href="PanelLayout.html#measureElement">measureElement</a> with each element of the Panel, and the arrange routine must similarly call <a href="PanelLayout.html#arrangeElement">arrangeElement</a> with each element of the Panel.</p> <p>There is an example PanelLayout in the <a href="../../samples/panelLayout.html">PanelLayout sample</a>.</p> <dl class="tsd-comment-tags"> <dt>since</dt> <dd><p>2.0</p> </dd> </dl> </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>Constructors</h3> <ul class="tsd-index-list"> <li class="tsd-kind-constructor tsd-parent-kind-class"><a href="PanelLayout.html#constructor" class="tsd-kind-icon">constructor</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="PanelLayout.html#arrange" class="tsd-kind-icon">arrange</a></li> <li class="tsd-kind-method tsd-parent-kind-class tsd-is-protected"><a href="PanelLayout.html#arrangeElement" class="tsd-kind-icon">arrange<wbr>Element</a></li> <li class="tsd-kind-method tsd-parent-kind-class"><a href="PanelLayout.html#measure" class="tsd-kind-icon">measure</a></li> <li class="tsd-kind-method tsd-parent-kind-class tsd-is-protected"><a href="PanelLayout.html#measureElement" class="tsd-kind-icon">measure<wbr>Element</a></li> </ul> </section> </div> </section> </section> <section class="tsd-panel-group tsd-member-group "> <h2>Constructors</h2> <section class="tsd-panel tsd-member tsd-kind-constructor tsd-parent-kind-class"> <a name="constructor" class="tsd-anchor"></a> <h3> constructor </h3> <ul class="tsd-signatures tsd-kind-constructor tsd-parent-kind-class"> <li class="tsd-signature tsd-kind-icon">new <wbr>Panel<wbr>Layout<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="PanelLayout.html" class="tsd-signature-type" data-tsd-kind="Class">PanelLayout</a></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <h4 class="tsd-returns-title">Returns <a href="PanelLayout.html" class="tsd-signature-type" data-tsd-kind="Class">PanelLayout</a></h4> </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="arrange" class="tsd-anchor"></a> <h3> <span class="tsd-flag ts-flagVirtual">Virtual</span> arrange </h3> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"> <li class="tsd-signature tsd-kind-icon">arrange<span class="tsd-signature-symbol">(</span>panel<span class="tsd-signature-symbol">: </span><a href="Panel.html" class="tsd-signature-type" data-tsd-kind="Class">Panel</a>, elements<span class="tsd-signature-symbol">: </span><a href="GraphObject.html" class="tsd-signature-type" data-tsd-kind="Class">GraphObject</a><span class="tsd-signature-symbol">[]</span>, union<span class="tsd-signature-symbol">: </span><a href="Rect.html" class="tsd-signature-type" data-tsd-kind="Class">Rect</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <div class="tsd-comment tsd-typography"> <p>Given the panel and its list of elements, arrange each element.</p> <p>This must call <a href="PanelLayout.html#arrangeElement">arrangeElement</a> with each Panel element, which will set that element&#39;s <a href="GraphObject.html#actualBounds">GraphObject.actualBounds</a>.</p> <p>For arranging some elements, it is useful to know the total unioned area of every element. This Rect can be used to right-align or center-align, etc, elements within an area.</p> </div> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5>panel: <a href="Panel.html" class="tsd-signature-type" data-tsd-kind="Class">Panel</a></h5> <div class="tsd-comment tsd-typography"> <p>Panel which called this layout</p> </div> </li> <li> <h5>elements: <a href="GraphObject.html" class="tsd-signature-type" data-tsd-kind="Class">GraphObject</a><span class="tsd-signature-symbol">[]</span></h5> <div class="tsd-comment tsd-typography"> <p>Array of Panel elements</p> </div> </li> <li> <h5>union: <a href="Rect.html" class="tsd-signature-type" data-tsd-kind="Class">Rect</a></h5> <div class="tsd-comment tsd-typography"> <p>rectangle, if properly constructed in <a href="PanelLayout.html#measure">measure</a>, that contains the expected union bounds of every element in the Panel.</p> </div> </li> </ul> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4> </li> </ul> </section> <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-protected"> <a name="arrangeElement" class="tsd-anchor"></a> <h3> <span class="tsd-flag ts-flagProtected">Protected</span> arrange<wbr>Element </h3> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-protected"> <li class="tsd-signature tsd-kind-icon">arrange<wbr>Element<span class="tsd-signature-symbol">(</span>obj<span class="tsd-signature-symbol">: </span><a href="GraphObject.html" class="tsd-signature-type" data-tsd-kind="Class">GraphObject</a>, fx<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span>, fy<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span>, fw<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span>, fh<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span>, clipRect<span class="tsd-signature-symbol">?: </span><a href="Rect.html" class="tsd-signature-type" data-tsd-kind="Class">Rect</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <div class="tsd-comment tsd-typography"> <p>Arranges the GraphObject onto its parent Panel. The passed-in numbers typically account for <a href="GraphObject.html#margin">GraphObject.margin</a> and other offsets. This sets <a href="GraphObject.html#actualBounds">GraphObject.actualBounds</a>.</p> </div> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5>obj: <a href="GraphObject.html" class="tsd-signature-type" data-tsd-kind="Class">GraphObject</a></h5> <div class="tsd-comment tsd-typography"> <p>GraphObject to be arranged.</p> </div> </li> <li> <h5>fx: <span class="tsd-signature-type">number</span></h5> <div class="tsd-comment tsd-typography"> <p>The final x value of actualBounds that the Panel computes for the GraphObject.</p> </div> </li> <li> <h5>fy: <span class="tsd-signature-type">number</span></h5> <div class="tsd-comment tsd-typography"> <p>The final y value of actualBounds that the Panel computes for the GraphObject.</p> </div> </li> <li> <h5>fw: <span class="tsd-signature-type">number</span></h5> <div class="tsd-comment tsd-typography"> <p>The final width value of actualBounds that the Panel computes for the GraphObject.</p> </div> </li> <li> <h5>fh: <span class="tsd-signature-type">number</span></h5> <div class="tsd-comment tsd-typography"> <p>The final height value of actualBounds that the Panel computes for the GraphObject.</p> </div> </li> <li> <h5><span class="tsd-flag ts-flagOptional">Optional</span> clipRect: <a href="Rect.html" class="tsd-signature-type" data-tsd-kind="Class">Rect</a></h5> <div class="tsd-comment tsd-typography"> <p>an optional area to constrain this actualBounds to when picking and drawing. By default, this is only used with Fixed/Table panels element, provided as a Rect.</p> </div> </li> </ul> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4> </li> </ul> </section> <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"> <a name="measure" class="tsd-anchor"></a> <h3> <span class="tsd-flag ts-flagVirtual">Virtual</span> measure </h3> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"> <li class="tsd-signature tsd-kind-icon">measure<span class="tsd-signature-symbol">(</span>panel<span class="tsd-signature-symbol">: </span><a href="Panel.html" class="tsd-signature-type" data-tsd-kind="Class">Panel</a>, width<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span>, height<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span>, elements<span class="tsd-signature-symbol">: </span><a href="GraphObject.html" class="tsd-signature-type" data-tsd-kind="Class">GraphObject</a><span class="tsd-signature-symbol">[]</span>, union<span class="tsd-signature-symbol">: </span><a href="Rect.html" class="tsd-signature-type" data-tsd-kind="Class">Rect</a>, minw<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span>, minh<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <div class="tsd-comment tsd-typography"> <p>Given the available size, measure the Panel and determine its expected drawing size. Sets the measuredBounds of the object.</p> <p>This must call <a href="PanelLayout.html#measureElement">measureElement</a> with each Panel element.</p> <p>This must also construct the union.width and union.height of the passed in union Rect argument. This union must reflect the measured size of the panel.</p> </div> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5>panel: <a href="Panel.html" class="tsd-signature-type" data-tsd-kind="Class">Panel</a></h5> <div class="tsd-comment tsd-typography"> <p>Panel which called this layout</p> </div> </li> <li> <h5>width: <span class="tsd-signature-type">number</span></h5> <div class="tsd-comment tsd-typography"> <p>expected width of the panel</p> </div> </li> <li> <h5>height: <span class="tsd-signature-type">number</span></h5> <div class="tsd-comment tsd-typography"> <p>expected height of the panel</p> </div> </li> <li> <h5>elements: <a href="GraphObject.html" class="tsd-signature-type" data-tsd-kind="Class">GraphObject</a><span class="tsd-signature-symbol">[]</span></h5> <div class="tsd-comment tsd-typography"> <p>Array of Panel elements</p> </div> </li> <li> <h5>union: <a href="Rect.html" class="tsd-signature-type" data-tsd-kind="Class">Rect</a></h5> <div class="tsd-comment tsd-typography"> <p>rectangle to contain the expected union bounds of every element in the Panel. Useful for arrange.</p> </div> </li> <li> <h5>minw: <span class="tsd-signature-type">number</span></h5> <div class="tsd-comment tsd-typography"> <p>minimum width of the panel</p> </div> </li> <li> <h5>minh: <span class="tsd-signature-type">number</span></h5> <div class="tsd-comment tsd-typography"> <p>minimum height of the panel</p> </div> </li> </ul> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4> </li> </ul> </section> <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-protected"> <a name="measureElement" class="tsd-anchor"></a> <h3> <span class="tsd-flag ts-flagProtected">Protected</span> measure<wbr>Element </h3> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-protected"> <li class="tsd-signature tsd-kind-icon">measure<wbr>Element<span class="tsd-signature-symbol">(</span>obj<span class="tsd-signature-symbol">: </span><a href="GraphObject.html" class="tsd-signature-type" data-tsd-kind="Class">GraphObject</a>, width<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span>, height<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span>, minw<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span>, minh<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <div class="tsd-comment tsd-typography"> <p>Given the available size, measure one element of the Panel and determine its expected drawing size. Sets the measuredBounds of the object.</p> </div> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5>obj: <a href="GraphObject.html" class="tsd-signature-type" data-tsd-kind="Class">GraphObject</a></h5> <div class="tsd-comment tsd-typography"> <p>Panel which called this layout</p> </div> </li> <li> <h5>width: <span class="tsd-signature-type">number</span></h5> <div class="tsd-comment tsd-typography"> <p>expected width of the GraphObject</p> </div> </li> <li> <h5>height: <span class="tsd-signature-type">number</span></h5> <div class="tsd-comment tsd-typography"> <p>expected height of the GraphObject</p> </div> </li> <li> <h5>minw: <span class="tsd-signature-type">number</span></h5> <div class="tsd-comment tsd-typography"> <p>minimum width of the GraphObject</p> </div> </li> <li> <h5>minh: <span class="tsd-signature-type">number</span></h5> <div class="tsd-comment tsd-typography"> <p>minimum height of the GraphObject</p> </div> </li> </ul> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</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=" "> <a href="../index.html">GoJS <wbr>Class <wbr>Index</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"> <a href="PanelLayout.html" class="tsd-kind-icon">Panel<wbr>Layout</a> <ul> <li class=" tsd-kind-constructor tsd-parent-kind-class"> <a href="PanelLayout.html#constructor" class="tsd-kind-icon">constructor</a> </li> <li class=" tsd-kind-method tsd-parent-kind-class"> <a href="PanelLayout.html#arrange" class="tsd-kind-icon">arrange</a> </li> <li class=" tsd-kind-method tsd-parent-kind-class tsd-is-protected"> <a href="PanelLayout.html#arrangeElement" class="tsd-kind-icon">arrange<wbr>Element</a> </li> <li class=" tsd-kind-method tsd-parent-kind-class"> <a href="PanelLayout.html#measure" class="tsd-kind-icon">measure</a> </li> <li class=" tsd-kind-method tsd-parent-kind-class tsd-is-protected"> <a href="PanelLayout.html#measureElement" class="tsd-kind-icon">measure<wbr>Element</a> </li> </ul> </li> </ul> <ul class="after-current"> </ul> </nav> </div> </div> </div> <div class="container bottom-copyright plr15"> Copyright &copy; 1998-2021 by Northwoods Software Corporation. </div> <div class="overlay"></div> <script src="../assets/js/main.js"></script> <script async src="https://www.googletagmanager.com/gtag/js?id=UA-1506307-5"></script> <script> window.dataLayer = window.dataLayer || []; function gtag(){dataLayer.push(arguments);} gtag('js', new Date()); gtag('config', 'UA-1506307-5'); // topnav var topButton = document.getElementById("topnavButton"); var topnavList = document.getElementById("topnavList"); topButton.addEventListener("click", function() { this.classList.toggle("active"); topnavList.classList.toggle("hidden"); document.getElementById("topnavOpen").classList.toggle("hidden"); document.getElementById("topnavClosed").classList.toggle("hidden"); }); </script> </body> </html>