Show / Hide Table of Contents

Constructor ImageFrame

ImageFrame(RuntimeImage, Envelope)

Initializes a new instance of the ImageFrame class that contains the image for display at the specified geographic extent.

Declaration
public ImageFrame(RuntimeImage image, Envelope extent)
Parameters
Type Name Description
RuntimeImage image

An image to display in the frame.

Envelope extent

The geographic extent at which the image is displayed.

Remarks

If a spatial reference is not defined for the extent, it is assumed to be the same as the map or scene. If the spatial reference of the extent is different from that of the map or scene, then the image would fail to render.

A RuntimeImage can be created from PNG and JPEG images. In general, prefer using ImageFrame constructors accepting a Uri, as these constructors support more image formats and use memory more efficiently.

Applies to

Platforms and versions
TargetVersions
.NET Standard 2.0100.8 - 200.7
.NET100.13 - 200.7
.NET Windows100.13 - 200.7
.NET Android200.0 - 200.7
.NET iOS200.0 - 200.7
.NET Framework100.8 - 200.7
Xamarin.Android100.8 - 100.15
Xamarin.iOS100.8 - 100.15
UWP100.8 - 200.7

ImageFrame(RuntimeImage, Polygon)

Initializes a new instance of the ImageFrame class using the image and a four-point polygon representing the corners of an image.

Declaration
public ImageFrame(RuntimeImage image, Polygon quadrilateral)
Parameters
Type Name Description
RuntimeImage image

An image to display in the frame.

Polygon quadrilateral

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

Remarks

If a spatial reference is not defined for the polygon, it is assumed to be the same as the map or scene. If the spatial reference of the polygon is different from that of the map or scene, then the image would fail to render. If the provided polygon does not contain exactly four points, the image frame will fail to load.

A RuntimeImage can be created from PNG and JPEG images. In general, prefer using ImageFrame constructors accepting a Uri, as these constructors support more image formats and use memory more efficiently.

Applies to

Platforms and versions
TargetVersions
.NET Standard 2.0100.8 - 200.7
.NET100.13 - 200.7
.NET Windows100.13 - 200.7
.NET Android200.0 - 200.7
.NET iOS200.0 - 200.7
.NET Framework100.8 - 200.7
Xamarin.Android100.8 - 100.15
Xamarin.iOS100.8 - 100.15
UWP100.8 - 200.7

ImageFrame(Uri)

Initializes a new instance of the ImageFrame class containing a georeferenced image defined by the provided URI.

Declaration
public ImageFrame(Uri uri)
Parameters
Type Name Description
System.Uri uri

A URI that identifies a local or online image source.

Remarks

The URI 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. Animated GIF is not supported.

Applies to

Platforms and versions
TargetVersions
.NET Standard 2.0100.8 - 200.7
.NET100.13 - 200.7
.NET Windows100.13 - 200.7
.NET Android200.2 - 200.7
.NET iOS200.0 - 200.7
.NET Framework100.8 - 200.7
Xamarin.Android100.8 - 100.14
Xamarin.iOS100.8 - 100.15
UWP100.8 - 200.7

ImageFrame(Uri, Envelope)

Initializes a new instance of the ImageFrame class containing the image identified by the URI for display at the specified geographic extent.

Declaration
public ImageFrame(Uri uri, Envelope extent)
Parameters
Type Name Description
System.Uri uri

A URI that identifies a local or online image source.

Envelope extent

The geographic extent at which the image is displayed.

Remarks

If a spatial reference is not defined for the extent, it is assumed to be the same as the map or scene. If the spatial reference of the extent is different from that of the scene or map, then the image would fail to render. The URI 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. Animated GIF is not supported.

Applies to

Platforms and versions
TargetVersions
.NET Standard 2.0100.8 - 200.7
.NET100.13 - 200.7
.NET Windows100.13 - 200.7
.NET Android200.2 - 200.7
.NET iOS200.0 - 200.7
.NET Framework100.8 - 200.7
Xamarin.Android100.8 - 100.14
Xamarin.iOS100.8 - 100.15
UWP100.8 - 200.7

ImageFrame(Uri, Polygon)

Initializes a new instance of the ImageFrame class using the URI of an image and a four-point polygon representing the corners of an image.

Declaration
public ImageFrame(Uri uri, Polygon quadrilateral)
Parameters
Type Name Description
System.Uri uri

A URI that identifies a local or online image source.

Polygon quadrilateral

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

Remarks

If a spatial reference is not defined for the polygon, it is assumed to be the same as the map or scene. If the spatial reference of the extent is different from that of the map or 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. The URI 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. Animated GIF is not supported.

Applies to

Platforms and versions
TargetVersions
.NET Standard 2.0100.8 - 200.7
.NET100.13 - 200.7
.NET Windows100.13 - 200.7
.NET Android200.2 - 200.7
.NET iOS200.0 - 200.7
.NET Framework100.8 - 200.7
Xamarin.Android100.8 - 100.14
Xamarin.iOS100.8 - 100.15
UWP100.8 - 200.7
In This Article
Back to top Copyright © 2022 Esri.