idea Removing map from ArcGIS Pro project using ArcPy in ArcGIS Pro Ideas

Removing map from ArcGIS Pro project using ArcPy

GraemeBrowning — Sat, 17 Jun 2017 08:53:51 GMT

I have a desirable requirement to be able to remove a map from an ArcGIS Pro project using ArcPy.

However the ArcGISProject class does not seem to provide a method to do this.

I would like ArcPy to be enhanced to allow this.

My use case is a map automation application where I need to maintain three maps to support three MGA Zones (Australian "equivalent" to supporting three UTM Zones). When the application exports a PDF at the end I also save a copy of the APRX so that the user wanting the PDF can, if need be, open up a copy of the project that created it (think of it as a draft), and perform some modifications before saving a final project/PDF. Since each PDF only uses one of the MGA Zone maps I would like to unclutter the project before saving the copy by removing the other two MGA Zone maps.

Re: Removing map from ArcGIS Pro project using ArcPy

GeoNZ — Mon, 10 Sep 2018 20:25:28 GMT

I also have a requirement to be able to remove Layouts from an aprx using Arcpy.mp. Arcpro has simplfied map templates as you can now keep all template variations of paper size/orientation in one project file. The draw back is that when requiring just one layout of many, there is no way in arcpy.mp to strip out the unneeded layouts from the project.

Re: Removing map from ArcGIS Pro project using ArcPy

ThomasL — Thu, 14 Feb 2019 11:04:52 GMT

ArcGIS Pro 2.3 is very slow with multiple Maps (and Layouts).

We need this feature in arcpy to enable us to write clean-up scripts to help ArcGIS Pro running.

Re: Removing map from ArcGIS Pro project using ArcPy

MatthewWStelmach — Fri, 14 Jan 2022 16:41:27 GMT

We've encountered a bug when working on a scripting tool that has created multiple maps that are not visible in the catalog but listed when trying to export the APRX. Without an arcpy module to delete the added map packages and not having them visible in the catalog we are unable to delete the added maps.

Re: Removing map from ArcGIS Pro project using ArcPy

JTLancer — Tue, 05 Apr 2022 15:23:56 GMT

I am interested in this functionality as well. My use case is trying to interrogate mxd files from ArcPro using the importDocument method. So far I have not found a way to access arcpy.mp properties without first importing the map to a project. I can import mxds just fine but there doesn't seem to be a way to programmatically get rid of them when desired after bringing them into the project.

Re: Removing map from ArcGIS Pro project using ArcPy - Status changed to: In Product Plan

JeffBarrette — Thu, 07 Apr 2022 16:08:30 GMT

We hope to include a number of project item management functions (e.g., Delete, Copy, Add folder connections, database connections ,etc).

Re: Removing map from ArcGIS Pro project using ArcPy

RichardHowe — Thu, 12 May 2022 08:08:49 GMT

@JeffBarrette That is great to hear! Removing and adding folder and database connections from a project would be so useful. All I seem to able to do at the moment is change the defaults

Any idea if this is coming soon??

Re: Removing map from ArcGIS Pro project using ArcPy

JeffBarrette — Fri, 13 May 2022 16:06:14 GMT

We started to prototype removing project items recently. Our current plan it to support this at Pro 3.1.

Jeff - Layout and arcpy.mp teams

Re: Removing map from ArcGIS Pro project using ArcPy

RichardHowe — Tue, 17 May 2022 19:21:49 GMT

@JeffBarrette Thank you for taking the time to reply and keeping us informed. That's excellent news. I look forward to it!!

Re: Removing map from ArcGIS Pro project using ArcPy

banders — Thu, 20 Oct 2022 17:43:48 GMT

@JeffBarrette +1 from me. Also awaiting a method to remove a Map from an ArcGISProject.

Re: Removing map from ArcGIS Pro project using ArcPy

John_Spence — Thu, 27 Oct 2022 14:12:14 GMT

@JeffBarrette +1 from us too! Would come in handy for a great number of situations.

Re: Removing map from ArcGIS Pro project using ArcPy - Status changed to: Implemented

AmeliaBradshaw — Fri, 10 Mar 2023 14:52:35 GMT

This Idea has been implemented in ArcGIS Pro 3.1. Please see the What's New documentation for more new features in Pro 3.1.

The Ideas in ArcGIS Pro 3.1 blog will be wrapped up soon. Once complete, I will add the link to this comment.

Re: Removing map from ArcGIS Pro project using ArcPy

PaulDziemiela21 — Fri, 03 Nov 2023 16:55:40 GMT

I rather think Amelie misread this enhancement and incorrectly marked the original request as implemented.

The original enhancement straightforwardly asks "I have a desirable requirement to be able to remove a map from an ArcGIS Pro project using ArcPy." - emphasis mine.

The provided 3.1 enhancement is in that vein of course, it provides a method to close all maps.
See https://pro.arcgis.com/en/pro-app/latest/arcpy/mapping/arcgisproject-class.htm#M1_GUID-1117B216-CE8B-47A9-998B-6143907D3165

However, Graeme is asking for a method to close one single map, not all of them. So if a user has 100 maps open, we seek to close map #87 leaving the other 99 just as they are. The aprx.closeViews() method does not address that need.

Could we thus reopen this enhancement?

It should also include a method to list the current open views as its difficult to know the items to close when one does not know what is open. If this is not possible in future Pro iterations a note mentioning that would be helpful as well.

Re: Removing map from ArcGIS Pro project using ArcPy

RichardHowe — Mon, 06 Nov 2023 09:07:54 GMT

@PaulDziemiela21 I don't think Amelia misread it at all. The original post was asking for a method to remove a map from a project.

The deleteItem (project_item) method, clearly provides for that and the post is correctly marked as implemented

What you are asking for may well be desirable functionality, but it is a new (and different) request from the original post and as such deserves its own post on the board

Re: Removing map from ArcGIS Pro project using ArcPy

PaulDziemiela21 — Mon, 06 Nov 2023 11:45:35 GMT

Hi Richard,

I suppose its about our interpretation of Graeme's requirement and what his verb, remove, means in the Pro catalog context. I'll admit I was reading into things from this supporting stack exchange
https://gis.stackexchange.com/questions/463961/closing-single-map-view-in-arcgis-pro-using-arcpy

If the requirement and the solution is to delete (not close) individual maps, then I apologize and the requirement is met.

Re: Removing map from ArcGIS Pro project using ArcPy

JeffBarrette — Mon, 06 Nov 2023 16:42:18 GMT

@PaulDziemiela21 , perhaps there is some understandable confusion with the term 'Map' - project item that defines a list of symbolized layers and a spatial reference like in the original statement "supporting three UTM Zones" vs a 'MapView' - a window to display a Map where you can have one or many views displaying the same map, perhaps each with a different extents, for example.

For managing a map project item, we have the ArcGISProject.deleteItem() method. I believe this addresses the original idea that we closed.

If the discussion was intended to address closing MapView's then ...

MapViews do NOT have unique names so it is not currently possible in arcpy.mp to reference a specific MapView (e.g., 1 out of X) to close it. The best, current solution is to reference the project item (map, layout, or report) and call openView(). This will open and activate the view. If you don't want too many views open, there is also the option to call ArcGISProject.closeViews(). This allows you to do some clean up before opening a new map view. There is a discussion about this in the same help topic listed above. It is very easy to close all views and then open the one or select few you want to see. Also understand that these map views exist when the application is open. If you are running Python scripts outside of the application, you can't work with views at all.

I completely understand your requirement but currently there is no way we can address it.

Jeff - Layout and arcpy.mp teams

Re: Removing map from ArcGIS Pro project using ArcPy

uasdev — Mon, 26 Feb 2024 22:12:54 GMT

@RichardHowe Where is the deleteItem function in arcpy?

I do not see it when I search the ArcGIS Pro documentation.

I am a little confused, but the original question seemed like "How to remove map from ArcGIS Project using arcpy?" Was this functionality implemented?

Re: Removing map from ArcGIS Pro project using ArcPy

JeffBarrette — Mon, 26 Feb 2024 22:38:01 GMT

@sadlkjiouasdf try ArcGISProject.deleteItem(project_item)

https://pro.arcgis.com/en/pro-app/latest/arcpy/mapping/arcgisproject-class.htm

Jeff - Layout SDK and arcpy.mp teams

Re: Removing map from ArcGIS Pro project using ArcPy

JohnButcher — Tue, 12 Aug 2025 21:05:14 GMT

Hi @JeffBarrette,

Would the deleteItem method work on an .aprx that is not open?

I'd like to iterate over multiple project files and remove certain map/layout items without having to open each one. Ultimately I'd also like to import new .mapx , .pagx, and .lyrx files as well but first things first.

I have attempted this with the following code run from a Notebook, but it never completes (the kernel hangs in "Busy" mode. Maybe I just have to be real patient but I am wondering if I'm missing something.

import arcpy aprx_path = r"file_path.aprx" p = arcpy.mp.ArcGISProject(aprx_path) m = p.listMaps("map name")[0] p.deleteItem(m)

Thanks!

John