Surface QML Type
Class containing elevation sources. More...
| Import Statement: | import Esri.ArcGISRuntime |
| Since: | Esri.ArcGISRuntime 100.0 |
| Inherits: |
Properties
- backgroundGrid : BackgroundGrid
- elevationExaggeration : real
- elevationSources : ElevationSourceListModel
- enabled : bool
- loadError : Error
- loadStatus : Enums.LoadStatus
- locationToElevationResult : double
- locationToElevationStatus : Enums.TaskStatus
- name : string
- navigationConstraint : Enums.NavigationConstraint
- opacity : real
Signals
- backgroundGridChanged()
- elevationExaggerationChanged()
- enabledChanged()
- loadErrorChanged()
- loadStatusChanged()
- locationToElevationStatusChanged()
- nameChanged()
- navigationConstraintChanged()
- opacityChanged()
Methods
- bool cancelTask(string taskId)
- string locationToElevation(Point location)
Detailed Description
This QML type supports the following default properties. A default property may be declared inside another declared object without being assigned explicitly to a property.
| Type | Default Property |
|---|---|
| ElevationSource | elevationSources (appends to model) |
| BackgroundGrid | backgroundGrid (since Esri.ArcGISRuntime 100.1) |
The QML type Surface contains a list of elevation sources, and defines a surface upon which layers and overlays can be draped. The order of the elevation sources determines how the elevations are blended together for each level of detail.
See also Loadable and Cancelable.
Property Documentation
[default, since Esri.ArcGISRuntime 100.1] backgroundGrid : BackgroundGrid |
The surface's background grid.
The surface is displayed on top of the background grid.
This property was introduced in Esri.ArcGISRuntime 100.1.
elevationExaggeration : real |
The elevation exaggeration for the surface.
The altitude values of the surface data are multiplied by the exaggeration value. The default value is 1.0.
[default] elevationSources : ElevationSourceListModel |
Returns the list of elevationSources as a model (read-only).
enabled : bool |
Whether the surface is enabled for the scene.
loadError : Error |
Returns the load error (read-only).
Note: load errors are also reported on the error property and emit the errorChanged signal.
See also Loadable.
loadStatus : Enums.LoadStatus |
Returns an enumeration value for the current load status of the surface (read-only).
See also Loadable and Enums.LoadStatus.
locationToElevationResult : double |
The elevation calculated by locationToElevation method for the specified map point.
The elevation is expressed in meters above sea level.
locationToElevationStatus : Enums.TaskStatus |
Returns the status of the latest asynchronous task to calculate the elevation of a location (read-only).
The task is started using locationToElevation.
See also Enums.TaskStatus.
name : string |
The name of the surface.
[since Esri.ArcGISRuntime 100.5] navigationConstraint : Enums.NavigationConstraint |
The type of navigation constraint from the surface.
The default value is Enums.NavigationConstraintStayAbove.
This property was introduced in Esri.ArcGISRuntime 100.5.
[since Esri.ArcGISRuntime 100.5] opacity : real |
The opacity of the ground surface.
You can adjust this ground surface opacity property to see through the ground. Changing this property also changes the transparency of the basemap. (Draped operational layers are not affected by this property.) Valid values are from 0.0 (full transparency) to 1.0 (full opacity).
The opacity affects all base layers and the grid color:
- If an individual base layer has 50% opacity and the surface has 50% opacity, the effect will be multiplicative, i.e. the base layer will appear to have 25% opacity.
- If the grid color has an alpha value of 50% and the surface has 50% opacity, the effect on the grid will also be multiplicative.
The default value is 1.0.
This property was introduced in Esri.ArcGISRuntime 100.5.
Signal Documentation
|
Emitted when the backgroundGrid property changes.
Note: The corresponding handler is onBackgroundGridChanged.
This signal was introduced in Esri.ArcGISRuntime 100.1.
elevationExaggerationChanged() |
Emitted when the elevationExaggeration property of the surface changes.
Note: The corresponding handler is onElevationExaggerationChanged.
enabledChanged() |
Emitted when the enabled property of the surface changes.
Note: The corresponding handler is onEnabledChanged.
loadErrorChanged() |
loadStatusChanged() |
Emitted when the loadStatus property of the surface changes.
Note: The corresponding handler is onLoadStatusChanged.
See also Loadable.
locationToElevationStatusChanged() |
Emitted when the locationToElevationStatus property of the surface changes.
Note: The corresponding handler is onLocationToElevationStatusChanged.
nameChanged() |
Emitted when the name property of the surface changes.
Note: The corresponding handler is onNameChanged.
|
Emitted when the navigationConstraint property changes.
Note: The corresponding handler is onNavigationConstraintChanged.
This signal was introduced in Esri.ArcGISRuntime 100.5.
|
Emitted when the opacity property changes.
Note: The corresponding handler is onOpacityChanged.
This signal was introduced in Esri.ArcGISRuntime 100.5.
Method Documentation
bool cancelTask(string taskId) |
Cancel the task with the ID taskId.
Returns false if the task cannot be canceled or there is no task with the specified id taskId.
See also Cancelable.
string locationToElevation(Point location) |
Gets the elevation for the specified location on the surface using an asynchronous task.
Before calling this method, check the locationToElevationStatus property to see whether a locationToElevation task is already in progress. If so, then this method cannot start a new task.
Returns a task ID that can be used to cancel the task.
See also Cancelable.