StatusBarWidgetControl Class
Status Bar Widget Control.
Extends
Implements
Methods
Name | Description | |
---|---|---|
constructor(info: ConfigurableCreateInfo, options: any): StatusBarWidgetControl | ||
getReactNode(args: StatusBarWidgetControlArgs): React.ReactNode Abstract | Gets the React node associated with this StatusBar Widget Control | |
getType(): ConfigurableUiControlType | Gets the type of ConfigurableUiControl, which is 'StatusBarWidget' in this case |
Inherited methods
Name | Inherited from | Description |
---|---|---|
onFrontstageDeactivated(): void | ConfigurableUiControl | Called when Frontstage is deactivated. |
onFrontstageReady(): void | ConfigurableUiControl | Called when Frontstage is ready. |
onInitialize(): void | ConfigurableUiControl | Called to initialize the ConfigurableUiControl. |
onWidgetStateChanged(): void | WidgetControl | Called when widget state changes. |
restoreTransientState(): boolean | WidgetControl | Overwrite to restore transient DOM state. |
saveTransientState(): void | WidgetControl | Overwrite to save transient DOM state (i.e. |
setWidgetState(state: WidgetState): void | WidgetControl | Sets the WidgetState for this control |
Inherited properties
Name | Type | Inherited from | Description |
---|---|---|---|
classId Accessor ReadOnly | string | ConfigurableBase | Gets the class Id of configurable element |
controlId Accessor ReadOnly | string | ConfigurableUiControl | Returns the ID of this ConfigurableUiControl. |
isReady Accessor ReadOnly | Promise<void> | ConfigurableUiControl | Returns a promise that resolves when the control is ready for usage. |
name Accessor ReadOnly | string | ConfigurableBase | Get internal name of configurable element. If no name is defined in configuration then the name will match the UniqueId. |
reactElement Accessor | React.ReactNode | WidgetControl | Gets the React element associated with this control |
widgetDef Accessor | WidgetDef | WidgetControl | Gets the WidgetDef associated with this control |
Defined in
Last Updated: 08 January, 2020