ArcGIS Runtime SDK for iOS: AGSArcGISVectorTiledLayer Class Reference
ArcGIS Runtime SDK for iOS  100.15
List of all members | Instance Methods | Class Methods | Properties
AGSArcGISVectorTiledLayer Class Reference

Description

Displays data from an ArcGIS vector tiled data source.

The ArcGIS Vector Tiled Layer is similar to the ArcGIS Tiled Layer. An ArcGIS Vector Tiled Layer is loaded from ArcGIS online, ArcGIS Enterprise, ArcGIS Server, or a local vector tile layer package file. The tile data format is optimized to reduce network bandwidth and reduce CPU load while rendering the tiles. Vector Tiled Layers are appropriate for basemap, reference and possibly operational layers. They do not contain any feature data, and do not support identify or search operations.

Vector tiles are an alternative to raster tile basemap layers. Instead of pixels (raster), the cartography is delivered using 2D points. The points describe lines, polygons or the locations of labels and marker symbols. The file format of tiles is binary and conforms to the Mapbox Vector Tile Specification. The vector tile file format requires much less space than raster tiles. Also, because the cartography is rendered at runtime, the differences between levels of detail appear more continuous than with raster tiles.

To create a vector tiled layer, the runtime client is given either a URL or a portal item. The URL can point to a vector tile source, a vector tile style sheet, or a local vector tile package file. The portal item will contain a URL to a vector tile stylesheet. The style sheet describes the appearance of the geometry and must be in the Mapbox GL Style format. The style sheet also contains a URL to a vector tile source. The source must be in the Mapbox TileJSON format. The source info includes a URL to a default style sheet.

More than one vector tile style sheet can use the same source. Both the source info and the style sheet are human readable JSON files.

Vector tile packages can also be downloaded from a ArcGIS Online vector tile service. The vector tile package is a single file (.vptk) that contains all of the tile data files, the source information, a style sheet, and the font and symbol marker resources required to display the map.

Vector tile packages are also distributed inside Mobile Map Packages. The MMPK contains JSON that points to the location of the vector tile style sheet or the root of the vector tile package data.

See also
AGSLayer, Sample: ArcGIS vector tiled layer URL
Since
100
Inheritance diagram for AGSArcGISVectorTiledLayer:
AGSLayer <AGSRemoteResource> <AGSAPIKeyResource> AGSLoadableBase <AGSLayerContent> AGSObject <AGSLoadable>

Instance Methods

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

Class Methods

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

Properties

NSString * APIKey
 
NSString * attribution
 
BOOL canChangeVisibility
 
AGSCredential * credential
 
AGSEnvelope * fullExtent
 
BOOL identifyEnabled
 
AGSItem * item
 
AGSItemResourceCache * itemResourceCache
 
NSString * layerDescription
 
NSString * layerID
 
NSError * loadError
 
AGSLoadStatus loadStatus
 
double maxScale
 
double minScale
 
NSString * name
 
float opacity
 
AGSRequestConfiguration * requestConfiguration
 
BOOL showInLegend
 
AGSVectorTileSourceInfo * sourceInfo
 
AGSSpatialReference * spatialReference
 
AGSVectorTileStyle * style
 
NSArray< id< AGSLayerContent > > * subLayerContents
 
void(^ subLayerContentsChangedHandler )(void)
 
NSURL * URL
 
AGSVectorTileCache * vectorTileCache
 
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

Creates an ArcGIS Vector Tiled Layer object from a vector tile cache.

Parameters
vectorTileCacheAn AGSVectorTileCache object.
See also
- initWithURL:
Since
100.2

◆ ArcGISVectorTiledLayerWithVectorTileCache:itemResourceCache:

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

Creates an ArcGIS Vector Tiled Layer object from a vector tile cache and an item resource cache containing a custom style for this vector tile layer.

Parameters
vectorTileCacheAn AGSVectorTileCache object.
itemResourceCacheAn AGSItemResourceCache object.
See also
- initWithURL:
Since
100.2

◆ 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).

◆ 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

◆ 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

◆ APIKey

- (NSString*) APIKey
readwriterequirednonatomiccopyinherited

The API key to access API key enabled services and resources in ArcGIS Online.

An API key is a unique key used to authorize access to specific services and resources in ArcGIS Online. It is also used to monitor access to those services. An API key is created and managed in the ArcGIS developer dashboard and is tied to a specific ArcGIS account.

In addition to setting an API key at a global level for your application using the AGSArcGISRuntimeEnvironment::APIKey property, you can set an AGSAPIKeyResource::APIKey property on any ArcGIS Runtime class that implements AGSAPIKeyResource. When you set an individual AGSAPIKeyResource::APIKey property on an AGSAPIKeyResource it will override the default key at the global level (on the AGSArcGISRuntimeEnvironment::APIKey property, in other words), enabling more granular usage telemetry and management for ArcGIS Online resources used by your app. Classes that expose an API key property by implementing AGSAPIKeyResource include:

◆ 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

The item resource cache of a vector tiled layer. This should contain a custom style to apply to the vector tiles in this layer. This method can only be called if the layer load status is AGSLoadStatusNotLoaded or AGSLoadStatusFailedToLoad otherwise AGSErrorCodeCommonIllegalState exception will occur.

See also
- initWithVectorTileCache:
Since
100.2

◆ 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 occurred, 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

The underlying vector tile cache or nil if no vector tile cache is present. If this layer was created from a vector tile cache or a local file URL, then this property will return the vector tile cache. If this layer was created from a remote URL, this property will return nil.

See also
- initWithVectorTileCache:
Since
100.2

◆ visible

- (BOOL) visible
readwritenonatomicassigninherited

Denotes whether the layer is visible or not. The visibility changes can be monitored using Key-Value Observing (KVO).

Since
100