This is an extension and not part of the main GoJS library. Note that the API for this class may change at any time. If you intend to use an extension in production, you should copy the code to your own source directory. Extensions can be found in the GoJS kit under the extensions (for loading via script tags),extensionsTS (UMD modules), or extensionsJSM (ES6 modules) folders. See the Extensions intro page for more information.
You do not normally need to create an instance of this tool because one already exists as the ToolManager.linkReshapingTool, which you can modify.
The Tool.name of this tool is "LinkReshaping".
Gets or sets whether a reshape handle's position should only be dragged where the adjacent segments do not cross over any nodes. This affects the behavior of computeReshape.
The default value is true.
Gets or sets the Size of each grid cell to which link points will be snapped.
The default value is NaNxNaN, which means use the Diagram.grid's Panel.gridCellSize.
Gets or sets the Point origin for the grid to which link points will be snapped.
The default value is NaN,NaN, which means use the Diagram.grid's Panel.gridOrigin.
Gets or sets whether a reshape handle's position should be snapped to a grid point. This affects the behavior of computeReshape.
The default value is true.
Pretend while dragging a reshape handle the mouse point is at the nearest grid point, if isGridSnapEnabled is true. This uses gridCellSize and gridOrigin, unless those are not real values, in which case this uses the Diagram.grid's Panel.gridCellSize and Panel.gridOrigin.
If avoidsNodes is true and the adorned Link is Link.isOrthogonal, this method also avoids returning a Point that causes the adjacent segments, both before and after the current handle's index, to cross over any Nodes that are Node.avoidable.
This override records information about the original point of the handle being dragged, if the adornedLink is Orthogonal and if avoidsNodes is true.
The SnapLinkReshapingTool class lets the user snap link reshaping handles to the nearest grid point. If avoidsNodes is true and the link is orthogonal, it also avoids reshaping the link so that any adjacent segments cross over any avoidable nodes.
If you want to experiment with this extension, try the Snap Link Reshaping sample.