ArcGIS Runtime SDK for iOS: AGSImageFrame Class Reference
ArcGIS Runtime SDK for iOS  100.12
AGSImageFrame Class Reference

Description

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

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

See also
AGSImageOverlay
Since
100.8
Inheritance diagram for AGSImageFrame:
AGSLoadableBase <AGSRemoteResource> AGSObject <AGSLoadable>

Instance Methods

(void) - cancelLoad
 
(void) - doCancelLoading
 
(void) - doStartLoading:
 
(instancetype) - initWithImage:extent:
 
(instancetype) - initWithImage:quadrilateral:
 
(instancetype) - initWithURL:
 
(instancetype) - initWithURL:extent:
 
(instancetype) - initWithURL:quadrilateral:
 
(void) - loadDidFinishWithError:
 
(void) - loadWithCompletion:
 
(void) - onLoadStatusChanged
 
(void) - retryLoadWithCompletion:
 

Class Methods

(instancetype) + imageFrameWithImage:extent:
 
(instancetype) + imageFrameWithImage:quadrilateral:
 
(instancetype) + imageFrameWithURL:
 
(instancetype) + imageFrameWithURL:extent:
 
(instancetype) + imageFrameWithURL:quadrilateral:
 

Properties

AGSCredentialcredential
 
AGSEnvelopeextent
 
AGSImageimage
 
NSError * loadError
 
AGSLoadStatus loadStatus
 
AGSPolygonquadrilateral
 
AGSRequestConfigurationrequestConfiguration
 
NSURL * URL
 

Method Documentation

◆ cancelLoad

- (void) cancelLoad
requiredinherited

Cancels loading if it is in progress, otherwise it does nothing. This should be called carefully because other objects could be waiting for loadWithCompletion: or retryLoadWithCompletion: to complete and this will call them all back with the error of NSUserCancelledError

Since
100

◆ doCancelLoading

- (void) doCancelLoading

Never call this method directly. The framework calls this method on a background thread when cancelLoad (AGSLoadable-p) is called. It is meant to be overriden by subclasses. Subclasses should override this method to cancel loading their data and call loadDidFinishWithError: (AGSLoadableBase(ForSubclassEyesOnly)) at the end passing in an error representing NSUserCancelledError.

Since
100

Provided by category AGSLoadableBase(ForSubclassEyesOnly).

◆ doStartLoading:

- (void) doStartLoading: (BOOL)  retrying

Never call this method directly. The framework calls this method on a background thread when loadWithCompletion: (AGSLoadable-p) or retryLoadWithCompletion: (AGSLoadable-p) is called. It is meant to be overriden by subclasses. Subclasses should override this method to load their data and call loadDidFinishWithError: (AGSLoadableBase(ForSubclassEyesOnly)) upon completion, passing in the error if any.

Parameters
retryingflag that is true if this method was called from retryLoadWithCompletion: (AGSLoadable-p).
Since
100

Provided by category AGSLoadableBase(ForSubclassEyesOnly).

◆ imageFrameWithImage:extent:

+ (instancetype) imageFrameWithImage: (AGSImage *)  image
extent: (AGSEnvelope *)  extent 

Initialize an AGSImageFrame containing the image 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 TIFF, GeoTIFF, ICO, BMP, GIF, JPEG, and PNG. Animated GIF is not supported.

Parameters
imageAn image to display in the frame.
extentThe geographic extent at which the image is displayed.
Since
100.8

◆ imageFrameWithImage:quadrilateral:

+ (instancetype) imageFrameWithImage: (AGSImage *)  image
quadrilateral: (AGSPolygon *)  quadrilateral 

Initialize an AGSImageFrame using the 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 TIFF, GeoTIFF, ICO, BMP, GIF, JPEG, and PNG. Animated GIF is not supported.

Parameters
imageAn image to display in the frame.
quadrilateralA polygon consisting of four points that represent each corner of the image.
Since
100.8

◆ imageFrameWithURL:

+ (instancetype) imageFrameWithURL: (NSURL *)  URL

Initialize an AGSImageFrame containing the image defined by the provided URL.

Note
Supported image formats are GeoTIFF, TIFF, JPEG, and PNG. The URL to an image file on disk or web.
Parameters
URLA URL to an image file on disk or web.
Since
100.8

◆ imageFrameWithURL:extent:

+ (instancetype) imageFrameWithURL: (NSURL *)  URL
extent: (AGSEnvelope *)  extent 

Initialize an AGSImageFrame containing the image identified by the URL 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.

Note
Supported image formats are GeoTIFF, TIFF, JPEG, and PNG. The URL to an image file on disk or web.
Parameters
URLA URL to an image file on disk or web.
extentThe geographic extent at which the image is displayed.
Since
100.8

◆ imageFrameWithURL:quadrilateral:

+ (instancetype) imageFrameWithURL: (NSURL *)  URL
quadrilateral: (AGSPolygon *)  quadrilateral 

Initialize an AGSImageFrame using the URL 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.

Note
Supported image formats are GeoTIFF, TIFF, JPEG, and PNG. The URL to an image file on disk or web.
Parameters
URLA URL to an image file on disk or web.
quadrilateralA polygon consisting of four points that represent each corner of the image.
Since
100.8

◆ initWithImage:extent:

- (instancetype) initWithImage: (AGSImage *)  image
extent: (AGSEnvelope *)  extent 

Initialize an AGSImageFrame containing the image 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 TIFF, GeoTIFF, ICO, BMP, GIF, JPEG, and PNG. Animated GIF is not supported.

Parameters
imageAn image to display in the frame.
extentThe geographic extent at which the image is displayed.
Since
100.8

◆ initWithImage:quadrilateral:

- (instancetype) initWithImage: (AGSImage *)  image
quadrilateral: (AGSPolygon *)  quadrilateral 

Initialize an AGSImageFrame using the 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 TIFF, GeoTIFF, ICO, BMP, GIF, JPEG, and PNG. Animated GIF is not supported.

Parameters
imageAn image to display in the frame.
quadrilateralA polygon consisting of four points that represent each corner of the image.
Since
100.8

◆ initWithURL:

- (instancetype) initWithURL: (NSURL *)  URL

Initialize an AGSImageFrame containing the image defined by the provided URL.

Note
Supported image formats are GeoTIFF, TIFF, JPEG, and PNG. The URL to an image file on disk or web.
Parameters
URLA URL to an image file on disk or web.
Since
100.8

◆ initWithURL:extent:

- (instancetype) initWithURL: (NSURL *)  URL
extent: (AGSEnvelope *)  extent 

Initialize an AGSImageFrame containing the image identified by the URL 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.

Note
Supported image formats are GeoTIFF, TIFF, JPEG, and PNG. The URL to an image file on disk or web.
Parameters
URLA URL to an image file on disk or web.
extentThe geographic extent at which the image is displayed.
Since
100.8

◆ initWithURL:quadrilateral:

- (instancetype) initWithURL: (NSURL *)  URL
quadrilateral: (AGSPolygon *)  quadrilateral 

Initialize an AGSImageFrame using the URL 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.

Note
Supported image formats are GeoTIFF, TIFF, JPEG, and PNG. The URL to an image file on disk or web.
Parameters
URLA URL to an image file on disk or web.
quadrilateralA polygon consisting of four points that represent each corner of the image.
Since
100.8

◆ loadDidFinishWithError:

- (void) loadDidFinishWithError: (nullable NSError *)  error

Only subclasses should call this method in doStartLoading: (AGSLoadableBase(ForSubclassEyesOnly)) and doCancelLoading (AGSLoadableBase(ForSubclassEyesOnly)) when done loading or failed to load.

Since
100

Provided by category AGSLoadableBase(ForSubclassEyesOnly).

◆ loadWithCompletion:

- (void) loadWithCompletion: (nullable void(^)(NSError *__nullable error))  completion
requiredinherited

Loads data for the object asynchronously. The completion block is invoked upon completion.

You can call this method any number of times, however only one attempt is made to load the data. If it is already loading, it will just continue to load (i.e. not force a reload). If it has already loaded successfully, the completion block will be invoked right away. If it has already failed to load, the completion block will be invoked right away with error previously encountered. This method supports multiple callers and will call them all back on completion. However, each caller's completion block will be invoked once and only once.

Parameters
completionblock that is invoked when object loads successfully or fails to load. An error is passed to the block if the object fails to load.
Note
The completion block is always invoked on the main thread.
Since
100
See also
- cancelLoad to cancel loading
- retryLoadWithCompletion: to force reload

◆ onLoadStatusChanged

- (void) onLoadStatusChanged

Never call this method directly. The framework calls this method on a background thread when AGSLoadable::loadStatus changes is called. Subclasses can optionally implement this to know when their loading status has changed.

Since
100

Provided by category AGSLoadableBase(ForSubclassEyesOnly).

◆ retryLoadWithCompletion:

- (void) retryLoadWithCompletion: (nullable void(^)(NSError *__nullable error))  completion
requiredinherited

Tries to reload when an object has failed to load. This method should be called judiciously. It should be called when:

  1. you didn't have network connectivity earlier when it failed and you want to retry now that you have connectivity
  2. the server was down earlier when it failed and you want to retry
  3. the request is taking too long and you want to cancel it and retry, in which case you will first call cancelLoad and then this method

If the data hasn't started loading, it will start loading. If it is already loading, it will just continue to load. If it has already loaded successfully, calls back right away. If it has already failed to load, tries again. This method supports multiple callers and will call them all back on completion. However, each caller's completion block will be invoked once and only once.

Parameters
completionblock that is invoked when object loads successfully or fails to load. An error is passed to the block if the object fails to load.
Note
The completion block is always invoked on the main thread.
Since
100

Property Documentation

◆ credential

- (AGSCredential*) credential
readwritenonatomicstronginherited

Security credentials to access the remote resource. Only applicable if the resource is secured.

Since
100

◆ extent

- (AGSEnvelope*) extent
readnonatomicstrong

The extent of the image.

Since
100.8

◆ image

- (AGSImage*) image
readnonatomicstrong

The image contained in the AGSImageFrame.

Since
100.8

◆ loadError

- (NSError*) loadError
readnonatomicstronginherited

The error that was encountered during the most recent load operation. Will be nil if the operation succeeded.

Since
100

◆ loadStatus

- (AGSLoadStatus) loadStatus
readrequirednonatomicassigninherited

Status of the load operation.

Since
100

◆ quadrilateral

- (AGSPolygon*) quadrilateral
readnonatomicstrong

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

Since
100.8

◆ requestConfiguration

- (AGSRequestConfiguration*) requestConfiguration
readwritenonatomicstronginherited

The AGSRequestConfiguration object which defines the behavior and policies to use when accessing the remote resource. The default will be nil. If it is nil the [AGSRequestConfiguration globalConfiguration] will be used.

Since
100

◆ URL

- (NSURL*) URL
readrequirednonatomicstronginherited

The URL of the remote resource.

Since
100