A key comprising the service URL and type of online service. The key is used to lookup values in a dictionary exposed by a GenerateOfflineMapParameterOverrides. More...
| Import Statement: | import Esri.ArcGISRuntime 100.15 |
| Since: | Esri.ArcGISRuntime 100.4 |
| Inherits: |
Properties
- empty : bool
- initLayer : Layer
- initTable : ServiceFeatureTable
- initUtilityNetwork : ServiceFeatureTable
- keyError : Error
- serviceUrl : url
- type : Enums.OfflineMapParametersType
Signals
Detailed Description
Generate offline map parameter overrides consist of instances of data type specific parameters: GenerateGeodatabaseParameters, ExportTileCacheParameters and ExportVectorTilesParameters. Each instance is associated with the service URL that the parameters will be sent to when taking the given data offline.
The data type specific parameters can be retrieved from their respective dictionaries on the GenerateOfflineMapParameterOverrides with an instance of an OfflineMapParametersKey.
Use the key with the dictionary returned by one of these properties:
- GenerateOfflineMapParameterOverrides::generateGeodatabaseParameters
- GenerateOfflineMapParameterOverrides::exportVectorTilesParameters
- GenerateOfflineMapParameterOverrides::exportTileCacheParameters
The particular dictionary property to call will be determined by the type property. Note that a given parameters key/value pair may be shared by multiple layers in the map: for example a single GenerateGeodatabaseParameters could represent the online settings for multiple feature layers and tables which all access the same underlying feature service.
A valid key can be initialized by setting either the initLayer or initTable properties. These properties should only be set once per key object.
Note: If an invalid layer or table is used to obtain the key (for example one which cannot be taken offline) the key will be empty - see empty and the keyError will provide details as to what went wrong.
Property Documentation
Returns whether this is a valid key object (read-only).
If true the key does not correspond to a valid set of parameters for taking a layer or table offline.
initLayer : Layer |
The layer used to initialize this key.
This property should only be set once at initialization time. A key be initialized using this property or initTable or initUtilityNetwork property - but not all three.
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 unloaded 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 type property:
| Parameter Type | Dictionary |
|---|---|
generateGeodatabase | GenerateOfflineMapParameterOverrides::generateGeodatabaseParameters |
exportVectorTiles | GenerateOfflineMapParameterOverrides::exportVectorTilesParameters |
exportTileCache | GenerateOfflineMapParameterOverrides::exportTileCacheParameters |
If the layer type is not supported, the constructed key will return true for the empty property and the keyError property will provide details of the problem.
initTable : ServiceFeatureTable |
The table used to initialize this key.
This property should only be set once at initialization time. A key be initialized using this property or initLayer or initUtilityNetwork property - but not all three.
The returned key can be used to retrieve a data type specific parameters object from the dictionary returned by GenerateOfflineMapParameterOverrides::generateGeodatabaseParameters.
If the table type is not supported, the constructed key will return true for the empty property and the keyError property will provide details of the problem.
initUtilityNetwork : ServiceFeatureTable |
The utility network used to initialize this key.
This property should only be set once at initialization time. A key is initialized using this property or initLayer or initTable property - but not all three.
A UtilityNetwork with a URL that points to a feature service, supports offline use when it returns true for SyncCapabilities::supportsUtilityNetworkSystem.
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 nullptr handle.
This property was introduced in Esri::ArcGISRuntime 100.11.
keyError : Error |
Returns an error describing any problems when creating this key object (read-only).
If there were no issues, the error will be empty.
Returns the service URL of this key (read-only).
The service URL is the URL associated with a data specific parameter object in one of the dictionaries of parameter overrides owned by a GenerateOfflineMapParameterOverrides instance.
Indicates the type of parameters object used to take layers offline (read-only).
The type of this key indicates which parameters dictionary this key belongs to:
| Parameter Type | Dictionary |
|---|---|
generateGeodatabase | GenerateOfflineMapParameterOverrides::generateGeodatabaseParameters |
exportVectorTiles | GenerateOfflineMapParameterOverrides::exportVectorTilesParameters |
exportTileCache | GenerateOfflineMapParameterOverrides::exportTileCacheParameters |
See also Enums.OfflineMapParametersType.
Signal Documentation
Emitted when the initLayer property changes.
Note: The corresponding handler is onInitLayerChanged.
Emitted when the initTable property changes.
Note: The corresponding handler is onInitTableChanged.
Emitted when the initUtilityNetwork property changes.
Note: The corresponding handler is onInitUtilityNetworkChanged.
This signal was introduced in Esri::ArcGISRuntime 100.11.
Emitted when the keyError property changes.
Note: The corresponding handler is onKeyErrorChanged.