ラベル | 説明 | データ タイプ |
JSON 形式の Web マップ | Web アプリに表示されるとおりにエクスポートされるマップの状態の JSON 表現です。このテキストの形式については、ExportWebMap 仕様をご参照ください。 ArcGIS API for JavaScript を使用すると、この JSON 文字列をマップから取得できます。 | String |
出力ファイル | 出力ファイル名です。 ファイルの拡張子は、[形式] パラメーターの値によって決まります。 | File |
形式 (オプション) | 印刷用に生成されるマップ イメージの形式を指定します。
注意:出力ファイルの背景は必ず不透明になります。 | String |
テンプレート フォルダー (オプション) | テンプレートとして使用するレイアウト ページまたはレポート ページ (.pagx、.rptx、および .rptt ファイル) が格納されているフォルダーの絶対パス。 デフォルトの場所は、<install_directory>\Resources\ArcToolBox\Templates\ExportWebMapTemplates です。 | Folder |
レイアウト テンプレート (オプション) | リストから選択したテンプレートの名前、または MAP_ONLY キーワード。 MAP_ONLY を使用した場合または空の文字列を渡した場合は、出力マップにページ レイアウト要素 (タイトル、凡例、縮尺記号など) が含まれません。 | String |
レイアウト アイテム ID (オプション) | テンプレートに使用されるレイアウト アイテムのポータル ID (JSON 形式)。 形式 {"id": "<portal-id>"} を使用します。 値が指定されている場合、このパラメーターが [レイアウト テンプレート] パラメーターより優先されます。 | String |
レポート テンプレート: (オプション) | レポート テンプレートの名前。 このパラメーター値が指定されている場合、[形式] パラメーターを [PDF (Portable Document Format)] に設定する必要があります。 このパラメーターが指定されていない場合、出力ファイルにレポートは含まれません。 | String |
レポート アイテム ID (オプション) | テンプレートに使用されるレポート アイテムのポータル ID (JSON 形式)。 形式 {"id": "<portal-id>"} を使用します。 値が指定されている場合、このパラメーターが [レポート テンプレート] パラメーターより優先されます。 | String |
サマリー
Web アプリの状態 (たとえば、含まれるサービス、レイヤーの表示設定、クライアント側のグラフィックス) に基づいて、指定された対象地域の印刷可能なページ レイアウトまたは基本的なマップを返します。
使用法
このツールの入力は、Web マップ内のレイヤー、グラフィックス、およびその他の設定を表す JSON 形式のテキストです。 ExportWebMap 仕様に従って JSON を構成する必要があります。
このツールは、事前構成済みの PrintingTools サービスなど、印刷用の Web サービスに対応するために ArcGIS Server に含まれています。 ArcGIS API for JavaScript では、PrintingTools サービスを使用して、マップ印刷のための画像を生成します。
ローカル ベクター データを収容するサービス レイヤーをスワップしたり、マップ ブックを作成したりするなど、高度な印刷が必要な場合は、このツールの代わりに、Python の arcpy.mp モジュールに実装されている ConvertWebMapToArcGISProject 関数を使用してください。 Python スクリプトを Web アプリで使用できるようにするには、ArcGIS Server ジオプロセシング サービスを介してスクリプトを公開できます。 詳細については、ArcGIS Server ヘルプの「Web アプリケーションでの印刷」をご参照ください。
TIFF エクスポート形式タイプは、アルファ チャンネルで空間対応の 32 ビット .tiff ファイルを生成します。
[テンプレート フォルダー] パラメーターで指定されているフォルダーに、同じ名前の 2 つ以上のファイル (.rptt と .rptx) を含めることはできません。 これは、印刷ジョブ中に要件を満たさない出力を回避するためのものです。 レイアウト テンプレートとレポート テンプレートはおなじ名前を共有できます。
レポート テンプレートが使用または指定されている場合、出力は PDF 形式にする必要があります。
パラメーター
arcpy.server.ExportWebMap(Web_Map_as_JSON, Output_File, {Format}, {Layout_Templates_Folder}, {Layout_Template}, {Layout_Item_ID}, {Report_Template}, {Report_Item_ID})
名前 | 説明 | データ タイプ |
Web_Map_as_JSON | Web アプリに表示されるとおりにエクスポートされるマップの状態の JSON 表現です。このテキストの形式については、ExportWebMap 仕様をご参照ください。 ArcGIS API for JavaScript を使用すると、この JSON 文字列をマップから取得できます。 | String |
Output_File | 出力ファイル名です。 ファイルの拡張子は、Format パラメーターの値によって決まります。 | File |
Format (オプション) | 印刷用に生成されるマップ イメージの形式を指定します。
注意:出力ファイルの背景は必ず不透明になります。 | String |
Layout_Templates_Folder (オプション) | テンプレートとして使用するレイアウト ページまたはレポート ページ (.pagx、.rptx、および .rptt ファイル) が格納されているフォルダーの絶対パス。 デフォルトの場所は、<install_directory>\Resources\ArcToolBox\Templates\ExportWebMapTemplates です。 | Folder |
Layout_Template (オプション) | リストから選択したテンプレートの名前、または MAP_ONLY キーワード。 MAP_ONLY を使用した場合または空の文字列を渡した場合は、出力マップにページ レイアウト要素 (タイトル、凡例、縮尺記号など) が含まれません。 | String |
Layout_Item_ID (オプション) | テンプレートに使用されるレイアウト アイテムのポータル ID (JSON 形式)。 形式 {"id": "<portal-id>"} を使用します。 値が指定されている場合、このパラメーターが Layout_Template パラメーターより優先されます。 | String |
Report_Template (オプション) | レポート テンプレートの名前。 このパラメーターが指定されている場合、Format パラメーターを PDF に設定する必要があります。 このパラメーターが指定されていない場合、出力ファイルにレポートは含まれません。 | String |
Report_Item_ID (オプション) | テンプレートに使用されるレポート アイテムのポータル ID (JSON 形式)。 形式 {"id": "<portal-id>"} を使用します。 値が指定されている場合、このパラメーターが Report_Template パラメーターより優先されます。 | String |
環境
ライセンス情報
- Basic: Yes
- Standard: Yes
- Advanced: Yes