API Reference > ui-framework > Frontstage > FrontstageManager

FrontstageManager Class

Frontstage Manager class.

Methods

Name Description
addFrontstageProvider(frontstageProvider: FrontstageProvider): void Static Add a Frontstage via a FrontstageProvider.  
clearFrontstageDefs(): void Static Clears the Frontstage map.  
closeModalFrontstage(): void Static Closes the top-most modal Frontstage.  
closeNestedFrontstage(): Promise<void> Static Closes the top-most nested Frontstage.  
findFrontstageDef(id?: string): FrontstageDef | undefined Static Find a loaded Frontstage with a given id.  
findWidget(widgetId: string): WidgetDef | undefined Static Sets the state of the widget with the given id  
initialize(): void Static Initializes the FrontstageManager  
openModalFrontstage(modalFrontstage: ModalFrontstageInfo): void Static Opens a modal Frontstage.  
openNestedFrontstage(nestedFrontstage: FrontstageDef): Promise<void> Static Opens a nested Frontstage.  
setActiveFrontstage(frontstageId: string): Promise<void> Static Sets the active FrontstageDef.  
setActiveFrontstageDef(frontstageDef: FrontstageDef | undefined): Promise<void> Static Sets the active FrontstageDef.  
setActiveLayout(contentLayoutDef: ContentLayoutDef, contentGroup: ContentGroup): Promise<void> Static Sets the active layout, content group and active content.  
setActiveNavigationAid(navigationAidId: string, iModelConnection: IModelConnection): void Static Sets the active Navigation Aid via its Id.  
setActiveTool(tool: Tool): void Static Sets the active tool  
setActiveToolId(toolId: string): void Static Sets the active tool id  
setWidgetState(widgetId: string, state: WidgetState): boolean Static Sets the state of the widget with the given id  
updateModalFrontstage(): void Static Updates the top-most modal Frontstage.  

Properties

Name Type Description
activeFrontstageDef Accessor StaticReadOnly FrontstageDef | undefined Gets the active FrontstageDef.  
activeFrontstageId Accessor StaticReadOnly string Gets the Id of the active FrontstageDef.  
activeModalFrontstage Accessor StaticReadOnly ModalFrontstageInfo | undefined Gets the top-most modal Frontstage.  
activeNestedFrontstage Accessor StaticReadOnly FrontstageDef | undefined Gets the top-most nested Frontstage.  
activeToolId Accessor StaticReadOnly string Gets the Id of the active tool.  
activeToolInformation Accessor StaticReadOnly ToolInformation | undefined Gets the active tool's ToolInformation  
activeToolSettingsNode Accessor StaticReadOnly React.ReactNode | undefined Gets the Tool Setting React node of the active tool.  
isLoading Accessor StaticReadOnly boolean Returns true if Frontstage is loading its controls.  
modalFrontstageCount Accessor StaticReadOnly number Gets the number of modal Frontstages.  
nestedFrontstageCount Accessor StaticReadOnly number Gets the number of nested Frontstages.  
NineZoneManager Accessor StaticReadOnly NineZoneManager Get Nine-zone State Manager.  
onContentControlActivatedEvent Static ContentControlActivatedEvent Get Content Control Activated event.  
onContentLayoutActivatedEvent Static ContentLayoutActivatedEvent Get Content Layout Activated event.  
onFrontstageActivatedEvent Static FrontstageActivatedEvent Get Frontstage Activated event.  
onFrontstageDeactivatedEvent Static FrontstageDeactivatedEvent Get Frontstage Deactivated event.  
onFrontstageReadyEvent Static FrontstageReadyEvent Get Frontstage Activated event.  
onModalFrontstageChangedEvent Static ModalFrontstageChangedEvent Get Modal Frontstage Changed event.  
onNavigationAidActivatedEvent Static NavigationAidActivatedEvent Get Navigation Aid Activated event.  
onToolActivatedEvent Static ToolActivatedEvent Get Tool Activated event.  
onToolIconChangedEvent Static ToolIconChangedEvent Get Tool Icon Changed event.  
onWidgetStateChangedEvent Static WidgetStateChangedEvent Get Widget State Changed event.  

Defined in

Last Updated: 13 June, 2024