Interface SurfaceMagnetizeOptions

Options for the magnetize functionality of the Surface.

interface SurfaceMagnetizeOptions {
    afterDrag?: boolean;
    afterGroupCollapse?: boolean;
    afterGroupExpand?: boolean;
    afterGroupGrow?: boolean;
    afterGroupResize?: boolean;
    afterGroupShrink?: boolean;
    afterLayout?: boolean;
    constant?: boolean;
    constrainToViewport?: boolean;
    repositionDraggedElement?: boolean;
}

Properties

afterDrag? afterGroupCollapse? afterGroupExpand? afterGroupGrow? afterGroupResize? afterGroupShrink? afterLayout? constant? constrainToViewport? repositionDraggedElement?

Properties

Optional afterDrag

afterDrag?: boolean

If true, magnetizer will be run after a vertex is dragged.

Optional afterGroupCollapse

afterGroupCollapse?: boolean

Defaults to false. Indicates the surface should gather nodes around a newly collapsed group

Optional afterGroupExpand

afterGroupExpand?: boolean

Defaults to false. Indicates the surface should magnetize nodes around a newly expanded group

Optional afterGroupGrow

afterGroupGrow?: boolean

Defaults to false. Indicates the surface should magnetize/gather nodes around a newly resized group if the group size was enlarged.

Optional afterGroupResize

afterGroupResize?: boolean

Defaults to false. Indicates the surface should magnetize/gather nodes around a newly resized group, regardless of whether the group size grew or if it shrunk. This flag is the same as setting afterGroupShrink and afterGroupGrow

Optional afterGroupShrink

afterGroupShrink?: boolean

Defaults to false. Indicates the surface should magnetize/gather nodes around a newly resized group if the group size was reduced.

Optional afterLayout

afterLayout?: boolean

If true, magnetizer will be run after the layout is run.

Optional constant

constant?: boolean

If true, magnetizer will be run constantly as a vertex is being dragged, pushing other vertices out of the way of the vertex that is being dragged

Optional constrainToViewport

constrainToViewport?: boolean

If true, vertices moved by the magnetizer will be constrained to move within the visible viewport, which is a function of the current zoom/pan of the surface. Otherwise, vertices will be able to be pushed out of the visible viewport.

Optional repositionDraggedElement

repositionDraggedElement?: boolean

If true, and afterDrag is true, when the magnetizer is run after a drag it will be the recently dragged element that moves in precedence to the other elements. By default, the recently dragged element is not moved by the magnetize operation - it stays where you dragged it.

Settings

Member Visibility

Theme

On This Page

afterDragafterGroupCollapseafterGroupExpandafterGroupGrowafterGroupResizeafterGroupShrinkafterLayoutconstantconstrainToViewportrepositionDraggedElement