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
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
-
image | An image to display in the frame. |
extent | The geographic extent at which the image is displayed. |
- Since
- 100.8
+ (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
-
image | An image to display in the frame. |
quadrilateral | A polygon consisting of four points that represent each corner of the image. |
- Since
- 100.8
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
-
URL | A URL to an image file on disk or web. |
quadrilateral | A polygon consisting of four points that represent each corner of the image. |
- Since
- 100.8
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
-
image | An image to display in the frame. |
extent | The geographic extent at which the image is displayed. |
- Since
- 100.8
- (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
-
image | An image to display in the frame. |
quadrilateral | A polygon consisting of four points that represent each corner of the image. |
- Since
- 100.8
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
-
URL | A URL to an image file on disk or web. |
quadrilateral | A polygon consisting of four points that represent each corner of the image. |
- Since
- 100.8
- (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
-
completion | block 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
- (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:
- you didn't have network connectivity earlier when it failed and you want to retry now that you have connectivity
- the server was down earlier when it failed and you want to retry
- 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
-
completion | block 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