UiItemsProvider Interface

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

Properties

Name Type Description
id string id of provider  
onBackstageItemArbiterChange undefined | (item: BackstageItem, action: UiItemsApplicationAction) => void Called if the application changed the Backstage item  
onStatusBarItemArbiterChange undefined | (item: CommonStatusBarItem, action: UiItemsApplicationAction) => void Called if the application changed the StatusBar item  
onToolbarButtonItemArbiterChange undefined | (item: CommonToolbarItem, action: UiItemsApplicationAction) => void Called if the application changed the Toolbar button item  
onWidgetArbiterChange undefined | (widget: AbstractWidgetProps, action: UiItemsApplicationAction) => void Called if the application changed the Widget  
provideBackstageItems undefined | () => BackstageItem[] UiItemsManager calls following method to augment backstage items.  
provideStatusBarItems undefined | (stageId: string, stageUsage: string) => CommonStatusBarItem[] UiItemsManager calls following method to augment base statusbar for stages that allow it.  
provideToolbarButtonItems undefined | (stageId: string, stageUsage: string, toolbarUsage: ToolbarUsage, toolbarOrientation: ToolbarOrientation) => CommonToolbarItem[] UiItemsManager calls following method to get items to populate specific toolbars  
provideWidgets undefined | (stageId: string, stageUsage: string, location: StagePanelLocation, section?: StagePanelSection, zoneLocation?: AbstractZoneLocation) => ReadonlyArray<AbstractWidgetProps> UiItemsManager calls following method to augment Widget lists.  

Defined in

Last Updated: 15 June, 2021