GoJS API
/ to search
    Preparing search index...

    Class NonRealtimeDraggingTool

    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. See the Extensions intro page for more information.

    The NonRealtimeDraggingTool class lets the user drag an image instead of actually moving any selected nodes, until the mouse-up event.

    If you want to experiment with this extension, try the Non Realtime Dragging sample.

    Hierarchy

    • unknown
      • NonRealtimeDraggingTool
    Index

    Constructors

    Accessors

    • get duration(): number

      Gets or sets how long the movement animation should be to move the actual parts upon a mouse-up. The default value is zero -- there is no animation of the movement.

      Returns number

    Methods

    • Call the base method, and then make an image of the returned collection, show it using a Picture, and hold the Picture in a temporary Part, as _imagePart.

      Parameters

      • parts: Iterable<Part>

        A go.Set or go.List of go.Parts.

      Returns Map<Part, DraggingInfo>

    • When activated, replace the draggedParts with the ghost dragged parts, which consists of just one Part, the image, added to the Diagram at the current mouse point.

      Returns void

    • When deactivated, make sure any image is removed from the Diagram and all references are cleared out.

      Returns void

    • If the user changes to "copying" mode by holding down the Control key, return to the regular behavior and remove the image.

      Returns void

    • If the user changes back to "moving" mode, show the image again and go back to dragging the ghost dragged parts.

      Returns void

    • Do the normal mouse-up behavior, but only after restoring draggedParts.

      Returns void