GenerateOfflineMapParameters class final
The parameters that specify how an offline map is generated and downloaded from an online map using a GenerateOfflineMapJob.
The online map must be a web map either 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 OfflineMapTask.createDefaultGenerateOfflineMapParameters). You can then modify the parameters with any desired changes. Alternatively, you can generate an empty set of parameters using GenerateOfflineMapParameters.new and set the parameters individually. To create a GenerateOfflineMapJob, pass the parameters to the OfflineMapTask.generateOfflineMap method and provide a path to a folder where the map content is stored on the device.
- Implemented types
Constructors
- GenerateOfflineMapParameters()
-
Creates a generate offline map parameters object.
factory
- GenerateOfflineMapParameters.withAreaOfInterest(Geometry areaOfInterest, {double minScale = 0.0, double maxScale = 0.0})
-
Creates a generate offline map parameters object.
factory
Properties
- areaOfInterest ↔ Geometry?
-
The area of interest for the offline map. This is used for the extent of
offline tile caches, geodatabases and the offline map's
GeoModel.initialViewpoint property.
getter/setter pair
- attachmentSyncDirection ↔ AttachmentSyncDirection
-
Specifies the direction for attachments to be synchronized when syncing
offline feature layers. This method should be used in conjunction with
GenerateOfflineMapParameters.returnLayerAttachmentOption to determine
which layers should be taken offline with attachments included.
getter/setter pair
- continueOnErrors ↔ bool
-
Indicates whether or not the generate offline map job should continue
running in the event of failure to take a layer offline.
getter/setter pair
- destinationTableRowFilter ↔ DestinationTableRowFilter
-
Indicates whether tables will contain all rows or can be filtered to a
smaller set of related rows.
getter/setter pair
- esriVectorTilesDownloadOption ↔ EsriVectorTilesDownloadOption
-
Describes how Esri vector tiled basemap layers will be downloaded.
getter/setter pair
- hashCode → int
-
The hash code for this object.
no setterinherited
- includeBasemap ↔ bool
-
Indicates whether or not a basemap will be included in the offline map.
getter/setter pair
- isDefinitionExpressionFilterEnabled ↔ bool
-
Indicates if feature layer definition expressions are used when taking
feature layers and tables offline.
getter/setter pair
- itemInfo ↔ OfflineMapItemInfo?
-
Offline map item info used for the local item properties in the offline
map.
getter/setter pair
- maxScale ↔ double
-
The maximum scale for how far in to extract tiles from tiled services. The
0 default means extract the levels down to the most detailed.
getter/setter pair
- minScale ↔ double
-
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.
getter/setter pair
- onlineOnlyServicesOption ↔ OnlineOnlyServicesOption
-
Describes how data that requires an online service will be handled when
taking a map offline.
getter/setter pair
- referenceBasemapDirectory ↔ Uri?
-
The path to a directory on the device where the local basemap file is
located.
getter/setter pair
- referenceBasemapFilename ↔ String
-
The name of a local basemap file on the device that can be used rather
than downloading an online basemap.
getter/setter pair
- returnLayerAttachmentOption ↔ ReturnLayerAttachmentOption
-
Which feature layers will include attachments when being taken offline.
Attachments can be included with none of the layers, all of the layers,
read only layers or editable layers. This method should be used in
conjunction with GenerateOfflineMapParameters.attachmentSyncDirection to
control how the attachments are synced.
getter/setter pair
- returnSchemaOnlyForEditableLayers ↔ bool
-
Whether or not feature layers taken offline should be schema only and
contain no data.
getter/setter pair
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
- updateMode ↔ GenerateOfflineMapUpdateMode
-
Describes how the offline map will support synchronization with online
services.
getter/setter pair
Methods
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
toString(
) → String -
A string representation of this object.
inherited
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited