Skip To Content ArcGIS for Developers Sign In Dashboard

ImageOverlay QML Type

An overlay that contains a frame with an image to display in the view. More...

Import Statement: import Esri.ArcGISRuntime 100.8
Since: Esri.ArcGISRuntime 100.8




Detailed Description

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.

ImageOverlay can be used to render fast and dynamic images. One example of such usage can be rendering of real-time sensor data like weather radar data, where each individual static image represents a single frame from the radar. In this workflow the 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 becomes available.

ImageOverlay does not support the rich processing and rendering capabilities of a RasterLayer. Use Raster and RasterLayer for static image rendering, analysis, and persistence.

Currently this feature is supported in SceneView (3D) only.

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.

TypeDefault Property

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).

opacity : real

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.

visible : bool

The visibility of the ImageOverlay.

Signal Documentation


Emitted when the imageFrame property of this ImageOverlay changes.


Emitted when the opacity property of this ImageOverlay changes.


Emitted when the visible property of this ImageOverlay changes.

Feedback on this topic?