Options
All
  • Public
  • Public/Protected
  • All
Menu

Class PortShiftingTool

This is an extension and not part of the main GoJS library. Note that the API for this class may change at any time. Extensions can be found in the GoJS kit under the extensions or extensionsTS folders. See the Extensions intro page for more information.

Hierarchy

  • Tool
    • PortShiftingTool

The PortShiftingTool class lets a user move a port on a Node.

This tool only works when the Node has a port (any GraphObject) marked with a non-null and non-empty portId that is positioned in a Spot Panel, and the user holds down the Shift key. It works by modifying that port's GraphObject.alignment property.

If you want to experiment with this extension, try the Port Shifting sample.

Index

Constructors

constructor

  • Constructs a PortShiftingTool and sets the name for the tool.

    Returns PortShiftingTool

Properties

port : GraphObject | null

The port being shifted.

Methods

Override canStart

  • canStart(): boolean
  • This tool can only start if the mouse has moved enough so that it is not a click, and if the mouse down point is on a GraphObject "port" in a Spot Panel, as determined by findPort.

    Returns boolean

Override doActivate

  • doActivate(): void
  • Start a transaction, call findPort and remember it as the "port" property, and remember the original value for the port's GraphObject.alignment property.

    Returns void

Override doCancel

  • doCancel(): void
  • Restore the port's original value for GraphObject.alignment.

    Returns void

Override doDeactivate

  • doDeactivate(): void
  • Stop any ongoing transaction.

    Returns void

Override doMouseMove

  • doMouseMove(): void

Override doMouseUp

  • doMouseUp(): void
  • At the end of the drag, update the alignment of the port and finish the tool, completing a transaction.

    Returns void

Override doStop

  • doStop(): void
  • Clear any reference to a port element.

    Returns void

findPort

  • From the GraphObject at the mouse point, search up the visual tree until we get to an object that has the GraphObject.portId property set to a non-empty string, that is in a Spot Panel, and that is not the main element of the panel (typically the first element).

    Returns GraphObject | null

    This returns null if no such port is at the mouse down point.

updateAlignment

  • updateAlignment(): void
  • Save the port's GraphObject.alignment as a fractional Spot in the Spot Panel that the port is in. Thus if the main element changes size, the relative positions of the ports will be maintained. But that does assume that the port must remain inside the main element -- it cannot wander away from the node. This does not modify the port's GraphObject.alignmentFocus property.

    Returns void