DownloadPreplannedOfflineMapParameters class final
The parameters that specify how an offline map area is downloaded from an online map using a DownloadPreplannedOfflineMapJob.
The online map must be a web map either on ArcGIS Online or ArcGIS Enterprise. Note that the API refers to an offline map area as a PreplannedMapArea.
To generate default parameters that match the online map's offline settings,
call OfflineMapTask.createDefaultDownloadPreplannedOfflineMapParameters.
You can then modify the parameters with any desired changes. Alternatively,
you can generate an empty set of parameters using
DownloadPreplannedOfflineMapParameters.new and set the parameters
individually. To create a DownloadPreplannedOfflineMapJob, pass the
parameters to the
OfflineMapTask.downloadPreplannedOfflineMapWithParameters method and
provide a path to a folder where the map content is stored on the device.
- Implemented types
Constructors
- DownloadPreplannedOfflineMapParameters({PreplannedMapArea? preplannedMapArea})
-
Creates a download preplanned offline map parameters object with the given
offline map area.
factory
Properties
- continueOnErrors ↔ bool
-
Indicates whether or not the download preplanned offline map job should
continue running in the event of failure to take a layer offline.
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
- preplannedMapArea ↔ PreplannedMapArea?
-
The offline map area that will be downloaded for offline use.
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 which can be used rather
than downloading an online basemap.
getter/setter pair
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
- updateMode ↔ PreplannedUpdateMode
-
Describes how the offline map will obtain feature updates from the online
service.
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