topic Re: Save mapx file using python in Python Questions

Save mapx file using python

JohnSawicki1 — Fri, 20 Sep 2019 15:02:26 GMT

I am looking to save some but not all of my Maps in an ArcGIS Pro document as templates. I know I can save the layers out using python but can't find a way to save the "mapx" file using python. I am saving these pieces tp put them into source control.

Thanks

John

Re: Save mapx file using python

Jeremy_Moore — Fri, 20 Sep 2019 16:41:54 GMT

When you say ArcGIS Pro Documents are you referring to an ArcGIS Pro project file (.aprx) that contains multiple maps?

EDIT:

I'm pretty sure you are talking about .aprx files because I see where you can export the maps as a .mapx file in ArcGIS Pro. However I have not been able to find any way to save a mapx in arcpy. I took a look at the arcpy Mapping Module which was designed to access the information inside of a .aprx file:

Introduction to arcpy.mp—ArcPy | ArcGIS Desktop

I also looked in the Map Class for the Mapping Module:

Map—ArcPy | ArcGIS Desktop

I saw no where in the documentation about saving or exporting as a .mapx. I Also tried to see if saveACopy() would work and it did not. Maybe someone else has more insight?

Re: Save mapx file using python

JohnSawicki1 — Fri, 20 Sep 2019 21:34:24 GMT

Thanks for figuring out what I meant. I also tried saveACopy on a map but no luck. Seems silly that you can save a map "mapx" externally using from the user interface but there appears to be no way to do so in python.

Re: Save mapx file using python

Luke_Pinner — Sun, 12 Dec 2021 00:37:22 GMT

I don't know if this will work and can't test*, but you could try getting the CIM definition (>= ArcGIS 2.4) from the map and then use json.dump / json.dumps to write the .mapx file manually.

* corporate IT moves slooowly and we're still on 2.3

Something like:

import arcpy
import json

aprx_path = "path\\to\\your.aprx"
mapx_path = "path\\to\\{}.mapx"

aprx = arcpy.mp.ArcGISProject(aprx_path)
for map in aprx.listMaps():
    print("Map: " + map.name)
    map_def = map.getDefinition()  # <-- Get the CIM definition
    with open(mapx_path.format(map.name), 'w') as map_file:
         map_file.write(json.dumps(map_def))‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍

From the documentation - Python CIM access—ArcPy | ArcGIS Desktop

Python CIM access
The arcpy.mp module ... does not provide access to all properties, settings, and capabilities available in ArcGIS Pro. One reason is to keep the API streamlined, simple, and manageable. Another reason is that ArcGIS Pro is being developed at such a rapid pace that the APIs can't keep up. It may take a release or more before you have access through the managed APIs. Starting with ArcGIS Pro 2.4, Python developers will have fine-grained access to the Cartographic Information Model (CIM) and can access many more settings, properties, and capabilities that are persisted in a project or document.
...
What is the CIM
The CIM is the Esri Cartographic Information Model. It is a map content specification used to document how information that describes various project components is persisted when saved, read, referenced, or opened. The specification is represented as JSON and is used for maps, scenes, layouts, layers, symbols, and styles in ArcGIS applications and APIs.

Re: Save mapx file using python

JoshuaBixby — Sat, 21 Sep 2019 15:36:15 GMT

ArcPy has never been a complete SDK for ArcGIS Desktop. If saving *.mapx files is important, log an enhancement request with Esri Support and submit an ArcGIS Ideas‌.

Re: Save mapx file using python

Luke_Pinner — Sat, 28 Sep 2019 08:06:50 GMT

John Sawicki‌ did you try this? I'm interested to see if it actually worked or not since I can't test.

Re: Save mapx file using python

JohnSawicki1 — Mon, 30 Sep 2019 17:16:48 GMT

I can't seem to make it work ... This line

map_file.write(json.dumps(map_def))

Give me this error:

TypeError: Object of type 'CIMMap' is not JSON serializable

I have tried a few different ways to output the object but so far no luck ...

Re: Save mapx file using python

JoshuaBixby — Mon, 30 Sep 2019 19:51:14 GMT

map.getDefinition doesn't return JSON or an object that can be directly serialized to JSON, hence the error. The function returns a CIMMap object that you will have to serialize by hand (not by hand by hand, but write your own function to do it).

Re: Save mapx file using python

KimSundeen2 — Fri, 25 Sep 2020 13:07:13 GMT

Hey John. Did you ever solve this? I addressed a similar JSON serializable error with the following code:

import arcpy import json aprx_path = "path\\to\\your.aprx"

mapx_path = "path\\to\\{}.mapx"

aprx = arcpy.mp.ArcGISProject(aprx_path)

for map in aprx.listMaps():

print("Map: " + map.name)

map_def = map.getDefinition() # <-- Get the CIM definition

with open(mapx_path.format(map.name), 'w') as map_file:

json_mapx_data = json.load(map_file) # <-- Needed serialize and load mapx as JSON

json_mapx_data .write(json.dumps(map_def))

Re: Save mapx file using python

JohnSawicki1 — Tue, 06 Oct 2020 11:48:52 GMT

Kim

Thanks ! I will give it a try! I also found this:

exportToMAPX (out_mapx)

Parameter	Explanation	Data Type
out_mapx	A string used to save a Map to a map file (.mapx).	String

This method is useful if you want to save a map to a map file that can be imported later into a project using the ArcGISProject importDocument method.

Map—ArcGIS Pro | Documentation

I think it is new but I am stuck on a old version of pro.

John

Re: Save mapx file using python

Yuriko — Sun, 28 Mar 2021 04:45:20 GMT

I am using ArcGIS Pro v2.5.1 and am unable to export a 'mapx' file form the console. When calling the method as described under the help documentation for 'Map' with the line:

aprx = arcpy.mp.ArcGIS Project('CURRENT')

m = aprx.activeMap

m.exportToMAPX('Template.mapx')

I receive the following error:

Traceback (most recent call last):
File "<string>", line 3, in <module>
AttributeError: 'Map' object has no attribute 'exportToMAPX'

Any advice or redirection to resources would be much appreciated!

Re: Save mapx file using python

Yuriko — Tue, 30 Mar 2021 15:25:45 GMT

Similarly, I receive this error when attempting to export a layout to a PAGX file.

AttributeError: 'Layout' object has no attribute 'exportToPAGX'

Re: Save mapx file using python

PaulCleverleyArup — Mon, 20 Sep 2021 12:05:54 GMT

I'm also getting "'Layout' object has no attribute 'exportToPAGX'"

Was there any resolution to this?

Thanks

Paul

Re: Save mapx file using python

LaurensKusse_hhdelfland — Thu, 30 Mar 2023 17:56:30 GMT

This worked for me (ArcGIS Pro 2.9.5):

import arcpy aprx = 'c:\\temp\\project.aprx' folder = 'c:\\temp\\export' p = arcpy.mp.ArcGISProject(aprx) for m in p.listMaps(): #export mapx file mapx_path = f'{folder}\\{m.name}.mapx' m.exportToMAPX(mapx_path) for m in p.listLayouts(): #export pagx file pagx_path = f'{folder}\\{m.name}.pagx' m.exportToPAGX(pagx_path)

Re: Save mapx file using python

MatthewMassey — Tue, 10 Oct 2023 19:08:25 GMT

This worked for me in the sense that I got a .mapx file, but the data sources for all the layers is not corrrect...they are all basically missing the name of the geodatabase in their source path. For example:

Name of source geodatabase: GEODATABSE.gdb

Correct path to source: PATH\GEODATABASE.gdb

Exported .mapx path to source: PATH\.gdb

Re: Save mapx file using python

LaurensKusse_hhdelfland — Wed, 11 Oct 2023 13:09:18 GMT

That's very odd. I think you should contact support about that.

I could not reproduce it. When I open the MapX-file with Visual Studio Code, I see this in the json:

"dataConnection" : { "type" : "CIMStandardDataConnection", "workspaceConnectionString" : "DATABASE=X:\\GIS\\Projecten\\3D\\GemaalWestland\\FGDB\\Data.gdb", "workspaceFactory" : "FileGDB", "dataset" : "GemaalWestland", "datasetType" : "esriDTFeatureClass" }