ImageOverlay

An overlay that contains a frame with an image to display in the view. 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.

Since

200.1.0

See also

Constructors

Link copied to clipboard
constructor(imageFrame: ImageFrame? = null)

Creates an image overlay that contains imageFrame, or an empty one if imageFrame is null.

Properties

Link copied to clipboard

The extent of the ImageOverlay. The spatial reference of the extent matches the extent of the SceneView that contains the image overlay.

Link copied to clipboard

The ImageFrame contained in the ImageOverlay.

Link copied to clipboard

The visibility of the ImageOverlay.

Link copied to clipboard

The opacity for the ImageOverlay. Opacity values range from 0.0 to 1.0, where 0.0 is fully transparent and 1.0 is fully opaque.