SnappingConfig
since v0.8.0Configuration for node dragging behavior.
Properties
Section titled “Properties”computeSnapForNodeDrag()
Section titled “computeSnapForNodeDrag()”computeSnapForNodeDrag: (
node) =>null|Size
Computes the snap size for a node while dragging. If null is returned, a default snap size will be used. If computeSnapForNodeDrag is used, it takes precedence over defaultDragSnap.
Parameters
Section titled “Parameters”The node to compute the snap size for dragging.
Returns
Section titled “Returns”null | Size
The snap size for the node while dragging, or null.
Default
Section titled “Default”() => nullcomputeSnapForNodeSize()
Section titled “computeSnapForNodeSize()”computeSnapForNodeSize: (
node) =>null|Size
Computes the snap size for a node while resizing. If null is returned, a default snap size will be used.
Parameters
Section titled “Parameters”The node to compute the snap size for resizing.
Returns
Section titled “Returns”null | Size
The snap size for the node while resizing, or null.
Default
Section titled “Default”() => nullcomputeSnapOffsetForNodeSize()
Section titled “computeSnapOffsetForNodeSize()”computeSnapOffsetForNodeSize: (
node) =>null|Size
Computes the snap offset for a node while resizing. The snapped size follows the
sequence offset + n * snap per axis, so a node with a 60px header snapping every
50px can snap to 60, 110, 160, … instead of 50, 100, 150, …
If null is returned, defaultResizeSnapOffset is used.
If computeSnapOffsetForNodeSize is used, it takes precedence over defaultResizeSnapOffset.
Parameters
Section titled “Parameters”The node to compute the snap offset for resizing.
Returns
Section titled “Returns”null | Size
The snap offset for the node while resizing, or null.
Default
Section titled “Default”() => null1.3.0
defaultDragSnap
Section titled “defaultDragSnap”defaultDragSnap:
Size
The default snap size for node dragging. If computeSnapForNodeDrag is used, it takes precedence over this value.
Default
Section titled “Default”{ width: 10, height: 10 }defaultResizeSnap
Section titled “defaultResizeSnap”defaultResizeSnap:
Size
The default snap size for node resizing.
Default
Section titled “Default”{ width: 10, height: 10 }defaultResizeSnapOffset
Section titled “defaultResizeSnapOffset”defaultResizeSnapOffset:
Size
The default snap offset for node resizing. The snapped size follows the
sequence offset + n * snap per axis (see computeSnapOffsetForNodeSize).
If computeSnapOffsetForNodeSize is used, it takes precedence over this value.
Default
Section titled “Default”{ width: 0, height: 0 }1.3.0
shouldSnapDragForNode()
Section titled “shouldSnapDragForNode()”shouldSnapDragForNode: (
node) =>boolean
Determines if a node should snap to grid while dragging.
Parameters
Section titled “Parameters”The node being dragged.
Returns
Section titled “Returns”boolean
True if the node should snap to grid, false otherwise.
Default
Section titled “Default”() => falseshouldSnapResizeForNode()
Section titled “shouldSnapResizeForNode()”shouldSnapResizeForNode: (
node) =>boolean
Determines if a node should snap to grid while resizing.
Parameters
Section titled “Parameters”The node being resized.
Returns
Section titled “Returns”boolean
True if the node should snap to grid, false otherwise.
Default
Section titled “Default”() => false