ArcGIS Runtime SDK for iOS: AGSArcGISVectorTiledLayer Class Reference
ArcGIS Runtime SDK for iOS  100.7
AGSArcGISVectorTiledLayer Class Reference

Description

A layer that can display maps using vector tiles.

An instance of this class allows you to display maps from an ArcGIS Vector Tile source, a Vector Tile Style Sheet, or a local Vector Tile Package(.VTPK file). It uses a cache of pre-generated vector tiles to assemble a map instead of dynamically generating map images.

Since
100
Inheritance diagram for AGSArcGISVectorTiledLayer:
AGSLayer <AGSRemoteResource> AGSLoadableBase <AGSLayerContent> AGSObject <AGSLoadable>

Instance Methods

(void) - cancelLoad
 
(id< AGSCancelable >) - fetchLegendInfosWithCompletion:
 
(instancetype) - initWithItem:
 
(instancetype) - initWithName:
 
(instancetype) - initWithURL:
 
(instancetype) - initWithVectorTileCache:
 
(instancetype) - initWithVectorTileCache:itemResourceCache:
 
(BOOL) - isEqualToLayer:
 
(BOOL) - isVisibleAtScale:
 
(void) - loadWithCompletion:
 
(void) - retryLoadWithCompletion:
 

Class Methods

(instancetype) + ArcGISVectorTiledLayerWithItem:
 
(instancetype) + ArcGISVectorTiledLayerWithName:
 
(instancetype) + ArcGISVectorTiledLayerWithURL:
 
(instancetype) + ArcGISVectorTiledLayerWithVectorTileCache:
 
(instancetype) + ArcGISVectorTiledLayerWithVectorTileCache:itemResourceCache:
 

Properties

NSString * attribution
 
BOOL canChangeVisibility
 
AGSCredentialcredential
 
AGSEnvelopefullExtent
 
BOOL identifyEnabled
 
AGSItemitem
 
AGSItemResourceCacheitemResourceCache
 
NSString * layerDescription
 
NSString * layerID
 
NSError * loadError
 
AGSLoadStatus loadStatus
 
double maxScale
 
double minScale
 
NSString * name
 
float opacity
 
AGSRequestConfigurationrequestConfiguration
 
BOOL showInLegend
 
AGSVectorTileSourceInfosourceInfo
 
AGSSpatialReferencespatialReference
 
AGSVectorTileStylestyle
 
NSArray< id< AGSLayerContent > > * subLayerContents
 
void(^ subLayerContentsChangedHandler )(void)
 
NSURL * URL
 
AGSVectorTileCachevectorTileCache
 
BOOL visible
 

Method Documentation

§ ArcGISVectorTiledLayerWithItem:()

+ (instancetype) ArcGISVectorTiledLayerWithItem: (AGSItem *)  item

Initialize this layer with an item on ArcGIS Online or ArcGIS Portal representing an ArcGIS Vector Tile layer.

Parameters
itemrepresenting an ArcGIS Vector Tile layer.
Returns
A new vector tiled layer
Since
100

§ ArcGISVectorTiledLayerWithName:()

+ (instancetype) ArcGISVectorTiledLayerWithName: (NSString *)  name

Initialize this layer with a name of a Vector Tile Package (.VTPK file), excluding the ".vtpk" extension, within the application bundle or shared documents directory.

Parameters
nameof the Vector Tile Package (excluding the .vtpk extension)
Returns
A new vector tiled layer
Since
100

§ ArcGISVectorTiledLayerWithURL:()

+ (instancetype) ArcGISVectorTiledLayerWithURL: (NSURL *)  url

Initialize this layer with a URL to an ArcGIS Vector Tile source/stylesheet or .vtpk file on disk. The following URL formats are supported -

Parameters
urlto an ArcGIS Vector Tile source/stylesheet or .vtpk file on disk.
Returns
A new vector tiled layer
Since
100

§ ArcGISVectorTiledLayerWithVectorTileCache:()

+ (instancetype) ArcGISVectorTiledLayerWithVectorTileCache: (AGSVectorTileCache *)  vectorTileCache

§ ArcGISVectorTiledLayerWithVectorTileCache:itemResourceCache:()

+ (instancetype) ArcGISVectorTiledLayerWithVectorTileCache: (AGSVectorTileCache *)  vectorTileCache
itemResourceCache: (nullable AGSItemResourceCache *)  itemResourceCache 

§ 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

§ fetchLegendInfosWithCompletion:()

- (id<AGSCancelable>) fetchLegendInfosWithCompletion: (void(^)(NSArray< AGSLegendInfo * > *__nullable legendInfos, NSError *__nullable error))  completion

Fetches the array of legend infos (AGSLegendInfo) for this layer.

Since
100

§ initWithItem:()

- (instancetype) initWithItem: (AGSItem *)  item

Initialize this layer with an item on ArcGIS Online or ArcGIS Portal representing an ArcGIS Vector Tile layer.

Parameters
itemrepresenting an ArcGIS Vector Tile layer.
Returns
A new vector tiled layer
Since
100

§ initWithName:()

- (instancetype) initWithName: (NSString *)  name

Initialize this layer with a name of a Vector Tile Package (.VTPK file), excluding the ".vtpk" extension, within the application bundle or shared documents directory.

Parameters
nameof the Vector Tile Package (excluding the .vtpk extension)
Returns
A new vector tiled layer
Since
100

§ initWithURL:()

- (instancetype) initWithURL: (NSURL *)  url

Initialize this layer with a URL to an ArcGIS Vector Tile source/stylesheet or .vtpk file on disk. The following URL formats are supported -

Parameters
urlto an ArcGIS Vector Tile source/stylesheet or .vtpk file on disk.
Returns
A new vector tiled layer
Since
100

§ initWithVectorTileCache:()

- (instancetype) initWithVectorTileCache: (AGSVectorTileCache *)  vectorTileCache

Initialize this layer with a tile cache representing a local Vector Tile Package (.vtpk file)

Parameters
vectorTileCacherepresenting a local Vector Tile Package (.vtpk file)
Returns
A new tiled layer object
Since
100.2

§ initWithVectorTileCache:itemResourceCache:()

- (instancetype) initWithVectorTileCache: (AGSVectorTileCache *)  vectorTileCache
itemResourceCache: (nullable AGSItemResourceCache *)  itemResourceCache 

Initialize this layer with a tile cache representing a local Vector Tile Package (.vtpk file) and resource cache containing custom style resources

Parameters
vectorTileCacherepresenting a local Vector Tile Package (.vtpk file)
itemResourceCachecontaining custom style resources
Returns
A new tiled layer object
Since
100.2

§ isEqualToLayer:()

- (BOOL) isEqualToLayer: (AGSLayer *)  other

§ isVisibleAtScale:()

- (BOOL) isVisibleAtScale: (double)  scale

Check whether this layer is visible at a given scale.

Since
100

§ 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

§ 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

§ attribution

- (NSString*) attribution
readnonatomiccopyinherited

Attribution information of the layer

Since
100

§ canChangeVisibility

- (BOOL) canChangeVisibility
readrequirednonatomicassigninherited

Denotes whether the layer can change visibility or not.

Since
100

§ credential

- (AGSCredential*) credential
readwritenonatomicstronginherited

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

Since
100

§ fullExtent

- (AGSEnvelope*) fullExtent
readnonatomicstronginherited

Full extent of the layer.

Since
100

§ identifyEnabled

- (BOOL) identifyEnabled
readnonatomicassigninherited

Specifies whether the layer supports identify.

Since
100

§ item

- (AGSItem*) item
readnonatomicstronginherited

The item the layer has been created from.

Since
100

§ itemResourceCache

- (AGSItemResourceCache*) itemResourceCache
readnonatomicstrong

§ layerDescription

- (NSString*) layerDescription
readwritenonatomiccopyinherited

The layer's description

Since
100

§ layerID

- (NSString*) layerID
readwritenonatomiccopyinherited

The layer's ID specified in the web map item of ArcGIS Online or an on-premises portal.

Since
100

§ 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

§ maxScale

- (double) maxScale
readwritenonatomicassigninherited

The maximum scale at which this layer is visible. If the map or scene is zoomed in beyond this scale, the layer will not be visible. A value of 0 means there is no maximum scale threshold and the layer will be visible at the smallest scale available for the map or scene.

Since
100

§ minScale

- (double) minScale
readwritenonatomicassigninherited

The minimum scale at which this layer is visible. If the map or scene is zoomed out beyond this scale, the layer will not be visible. A value of 0 means there is no minimum scale threshold and the layer will be visible at the largest scale available for the map or scene.

Since
100

§ name

- (NSString*) name
readwritenonatomiccopyinherited

The name of the layer

Since
100

§ opacity

- (float) opacity
readwritenonatomicassigninherited

The opacity of this layer as a value between 0 (fully transparent) and 1 (fully opaque). Default value is 1.

Since
100

§ 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

§ showInLegend

- (BOOL) showInLegend
readwritenonatomicassigninherited

Indicates whether to show legend information.

Since
100

§ sourceInfo

- (AGSVectorTileSourceInfo*) sourceInfo
readnonatomicstrong

Metadata about the source of vector tiles

Since
100

§ spatialReference

- (AGSSpatialReference*) spatialReference
readnonatomicstronginherited

The spatial reference of the layer.

Since
100

§ style

- (AGSVectorTileStyle*) style
readnonatomicstrong

Style used to display the vector tiles

Since
100

§ subLayerContents

- (NSArray<id<AGSLayerContent> >*) subLayerContents
readnonatomiccopyinherited

This layer's sub-layers.

Since
100

§ subLayerContentsChangedHandler

- (void(^ subLayerContentsChangedHandler) (void))
readwritenonatomiccopyinherited

Block that is invoked when the sub layer contents changes.

Note
The block will be invoked on the same thread on which the event occured, which could be any arbitrary thread. You need to dispatch any UI related work to the main thread.
Since
100

§ URL

- (NSURL*) URL
readrequirednonatomicstronginherited

The URL of the remote resource.

Since
100

§ vectorTileCache

- (AGSVectorTileCache*) vectorTileCache
readnonatomicstrong

§ visible

- (BOOL) visible
readwritenonatomicassigninherited

Denotes whether the layer is visible or not.

Since
100