ArcGIS Runtime SDK for iOS: AGSExportVectorTilesParameters Class Reference
ArcGIS Runtime SDK for iOS  100.14
AGSExportVectorTilesParameters Class Reference

Description

Parameters for the operations on AGSExportVectorTilesTask.

Instances of this class represent input parameters of operations on AGSExportVectorTilesTask to export a vector tile cache.

Since
100.2
See also
AGSExportVectorTilesTask
Inheritance diagram for AGSExportVectorTilesParameters:
AGSObject

Class Methods

(instancetype) + exportVectorTilesParameters
 

Properties

AGSGeometryareaOfInterest
 
AGSEsriVectorTilesDownloadOption esriVectorTilesDownloadOption
 
NSInteger maxLevel
 

Method Documentation

◆ exportVectorTilesParameters

+ (instancetype) exportVectorTilesParameters

Property Documentation

◆ areaOfInterest

- (AGSGeometry*) areaOfInterest
readwritenonatomicstrong

An AGSPolygon or AGSEnvelope geometry that defines the geographic area for which tiles are needed. Where an AGSPolygon is supplied, tiles will be filtered according to the polygon geometry, which can help reduce the size of the resulting tile package. Note that the filtered set of tiles may vary, depending on the underlying service. AGSPoint and AGSPolyline geometries are not supported. If this is not specified, the full extent of the service will be used.

Since
100.2

◆ esriVectorTilesDownloadOption

- (AGSEsriVectorTilesDownloadOption) esriVectorTilesDownloadOption
readwritenonatomicassign

Describes how Esri vector tiled basemap layers will be downloaded.

This property lets you choose how to download Esri vector tiled basemap layers. This property only applies when taking an Esri vector tile basemap service offline.

When taking an Esri vector tiled basemap service offline (e.g. to create an AGSVectorTileCache on your device), you can choose from different versions of the service depending on your use case.

Primary considerations are the download speed and the size of the resulting .vtpk file. Among other things, file size is influenced by the number of fonts downloaded from the service. Esri vector tiled basemap layers use fonts as part of their style resources - see the vector-tile-style documentation. When you take a vector tiled layer offline, these fonts are downloaded as part of the AGSVectorTileCache.

Esri services also offer an alternative version with a reduced font package size. This omits the large Arial Unicode font, which greatly reduces the download size. You can view the set of reduced font vector tile services here.

  • If you choose AGSEsriVectorTilesDownloadOptionUseOriginalService, the full set of resources used by the original online service, including all fonts, will be downloaded. This increases the download size of the AGSVectorTileCache but ensures that the offline layer will display the same as the original online data.
  • If you choose AGSEsriVectorTilesDownloadOptionUseReducedFontsService, the smaller set of fonts used by the alternative, for export, version of the service will be downloaded. This reduces the download size of the AGSVectorTileCache but is not suitable for all locales or when your offline vector tiled layer includes certain language characters. For example, this option will not display Chinese, Japanese, Thai, Korean or Georgian characters. If an alternative, for export version of the service cannot be found, the original service will be used.

The default value is AGSEsriVectorTilesDownloadOptionUseOriginalService.

Since
100.10

◆ maxLevel

- (NSInteger) maxLevel
readwritenonatomicassign

The maximum level of detail to export vector tiles. The vector tile export will always take levels 0 and all in between levels up to and including the value of max level. The larger the level the more tiles will be included. The default value is -1, which must be set to a valid value >= 0.

Since
100.2