UiItemsProvider Interface

Describes interface of objects that want to provide UI component to the running IModelApp.

Implemented by

Methods

Name Description
onUnregister(): void OptionalReadonly Function called when the provider is unregistered.  
provideBackstageItems(): undefined OptionalReadonly Provides backstage items.  
provideStatusBarItems(stageId: string, stageUsage: string): undefined OptionalReadonly Provides status bar items.  
provideToolbarItems(stageId: string, stageUsage: string, toolbarUsage: ToolbarUsage, toolbarOrientation: ToolbarOrientation): undefined OptionalReadonly Provides toolbar items.  
provideWidgets(stageId: string, stageUsage: string, location: StagePanelLocation, section?: StagePanelSection): undefined OptionalReadonly Provides widgets.  

Properties

Name Type Description
id Readonly string Id of provider.  

Defined in

Last Updated: 09 March, 2023