API Reference > ui-framework > Widget > WidgetDef WidgetDef Class A Widget Definition in the 9-Zone Layout system. Extended by ToolbarWidgetDefBase Methods Name Description constructor(widgetProps: WidgetProps): WidgetDef canOpen(): boolean getWidgetControl(type: ConfigurableUiControlType): undefined | WidgetControl onWidgetStateChanged(): void restoreTransientState(): boolean Overwrite to restore transient DOM state. saveTransientState(): void Overwrite to save transient DOM state (i.e. setCanPopout(value: undefined | boolean): void setLabel(v: string | ConditionalStringValue | StringGetter): void Set the label. setTooltip(v: string | ConditionalStringValue | StringGetter): void Set the tooltip. setUpSyncSupport(props: WidgetProps): void setWidgetState(newState: WidgetState): void createWidgetPropsFromAbstractProps(abstractWidgetProps: AbstractWidgetProps): WidgetProps Static initializeFromWidgetProps(widgetProps: WidgetProps, me: WidgetDef): void Static Properties Name Type Description activeState Accessor ReadOnly WidgetState applicationData Accessor ReadOnly any badgeType Accessor ReadOnly undefined | BadgeType canPopout Accessor ReadOnly undefined | boolean classId Accessor ReadOnly undefined | string | ConfigurableUiControlConstructor fillZone Accessor ReadOnly boolean iconSpec Accessor ReadOnly ConditionalStringValue | ReactNode id Accessor ReadOnly string isActive Accessor ReadOnly boolean isFloating Accessor ReadOnly boolean isFloatingStateSupported Accessor ReadOnly boolean isFloatingStateWindowResizable Accessor ReadOnly boolean isFreeform Accessor ReadOnly boolean isStatusBar Accessor ReadOnly boolean isToolSettings Accessor ReadOnly boolean isVisible Accessor ReadOnly boolean label Accessor ReadOnly string Get the label string priority Accessor ReadOnly number reactElement Accessor ReactNode reactNode Accessor ReactNode state Accessor ReadOnly WidgetState stateChanged Accessor ReadOnly boolean stateFunc Accessor ReadOnly undefined | WidgetStateFunc syncEventIds Accessor ReadOnly string[] tooltip Accessor ReadOnly string Get the tooltip string widgetControl Accessor ReadOnly undefined | WidgetControl widgetType Accessor WidgetType Defined in ui/framework/src/ui-framework/widgets/WidgetDef.tsx Line 115 Last Updated: 29 November, 2022