referenceBasemapFilename property

String referenceBasemapFilename

The name of a local basemap file on the device which can be used rather than downloading an online basemap.

The local basemap filename must end with .tpk, .tpkx or .vtpk since these are the supported file formats. This property can be read directly from settings applied by the author of the online web map (see OfflineSettings) or set by user code to a file known to be on the device. This property will be populated from online settings when created with OfflineMapTask.createDefaultDownloadPreplannedOfflineMapParameters.

If you wish to use the specified local basemap rather than downloading, you must also set DownloadPreplannedOfflineMapParameters.referenceBasemapDirectory.

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

The spatial reference of the reference basemap is used for the offline map when it is different to the online map's spatial reference.

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

Implementation

String get referenceBasemapFilename {
  final stringHandle = _withThrowingErrorHandler((errorHandler) {
    return runtimecore
        .RT_DownloadPreplannedOfflineMapParameters_getReferenceBasemapFilename(
      _handle,
      errorHandler,
    );
  });
  return stringHandle.toDartString();
}
void referenceBasemapFilename=(String value)

Implementation

set referenceBasemapFilename(String value) {
  final coreValue = _CString(value);
  _withThrowingErrorHandler((errorHandler) {
    runtimecore
        .RT_DownloadPreplannedOfflineMapParameters_setReferenceBasemapFilename(
      _handle,
      coreValue.bytes,
      errorHandler,
    );
  });
}