referenceBasemapDirectory property

The path to a directory on the device where the local basemap file is located.

Set this property to use a basemap which is already on the device (rather than downloading it). The directory should only be set when DownloadPreplannedOfflineMapParameters.referenceBasemapFilename is defined.

This property supports any directory specified as either:

• An absolute path
• A path relative to the parent directory of the generated mobile map package (see downloadPath for OfflineMapTask.downloadPreplannedOfflineMapWithParameters)

If the directory does not exist, or does not contain the specified basemap, the DownloadPreplannedOfflineMapJob will fail.

Note that, the mobile map package will store either a relative or absolute path to the reference basemap file so that it can be opened in the future.

A relative path typically begins with "." to denote the parent directory of the resulting mobile map package or ".." to move up one directory. The parent directory of the mobile map package will be set when calling OfflineMapTask.generateOfflineMap.

For example, to download a mobile map package to "[my root path]/my_offline_maps/my_mobile_map_package", which uses a reference basemap in "[my root path]/other_maps/my_basemap.tpk", you would set the relative path as follows:

• DownloadPreplannedOfflineMapJob.downloadDirectoryUri to "[my root path]/my_offline_maps/my_mobile_map_package"
• DownloadPreplannedOfflineMapParameters.referenceBasemapDirectory to "../other_maps"
• DownloadPreplannedOfflineMapParameters.referenceBasemapFilename to "my_basemap.tpk"

Note that, this property is ignored if DownloadPreplannedOfflineMapParameters.includeBasemap is FALSE.