IModelApp Class
Global singleton that connects the user interface with the iModel.js services. There can be only one IModelApp active in a session. All members of IModelApp are static, and it serves as a singleton object for gaining access to session information.
Before any interactive operations may be performed by the @bentley/imodeljs-frontend package
, IModelApp.startup must be called.
Applications may customize the frontend behavior of iModel.js by supplying options to IModelApp.startup.
Methods
Name | Description | |
---|---|---|
makeHTMLElement<K extends undefined>(type: K extends undefined, opt?: object): HTMLElementTagNameMap[K] Static | Shortcut for creating an HTMLElement with optional parent, className, id, innerHTML, innerText @internal |
|
makeIModelJsLogoCard(): HTMLTableRowElement Static | Make the logo card for the iModel.js library itself. | |
makeLogoCard(opts: object): HTMLTableRowElement Static | Make a new Logo Card. | Beta |
queryRenderCompatibility(): WebGLRenderCompatibilityInfo Static | Obtain WebGL rendering compatibility information for the client system. | Beta |
shutdown(): void Static | Must be called before the application exits to release any held resources. | |
startup(opts?: IModelAppOptions): void Static | This method must be called before any iModel.js frontend services are used. |
Properties
Name | Type | Description | |
---|---|---|---|
accuSnap Accessor StaticReadOnly | AccuSnap | The IModelApp.AccuSnap for this session. | |
animationInterval Accessor Static | BeDuration | undefined | Controls how frequently the application polls for changes that may require a new animation frame to be requested. | Beta |
applicationId Accessor StaticReadOnly | string | The Id of this application. | |
applicationLogoCard Static | undefined | () => HTMLTableRowElement | Applications may implement this method to supply a Logo Card. | Beta |
applicationVersion Accessor StaticReadOnly | string | The version of this application. | |
authorizationClient Static | undefined | IAuthorizationClient | Provides authorization information for various frontend APIs | |
features Accessor StaticReadOnly | FeatureTrackingManager | The FeatureTrackingManager for this session | |
i18n Accessor StaticReadOnly | I18N | The I18N for this session. | |
iModelClient Accessor StaticReadOnly | IModelClient | The IModelClient for this session. | |
notifications Accessor StaticReadOnly | NotificationManager | The NotificationManager for this session. | |
renderSystem Accessor StaticReadOnly | RenderSystem | The RenderSystem for this session. | |
sessionId Static | GuidString | A uniqueId for this session | |
settings Accessor StaticReadOnly | SettingsAdmin | The SettingsAdmin for this session. | |
toolAdmin Accessor StaticReadOnly | ToolAdmin | The ToolAdmin for this session. | |
tools Static | ToolRegistry | The ToolRegistry for this session. | |
uiAdmin Accessor StaticReadOnly | UiAdmin | The UiAdmin for this session. | |
viewManager Accessor StaticReadOnly | ViewManager | The ViewManager for this session. |
Defined in
Last Updated: 08 January, 2020