使用代码片段

您可通过 ArcGIS Notebooks 浏览和创建预先编写和可重用的代码(称为代码片段)并将其插入到笔记本中。

创建代码片段

您可以从笔记本创建代码片段。 所创建的代码片段可以用于同一笔记本或其他笔记本。 所创建的代码片段存储在笔记本代码片段库项目中,此项目用于组织您的代码片段,并且支持共享

要创建代码片段,您必须先创建一个笔记本代码片段库,以便在其中存储代码片段。 代码片段库最多可包含 100 个片段。

创建笔记本代码片段库

要创建代码片段库,请完成以下步骤:

  1. 打开笔记本
  2. 在笔记本编辑器的顶部功能区上,单击代码片段
  3. 单击添加按钮 添加,然后选择创建库项目
  4. 为库提供标题和摘要,然后选择性地添加标签,这些标签用于表示存储在库中的代码片段。
  5. 或者,在文件夹下选择一个位置来保存代码段库。
  6. 单击创建

在创建代码片段库后,它会像任何其他项目一样存储在组织中。 要管理代码片段库,可在代码片段窗格中单击更多选项按钮 更多,然后单击管理库项目。 在管理代码片段库项目窗口中,可以新建代码片段库,对于每个代码片段库,可以共享、编辑、查看项目页面,然后将库标记为已弃用。

添加代码片段

创建库后,即可向其中添加代码片段。 要添加代码片段,请执行以下操作:

  1. 打开笔记本
  2. 在笔记本编辑器的顶部功能区上,单击代码片段
  3. 单击添加按钮 添加,然后选择添加代码片段
  4. 提供代码片段的标题,选择要添加代码片段的库,然后提供描述。

    选择代码片段库项目下拉列表显示了可向其添加片段的库。 该列表还指示了该库中的片段数。

  5. 单击保存

您可以单击代码片段的更多选项按钮 更多,更改代码片段。 更多选项下拉菜单提供用于编辑弃用删除片段的选项。

插入代码片段

使用代码片段窗格,完成以下步骤以插入代码片段:

  1. 打开笔记本
  2. 在笔记本编辑器的顶部功能区上,单击代码片段
  3. 浏览要插入的代码片段所在的代码片段库。
  4. 单击代码片段的查看详细信息以查看代码预览。
  5. 找到要插入的代码片段后,单击代码片段窗格中的添加按钮 添加 或单击代码预览窗格中的插入笔记本,将代码片段作为新单元格插入到笔记本中。

以下是一个可以添加至笔记本的代码片段示例:

# curated code snippet inserted from the Code snippets pane
from arcgis.gis import GIS
def check_org_credits_agol(gis: GIS):
    if "admin" in gis.__dict__:
        credits = gis.admin.credits.credits
        print(f"This ArcGIS Online organization has {credits} credits.")
    else:
        print("Please connect to the ArcGIS Online organization as an administrator to check credits.")

# create a GIS instance to pass to the code snippet function
gis_agol = GIS("https://www.arcgis.com/", "<admin_username>")

# call the code snippet function with your GIS instance
check_org_credits_agol(gis_agol)

Esri 代码片段

所有可用的代码片段均为 Esri 精选内容。 这些精选的代码片段允许您在笔记本中实施常见的 GIS 工作流。 将代码片段编写为 Python 函数,这些函数可被插入到笔记本中并支持全范围调用。 将代码片段添加到笔记本后,也可以对其进行编辑。

以下是可以插入到笔记本中的可用代码片段:

  1. GIS 管理 - 执行常见 GIS 管理任务的代码片段
    注:

    其中许多代码片段需要管理员连接。

    • 检查剩余配额(仅限 ArcGIS Online
    • 检查特定用户的配额(仅限 ArcGIS Online
    • 获取图层项目的基础服务 URL
    • 查询失败的笔记本任务
    • 查询门户日志并另存为 CSV(仅限 ArcGIS Enterprise
    • 登录门户(适用于 ArcPy
  2. 内容管理 - 代码片段有助于管理 GIS 中的内容和笔记本工作区目录中的文件。
    • 在工作空间目录中复制地理数据库
    • 使用空要素类创建文件地理数据库
    • 在工作空间目录中创建文件夹
    • 将文件项目从门户下载到工作空间目录
    • 列出数据集
    • 列出文件
    • 从工作空间目录中移除文件地理数据库
    • 从工作空间目录中移除文件夹
    • 将文件解压到工作空间目录
  3. 数据科学和分析 - 可以使用 ArcGIS API for PythonArcPy 和其他 Python 库在您的数据科学和分析工作流中实施的代码片段。
    注:

    使用高级笔记本运行时以运行需要 ArcPy 的代码片段。 有关笔记本运行时的详细信息,请参阅指定笔记本的运行时

    • 将要素类转换为要素图层
    • 将要素类转换为启用空间功能的 DataFrame
    • 将要素图层转换为启用空间功能的 DataFrame
    • 将启用空间功能的 DataFrame 转换为要素类
    • 显示来自 URL 的图像
    • 显示来自工作空间目录的图像
    • 填充缺失值
    • 列出要素类中的字段
    • 列出图层中的字段
    • 列出项目中的图层
    • 绘制启用空间功能的 DataFrame(快速入门)
    • 使用分类间隔渲染器绘制启用空间功能的 DataFrame
    • 使用简单渲染器绘制启用空间功能的 DataFrame
    • 使用唯一值渲染器绘制启用空间功能的 DataFrame
    • 将启用空间功能的 DataFrame 发布为要素图层