createDefaultGenerateOfflineMapParameters

suspend fun createDefaultGenerateOfflineMapParameters(areaOfInterest: Geometry, minScale: Double = 0.0, maxScale: Double = 0.0): Result<GenerateOfflineMapParameters>

Returns a Result of GenerateOfflineMapParameters created from the specified area of interest, min scale and max scale.

Return

A Result of GenerateOfflineMapParameters. The supported geometry types for the area of interest are com.arcgismaps.geometry.Envelope and com.arcgismaps.geometry.Polygon. The area of interest must have a spatial reference. Where a com.arcgismaps.geometry.Polygon is supplied, features and tiles will be filtered according to the polygon geometry, which can help reduce the size of the resulting offline map. Note that the filtered set of tiles may vary, depending on the underlying service. The returned GenerateOfflineMapParameters has its itemInfo property initialized from the offline map task's portal item, if that is set. The ItemInfo's thumbnail will be copied from the portal item's thumbnail. The default parameters will be populated using the values in the online map's com.arcgismaps.mapping.OfflineSettings (if present). If the map being taken offline contains an com.arcgismaps.utilitynetworks.UtilityNetwork and is in an ArcGIS Enterprise 11.1 or later service, the Offline Capability selected for the com.arcgismaps.utilitynetworks.UtilityNetwork such as "Trace utility network features" will automatically be reflected in the default parameters created by this method. If the map being taken offline contains an com.arcgismaps.utilitynetworks.UtilityNetwork and is in an earlier version of ArcGIS Enterprise, the com.arcgismaps.tasks.geodatabase.GenerateGeodatabaseParameters.utilityNetworkSyncMode property is set to com.arcgismaps.tasks.geodatabase.UtilityNetworkSyncMode.SyncSystemTables for the com.arcgismaps.data.Geodatabase containing the com.arcgismaps.utilitynetworks.UtilityNetwork. Use OfflineMapTask.createGenerateOfflineMapParameterOverrides to change the com.arcgismaps.tasks.geodatabase.UtilityNetworkSyncMode if desired.

Since

200.1.0

Parameters

areaOfInterest

The region of the online map that is to be taken offline. Sets the property GenerateOfflineMapParameters.areaOfInterest.

minScale

The minimum scale for offline tile caches. Use 0 for all far out levels. See the property GenerateOfflineMapParameters.minScale.

maxScale

The maximum scale for offline tile caches. Use 0 for closer in detailed levels. Sets the property GenerateOfflineMapParameters.maxScale.