Show / Hide Table of Contents

Property ReferenceBasemapFilename

ReferenceBasemapFilename

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

Declaration
public string ReferenceBasemapFilename { get; set; }
Property Value
Type Description
string

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

Remarks

The local basemap filename can reference any supported local basemap type, including:

  • a tile package (.tpk or .tpkx)
  • a vector tile package (.vtpk)
  • a supported raster data file

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 CreateDefaultGenerateOfflineMapParametersAsync(Geometry).

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

If the directory does not exist, or does not contain the specified basemap, the GenerateOfflineMapJob 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 IncludeBasemap is false.

Applies to

Platforms and versions
TargetVersions
.NET Standard 2.0100.5 - 200.8
.NET100.13 - 300.1
.NET Windows100.13 - 300.1
.NET Android200.0 - 300.1
.NET iOS200.0 - 300.1
.NET Framework100.5 - 200.8
Xamarin.Android100.5 - 100.15
Xamarin.iOS100.5 - 100.15
UWP100.5 - 200.8
In this article
Provide feedback
Back to top Copyright © 2025 Esri.