IRemoveSectionItemByWidgetRefPayload
Beta API. Mostly stable, but details may change in a minor release, outside SemVer.
Payload of the IRemoveSectionItemByWidgetRef command.
export interface IRemoveSectionItemByWidgetRefPayload
Properties
Property | Modifiers | Type | Description |
|---|---|---|---|
| boolean | (BETA) (Optional) Specify whether to eagerly remove the entire section if the item being removed was the only item in the section. | |
| (BETA) (Optional) Specify stash identifier. | ||
| (BETA) Widget reference of the item to remove. |
Property details
IRemoveSectionItemByWidgetRefPayload.eagerpropertyBeta
Beta API. Mostly stable, but details may change in a minor release, outside SemVer.
Specify whether to eagerly remove the entire section if the item being removed was the only item in the section.
readonly eager?: boolean;
Remarks
Default is false. Meaning an empty section will be left.
IRemoveSectionItemByWidgetRefPayload.stashIdentifierpropertyBeta
Beta API. Mostly stable, but details may change in a minor release, outside SemVer.
Specify stash identifier.
readonly stashIdentifier?: StashedDashboardItemsId;
Remarks
If provided, the item will not be permanently removed but will be stored in the stash under this identifier. You can then use the stash identifier to ‘resurrect’ the item in different section.
Default behavior with no stashIdentifier is to permanently remove the item as well.
IRemoveSectionItemByWidgetRefPayload.widgetRefpropertyBeta
Beta API. Mostly stable, but details may change in a minor release, outside SemVer.
Widget reference of the item to remove.
readonly widgetRef: ObjRef;