ProConcepts Migrating to ArcGIS Pro - EsriJapan/arcgis-pro-sdk GitHub Wiki

このドキュメントでは、ArcGIS Pro SDK を使用した開発についての簡単な紹介と、従来の ArcGIS Desktop のカスタマイズを Pro に移行する開発者向けの考慮事項およびリソースの概要について説明します。

    Language:      C#
    Subject:       Framework
    Contributor:   ArcGIS Pro SDK Team <[email protected]>
    Organization:  Esri, http://www.esri.com
    Date:          10/06/2024 
    ArcGIS Pro:    3.4
    Visual Studio: 2022

• 概要
• ArcGIS Pro への移行
• カスタマイズ オプション
• 拡張パターン
• プログラミング パターン
• ArcGIS Pro SDK の学習

このドキュメントでは、ArcGIS Pro SDK for .NET での開発について簡単に紹介し、従来の ArcGIS Desktop のカスタマイズを Pro に移行する開発者向けの考慮事項およびリソースの概要を説明します。

ノート: ArcGIS Pro 3.0 では、Pro 2.x のアドイン コードが変更されています。 詳細については、ProConcepts 3.0 移行ガイド を参照してください。その他の ArcGIS Pro 2.x プロジェクトおよびファイルの移行情報については、ArcGIS Pro 2.x から 3.0 への移行 ドキュメントを参照してください。

このドキュメントには、以下の項目があります。

• ArcGIS Pro への移行 - 開発を開始する前に、従来の Desktop との多くの違いを理解するために ArcGIS Pro を学習するためのリソースのリンク。
• カスタマイズ オプション - ArcGIS Pro で利用可能なカスタマイズ オプションの説明。
• 拡張パターン - ArcGIS Pro をカスタマイズするための主要な Pro SDK の拡張パターン。
• プログラミング パターン - Pro API の使用、WPF、MVVM、非同期プログラミング、および関連する考慮事項など、Pro SDK でプログラミングする際に使用されるプログラミング パターン。
• Pro SDK の学習 - Pro SDK を学ぶためのヒントとリソース。

このセクションでは、従来の ArcGIS Desktop との多くの違いを理解するために、ArcGIS Pro を学習するためのリソースのリンクを紹介します。

移行の計画を始めるにあたり、既存のソリューションを強化できる ArcGIS Pro の多くの進化と機能をどのように利用できるかを検討することをお勧めします。また、必要に応じてコアのすぐに使える機能を使用して、ワークフローに対処する方法についても検討する必要があります。たとえば、ユーザーが ArcGIS Pro をどのように操作するか、また、コンテキスト リボン UI によって UI の実装がどのように変わるかを検討してください。アドインの設計に取りかかる前に、ArcGIS Pro アプリケーションを十分に理解しておくと役に立ちます。

新しい ArcGIS Pro の UI 要素や用語に慣れるために、ArcGIS Pro　のトレーニング、ドキュメント、クイック スタートガイドの包括的なリソースが用意されています。

• ArcGIS トレーニング カタログ – 利用可能な多くの ArcGIS Pro トレーニング コースを調べる

• ArcGIS Pro リソース – クイックスタート チュートリアルと移行ガイドを活用する

• ArcGIS Pro への移行 – 移行情報とビデオを探す

• ArcGIS Pro ドキュメント – すべてのドキュメントにアクセスする

• ArcGIS Pro 新機能 - ArcGIS Pro の新機能と製品のロードマップの紹介

• ArcGIS Pro 用語ガイド – ArcGIS Pro の用語を学ぶ

• Esri Press – ArcGIS Pro の学習に関する書籍を探す

移行する際には、労力と複雑さの観点から、ArcGIS Pro のカスタマイズ オプションを検討するのが役に立ちます。ArcGIS Pro のカスタマイズには、3 つの一般的なオプションまたはアプローチがあり、複雑度の低いものから高いものへと記載しています。

• 設定を使用して UI を構成し、タスクを使用してワークフローを構成する。 この複雑度の低いアプローチは、必要な機能が既存の ArcGIS Pro ツールおよび機能によってカバーされており、ArcGIS Pro プロジェクトとワークフローを整理したい場合に最適です。この場合、Pro リボンのカスタマイズ のように、UI を少し変更するだけでよい場合もあります。また、ArcGIS Pro の タスク を使用すると、繰り返し使用できるワークフローを構成し、ArcGIS Pro の標準ツール、ジオプロセッシング ツール、および独自のジオプロセシング モデルを埋め込むことができます。これらのタイプのアップデートは、多くの組織のニーズを満たすことができ、ArcGIS Pro のバージョンをアップグレードする際に簡単に管理することができます。

• ジオプロセシングと Python を使用して自動化する。 次に、ModelBuilder によるジオプロセシング モデルの作成と、ArcPy による Python スクリプトの開発について説明します。このアプローチでは、一般的なタスクや操作を自動化するための強力で反復可能なスクリプトを作成することができます。ArcGIS Pro でジオプロセシングと Python を使用することは非常に強力であり、プロセスやルーチンで ArcGIS Pro を使用する多くの側面は、このオプションを介してのみ可能であることに注意することが重要です。このように、ジオプロセシングツールや Python スクリプトは、ArcGIS Pro SDK を使用してタスクやより大きなワークフローと統合することもできます。

• ArcGIS Pro SDK を使用して、独自のカスタム ツールとソリューションで拡張する。 最も高度なアプローチは、ArcGIS Pro SDK を使用した独自のアドイン開発です。Microsoft Visual Studio と .NET を使用して、Pro UI に直接統合された高度な ArcGIS Pro カスタマイズを開発し、効率的なワークフローとユーザー エクスペリエンスを提供することが可能です。ArcGIS Pro SDK の開発者は、SDK プロジェクト テンプレートを基に、アドイン、構成管理、プラグイン データソース、CoreHost アプリケーションのいずれかの ArcGIS Pro 拡張パターンを選択し開発することができます。各パターンについては、次のセクションで説明します。

上記のカスタマイズ オプションでは、それぞれで実装上のトレードオフがあります。たとえば、より簡単な「構成」オプションは、タスクの使用など、いくつかの構成ステップでコア、すぐに使えるツールを活用します。この方法は、実装と保守がより簡単かつ迅速に行える可能性があります。時には、タスク内の一連のステップで構成された、コアですぐに使えるツールのセットを使用することが、必要なことのすべてかもしれません。プロジェクトの観点からは、このアプローチは、プログラミングや開発の時間が不要なため、通常、実装と維持が最も簡単です。ArcGIS Pro の将来のアップグレードでは、カスタムコードの変更を考慮する必要がないため、通常、手直しは不要です。また、構成は、小規模なチームが迅速に着手し、ワークフローの手順と製品がソリューションに本当に必要であるかどうかを確認し、後で改善を検討するための簡単な方法となり得ます。

ワークフローの使用頻度が高い場合や、複雑なステップが多い場合、ユーザーにとって使い勝手が悪くなる可能性があります。ユーザーは、より速く、より自動化された方法でタスクを完了することができる、よりカスタマイズされたソリューションを好むかもしれません。このような場合には、Python やジオプロセシングを使用してステップを自動化したり、ArcGIS Pro SDK を使用してカスタム アドインを開発することを検討する良い機会です。

しかし、マップやシーンなどとのインタラクションを伴う新しい ArcGIS Pro ツールが必要で、基本的な構成と自動化を超える場合、または ArcGIS Pro UI のカスタマイズが必要な場合は、ArcGIS Pro SDK を使用して ArcGIS Pro を拡張することを検討する必要があります。SDK を使用してアドインを開発することは、精度と生産性の面で優れた選択肢となり得ます。 また、ArcGIS Pro の UI を一貫して改良または合理化し、新しい独自の機能や時間節約につながる機能を提供したい場合、アドインが非常に有益な手段となります。

ArcGIS Pro SDK は、ArcGIS 10.0 で初めて導入されたアドイン拡張パターンに基づいており、最新の .NET 機能とパターンを活用しています。 SDK を使用して構築できる ArcGIS Pro の拡張パターンは 4 つあります。

• モジュール アドイン (.esriAddinX ファイル) - 新しいツールや機能を構築するための広範な ArcGIS Pro カスタマイゼーション機能を提供します。これらのカスタマイズは、簡単に共有およびインストールできる単一の圧縮された zip ファイルにパッケージ化されています。

• 構成管理 (.proConfigX ファイル) - 従来のモジュール アドインのすべての機能に加えて、ArcGIS Pro UI とユーザーエクスペリエンスの追加カスタマイズを提供します。

• プラグイン データソース (.esriPlugin) - 開発者が ArcGIS Pro とカスタム データソースの統合を構築できるようにする特化型パターンです。

• CoreHost アプリケーション (.exe) - 64 ビットのジオデータベースとジオメトリにアクセスするための ArcGIS Pro アセンブリのサブセットを使用して、スタンドアロンの WPF およびコンソール アプリケーションを構築するための、もう 1 つの特別なパターンです。

それでは、それぞれのパターンを見ていきましょう。

モジュール アドインは、開発者に柔軟性と多くの機能を提供するため、最も人気のある拡張パターンです。アドイン パターンを使用して、ArcGIS Pro API、ジオプロセシング ツールにアクセスするカスタム機能を持つ新しいツールやコマンドを作成したり、カスタム タブや追加/移動/削除ツールを作成して ArcGIS Pro リボンを変更したり、ArcGIS Pro のワークフローをより効率的にすることができます。

モジュール アドインの開発については、ProConcepts: フレームワーク ドキュメントで、新規開発者向けに基礎となるコンセプトが紹介されています。 アドインは通常、特定のツールまたはツールセット、特定の UI カスタマイズ、カスタム ワークフローなど、より焦点を絞った機能を目的としています。

アドインがもたらす可能性

• 強力で、ユーザーが求めているもののほとんどを提供することができます。
• 開発者は、新しいカスタム ツール、ボタン、ペインを構築することにより、UI をカスタマイズすることができます。
• .NET を使用したカスタム プロセスの構築
• サードパーティー ライブラリーの統合

QA Review Tool SDK サンプル のスクリーンショット

より専門的な SDK のパターンを使用する場合の考慮事項。

• ArcGIS Pro のスタートアップ プロセスを完全に制御する必要がある場合 >> 構成管理を検討
• レイヤーまたはテーブルとして使用したいデータフォーマットがある場合 >> プラグイン データソースを検討
• スケジュールされたジオデータベース プロセスを実行する必要がある場合 >> CoreHost アプリケーションを検討

構成管理については、ProConcepts: 構成管理 のドキュメントで詳しく説明されています。

構成管理を使用すると、次のような利点があります。

• ArcGIS Pro UI のブランディング - カスタムのスプラッシュ画面、スタートアップ ページ、アプリケーション アイコンなど、高度にカスタマイズされた UI と ArcGIS Pro のスタートアップ ユーザー エクスペリエンスを作成することができます。
• 条件/ロールベースのカスタマイズ - ArcGIS Pro のスタートアップ エクスペリエンスにロジックを組み込んで、条件、ログインなどに基づいて ArcGIS Pro の UI リボンを調整することができます。
• アドイン機能 - 設定により、アドインの標準的なカスタマイズ機能が提供されます。
• アドインのコントロール - ArcGIS Pro でどのように、どのアドインを読み込むかを選択できます。

ConfigWithStartWizard SDK サンプルのスクリーンショット

上記の構成管理のサンプルに加え、ConfigWithMap 構成サンプル では、このパターンで可能なユニークな UI/UX 機能のすべてを開発者に提供しています。また、ArcGIS Pro のガイドも参照してください。

また、構成管理では、開発者は複数のユーザー ロールをサポートする単一の構成を提供することができます。ArcGIS Pro セッションごとに使用できる構成は 1 つだけですが、同じ ArcGIS Pro セッションに複数のアドインを含めることができます。これにより、ArcGIS Pro セッションでより柔軟な拡張性オプションを提供できます。また、構成管理ではアドインのロード順序を定義できるため、ArcGIS Pro UI でのアドインの使用方法と表示方法を別のレベルで制御することができます。

既存のアドインの機能を強化するため、または一連のアドインの機能を段階的にリリースするために、複数のアドインを使用してソリューションを実装する方法については、ProConcepts: Advanced Topics ドキュメントで説明されています。このドキュメントでは、構成の起動を制御する方法、およびレジストリ設定やデスクトップ ショートカットなど、設定を処理するためのさまざまなオプションについても説明されています。

最初の構成を作成する際の手順については、ProGuide: 構成管理 ドキュメントを参照してください。

プラグイン データソースは、ArcGIS Pro とのカスタムデータ統合を提供します。開発者はこれを使用して、独自のカスタム データセットを ArcGIS　Pro に取り込み、読み取り専用のフィーチャ レイヤーやテーブルのように使用することができます。また、プラグイン データソースにより、開発者は MySQL などのリレーショナル データベース、非リレーショナル データベース、画像ファイルや GPS データなどの独自データやファイルベースのデータストアなどのデータソースを統合することができます。

ArcGIS Pro でのデータへのアクセスは、テーブルまたはフィーチャクラスの形式で行われ、読み取り専用となります。ArcGIS Pro では、標準的な方法でデータを操作できますが、カスタム データを編集するには、ArcGIS Pro で独自のツールを開発する必要があります。

ProDataReader SDK サンプル のスクリーンショット

詳しくは、ProConcepts: Plugin Datasources および ProGuide: Plugin Datasource のドキュメントをご覧ください。

プラグイン データソースのサンプル にも解説があります。

最後のパターンは CoreHost アプリケーションで、開発者は ArcGIS Pro の Geodatabase および Geometry API 機能にアクセスするスタンドアロン コンソールおよび WPF アプリケーションを構築することができます。これらのアプリケーションを実行するには、ArcGIS Pro がマシンにインストールされている必要がありますが、.exe アプリケーションを実行して使用するために必要な ArcGIS Pro UI のインタラクションはありません。

ドキュメントに記載されているように、API アクセスは Geodatabase クラスおよび Geometry クラスへの 64 ビット アクセスを持つ ArcGIS.Core に限定されています。CoreHost アプリケーションは、スケジュールされたジオデータベースの更新ルーチンや、スタンドアロン モードでのテーブルの表示や更新に使用することができます。

CoreHostGDB SDK サンプル のスクリーンショット

情報およびリソースについては、ProConcepts: CoreHost ドキュメントを参照してください。 CoreHost アプリケーションのサンプル にも解説があります。

4つのパターンの詳細について -- ArcGIS Pro SDK の ドキュメント サイト および Developer Summit 2022 Technical Sessions の中の Approaches for Pro Extensibility セッションを参照してください。

このセクションでは、ArcGIS Pro SDK で使用されるいくつかのプログラミング パターンに関する一般的な情報およびリソースへのリンクを紹介します。

ArcGIS Pro SDK は、Microsoft .NET をベースに構築されています。 開発は Microsoft Visual Studio 統合開発環境（IDE）内で、最新のデスクトップ アプリケーション開発のための機能を提供する Windows Presentation Foundation (WPF) を使用して実行されます。WPF とともに、SDK で使用されるベストプラクティスのパターンは、Model-View-ViewModel (MVVM) です。これらのパターンは、ArcGIS Pro SDK のドキュメントとサンプルで実装方法を確認できます。

MVVM は、XAML ベースの開発でよく使われるデザイン パターンで、アドインの UI コンポーネントとデータおよびビジネス ロジックのコンポーネントを分離します。 ArcGIS Pro SDK では、MVVM を使用してカスタム ペイン、ドックペイン、ダイアログ、プロパティシート、および埋め込みコントロールを実装します。ArcGIS Pro SDK のアイテム テンプレートは、MVVM パターンに必要なコードの大部分を生成します。この Microsoft ドキュメント は、その利点について説明している良い入門書です。また、ProConcept: フレームワーク では、SDK で実装するための重要なガイダンスを提供しています。

デスクトップ アプリケーション マークアップ言語 (DAML) は、ProConcepts: フレームワーク ドキュメントで詳しく説明されています。DAML は、アドイン プロジェクトの Config.daml ファイルで定義されます。これは、ArcGIS Pro のリボンや UI に配置されるボタン、ツール、メニュー、タブ、その他のコントロールを宣言するために使用されます。ArcGIS Pro が起動すると、アイテム テンプレートからの DAML コードと、アドインの Config.daml で定義したその他の要素に基づいて、UI が更新されます。

Config.daml を使用すると、State と Conditions を使用して ArcGIS Pro UI のコンテキスト動作を開発することもできます。これらについては、ProConcepts: フレームワーク のドキュメントのセクションで紹介されており、ProGuide Code Your Own States and Conditions でウォークスルーが提供されています。

ArcGIS Pro SDK の主な機能の 1 つに非同期開発があります。従来のデスクトップ開発では、UI の応答性を維持し、優れたユーザー エクスペリエンスを構築するために、これは重要な機能であり、実装すべきパターンです。

「ProConcepts: フレームワーク」のドキュメントの ArcGIS Pro でのマルチスレッドの操作 セクションや、それをベースにした ProConcepts: ArcGIS Pro での非同期プログラミング ドキュメントが最適なリソースとなります。

QueuedTask クラス の使い方に慣れることが重要です。ほとんどのコードは QueuedTask を使用して実行され、バックグラウンドまたはワーカスレッドとも呼ばれる ArcGIS Pro のメイン CIM スレッド（MCT）上でバックグラウンドで実行されます。QueuedTask を使用して実行される機能は "キュー" に入れられ、バックグラウンドで逐次実行され、UI は反応したままです。QueuedTask 上で実行されているものは、QueuedTask 上で他のものが実行される前に完了する必要があります。この機能は、非同期で実行されますが、予測可能で連続的な順序で実行されます。

Microsoft は、非同期プログラミングについて、このドキュメント を含む多くのリソースを提供しています。

ArcGIS Pro SDK には、カスタム UI で使用できる多数のスタイル、ブラシ、およびカラーが用意されています。アドインが ArcGIS Pro に溶け込むように、可能な限り WPF UI 要素に ArcGIS Pro SDK のスタイルを使用してください。ArcGIS Pro の対応するライトまたはダーク テーマを変更すると、ArcGIS Pro スタイルは自動的に正しい配色に切り替わります。以下のリソースでは、カスタム UI でメインの WPF コントロールを ArcGIS Pro スタイルでスタイリングする際に考慮すべき詳細を説明しています。

• ProGuide: Style Guide – この ProGuide では、異なる WPF UI コントロールのそれぞれのスタイリングに関する考慮事項を説明しています。
• Esri Brushes – このページでは、Esri XAML ブラシの一覧を表示します。
• Esri Colors – このページでは、 Esri XAML カラーの一覧を表示します。
• ProGuide: Applying Custom Styles – この ProGuide では、ライトとダークの両方のテーマをサポートするカスタム スタイリングのウォークスルーを提供しています。
• Custom Styling コミュニティ サンプル – このコミュニティ サンプルでは、ライトとダークの両方のテーマをサポートするようにスタイリングされたカスタム ArcGIS Pro ユーザー コントロールを備えたドックペインを提供しています。

Esri Cartographic Information Model (CIM) は、さまざまなプロジェクトのコンポーネントを記述する情報を、保存、読み取り、参照、または開く際にどのように保持するかを文書化するために使用されるマップ コンテンツの仕様です。この仕様は JSON で表され、ArcGIS アプリケーションおよび API のマップ、シーン、レイアウト、レイヤー、シンボル、およびスタイルに使用されます。

CIM を SDK で使用する方法については、Developer Summit のテクニカル セッションの スライド と ビデオ で紹介されています。また、CIM の使用を開始する際のワークフローを説明する SDK ガイドとして、ProGuide: Templates ドキュメントがあります。 また、ArcGIS.Core.CIM Namespace in the API Reference には、CIM オブジェクトのリストが記載されています。

また、他の CIM リソースへのリンクについては、CIM リソース ドキュメントを参照してください。

アドインや設定を製品化して販売したい場合など、ライセンス方式を検討し、アドインへのアクセスを管理することが重要になる場合があります。

ArcGIS Pro アドイン開発者は、.NET で独自のライセンシング メカニズムを自由に構築することができます。また、サードパーティの .NET ライセンス コンポーネントを入手して統合することもできます。多くのサードパーティ製オプションが存在するので、調査して選択することができます。

移行に関しては、従来の Desktop アドインのためにライセンス アプローチを開発した場合、新しい ArcGIS Pro アドインにそのアプローチを活用できる可能性があります。

実装に関しては、アドイン用と構成管理用の2つのアプローチがあります。

モジュール アドイン: アドインについては、IExtensionConfig インターフェースを使用して、ArcGIS Pro リボン上のアドイン UI コンポーネントの有効化と無効化を制御する API アクセスがあります。 学習用のリソースとしては、ProGuide: License Your Add-In ドキュメント、および関連する Licensing コミュニティ サンプル があります。

構成管理: 構成管理については、起動時にライセンスチェックを行う機会を構成管理に与える OnValidateLicense オーバーライドへの API アクセスがあります。チェックが false を返した場合、アプリケーションの起動が終了し、ArcGIS Pro アプリケー ションはシャットダウンします。 詳細については、ProConcepts: 構成管理 ドキュメントを参照してください。

以下は、ArcGIS Pro SDK の使用開始と学習におけるリソースへのリンクです。

• ドキュメント - 現在ご覧になっているサイトです。ProConcept と ProGuide のドキュメント、コードスニペット、およびその他のリソース リンクについては、右側の目次を参照してください。Tips: はじめに、ProConcepts: フレームワーク のドキュメントを確認してください。

• API リファレンス - ArcGIS Pro API の完全なリファレンスです。

• チューリアル - ArcGIS Pro SDK チュートリアルは、コード サンプルを使用してアドインを構築するための簡単な手順を提供します。

• コードサンプル - すぐにコンパイルできる多くのサンプルを使用して、アドインを実行し、ベストプラクティスを理解することができます。また、サンプルを自分のプロジェクトに統合することもできます。サンプルは、ドキュメントにある SDK のトピックに従って、フレームワーク、コンテンツ、編集、ジオデータベースなど、ArcGIS Pro の機能ごとに分類されています。また、サンプルで使用するためのサンプルデータ をダウンロードしてください。サンプルを使い始めるには、こちら が参考になります。

• コードスニペット - SDK のトピックごとのコードスニペットの完全なリストです。

• FAQ - 「Migration from 10x」セクションを必ずご確認ください。

• Esri Community の ArcGIS Pro SDK グループ - Esri Community の ArcGIS Pro SDK 開発者コミュニティ スペースです。コミュニティとのコラボレーション、質問の投稿、キーワード検索による過去のスレッドの質問回答の確認ができます。また、新しい SDK の機能に関するフィードバックや要望を投稿することもできます。

• ビデオ - 過去の Esri Developer Summits の技術セッションを録画した ArcGIS Pro SDK コミュニティのプレイリストを YouTube と Esri Videos チャンネルで見ることができます。

• ブログ記事 - 左記の ArcGIS ブログと Esri Community グループには、役立つ最新情報やリソース リンクが掲載されています。

ArcGIS Pro SDK の成長は、ユーザのニーズとフィードバックによって推進されます。Esri Community の ArcGIS Pro SDK グループ を通じてフィードバックを投稿するか、ArcGIS Pro Ideas サイトに「SDK」ラベルを使用して新しいアイデアを投稿することができます。

Esri パートナーは、自社のアドイン製品を ArcGIS Marketplace に公開することができます。また、すべての ArcGIS Pro ユーザは、SDK を使用して構築された ArcGIS Pro アドインで利用可能な製品や機会に関するアイデアを得るために、このリストを探索することができます。

ArcGIS Pro を使い始めるためにトライアルが必要な場合は、無料トライアル にお申込みください。