Show / Hide Table of Contents

Class GenerateOfflineMapParameters

The parameters that specify how an offline map is generated and downloaded from an online map using a GenerateOfflineMapJob.

Inheritance
System.Object
GenerateOfflineMapParameters
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.GetHashCode()
System.Object.GetType()
System.Object.MemberwiseClone()
System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.ToString()
Namespace: Esri.ArcGISRuntime.Tasks.Offline
Assembly: Esri.ArcGISRuntime.dll
Syntax
public sealed class GenerateOfflineMapParameters
Remarks

The online map must be a web map hosted on ArcGIS Online or ArcGIS Enterprise.

To generate parameters with appropriate default values which take into account the online map and the data it contains, call CreateDefaultGenerateOfflineMapParametersAsync(Geometry)). You can then modify the parameters with any desired changes. Alternatively, you can generate an empty set of parameters using GenerateOfflineMapParameters() and set the parameters individually. To create a GenerateOfflineMapJob, pass the parameters to the GenerateOfflineMap(GenerateOfflineMapParameters, String) method and provide a path to a folder where the map content will be stored on the device.

Constructors

Name Description
GenerateOfflineMapParameters()

Initializes a new instance of the GenerateOfflineMapParameters class.

GenerateOfflineMapParameters(Geometry, Double, Double)

Initializes a new instance of the GenerateOfflineMapParameters class.

Properties

Name Description
AreaOfInterest

Gets or sets the area of interest for the offline map.

AttachmentSyncDirection

Gets or sets a value that specifies the direction for attachments to be synchronized when syncing offline feature layers. This method should be used in conjunction with ReturnLayerAttachmentOption to determine which layers should be taken offline with attachments included.

ContinueOnErrors

Gets or sets a value indicating whether or not the GenerateOfflineMapJob should continue running in the event of failure to take a layer offline.

DestinationTableRowFilter

Gets or sets a value indicating whether tables will contain all rows or can be filtered to a smaller set of related rows.

EsriVectorTilesDownloadOption

Gets or sets a value that describes how Esri vector tiled basemap layers will be downloaded.

IncludeBasemap

Gets or sets a value indicating whether or not a basemap will be included in the offline map.

IsDefinitionExpressionFilterEnabled

Gets or sets a value indicating whether feature layer definition expressions are used when taking feature layers and tables offline.

ItemInfo

Gets or sets offline map item info used for the local item properties in the offline map.

MaxScale

Gets or sets the maximum scale for how far in to extract tiles from tiled services. The default value of 0 means extract the levels down to the most detailed.

MinScale

Gets or sets the minimum scale for how far out data will be in tile caches. The 0 default means extract all the available detailed levels to global scales.

OnlineOnlyServicesOption

Gets or sets a value describing how data that requires an online service will be handled when taking a map offline.

ReferenceBasemapDirectory

Gets or sets the path to a directory on the device where the local basemap file is located.

ReferenceBasemapFilename

Gets or sets the name of a local basemap file on the device that can be used rather than downloading an online basemap.

ReturnLayerAttachmentOption

Gets or sets a value indicating which type of feature layer will be included when taking feature layers offline. This will include attachments with none of the layers, all of the layers, read only layers or editable layers.

ReturnSchemaOnlyForEditableLayers

Gets or sets a value indicating whether or not feature layers taken offline should be schema only and contain no data.

UpdateMode

Gets or sets a value indicating how the offline map will support synchronization with online services.

Applies to

TargetVersions
.NET Standard 2.0100.3 - 200.7
.NET100.13 - 200.7
.NET Windows100.13 - 200.7
.NET Android200.0 - 200.7
.NET iOS200.0 - 200.7
.NET Framework100.1 - 200.7
Xamarin.Android100.1 - 100.15
Xamarin.iOS100.1 - 100.15
UWP100.1 - 200.7
In This Article
Back to top Copyright © 2022 Esri.