gojs
Version:
Interactive diagrams, charts, and graphs, such as trees, flowcharts, orgcharts, UML, BPMN, or business diagrams
50 lines (48 loc) • 20.4 kB
HTML
<html class="default"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>ForceDirectedVertex | 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/style.css"/><link rel="stylesheet" href="../assets/style-tsd.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script async src="../assets/search.js" id="search-script"></script></head><body><script>document.body.classList.add(localStorage.getItem("tsd-theme") || "os")</script><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\n font-bold text-2xl lg:text-4xl rounded-lg hover:bg-nwoods-secondary" href="../../index.html"><h1 class="my-0 p-1 leading-none">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 font-semibold 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/index.html">Learn</a></li><li class="p-1 sm:p-0"><a class="topnav-link" href="../../samples/index.html">Samples</a></li><li class="p-1 sm:p-0"><a class="topnav-link" href="../../intro/index.html">Intro</a></li><li class="p-1 sm:p-0"><a class="topnav-link" href="../../api/index.html">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" target="_blank" rel="noopener" id="contactBtn">Contact</a></li><li class="p-1 sm:p-0"><a class="topnav-link" href="https://www.nwoods.com/sales/index.html" target="_blank" rel="noopener" id="buyBtn">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="w-full max-w-screen-xl mx-auto px-2"><div class="table-wrap"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget search no-caption">Search</label><input type="text" id="tsd-search-field"/></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> <input type="checkbox" id="tsd-filter-inherited"/><label class="tsd-widget" for="tsd-filter-inherited">Inherited</label></div></div><a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a></div></div></div></div></div><div class="tsd-page-title"><div class="w-full max-w-screen-xl mx-auto px-2"><div class="top-copyright"><b>GoJS</b>® Diagramming Components<br/>version 2.3.8<br/>by <a href="https://www.nwoods.com/">Northwoods Software®</a></div><div><h1>Class ForceDirectedVertex </h1></div></div></div></header><div class="tsd w-full max-w-screen-xl mx-auto pb-4"><div class="row px-2 w-full"><div class="col-8 col-content"><section class="tsd-panel tsd-hierarchy"><h3>Hierarchy</h3><ul class="tsd-hierarchy"><li><a href="LayoutVertex.html" class="tsd-signature-type" data-tsd-kind="Class">LayoutVertex</a><ul class="tsd-hierarchy"><li><span class="target">ForceDirectedVertex</span></li></ul></li></ul></section><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography">
<p>This holds <a href="ForceDirectedLayout.html">ForceDirectedLayout</a>-specific information about <a href="Node.html">Node</a>s.</p>
<div><p>This class inherits from <a href="LayoutVertex.html">LayoutVertex</a>.</p>
</div></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 tsd-is-overwrite"><a href="ForceDirectedVertex.html#constructor" class="tsd-kind-icon">constructor</a></li></ul></section><section class="tsd-index-section "><h3>Properties</h3><ul class="tsd-index-list"><li class="tsd-kind-accessor tsd-parent-kind-class"><a href="ForceDirectedVertex.html#charge" class="tsd-kind-icon">charge</a></li><li class="tsd-kind-accessor tsd-parent-kind-class"><a href="ForceDirectedVertex.html#forceX" class="tsd-kind-icon">forceX</a></li><li class="tsd-kind-accessor tsd-parent-kind-class"><a href="ForceDirectedVertex.html#forceY" class="tsd-kind-icon">forceY</a></li><li class="tsd-kind-accessor tsd-parent-kind-class"><a href="ForceDirectedVertex.html#isFixed" class="tsd-kind-icon">is<wbr/>Fixed</a></li><li class="tsd-kind-accessor tsd-parent-kind-class"><a href="ForceDirectedVertex.html#mass" class="tsd-kind-icon">mass</a></li></ul></section></div></section></section><section class="tsd-panel-group tsd-index-group tsd-is-inherited"><h2>Inherited Members</h2><section class="tsd-panel tsd-index-panel"><div class="tsd-index-content"><section class="tsd-index-section undefined"><h3>Properties</h3><ul class="tsd-index-list"><li class="tsd-kind-accessor tsd-parent-kind-class"><a href="LayoutVertex.html#bounds" class="tsd-kind-icon">Layout<wbr/>Vertex.bounds</a></li><li class="tsd-kind-accessor tsd-parent-kind-class"><a href="LayoutVertex.html#centerX" class="tsd-kind-icon">Layout<wbr/>Vertex.centerX</a></li><li class="tsd-kind-accessor tsd-parent-kind-class"><a href="LayoutVertex.html#centerY" class="tsd-kind-icon">Layout<wbr/>Vertex.centerY</a></li><li class="tsd-kind-accessor tsd-parent-kind-class"><a href="LayoutVertex.html#data" class="tsd-kind-icon">Layout<wbr/>Vertex.data</a></li><li class="tsd-kind-get-signature tsd-parent-kind-class"><a href="LayoutVertex.html#destinationEdges" class="tsd-kind-icon">Layout<wbr/>Vertex.destination<wbr/>Edges</a></li><li class="tsd-kind-get-signature tsd-parent-kind-class"><a href="LayoutVertex.html#destinationVertexes" class="tsd-kind-icon">Layout<wbr/>Vertex.destination<wbr/>Vertexes</a></li><li class="tsd-kind-get-signature tsd-parent-kind-class"><a href="LayoutVertex.html#edges" class="tsd-kind-icon">Layout<wbr/>Vertex.edges</a></li><li class="tsd-kind-get-signature tsd-parent-kind-class"><a href="LayoutVertex.html#edgesCount" class="tsd-kind-icon">Layout<wbr/>Vertex.edges<wbr/>Count</a></li><li class="tsd-kind-accessor tsd-parent-kind-class"><a href="LayoutVertex.html#focus" class="tsd-kind-icon">Layout<wbr/>Vertex.focus</a></li><li class="tsd-kind-accessor tsd-parent-kind-class"><a href="LayoutVertex.html#focusX" class="tsd-kind-icon">Layout<wbr/>Vertex.focusX</a></li><li class="tsd-kind-accessor tsd-parent-kind-class"><a href="LayoutVertex.html#focusY" class="tsd-kind-icon">Layout<wbr/>Vertex.focusY</a></li><li class="tsd-kind-accessor tsd-parent-kind-class"><a href="LayoutVertex.html#height" class="tsd-kind-icon">Layout<wbr/>Vertex.height</a></li><li class="tsd-kind-accessor tsd-parent-kind-class"><a href="LayoutVertex.html#network" class="tsd-kind-icon">Layout<wbr/>Vertex.network</a></li><li class="tsd-kind-accessor tsd-parent-kind-class"><a href="LayoutVertex.html#node" class="tsd-kind-icon">Layout<wbr/>Vertex.node</a></li><li class="tsd-kind-get-signature tsd-parent-kind-class"><a href="LayoutVertex.html#sourceEdges" class="tsd-kind-icon">Layout<wbr/>Vertex.source<wbr/>Edges</a></li><li class="tsd-kind-get-signature tsd-parent-kind-class"><a href="LayoutVertex.html#sourceVertexes" class="tsd-kind-icon">Layout<wbr/>Vertex.source<wbr/>Vertexes</a></li><li class="tsd-kind-get-signature tsd-parent-kind-class"><a href="LayoutVertex.html#vertexes" class="tsd-kind-icon">Layout<wbr/>Vertex.vertexes</a></li><li class="tsd-kind-accessor tsd-parent-kind-class"><a href="LayoutVertex.html#width" class="tsd-kind-icon">Layout<wbr/>Vertex.width</a></li><li class="tsd-kind-accessor tsd-parent-kind-class"><a href="LayoutVertex.html#x" class="tsd-kind-icon">Layout<wbr/>Vertex.x</a></li><li class="tsd-kind-accessor tsd-parent-kind-class"><a href="LayoutVertex.html#y" class="tsd-kind-icon">Layout<wbr/>Vertex.y</a></li></ul></section><section class="tsd-index-section undefined"><h3>Methods</h3><ul class="tsd-index-list"><li class="tsd-kind-method tsd-parent-kind-class"><a href="LayoutVertex.html#addDestinationEdge" class="tsd-kind-icon">Layout<wbr/>Vertex.add<wbr/>Destination<wbr/>Edge</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="LayoutVertex.html#addSourceEdge" class="tsd-kind-icon">Layout<wbr/>Vertex.add<wbr/>Source<wbr/>Edge</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="LayoutVertex.html#commit" class="tsd-kind-icon">Layout<wbr/>Vertex.commit</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="LayoutVertex.html#deleteDestinationEdge" class="tsd-kind-icon">Layout<wbr/>Vertex.delete<wbr/>Destination<wbr/>Edge</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="LayoutVertex.html#deleteSourceEdge" class="tsd-kind-icon">Layout<wbr/>Vertex.delete<wbr/>Source<wbr/>Edge</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 tsd-is-overwrite"><a id="constructor" class="tsd-anchor"></a><h3 class="tsd-anchor-link"> constructor<a href="#constructor" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><ul class="tsd-signatures tsd-kind-constructor tsd-parent-kind-class tsd-is-overwrite"><li class="tsd-signature tsd-kind-icon">new <wbr/>Force<wbr/>Directed<wbr/>Vertex<span class="tsd-signature-symbol">(</span>network<span class="tsd-signature-symbol">: </span><a href="ForceDirectedNetwork.html" class="tsd-signature-type" data-tsd-kind="Class">ForceDirectedNetwork</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="ForceDirectedVertex.html" class="tsd-signature-type" data-tsd-kind="Class">ForceDirectedVertex</a></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><div class="tsd-comment tsd-typography">
<p>This constructs a vertex that does not know about any <a href="Node.html">Node</a>.</p>
</div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>network: <a href="ForceDirectedNetwork.html" class="tsd-signature-type" data-tsd-kind="Class">ForceDirectedNetwork</a></h5></li></ul><h4 class="tsd-returns-title">Returns <a href="ForceDirectedVertex.html" class="tsd-signature-type" data-tsd-kind="Class">ForceDirectedVertex</a></h4></li></ul></section></section><section class="tsd-panel-group tsd-member-group "><h2>Properties</h2><section class="tsd-panel tsd-member tsd-kind-accessor tsd-parent-kind-class"><a id="charge" class="tsd-anchor"></a><h3 class="tsd-anchor-link"> charge<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><a href="#charge" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><ul class="tsd-descriptions"><li class="tsd-description"><div class="tsd-comment tsd-typography">
<p>Gets or sets the electrical charge for this vertex.
The default value is NaN.</p>
</div></li></ul></section><section class="tsd-panel tsd-member tsd-kind-accessor tsd-parent-kind-class"><a id="forceX" class="tsd-anchor"></a><h3 class="tsd-anchor-link"> forceX<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><a href="#forceX" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><ul class="tsd-descriptions"><li class="tsd-description"><div class="tsd-comment tsd-typography">
<p>Gets or sets the cumulative force on the vertex in the X direction.
The default value is zero.</p>
</div></li></ul></section><section class="tsd-panel tsd-member tsd-kind-accessor tsd-parent-kind-class"><a id="forceY" class="tsd-anchor"></a><h3 class="tsd-anchor-link"> forceY<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><a href="#forceY" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><ul class="tsd-descriptions"><li class="tsd-description"><div class="tsd-comment tsd-typography">
<p>Gets or sets the cumulative force on the vertex in the Y direction.
The default value is zero.</p>
</div></li></ul></section><section class="tsd-panel tsd-member tsd-kind-accessor tsd-parent-kind-class"><a id="isFixed" class="tsd-anchor"></a><h3 class="tsd-anchor-link"> is<wbr/>Fixed<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span><a href="#isFixed" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><ul class="tsd-descriptions"><li class="tsd-description"><div class="tsd-comment tsd-typography">
<p>Gets or sets whether the vertex may be moved by any forces.
The default value is false.</p>
</div></li></ul></section><section class="tsd-panel tsd-member tsd-kind-accessor tsd-parent-kind-class"><a id="mass" class="tsd-anchor"></a><h3 class="tsd-anchor-link"> mass<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><a href="#mass" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><ul class="tsd-descriptions"><li class="tsd-description"><div class="tsd-comment tsd-typography">
<p>Gets or sets the gravitational mass for this vertex.
The default value is NaN.</p>
</div></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 Class Index</a></li></ul></nav><nav class="tsd-navigation secondary menu-sticky"><ul><li class="current tsd-kind-class"><a href="ForceDirectedVertex.html" class="tsd-kind-icon">Force<wbr/>Directed<wbr/>Vertex</a><ul><li class="tsd-kind-constructor tsd-parent-kind-class tsd-is-overwrite"><a href="ForceDirectedVertex.html#constructor" class="tsd-kind-icon">constructor</a></li><li class="tsd-kind-accessor tsd-parent-kind-class"><a href="ForceDirectedVertex.html#charge" class="tsd-kind-icon">charge</a></li><li class="tsd-kind-accessor tsd-parent-kind-class"><a href="ForceDirectedVertex.html#forceX" class="tsd-kind-icon">forceX</a></li><li class="tsd-kind-accessor tsd-parent-kind-class"><a href="ForceDirectedVertex.html#forceY" class="tsd-kind-icon">forceY</a></li><li class="tsd-kind-accessor tsd-parent-kind-class"><a href="ForceDirectedVertex.html#isFixed" class="tsd-kind-icon">is<wbr/>Fixed</a></li><li class="tsd-kind-accessor tsd-parent-kind-class"><a href="ForceDirectedVertex.html#mass" class="tsd-kind-icon">mass</a></li></ul></li></ul></nav></div></div></div><div class="tsd w-full max-w-screen-xl mx-auto px-2"><div class="bottom-copyright">Copyright © 1998-2022 by Northwoods Software Corporation.</div></div><footer class=""><div class="tsd w-full max-w-screen-xl mx-auto px-2"><h2>Settings</h2><p class="mb-4">Theme <select id="theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></p></div></footer><div class="overlay"></div><script src="../assets/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');
var getOutboundLink = function(url, label) {
gtag('event', 'click', {
'event_category': 'outbound',
'event_label': label,
'transport_type': 'beacon'
});
}
// 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");
});
document.getElementById("contactBtn").addEventListener("click", function() {
getOutboundLink('https://www.nwoods.com/contact.html', 'contact');
});
document.getElementById("buyBtn").addEventListener("click", function() {
getOutboundLink('https://www.nwoods.com/sales/index.html', 'buy');
});
</script></body></html>