You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
2542 lines
152 KiB
2542 lines
152 KiB
<!doctype html>
|
|
<html class="default no-js">
|
|
<head>
|
|
<meta charset="utf-8">
|
|
<meta http-equiv="X-UA-Compatible" content="IE=edge">
|
|
<title>Link | 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>
|
|
<!-- non-fixed navbar -->
|
|
<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><!--/.nav-collapse -->
|
|
</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 <br/>version 2.0.17 for TypeScript/HTML<br/>by <a href="https://www.nwoods.com/">Northwoods Software®</a>-->
|
|
<b>GoJS</b>® Diagramming Components<br/>version 2.0.17<br/>by <a href="https://www.nwoods.com/">Northwoods Software®</a>
|
|
</div>
|
|
<div>
|
|
<h1>Class Link</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-hierarchy">
|
|
<h3>Hierarchy</h3>
|
|
<ul class="tsd-hierarchy">
|
|
<li>
|
|
<a href="GraphObject.html" class="tsd-signature-type">GraphObject</a>
|
|
<ul class="tsd-hierarchy">
|
|
<li>
|
|
<a href="Panel.html" class="tsd-signature-type">Panel</a>
|
|
<ul class="tsd-hierarchy">
|
|
<li>
|
|
<a href="Part.html" class="tsd-signature-type">Part</a>
|
|
<ul class="tsd-hierarchy">
|
|
<li>
|
|
<span class="target">Link</span>
|
|
<ul class="tsd-hierarchy">
|
|
<li>
|
|
<a href="BalloonLink.html" class="tsd-signature-type">BalloonLink</a>
|
|
</li>
|
|
<li>
|
|
<a href="DimensioningLink.html" class="tsd-signature-type">DimensioningLink</a>
|
|
</li>
|
|
<li>
|
|
<a href="FishboneLink.html" class="tsd-signature-type">FishboneLink</a>
|
|
</li>
|
|
<li>
|
|
<a href="ParallelRouteLink.html" class="tsd-signature-type">ParallelRouteLink</a>
|
|
</li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-panel tsd-comment">
|
|
<div class="tsd-comment tsd-typography">
|
|
<p>A Link is a <a href="Part.html">Part</a> that connects <a href="Node.html">Node</a>s.
|
|
The link relationship is directional, going from <a href="Link.html#fromNode">Link.fromNode</a> to <a href="Link.html#toNode">Link.toNode</a>.
|
|
A link can connect to a specific port element in a node, as named by the <a href="Link.html#fromPortId">Link.fromPortId</a>
|
|
and <a href="Link.html#toPortId">Link.toPortId</a> properties.</p>
|
|
<p class="boxread">
|
|
For more discussion, see <a href="../../intro/links.html">Introduction to Links</a>.
|
|
<p>To add a Link to a Diagram when using a <a href="GraphLinksModel.html">GraphLinksModel</a> you should do something like:</p>
|
|
<pre><code class="hljs js"> myDiagram.startTransaction(<span class="hljs-string">"make new link"</span>);
|
|
myDiagram.model.addLinkData({ <span class="hljs-attr">from</span>: <span class="hljs-string">"Alpha"</span>, <span class="hljs-attr">to</span>: <span class="hljs-string">"Beta"</span> });
|
|
myDiagram.commitTransaction(<span class="hljs-string">"make new link"</span>);</code></pre>
|
|
<p>where you would substitute the keys of the actual nodes that you want to connect with a link.
|
|
This will cause a Link to be created (copying the template found in <a href="Diagram.html#linkTemplateMap">Diagram.linkTemplateMap</a>),
|
|
added to the Diagram in some <a href="Layer.html">Layer</a> (based on <a href="Part.html#layerName">Part.layerName</a>), and bound to the link data
|
|
(resulting in <a href="Panel.html#data">Panel.data</a> referring to that link data object).
|
|
Note that link data objects, unlike <a href="Node.html">Node</a> data, do not have their own unique keys or identifiers,
|
|
because other Parts do not refer to them.</p>
|
|
<p>If you are using a <a href="TreeModel.html">TreeModel</a>, there are no link data objects, so you just need to call
|
|
<a href="TreeModel.html#setParentKeyForNodeData">TreeModel.setParentKeyForNodeData</a> to specify the "parent" node's key for a "child" node data.</p>
|
|
<p>To find a <a href="Link.html">Link</a> given a link data object in the <a href="GraphLinksModel.html">GraphLinksModel</a>,
|
|
call <a href="Diagram.html#findLinkForData">Diagram.findLinkForData</a>. When using a <a href="TreeModel.html">TreeModel</a>, call either <a href="Diagram.html#findNodeForData">Diagram.findNodeForData</a>
|
|
or <a href="Diagram.html#findNodeForKey">Diagram.findNodeForKey</a> to get a Node, and then call <a href="Node.html#findTreeParentLink">Node.findTreeParentLink</a> to get the Link, if any exists.</p>
|
|
<p>To find a link that connects two nodes, call <a href="Node.html#findLinksTo">Node.findLinksTo</a> or <a href="Node.html#findLinksBetween">Node.findLinksBetween</a>.
|
|
With the former method, the direction matters; with the latter method it returns links in either direction.</p>
|
|
<p>A link's position and size are determined by the two nodes that it connects.
|
|
Normally there should be a <a href="Shape.html">Shape</a> as the main element in this Link.
|
|
This shape is what users will see as the "line" or "wire" --
|
|
you can set its <a href="Shape.html#stroke">Shape.stroke</a> and other "stroke..." properties to control its appearance.</p>
|
|
<p>The link will compute a route (a sequence of points) going from the <a href="Link.html#fromNode">fromNode</a>'s port element
|
|
to the <a href="Link.html#toNode">toNode</a>'s port element.
|
|
That route is used to generate the path of the main shape.
|
|
Properties that affect the nature of the route and the geometry of the path include:</p>
|
|
<ul>
|
|
<li><a href="Link.html#curve">curve</a></li>
|
|
<li><a href="Link.html#curviness">curviness</a></li>
|
|
<li><a href="Link.html#corner">corner</a></li>
|
|
<li><a href="Link.html#routing">routing</a></li>
|
|
<li><a href="Link.html#smoothness">smoothness</a></li>
|
|
<li><a href="Link.html#adjusting">adjusting</a></li>
|
|
</ul>
|
|
<p class="boxread">
|
|
For more discussion and examples, see <a href="../../intro/links.html">Links</a>.
|
|
<p>There are additional properties that affect how the end of the link connects to a port element of a node.
|
|
There are duplicate properties, ones for the "to" end and ones for the "from" end:</p>
|
|
<ul>
|
|
<li><a href="Link.html#fromSpot">fromSpot</a>, <a href="Link.html#toSpot">toSpot</a></li>
|
|
<li><a href="Link.html#fromEndSegmentLength">fromEndSegmentLength</a>, <a href="Link.html#toEndSegmentLength">toEndSegmentLength</a></li>
|
|
<li><a href="Link.html#fromShortLength">fromShortLength</a>, <a href="Link.html#toShortLength">toShortLength</a></li>
|
|
</ul>
|
|
<p>These properties normally have "default" values, causing the link's routing and path-geometry generating
|
|
to get the corresponding values from the connected port element.
|
|
This scheme permits an individual link to have its own specific connection to a port,
|
|
taking precedence over how the port normally expects links to connect to it.
|
|
For example, several of the <a href="Layout.html">Layout</a> classes sets these properties on each Link
|
|
as part of their route computation for links.</p>
|
|
<p class="boxread">
|
|
For more discussion and examples, see <a href="../../intro/connectionPoints.html">Link Points</a>.
|
|
<p>Elements other than the main <a href="Shape.html">Shape</a> in the Link may act as decorations on the link, including arrowheads and labels.
|
|
You can control where they are located along the link route and how they are oriented.
|
|
Because these decorations may be any <a href="GraphObject.html">GraphObject</a>, they are all properties of that class.
|
|
The properties include:</p>
|
|
<ul>
|
|
<li><a href="GraphObject.html#segmentIndex">GraphObject.segmentIndex</a></li>
|
|
<li><a href="GraphObject.html#segmentFraction">GraphObject.segmentFraction</a></li>
|
|
<li><a href="GraphObject.html#segmentOffset">GraphObject.segmentOffset</a></li>
|
|
<li><a href="GraphObject.html#segmentOrientation">GraphObject.segmentOrientation</a></li>
|
|
</ul>
|
|
<p>If you do not set the <a href="GraphObject.html#segmentIndex">GraphObject.segmentIndex</a> property, the object is positioned
|
|
to be at the middle of the link.</p>
|
|
<p class="boxread">
|
|
For more discussion and examples, see <a href="../../intro/linkLabels.html">Link Labels</a>.
|
|
<p><strong>GoJS</strong> makes it easy to add arrowheads to your link template.
|
|
Just add a <a href="Shape.html">Shape</a> with the appearance properties that you want,
|
|
and also set the <a href="Shape.html#toArrow">Shape.toArrow</a> or <a href="Shape.html#fromArrow">Shape.fromArrow</a> property
|
|
to the name of the kind of arrowhead that you want.
|
|
Doing so automatically sets the "segment..." properties that are appropriate for the chosen arrowhead.</p>
|
|
<p>More than one shape may automatically get the route geometry.
|
|
This is useful when you want to have multiple link shapes with different thicknesses
|
|
to create a gradient effect across the path of the link or to produce parallel lines along the path.
|
|
Just set <a href="GraphObject.html#isPanelMain">GraphObject.isPanelMain</a> to true on each such <a href="Shape.html">Shape</a>.</p>
|
|
<p>If you want the user to be able to reconnect a link, using the <a href="RelinkingTool.html">RelinkingTool</a>,
|
|
you need to set one or both of <a href="Link.html#relinkableFrom">relinkableFrom</a> and <a href="Link.html#relinkableTo">relinkableTo</a> to true.
|
|
The <a href="RelinkingTool.html">RelinkingTool</a> shows a <a href="RelinkingTool.html#fromHandleArchetype">RelinkingTool.fromHandleArchetype</a> and/or a
|
|
<a href="RelinkingTool.html#toHandleArchetype">RelinkingTool.toHandleArchetype</a> when the link is selected.
|
|
Such a relink handle can be dragged by the user to start a relinking operation.</p>
|
|
<p>If you want the user to be able to change the path of the link, using the <a href="LinkReshapingTool.html">LinkReshapingTool</a>,
|
|
set <a href="Part.html#reshapable">Part.reshapable</a> to true.
|
|
The <a href="LinkReshapingTool.html">LinkReshapingTool</a> shows reshape handles that the user can drag to shift the position
|
|
of a point in the link's route.
|
|
The <a href="LinkReshapingTool.html#handleArchetype">LinkReshapingTool.handleArchetype</a> is copied for each reshape handle.</p>
|
|
<p>Often if a Link is reshapable, you will want to save the route in the model so that it can be restored
|
|
upon load. To save the route automatically, add a TwoWay Binding on the <a href="Link.html#points">points</a> property:
|
|
<code>new go.Binding("points").makeTwoWay()</code>. <a href="Model.html#toJson">Model.toJson</a> will automatically
|
|
convert the <a href="List.html">List</a> of <a href="Point.html">Point</a>s into an Array of numbers in the JSON representation,
|
|
if the property is named "points".</p>
|
|
<p>If a Link is <a href="Part.html#reshapable">Part.reshapable</a>, it is also possible to allow the user to add and remove segments
|
|
from the link's route by setting <a href="Link.html#resegmentable">resegmentable</a> to true.
|
|
This causes the <a href="LinkReshapingTool.html">LinkReshapingTool</a> to add resegmenting handles at the midpoints of each segment.
|
|
The <a href="LinkReshapingTool.html#midHandleArchetype">LinkReshapingTool.midHandleArchetype</a> is copied for each resegment handle.
|
|
When the user drags such a resegmenting handle, a new segment is inserted into the route.
|
|
Also, when the user drags a reshape handle such that two adjacent segments end up in a straight line,
|
|
a segment is removed from the route.</p>
|
|
<p class="boxread">
|
|
For more discussion and examples, see <a href="../../intro/links.html">Links</a>,
|
|
<a href="../../intro/linkLabels.html">Link Labels</a>, and
|
|
<a href="../../intro/connectionPoints.html">Link Points</a>.
|
|
<p class="boxread">
|
|
To control what links a user may draw or reconnect, please read about
|
|
<a href="../../intro/validation.html">Validation</a>.
|
|
<p class="boxread">
|
|
To customize linking and relinking behavior, please read
|
|
<a href="../../intro/tools.html#LinkingToolAndRelinkingTool">Introduction to the Linking Tools</a>
|
|
and <a href="../../intro/tools.html#RelinkingTool">Introduction to the RelinkingTool</a>.
|
|
For customizing the reshaping of Links,
|
|
see <a href="../../intro/tools.html#LinkReshapingTool">Introduction to the LinkReshapingTool</a>.
|
|
<p>Only Links that are in Diagrams can have connections with Nodes.
|
|
Templates should not be connected with Nodes, be members of Groups, or have any Adornments.</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>Constructors</h3>
|
|
<ul class="tsd-index-list">
|
|
<li class="tsd-kind-constructor tsd-parent-kind-class"><a href="Link.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="Link.html#adjusting" class="tsd-kind-icon">adjusting</a></li>
|
|
<li class="tsd-kind-accessor tsd-parent-kind-class"><a href="Link.html#corner" class="tsd-kind-icon">corner</a></li>
|
|
<li class="tsd-kind-accessor tsd-parent-kind-class"><a href="Link.html#curve" class="tsd-kind-icon">curve</a></li>
|
|
<li class="tsd-kind-accessor tsd-parent-kind-class"><a href="Link.html#curviness" class="tsd-kind-icon">curviness</a></li>
|
|
<li class="tsd-kind-accessor tsd-parent-kind-class"><a href="Link.html#fromEndSegmentLength" class="tsd-kind-icon">from<wbr>End<wbr>Segment<wbr>Length</a></li>
|
|
<li class="tsd-kind-accessor tsd-parent-kind-class"><a href="Link.html#fromNode" class="tsd-kind-icon">from<wbr>Node</a></li>
|
|
<li class="tsd-kind-get-signature tsd-parent-kind-class"><a href="Link.html#fromPort" class="tsd-kind-icon">from<wbr>Port</a></li>
|
|
<li class="tsd-kind-accessor tsd-parent-kind-class"><a href="Link.html#fromPortChanged" class="tsd-kind-icon">from<wbr>Port<wbr>Changed</a></li>
|
|
<li class="tsd-kind-accessor tsd-parent-kind-class"><a href="Link.html#fromPortId" class="tsd-kind-icon">from<wbr>Port<wbr>Id</a></li>
|
|
<li class="tsd-kind-accessor tsd-parent-kind-class"><a href="Link.html#fromShortLength" class="tsd-kind-icon">from<wbr>Short<wbr>Length</a></li>
|
|
<li class="tsd-kind-accessor tsd-parent-kind-class"><a href="Link.html#fromSpot" class="tsd-kind-icon">from<wbr>Spot</a></li>
|
|
<li class="tsd-kind-get-signature tsd-parent-kind-class"><a href="Link.html#geometry" class="tsd-kind-icon">geometry</a></li>
|
|
<li class="tsd-kind-get-signature tsd-parent-kind-class"><a href="Link.html#isLabeledLink" class="tsd-kind-icon">is<wbr>Labeled<wbr>Link</a></li>
|
|
<li class="tsd-kind-get-signature tsd-parent-kind-class"><a href="Link.html#isOrthogonal" class="tsd-kind-icon">is<wbr>Orthogonal</a></li>
|
|
<li class="tsd-kind-accessor tsd-parent-kind-class"><a href="Link.html#isTreeLink" class="tsd-kind-icon">is<wbr>Tree<wbr>Link</a></li>
|
|
<li class="tsd-kind-get-signature tsd-parent-kind-class"><a href="Link.html#key" class="tsd-kind-icon">key</a></li>
|
|
<li class="tsd-kind-get-signature tsd-parent-kind-class"><a href="Link.html#labelNodes" class="tsd-kind-icon">label<wbr>Nodes</a></li>
|
|
<li class="tsd-kind-get-signature tsd-parent-kind-class"><a href="Link.html#midAngle" class="tsd-kind-icon">mid<wbr>Angle</a></li>
|
|
<li class="tsd-kind-get-signature tsd-parent-kind-class"><a href="Link.html#midPoint" class="tsd-kind-icon">mid<wbr>Point</a></li>
|
|
<li class="tsd-kind-get-signature tsd-parent-kind-class"><a href="Link.html#path" class="tsd-kind-icon">path</a></li>
|
|
<li class="tsd-kind-accessor tsd-parent-kind-class"><a href="Link.html#points" class="tsd-kind-icon">points</a></li>
|
|
<li class="tsd-kind-get-signature tsd-parent-kind-class"><a href="Link.html#pointsCount" class="tsd-kind-icon">points<wbr>Count</a></li>
|
|
<li class="tsd-kind-accessor tsd-parent-kind-class"><a href="Link.html#relinkableFrom" class="tsd-kind-icon">relinkable<wbr>From</a></li>
|
|
<li class="tsd-kind-accessor tsd-parent-kind-class"><a href="Link.html#relinkableTo" class="tsd-kind-icon">relinkable<wbr>To</a></li>
|
|
<li class="tsd-kind-accessor tsd-parent-kind-class"><a href="Link.html#resegmentable" class="tsd-kind-icon">resegmentable</a></li>
|
|
<li class="tsd-kind-accessor tsd-parent-kind-class"><a href="Link.html#routing" class="tsd-kind-icon">routing</a></li>
|
|
<li class="tsd-kind-accessor tsd-parent-kind-class"><a href="Link.html#smoothness" class="tsd-kind-icon">smoothness</a></li>
|
|
<li class="tsd-kind-accessor tsd-parent-kind-class"><a href="Link.html#toEndSegmentLength" class="tsd-kind-icon">to<wbr>End<wbr>Segment<wbr>Length</a></li>
|
|
<li class="tsd-kind-accessor tsd-parent-kind-class"><a href="Link.html#toNode" class="tsd-kind-icon">to<wbr>Node</a></li>
|
|
<li class="tsd-kind-get-signature tsd-parent-kind-class"><a href="Link.html#toPort" class="tsd-kind-icon">to<wbr>Port</a></li>
|
|
<li class="tsd-kind-accessor tsd-parent-kind-class"><a href="Link.html#toPortChanged" class="tsd-kind-icon">to<wbr>Port<wbr>Changed</a></li>
|
|
<li class="tsd-kind-accessor tsd-parent-kind-class"><a href="Link.html#toPortId" class="tsd-kind-icon">to<wbr>Port<wbr>Id</a></li>
|
|
<li class="tsd-kind-accessor tsd-parent-kind-class"><a href="Link.html#toShortLength" class="tsd-kind-icon">to<wbr>Short<wbr>Length</a></li>
|
|
<li class="tsd-kind-accessor tsd-parent-kind-class"><a href="Link.html#toSpot" class="tsd-kind-icon">to<wbr>Spot</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="Link.html#addPoint" class="tsd-kind-icon">add<wbr>Point</a></li>
|
|
<li class="tsd-kind-method tsd-parent-kind-class"><a href="Link.html#canRelinkFrom" class="tsd-kind-icon">can<wbr>Relink<wbr>From</a></li>
|
|
<li class="tsd-kind-method tsd-parent-kind-class"><a href="Link.html#canRelinkTo" class="tsd-kind-icon">can<wbr>Relink<wbr>To</a></li>
|
|
<li class="tsd-kind-method tsd-parent-kind-class"><a href="Link.html#clearPoints" class="tsd-kind-icon">clear<wbr>Points</a></li>
|
|
<li class="tsd-kind-method tsd-parent-kind-class"><a href="Link.html#computeCurve" class="tsd-kind-icon">compute<wbr>Curve</a></li>
|
|
<li class="tsd-kind-method tsd-parent-kind-class"><a href="Link.html#computeCurviness" class="tsd-kind-icon">compute<wbr>Curviness</a></li>
|
|
<li class="tsd-kind-method tsd-parent-kind-class"><a href="Link.html#computeEndSegmentLength" class="tsd-kind-icon">compute<wbr>End<wbr>Segment<wbr>Length</a></li>
|
|
<li class="tsd-kind-method tsd-parent-kind-class"><a href="Link.html#computeOtherPoint" class="tsd-kind-icon">compute<wbr>Other<wbr>Point</a></li>
|
|
<li class="tsd-kind-method tsd-parent-kind-class"><a href="Link.html#computePoints" class="tsd-kind-icon">compute<wbr>Points</a></li>
|
|
<li class="tsd-kind-method tsd-parent-kind-class"><a href="Link.html#computeSpacing" class="tsd-kind-icon">compute<wbr>Spacing</a></li>
|
|
<li class="tsd-kind-method tsd-parent-kind-class"><a href="Link.html#computeSpot" class="tsd-kind-icon">compute<wbr>Spot</a></li>
|
|
<li class="tsd-kind-method tsd-parent-kind-class"><a href="Link.html#computeThickness" class="tsd-kind-icon">compute<wbr>Thickness</a></li>
|
|
<li class="tsd-kind-method tsd-parent-kind-class"><a href="Link.html#findClosestSegment" class="tsd-kind-icon">find<wbr>Closest<wbr>Segment</a></li>
|
|
<li class="tsd-kind-method tsd-parent-kind-class"><a href="Link.html#getLinkDirection" class="tsd-kind-icon">get<wbr>Link<wbr>Direction</a></li>
|
|
<li class="tsd-kind-method tsd-parent-kind-class"><a href="Link.html#getLinkPoint" class="tsd-kind-icon">get<wbr>Link<wbr>Point</a></li>
|
|
<li class="tsd-kind-method tsd-parent-kind-class"><a href="Link.html#getLinkPointFromPoint" class="tsd-kind-icon">get<wbr>Link<wbr>Point<wbr>From<wbr>Point</a></li>
|
|
<li class="tsd-kind-method tsd-parent-kind-class"><a href="Link.html#getOtherNode" class="tsd-kind-icon">get<wbr>Other<wbr>Node</a></li>
|
|
<li class="tsd-kind-method tsd-parent-kind-class"><a href="Link.html#getOtherPort" class="tsd-kind-icon">get<wbr>Other<wbr>Port</a></li>
|
|
<li class="tsd-kind-method tsd-parent-kind-class"><a href="Link.html#getPoint" class="tsd-kind-icon">get<wbr>Point</a></li>
|
|
<li class="tsd-kind-method tsd-parent-kind-class"><a href="Link.html#hasCurviness" class="tsd-kind-icon">has<wbr>Curviness</a></li>
|
|
<li class="tsd-kind-method tsd-parent-kind-class"><a href="Link.html#insertPoint" class="tsd-kind-icon">insert<wbr>Point</a></li>
|
|
<li class="tsd-kind-method tsd-parent-kind-class"><a href="Link.html#invalidateRoute" class="tsd-kind-icon">invalidate<wbr>Route</a></li>
|
|
<li class="tsd-kind-method tsd-parent-kind-class"><a href="Link.html#makeGeometry" class="tsd-kind-icon">make<wbr>Geometry</a></li>
|
|
<li class="tsd-kind-method tsd-parent-kind-class"><a href="Link.html#move" class="tsd-kind-icon">move</a></li>
|
|
<li class="tsd-kind-method tsd-parent-kind-class"><a href="Link.html#removePoint" class="tsd-kind-icon">remove<wbr>Point</a></li>
|
|
<li class="tsd-kind-method tsd-parent-kind-class"><a href="Link.html#setPoint" class="tsd-kind-icon">set<wbr>Point</a></li>
|
|
<li class="tsd-kind-method tsd-parent-kind-class"><a href="Link.html#updateRoute" class="tsd-kind-icon">update<wbr>Route</a></li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-index-section ">
|
|
<h3>Constants</h3>
|
|
<ul class="tsd-index-list">
|
|
<li class="tsd-kind-constant tsd-parent-kind-class tsd-is-static"><a href="Link.html#static-AvoidsNodes" class="tsd-kind-icon">Avoids<wbr>Nodes</a></li>
|
|
<li class="tsd-kind-constant tsd-parent-kind-class tsd-is-static"><a href="Link.html#static-Bezier" class="tsd-kind-icon">Bezier</a></li>
|
|
<li class="tsd-kind-constant tsd-parent-kind-class tsd-is-static"><a href="Link.html#static-End" class="tsd-kind-icon">End</a></li>
|
|
<li class="tsd-kind-constant tsd-parent-kind-class tsd-is-static"><a href="Link.html#static-JumpGap" class="tsd-kind-icon">Jump<wbr>Gap</a></li>
|
|
<li class="tsd-kind-constant tsd-parent-kind-class tsd-is-static"><a href="Link.html#static-JumpOver" class="tsd-kind-icon">Jump<wbr>Over</a></li>
|
|
<li class="tsd-kind-constant tsd-parent-kind-class tsd-is-static"><a href="Link.html#static-None" class="tsd-kind-icon">None</a></li>
|
|
<li class="tsd-kind-constant tsd-parent-kind-class tsd-is-static"><a href="Link.html#static-Normal" class="tsd-kind-icon">Normal</a></li>
|
|
<li class="tsd-kind-constant tsd-parent-kind-class tsd-is-static"><a href="Link.html#static-OrientAlong" class="tsd-kind-icon">Orient<wbr>Along</a></li>
|
|
<li class="tsd-kind-constant tsd-parent-kind-class tsd-is-static"><a href="Link.html#static-OrientMinus90" class="tsd-kind-icon">Orient<wbr>Minus90</a></li>
|
|
<li class="tsd-kind-constant tsd-parent-kind-class tsd-is-static"><a href="Link.html#static-OrientMinus90Upright" class="tsd-kind-icon">Orient<wbr>Minus90<wbr>Upright</a></li>
|
|
<li class="tsd-kind-constant tsd-parent-kind-class tsd-is-static"><a href="Link.html#static-OrientOpposite" class="tsd-kind-icon">Orient<wbr>Opposite</a></li>
|
|
<li class="tsd-kind-constant tsd-parent-kind-class tsd-is-static"><a href="Link.html#static-OrientPlus90" class="tsd-kind-icon">Orient<wbr>Plus90</a></li>
|
|
<li class="tsd-kind-constant tsd-parent-kind-class tsd-is-static"><a href="Link.html#static-OrientPlus90Upright" class="tsd-kind-icon">Orient<wbr>Plus90<wbr>Upright</a></li>
|
|
<li class="tsd-kind-constant tsd-parent-kind-class tsd-is-static"><a href="Link.html#static-OrientUpright" class="tsd-kind-icon">Orient<wbr>Upright</a></li>
|
|
<li class="tsd-kind-constant tsd-parent-kind-class tsd-is-static"><a href="Link.html#static-OrientUpright45" class="tsd-kind-icon">Orient<wbr>Upright45</a></li>
|
|
<li class="tsd-kind-constant tsd-parent-kind-class tsd-is-static"><a href="Link.html#static-Orthogonal" class="tsd-kind-icon">Orthogonal</a></li>
|
|
<li class="tsd-kind-constant tsd-parent-kind-class tsd-is-static"><a href="Link.html#static-Scale" class="tsd-kind-icon">Scale</a></li>
|
|
<li class="tsd-kind-constant tsd-parent-kind-class tsd-is-static"><a href="Link.html#static-Stretch" class="tsd-kind-icon">Stretch</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>Link<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="Link.html" class="tsd-signature-type">Link</a></li>
|
|
</ul>
|
|
<ul class="tsd-descriptions">
|
|
<li class="tsd-description">
|
|
<div class="tsd-comment tsd-typography">
|
|
<p>Constructs an empty link that does not connect any nodes.
|
|
If you want the link to be seen, you must provide a <a href="Shape.html">Shape</a> as an element
|
|
to be used as the visual path for the link.</p>
|
|
</div>
|
|
<h4 class="tsd-returns-title">Returns <a href="Link.html" class="tsd-signature-type">Link</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 name="adjusting" class="tsd-anchor"></a>
|
|
<h3>
|
|
adjusting
|
|
<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">EnumValue</span> </h3>
|
|
<ul class="tsd-descriptions">
|
|
<li class="tsd-description">
|
|
<div class="tsd-comment tsd-typography">
|
|
<p>Gets or sets how the route is computed, including whether it uses the points of its old route to determine the new route.
|
|
The value must be one of <a href="Link.html#static-None">None</a>, <a href="Link.html#static-End">End</a>, <a href="Link.html#static-Scale">Scale</a>, or <a href="Link.html#static-Stretch">Stretch</a>.</p>
|
|
<p>The default value is <a href="Link.html#static-None">None</a> -- the route is completely recalculated each time.</p>
|
|
</div>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-accessor tsd-parent-kind-class">
|
|
<a name="corner" class="tsd-anchor"></a>
|
|
<h3>
|
|
corner
|
|
<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 how rounded the corners are for adjacent line segments when the <a href="Link.html#curve">curve</a>
|
|
is <a href="Link.html#static-None">None</a>, <a href="Link.html#static-JumpGap">JumpGap</a>, or <a href="Link.html#static-JumpOver">JumpOver</a> and
|
|
the two line segments are orthogonal to each other.</p>
|
|
<p>The default value is zero -- there is no curve at a corner.</p>
|
|
</div>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-accessor tsd-parent-kind-class">
|
|
<a name="curve" class="tsd-anchor"></a>
|
|
<h3>
|
|
curve
|
|
<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">EnumValue</span> </h3>
|
|
<ul class="tsd-descriptions">
|
|
<li class="tsd-description">
|
|
<div class="tsd-comment tsd-typography">
|
|
<p>Gets or sets the way the path is generated from the route's points.
|
|
The value must be one of <a href="Link.html#static-None">None</a>, <a href="Link.html#static-Bezier">Bezier</a>, <a href="Link.html#static-JumpGap">JumpGap</a>, or <a href="Link.html#static-JumpOver">JumpOver</a>.</p>
|
|
<p>Setting this property to <a href="Link.html#static-JumpOver">JumpOver</a> or <a href="Link.html#static-JumpGap">JumpGap</a> requires the Diagram to do
|
|
considerable computation when calculating Link routes. Consider not using
|
|
a Jump... value with Diagrams that contain large numbers of Links
|
|
if you are targeting slow devices.</p>
|
|
<p>The default value is <a href="Link.html#static-None">None</a> -- each link segment is a straight line.</p>
|
|
<dl class="tsd-comment-tags">
|
|
<dt>see</dt>
|
|
<dd><p><a href="Link.html#computeCurve">computeCurve</a></p>
|
|
</dd>
|
|
</dl>
|
|
</div>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-accessor tsd-parent-kind-class">
|
|
<a name="curviness" class="tsd-anchor"></a>
|
|
<h3>
|
|
curviness
|
|
<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 how far the control points are offset when the <a href="Link.html#curve">curve</a> is <a href="Link.html#static-Bezier">Bezier</a>
|
|
or when there are multiple links between the same two ports.</p>
|
|
<p>The default value is NaN -- the actual curviness is computed based on how many links connect the same pair of ports.</p>
|
|
<dl class="tsd-comment-tags">
|
|
<dt>see</dt>
|
|
<dd><p><a href="Link.html#computeCurviness">computeCurviness</a></p>
|
|
</dd>
|
|
</dl>
|
|
</div>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-accessor tsd-parent-kind-class">
|
|
<a name="fromEndSegmentLength" class="tsd-anchor"></a>
|
|
<h3>
|
|
<span class="tsd-flag ts-flagOverride">Override</span>
|
|
from<wbr>End<wbr>Segment<wbr>Length
|
|
<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 length of the first segment, when the computed "from spot" at the <a href="Link.html#fromPort">fromPort</a> is not <a href="Spot.html#static-None">Spot.None</a>.
|
|
The default value is NaN, meaning that the value
|
|
actually comes from the <a href="GraphObject.html#fromEndSegmentLength">GraphObject.fromEndSegmentLength</a> property of the <a href="Link.html#fromPort">fromPort</a>.
|
|
This value also limits how short the <a href="Link.html#fromShortLength">fromShortLength</a> may be drawn.</p>
|
|
<p>For examples of how to use this property, see <a href="../../intro/connectionPoints.html">Link Connection Points</a>.</p>
|
|
<dl class="tsd-comment-tags">
|
|
<dt>see</dt>
|
|
<dd><p><a href="Link.html#toEndSegmentLength">toEndSegmentLength</a>, <a href="Link.html#computeEndSegmentLength">computeEndSegmentLength</a>, <a href="GraphObject.html#fromEndSegmentLength">GraphObject.fromEndSegmentLength</a>, <a href="Link.html#fromShortLength">fromShortLength</a></p>
|
|
</dd>
|
|
</dl>
|
|
</div>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-accessor tsd-parent-kind-class">
|
|
<a name="fromNode" class="tsd-anchor"></a>
|
|
<h3>
|
|
from<wbr>Node
|
|
<span class="tsd-signature-symbol">: </span><a href="Node.html" class="tsd-signature-type">Node</a><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 the <a href="Node.html">Node</a> that this link comes from.
|
|
The <a href="Link.html#fromPortId">fromPortId</a> specifies which port the link comes from.
|
|
The default value is null -- this link is not coming from any node.</p>
|
|
<p>A template should not be connected with any node.</p>
|
|
</div>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-get-signature tsd-parent-kind-class">
|
|
<a name="fromPort" class="tsd-anchor"></a>
|
|
<h3>
|
|
<span class="tsd-flag ts-flagReadOnly">Read-only</span>
|
|
from<wbr>Port
|
|
<span class="tsd-signature-symbol">: </span><a href="GraphObject.html" class="tsd-signature-type">GraphObject</a><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>This read-only property returns a <a href="GraphObject.html">GraphObject</a> that is the "from" port that this link is connected from.
|
|
The <a href="Link.html#fromNode">fromNode</a> provides the node that the link is coming from.
|
|
The <a href="Link.html#fromPortId">fromPortId</a> provides the identifier for which port this link is coming from;
|
|
you can set that property in order to change the value of this property.
|
|
This method may return null.</p>
|
|
</div>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-accessor tsd-parent-kind-class">
|
|
<a name="fromPortChanged" class="tsd-anchor"></a>
|
|
<h3>
|
|
from<wbr>Port<wbr>Changed
|
|
<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">function</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">thisLink</span><span class="tsd-signature-symbol">: </span><a href="Link.html" class="tsd-signature-type">Link</a><span class="tsd-signature-symbol">, </span><span class="tsd-signature-symbol">oldPort</span><span class="tsd-signature-symbol">: </span><a href="GraphObject.html" class="tsd-signature-type">GraphObject</a><span class="tsd-signature-symbol">, </span><span class="tsd-signature-symbol">newPort</span><span class="tsd-signature-symbol">: </span><a href="GraphObject.html" class="tsd-signature-type">GraphObject</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</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 the function that is called after this Link changes which Node or port it connects from.
|
|
The first argument will be this Link.
|
|
The second argument will be the old GraphObject port.
|
|
The third argument will be the new GraphObject port.</p>
|
|
<p>If the value is a function, that function must not modify which nodes or links this link connects with.
|
|
The "from" node and/or port has already been changed -- trying to change it again may produce undefined behavior.</p>
|
|
<p>The default value is null -- no function is called.</p>
|
|
</div>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-accessor tsd-parent-kind-class">
|
|
<a name="fromPortId" class="tsd-anchor"></a>
|
|
<h3>
|
|
from<wbr>Port<wbr>Id
|
|
<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 identifier of the port that this link comes from.
|
|
The default value is the empty string.</p>
|
|
</div>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-accessor tsd-parent-kind-class">
|
|
<a name="fromShortLength" class="tsd-anchor"></a>
|
|
<h3>
|
|
<span class="tsd-flag ts-flagOverride">Override</span>
|
|
from<wbr>Short<wbr>Length
|
|
<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 how far the end segment stops short of the actual port.
|
|
Positive values are limited by the <a href="Link.html#fromEndSegmentLength">fromEndSegmentLength</a> or <a href="GraphObject.html#fromEndSegmentLength">GraphObject.fromEndSegmentLength</a>.
|
|
Negative values cause the link to extend into the port.
|
|
The default value is NaN -- the value actually comes from the
|
|
<a href="GraphObject.html#fromShortLength">GraphObject.fromShortLength</a> property of the <a href="Link.html#fromPort">fromPort</a>.</p>
|
|
<p>For examples of how to use this property, see <a href="../../intro/connectionPoints.html">Link Connection Points</a>.
|
|
If you want to move an arrowhead away from the start of the link route,
|
|
set the arrowhead Shape's <a href="GraphObject.html#segmentOffset">GraphObject.segmentOffset</a>.</p>
|
|
<dl class="tsd-comment-tags">
|
|
<dt>see</dt>
|
|
<dd><p><a href="Link.html#toShortLength">toShortLength</a>, <a href="GraphObject.html#fromShortLength">GraphObject.fromShortLength</a>, <a href="Link.html#fromEndSegmentLength">fromEndSegmentLength</a></p>
|
|
</dd>
|
|
</dl>
|
|
</div>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-accessor tsd-parent-kind-class">
|
|
<a name="fromSpot" class="tsd-anchor"></a>
|
|
<h3>
|
|
<span class="tsd-flag ts-flagOverride">Override</span>
|
|
from<wbr>Spot
|
|
<span class="tsd-signature-symbol">: </span><a href="Spot.html" class="tsd-signature-type">Spot</a> </h3>
|
|
<ul class="tsd-descriptions">
|
|
<li class="tsd-description">
|
|
<div class="tsd-comment tsd-typography">
|
|
<p>Gets or sets where this link should connect at the <a href="Link.html#fromPort">fromPort</a>.
|
|
The default value is <a href="Spot.html#static-Default">Spot.Default</a>, meaning that the value
|
|
actually comes from the <a href="GraphObject.html#fromSpot">GraphObject.fromSpot</a> property of the <a href="Link.html#fromPort">fromPort</a>.</p>
|
|
<p>This property is set by some layouts, if <a href="ForceDirectedLayout.html#setsPortSpots">ForceDirectedLayout.setsPortSpots</a> or
|
|
<a href="LayeredDigraphLayout.html#setsPortSpots">LayeredDigraphLayout.setsPortSpots</a> or <a href="TreeLayout.html#setsPortSpot">TreeLayout.setsPortSpot</a> or
|
|
<a href="TreeLayout.html#setsChildPortSpot">TreeLayout.setsChildPortSpot</a> is true.</p>
|
|
<p>For examples of how to use this property, see <a href="../../intro/connectionPoints.html">Link Connection Points</a>.</p>
|
|
<dl class="tsd-comment-tags">
|
|
<dt>see</dt>
|
|
<dd><p><a href="Link.html#toSpot">toSpot</a>, <a href="GraphObject.html#fromSpot">GraphObject.fromSpot</a>, <a href="Link.html#computeSpot">computeSpot</a></p>
|
|
</dd>
|
|
</dl>
|
|
</div>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-get-signature tsd-parent-kind-class">
|
|
<a name="geometry" class="tsd-anchor"></a>
|
|
<h3>
|
|
<span class="tsd-flag ts-flagReadOnly">Read-only</span>
|
|
geometry
|
|
<span class="tsd-signature-symbol">: </span><a href="Geometry.html" class="tsd-signature-type">Geometry</a> </h3>
|
|
<ul class="tsd-descriptions">
|
|
<li class="tsd-description">
|
|
<div class="tsd-comment tsd-typography">
|
|
<p>This read-only property returns the <a href="Geometry.html">Geometry</a> that is used by the <a href="Link.html#path">path</a>, the link <a href="Shape.html">Shape</a> based on the route points.</p>
|
|
<p>This geometry is automatically generated using the route points and other properties
|
|
such as the <a href="Link.html#curve">curve</a>.
|
|
The points of the Geometry are in local coordinates, whereas the <a href="Link.html#points">points</a> of the link route are in document coordinates.</p>
|
|
<p>More than one <a href="Shape.html">Shape</a> may share this geometry as its <a href="Shape.html#geometry">Shape.geometry</a>,
|
|
if there is more than one shape element in the Link with <a href="GraphObject.html#isPanelMain">GraphObject.isPanelMain</a> set to true.</p>
|
|
</div>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-get-signature tsd-parent-kind-class">
|
|
<a name="isLabeledLink" class="tsd-anchor"></a>
|
|
<h3>
|
|
<span class="tsd-flag ts-flagReadOnly">Read-only</span>
|
|
is<wbr>Labeled<wbr>Link
|
|
<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span> </h3>
|
|
<ul class="tsd-descriptions">
|
|
<li class="tsd-description">
|
|
<div class="tsd-comment tsd-typography">
|
|
<p>This read-only property is true when this Link has any label Nodes, <a href="Node.html">Node</a>s that are owned by this Link
|
|
and are arranged along its path in the same manner as elements of the Link Panel.</p>
|
|
<dl class="tsd-comment-tags">
|
|
<dt>see</dt>
|
|
<dd><p><a href="Link.html#labelNodes">labelNodes</a></p>
|
|
</dd>
|
|
<dt>since</dt>
|
|
<dd><p>1.1</p>
|
|
</dd>
|
|
</dl>
|
|
</div>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-get-signature tsd-parent-kind-class">
|
|
<a name="isOrthogonal" class="tsd-anchor"></a>
|
|
<h3>
|
|
<span class="tsd-flag ts-flagReadOnly">Read-only</span>
|
|
is<wbr>Orthogonal
|
|
<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span> </h3>
|
|
<ul class="tsd-descriptions">
|
|
<li class="tsd-description">
|
|
<div class="tsd-comment tsd-typography">
|
|
<p>This read-only property is true if <a href="Link.html#routing">routing</a> is a value that implies that the points
|
|
of the route should be orthogonal, such that each point shares a common X or a common Y value
|
|
with the immediately previous and next points.
|
|
This property is completely dependent on the <a href="Link.html#routing">routing</a> property.
|
|
Values of <a href="Link.html#static-Orthogonal">Link.Orthogonal</a> and <a href="Link.html#static-AvoidsNodes">Link.AvoidsNodes</a> causes this property to be true.</p>
|
|
<p>The points in the route might not actually form an orthogonal route, but when the route is computed
|
|
the intent is to maintain orthogonality.</p>
|
|
<dl class="tsd-comment-tags">
|
|
<dt>since</dt>
|
|
<dd><p>1.2</p>
|
|
</dd>
|
|
</dl>
|
|
</div>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-accessor tsd-parent-kind-class">
|
|
<a name="isTreeLink" class="tsd-anchor"></a>
|
|
<h3>
|
|
is<wbr>Tree<wbr>Link
|
|
<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span> </h3>
|
|
<ul class="tsd-descriptions">
|
|
<li class="tsd-description">
|
|
<div class="tsd-comment tsd-typography">
|
|
<p>Gets or sets whether this Link is part of the tree for tree operations
|
|
such as <a href="Node.html#findTreeChildrenNodes">Node.findTreeChildrenNodes</a> or <a href="Node.html#collapseTree">Node.collapseTree</a>.</p>
|
|
<p>The initial value is true.</p>
|
|
<dl class="tsd-comment-tags">
|
|
<dt>since</dt>
|
|
<dd><p>1.2</p>
|
|
</dd>
|
|
</dl>
|
|
</div>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-get-signature tsd-parent-kind-class">
|
|
<a name="key" class="tsd-anchor"></a>
|
|
<h3>
|
|
<span class="tsd-flag ts-flagOverride">Override</span>
|
|
<span class="tsd-flag ts-flagReadOnly">Read-only</span>
|
|
key
|
|
<span class="tsd-signature-symbol">: </span><a href="../index.html#Key" class="tsd-signature-type">Key</a> </h3>
|
|
<ul class="tsd-descriptions">
|
|
<li class="tsd-description">
|
|
<div class="tsd-comment tsd-typography">
|
|
<p>This read-only property returns the Links's Model data key if it is in a Diagram and is backed by Model data.
|
|
Otherwise this returns undefined.</p>
|
|
<p>If the link data is in a GraphLinksModel, the <a href="GraphLinksModel.html#linkKeyProperty">GraphLinksModel.linkKeyProperty</a> must not be an empty string.</p>
|
|
<dl class="tsd-comment-tags">
|
|
<dt>since</dt>
|
|
<dd><p>1.8</p>
|
|
</dd>
|
|
<dt>see</dt>
|
|
<dd><p><a href="GraphLinksModel.html#getKeyForLinkData">GraphLinksModel.getKeyForLinkData</a></p>
|
|
</dd>
|
|
</dl>
|
|
</div>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-get-signature tsd-parent-kind-class">
|
|
<a name="labelNodes" class="tsd-anchor"></a>
|
|
<h3>
|
|
<span class="tsd-flag ts-flagReadOnly">Read-only</span>
|
|
label<wbr>Nodes
|
|
<span class="tsd-signature-symbol">: </span><a href="Iterator.html" class="tsd-signature-type">Iterator</a><span class="tsd-signature-symbol"><</span><a href="Node.html" class="tsd-signature-type">Node</a><span class="tsd-signature-symbol">></span> </h3>
|
|
<ul class="tsd-descriptions">
|
|
<li class="tsd-description">
|
|
<div class="tsd-comment tsd-typography">
|
|
<p>This read-only property returns an iterator over the <a href="Node.html">Node</a>s that act as labels on this Link.
|
|
Setting <a href="Node.html#labeledLink">Node.labeledLink</a> to refer to this Link
|
|
will add that <a href="Node.html">Node</a> to this collection.</p>
|
|
<p>Do not confuse these <a href="Node.html">Node</a>s with the <a href="GraphObject.html">GraphObject</a>s that
|
|
are part of this <a href="Link.html">Link</a> <a href="Panel.html">Panel</a>.
|
|
Those objects can also be used as "labels", but not as objects to which
|
|
there can be link connections, because those panel elements cannot be <a href="Node.html">Node</a>s.
|
|
Those panel objects can be used for other purposes too, such as arrowheads.</p>
|
|
<p>A template should not have any label nodes.</p>
|
|
<dl class="tsd-comment-tags">
|
|
<dt>see</dt>
|
|
<dd><p><a href="Link.html#isLabeledLink">isLabeledLink</a></p>
|
|
</dd>
|
|
</dl>
|
|
</div>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-get-signature tsd-parent-kind-class">
|
|
<a name="midAngle" class="tsd-anchor"></a>
|
|
<h3>
|
|
<span class="tsd-flag ts-flagReadOnly">Read-only</span>
|
|
mid<wbr>Angle
|
|
<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>This read-only property returns the angle of the path at the <a href="Link.html#midPoint">midPoint</a>.</p>
|
|
</div>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-get-signature tsd-parent-kind-class">
|
|
<a name="midPoint" class="tsd-anchor"></a>
|
|
<h3>
|
|
<span class="tsd-flag ts-flagReadOnly">Read-only</span>
|
|
mid<wbr>Point
|
|
<span class="tsd-signature-symbol">: </span><a href="Point.html" class="tsd-signature-type">Point</a> </h3>
|
|
<ul class="tsd-descriptions">
|
|
<li class="tsd-description">
|
|
<div class="tsd-comment tsd-typography">
|
|
<p>This read-only property returns the point at the middle of the path, in document coordinates.</p>
|
|
</div>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-get-signature tsd-parent-kind-class">
|
|
<a name="path" class="tsd-anchor"></a>
|
|
<h3>
|
|
<span class="tsd-flag ts-flagReadOnly">Read-only</span>
|
|
path
|
|
<span class="tsd-signature-symbol">: </span><a href="Shape.html" class="tsd-signature-type">Shape</a><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>This read-only property returns the main <a href="Shape.html">Shape</a> representing the path of this Link.</p>
|
|
<p>The value depends on there being an element in this Link that is
|
|
a <a href="Shape.html">Shape</a> and that has <a href="GraphObject.html#isPanelMain">GraphObject.isPanelMain</a> set to true.
|
|
This shape is what displays the stroke going from one node to another node.</p>
|
|
<p>This path shape's geometry is automatically generated based on the <a href="Link.html#points">points</a>
|
|
of this link's route, depending on other properties such as <a href="Link.html#curve">curve</a>.
|
|
Note that the points are in document coordinates, but the path's <a href="Shape.html#geometry">Shape.geometry</a>
|
|
will have points that are in local Shape coordinates.
|
|
This Shape's <a href="GraphObject.html#scale">GraphObject.scale</a> should be one and <a href="GraphObject.html#angle">GraphObject.angle</a> should be zero.</p>
|
|
<p>If there is no Shape with <a href="GraphObject.html#isPanelMain">GraphObject.isPanelMain</a> set to true,
|
|
the Link will use the first Shape for its path.</p>
|
|
</div>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-accessor tsd-parent-kind-class">
|
|
<a name="points" class="tsd-anchor"></a>
|
|
<h3>
|
|
points
|
|
<span class="tsd-signature-symbol">: </span><a href="List.html" class="tsd-signature-type">List</a><span class="tsd-signature-symbol"><</span><a href="Point.html" class="tsd-signature-type">Point</a><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 the <a href="List.html">List</a> of <a href="Point.html">Point</a>s in the route.
|
|
All of the Points must be <a href="Point.html#isReal">Point.isReal</a> -- no NaN or infinite values --
|
|
and all of the points are in document coordinates.
|
|
Although this list may be replaced by setting this property,
|
|
one must not modify the contents of the List directly.</p>
|
|
<p>The setter also accepts an Array of alternating X,Y point values [1, 2, 3, 4, 5, 6],
|
|
or an Array of Objects each of which has (lowercase) 'x' and 'y' properties that are numbers
|
|
[{"x":1,"y":2}, {"x":3,"y":4}, {"x":5,"y":6}].</p>
|
|
<p>Ownership of the <a href="List.html">List</a> and all of its <a href="Point.html">Point</a>s that is provided to the setter
|
|
is transferred to this Link.</p>
|
|
</div>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-get-signature tsd-parent-kind-class">
|
|
<a name="pointsCount" class="tsd-anchor"></a>
|
|
<h3>
|
|
<span class="tsd-flag ts-flagReadOnly">Read-only</span>
|
|
points<wbr>Count
|
|
<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>This read-only property returns the number of points in the route.</p>
|
|
</div>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-accessor tsd-parent-kind-class">
|
|
<a name="relinkableFrom" class="tsd-anchor"></a>
|
|
<h3>
|
|
relinkable<wbr>From
|
|
<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span> </h3>
|
|
<ul class="tsd-descriptions">
|
|
<li class="tsd-description">
|
|
<div class="tsd-comment tsd-typography">
|
|
<p>Gets or sets whether the user may reconnect an existing link at the "from" end.
|
|
This affects the behavior of the <a href="RelinkingTool.html">RelinkingTool</a>.</p>
|
|
<p>The initial value is false.</p>
|
|
</div>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-accessor tsd-parent-kind-class">
|
|
<a name="relinkableTo" class="tsd-anchor"></a>
|
|
<h3>
|
|
relinkable<wbr>To
|
|
<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span> </h3>
|
|
<ul class="tsd-descriptions">
|
|
<li class="tsd-description">
|
|
<div class="tsd-comment tsd-typography">
|
|
<p>Gets or sets whether the user may reconnect an existing link at the "to" end.
|
|
This affects the behavior of the <a href="RelinkingTool.html">RelinkingTool</a>.</p>
|
|
<p>The initial value is false.</p>
|
|
</div>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-accessor tsd-parent-kind-class">
|
|
<a name="resegmentable" class="tsd-anchor"></a>
|
|
<h3>
|
|
resegmentable
|
|
<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span> </h3>
|
|
<ul class="tsd-descriptions">
|
|
<li class="tsd-description">
|
|
<div class="tsd-comment tsd-typography">
|
|
<p>Gets or sets whether the user may change the number of segments in this Link,
|
|
if the link has straight segments.
|
|
This affects the behavior of the <a href="LinkReshapingTool.html">LinkReshapingTool</a> when <a href="Link.html#curve">curve</a> is not <a href="Link.html#static-Bezier">Link.Bezier</a>.</p>
|
|
<p>The initial value is false.</p>
|
|
<dl class="tsd-comment-tags">
|
|
<dt>since</dt>
|
|
<dd><p>1.2</p>
|
|
</dd>
|
|
</dl>
|
|
</div>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-accessor tsd-parent-kind-class">
|
|
<a name="routing" class="tsd-anchor"></a>
|
|
<h3>
|
|
routing
|
|
<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">EnumValue</span> </h3>
|
|
<ul class="tsd-descriptions">
|
|
<li class="tsd-description">
|
|
<div class="tsd-comment tsd-typography">
|
|
<p>Gets or sets whether the link's path tries to avoid other nodes.
|
|
The value must be one of <a href="Link.html#static-Normal">Normal</a>, <a href="Link.html#static-Orthogonal">Orthogonal</a>, or <a href="Link.html#static-AvoidsNodes">AvoidsNodes</a>.</p>
|
|
<p>Setting this property to <a href="Link.html#static-AvoidsNodes">AvoidsNodes</a> requires the Diagram to do
|
|
considerable computation when calculating Link routes. Consider not using
|
|
the <a href="Link.html#static-AvoidsNodes">AvoidsNodes</a> with Diagrams that contain large numbers of Nodes and Links
|
|
if you are targeting slow devices.
|
|
When using <a href="Link.html#static-AvoidsNodes">AvoidsNodes</a>, dragging performance can be improved by setting <a href="DraggingTool.html#isComplexRoutingRealtime">DraggingTool.isComplexRoutingRealtime</a> to false.</p>
|
|
<p>The default value is <a href="Link.html#static-Normal">Normal</a> -- the route is primarily a single straight segment,
|
|
with possible short end segments when connecting with ports that have a "spot" value
|
|
as the <a href="Link.html#fromSpot">fromSpot</a> or <a href="GraphObject.html#fromSpot">GraphObject.fromSpot</a> or <a href="Link.html#toSpot">toSpot</a> or <a href="GraphObject.html#toSpot">GraphObject.toSpot</a>.</p>
|
|
</div>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-accessor tsd-parent-kind-class">
|
|
<a name="smoothness" class="tsd-anchor"></a>
|
|
<h3>
|
|
smoothness
|
|
<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 how far the control points are from the points of the route
|
|
when <a href="Link.html#routing">routing</a> is <a href="Link.html#static-Orthogonal">Orthogonal</a> and <a href="Link.html#curve">curve</a> is <a href="Link.html#static-Bezier">Bezier</a>.</p>
|
|
<p>The default value is 0.5.
|
|
Values of this property typically fall in the range of 0.0 to 1.0.
|
|
A value of 0.0 indicates that the control points of the curve are at the end points,
|
|
which will result in straight line segments.
|
|
A value of 1.0 indicates that the control points are one-third of the link's
|
|
length away from the end point along the direction of the link,
|
|
and the same distance away in a perpendicular direction.
|
|
The distance scales linearly with the value of this property,
|
|
even with negative values and values greater than 1.0.</p>
|
|
</div>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-accessor tsd-parent-kind-class">
|
|
<a name="toEndSegmentLength" class="tsd-anchor"></a>
|
|
<h3>
|
|
<span class="tsd-flag ts-flagOverride">Override</span>
|
|
to<wbr>End<wbr>Segment<wbr>Length
|
|
<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 length of the last segment.
|
|
The default value is NaN, meaning that the value
|
|
actually comes from the <a href="GraphObject.html#toEndSegmentLength">GraphObject.toEndSegmentLength</a> property of the <a href="Link.html#toPort">toPort</a>.
|
|
This value also limits how short the <a href="Link.html#toShortLength">toShortLength</a> may be drawn.</p>
|
|
<p>For examples of how to use this property, see <a href="../../intro/connectionPoints.html">Link Connection Points</a>.</p>
|
|
<dl class="tsd-comment-tags">
|
|
<dt>see</dt>
|
|
<dd><p><a href="Link.html#fromEndSegmentLength">fromEndSegmentLength</a>, <a href="Link.html#computeEndSegmentLength">computeEndSegmentLength</a>, <a href="GraphObject.html#toEndSegmentLength">GraphObject.toEndSegmentLength</a>, <a href="Link.html#toShortLength">toShortLength</a></p>
|
|
</dd>
|
|
</dl>
|
|
</div>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-accessor tsd-parent-kind-class">
|
|
<a name="toNode" class="tsd-anchor"></a>
|
|
<h3>
|
|
to<wbr>Node
|
|
<span class="tsd-signature-symbol">: </span><a href="Node.html" class="tsd-signature-type">Node</a><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 the <a href="Node.html">Node</a> that this link goes to.
|
|
The <a href="Link.html#toPortId">toPortId</a> specifies which port the link goes to.
|
|
The default value is null -- this link is not going to any node.</p>
|
|
<p>A template should not be connected with any node.</p>
|
|
</div>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-get-signature tsd-parent-kind-class">
|
|
<a name="toPort" class="tsd-anchor"></a>
|
|
<h3>
|
|
<span class="tsd-flag ts-flagReadOnly">Read-only</span>
|
|
to<wbr>Port
|
|
<span class="tsd-signature-symbol">: </span><a href="GraphObject.html" class="tsd-signature-type">GraphObject</a><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>This read-only property returns a <a href="GraphObject.html">GraphObject</a> that is the "to" port that this link is connected to.
|
|
The <a href="Link.html#toNode">toNode</a> provides the node that the link is going to.
|
|
The <a href="Link.html#toPortId">toPortId</a> provides the identifier for which port this link is going to;
|
|
you can set that property in order to change the value of this property.
|
|
This method may return null.</p>
|
|
</div>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-accessor tsd-parent-kind-class">
|
|
<a name="toPortChanged" class="tsd-anchor"></a>
|
|
<h3>
|
|
to<wbr>Port<wbr>Changed
|
|
<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">function</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">thisLink</span><span class="tsd-signature-symbol">: </span><a href="Link.html" class="tsd-signature-type">Link</a><span class="tsd-signature-symbol">, </span><span class="tsd-signature-symbol">oldPort</span><span class="tsd-signature-symbol">: </span><a href="GraphObject.html" class="tsd-signature-type">GraphObject</a><span class="tsd-signature-symbol">, </span><span class="tsd-signature-symbol">newPort</span><span class="tsd-signature-symbol">: </span><a href="GraphObject.html" class="tsd-signature-type">GraphObject</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</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 the function that is called after this Link changes which Node or port it connects to.
|
|
The first argument will be this Link.
|
|
The second argument will be the old GraphObject port.
|
|
The third argument will be the new GraphObject port.</p>
|
|
<p>If the value is a function, that function must not modify which nodes or links this link connects with.
|
|
The "to" node and/or port has already been changed -- trying to change it again may produce undefined behavior.</p>
|
|
<p>The default value is null -- no function is called.</p>
|
|
</div>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-accessor tsd-parent-kind-class">
|
|
<a name="toPortId" class="tsd-anchor"></a>
|
|
<h3>
|
|
to<wbr>Port<wbr>Id
|
|
<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 identifier of the port that this link goes to.
|
|
The default value is the empty string.</p>
|
|
</div>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-accessor tsd-parent-kind-class">
|
|
<a name="toShortLength" class="tsd-anchor"></a>
|
|
<h3>
|
|
<span class="tsd-flag ts-flagOverride">Override</span>
|
|
to<wbr>Short<wbr>Length
|
|
<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 how far the end segment stops short of the actual port.
|
|
Positive values are limited by the <a href="Link.html#toEndSegmentLength">toEndSegmentLength</a> or <a href="GraphObject.html#toEndSegmentLength">GraphObject.toEndSegmentLength</a>.
|
|
Negative values cause the link to extend into the port.
|
|
The default value is NaN -- the value actually comes from the
|
|
<a href="GraphObject.html#toShortLength">GraphObject.toShortLength</a> property of the <a href="Link.html#toPort">toPort</a>.</p>
|
|
<p>For examples of how to use this property, see <a href="../../intro/connectionPoints.html">Link Connection Points</a>.
|
|
If you want to move an arrowhead away from the end of the link route,
|
|
set the arrowhead Shape's <a href="GraphObject.html#segmentOffset">GraphObject.segmentOffset</a>.</p>
|
|
<dl class="tsd-comment-tags">
|
|
<dt>see</dt>
|
|
<dd><p><a href="Link.html#fromShortLength">fromShortLength</a>, <a href="GraphObject.html#toShortLength">GraphObject.toShortLength</a>, <a href="Link.html#toEndSegmentLength">toEndSegmentLength</a></p>
|
|
</dd>
|
|
</dl>
|
|
</div>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-accessor tsd-parent-kind-class">
|
|
<a name="toSpot" class="tsd-anchor"></a>
|
|
<h3>
|
|
<span class="tsd-flag ts-flagOverride">Override</span>
|
|
to<wbr>Spot
|
|
<span class="tsd-signature-symbol">: </span><a href="Spot.html" class="tsd-signature-type">Spot</a> </h3>
|
|
<ul class="tsd-descriptions">
|
|
<li class="tsd-description">
|
|
<div class="tsd-comment tsd-typography">
|
|
<p>Gets or sets where this link should connect at the <a href="Link.html#toPort">toPort</a>.
|
|
The default value is <a href="Spot.html#static-Default">Spot.Default</a>, meaning that the value
|
|
actually comes from the <a href="GraphObject.html#toSpot">GraphObject.toSpot</a> property of the <a href="Link.html#toPort">toPort</a>.</p>
|
|
<p>This property is set by some layouts, if <a href="ForceDirectedLayout.html#setsPortSpots">ForceDirectedLayout.setsPortSpots</a> or
|
|
<a href="LayeredDigraphLayout.html#setsPortSpots">LayeredDigraphLayout.setsPortSpots</a> or <a href="TreeLayout.html#setsPortSpot">TreeLayout.setsPortSpot</a> or
|
|
<a href="TreeLayout.html#setsChildPortSpot">TreeLayout.setsChildPortSpot</a> is true.</p>
|
|
<p>For examples of how to use this property, see <a href="../../intro/connectionPoints.html">Link Connection Points</a>.</p>
|
|
<dl class="tsd-comment-tags">
|
|
<dt>see</dt>
|
|
<dd><p><a href="Link.html#fromSpot">fromSpot</a>, <a href="GraphObject.html#toSpot">GraphObject.toSpot</a>, <a href="Link.html#computeSpot">computeSpot</a></p>
|
|
</dd>
|
|
</dl>
|
|
</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="addPoint" class="tsd-anchor"></a>
|
|
<h3>
|
|
add<wbr>Point
|
|
</h3>
|
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
|
<li class="tsd-signature tsd-kind-icon">add<wbr>Point<span class="tsd-signature-symbol">(</span>p<span class="tsd-signature-symbol">: </span><a href="Point.html" class="tsd-signature-type">Point</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>Add a point at the end of the route; this may only be called within an override of <a href="Link.html#computePoints">computePoints</a>.</p>
|
|
<dl class="tsd-comment-tags">
|
|
<dt>see</dt>
|
|
<dd><p><a href="Link.html#getPoint">getPoint</a>, <a href="Link.html#setPoint">setPoint</a>, <a href="Link.html#insertPoint">insertPoint</a>, <a href="Link.html#removePoint">removePoint</a></p>
|
|
</dd>
|
|
<dt>since</dt>
|
|
<dd><p>1.6</p>
|
|
</dd>
|
|
</dl>
|
|
</div>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>p: <a href="Point.html" class="tsd-signature-type">Point</a></h5>
|
|
<div class="tsd-comment tsd-typography">
|
|
<p>The new point in document coordinates, which should not have infinite or NaN coordinate values, and which must not be modified afterwards.</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="canRelinkFrom" class="tsd-anchor"></a>
|
|
<h3>
|
|
<span class="tsd-flag ts-flagVirtual">Virtual</span>
|
|
can<wbr>Relink<wbr>From
|
|
</h3>
|
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
|
<li class="tsd-signature tsd-kind-icon">can<wbr>Relink<wbr>From<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span></li>
|
|
</ul>
|
|
<ul class="tsd-descriptions">
|
|
<li class="tsd-description">
|
|
<div class="tsd-comment tsd-typography">
|
|
<p>This predicate returns true if <a href="Link.html#relinkableFrom">relinkableFrom</a> is true,
|
|
if the layer's <a href="Layer.html#allowRelink">Layer.allowRelink</a> is true, and
|
|
if the diagram's <a href="Diagram.html#allowRelink">Diagram.allowRelink</a> is true.</p>
|
|
<p>This does not check <a href="Diagram.html#isReadOnly">Diagram.isReadOnly</a> or <a href="Model.html#isReadOnly">Model.isReadOnly</a>,
|
|
but commands and tools should check those properties.</p>
|
|
</div>
|
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4>
|
|
<p>true if the user may relink the From end of this link.</p>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
|
|
<a name="canRelinkTo" class="tsd-anchor"></a>
|
|
<h3>
|
|
<span class="tsd-flag ts-flagVirtual">Virtual</span>
|
|
can<wbr>Relink<wbr>To
|
|
</h3>
|
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
|
<li class="tsd-signature tsd-kind-icon">can<wbr>Relink<wbr>To<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span></li>
|
|
</ul>
|
|
<ul class="tsd-descriptions">
|
|
<li class="tsd-description">
|
|
<div class="tsd-comment tsd-typography">
|
|
<p>This predicate returns true if <a href="Link.html#relinkableTo">relinkableTo</a> is true,
|
|
if the layer's <a href="Layer.html#allowRelink">Layer.allowRelink</a> is true, and
|
|
if the diagram's <a href="Diagram.html#allowRelink">Diagram.allowRelink</a> is true.</p>
|
|
<p>This does not check <a href="Diagram.html#isReadOnly">Diagram.isReadOnly</a> or <a href="Model.html#isReadOnly">Model.isReadOnly</a>,
|
|
but commands and tools should check those properties.</p>
|
|
</div>
|
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4>
|
|
<p>true if the user may relink the To end of this link.</p>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
|
|
<a name="clearPoints" class="tsd-anchor"></a>
|
|
<h3>
|
|
clear<wbr>Points
|
|
</h3>
|
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
|
<li class="tsd-signature tsd-kind-icon">clear<wbr>Points<span class="tsd-signature-symbol">(</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>Remove all of the points from this link's route; this may only be called within an override of <a href="Link.html#computePoints">computePoints</a>.</p>
|
|
<dl class="tsd-comment-tags">
|
|
<dt>see</dt>
|
|
<dd><p><a href="Link.html#getPoint">getPoint</a>, <a href="Link.html#setPoint">setPoint</a>, <a href="Link.html#insertPoint">insertPoint</a>, <a href="Link.html#addPoint">addPoint</a>, <a href="Link.html#removePoint">removePoint</a></p>
|
|
</dd>
|
|
<dt>since</dt>
|
|
<dd><p>1.6</p>
|
|
</dd>
|
|
</dl>
|
|
</div>
|
|
<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="computeCurve" class="tsd-anchor"></a>
|
|
<h3>
|
|
<span class="tsd-flag ts-flagVirtual">Virtual</span>
|
|
compute<wbr>Curve
|
|
</h3>
|
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
|
<li class="tsd-signature tsd-kind-icon">compute<wbr>Curve<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">EnumValue</span></li>
|
|
</ul>
|
|
<ul class="tsd-descriptions">
|
|
<li class="tsd-description">
|
|
<div class="tsd-comment tsd-typography">
|
|
<p>Returns the <a href="Link.html#curve">curve</a>, unless this link is supposed to pretend to be curved, as with reflexive links.</p>
|
|
<p>This method may be overridden.
|
|
Please read the Introduction page on <a href="../../intro/extensions.html">Extensions</a> for how to override methods and how to call this base method.</p>
|
|
<dl class="tsd-comment-tags">
|
|
<dt>since</dt>
|
|
<dd><p>1.6</p>
|
|
</dd>
|
|
</dl>
|
|
</div>
|
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">EnumValue</span></h4>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
|
|
<a name="computeCurviness" class="tsd-anchor"></a>
|
|
<h3>
|
|
<span class="tsd-flag ts-flagVirtual">Virtual</span>
|
|
compute<wbr>Curviness
|
|
</h3>
|
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
|
<li class="tsd-signature tsd-kind-icon">compute<wbr>Curviness<span class="tsd-signature-symbol">(</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>Returns the <a href="Link.html#curviness">curviness</a>, if it's a number,
|
|
or else a computed value based on how many links connect this pair of nodes/ports,
|
|
by calling <a href="Link.html#computeSpacing">computeSpacing</a> on each link.</p>
|
|
<p>This method may be overridden.
|
|
Please read the Introduction page on <a href="../../intro/extensions.html">Extensions</a> for how to override methods and how to call this base method.</p>
|
|
<dl class="tsd-comment-tags">
|
|
<dt>see</dt>
|
|
<dd><p><a href="Link.html#computeSpacing">computeSpacing</a></p>
|
|
</dd>
|
|
<dt>since</dt>
|
|
<dd><p>1.6</p>
|
|
</dd>
|
|
</dl>
|
|
</div>
|
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">number</span></h4>
|
|
<p>must be a real number, not NaN or infinity</p>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
|
|
<a name="computeEndSegmentLength" class="tsd-anchor"></a>
|
|
<h3>
|
|
<span class="tsd-flag ts-flagVirtual">Virtual</span>
|
|
compute<wbr>End<wbr>Segment<wbr>Length
|
|
</h3>
|
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
|
<li class="tsd-signature tsd-kind-icon">compute<wbr>End<wbr>Segment<wbr>Length<span class="tsd-signature-symbol">(</span>node<span class="tsd-signature-symbol">: </span><a href="Node.html" class="tsd-signature-type">Node</a><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">null</span>, port<span class="tsd-signature-symbol">: </span><a href="GraphObject.html" class="tsd-signature-type">GraphObject</a><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">null</span>, spot<span class="tsd-signature-symbol">: </span><a href="Spot.html" class="tsd-signature-type">Spot</a>, from<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</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>Get the length of the end segment in document coordinates, typically a short distance, in document units.
|
|
For spot values that are <a href="Spot.html#isSide">Spot.isSide</a>, this returns a computed value.
|
|
Depending on the <code>from</code> argument, this will return <a href="Link.html#fromEndSegmentLength">fromEndSegmentLength</a> or <a href="Link.html#toEndSegmentLength">toEndSegmentLength</a>.
|
|
If the value is <code>NaN</code>, this will return the <a href="Link.html#fromPort">fromPort</a>'s <a href="GraphObject.html#fromEndSegmentLength">GraphObject.fromEndSegmentLength</a>
|
|
or the <a href="Link.html#toPort">toPort</a>'s <a href="GraphObject.html#toEndSegmentLength">GraphObject.toEndSegmentLength</a>.</p>
|
|
<p>This method may be overridden.
|
|
Please read the Introduction page on <a href="../../intro/extensions.html">Extensions</a> for how to override methods and how to call this base method.</p>
|
|
<dl class="tsd-comment-tags">
|
|
<dt>since</dt>
|
|
<dd><p>1.6</p>
|
|
</dd>
|
|
</dl>
|
|
</div>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>node: <a href="Node.html" class="tsd-signature-type">Node</a><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">null</span></h5>
|
|
</li>
|
|
<li>
|
|
<h5>port: <a href="GraphObject.html" class="tsd-signature-type">GraphObject</a><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">null</span></h5>
|
|
<div class="tsd-comment tsd-typography">
|
|
<p>the <a href="GraphObject.html">GraphObject</a> representing a port on the node.</p>
|
|
</div>
|
|
</li>
|
|
<li>
|
|
<h5>spot: <a href="Spot.html" class="tsd-signature-type">Spot</a></h5>
|
|
<div class="tsd-comment tsd-typography">
|
|
<p>a <a href="Spot.html">Spot</a> value describing where the link should connect.</p>
|
|
</div>
|
|
</li>
|
|
<li>
|
|
<h5>from: <span class="tsd-signature-type">boolean</span></h5>
|
|
<div class="tsd-comment tsd-typography">
|
|
<p>true if the link is coming out of the port; false if going to the port.</p>
|
|
</div>
|
|
</li>
|
|
</ul>
|
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">number</span></h4>
|
|
<p>a distance in document coordinates; must be a real number, not NaN or infinity.</p>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
|
|
<a name="computeOtherPoint" class="tsd-anchor"></a>
|
|
<h3>
|
|
<span class="tsd-flag ts-flagVirtual">Virtual</span>
|
|
compute<wbr>Other<wbr>Point
|
|
</h3>
|
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
|
<li class="tsd-signature tsd-kind-icon">compute<wbr>Other<wbr>Point<span class="tsd-signature-symbol">(</span>othernode<span class="tsd-signature-symbol">: </span><a href="Node.html" class="tsd-signature-type">Node</a>, otherport<span class="tsd-signature-symbol">: </span><a href="GraphObject.html" class="tsd-signature-type">GraphObject</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="Point.html" class="tsd-signature-type">Point</a></li>
|
|
</ul>
|
|
<ul class="tsd-descriptions">
|
|
<li class="tsd-description">
|
|
<div class="tsd-comment tsd-typography">
|
|
<p>Find the approximate point of the other end of the link in document coordinates.
|
|
This is useful when computing the connection point when there is no specific spot, to have an idea of which general direction the link should be going.
|
|
By default this will return the center of the other port.</p>
|
|
<p>This method may be overridden.
|
|
Please read the Introduction page on <a href="../../intro/extensions.html">Extensions</a> for how to override methods and how to call this base method.</p>
|
|
<dl class="tsd-comment-tags">
|
|
<dt>since</dt>
|
|
<dd><p>1.6</p>
|
|
</dd>
|
|
</dl>
|
|
</div>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>othernode: <a href="Node.html" class="tsd-signature-type">Node</a></h5>
|
|
</li>
|
|
<li>
|
|
<h5>otherport: <a href="GraphObject.html" class="tsd-signature-type">GraphObject</a></h5>
|
|
</li>
|
|
</ul>
|
|
<h4 class="tsd-returns-title">Returns <a href="Point.html" class="tsd-signature-type">Point</a></h4>
|
|
<p>approximately where the other end of this link might end, in document coordinates</p>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
|
|
<a name="computePoints" class="tsd-anchor"></a>
|
|
<h3>
|
|
<span class="tsd-flag ts-flagVirtual">Virtual</span>
|
|
compute<wbr>Points
|
|
</h3>
|
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
|
<li class="tsd-signature tsd-kind-icon">compute<wbr>Points<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span></li>
|
|
</ul>
|
|
<ul class="tsd-descriptions">
|
|
<li class="tsd-description">
|
|
<div class="tsd-comment tsd-typography">
|
|
<p>The code that constructs a new route by modifying the <a href="Link.html#points">points</a>.
|
|
It is only called by <a href="Link.html#updateRoute">updateRoute</a>, when needed.
|
|
All route points are always in document coordinates.</p>
|
|
<p>This method may be overridden.
|
|
Please read the Introduction page on <a href="../../intro/extensions.html">Extensions</a> for how to override methods and how to call this base method.</p>
|
|
<p>Overrides of this method may call a number of "protected" methods in order to build the route:
|
|
<a href="Link.html#clearPoints">clearPoints</a>, <a href="Link.html#addPoint">addPoint</a>, <a href="Link.html#insertPoint">insertPoint</a>, <a href="Link.html#removePoint">removePoint</a>, <a href="Link.html#setPoint">setPoint</a>.
|
|
Overrides of this method must not set <a href="Link.html#points">points</a>.</p>
|
|
<p>Other methods that are commonly called and may be overridden are:
|
|
<a href="Link.html#computeEndSegmentLength">computeEndSegmentLength</a>, <a href="Link.html#computeSpot">computeSpot</a>, <a href="Link.html#computeOtherPoint">computeOtherPoint</a>,
|
|
<a href="Link.html#computeCurve">computeCurve</a>, <a href="Link.html#computeCurviness">computeCurviness</a>, <a href="Link.html#hasCurviness">hasCurviness</a>,
|
|
<a href="Link.html#computeThickness">computeThickness</a>,
|
|
<a href="Link.html#makeGeometry">makeGeometry</a>.</p>
|
|
<dl class="tsd-comment-tags">
|
|
<dt>since</dt>
|
|
<dd><p>1.6</p>
|
|
</dd>
|
|
</dl>
|
|
</div>
|
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4>
|
|
<p>true if it computed a route of points</p>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
|
|
<a name="computeSpacing" class="tsd-anchor"></a>
|
|
<h3>
|
|
<span class="tsd-flag ts-flagVirtual">Virtual</span>
|
|
compute<wbr>Spacing
|
|
</h3>
|
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
|
<li class="tsd-signature tsd-kind-icon">compute<wbr>Spacing<span class="tsd-signature-symbol">(</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>Returns the expected spacing between this link and others that connect this link's fromPort and toPort.
|
|
This calls <a href="Link.html#computeThickness">computeThickness</a> and also takes any "mid label"'s breadth into account.</p>
|
|
<p>This method may be overridden.
|
|
Please read the Introduction page on <a href="../../intro/extensions.html">Extensions</a> for how to override methods and how to call this base method.</p>
|
|
<dl class="tsd-comment-tags">
|
|
<dt>see</dt>
|
|
<dd><p><a href="Link.html#computeCurviness">computeCurviness</a></p>
|
|
</dd>
|
|
<dt>since</dt>
|
|
<dd><p>1.6</p>
|
|
</dd>
|
|
</dl>
|
|
</div>
|
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">number</span></h4>
|
|
<p>must be a real number, not NaN or infinity</p>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
|
|
<a name="computeSpot" class="tsd-anchor"></a>
|
|
<h3>
|
|
<span class="tsd-flag ts-flagVirtual">Virtual</span>
|
|
compute<wbr>Spot
|
|
</h3>
|
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
|
<li class="tsd-signature tsd-kind-icon">compute<wbr>Spot<span class="tsd-signature-symbol">(</span>from<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span>, port<span class="tsd-signature-symbol">?: </span><a href="GraphObject.html" class="tsd-signature-type">GraphObject</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><a href="Spot.html" class="tsd-signature-type">Spot</a></li>
|
|
</ul>
|
|
<ul class="tsd-descriptions">
|
|
<li class="tsd-description">
|
|
<div class="tsd-comment tsd-typography">
|
|
<p>Get the <a href="Spot.html">Spot</a> that describes how the end of the link should connect with the port.
|
|
Depending on the <code>from</code> argument, this will return <a href="Link.html#fromSpot">fromSpot</a> or <a href="Link.html#toSpot">toSpot</a>.
|
|
If the value is <a href="Spot.html#isDefault">Spot.isDefault</a>, this will return the <a href="Link.html#fromPort">fromPort</a>'s <a href="GraphObject.html#fromSpot">GraphObject.fromSpot</a>
|
|
or the <a href="Link.html#toPort">toPort</a>'s <a href="GraphObject.html#toSpot">GraphObject.toSpot</a>.</p>
|
|
<p>This method may be overridden.
|
|
Please read the Introduction page on <a href="../../intro/extensions.html">Extensions</a> for how to override methods and how to call this base method.</p>
|
|
<dl class="tsd-comment-tags">
|
|
<dt>since</dt>
|
|
<dd><p>1.6</p>
|
|
</dd>
|
|
</dl>
|
|
</div>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>from: <span class="tsd-signature-type">boolean</span></h5>
|
|
</li>
|
|
<li>
|
|
<h5><span class="tsd-flag ts-flagOptional">Optional</span> port: <a href="GraphObject.html" class="tsd-signature-type">GraphObject</a><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">null</span></h5>
|
|
</li>
|
|
</ul>
|
|
<h4 class="tsd-returns-title">Returns <a href="Spot.html" class="tsd-signature-type">Spot</a></h4>
|
|
<p>must not be <a href="Spot.html#static-Default">Spot.Default</a>, but may be <a href="Spot.html#static-None">Spot.None</a></p>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
|
|
<a name="computeThickness" class="tsd-anchor"></a>
|
|
<h3>
|
|
<span class="tsd-flag ts-flagVirtual">Virtual</span>
|
|
compute<wbr>Thickness
|
|
</h3>
|
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
|
<li class="tsd-signature tsd-kind-icon">compute<wbr>Thickness<span class="tsd-signature-symbol">(</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>Returns the thickness of this link.
|
|
By default it uses the strokeWidth of the main element, assuming it's a Shape.
|
|
This is called by <a href="Link.html#computeSpacing">computeSpacing</a>.</p>
|
|
<p>This method may be overridden.
|
|
Please read the Introduction page on <a href="../../intro/extensions.html">Extensions</a> for how to override methods and how to call this base method.</p>
|
|
<dl class="tsd-comment-tags">
|
|
<dt>since</dt>
|
|
<dd><p>1.6</p>
|
|
</dd>
|
|
</dl>
|
|
</div>
|
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">number</span></h4>
|
|
<p>a non-negative real number</p>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
|
|
<a name="findClosestSegment" class="tsd-anchor"></a>
|
|
<h3>
|
|
find<wbr>Closest<wbr>Segment
|
|
</h3>
|
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
|
<li class="tsd-signature tsd-kind-icon">find<wbr>Closest<wbr>Segment<span class="tsd-signature-symbol">(</span>p<span class="tsd-signature-symbol">: </span><a href="Point.html" class="tsd-signature-type">Point</a><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>Find the index of the segment that is closest to a given point.
|
|
This assume the route only has straight line segments.
|
|
It ignores any jump-overs or jump-gaps.</p>
|
|
</div>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>p: <a href="Point.html" class="tsd-signature-type">Point</a></h5>
|
|
<div class="tsd-comment tsd-typography">
|
|
<p>the Point, in document coordinates.</p>
|
|
</div>
|
|
</li>
|
|
</ul>
|
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">number</span></h4>
|
|
<p>int the index of the segment, from zero to the number of points minus 2.</p>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
|
|
<a name="getLinkDirection" class="tsd-anchor"></a>
|
|
<h3>
|
|
<span class="tsd-flag ts-flagVirtual">Virtual</span>
|
|
get<wbr>Link<wbr>Direction
|
|
</h3>
|
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
|
<li class="tsd-signature tsd-kind-icon">get<wbr>Link<wbr>Direction<span class="tsd-signature-symbol">(</span>node<span class="tsd-signature-symbol">: </span><a href="Node.html" class="tsd-signature-type">Node</a><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">null</span>, port<span class="tsd-signature-symbol">: </span><a href="GraphObject.html" class="tsd-signature-type">GraphObject</a><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">null</span>, linkpoint<span class="tsd-signature-symbol">: </span><a href="Point.html" class="tsd-signature-type">Point</a>, spot<span class="tsd-signature-symbol">: </span><a href="Spot.html" class="tsd-signature-type">Spot</a>, from<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span>, ortho<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span>, othernode<span class="tsd-signature-symbol">: </span><a href="Node.html" class="tsd-signature-type">Node</a><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">null</span>, otherport<span class="tsd-signature-symbol">: </span><a href="GraphObject.html" class="tsd-signature-type">GraphObject</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">number</span></li>
|
|
</ul>
|
|
<ul class="tsd-descriptions">
|
|
<li class="tsd-description">
|
|
<div class="tsd-comment tsd-typography">
|
|
<p>Compute the direction in which a link should go from a given connection point.</p>
|
|
<dl class="tsd-comment-tags">
|
|
<dt>since</dt>
|
|
<dd><p>1.2</p>
|
|
</dd>
|
|
</dl>
|
|
</div>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>node: <a href="Node.html" class="tsd-signature-type">Node</a><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">null</span></h5>
|
|
</li>
|
|
<li>
|
|
<h5>port: <a href="GraphObject.html" class="tsd-signature-type">GraphObject</a><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">null</span></h5>
|
|
<div class="tsd-comment tsd-typography">
|
|
<p>the <a href="GraphObject.html">GraphObject</a> representing a port on the node.</p>
|
|
</div>
|
|
</li>
|
|
<li>
|
|
<h5>linkpoint: <a href="Point.html" class="tsd-signature-type">Point</a></h5>
|
|
<div class="tsd-comment tsd-typography">
|
|
<p>the connection point, in document coordinates.</p>
|
|
</div>
|
|
</li>
|
|
<li>
|
|
<h5>spot: <a href="Spot.html" class="tsd-signature-type">Spot</a></h5>
|
|
<div class="tsd-comment tsd-typography">
|
|
<p>a <a href="Spot.html">Spot</a> value describing where the link should connect.</p>
|
|
</div>
|
|
</li>
|
|
<li>
|
|
<h5>from: <span class="tsd-signature-type">boolean</span></h5>
|
|
<div class="tsd-comment tsd-typography">
|
|
<p>true if the link is coming out of the port; false if going to the port.</p>
|
|
</div>
|
|
</li>
|
|
<li>
|
|
<h5>ortho: <span class="tsd-signature-type">boolean</span></h5>
|
|
<div class="tsd-comment tsd-typography">
|
|
<p>whether the link should have orthogonal segments.</p>
|
|
</div>
|
|
</li>
|
|
<li>
|
|
<h5>othernode: <a href="Node.html" class="tsd-signature-type">Node</a><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">null</span></h5>
|
|
<div class="tsd-comment tsd-typography">
|
|
<p>the node at the other end of the link.</p>
|
|
</div>
|
|
</li>
|
|
<li>
|
|
<h5>otherport: <a href="GraphObject.html" class="tsd-signature-type">GraphObject</a><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">null</span></h5>
|
|
<div class="tsd-comment tsd-typography">
|
|
<p>the <a href="GraphObject.html">GraphObject</a> port at the other end of the link.</p>
|
|
</div>
|
|
</li>
|
|
</ul>
|
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">number</span></h4>
|
|
<p>the absolute angle, in degrees.</p>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
|
|
<a name="getLinkPoint" class="tsd-anchor"></a>
|
|
<h3>
|
|
<span class="tsd-flag ts-flagVirtual">Virtual</span>
|
|
get<wbr>Link<wbr>Point
|
|
</h3>
|
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
|
<li class="tsd-signature tsd-kind-icon">get<wbr>Link<wbr>Point<span class="tsd-signature-symbol">(</span>node<span class="tsd-signature-symbol">: </span><a href="Node.html" class="tsd-signature-type">Node</a><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">null</span>, port<span class="tsd-signature-symbol">: </span><a href="GraphObject.html" class="tsd-signature-type">GraphObject</a><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">null</span>, spot<span class="tsd-signature-symbol">: </span><a href="Spot.html" class="tsd-signature-type">Spot</a>, from<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span>, ortho<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span>, othernode<span class="tsd-signature-symbol">: </span><a href="Node.html" class="tsd-signature-type">Node</a><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">null</span>, otherport<span class="tsd-signature-symbol">: </span><a href="GraphObject.html" class="tsd-signature-type">GraphObject</a><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">null</span>, result<span class="tsd-signature-symbol">?: </span><a href="Point.html" class="tsd-signature-type">Point</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="Point.html" class="tsd-signature-type">Point</a></li>
|
|
</ul>
|
|
<ul class="tsd-descriptions">
|
|
<li class="tsd-description">
|
|
<div class="tsd-comment tsd-typography">
|
|
<p>Compute the point on a node/port in document coordinates at which the route of a link should end.</p>
|
|
<dl class="tsd-comment-tags">
|
|
<dt>since</dt>
|
|
<dd><p>1.2</p>
|
|
</dd>
|
|
</dl>
|
|
</div>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>node: <a href="Node.html" class="tsd-signature-type">Node</a><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">null</span></h5>
|
|
</li>
|
|
<li>
|
|
<h5>port: <a href="GraphObject.html" class="tsd-signature-type">GraphObject</a><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">null</span></h5>
|
|
<div class="tsd-comment tsd-typography">
|
|
<p>the <a href="GraphObject.html">GraphObject</a> representing a port on the node.</p>
|
|
</div>
|
|
</li>
|
|
<li>
|
|
<h5>spot: <a href="Spot.html" class="tsd-signature-type">Spot</a></h5>
|
|
<div class="tsd-comment tsd-typography">
|
|
<p>a <a href="Spot.html">Spot</a> value describing where the link should connect.</p>
|
|
</div>
|
|
</li>
|
|
<li>
|
|
<h5>from: <span class="tsd-signature-type">boolean</span></h5>
|
|
<div class="tsd-comment tsd-typography">
|
|
<p>true if the link is coming out of the port; false if going to the port.</p>
|
|
</div>
|
|
</li>
|
|
<li>
|
|
<h5>ortho: <span class="tsd-signature-type">boolean</span></h5>
|
|
<div class="tsd-comment tsd-typography">
|
|
<p>whether the link should have orthogonal segments.</p>
|
|
</div>
|
|
</li>
|
|
<li>
|
|
<h5>othernode: <a href="Node.html" class="tsd-signature-type">Node</a><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">null</span></h5>
|
|
<div class="tsd-comment tsd-typography">
|
|
<p>the node at the other end of the link.</p>
|
|
</div>
|
|
</li>
|
|
<li>
|
|
<h5>otherport: <a href="GraphObject.html" class="tsd-signature-type">GraphObject</a><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">null</span></h5>
|
|
<div class="tsd-comment tsd-typography">
|
|
<p>the <a href="GraphObject.html">GraphObject</a> port at the other end of the link.</p>
|
|
</div>
|
|
</li>
|
|
<li>
|
|
<h5><span class="tsd-flag ts-flagOptional">Optional</span> result: <a href="Point.html" class="tsd-signature-type">Point</a></h5>
|
|
<div class="tsd-comment tsd-typography">
|
|
<p>an optional Point that is modified and returned; otherwise it allocates and returns a new Point</p>
|
|
</div>
|
|
</li>
|
|
</ul>
|
|
<h4 class="tsd-returns-title">Returns <a href="Point.html" class="tsd-signature-type">Point</a></h4>
|
|
<p>in document coordinates.</p>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
|
|
<a name="getLinkPointFromPoint" class="tsd-anchor"></a>
|
|
<h3>
|
|
<span class="tsd-flag ts-flagVirtual">Virtual</span>
|
|
get<wbr>Link<wbr>Point<wbr>From<wbr>Point
|
|
</h3>
|
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
|
<li class="tsd-signature tsd-kind-icon">get<wbr>Link<wbr>Point<wbr>From<wbr>Point<span class="tsd-signature-symbol">(</span>node<span class="tsd-signature-symbol">: </span><a href="Node.html" class="tsd-signature-type">Node</a><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">null</span>, port<span class="tsd-signature-symbol">: </span><a href="GraphObject.html" class="tsd-signature-type">GraphObject</a><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">null</span>, focus<span class="tsd-signature-symbol">: </span><a href="Point.html" class="tsd-signature-type">Point</a>, p<span class="tsd-signature-symbol">: </span><a href="Point.html" class="tsd-signature-type">Point</a>, from<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span>, result<span class="tsd-signature-symbol">?: </span><a href="Point.html" class="tsd-signature-type">Point</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="Point.html" class="tsd-signature-type">Point</a></li>
|
|
</ul>
|
|
<ul class="tsd-descriptions">
|
|
<li class="tsd-description">
|
|
<div class="tsd-comment tsd-typography">
|
|
<p>Compute the intersection point in document coordinates for the edge of a particular port GraphObject, given a point,
|
|
when no particular spot or side has been specified.</p>
|
|
<dl class="tsd-comment-tags">
|
|
<dt>since</dt>
|
|
<dd><p>1.2</p>
|
|
</dd>
|
|
</dl>
|
|
</div>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>node: <a href="Node.html" class="tsd-signature-type">Node</a><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">null</span></h5>
|
|
</li>
|
|
<li>
|
|
<h5>port: <a href="GraphObject.html" class="tsd-signature-type">GraphObject</a><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">null</span></h5>
|
|
<div class="tsd-comment tsd-typography">
|
|
<p>the <a href="GraphObject.html">GraphObject</a> representing a port on the node.</p>
|
|
</div>
|
|
</li>
|
|
<li>
|
|
<h5>focus: <a href="Point.html" class="tsd-signature-type">Point</a></h5>
|
|
<div class="tsd-comment tsd-typography">
|
|
<p>the point in document coordinates to/from which the link should point,
|
|
normally the center of the port.</p>
|
|
</div>
|
|
</li>
|
|
<li>
|
|
<h5>p: <a href="Point.html" class="tsd-signature-type">Point</a></h5>
|
|
<div class="tsd-comment tsd-typography">
|
|
<p>often this point is far away from the node, to give a general direction,
|
|
particularly an orthogonal one.</p>
|
|
</div>
|
|
</li>
|
|
<li>
|
|
<h5>from: <span class="tsd-signature-type">boolean</span></h5>
|
|
<div class="tsd-comment tsd-typography">
|
|
<p>true if the link is coming out of the port; false if going to the port.</p>
|
|
</div>
|
|
</li>
|
|
<li>
|
|
<h5><span class="tsd-flag ts-flagOptional">Optional</span> result: <a href="Point.html" class="tsd-signature-type">Point</a></h5>
|
|
<div class="tsd-comment tsd-typography">
|
|
<p>an optional Point that is modified and returned; otherwise it allocates and returns a new Point</p>
|
|
</div>
|
|
</li>
|
|
</ul>
|
|
<h4 class="tsd-returns-title">Returns <a href="Point.html" class="tsd-signature-type">Point</a></h4>
|
|
<p>the point in document coordinates of the intersection point on the edge of the port.</p>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
|
|
<a name="getOtherNode" class="tsd-anchor"></a>
|
|
<h3>
|
|
get<wbr>Other<wbr>Node
|
|
</h3>
|
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
|
<li class="tsd-signature tsd-kind-icon">get<wbr>Other<wbr>Node<span class="tsd-signature-symbol">(</span>node<span class="tsd-signature-symbol">: </span><a href="Node.html" class="tsd-signature-type">Node</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="Node.html" class="tsd-signature-type">Node</a><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 <a href="Node.html">Node</a>, return the node at the other end of this link.</p>
|
|
</div>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>node: <a href="Node.html" class="tsd-signature-type">Node</a></h5>
|
|
</li>
|
|
</ul>
|
|
<h4 class="tsd-returns-title">Returns
|
|
<a href="Node.html" class="tsd-signature-type">Node</a>
|
|
<span class="tsd-signature-symbol"> | </span>
|
|
<span class="tsd-signature-type">null</span>
|
|
</h4>
|
|
<p>This may return the same node, if the link is reflexive.</p>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
|
|
<a name="getOtherPort" class="tsd-anchor"></a>
|
|
<h3>
|
|
get<wbr>Other<wbr>Port
|
|
</h3>
|
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
|
<li class="tsd-signature tsd-kind-icon">get<wbr>Other<wbr>Port<span class="tsd-signature-symbol">(</span>port<span class="tsd-signature-symbol">: </span><a href="GraphObject.html" class="tsd-signature-type">GraphObject</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="GraphObject.html" class="tsd-signature-type">GraphObject</a><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 <a href="GraphObject.html">GraphObject</a> that is a "port", return the port at the other end of this link.</p>
|
|
</div>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>port: <a href="GraphObject.html" class="tsd-signature-type">GraphObject</a></h5>
|
|
</li>
|
|
</ul>
|
|
<h4 class="tsd-returns-title">Returns
|
|
<a href="GraphObject.html" class="tsd-signature-type">GraphObject</a>
|
|
<span class="tsd-signature-symbol"> | </span>
|
|
<span class="tsd-signature-type">null</span>
|
|
</h4>
|
|
<p>This may return the same object, if the link is reflexive.</p>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
|
|
<a name="getPoint" class="tsd-anchor"></a>
|
|
<h3>
|
|
get<wbr>Point
|
|
</h3>
|
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
|
<li class="tsd-signature tsd-kind-icon">get<wbr>Point<span class="tsd-signature-symbol">(</span>i<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><a href="Point.html" class="tsd-signature-type">Point</a></li>
|
|
</ul>
|
|
<ul class="tsd-descriptions">
|
|
<li class="tsd-description">
|
|
<div class="tsd-comment tsd-typography">
|
|
<p>Gets a particular point of the route.</p>
|
|
</div>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>i: <span class="tsd-signature-type">number</span></h5>
|
|
<div class="tsd-comment tsd-typography">
|
|
<p>int The zero-based index of the desired point.</p>
|
|
</div>
|
|
</li>
|
|
</ul>
|
|
<h4 class="tsd-returns-title">Returns <a href="Point.html" class="tsd-signature-type">Point</a></h4>
|
|
<p>in document coordinates</p>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
|
|
<a name="hasCurviness" class="tsd-anchor"></a>
|
|
<h3>
|
|
<span class="tsd-flag ts-flagVirtual">Virtual</span>
|
|
has<wbr>Curviness
|
|
</h3>
|
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
|
<li class="tsd-signature tsd-kind-icon">has<wbr>Curviness<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span></li>
|
|
</ul>
|
|
<ul class="tsd-descriptions">
|
|
<li class="tsd-description">
|
|
<div class="tsd-comment tsd-typography">
|
|
<p>Returns true if an extra or a different point is needed based on <a href="Link.html#curviness">curviness</a>.</p>
|
|
<p>This method may be overridden.
|
|
Please read the Introduction page on <a href="../../intro/extensions.html">Extensions</a> for how to override methods and how to call this base method.</p>
|
|
<dl class="tsd-comment-tags">
|
|
<dt>since</dt>
|
|
<dd><p>1.6</p>
|
|
</dd>
|
|
</dl>
|
|
</div>
|
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
|
|
<a name="insertPoint" class="tsd-anchor"></a>
|
|
<h3>
|
|
insert<wbr>Point
|
|
</h3>
|
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
|
<li class="tsd-signature tsd-kind-icon">insert<wbr>Point<span class="tsd-signature-symbol">(</span>i<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span>, p<span class="tsd-signature-symbol">: </span><a href="Point.html" class="tsd-signature-type">Point</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>Insert a point at a particular position in the route, without replacing an existing point; this may only be called within an override of <a href="Link.html#computePoints">computePoints</a>.</p>
|
|
<dl class="tsd-comment-tags">
|
|
<dt>see</dt>
|
|
<dd><p><a href="Link.html#getPoint">getPoint</a>, <a href="Link.html#setPoint">setPoint</a>, <a href="Link.html#addPoint">addPoint</a>, <a href="Link.html#removePoint">removePoint</a></p>
|
|
</dd>
|
|
<dt>since</dt>
|
|
<dd><p>1.6</p>
|
|
</dd>
|
|
</dl>
|
|
</div>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>i: <span class="tsd-signature-type">number</span></h5>
|
|
<div class="tsd-comment tsd-typography">
|
|
<p>int The zero-based index of the new point.</p>
|
|
</div>
|
|
</li>
|
|
<li>
|
|
<h5>p: <a href="Point.html" class="tsd-signature-type">Point</a></h5>
|
|
<div class="tsd-comment tsd-typography">
|
|
<p>The new point in document coordinates, which should not have infinite or NaN coordinate values, and which must not be modified afterwards.</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="invalidateRoute" class="tsd-anchor"></a>
|
|
<h3>
|
|
invalidate<wbr>Route
|
|
</h3>
|
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
|
<li class="tsd-signature tsd-kind-icon">invalidate<wbr>Route<span class="tsd-signature-symbol">(</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>Declare that the route (the <a href="Link.html#points">points</a>) of this Link need to be recomputed soon.
|
|
This causes <a href="Link.html#updateRoute">updateRoute</a> to be called, which will call <a href="Link.html#computePoints">computePoints</a>
|
|
to perform the actual determination of the route.</p>
|
|
<dl class="tsd-comment-tags">
|
|
<dt>since</dt>
|
|
<dd><p>1.6</p>
|
|
</dd>
|
|
</dl>
|
|
</div>
|
|
<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="makeGeometry" class="tsd-anchor"></a>
|
|
<h3>
|
|
<span class="tsd-flag ts-flagVirtual">Virtual</span>
|
|
make<wbr>Geometry
|
|
</h3>
|
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
|
<li class="tsd-signature tsd-kind-icon">make<wbr>Geometry<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="Geometry.html" class="tsd-signature-type">Geometry</a></li>
|
|
</ul>
|
|
<ul class="tsd-descriptions">
|
|
<li class="tsd-description">
|
|
<div class="tsd-comment tsd-typography">
|
|
<p>Produce a <a href="Geometry.html">Geometry</a> given the points of this route,
|
|
depending on the value of <a href="Link.html#curve">curve</a> and <a href="Link.html#corner">corner</a> and perhaps other properties.
|
|
The points of the Geometry are in local coordinates, whereas the <a href="Link.html#points">points</a> of the link route are in document coordinates.</p>
|
|
<p>This method may be overridden.
|
|
Please read the Introduction page on <a href="../../intro/extensions.html">Extensions</a> for how to override methods and how to call this base method.</p>
|
|
<dl class="tsd-comment-tags">
|
|
<dt>since</dt>
|
|
<dd><p>1.6</p>
|
|
</dd>
|
|
</dl>
|
|
</div>
|
|
<h4 class="tsd-returns-title">Returns <a href="Geometry.html" class="tsd-signature-type">Geometry</a></h4>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
|
|
<a name="move" class="tsd-anchor"></a>
|
|
<h3>
|
|
<span class="tsd-flag ts-flagOverride">Override</span>
|
|
move
|
|
</h3>
|
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
|
<li class="tsd-signature tsd-kind-icon">move<span class="tsd-signature-symbol">(</span>newpos<span class="tsd-signature-symbol">: </span><a href="Point.html" class="tsd-signature-type">Point</a>, useLocation<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</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>Move this link to a new position.
|
|
This also shifts all of the Points in the route accordingly.
|
|
This also moves any <a href="Link.html#labelNodes">labelNodes</a>.</p>
|
|
</div>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>newpos: <a href="Point.html" class="tsd-signature-type">Point</a></h5>
|
|
<div class="tsd-comment tsd-typography">
|
|
<p>a new <a href="Point.html">Point</a> in document coordinates.</p>
|
|
</div>
|
|
</li>
|
|
<li>
|
|
<h5><span class="tsd-flag ts-flagOptional">Optional</span> useLocation: <span class="tsd-signature-type">boolean</span></h5>
|
|
<div class="tsd-comment tsd-typography">
|
|
<p>true if you want to set the <a href="Part.html#location">location</a> instead of the position. False by default.</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="removePoint" class="tsd-anchor"></a>
|
|
<h3>
|
|
remove<wbr>Point
|
|
</h3>
|
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
|
<li class="tsd-signature tsd-kind-icon">remove<wbr>Point<span class="tsd-signature-symbol">(</span>i<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>Remove a particular point from the route; this may only be called within an override of <a href="Link.html#computePoints">computePoints</a>.</p>
|
|
<dl class="tsd-comment-tags">
|
|
<dt>see</dt>
|
|
<dd><p><a href="Link.html#getPoint">getPoint</a>, <a href="Link.html#setPoint">setPoint</a>, <a href="Link.html#insertPoint">insertPoint</a>, <a href="Link.html#addPoint">addPoint</a>, <a href="Link.html#clearPoints">clearPoints</a></p>
|
|
</dd>
|
|
<dt>since</dt>
|
|
<dd><p>1.6</p>
|
|
</dd>
|
|
</dl>
|
|
</div>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>i: <span class="tsd-signature-type">number</span></h5>
|
|
<div class="tsd-comment tsd-typography">
|
|
<p>int The zero-based index of the point to extract.</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="setPoint" class="tsd-anchor"></a>
|
|
<h3>
|
|
set<wbr>Point
|
|
</h3>
|
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
|
<li class="tsd-signature tsd-kind-icon">set<wbr>Point<span class="tsd-signature-symbol">(</span>i<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span>, p<span class="tsd-signature-symbol">: </span><a href="Point.html" class="tsd-signature-type">Point</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>Sets a particular point of the route; this may only be called within an override of <a href="Link.html#computePoints">computePoints</a>.</p>
|
|
<dl class="tsd-comment-tags">
|
|
<dt>see</dt>
|
|
<dd><p><a href="Link.html#getPoint">getPoint</a>, <a href="Link.html#insertPoint">insertPoint</a>, <a href="Link.html#addPoint">addPoint</a>, <a href="Link.html#removePoint">removePoint</a></p>
|
|
</dd>
|
|
<dt>since</dt>
|
|
<dd><p>1.6</p>
|
|
</dd>
|
|
</dl>
|
|
</div>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>i: <span class="tsd-signature-type">number</span></h5>
|
|
<div class="tsd-comment tsd-typography">
|
|
<p>int The zero-based index of the desired point.</p>
|
|
</div>
|
|
</li>
|
|
<li>
|
|
<h5>p: <a href="Point.html" class="tsd-signature-type">Point</a></h5>
|
|
<div class="tsd-comment tsd-typography">
|
|
<p>The new point in document coordinates, which should not have infinite or NaN coordinate values, and which must not be modified afterwards.</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="updateRoute" class="tsd-anchor"></a>
|
|
<h3>
|
|
update<wbr>Route
|
|
</h3>
|
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
|
<li class="tsd-signature tsd-kind-icon">update<wbr>Route<span class="tsd-signature-symbol">(</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>This method recomputes the route if the route is invalid,
|
|
to make sure the <a href="Link.html#points">points</a> are up-to-date.
|
|
This method calls <a href="Link.html#computePoints">computePoints</a> in order to calculate a new route.</p>
|
|
<p>The route may become invalid if either connected node is moved,
|
|
or if various properties are modified, such as <a href="Link.html#routing">routing</a>.
|
|
Such changes will call <a href="Link.html#invalidateRoute">invalidateRoute</a>.</p>
|
|
<p>It is unusual for you to have to call this method.</p>
|
|
<dl class="tsd-comment-tags">
|
|
<dt>since</dt>
|
|
<dd><p>1.6</p>
|
|
</dd>
|
|
</dl>
|
|
</div>
|
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
</section>
|
|
<section class="tsd-panel-group tsd-member-group ">
|
|
<h2>Constants</h2>
|
|
<section class="tsd-panel tsd-member tsd-kind-constant tsd-parent-kind-class tsd-is-static">
|
|
<a name="static-AvoidsNodes" class="tsd-anchor"></a>
|
|
<h3>
|
|
<span class="tsd-flag ts-flagStatic">Static</span>
|
|
Avoids<wbr>Nodes
|
|
<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">EnumValue</span> </h3>
|
|
<div class="tsd-comment tsd-typography">
|
|
<p>Used as a value for <a href="Link.html#routing">Link.routing</a>:
|
|
each segment is horizontal or vertical, but the route tries to avoid crossing over nodes.</p>
|
|
</div>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-constant tsd-parent-kind-class tsd-is-static">
|
|
<a name="static-Bezier" class="tsd-anchor"></a>
|
|
<h3>
|
|
<span class="tsd-flag ts-flagStatic">Static</span>
|
|
Bezier
|
|
<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">EnumValue</span> </h3>
|
|
<div class="tsd-comment tsd-typography">
|
|
<p>Used as a value for <a href="Link.html#curve">Link.curve</a>, to indicate that
|
|
the link path uses Bezier curve segments.</p>
|
|
</div>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-constant tsd-parent-kind-class tsd-is-static">
|
|
<a name="static-End" class="tsd-anchor"></a>
|
|
<h3>
|
|
<span class="tsd-flag ts-flagStatic">Static</span>
|
|
End
|
|
<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">EnumValue</span> </h3>
|
|
<div class="tsd-comment tsd-typography">
|
|
<p>Used as a value for <a href="Link.html#adjusting">Link.adjusting</a>,
|
|
to indicate that the link route computation should keep the
|
|
intermediate points of the previous route, just modifying the first and/or last points;
|
|
if the routing is orthogonal, it will only modify the first two and/or last two points.</p>
|
|
</div>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-constant tsd-parent-kind-class tsd-is-static">
|
|
<a name="static-JumpGap" class="tsd-anchor"></a>
|
|
<h3>
|
|
<span class="tsd-flag ts-flagStatic">Static</span>
|
|
Jump<wbr>Gap
|
|
<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">EnumValue</span> </h3>
|
|
<div class="tsd-comment tsd-typography">
|
|
<p>Used as a value for <a href="Link.html#curve">Link.curve</a>, to indicate that
|
|
orthogonal link segments will be discontinuous where they cross over
|
|
other orthogonal link segments that have a <a href="Link.html#curve">Link.curve</a> or JumpOver or JumpGap.</p>
|
|
</div>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-constant tsd-parent-kind-class tsd-is-static">
|
|
<a name="static-JumpOver" class="tsd-anchor"></a>
|
|
<h3>
|
|
<span class="tsd-flag ts-flagStatic">Static</span>
|
|
Jump<wbr>Over
|
|
<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">EnumValue</span> </h3>
|
|
<div class="tsd-comment tsd-typography">
|
|
<p>Used as a value for <a href="Link.html#curve">Link.curve</a>, to indicate that
|
|
orthogonal link segments will veer around where they cross over
|
|
other orthogonal link segments that have a <a href="Link.html#curve">Link.curve</a> or JumpOver or JumpGap.</p>
|
|
</div>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-constant tsd-parent-kind-class tsd-is-static">
|
|
<a name="static-None" class="tsd-anchor"></a>
|
|
<h3>
|
|
<span class="tsd-flag ts-flagStatic">Static</span> <span class="tsd-flag ts-flagOverride">Override</span>
|
|
None
|
|
<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">EnumValue</span> </h3>
|
|
<div class="tsd-comment tsd-typography">
|
|
<p>This is the default value for <a href="Link.html#curve">Link.curve</a> and <a href="Link.html#adjusting">Link.adjusting</a>,
|
|
to indicate that the path geometry consists of straight line segments and
|
|
to indicate that the link route computation does not depend on any previous route points;
|
|
this can also be used as a value for <a href="GraphObject.html#segmentOrientation">GraphObject.segmentOrientation</a>
|
|
to indicate that the object is never rotated along the link route -- its angle is unchanged.</p>
|
|
</div>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-constant tsd-parent-kind-class tsd-is-static">
|
|
<a name="static-Normal" class="tsd-anchor"></a>
|
|
<h3>
|
|
<span class="tsd-flag ts-flagStatic">Static</span>
|
|
Normal
|
|
<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">EnumValue</span> </h3>
|
|
<div class="tsd-comment tsd-typography">
|
|
<p>Used as the default value for <a href="Link.html#routing">Link.routing</a>:
|
|
the route goes fairly straight between ports.</p>
|
|
</div>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-constant tsd-parent-kind-class tsd-is-static">
|
|
<a name="static-OrientAlong" class="tsd-anchor"></a>
|
|
<h3>
|
|
<span class="tsd-flag ts-flagStatic">Static</span>
|
|
Orient<wbr>Along
|
|
<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">EnumValue</span> </h3>
|
|
<div class="tsd-comment tsd-typography">
|
|
<p>This value for <a href="GraphObject.html#segmentOrientation">GraphObject.segmentOrientation</a> results in
|
|
the GraphObject turned to have the same angle as the route:
|
|
the GraphObject's angle is always the same as the angle of the link's route
|
|
at the segment where the GraphObject is attached;
|
|
use this orientation for arrow heads.</p>
|
|
</div>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-constant tsd-parent-kind-class tsd-is-static">
|
|
<a name="static-OrientMinus90" class="tsd-anchor"></a>
|
|
<h3>
|
|
<span class="tsd-flag ts-flagStatic">Static</span>
|
|
Orient<wbr>Minus90
|
|
<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">EnumValue</span> </h3>
|
|
<div class="tsd-comment tsd-typography">
|
|
<p>This value for <a href="GraphObject.html#segmentOrientation">GraphObject.segmentOrientation</a> results in
|
|
the GraphObject being turned counter-clockwise to be perpendicular to the route:
|
|
the GraphObject's angle is always 90 degrees less than the angle of the link's route
|
|
at the segment where the GraphObject is attached.</p>
|
|
</div>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-constant tsd-parent-kind-class tsd-is-static">
|
|
<a name="static-OrientMinus90Upright" class="tsd-anchor"></a>
|
|
<h3>
|
|
<span class="tsd-flag ts-flagStatic">Static</span>
|
|
Orient<wbr>Minus90<wbr>Upright
|
|
<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">EnumValue</span> </h3>
|
|
<div class="tsd-comment tsd-typography">
|
|
<p>This value for <a href="GraphObject.html#segmentOrientation">GraphObject.segmentOrientation</a> results in
|
|
the GraphObject turned counter-clockwise to be perpendicular to the route, just like <a href="Link.html#static-OrientMinus90">Link.OrientMinus90</a>, but is never upside down:
|
|
the GraphObject's angle always being 90 degrees less than the angle of the link's route
|
|
at the segment where the GraphObject is attached;
|
|
this is typically only used for <a href="TextBlock.html">TextBlock</a>s or <a href="Panel.html">Panel</a>s that contain text.</p>
|
|
</div>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-constant tsd-parent-kind-class tsd-is-static">
|
|
<a name="static-OrientOpposite" class="tsd-anchor"></a>
|
|
<h3>
|
|
<span class="tsd-flag ts-flagStatic">Static</span>
|
|
Orient<wbr>Opposite
|
|
<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">EnumValue</span> </h3>
|
|
<div class="tsd-comment tsd-typography">
|
|
<p>This value for <a href="GraphObject.html#segmentOrientation">GraphObject.segmentOrientation</a> results in
|
|
the GraphObject's angle always being 180 degrees opposite from the angle of the link's route
|
|
at the segment where the GraphObject is attached.</p>
|
|
</div>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-constant tsd-parent-kind-class tsd-is-static">
|
|
<a name="static-OrientPlus90" class="tsd-anchor"></a>
|
|
<h3>
|
|
<span class="tsd-flag ts-flagStatic">Static</span>
|
|
Orient<wbr>Plus90
|
|
<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">EnumValue</span> </h3>
|
|
<div class="tsd-comment tsd-typography">
|
|
<p>This value for <a href="GraphObject.html#segmentOrientation">GraphObject.segmentOrientation</a> results in
|
|
the GraphObject is turned clockwise to be perpendicular to the route:
|
|
the GraphObject's angle is always 90 degrees more than the angle of the link's route
|
|
at the segment where the GraphObject is attached.</p>
|
|
</div>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-constant tsd-parent-kind-class tsd-is-static">
|
|
<a name="static-OrientPlus90Upright" class="tsd-anchor"></a>
|
|
<h3>
|
|
<span class="tsd-flag ts-flagStatic">Static</span>
|
|
Orient<wbr>Plus90<wbr>Upright
|
|
<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">EnumValue</span> </h3>
|
|
<div class="tsd-comment tsd-typography">
|
|
<p>This value for <a href="GraphObject.html#segmentOrientation">GraphObject.segmentOrientation</a> results in
|
|
the GraphObject turned clockwise to be perpendicular to the route, just like <a href="Link.html#static-OrientPlus90">Link.OrientPlus90</a>, but is never upside down:
|
|
the GraphObject's angle always being 90 degrees more than the angle of the link's route
|
|
at the segment where the GraphObject is attached;
|
|
this is typically only used for <a href="TextBlock.html">TextBlock</a>s or <a href="Panel.html">Panel</a>s that contain text.</p>
|
|
</div>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-constant tsd-parent-kind-class tsd-is-static">
|
|
<a name="static-OrientUpright" class="tsd-anchor"></a>
|
|
<h3>
|
|
<span class="tsd-flag ts-flagStatic">Static</span>
|
|
Orient<wbr>Upright
|
|
<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">EnumValue</span> </h3>
|
|
<div class="tsd-comment tsd-typography">
|
|
<p>This value for <a href="GraphObject.html#segmentOrientation">GraphObject.segmentOrientation</a> results in
|
|
the GraphObject turned to have the same angle as the route, just like <a href="Link.html#static-OrientAlong">Link.OrientAlong</a>, but is never upside down:
|
|
the GraphObject's angle always following the angle of the link's route
|
|
at the segment where the GraphObject is attached;
|
|
this is typically only used for <a href="TextBlock.html">TextBlock</a>s or <a href="Panel.html">Panel</a>s that contain text.</p>
|
|
</div>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-constant tsd-parent-kind-class tsd-is-static">
|
|
<a name="static-OrientUpright45" class="tsd-anchor"></a>
|
|
<h3>
|
|
<span class="tsd-flag ts-flagStatic">Static</span>
|
|
Orient<wbr>Upright45
|
|
<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">EnumValue</span> </h3>
|
|
<div class="tsd-comment tsd-typography">
|
|
<p>This value for <a href="GraphObject.html#segmentOrientation">GraphObject.segmentOrientation</a> results in
|
|
the GraphObject's angle always following the angle of the link's route
|
|
at the segment where the GraphObject is attached, but never upside down
|
|
and never angled more than +/- 45 degrees:
|
|
when the route's angle is within 45 degrees of vertical (90 or 270 degrees),
|
|
the GraphObject's angle is set to zero;
|
|
this is typically only used for <a href="TextBlock.html">TextBlock</a>s or <a href="Panel.html">Panel</a>s that contain text.</p>
|
|
</div>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-constant tsd-parent-kind-class tsd-is-static">
|
|
<a name="static-Orthogonal" class="tsd-anchor"></a>
|
|
<h3>
|
|
<span class="tsd-flag ts-flagStatic">Static</span>
|
|
Orthogonal
|
|
<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">EnumValue</span> </h3>
|
|
<div class="tsd-comment tsd-typography">
|
|
<p>Used as a value for <a href="Link.html#routing">Link.routing</a>:
|
|
each segment is horizontal or vertical.</p>
|
|
</div>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-constant tsd-parent-kind-class tsd-is-static">
|
|
<a name="static-Scale" class="tsd-anchor"></a>
|
|
<h3>
|
|
<span class="tsd-flag ts-flagStatic">Static</span>
|
|
Scale
|
|
<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">EnumValue</span> </h3>
|
|
<div class="tsd-comment tsd-typography">
|
|
<p>Used as a value for <a href="Link.html#adjusting">Link.adjusting</a>,
|
|
to indicate that the link route computation should scale and rotate the intermediate points
|
|
so that the link's shape looks approximately the same;
|
|
if the routing is orthogonal, this value is treated as if it were <a href="Link.html#static-End">Link.End</a>.</p>
|
|
</div>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-constant tsd-parent-kind-class tsd-is-static">
|
|
<a name="static-Stretch" class="tsd-anchor"></a>
|
|
<h3>
|
|
<span class="tsd-flag ts-flagStatic">Static</span>
|
|
Stretch
|
|
<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">EnumValue</span> </h3>
|
|
<div class="tsd-comment tsd-typography">
|
|
<p>Used as a value for <a href="Link.html#adjusting">Link.adjusting</a>,
|
|
to indicate that the link route computation should linearly interpolate the intermediate points
|
|
so that the link's shape looks stretched;
|
|
if the routing is orthogonal, this value is treated as if it were <a href="Link.html#static-End">Link.End</a>.</p>
|
|
</div>
|
|
</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">
|
|
<a href="Link.html" class="tsd-kind-icon">Link</a>
|
|
<ul>
|
|
<li class=" tsd-kind-constructor tsd-parent-kind-class">
|
|
<a href="Link.html#constructor" class="tsd-kind-icon">constructor</a>
|
|
</li>
|
|
<li class=" tsd-kind-accessor tsd-parent-kind-class">
|
|
<a href="Link.html#adjusting" class="tsd-kind-icon">adjusting</a>
|
|
</li>
|
|
<li class=" tsd-kind-accessor tsd-parent-kind-class">
|
|
<a href="Link.html#corner" class="tsd-kind-icon">corner</a>
|
|
</li>
|
|
<li class=" tsd-kind-accessor tsd-parent-kind-class">
|
|
<a href="Link.html#curve" class="tsd-kind-icon">curve</a>
|
|
</li>
|
|
<li class=" tsd-kind-accessor tsd-parent-kind-class">
|
|
<a href="Link.html#curviness" class="tsd-kind-icon">curviness</a>
|
|
</li>
|
|
<li class=" tsd-kind-accessor tsd-parent-kind-class">
|
|
<a href="Link.html#fromEndSegmentLength" class="tsd-kind-icon">from<wbr>End<wbr>Segment<wbr>Length</a>
|
|
</li>
|
|
<li class=" tsd-kind-accessor tsd-parent-kind-class">
|
|
<a href="Link.html#fromNode" class="tsd-kind-icon">from<wbr>Node</a>
|
|
</li>
|
|
<li class=" tsd-kind-get-signature tsd-parent-kind-class">
|
|
<a href="Link.html#fromPort" class="tsd-kind-icon">from<wbr>Port</a>
|
|
</li>
|
|
<li class=" tsd-kind-accessor tsd-parent-kind-class">
|
|
<a href="Link.html#fromPortChanged" class="tsd-kind-icon">from<wbr>Port<wbr>Changed</a>
|
|
</li>
|
|
<li class=" tsd-kind-accessor tsd-parent-kind-class">
|
|
<a href="Link.html#fromPortId" class="tsd-kind-icon">from<wbr>Port<wbr>Id</a>
|
|
</li>
|
|
<li class=" tsd-kind-accessor tsd-parent-kind-class">
|
|
<a href="Link.html#fromShortLength" class="tsd-kind-icon">from<wbr>Short<wbr>Length</a>
|
|
</li>
|
|
<li class=" tsd-kind-accessor tsd-parent-kind-class">
|
|
<a href="Link.html#fromSpot" class="tsd-kind-icon">from<wbr>Spot</a>
|
|
</li>
|
|
<li class=" tsd-kind-get-signature tsd-parent-kind-class">
|
|
<a href="Link.html#geometry" class="tsd-kind-icon">geometry</a>
|
|
</li>
|
|
<li class=" tsd-kind-get-signature tsd-parent-kind-class">
|
|
<a href="Link.html#isLabeledLink" class="tsd-kind-icon">is<wbr>Labeled<wbr>Link</a>
|
|
</li>
|
|
<li class=" tsd-kind-get-signature tsd-parent-kind-class">
|
|
<a href="Link.html#isOrthogonal" class="tsd-kind-icon">is<wbr>Orthogonal</a>
|
|
</li>
|
|
<li class=" tsd-kind-accessor tsd-parent-kind-class">
|
|
<a href="Link.html#isTreeLink" class="tsd-kind-icon">is<wbr>Tree<wbr>Link</a>
|
|
</li>
|
|
<li class=" tsd-kind-get-signature tsd-parent-kind-class">
|
|
<a href="Link.html#key" class="tsd-kind-icon">key</a>
|
|
</li>
|
|
<li class=" tsd-kind-get-signature tsd-parent-kind-class">
|
|
<a href="Link.html#labelNodes" class="tsd-kind-icon">label<wbr>Nodes</a>
|
|
</li>
|
|
<li class=" tsd-kind-get-signature tsd-parent-kind-class">
|
|
<a href="Link.html#midAngle" class="tsd-kind-icon">mid<wbr>Angle</a>
|
|
</li>
|
|
<li class=" tsd-kind-get-signature tsd-parent-kind-class">
|
|
<a href="Link.html#midPoint" class="tsd-kind-icon">mid<wbr>Point</a>
|
|
</li>
|
|
<li class=" tsd-kind-get-signature tsd-parent-kind-class">
|
|
<a href="Link.html#path" class="tsd-kind-icon">path</a>
|
|
</li>
|
|
<li class=" tsd-kind-accessor tsd-parent-kind-class">
|
|
<a href="Link.html#points" class="tsd-kind-icon">points</a>
|
|
</li>
|
|
<li class=" tsd-kind-get-signature tsd-parent-kind-class">
|
|
<a href="Link.html#pointsCount" class="tsd-kind-icon">points<wbr>Count</a>
|
|
</li>
|
|
<li class=" tsd-kind-accessor tsd-parent-kind-class">
|
|
<a href="Link.html#relinkableFrom" class="tsd-kind-icon">relinkable<wbr>From</a>
|
|
</li>
|
|
<li class=" tsd-kind-accessor tsd-parent-kind-class">
|
|
<a href="Link.html#relinkableTo" class="tsd-kind-icon">relinkable<wbr>To</a>
|
|
</li>
|
|
<li class=" tsd-kind-accessor tsd-parent-kind-class">
|
|
<a href="Link.html#resegmentable" class="tsd-kind-icon">resegmentable</a>
|
|
</li>
|
|
<li class=" tsd-kind-accessor tsd-parent-kind-class">
|
|
<a href="Link.html#routing" class="tsd-kind-icon">routing</a>
|
|
</li>
|
|
<li class=" tsd-kind-accessor tsd-parent-kind-class">
|
|
<a href="Link.html#smoothness" class="tsd-kind-icon">smoothness</a>
|
|
</li>
|
|
<li class=" tsd-kind-accessor tsd-parent-kind-class">
|
|
<a href="Link.html#toEndSegmentLength" class="tsd-kind-icon">to<wbr>End<wbr>Segment<wbr>Length</a>
|
|
</li>
|
|
<li class=" tsd-kind-accessor tsd-parent-kind-class">
|
|
<a href="Link.html#toNode" class="tsd-kind-icon">to<wbr>Node</a>
|
|
</li>
|
|
<li class=" tsd-kind-get-signature tsd-parent-kind-class">
|
|
<a href="Link.html#toPort" class="tsd-kind-icon">to<wbr>Port</a>
|
|
</li>
|
|
<li class=" tsd-kind-accessor tsd-parent-kind-class">
|
|
<a href="Link.html#toPortChanged" class="tsd-kind-icon">to<wbr>Port<wbr>Changed</a>
|
|
</li>
|
|
<li class=" tsd-kind-accessor tsd-parent-kind-class">
|
|
<a href="Link.html#toPortId" class="tsd-kind-icon">to<wbr>Port<wbr>Id</a>
|
|
</li>
|
|
<li class=" tsd-kind-accessor tsd-parent-kind-class">
|
|
<a href="Link.html#toShortLength" class="tsd-kind-icon">to<wbr>Short<wbr>Length</a>
|
|
</li>
|
|
<li class=" tsd-kind-accessor tsd-parent-kind-class">
|
|
<a href="Link.html#toSpot" class="tsd-kind-icon">to<wbr>Spot</a>
|
|
</li>
|
|
<li class=" tsd-kind-method tsd-parent-kind-class">
|
|
<a href="Link.html#addPoint" class="tsd-kind-icon">add<wbr>Point</a>
|
|
</li>
|
|
<li class=" tsd-kind-method tsd-parent-kind-class">
|
|
<a href="Link.html#canRelinkFrom" class="tsd-kind-icon">can<wbr>Relink<wbr>From</a>
|
|
</li>
|
|
<li class=" tsd-kind-method tsd-parent-kind-class">
|
|
<a href="Link.html#canRelinkTo" class="tsd-kind-icon">can<wbr>Relink<wbr>To</a>
|
|
</li>
|
|
<li class=" tsd-kind-method tsd-parent-kind-class">
|
|
<a href="Link.html#clearPoints" class="tsd-kind-icon">clear<wbr>Points</a>
|
|
</li>
|
|
<li class=" tsd-kind-method tsd-parent-kind-class">
|
|
<a href="Link.html#computeCurve" class="tsd-kind-icon">compute<wbr>Curve</a>
|
|
</li>
|
|
<li class=" tsd-kind-method tsd-parent-kind-class">
|
|
<a href="Link.html#computeCurviness" class="tsd-kind-icon">compute<wbr>Curviness</a>
|
|
</li>
|
|
<li class=" tsd-kind-method tsd-parent-kind-class">
|
|
<a href="Link.html#computeEndSegmentLength" class="tsd-kind-icon">compute<wbr>End<wbr>Segment<wbr>Length</a>
|
|
</li>
|
|
<li class=" tsd-kind-method tsd-parent-kind-class">
|
|
<a href="Link.html#computeOtherPoint" class="tsd-kind-icon">compute<wbr>Other<wbr>Point</a>
|
|
</li>
|
|
<li class=" tsd-kind-method tsd-parent-kind-class">
|
|
<a href="Link.html#computePoints" class="tsd-kind-icon">compute<wbr>Points</a>
|
|
</li>
|
|
<li class=" tsd-kind-method tsd-parent-kind-class">
|
|
<a href="Link.html#computeSpacing" class="tsd-kind-icon">compute<wbr>Spacing</a>
|
|
</li>
|
|
<li class=" tsd-kind-method tsd-parent-kind-class">
|
|
<a href="Link.html#computeSpot" class="tsd-kind-icon">compute<wbr>Spot</a>
|
|
</li>
|
|
<li class=" tsd-kind-method tsd-parent-kind-class">
|
|
<a href="Link.html#computeThickness" class="tsd-kind-icon">compute<wbr>Thickness</a>
|
|
</li>
|
|
<li class=" tsd-kind-method tsd-parent-kind-class">
|
|
<a href="Link.html#findClosestSegment" class="tsd-kind-icon">find<wbr>Closest<wbr>Segment</a>
|
|
</li>
|
|
<li class=" tsd-kind-method tsd-parent-kind-class">
|
|
<a href="Link.html#getLinkDirection" class="tsd-kind-icon">get<wbr>Link<wbr>Direction</a>
|
|
</li>
|
|
<li class=" tsd-kind-method tsd-parent-kind-class">
|
|
<a href="Link.html#getLinkPoint" class="tsd-kind-icon">get<wbr>Link<wbr>Point</a>
|
|
</li>
|
|
<li class=" tsd-kind-method tsd-parent-kind-class">
|
|
<a href="Link.html#getLinkPointFromPoint" class="tsd-kind-icon">get<wbr>Link<wbr>Point<wbr>From<wbr>Point</a>
|
|
</li>
|
|
<li class=" tsd-kind-method tsd-parent-kind-class">
|
|
<a href="Link.html#getOtherNode" class="tsd-kind-icon">get<wbr>Other<wbr>Node</a>
|
|
</li>
|
|
<li class=" tsd-kind-method tsd-parent-kind-class">
|
|
<a href="Link.html#getOtherPort" class="tsd-kind-icon">get<wbr>Other<wbr>Port</a>
|
|
</li>
|
|
<li class=" tsd-kind-method tsd-parent-kind-class">
|
|
<a href="Link.html#getPoint" class="tsd-kind-icon">get<wbr>Point</a>
|
|
</li>
|
|
<li class=" tsd-kind-method tsd-parent-kind-class">
|
|
<a href="Link.html#hasCurviness" class="tsd-kind-icon">has<wbr>Curviness</a>
|
|
</li>
|
|
<li class=" tsd-kind-method tsd-parent-kind-class">
|
|
<a href="Link.html#insertPoint" class="tsd-kind-icon">insert<wbr>Point</a>
|
|
</li>
|
|
<li class=" tsd-kind-method tsd-parent-kind-class">
|
|
<a href="Link.html#invalidateRoute" class="tsd-kind-icon">invalidate<wbr>Route</a>
|
|
</li>
|
|
<li class=" tsd-kind-method tsd-parent-kind-class">
|
|
<a href="Link.html#makeGeometry" class="tsd-kind-icon">make<wbr>Geometry</a>
|
|
</li>
|
|
<li class=" tsd-kind-method tsd-parent-kind-class">
|
|
<a href="Link.html#move" class="tsd-kind-icon">move</a>
|
|
</li>
|
|
<li class=" tsd-kind-method tsd-parent-kind-class">
|
|
<a href="Link.html#removePoint" class="tsd-kind-icon">remove<wbr>Point</a>
|
|
</li>
|
|
<li class=" tsd-kind-method tsd-parent-kind-class">
|
|
<a href="Link.html#setPoint" class="tsd-kind-icon">set<wbr>Point</a>
|
|
</li>
|
|
<li class=" tsd-kind-method tsd-parent-kind-class">
|
|
<a href="Link.html#updateRoute" class="tsd-kind-icon">update<wbr>Route</a>
|
|
</li>
|
|
<li class=" tsd-kind-constant tsd-parent-kind-class tsd-is-static">
|
|
<a href="Link.html#static-AvoidsNodes" class="tsd-kind-icon">Avoids<wbr>Nodes</a>
|
|
</li>
|
|
<li class=" tsd-kind-constant tsd-parent-kind-class tsd-is-static">
|
|
<a href="Link.html#static-Bezier" class="tsd-kind-icon">Bezier</a>
|
|
</li>
|
|
<li class=" tsd-kind-constant tsd-parent-kind-class tsd-is-static">
|
|
<a href="Link.html#static-End" class="tsd-kind-icon">End</a>
|
|
</li>
|
|
<li class=" tsd-kind-constant tsd-parent-kind-class tsd-is-static">
|
|
<a href="Link.html#static-JumpGap" class="tsd-kind-icon">Jump<wbr>Gap</a>
|
|
</li>
|
|
<li class=" tsd-kind-constant tsd-parent-kind-class tsd-is-static">
|
|
<a href="Link.html#static-JumpOver" class="tsd-kind-icon">Jump<wbr>Over</a>
|
|
</li>
|
|
<li class=" tsd-kind-constant tsd-parent-kind-class tsd-is-static">
|
|
<a href="Link.html#static-None" class="tsd-kind-icon">None</a>
|
|
</li>
|
|
<li class=" tsd-kind-constant tsd-parent-kind-class tsd-is-static">
|
|
<a href="Link.html#static-Normal" class="tsd-kind-icon">Normal</a>
|
|
</li>
|
|
<li class=" tsd-kind-constant tsd-parent-kind-class tsd-is-static">
|
|
<a href="Link.html#static-OrientAlong" class="tsd-kind-icon">Orient<wbr>Along</a>
|
|
</li>
|
|
<li class=" tsd-kind-constant tsd-parent-kind-class tsd-is-static">
|
|
<a href="Link.html#static-OrientMinus90" class="tsd-kind-icon">Orient<wbr>Minus90</a>
|
|
</li>
|
|
<li class=" tsd-kind-constant tsd-parent-kind-class tsd-is-static">
|
|
<a href="Link.html#static-OrientMinus90Upright" class="tsd-kind-icon">Orient<wbr>Minus90<wbr>Upright</a>
|
|
</li>
|
|
<li class=" tsd-kind-constant tsd-parent-kind-class tsd-is-static">
|
|
<a href="Link.html#static-OrientOpposite" class="tsd-kind-icon">Orient<wbr>Opposite</a>
|
|
</li>
|
|
<li class=" tsd-kind-constant tsd-parent-kind-class tsd-is-static">
|
|
<a href="Link.html#static-OrientPlus90" class="tsd-kind-icon">Orient<wbr>Plus90</a>
|
|
</li>
|
|
<li class=" tsd-kind-constant tsd-parent-kind-class tsd-is-static">
|
|
<a href="Link.html#static-OrientPlus90Upright" class="tsd-kind-icon">Orient<wbr>Plus90<wbr>Upright</a>
|
|
</li>
|
|
<li class=" tsd-kind-constant tsd-parent-kind-class tsd-is-static">
|
|
<a href="Link.html#static-OrientUpright" class="tsd-kind-icon">Orient<wbr>Upright</a>
|
|
</li>
|
|
<li class=" tsd-kind-constant tsd-parent-kind-class tsd-is-static">
|
|
<a href="Link.html#static-OrientUpright45" class="tsd-kind-icon">Orient<wbr>Upright45</a>
|
|
</li>
|
|
<li class=" tsd-kind-constant tsd-parent-kind-class tsd-is-static">
|
|
<a href="Link.html#static-Orthogonal" class="tsd-kind-icon">Orthogonal</a>
|
|
</li>
|
|
<li class=" tsd-kind-constant tsd-parent-kind-class tsd-is-static">
|
|
<a href="Link.html#static-Scale" class="tsd-kind-icon">Scale</a>
|
|
</li>
|
|
<li class=" tsd-kind-constant tsd-parent-kind-class tsd-is-static">
|
|
<a href="Link.html#static-Stretch" class="tsd-kind-icon">Stretch</a>
|
|
</li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
<ul class="after-current">
|
|
</ul>
|
|
</nav>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<div class="container-fluid bottom-copyright plr15">
|
|
Copyright © 1998-2019 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> |