Python コードスニペットの使用—ArcGIS Notebook Server

ArcGIS Enterprise 11.0 で採用された ArcGIS Notebook Server では、コードスニペットと呼ばれる再利用可能な記述済みのコードの一部を参照し、ノートブックに挿入できます。

コードスニペットの作成

ノートブックからコードスニペットを作成できます。作成したスニペットは、同じノートブックまたは他のノートブックで使用できます。作成したコードスニペットは、スニペットの整理に使用されるノートブックコードスニペットライブラリアイテムに保存され、共有することができます。

コードスニペットを作成するには、スニペットを保存するノートブックコードスニペットライブラリを先に作成する必要があります。コードスニペットライブラリには最大 100 個のスニペットを保存できます。

ノートブックコードスニペットライブラリの作成

コードスニペットライブラリを作成するには、次の手順を実行します。

ノートブックエディターの上部のリボンで、[コードスニペット] をクリックします。
[追加] ボタンをクリックして [ライブラリアイテムの作成] を選択します。
ライブラリのタイトルとサマリーを入力し、必要に応じて、そのライブラリに保存されるコードスニペットを表すタグを追加します。
必要に応じ、コードスニペットライブラリの保存先として [マイコンテンツ] のフォルダーを選択します。
[作成] をクリックします。

コードスニペットライブラリを作成すると、他のアイテムと同じように組織サイトに格納されます。 [コードスニペット] ウィンドウの [その他のオプション] ボタンをクリックして [ライブラリアイテムの管理] をクリックすることで、コードスニペットライブラリを管理できます。 [コードスニペットライブラリアイテムの管理] ウィンドウで、新しいコードスニペットライブラリを作成できます。また、コードスニペットライブラリごとにアイテムの詳細ページを共有、編集、表示し、ライブラリを非推奨としてマークできます。

コードスニペットの追加

ライブラリの作成が完了したら、コードスニペットをライブラリに追加できます。コードスニペットを追加するには、次の手順を実行します。

ノートブックエディターの上部のリボンで、[コードスニペット] をクリックします。
[追加] ボタンをクリックし、[コードスニペットを追加] を選択します。
コードスニペットのタイトルを入力し、そのコードスニペットを追加するライブラリを選択し、説明を入力します。
[コードスニペットライブラリアイテムの選択] ドロップダウンリストに、スニペットを追加できるライブラリが表示されます。リストには、ライブラリ内のスニペット数も表示されます。
次のいずれかの手順を実行し、スニペットのコードを追加します。
- ノートブックがランタイムバージョン 8.0 以降を使用している場合、コードスニペットとして追加するセルを選択し、[アクティブなセルからコピー] をクリックします。
- ノートブックがランタイムバージョン 7.0 以前を使用している場合、コードスニペットのコードを入力します。
  注意:
  インデントやその他の構文エラーを回避するため、コードを直接入力するのではなく、ノートブックセルからコードをコピーして貼り付けます。
[保存] をクリックします。

スニペットの [その他のオプション] ボタンをクリックすることで、コードスニペットに対して変更を加えることができます。 [その他のオプション] ドロップダウンメニューには、スニペットを編集 ([編集])、廃止 ([廃止])、および削除 ([削除]) できるオプションがあります。

コードスニペットの挿入

[コードスニペット] ウィンドウを使用し、次の手順を実行してコードスニペットを挿入します。

ノートブックエディターの上部のリボンで、[コードスニペット] をクリックします。
挿入するスニペットが保存されているコードスニペットライブラリを参照します。
スニペットの [詳細の表示] をクリックしてコードのプレビューを表示します。
挿入するコードスニペットを見つけたら、コードスニペットウィンドウの [追加] ボタンか、コードプレビューウィンドウの [ノートブックに挿入] をクリックし、コードスニペットを新しいセルとしてノートブックに挿入します。

次に、ノートブックに追加したコードスニペットの例を示します。

# 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 関数として記述され、ノートブックに挿入し、ノートブックから呼び出すことができます。コードスニペットは、ノートブックに追加した後に編集できます。

注意:

11.0 では、管理コードスニペットの名前と説明は、英語のみで提供されています。

ノートブックに挿入できるコードスニペットには、次のようなものがあります。

GIS administration - 一般的な GIS 管理タスクを実行するコードスニペット。
注意:
これらのコードスニペットの多くは、管理者としての接続が必要です。
- 使用可能なクレジット数の確認 (ArcGIS Online のみ)
- 特定のユーザーのクレジット数の確認 (ArcGIS Online のみ)
- レイヤーアイテムのベースサービスの URL を取得
- 失敗したノートブックタスクのクエリ
- ポータルログをクエリ検索して CSV として保存 (ArcGIS Enterprise のみ)
- ポータルにサインインして ArcPy を使用
コンテンツ管理 - GIS のコンテンツと、ノートブックのワークスペースディレクトリのファイルを管理するために使用されるコードスニペット。
- ワークスペースディレクトリでジオデータベースをコピー
- 空のフィーチャクラスを含むファイルジオデータベースを作成
- ワークスペースディレクトリにフォルダーを作成
- ファイルアイテムをポータルからワークスペースディレクトリにダウンロード
- データセットをリスト
- ファイルをリスト
- ワークスペースディレクトリのファイルジオデータベースを削除
- ワークスペースディレクトリのフォルダーを削除
- ワークスペースディレクトリにファイルを展開
Data science and analysis - ArcGIS API for Python、ArcPy、およびその他の Python ライブラリを使用して、データサイエンスと解析ワークフローに実装できるコードスニペット。
注意:
ArcPy を必要とするコードスニペットを実行するには、高度なノードブックランタイムを使用します。ノートブックランタイムの詳細については、「ノートブックのランタイムの指定」をご参照ください。
- フィーチャクラスをフィーチャレイヤーに変換
- フィーチャクラスを Spatially Enabled DataFrame に変換
- フィーチャレイヤーを Spatially Enable DataFrame に変換
- Spatially Enabled DataFrame をフィーチャクラスに変換
- URL から画像を表示
- ワークスペースディレクトリから画像を表示
- 欠損値の補完
- フィーチャクラス内のフィールドをリスト
- レイヤー内のフィールドをリスト
- アイテム内のレイヤーをリスト
- Spatially Enable DataFrame (quickstart) をプロット
- Spatially Enable DataFrame をクラス閾値レンダラーでプロット
- Spatially Enable DataFrame をシンプルレンダラーでプロット
- Spatially Enable DataFrame を個別値レンダラーでプロット
- Spatially Enabled DataFrame をフィーチャレイヤーとして公開

このトピックへのフィードバック

コード スニペットの作成

ノートブック コード スニペット ライブラリの作成

コード スニペットの追加

注意:

コード スニペットの挿入

Esri コード スニペット

注意:

注意:

注意:

このトピックの内容

コードスニペットの作成

ノートブックコードスニペットライブラリの作成

コードスニペットの追加

コードスニペットの挿入

Esri コードスニペット