CreateMap(String,MapType,MapViewingMode,Basemap) Method

In This Topic

Creates a new Map in the project. This method must be called on the MCT. Use QueuedTask.Run.

Syntax

C#
Visual Basic (Declaration)

public Map CreateMap( 
   string name,
   MapType mapType,
   MapViewingMode defaultViewingMode,
   Basemap basemap
)

Public Overloads Function CreateMap( _
   ByVal name As String, _
   Optional ByVal mapType As MapType, _
   Optional ByVal defaultViewingMode As MapViewingMode, _
   Optional ByVal basemap As Basemap _
) As Map

Parameters

name: The name of the map
mapType: ArcGIS.Core.CIM.MapType (Optional) The type of the map. (default value = MapType.Map)
defaultViewingMode: ArcGIS.Core.CIM.MapViewingMode (Optional) Map's default viewing mode. (default value = MapViewingMode.Map)
basemap: Basemap (Optional) Map's basemap which can be the one that is set as the default for the project or one of the ArcGIS Online basemaps. If you want create a map without basemap, set it to Basemap.None. (default value = Basemap.ProjectDefault)

Return Value

A map.

Exceptions

Exception	Description
ArcGIS.Core.CalledOnWrongThreadException	This method or property must be called within the lambda passed to QueuedTask.Run.
System.ArgumentException	Link Charts mucst be created with MapFactory.CreateLinkChart.

Remarks

To open a map, use ProApp.Panes.CreateMapPaneAsync method.

Example

How to add a new map to a project

await QueuedTask.Run(() =>
{
  //Note: see also MapFactory in ArcGIS.Desktop.Mapping
  var map = MapFactory.Instance.CreateMap("New Map", MapType.Map, MapViewingMode.Map, Basemap.Oceans);
  ProApp.Panes.CreateMapPaneAsync(map);
});

Create a new map with a default basemap layer

await QueuedTask.Run(() =>
{
  var map = MapFactory.Instance.CreateMap(mapName, basemap: Basemap.ProjectDefault);
  //TODO: use the map...
});

Open a diagram pane from a Network Diagram

// Create a diagram layer from a NetworkDiagram (myDiagram)
DiagramLayer diagramLayer = await QueuedTask.Run<DiagramLayer>(() =>
{
  // Create the diagram map
  var newMap = MapFactory.Instance.CreateMap(myDiagram.Name, ArcGIS.Core.CIM.MapType.NetworkDiagram, MapViewingMode.Map);
  if (newMap == null)
    return null;

  // Open the diagram map
  var mapPane = ArcGIS.Desktop.Core.ProApp.Panes.CreateMapPaneAsync(newMap, MapViewingMode.Map);
  if (mapPane == null)
    return null;

  //Add the diagram to the map
  return newMap.AddDiagramLayer(myDiagram);
});

Requirements

Target Platforms: Windows 11, Windows 10

ArcGIS Pro version: 3 or higher.

Reference

MapFactory Class
MapFactory Members
Overload List

Send feedback