ArcGIS Pro 3.7 API Reference Guide
ArcGIS.Desktop.Mapping Namespace / Map Class / SetBasemapLayers Method / SetBasemapLayers(Basemap) Method
A basemap.
Example

In This Topic
    SetBasemapLayers(Basemap) Method
    In This Topic
    Sets the current basemap layers in the map. This method must be called on the MCT. Use QueuedTask.Run.
    Syntax
    Public Overloads Sub SetBasemapLayers( _
       ByVal basemap As Basemap _
    ) 
    public void SetBasemapLayers( 
       Basemap basemap
    )

    Parameters

    basemap
    A basemap.
    Exceptions
    ExceptionDescription
    This method or property must be called within the lambda passed to QueuedTask.Run.
    Example
    Get Basemaps
    {
        //Basemaps stored locally in the project. This is usually an empty collection
        //Note: Needs QueuedTask to run
        string localBasemapTypeID = "cim_map_basemap";
    
        var mapContainer = Project.Current.GetProjectItemContainer("Map");
        mapContainer.GetItems().Where(i => i.TypeID == localBasemapTypeID).ToList();
    
        //portal basemaps. If there is no current active portal, the usual default
        //is arcgis online
        var portal = ArcGISPortalManager.Current.GetActivePortal();
        var portalBaseMaps = await portal.GetBasemapsAsync();
    
        //use one of them...local or portal...
        //var map = MapView.Active.Map;
        //QueuedTask.Run(() => map?.SetBasemapLayers(portalBaseMaps[0]));  
    }
    Update a map's basemap layer
    {
        //Note: Run within QueuedTask
        map.SetBasemapLayers(Basemap.Gray);
    }
    Remove basemap layer from a map
    {
        //Note: Run within QueuedTask
        map.SetBasemapLayers(Basemap.None);
    }
    Requirements

    Target Platforms: Windows 11 Home, Pro, Enterprise (64 bit)

    ArcGIS Pro version: 3.0 or higher.
    See Also