Files
noodl-docs/nodes/utilities/drag/README.md
2023-09-22 13:37:52 +02:00

9.4 KiB

hide_title, hide_table_of_contents, title
hide_title hide_table_of_contents title
true true Drag node

<##head##>

Drag

The drag node is used to make visual nodes draggable with the mouse or touch. The child of a Drag node automatically become draggable.

:::tip

The Drag node can only have one child, but that child can have many children.

:::

<##head##>

Inputs

Snap To Position X

Signal Description
Do Send a signal here to trigger a snap to the position specified by Value and with the transition duration specified by Duration.
Data Description
Value This is the X value the the snap action will have as destination when triggered.
Duration The snap transition duration.

Snap To Position Y

Signal Description
Do Send a signal here to trigger a snap to the position specified by Value and with the transition duration specified by Duration.
Data Description
Value This is the Y value the the snap action will have as destination when triggered.
Duration The snap transition duration.

Drag

Data Description
Enable Enables or disables this node. If it is disabled, drag will not have any affect on child nodes.
Axis Specifies along which axes the drag will work
a
X: Only horizontal drag is enabled.
Y: Only vertical drag is enabled.
Both: Both horizontal and vertical drag is enabled.
Constrain to parent If enabled the child nodes being dragged will be constrained to the borders of the parent node so they cannot be dragged outside of the parent bounds.

Other

Data Description
Start Drag X Specifies the X position that will be used as the starting point. Setting this will force the child nodes to the specified position.
Start Drag Y Specifies the Y position that will be used as the starting point. Setting this will force the child nodes to the specified position.
Scale Specifies the move scale that will be used when dragging the node around. This can correct the drag deltas while you are zoomed in or out.
Mounted This property is used to completely remove the node from the DOM. If this property is set to false the node is removed from the DOM. It differs from the Visible property where the node is still part of the DOM but invisible.

Visual

This node supports the following Visual Input Properties:

Outputs

Other

Data Description
Child Index The place this node has in relation to its parent. E.g. if a Group has three children, then the first child will have Child Index 0, the second child will have Child Index 1, and so on.
This A reference to this node. Used in custom Javascript nodes and more.

Bounding Box

Data Description
Screen Position X Where this node is on the screen's X-axis, in pixels.
Screen Position Y Where this node is on the screen's Y-axis, in pixels.
Width Current width of this node.
Height Current height of this node.

Mounted

Signal Description
Did Mount Signal sent when this node has been mounted, i.e. has become part of the visual tree and is visible.
Will Unmount Signal sent when this node is about to be removed from the visual tree and become hidden.

Signals

Signal Description
Drag Started Emitted when dragging of a child is detected.
Drag Ended Emitted when dragging stopped.
Drag Moved Emitted while a child node is being moved during the drag.

Values

Data Description
Drag X The current X position of the dragged node.
Drag Y The current Y position of the dragged node.
Delta X The horizontal distance a node has been dragged from its last horizontal position. Measured in px.
Delta Y The vertical distance a node has been dragged from its last vertical position. Measured in px.