ImageFrame

A frame that, when added to an ImageOverlay, renders an image on top of a scene. An ImageFrame can contain images that do not have georeferencing information. In such cases, location data can be provided to geolocate the image.

Since

200.1.0

See also

Constructors

Link copied to clipboard
constructor(uri: String)

Creates an ImageFrame containing the image defined by the provided uri. Supported image formats are GeoTIFF, TIFF, JPEG, and PNG. The URI can be a local file path or an HTTP path to an image.

constructor(uri: String, extent: Envelope)

Creates an ImageFrame containing the image identified by the uri for display at the specified geographic extent. If a spatial reference is not defined for the extent, it is assumed to be the same as the scene. If the spatial reference of the extent is different from that of the scene, then the image would fail to render. Supported image formats are GeoTIFF, TIFF, JPEG, and PNG. The URI can be a local file path or an HTTP path to an image.

constructor(uri: String, quadrilateral: Polygon)

Creates an ImageFrame using the uri of an image and a four-point polygon representing the corners of an image. If a spatial reference is not defined for the polygon, it is assumed to be the same as the scene. If the spatial reference of the extent is different from that of the scene, then the image would fail to render. If the provided polygon doesn't contain exactly four points, the image frame will fail to load. Supported image formats are GeoTIFF, TIFF, JPEG, and PNG. The URL can be a local file path or an HTTP path to an image.

Types

Link copied to clipboard
object Companion

Properties

Link copied to clipboard

The extent of the image. Returns the extent of the image.

Link copied to clipboard

Returns the image contained in the ImageFrame.

Link copied to clipboard

Returns a polygon consisting of four points that represent each corner of the image.

Link copied to clipboard
val uri: String?

Returns the URI of the image.

Inherited properties

Link copied to clipboard
open override val loadStatus: StateFlow<LoadStatus>

The load status.

Inherited functions

Link copied to clipboard
open override fun cancelLoad()

Cancels loading metadata for the Loadable object.

Link copied to clipboard
open suspend override fun load(): Result<Unit>

Loads the metadata for the object.

Link copied to clipboard
open suspend override fun retryLoad(): Result<Unit>

Loads or retries loading metadata for the object.