UNPKG

gojs/extensionsJSM/LinkLabelOnPathDragging.html

Version:

1<!DOCTYPE html>
2<html lang="en">
3<head>
4<meta charset="utf-8"/>
5<meta name="viewport" content="width=device-width, initial-scale=1, shrink-to-fit=no, viewport-fit=cover"/>
6<meta name="description" content="TypeScript: This variation on the LinkLabelDraggingTool extension restricts link labels to stay on the link&#39;s route while the user is dragging it."/> 
7<link rel="stylesheet" href="../assets/css/style.css"/> 
8<!-- Copyright 1998-2021 by Northwoods Software Corporation. -->
9<title>Draggable Link Labels That Stay On Path</title>
10</head>
11
12<body>
<!-- This top nav is not part of the sample code -->
<nav id="navTop" class="w-full z-30 top-0 text-white bg-nwoods-primary">
  <div class="w-full container max-w-screen-lg mx-auto flex flex-wrap sm:flex-nowrap items-center justify-between mt-0 py-2">
    <div class="md:pl-4">
      <a class="text-white hover:text-white no-underline hover:no-underline
      font-bold text-2xl lg:text-4xl rounded-lg hover:bg-nwoods-secondary " href="../">
        <h1 class="mb-0 p-1 ">GoJS</h1>
      </a>
    </div>
    <button id="topnavButton" class="rounded-lg sm:hidden focus:outline-none focus:ring" aria-label="Navigation">
      <svg fill="currentColor" viewBox="0 0 20 20" class="w-6 h-6">
        <path id="topnavOpen" fill-rule="evenodd" d="M3 5a1 1 0 011-1h12a1 1 0 110 2H4a1 1 0 01-1-1zM3 10a1 1 0 011-1h12a1 1 0 110 2H4a1 1 0 01-1-1zM9 15a1 1 0 011-1h6a1 1 0 110 2h-6a1 1 0 01-1-1z" clip-rule="evenodd"></path>
        <path id="topnavClosed" class="hidden" fill-rule="evenodd" d="M4.293 4.293a1 1 0 011.414 0L10 8.586l4.293-4.293a1 1 0 111.414 1.414L11.414 10l4.293 4.293a1 1 0 01-1.414 1.414L10 11.414l-4.293 4.293a1 1 0 01-1.414-1.414L8.586 10 4.293 5.707a1 1 0 010-1.414z" clip-rule="evenodd"></path>
      </svg>
    </button>
    <div id="topnavList" class="hidden sm:block items-center w-auto mt-0 text-white p-0 z-20">
      <ul class="list-reset list-none font-semibold flex justify-end flex-wrap sm:flex-nowrap items-center px-0 pb-0">
        <li class="p-1 sm:p-0"><a class="topnav-link" href="../learn/">Learn</a></li>
        <li class="p-1 sm:p-0"><a class="topnav-link" href="../samples/">Samples</a></li>
        <li class="p-1 sm:p-0"><a class="topnav-link" href="../intro/">Intro</a></li>
        <li class="p-1 sm:p-0"><a class="topnav-link" href="../api/">API</a></li>
        <li class="p-1 sm:p-0"><a class="topnav-link" href="https://www.nwoods.com/products/register.html">Register</a></li>
        <li class="p-1 sm:p-0"><a class="topnav-link" href="../download.html">Download</a></li>
        <li class="p-1 sm:p-0"><a class="topnav-link" href="https://forum.nwoods.com/c/gojs/11">Forum</a></li>
        <li class="p-1 sm:p-0"><a class="topnav-link" href="https://www.nwoods.com/contact.html"
         target="_blank" rel="noopener" onclick="getOutboundLink('https://www.nwoods.com/contact.html', 'contact');">Contact</a></li>
        <li class="p-1 sm:p-0"><a class="topnav-link" href="https://www.nwoods.com/sales/index.html"
         target="_blank" rel="noopener" onclick="getOutboundLink('https://www.nwoods.com/sales/index.html', 'buy');">Buy</a></li>
      </ul>
    </div>
  </div>
  <hr class="border-b border-gray-600 opacity-50 my-0 py-0" />
</nav>
<div class="md:flex flex-col md:flex-row md:min-h-screen w-full max-w-screen-xl mx-auto">
  <div id="navSide" class="flex flex-col w-full md:w-48 text-gray-700 bg-white flex-shrink-0"></div>
  <!-- * * * * * * * * * * * * * -->
  <!-- Start of GoJS sample code -->
  
51
  <div class="p-4 w-full">
<div id="sample">
  <div id="myDiagramDiv" style="background-color: whitesmoke; border: solid 1px black; width: 100%; height: 600px"></div>
  <p>
    This sample demonstrates a custom Tool, LinkLabelOnPathDraggingTool, that allows the user to drag the label of a Link, but
    that keeps the label exactly on the path of the link. The tool is defined at <a href="LinkLabelOnPathDraggingTool.ts">LinkLabelOnPathDraggingTool.ts</a>.
  </p>
  <p>
    The label on the link can be any arbitrarily complex object.
    It is positioned by the <a>GraphObject.segmentIndex</a> and <a>GraphObject.segmentFraction</a> properties.
    The segmentIndex is set to NaN such that the whole link path acts as the segment, and the segmentFraction is set by the LinkLabelOnPathDraggingTool.
    A two-way data binding on segmentFraction automatically remembers any modified value on the link data object in the model.
  </p>
  <p>
    The tool is derived from a similar tool, <a href="LinkLabelDraggingTool.ts">LinkLabelDraggingTool.ts</a>, that allows
    the user to drag the label in any direction from the mid-point of the Link path.
  </p>
</div>
70
<script type="module" id="code">
  import * as go from "../release/go-module.js";
  import { LinkLabelOnPathDraggingTool } from './LinkLabelOnPathDraggingTool.js';
74
  if (window.goSamples) window.goSamples(); // init for these samples -- you don't need to call this
  const $ = go.GraphObject.make;
77
  const myDiagram = $(go.Diagram, 'myDiagramDiv', // the ID of the DIV HTML element
  {
      layout: $(go.ForceDirectedLayout, { defaultSpringLength: 50, defaultElectricalCharge: 50 }),
      'undoManager.isEnabled': true
  });
  // install the LinkLabelDraggingTool as a "mouse move" tool
  myDiagram.toolManager.mouseMoveTools.insertAt(0, new LinkLabelOnPathDraggingTool());
  myDiagram.nodeTemplate =
      $(go.Node, go.Panel.Auto, { locationSpot: go.Spot.Center }, $(go.Shape, {
          fill: 'orange',
          portId: '',
          fromLinkable: true,
          fromSpot: go.Spot.AllSides,
          toLinkable: true,
          toSpot: go.Spot.AllSides,
          cursor: 'pointer'
      }, new go.Binding('fill', 'color')), $(go.TextBlock, { margin: 10, font: 'bold 12pt sans-serif' }, new go.Binding('text')));
  myDiagram.linkTemplate =
      $(go.Link, {
          routing: go.Link.AvoidsNodes,
          corner: 5,
          relinkableFrom: true,
          relinkableTo: true,
          reshapable: true,
          resegmentable: true
      }, $(go.Shape), $(go.Shape, { toArrow: 'OpenTriangle' }), $(go.Panel, 'Auto',
      // mark this Panel as being a draggable label, and set default segment props
      { _isLinkLabel: true, segmentIndex: NaN, segmentFraction: .5 }, $(go.Shape, { fill: 'white' }), $(go.TextBlock, '?', { margin: 3 }, new go.Binding('text', 'color')),
      // remember any modified segment properties in the link data object
      new go.Binding('segmentIndex').makeTwoWay(), new go.Binding('segmentFraction').makeTwoWay()));
  // create a few nodes and links
  myDiagram.model = new go.GraphLinksModel([
      { key: 1, text: 'one', color: 'lightyellow' },
      { key: 2, text: 'two', color: 'brown' },
      { key: 3, text: 'three', color: 'green' },
      { key: 4, text: 'four', color: 'slateblue' },
      { key: 5, text: 'five', color: 'aquamarine' },
      { key: 6, text: 'six', color: 'lightgreen' },
      { key: 7, text: 'seven' }
  ], [
      { from: 5, to: 6, color: 'orange' },
      { from: 1, to: 2, color: 'red' },
      { from: 1, to: 3, color: 'blue' },
      { from: 1, to: 4, color: 'goldenrod' },
      { from: 2, to: 5, color: 'fuchsia' },
      { from: 3, to: 5, color: 'green' },
      { from: 4, to: 5, color: 'black' },
      { from: 6, to: 7 }
  ]);
127
  window.myDiagram = myDiagram; // Attach to the window for console debugging
</script>
  </div>
  <!-- * * * * * * * * * * * * * -->
  <!--  End of GoJS sample code  -->
</div>
134</body>
135<!--  This script is part of the gojs.net website, and is not needed to run the sample -->
136<script src="../assets/js/goSamples.js"></script>
137</html>

1	`<!DOCTYPE html>`
2	`<html lang="en">`
3	`<head>`
4	`<meta charset="utf-8"/>`
5	`<meta name="viewport" content="width=device-width, initial-scale=1, shrink-to-fit=no, viewport-fit=cover"/>`
6	`<meta name="description" content="TypeScript: This variation on the LinkLabelDraggingTool extension restricts link labels to stay on the link's route while the user is dragging it."/>`
7	`<link rel="stylesheet" href="../assets/css/style.css"/>`
8	`<!-- Copyright 1998-2021 by Northwoods Software Corporation. -->`
9	`<title>Draggable Link Labels That Stay On Path</title>`
10	`</head>`
11
12	`<body>`
13	`<!-- This top nav is not part of the sample code -->`
14	`<nav id="navTop" class="w-full z-30 top-0 text-white bg-nwoods-primary">`
15	`<div class="w-full container max-w-screen-lg mx-auto flex flex-wrap sm:flex-nowrap items-center justify-between mt-0 py-2">`
16	`<div class="md:pl-4">`
17	`<a class="text-white hover:text-white no-underline hover:no-underline`
18	`font-bold text-2xl lg:text-4xl rounded-lg hover:bg-nwoods-secondary " href="../">`
19	`<h1 class="mb-0 p-1 ">GoJS</h1>`
20	`</a>`
21	`</div>`
22	`<button id="topnavButton" class="rounded-lg sm:hidden focus:outline-none focus:ring" aria-label="Navigation">`
23	`<svg fill="currentColor" viewBox="0 0 20 20" class="w-6 h-6">`
24	`<path id="topnavOpen" fill-rule="evenodd" d="M3 5a1 1 0 011-1h12a1 1 0 110 2H4a1 1 0 01-1-1zM3 10a1 1 0 011-1h12a1 1 0 110 2H4a1 1 0 01-1-1zM9 15a1 1 0 011-1h6a1 1 0 110 2h-6a1 1 0 01-1-1z" clip-rule="evenodd"></path>`
25	`<path id="topnavClosed" class="hidden" fill-rule="evenodd" d="M4.293 4.293a1 1 0 011.414 0L10 8.586l4.293-4.293a1 1 0 111.414 1.414L11.414 10l4.293 4.293a1 1 0 01-1.414 1.414L10 11.414l-4.293 4.293a1 1 0 01-1.414-1.414L8.586 10 4.293 5.707a1 1 0 010-1.414z" clip-rule="evenodd"></path>`
26	`</svg>`
27	`</button>`
28	`<div id="topnavList" class="hidden sm:block items-center w-auto mt-0 text-white p-0 z-20">`
29	`<ul class="list-reset list-none font-semibold flex justify-end flex-wrap sm:flex-nowrap items-center px-0 pb-0">`
30	`<li class="p-1 sm:p-0"><a class="topnav-link" href="../learn/">Learn</a></li>`
31	`<li class="p-1 sm:p-0"><a class="topnav-link" href="../samples/">Samples</a></li>`
32	`<li class="p-1 sm:p-0"><a class="topnav-link" href="../intro/">Intro</a></li>`
33	`<li class="p-1 sm:p-0"><a class="topnav-link" href="../api/">API</a></li>`
34	`<li class="p-1 sm:p-0"><a class="topnav-link" href="https://www.nwoods.com/products/register.html">Register</a></li>`
35	`<li class="p-1 sm:p-0"><a class="topnav-link" href="../download.html">Download</a></li>`
36	`<li class="p-1 sm:p-0"><a class="topnav-link" href="https://forum.nwoods.com/c/gojs/11">Forum</a></li>`
37	`<li class="p-1 sm:p-0"><a class="topnav-link" href="https://www.nwoods.com/contact.html"`
38	`target="_blank" rel="noopener" onclick="getOutboundLink('https://www.nwoods.com/contact.html', 'contact');">Contact</a></li>`
39	`<li class="p-1 sm:p-0"><a class="topnav-link" href="https://www.nwoods.com/sales/index.html"`
40	`target="_blank" rel="noopener" onclick="getOutboundLink('https://www.nwoods.com/sales/index.html', 'buy');">Buy</a></li>`
41	`</ul>`
42	`</div>`
43	`</div>`
44	`<hr class="border-b border-gray-600 opacity-50 my-0 py-0" />`
45	`</nav>`
46	`<div class="md:flex flex-col md:flex-row md:min-h-screen w-full max-w-screen-xl mx-auto">`
47	`<div id="navSide" class="flex flex-col w-full md:w-48 text-gray-700 bg-white flex-shrink-0"></div>`
48	`<!-- * * * * * * * * * * * * * -->`
49	`<!-- Start of GoJS sample code -->`
50
51
52	`<div class="p-4 w-full">`
53	`<div id="sample">`
54	`<div id="myDiagramDiv" style="background-color: whitesmoke; border: solid 1px black; width: 100%; height: 600px"></div>`
55	`<p>`
56	`This sample demonstrates a custom Tool, LinkLabelOnPathDraggingTool, that allows the user to drag the label of a Link, but`
57	`that keeps the label exactly on the path of the link. The tool is defined at <a href="LinkLabelOnPathDraggingTool.ts">LinkLabelOnPathDraggingTool.ts</a>.`
58	`</p>`
59	`<p>`
60	`The label on the link can be any arbitrarily complex object.`
61	`It is positioned by the <a>GraphObject.segmentIndex</a> and <a>GraphObject.segmentFraction</a> properties.`
62	`The segmentIndex is set to NaN such that the whole link path acts as the segment, and the segmentFraction is set by the LinkLabelOnPathDraggingTool.`
63	`A two-way data binding on segmentFraction automatically remembers any modified value on the link data object in the model.`
64	`</p>`
65	`<p>`
66	`The tool is derived from a similar tool, <a href="LinkLabelDraggingTool.ts">LinkLabelDraggingTool.ts</a>, that allows`
67	`the user to drag the label in any direction from the mid-point of the Link path.`
68	`</p>`
69	`</div>`
70
71	`<script type="module" id="code">`
72	`import * as go from "../release/go-module.js";`
73	`import { LinkLabelOnPathDraggingTool } from './LinkLabelOnPathDraggingTool.js';`
74
75	`if (window.goSamples) window.goSamples(); // init for these samples -- you don't need to call this`
76	`const $ = go.GraphObject.make;`
77
78	`const myDiagram = $(go.Diagram, 'myDiagramDiv', // the ID of the DIV HTML element`
79	`{`
80	`layout: $(go.ForceDirectedLayout, { defaultSpringLength: 50, defaultElectricalCharge: 50 }),`
81	`'undoManager.isEnabled': true`
82	`});`
83	`// install the LinkLabelDraggingTool as a "mouse move" tool`
84	`myDiagram.toolManager.mouseMoveTools.insertAt(0, new LinkLabelOnPathDraggingTool());`
85	`myDiagram.nodeTemplate =`
86	`$(go.Node, go.Panel.Auto, { locationSpot: go.Spot.Center }, $(go.Shape, {`
87	`fill: 'orange',`
88	`portId: '',`
89	`fromLinkable: true,`
90	`fromSpot: go.Spot.AllSides,`
91	`toLinkable: true,`
92	`toSpot: go.Spot.AllSides,`
93	`cursor: 'pointer'`
94	`}, new go.Binding('fill', 'color')), $(go.TextBlock, { margin: 10, font: 'bold 12pt sans-serif' }, new go.Binding('text')));`
95	`myDiagram.linkTemplate =`
96	`$(go.Link, {`
97	`routing: go.Link.AvoidsNodes,`
98	`corner: 5,`
99	`relinkableFrom: true,`
100	`relinkableTo: true,`
101	`reshapable: true,`
102	`resegmentable: true`
103	`}, $(go.Shape), $(go.Shape, { toArrow: 'OpenTriangle' }), $(go.Panel, 'Auto',`
104	`// mark this Panel as being a draggable label, and set default segment props`
105	`{ _isLinkLabel: true, segmentIndex: NaN, segmentFraction: .5 }, $(go.Shape, { fill: 'white' }), $(go.TextBlock, '?', { margin: 3 }, new go.Binding('text', 'color')),`
106	`// remember any modified segment properties in the link data object`
107	`new go.Binding('segmentIndex').makeTwoWay(), new go.Binding('segmentFraction').makeTwoWay()));`
108	`// create a few nodes and links`
109	`myDiagram.model = new go.GraphLinksModel([`
110	`{ key: 1, text: 'one', color: 'lightyellow' },`
111	`{ key: 2, text: 'two', color: 'brown' },`
112	`{ key: 3, text: 'three', color: 'green' },`
113	`{ key: 4, text: 'four', color: 'slateblue' },`
114	`{ key: 5, text: 'five', color: 'aquamarine' },`
115	`{ key: 6, text: 'six', color: 'lightgreen' },`
116	`{ key: 7, text: 'seven' }`
117	`], [`
118	`{ from: 5, to: 6, color: 'orange' },`
119	`{ from: 1, to: 2, color: 'red' },`
120	`{ from: 1, to: 3, color: 'blue' },`
121	`{ from: 1, to: 4, color: 'goldenrod' },`
122	`{ from: 2, to: 5, color: 'fuchsia' },`
123	`{ from: 3, to: 5, color: 'green' },`
124	`{ from: 4, to: 5, color: 'black' },`
125	`{ from: 6, to: 7 }`
126	`]);`
127
128	`window.myDiagram = myDiagram; // Attach to the window for console debugging`
129	`</script>`
130	`</div>`
131	`<!-- * * * * * * * * * * * * * -->`
132	`<!-- End of GoJS sample code -->`
133	`</div>`
134	`</body>`
135	`<!-- This script is part of the gojs.net website, and is not needed to run the sample -->`
136	`<script src="../assets/js/goSamples.js"></script>`
137	`</html>`