UiFramework Class
Manages the Redux store, I18N service and iModel, Project and Login services for the ui-framework package.
Methods
| Name | Description | |
|---|---|---|
| constructor(): UiFramework | ||
| closeCursorMenu(): void Static | Beta | |
| dispatchActionToStore(type: string, payload: any, immediateSync: boolean = false): void Static | ||
| getAccudrawSnapMode(): SnapMode Static | ||
| getActiveIModelId(): string Static | ||
| getActiveSelectionScope(): string Static | ||
| getAvailableSelectionScopes(): PresentationSelectionScope[] Static | Beta | |
| getColorTheme(): string Static | ||
| getCursorMenuData(): undefined | CursorMenuData Static | Beta | |
| getDefaultIModelViewportControlId(): undefined | string Static | ||
| getDefaultViewId(): undefined | string Static | ||
| getDefaultViewState(): undefined | ViewState Static | ||
| getIModelConnection(): undefined | IModelConnection Static | ||
| getIsUiVisible(): boolean Static | ||
| getUiSettingsStorage(): UiSettingsStorage Static | Beta | |
| getUserInfo(): undefined | UserInfo Static | Beta | |
| getWidgetOpacity(): number Static | ||
| initialize(store: undefined | Store<any, AnyAction>, i18n?: I18N, frameworkStateKey?: string): Promise<void> Static | Called by the application to initialize the UiFramework. | |
| isMobile(): boolean Static | ||
| openCursorMenu(menuData: undefined | CursorMenuData): void Static | Beta | |
| setAccudrawSnapMode(snapMode: SnapMode): void Static | ||
| setActiveIModelId(iModelId: string): void Static | ||
| setActiveSelectionScope(selectionScopeId: string): void Static | ||
| setColorTheme(theme: string): void Static | ||
| setDefaultIModelViewportControlId(iModelViewportControlId: string, immediateSync: boolean = false): void Static | ||
| setDefaultViewId(viewId: string, immediateSync: boolean = false): void Static | ||
| setDefaultViewState(viewState: ViewState, immediateSync: boolean = false): void Static | ||
| setIModelConnection(iModelConnection: undefined | IModelConnection, immediateSync: boolean = false): void Static | ||
| setIsUiVisible(visible: boolean): void Static | ||
| setUiSettingsStorage(storage: UiSettingsStorage, immediateSync: boolean = false): Promise<void> Static | Beta | |
| setUiVersion(version: string): void Static | ||
| setUseDragInteraction(useDragInteraction: boolean): void Static | ||
| setUserInfo(userInfo: undefined | UserInfo, immediateSync: boolean = false): void Static | Beta | |
| setWidgetOpacity(opacity: number): void Static | ||
| terminate(): void Static | Un-registers the UiFramework internationalization service namespace |
Properties
| Name | Type | Description | |
|---|---|---|---|
| backstageManager Accessor StaticReadOnly | BackstageManager | ||
| childWindowManager Accessor StaticReadOnly | ChildWindowManager | ||
| frameworkState Accessor StaticReadOnly | undefined | FrameworkState | The UiFramework state maintained by Redux | |
| frameworkStateKey Accessor StaticReadOnly | string | ||
| i18n Accessor StaticReadOnly | I18N | The internationalization service created by the app. | |
| i18nNamespace Accessor StaticReadOnly | string | The internationalization service namespace. | |
| initialized Accessor StaticReadOnly | boolean | Determines if UiFramework has been initialized | |
| onUiVisibilityChanged StaticReadonly | UiVisibilityChangedEvent | Get Show Ui event. | |
| settingsManager Accessor StaticReadOnly | SettingsManager | Property that returns the SettingManager used by AppUI-based applications. | |
| store Accessor StaticReadOnly | Store<any, AnyAction> | The Redux store | |
| uiVersion Accessor StaticReadOnly | string | Returns the Ui Version. | |
| useDefaultPopoutUrl Static | boolean | ||
| useDragInteraction Accessor StaticReadOnly | boolean |
Defined in
Last Updated: 11 June, 2024