ReferenceTypes

InternalNode

Source on GitHub

The InternalNode type is identical to the base Node type but is extended with some additional properties used internall by React Flow. Some functions and callbacks that return nodes may return an InternalNode.

export type InternalNodeBase<NodeType extends NodeBase = NodeBase> =
  NodeType & {
    measured: {
      width?: number;
      height?: number;
    };
    internals: {
      positionAbsolute: XYPosition;
      z: number;
      userNode: NodeType;
      handleBounds?: NodeHandleBounds;
      bounds?: NodeBounds;
    };
  };

Fields

#id
string
#position
XYPosition
#data
T
#type?
U
#sourcePosition?
Position
#targetPosition?
Position
#hidden?
boolean
Whether or not the node should be visible on the canvas.
#selected?
boolean
#dragging?
boolean
Whether or not the node is currently being dragged.
#draggable?
boolean
Whether or not the node is able to be dragged.
#selectable?
boolean
#connectable?
boolean
#resizing?
boolean
#deletable?
boolean
#dragHandle?
string
#width?
number | null
#height?
number | null
#parentNode?
string
#parentId?
string
#zIndex?
number
#extent?
"parent" | CoordinateExtent
#expandParent?
boolean
When true, the parent node will automatically expand if this node is dragged to the edge of the parent node's bounds.
#positionAbsolute?
XYPosition
#ariaLabel?
string
#focusable?
boolean
#style?
#className?
string
#handles?
NodeHandle[]
#origin?
NodeOrigin
#measured?
{ width?: number, height?: number }
#internals
object
#internals.positionAbsolute
XYPosition
#internals.z
number
#internals.userNode
NodeType
#internals.handleBounds?
NodeHandleBounds
#internals.bounds?
NodeBounds