SaveAsWebMapFile(String) Method

In This Topic

Save the current map to webmap file format. This method must be called on the MCT. Use QueuedTask.Run.

Syntax

Visual Basic (Declaration)
C#

Public Sub SaveAsWebMapFile( _
   ByVal webMapFileName As String _
)

public void SaveAsWebMapFile( 
   string webMapFileName
)

Parameters

webMapFileName: The fullpath of the webmap file to save to

Exceptions

Exception	Description
ArcGIS.Core.CalledOnWrongThreadException	This method or property must be called within the lambda passed to QueuedTask.Run.
System.NotSupportedException	DefaultViewingMode not supported
System.IO.DirectoryNotFoundException	Directory does not exist
System.ArgumentNullException	The value of webMapFileName cannot be null

Remarks

This version currently supports 2D maps: DefaultViewingMode == ArcGIS.Core.CIM.MapViewingMode.Map.
Only webmap compatible layers will be saved out to the specified file.
A suffix of ".json" will be appended to the filename if no suffix or a different suffix is provided. If the specified filename exists it will be overwritten.
Layer symbology is converted to symbology compatible with all web map clients

Example

Save 2D Map as WebMap on Disk

{
    //2D maps only
    //Must be on the QueuedTask.Run(...)
    if (map.DefaultViewingMode == MapViewingMode.Map)
        //Only webmap compatible layers will be saved out to the file
        map.SaveAsWebMapFile(@"C:\Data\MyMap.json");
}

Requirements

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

ArcGIS Pro version: 3.0 or higher.

Reference

Map Class
Map Members

Send feedback