An overlay that contains a frame with an image to display in the view. More...
| Import Statement: | import Esri.ArcGISRuntime 100.15 |
| Since: | Esri.ArcGISRuntime 100.8 |
| Inherits: |
Properties
- extent : Envelope
- imageFrame : ImageFrame
- opacity : real
- visible : bool
Signals
Detailed Description
Currently, this feature is supported in a SceneView (3D) only. The overlay can contain exactly one image at any given time. Multiple overlays, however, can be added and rendered at the same time on the SceneView. An ImageOverlay can be used to quickly render frequently changing images. For example, rendering real-time sensor data, such as weather, where each static image represents a single frame from the radar. In this workflow, images are constantly updated via a new ImageFrame each time new data is available. This provides a fast-refreshing workflow where the underlying images are frequently updated as new data comes in.
Because ImageOverlay does not support the rich processing and rendering capabilities of a RasterLayer, you should use Raster and RasterLayer for workflows that require static image rendering, analysis, and persistence.
Image overlays are rendered above all other layers in the scene, draped on the surface, and below any graphics overlays in the scene view. The overlay can contain exactly one image at any given time, however, multiple overlays can be added and rendered at the same time on the SceneView.
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 |
|---|---|
| ImageFrame | imageFrame |
See also ImageFrame, ImageFrame, and SceneView.
Property Documentation
extent : Envelope |
Returns the extent of the ImageOverlay (read-only).
The spatial reference of the extent matches the extent of the SceneView that contains the image overlay.
[default] imageFrame : ImageFrame |
Returns the ImageFrame contained in the ImageOverlay (read-only).
The opacity of the ImageOverlay.
Opacity values range from 0.0 to 1.0, where 0.0 is fully transparent and 1.0 is fully opaque.
The visibility of the ImageOverlay.
Signal Documentation
Emitted when the imageFrame property of this ImageOverlay changes.
Note: The corresponding handler is onImageFrameChanged.
Emitted when the opacity property of this ImageOverlay changes.
Note: The corresponding handler is onOpacityChanged.
Emitted when the visible property of this ImageOverlay changes.
Note: The corresponding handler is onVisibleChanged.