OfflineMapParametersKey

constructor(layer: Layer)

Create an offline map parameters key for the given layer. Layers that are supported for offline use are:

  • FeatureLayer with a table which is a ServiceFeatureTable

  • ArcGISTiledLayer with an online URL

  • ArcGISVectorTiledLayer with an online URL

To construct a key the layer must be loaded, or if not loaded have a service URL available in the layer's properties. The returned key can be used to retrieve a data type specific parameters object from one of the three parameter overrides dictionaries. The dictionary that the key is valid for is indicated by its OfflineMapParametersKey.type property: | Parameter Type | Dictionary | |-------------------------------------------------|---------------------------------------------------------------------------| | OfflineMapParametersType.GenerateGeodatabase | GenerateOfflineMapParameterOverrides.generateGeodatabaseParameters | | OfflineMapParametersType.ExportVectorTiles | GenerateOfflineMapParameterOverrides.exportVectorTilesParameters | | OfflineMapParametersType.ExportTileCache | GenerateOfflineMapParameterOverrides.exportTileCacheParameters | If the layer type is not supported an error is returned with a null handle

Since

200.1.0


constructor(table: ServiceFeatureTable)

Create an offline map parameters key for the given table. The returned key can be used to retrieve a data type specific parameter object from the dictionary returned by GenerateOfflineMapParameterOverrides.generateGeodatabaseParameters.

Since

200.1.0


constructor(utilityNetwork: UtilityNetwork)

Create an offline map parameters key for the specified UtilityNetwork. An UtilityNetwork with URI that points to a feature service which returns true for SyncCapabilities.supportsUtilityNetworkSystem is supported for offline use.

The returned key can be used to retrieve a data type specific parameter object from the dictionary returned by GenerateOfflineMapParameterOverrides.generateGeodatabaseParameters.

If the UtilityNetwork does not support taking Utility Network data offline, an error is returned with a null handle.

Since

200.1.0