arcgis pro ArcGISProject

描述

ArcGIS Pro 工程方法和属性。大多数地图自动化工作流都需要引用此对象。

说明

ArcGISProject 对象通常是最先引用的对象（这些对象是在地图自动化脚本中创建的）之一，因为它是访问几乎所有其他 ArcGIS 工程对象的主要入口点。

defaultToolbox。

.rptx) 导入到现有工程中。

None 值，因为视图仅在应用程序打开时才会相关。

属性

属性	说明	数据类型
activeMap （只读）	None 如果没有打开具有相关联的地图的视图或当脚本在应用程序外部运行时，将会返回。	Map
dateSaved （只读）	datetime 对象。	DateTime
defaultGeodatabase （可读写）	工程的默认地理数据库位置。此字符串必须包含地理数据库的完整路径和文件名称。	String
defaultToolbox （可读写）	工程的默认工具箱位置。此字符串必须包含工具箱的完整路径和文件名称。	String
documentVersion （只读）	saveACopy 将更新文档版本，以匹配应用程序版本。	String
filePath （只读）	返回报告完全限定的工程路径和文件名的字符串值。	String
homeFolder （可读写）	工程的主目录文件夹位置。此字符串必须包含所需位置的完整路径。	String

方法概述

方法	说明
importDocument (document_path, {include_layout}, {reuse_existing_maps})	.rptx) 的内容。
listBrokenDataSources ()	Table 对象的 Python 列表。
listColorRamps ({wildcard})	listColorRamps 方法将引用工程中的可用色带。
listLayouts ({wildcard})	Layout 对象的 Python 列表。
listMaps ({wildcard})	Map 对象的 Python 列表。
listReports ({wildcard})	报表对象的 Python 列表。
save ()	.aprx)。
saveACopy (file_name)	.aprx) 保存到新文件路径或另存为新文件名。
updateConnectionProperties (current_connection_info, new_connection_info, {auto_update_joins_and_relates}, {validate}, {ignore_case})	使用工作空间字典或路径替换连接属性。

方法

importDocument (document_path, {include_layout}, {reuse_existing_maps})

参数	说明	数据类型
document_path	.rptx) 的系统路径和名称的字符串。	String
include_layout	False，则仅导入数据框。对于其他文件类型，可忽略此参数。 (默认值为 True)	Boolean
reuse_existing_maps	False，由此可检查工程中布局文件中引用的地图，并仅复制工程中不存在的地图。这样可以避免在工程中复制地图。对于其他文件类型，可忽略此参数。 (默认值为 False)	Boolean

include_layout=False。

listBrokenDataSources ()

 

返回值

数据类型	说明
List	Table 对象的 Python 列表。

listBrokenDataSources 方法始终返回 Python 列表对象，即使返回一个损坏的图层或表。

listColorRamps ({wildcard})

参数	说明	数据类型
wildcard	通配符将基于色带名称显示在应用程序中。星号 (*) 和字符的组合可用于帮助限制生成的列表。 (默认值为 None)	String

返回值

数据类型	说明
List	ColorRamp 对象列表。

listLayouts ({wildcard})

参数	说明	数据类型
wildcard	通配符基于布局名称且不区分大小写。星号 (*) 和字符的组合可用于帮助限制生成的列表。 (默认值为 None)	String

返回值

数据类型	说明
List	Layout 对象的 Python 列表。

Layout 对象的 Python 列表。

listMaps ({wildcard})

参数	说明	数据类型
wildcard	通配符基于地图名称且不区分大小写。星号 (*) 和字符的组合可用于帮助限制生成的列表。 (默认值为 None)	String

返回值

数据类型	说明
List	Map 对象的 Python 列表。

Map 对象的 Python 列表。

listReports ({wildcard})

参数	说明	数据类型
wildcard	通配符基于报表名称且不区分大小写。星号 (*) 和字符的组合可用于帮助限制生成的列表。 (默认值为 None)	String

返回值

数据类型	说明
List	报表对象的 Python 列表。

.aprx) 中的报表对象的 Python 列表。

save ()

 

ArcGISProject对象。

saveACopy (file_name)

参数	说明	数据类型
file_name	.aprx) 保存到新文件路径或另存为新文件名的字符串。	String

ArcGISProject 对象。并不会复制工程文件夹中的所有内容。

updateConnectionProperties (current_connection_info, new_connection_info, {auto_update_joins_and_relates}, {validate}, {ignore_case})

参数	说明	数据类型
current_connection_info	用于表示工作空间路径或 Python 字典（包含要更新的源的连接属性）的字符串。	String
new_connection_info	用于表示包含连接属性与新源信息的工作空间路径或 Python 字典的字符串。	String
auto_update_joins_and_relates	updateConnectionProperties 方法还将更新相关连接或关联的连接。 (默认值为 True)	Boolean
validate	new_connection_info。在这种情况下，如果匹配不存在，则将损坏数据源。 (默认值为 True)	Boolean
ignore_case	True。 (默认值为 False)	Boolean

更新和修复数据源帮助主题。

代码示例

ArcGISProject 示例 1

ArcGIS Pro 工程。同时还设置了一些默认工程设置并将结果保存到新文件。

import arcpy
aprx = arcpy.mp.ArcGISProject(r"C:\Projects\blank.aprx")
aprx.importDocument(r"C:\Projects\YosemiteNP\Documents\Yosemite.mxd")
aprx.importDocument(r"C:\Projects\YosemiteNP\Documents\Yosemite_ScenicViews.3dd")
aprx.defaultToolGeoDatabase = r"C:\Projects\YosemiteNP\Data_Vector\YosemiteData.gdb"
aprx.defaultToolbox = r"C:\Projects\YosemiteNP\Analysis\AnalysisTools.tbx"
aprx.saveACopy(r"C:\Projects\YosemiteNP\Yosemite.aprx")

ArcGISProject 示例 2

Python 窗口运行此脚本。此脚本打印了工程及其图层中每个地图的名称，以及每个布局的名称及其页面大小。

aprx = arcpy.mp.ArcGISProject("CURRENT")
for m in aprx.listMaps():
    print("Map: " + m.name)
    for lyr in m.listLayers():
        print("  " + lyr.name)
print("Layouts:")
for lyt in aprx.listLayouts():
    print(f"  {lyt.name} ({lyt.pageHeight} x {lyt.pageWidth} {lyt.pageUnits})")