Class ImageOverlay
An overlay that contains an ImageFrame with an image to display in the SceneView.
Implements
Namespace: Esri.ArcGISRuntime.UI
Assembly: Esri.ArcGISRuntime.dll
Syntax
public sealed class ImageOverlay : INotifyPropertyChangedRemarks
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 realtime 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.
Since 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.
Constructors
| Name | Description |
|---|---|
| ImageOverlay() | Initializes a new instance of the ImageOverlay class. Creates an ImageOverlay |
| ImageOverlay(ImageFrame) | Initializes a new instance of the ImageOverlay class. Creates an ImageOverlay that contains an ImageFrame. |
Properties
| Name | Description |
|---|---|
| Extent | Gets the extent of the ImageOverlay. |
| ImageFrame | Gets or sets the ImageFrame contained in the ImageOverlay. |
| IsVisible | Gets or sets a value indicating whether the ImageOverlay is visible. |
| Opacity | Gets or sets the opacity of the ImageOverlay. |
| Name | Description |
|---|---|
| INotifyPropertyChanged.PropertyChanged | Occurs when a property value changes. |
Applies to
| Target | Versions |
|---|---|
| .NET Standard 2.0 | 100.8 - 200.2 |
| .NET 6.0 | 100.13 - 200.2 |
| .NET 6.0 Windows | 100.13 - 200.2 |
| .NET 6.0 Android | 200.0 - 200.2 |
| .NET 6.0 iOS | 200.0 - 200.2 |
| .NET Framework | 100.8 - 200.2 |
| .NET 5 | 100.10 - 100.12 |
| .NET Core 3.1 | 100.8 - 100.12 |
| Android | 100.8 - 100.15 |
| iOS | 100.8 - 100.15 |
| UWP | 100.8 - 200.2 |