IModelViewportControl Class
Beta
iModel Viewport Control
Extends
Implements
Methods
| Name | Description | |
|---|---|---|
| constructor(info: ConfigurableCreateInfo, options: IModelViewportControlOptions): IModelViewportControl | ||
| _getViewOverlay(viewport: ScreenViewport): React.ReactNode Protected | Get the default ViewOverlay unless parameter is set to not use it. | |
| getImodelConnectedViewportReactElement(): React.ReactNode Protected | Get the React component that will contain the Viewport | |
| getImodelViewportReactElement(iModelConnection: IModelConnection, viewState: ViewState): React.ReactNode Protected | Get the React component that will contain the Viewport | |
| getNoContentReactElement(_options: IModelViewportControlOptions): React.ReactNode Protected | Get the React component that will be shown when no iModel data is available | |
| getReactElementForViewSelectorChange(iModelConnection: IModelConnection, _unusedViewDefinitionId: Id64String, viewState: ViewState, _name: string): React.ReactNode | Get the React.Element for a ViewSelector change. |
Inherited methods
| Name | Inherited from | Description |
|---|---|---|
| getType(): ConfigurableUiControlType | ViewportContentControl | Gets the type of ConfigurableUiControl, which is 'Viewport' in this case |
| onActivated(): void | ViewportContentControl | Called when this ContentControl is activated |
| onDeactivated(): void | ContentControl | Called when this ContentControl is deactivated |
| onFrontstageDeactivated(): void | ConfigurableUiControl | Called when Frontstage is deactivated. |
| onFrontstageReady(): void | ConfigurableUiControl | Called when Frontstage is ready. |
| onInitialize(): void | ConfigurableUiControl | Called to initialize the ConfigurableUiControl. |
| processViewSelectorChange(iModel: IModelConnection, viewDefinitionId: Id64String, viewState: ViewState, name: string): Promise<void> | ViewportContentControl | Process a ViewSelector change. |
| setIsReady(): void | ViewportContentControl | Returns a promise that resolves when the control is ready for usage. |
Properties
| Name | Type | Description | |
|---|---|---|---|
| _disableDefaultViewOverlay Protected | boolean | ||
| _iModelConnection Protected | IModelConnection | undefined | ||
| _viewState Protected | ViewState | undefined | ||
| id Accessor StaticReadOnly | string | ||
| navigationAidControl Accessor ReadOnly | string | Get the NavigationAidControl associated with this ContentControl |
Inherited properties
| Name | Type | Inherited from | Description |
|---|---|---|---|
| classId Accessor ReadOnly | string | ConfigurableBase | Gets the class Id of configurable element |
| controlId Accessor ReadOnly | string | ConfigurableUiControl | Returns the ID of this ConfigurableUiControl. |
| isReady Accessor ReadOnly | Promise<void> | ViewportContentControl | Returns a promise that resolves when the control is ready for usage. |
| isViewport Accessor ReadOnly | boolean | ViewportContentControl | Returns true if this control is a Viewport control. |
| name Accessor ReadOnly | string | ConfigurableBase | Get internal name of configurable element. If no name is defined in configuration then the name will match the UniqueId. |
| reactElement Accessor | React.ReactNode | ContentControl | Gets the React element associated with this control. |
| supportsViewSelectorChange Accessor ReadOnly | boolean | ViewportContentControl | Returns true if this control supports processing ViewSelector changes. |
| viewport Accessor | ScreenViewport | undefined | ViewportContentControl | Gets the ScreenViewport |
Defined in
Last Updated: 08 January, 2020