UiItemsProvider Interface
Deprecated in 3.6. Use UiItemsProvider instead.
Describes interface of objects that want to provide UI component to the running IModelApp.
Implemented by
Properties
| Name | Type | Description | |
|---|---|---|---|
| id Readonly | string | id of provider | |
| onUnregister | () => void | undefined | Function called when the provider is unregistered via ItemsManager.unregister to allow provider to do cleanup. |
|
| provideBackstageItems | () => BackstageItem[] | undefined | UiItemsManager calls following method to augment backstage items. | |
| provideStatusBarItems | (stageId: string, stageUsage: string, stageAppData?: any) => CommonStatusBarItem[] | undefined | UiItemsManager calls following method to augment base statusbar for stages that allow it. | |
| provideToolbarButtonItems | (stageId: string, stageUsage: string, toolbarUsage: ToolbarUsage, toolbarOrientation: ToolbarOrientation, stageAppData?: any) => CommonToolbarItem[] | undefined | UiItemsManager calls following method to get items to populate specific toolbars | |
| provideWidgets | (stageId: string, stageUsage: string, location: StagePanelLocation, section?: StagePanelSection, zoneLocation?: AbstractZoneLocation, stageAppData?: any) => | undefined | UiItemsManager calls following method to augment Widget lists. |
Defined in
Last Updated: 13 May, 2024
Found something wrong, missing, or unclear on this page?Raise an issue in our repo.