AbstractStatusBarActionItem Interface

Describes the data needed to insert an action item into the status bar.

Extends

Methods

Name Description
execute(): void Readonly method to execute when icon is pressed  

Properties

Name Type Description
icon Readonly string | ConditionalStringValue Name of icon WebFont entry or if specifying an SVG symbol added by plug on use "svg:" prefix to imported symbol Id.  
label Readonly string | ConditionalStringValue Label.  
tooltip Readonly string | ConditionalStringValue tooltip.  

Inherited properties

Name Type Inherited from Description
applicationData undefined | any AbstractStatusBarItem can be used by application to store miscellaneous data.
badgeType Readonly undefined | BadgeType AbstractStatusBarItem Describes badge.
id Readonly string AbstractStatusBarItem Required unique id of the item.
internalData Readonly undefined | Map<string, any> AbstractStatusBarItem optional data to used by item implementor.
isDisabled Readonly boolean | ConditionalBooleanValue AbstractStatusBarItem Describes if the item is enabled or disabled.
isHidden Readonly boolean | ConditionalBooleanValue AbstractStatusBarItem Describes if the item is visible or hidden.
itemPriority Readonly number AbstractStatusBarItem Priority within a section (recommend using values 1 through 100).
providerId Readonly undefined | string AbstractStatusBarItem id of UiItemsProvider
section Readonly StatusBarSection AbstractStatusBarItem status bar section

Defined in

Last Updated: 11 June, 2024