UiFramework Class

Manages the Redux store, I18N service and iModel, Project and Login services for the ui-framework package.


Name Description
dispatchActionToStore(type: string, payload: any, immediateSync: boolean = false): void Static    
getAccessToken(): AccessToken | undefined Static    
getAccudrawSnapMode(): SnapMode Static    
getActiveIModelId(): string Static    
getActiveSelectionScope(): string Static    
getAvailableSelectionScopes(): PresentationSelectionScope[] Static   Beta
getColorTheme(): string Static   Beta
getDefaultIModelViewportControlId(): string | undefined Static    
getDefaultRulesetId(): string | undefined Static    
getDefaultViewId(): string | undefined Static    
getIModelConnection(): IModelConnection | undefined Static    
getIsUiVisible(): boolean Static   Beta
getWidgetOpacity(): number Static   Beta
initialize(store: Store<any>, i18n: I18N, oidcConfig?: OidcFrontendClientConfiguration, frameworkStateKey?: string): Promise<any> Static Called by IModelApp to initialize the UiFramework  
isMobile(): boolean Static   Beta
setAccessToken(accessToken: AccessToken, immediateSync: boolean = false): void Static    
setAccudrawSnapMode(snapMode: SnapMode): void Static    
setActiveIModelId(iModelId: string): void Static    
setActiveSelectionScope(selectionScopeId: string): void Static    
setColorTheme(theme: string): void Static   Beta
setDefaultIModelViewportControlId(iModelViewportControlId: string, immediateSync: boolean = false): void Static    
setDefaultRulesetId(viewId: string, immediateSync: boolean = false): void Static    
setDefaultViewId(viewId: string, immediateSync: boolean = false): void Static    
setIModelConnection(iModelConnection: IModelConnection | undefined, immediateSync: boolean = false): void Static    
setIsUiVisible(visible: boolean): void Static   Beta
setWidgetOpacity(opacity: number): void Static   Beta
terminate(): void Static Unregisters the UiFramework internationalization service namespace  


Name Type Description
frameworkState Accessor StaticReadOnly FrameworkState | undefined The UiFramework state maintained by Redux Beta
frameworkStateKey Accessor StaticReadOnly string   Beta
i18n Accessor StaticReadOnly I18N The internationalization service created by the IModelApp.  
i18nNamespace Accessor StaticReadOnly string The internationalization service namespace.  
oidcClient Accessor StaticReadOnly IOidcFrontendClient   Beta
onUiVisibilityChanged Static UiVisibilityChangedEvent Get Show Ui event. Beta
store Accessor StaticReadOnly Store<any> The Redux store  

Defined in

Last Updated: 10 September, 2019