Skip To Content ArcGIS for Developers Sign In Dashboard

ImageFrame QML Type

A frame that, when added to an ImageOverlay, renders an image on top of a scene. More...

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

Object

Properties

Signals

Methods

Detailed Description

An ImageFrame can contain images that do not have georeferencing information. In such cases, location data can be provided to geolocate the image.

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
Envelopeextent
Polygonquadrilateral

You can initialize the imageFrame in several different ways:

  • Creating an image from a URL that is georeferenced
  • Creating an image from a URL (that does not have any georeferencing information) and an extent
  • Creating an image from a URL (that does not have any georeferencing information) and a four-point polygon that defines a quadrilateral.

Each method of initialization is mutually exclusive. For example, you should not set both the extent and quadrilateral properties.

The table below highlights the possible combinations.

PropertyProperty
url - a georeferenced image URLN/A
url - a non-georeferenced image URLextent
url - a non-georeferenced image urlquadrilateral

The URL can be a local file path or an HTTP path to an image. Supported image formats are TIFF, GeoTIFF, ICO, BMP, GIF, JPEG, and PNG.

See also Loadable, RemoteResource, and ImageOverlay.

Property Documentation

[default] credential : Credential

The credential to be used to access a secured image URL if provided.

A credential can only be provided before the image frame is loaded.


[default] extent : Envelope

The extent of the image.

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 TIFF, GeoTIFF, ICO, BMP, GIF, JPEG, and PNG.


loadError : Error

Returns the load error (read-only).

Note: load errors are also reported on the error property and emit the errorChanged signal.

See also Loadable.


loadStatus : Enums.LoadStatus

Returns the load status (read-only).

See also Loadable and Enums.LoadStatus.


[default] quadrilateral : Polygon

The polygon consisting of four points that represent each corner of the 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 TIFF, GeoTIFF, ICO, BMP, GIF, JPEG, and PNG.


[default] requestConfiguration : RequestConfiguration

The configuration parameters used for network requests sent by the image frame.


url : url

A URL that identifies a local or online image source.

This could be a local file path, Qt resource path, or HTTP path to the image. The URL can only be provided before the picture marker symbol is loaded. Supported image formats are GeoTIFF, TIFF, JPEG, and PNG.


Signal Documentation

credentialChanged()

Emitted when the credential property changes.

Note: The corresponding handler is onCredentialChanged.


extentChanged()

Emitted when the extent property of this ImageFrame changes.

Note: The corresponding handler is onExtentChanged.


loadErrorChanged()

Emitted when the loadError property of this ArcGISFeature changes.

Note: load errors are also reported on the error property and emit the errorChanged signal.

Note: The corresponding handler is onLoadErrorChanged.

See also Loadable and Object.


loadStatusChanged()

Emitted when the loadStatus property of this ArcGISFeature changes.

Note: The corresponding handler is onLoadStatusChanged.

See also Loadable.


quadrilateralChanged()

Emitted when the quadrilateral property of this ImageFrame changes.

Note: The corresponding handler is onQuadrilateralChanged.


requestConfigurationChanged()

Emitted when the requestConfiguration property changes.

Note: The corresponding handler is onRequestConfigurationChanged.


urlChanged()

Emitted when the url property of this ImageFrame changes.

Note: The corresponding handler is onUrlChanged.


Method Documentation

void cancelLoad()

See also Loadable.


void load()

See also Loadable.


void retryLoad()

See also Loadable.



Feedback on this topic?