ArcGIS Runtime SDK for iOS: AGSImageTiledLayer(CustomImageTiledLayer) Category Reference
ArcGIS Runtime SDK for iOS  100.12
AGSImageTiledLayer(CustomImageTiledLayer) Category Reference

Description

Category for implementing custom tiled layers.

This category organizes the methods that are relevant to creating a custom tiled layer. The custom layer can work with local tiled data or remote tiled services depending upon how it is implemented.

Since
100
See also
AGSServiceImageTiledLayer(CustomTiledLayer) for creating custom tiled layers based on remote tiles.

Instance Methods

(instancetype) - initWithTileInfo:fullExtent:
 
(void) - respondWithNoDataTileForTileKey:
 
(void) - respondWithTileKey:data:error:
 

Class Methods

(instancetype) + imageTiledLayerWithTileInfo:fullExtent:
 

Properties

void(^ cancelTileRequestHandler )(AGSTileKey *tileKey)
 
void(^ tileRequestHandler )(AGSTileKey *tileKey)
 

Method Documentation

◆ imageTiledLayerWithTileInfo:fullExtent:

+ (instancetype) imageTiledLayerWithTileInfo: (AGSTileInfo *)  tileInfo
fullExtent: (AGSEnvelope *)  fullExtent 

Creates a custom tiled layer with the provided details.

Parameters
tileInfospecifying the tiling scheme used by the layer.
fullExtentof the layer.
Returns
A new tiled layer.
Since
100

Extends class AGSImageTiledLayer.

◆ initWithTileInfo:fullExtent:

- (instancetype) initWithTileInfo: (AGSTileInfo *)  tileInfo
fullExtent: (AGSEnvelope *)  fullExtent 

Creates a custom tiled layer with the provided details.

Parameters
tileInfospecifying the tiling scheme used by the layer.
fullExtentof the layer.
Since
100

Extends class AGSImageTiledLayer.

◆ respondWithNoDataTileForTileKey:

- (void) respondWithNoDataTileForTileKey: (AGSTileKey *)  tileKey

Needs to be invoked when the custom layer does not find a tile.

Parameters
tileKeyspecifying the tile that was requested.
Since
100

Extends class AGSImageTiledLayer.

◆ respondWithTileKey:data:error:

- (void) respondWithTileKey: (AGSTileKey *)  tileKey
data: (nullable NSData *)  data
error: (nullable NSError *)  error 

Needs to be invoked when the custom layer has successfully retrieved the tile requested in #tileRequestHandler, or if an error is encountered while retrieving the tile.

Parameters
tileKeyspecifying the tile that was requested.
datafor the retrieved tile if the operation was successful.
errorencountered while retrieving the tile if the operation failed.
Since
100

Extends class AGSImageTiledLayer.

Property Documentation

◆ cancelTileRequestHandler

- (void(^ cancelTileRequestHandler) (AGSTileKey *tileKey))
readwritenonatomicstrong

The handler that will be invoked when a requested tile is no longer needed. This should be assigned a block that contains the business logic specific to the custom layer for canceling the requested tile.

Since
100

Extends class AGSImageTiledLayer.

◆ tileRequestHandler

- (void(^ tileRequestHandler) (AGSTileKey *tileKey))
readwritenonatomicstrong

The handler that will be invoked when a new tile is needed. This should be assigned a block that contains the business logic specific to the custom layer for fetching the requested tile. The block should eventually invoke #respondWithTileKey:data:error: if a tile is retrieved or an error is encountered. Alternatively, it can invoke #respondWithNoDataTileForTileKey if no tile is available.

Since
100

Extends class AGSImageTiledLayer.