Options
All
  • Public
  • Public/Protected
  • All
Menu

Class LinkReshapingTool

Hierarchy

The LinkReshapingTool is used to interactively change the route of a Link by setting its Link.points list. You may want to save the route to the model by using a TwoWay Binding on the "points" property of the 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.

For a general discussion of link routing, see: Introduction to Links, Introduction to Link Labels, and Introduction to Link Connection Points. For customizing the linking tools, see Introduction to the Linking Tools. For a general discussion of validation, see Introduction to Validation.

Index

Constructors

constructor

Properties

Read-only adornedLink : Link | null

  • This read-only property returns the Link that is being routed manually.

Read-only handle : GraphObject | null

handleArchetype : GraphObject | null

  • Gets or sets a small GraphObject that is copied as a reshape handle at each movable point in the selected link's route. By default this is a Shape that is a small blue rectangle. Setting this property does not raise any events.

    Here is an example of changing the default handles to be larger yellow circles:

      myDiagram.toolManager.linkReshapingTool.handleArchetype =
        $(go.Shape, "Circle",
          { width: 10, height: 10, fill: "yellow" });
    
    see

    midHandleArchetype

midHandleArchetype : GraphObject | null

  • Gets or sets a small GraphObject that is copied as a resegment handle at each mid-point in the selected Link's route. By default this is a Shape that is a small blue diamond. Setting this property does not raise any events.

    Here is an example of changing the default handle to be larger cyan triangles:

      myDiagram.toolManager.linkReshapingTool.midHandleArchetype =
        $(go.Shape, "Triangle", { width: 10, height: 10, fill: "cyan" });
    
    see

    handleArchetype

    since

    1.2

Read-only originalPoint : Point

  • This read-only property returns the Point that was the original location of the handle that is being dragged to reshape the Link.

    since

    1.1

Read-only originalPoints : List<Point>

  • This read-only property returns the List of Points that was the original route of the Link that is being reshaped. This List should not be modified; its value is indeterminate until a reshaping has been activated.

    since

    1.1

Methods

Virtual Override canStart

  • canStart(): boolean
  • This tool may run when there is a mouse-down event on a reshape handle.

    This method may be overridden. Please read the Introduction page on Extensions for how to override methods and how to call this base method.

    Returns boolean

Virtual computeReshape

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

    This method may be overridden. Please read the Introduction page on Extensions for how to override methods and how to call this base method.

    Parameters

    • p: Point

      the point where the handle is being dragged.

    Returns Point

    Either the same Point p or one constrained by the reshape behavior to be moved only vertically or only horizontally.

Override doActivate

  • doActivate(): void
  • Start reshaping, if findToolHandleAt finds a reshape handle at the mouse down point.

    If successful this sets handle to be the reshape handle that it finds and adornedLink to be the Link being routed. It also remembers the original link route (a list of Points) in case this tool is cancelled. And it starts a transaction.

    Returns void

Override doCancel

  • doCancel(): void
  • Restore the link route to be the original points and stop this tool.

    Returns void

Override doDeactivate

  • doDeactivate(): void
  • This stops the current reshaping operation with the link route shaped the way it is.

    Returns void

Override doMouseMove

  • doMouseMove(): void
  • Call reshape with a new point determined by the mouse to change the route of the adornedLink.

    Returns void

Override doMouseUp

  • doMouseUp(): void
  • 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 void

Protected getReshapingBehavior

  • Get the permitted reshaping behavior for a particular reshape handle.

    since

    1.3

    Parameters

    • obj: GraphObject

      a reshape handle in the "LinkReshaping" Adornment.

    Returns EnumValue

    one of LinkReshapingTool.All, .Vertical, .Horizontal, or .None

Virtual reshape

  • reshape(newPoint: Point): void
  • Change the route of the adornedLink by moving the point corresponding to the current handle to be at the given Point. This is called by doMouseMove and doMouseUp with the result of calling computeReshape to constrain the input point.

    This method respects the orthogonality of the link, if necessary limiting movement along only one axis. To maintain orthogonality it may need to modify more than one point in the route.

    This method may be overridden. Please read the Introduction page on Extensions for how to override methods and how to call this base method.

    Parameters

    Returns void

Protected setReshapingBehavior

  • setReshapingBehavior(obj: GraphObject, behavior: EnumValue): void
  • Set the permitted reshaping behavior for a particular reshape handle.

    since

    1.3

    Parameters

    • obj: GraphObject

      a reshape handle in the "LinkReshaping" Adornment.

    • behavior: EnumValue

      one of LinkReshapingTool.All, .Vertical, .Horizontal, or .None

    Returns void

Virtual Override updateAdornments

  • updateAdornments(part: Part): void
  • 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.

    This method may be overridden. Please read the Introduction page on Extensions for how to override methods and how to call this base method.

    Parameters

    Returns void

Constants

Static All : EnumValue

Allow dragging in any direction.

Static Horizontal : EnumValue

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

Static None : EnumValue

Disallow dragging.

Static Vertical : EnumValue

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