ViewportContentControl Class
The base class for Frontstage Viewport content controls.
Extends
Extended by
Implements
Methods
Name |
Description |
|
constructor(info: ConfigurableCreateInfo, options: any): ViewportContentControl |
Creates an instance of ViewportContentControl. |
|
getReactElementForViewSelectorChange(_iModel: IModelConnection, _viewDefinitionId: Id64String, _viewState: ViewState, _name: string): React.ReactNode |
Get the React.Element for a ViewSelector change. |
|
getType(): ConfigurableUiControlType |
Gets the type of ConfigurableUiControl, which is 'Viewport' in this case |
|
onActivated(): void |
Called when this ContentControl is activated |
|
processViewSelectorChange(iModel: IModelConnection, viewDefinitionId: Id64String, viewState: ViewState, name: string): Promise<void> |
Process a ViewSelector change. |
|
setIsReady(): void |
Returns a promise that resolves when the control is ready for usage. |
|
Inherited methods
Properties
Name |
Type |
Description |
|
isReady Accessor ReadOnly |
Promise<void> |
Returns a promise that resolves when the control is ready for usage. |
|
isViewport Accessor ReadOnly |
boolean |
Returns true if this control is a Viewport control. |
|
navigationAidControl Accessor ReadOnly |
string |
Get the NavigationAidControl associated with this ContentControl |
|
supportsViewSelectorChange Accessor ReadOnly |
boolean |
Returns true if this control supports processing ViewSelector changes. |
|
viewport Accessor |
ScreenViewport | undefined |
Gets the ScreenViewport |
|
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. |
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. |
Defined in
Last Updated:
08 January, 2020