interface-iboardselectioncommands

Interface: IBoardSelectionCommands

Commands related to the selection and selected widgets in the board

Hierarchy

  • IBoardSelectionCommands

Index

Methods

Methods

clear

clear(): Promise<void>

Unselect all widgets in the board

Returns: Promise<void>

A promised fulfilled if the action can be performed.


enterSelectWidgetsMode

enterSelectWidgetsMode(): Promise<{ selectedWidgets: IWidget[] }>

Creates a dark mask and prompts the current user to select a widget in the board (widget selection mode).

The user can only select one widget at the time.

Note: This command is not available in container extension points.

Returns: Promise<{ selectedWidgets: IWidget[] }>

A promise resolving into the selected widgets.
If the user cancels the selection the array of selected widgets will be empty


get

get(): Promise<IWidget[]>

Requires scope: BOARDS:READ

Returns: Promise<IWidget[]>

The currently selected widgets


selectWidgets

selectWidgets(widgetIds: InputWidgets): Promise<IWidget[]>

Selects an specific widget.

Requires scope: BOARDS:READ

Parameters:

NameType
widgetIdsInputWidgets

Returns: Promise<IWidget[]>

The selected widgets


Did this page help you?