Skip to content

gi-nx


gi-nx / enterBlockEditMode

ts
function enterBlockEditMode(featureId: string): void;

Opens the block editor on a block instance, exploding it into its child features so they can be edited in place. Call this again on a nested block instance to descend a level.

Parameters ​

ParameterTypeDescription
featureIdstringId of the block instance (a Point feature with a blockId) to edit.

Returns ​

void

Needs Permission ​

Throws ​

If the project is read only, the feature does not exist, is not a block instance, or cannot be edited from the current block edit (it is outside the edit, or its definition is already open further up the stack).

Example ​

ts
await rpc.invoke("enterBlockEditMode", ["0uQcmfb4wcsEv8BRLjNd4"]);