Class LinkReshapingTool

The LinkReshapingTool is used to interactively change the route of a Link. This tool makes use of an Adornment, shown when the adorned Link is selected, that includes some number of reshape handles. This tool conducts a transaction while the tool is active. A successful reshaping will result in a "LinkReshaped" DiagramEvent and a "LinkReshaping" transaction.

Hierarchy

  • Tool
    • LinkReshapingTool

Index

Constructor methods

Properties

Methods

Constructor methods

constructor(): LinkReshapingTool

You do not normally need to create an instance of this tool because one already exists as the ToolManager#linkReshapingTool, which you can modify.

Returns

LinkReshapingTool

Properties

public static All: EnumValue

Allow dragging in any direction.

public static Horizontal: EnumValue

Allow only horizontal (left-and-right) dragging.

public static None: EnumValue

Disallow dragging.

public static Vertical: EnumValue

Allow only vertical (up-and-down) dragging.

public adornedLink: Link

Gets the Link that is being routed manually.

public diagram: Diagram

Gets the Diagram that owns this tool and for which this tool is handling input events.

public handle: GraphObject

Gets the GraphObject that is the tool handle being dragged by the user.

public handleArchetype: GraphObject

Gets or sets a small GraphObject that is copied as a reshape handle at each movable point in the selected link's route.

public isActive: boolean

Gets or sets whether this tool is started and is actively doing something.

public isEnabled: boolean

Gets or sets whether this tool can be started by a mouse event.

public midHandleArchetype: GraphObject

Gets or sets a small GraphObject that is copied as a resegment handle at each mid point in the selected Link's route.

public name: string

Gets or sets the name of this tool.

public originalPoint: Point

Gets the Point that was the original location of the handle that is being dragged to reshape the Link.

public originalPoints: List

Gets the List of Points that was the original route of the Link that is being reshaped.

public transactionResult: string

Gets or sets the name of the transaction to be committed by #stopTransaction; if null, the transaction will be rolled back.

Methods

public canStart(): boolean

This tool may run when there is a mouse-down event on a reshape handle.

Returns

boolean

public cancelWaitAfter(): any

This is called to cancel any running "WaitAfter" timer.

Returns

any

public computeReshape(p: Point): Point

This is called by #doMouseMove and #doMouseUp to limit the input point before calling #reshape.

Parameters

Returns

Point

public doActivate(): any

Start reshaping, if #findToolHandleAt finds a reshape handle at the mouse down point.

Returns

any

public doCancel(): any

Restore the link route to be the original points and stop this tool.

Returns

any

public doDeactivate(): any

This stops the current reshaping operation with the link route shaped the way it is.

Returns

any

public doKeyDown(): any

The diagram will call this method upon a key down event.

Returns

any

public doKeyUp(): any

The diagram will call this method upon a key up event.

Returns

any

public doMouseDown(): any

The diagram will call this method upon a mouse down event.

Returns

any

public doMouseMove(): any

Call #reshape with a new point determined by the mouse to change the route of the #adornedLink.

Returns

any

public doMouseUp(): any

Reshape the route with a point based on the most recent mouse point by calling #reshape, and then raise a "LinkReshaped" DiagramEvent before stopping this tool.

Returns

any

public doMouseWheel(): any

The diagram will call this method as the mouse wheel is rotated.

Returns

any

public doStart(): any

This method is called by the diagram when this tool becomes the current tool; you should not call this method.

Returns

any

public doStop(): any

This method is called by the diagram when this tool stops being the current tool; you should not call this method.

Returns

any

public doWaitAfter(): any

This is called a certain delay after a call to #standardWaitAfter if there has not been any call to #cancelWaitAfter.

Returns

any

public findToolHandleAt(p: Point, category: string): GraphObject

This convenience function finds the front-most GraphObject that is at a given point and that is part of an Adornment that is of a given category.

Parameters

  • p: Point

    a Point in document coordinates.

  • category: string

    the required Part#category of the Adornment.

Returns

GraphObject

public isBeyondDragSize(first?: Point, last?: Point): boolean

Return true when the last mouse point is far enough away from the first mouse down point to constitute a drag operation instead of just a potential click.

Parameters

  • first?: Point optional

    Point in view coordinates, defaults to Diagram#firstInput's InputEvent#viewPoint.

  • last?: Point optional

    Point in view coordinates, defaults to Diagram#lastInput's InputEvent#viewPoint.

Returns

boolean

public reshape(newPoint: Point): any

Change the route of the #adornedLink by moving the point corresponding to the current #handle to be at the given Point.

Parameters

Returns

any

public standardMouseClick(navig?: (obj: go.GraphObject) => go.GraphObject, pred?: (obj: go.GraphObject) => boolean): any

Implement the standard behavior for mouse clicks, searching for and calling click handler functions on GraphObjects or on Diagram, and raising the corresponding DiagramEvent.

Parameters

  • navig?: (obj: go.GraphObject) => go.GraphObject optional

    An optional custom navigation function to find target objects.

  • pred?: (obj: go.GraphObject) => boolean optional

    An optional custom predicate

Returns

any

public standardMouseOver(): any

Implement the standard behavior for mouse enter, over, and leave events, where the mouse is moving but no button is pressed.

Returns

any

public standardMouseSelect(): any

Implement the standard behavior for selecting parts with the mouse, depending on the control and shift modifier keys.

Returns

any

public standardMouseWheel(): any

Implement the standard behavior for mouse wheel events.

Returns

any

public standardWaitAfter(delay: number): any

This is called to start a new timer to call #doWaitAfter after a given delay.

Parameters

  • delay: number

    in milliseconds

Returns

any

public startTransaction(tname?: string): boolean

Call Diagram#startTransaction with the given transaction name.

Parameters

  • tname?: string optional

    a description of the transaction

Returns

boolean

public stopTool(): any

If the Diagram#currentTool is this tool, stop this tool and start the Diagram#defaultTool by making it be the new current tool.

Returns

any

public stopTransaction(): boolean

If #transactionResult is null, call Diagram#rollbackTransaction, otherwise call Diagram#commitTransaction.

Returns

boolean

public updateAdornments(part: Part): any

Show an Adornment with reshape handles at each of the interesting points of the link's route, if the link is selected and visible and if Part#canReshape is true.

Parameters

Returns

any