VisibilityWidget Class

Beta  @deprecated

VisibilityWidget React component.

Extends

Methods

Name Description
constructor(info: ConfigurableCreateInfo, options: any): VisibilityWidget Creates an instance of ConfigurableUiControl.  
restoreTransientState(): boolean Overwrite to restore transient DOM state.  
saveTransientState(): void Overwrite to save transient DOM state (i.e.  

Inherited methods

Name Inherited from Description
getType(): ConfigurableUiControlType WidgetControl Gets the type of ConfigurableUiControl, which is 'Widget' in this case
onFrontstageDeactivated(): void WidgetControl Called when Frontstage is deactivated.
onFrontstageReady(): void WidgetControl Called when Frontstage is ready.
onInitialize(): void WidgetControl Called to initialize the ConfigurableUiControl.
onWidgetStateChanged(): void WidgetControl Called when widget state changes.
setWidgetState(state: WidgetState): void WidgetControl Sets the WidgetState for this control

Properties

Name Type Description
iconSpec Accessor StaticReadOnly string    
label Accessor StaticReadOnly string    

Inherited properties

Name Type Inherited from Description
classId Accessor ReadOnly string WidgetControl Gets the class Id of configurable element
controlId Accessor ReadOnly string WidgetControl Returns the ID of this ConfigurableUiControl.
isReady Accessor ReadOnly Promise<void> WidgetControl Returns a promise that resolves when the control is ready for usage.
name Accessor ReadOnly string WidgetControl Get internal name of configurable element. If no name is defined in configuration
then the name will match the UniqueId.
reactElement Accessor ReactNode WidgetControl The React element associated with this control
reactNode Accessor ReactNode WidgetControl The ReactNode associated with this control
widgetDef Accessor WidgetDef WidgetControl The WidgetDef associated with this control

Defined in

Last Updated: 12 June, 2024