Options

Required type

string

Plugin type

autoSnap

boolean Default: true

Whether to enable automatic adsorption

filter

(node: Node) => boolean Default: ``

Filter, used to filter nodes that do not need to be used as references

horizontalLineStyle

BaseStyleProps Default: ``

Horizontal snapline style

offset

number Default: 20

The extension distance of the snapline. The value range is [0, Infinity]

shape

string | ((node: Node) => DisplayObject) Default: ``

Specifies which shape on the element to use as the reference shape

• 'key' uses the key shape of the element as the reference shape - You can also pass in a function that receives the element and returns a shape

tolerance

number Default: 5

The alignment accuracy, that is, when the distance between the moved node and the target position is less than tolerance, the alignment line is displayed

verticalLineStyle

BaseStyleProps Default: ``

Vertical snapline style

API

Snapline.destroy()

destroy(): void;