Home > @i2analyze/notebook-sdk > commands > IDynamicActionArea

commands.IDynamicActionArea interface

A scoped area for creating and surfacing commands within a commands.IDynamicGroupConfigBase.onPopulate() callback.

Signature:

interface IDynamicActionArea extends Pick<ICommandApi, 'createCommand'> 

Extends: Pick<ICommandApi, 'createCommand'>

Introduced: version 1.10

Remarks

Methods on this interface work like their equivalents on commands.IActionArea, but are scoped to the current populate session. Commands created here exist only while the group is open and are automatically unregistered when it closes.

getGroup is restricted to groups created within the same onPopulate call — it throws if you pass an external group identifier.

(Some inherited members may not be shown because they are not represented in the documentation.)

Methods

Method	Description
addGroup(group)	Adds a new group.
addOrGetGroup(group)	Adds a new group, or returns the existing one if it was already added during this onPopulate call.
after(idOrCommand)	Returns an area positioned immediately after the specified action or group.
before(idOrCommand)	Returns an area positioned immediately before the specified action or group.
getGroup(id)	Returns an area scoped to a group created during this onPopulate call.
surfaceCommands(commandsOrCommandIds)	Surfaces the specified commands in the group.