gi-nx

---

gi-nx / setFlowDrawingOverlay

function setFlowDrawingOverlay(overlay: SdkDrawOverlay): void;

Open the drawing overlay for a flow block. Equivalent to a user pressing shift+A. Selects the feature if it isn't already, and enters vertices edit mode. Pass null to close the overlay and leave that mode again.

Parameters

Parameter	Type	Description
overlay	SdkDrawOverlay	The handle to edit, or null to close. Omit nodeId for the flow's first editable handle; getFlowHandleNodeTypes lists the node types that have one.

Returns

void

Throws

Error if the feature is unknown, runs no flow, cannot be selected, or the flow has no editable handle (or none matching nodeId)

Example

rpc.invoke("setFlowDrawingOverlay", [{ featureId }]);
rpc.invoke("setFlowDrawingOverlay", [null]);