Skip to main content

レイアウト テンプレート情報の取得 (サーバー ツール)

サマリー

レイアウト テンプレートの内容を JSON 形式で返します。 フォルダー内にあるレイアウト ファイル (.pagx) が、レイアウト テンプレートとして使用されます。

使用法

  • このツールは、印刷サービス内のジオプロセシング タスクとして公開されるようになっています。 また、事前構成済みの PrintingTools サービスでも使用されます。

  • このツールの出力は、JSON で書式設定された文字列です。 この文字列には、利用可能な .pagx ファイルのリストと、次の情報が含まれます:

    • ページ レイアウトのサイズと単位

    • マップ フレームのサイズ

      • レイアウト上に複数のマップ フレームがある場合は、WEBMAP_MAP_FRAME という名前のマップ フレームに関する情報だけが返されます。

    • 次のレイアウト エレメントの使用可否

      • 凡例エレメント

      • タイトル テキスト エレメント

      • 著作権テキスト エレメント

      • 作成者テキスト エレメント

      • カスタム テキスト エレメントとその名前および既存の値

      • 方位記号エレメント

      • 縮尺記号エレメント

      • エレメントのグループ化

      • ダイナミック テキスト エレメント

      • テーブル フレーム

      • チャート フレーム

    注意:

    これらのサイズは、レイアウト ファイルに保存されている単位で返されます。

    JSON の出力例

    <!--```javascript [{ "layoutTemplate": "A4 Landscape", // レイアウト名 layout "pageSize": [29.7, 21], // ページ サイズ "pageUnits": "CENTIMETER", // ページ単位 "activeDataFrameSize": [27.75, 15.91], // マップ フレームのサイズ "layoutOptions": { "hasAuthorText": true, // 利用可能な定義済み AuthorText である "hasCopyrightText": true, // 利用可能な定義済み CopyrightText "hasTitleText": true, // 利用可能な定義済み TitleText "hasLegend": true, // 利用可能な凡例エレメント "customTextElements": [] // 利用可能なカスタム テキスト エレメントのリスト "mapSurroundInfos": [] // 利用可能な地図修飾のリスト } }, { "layoutTemplate": "MyTemplatesWithCustomTextElements", "pageSize": [11, 8.5], "pageUnits": "INCH", "activeDataFrameSize": [6.65, 7.34], "layoutOptions": { "hasAuthorText": false, "hasCopyrightText": true, "hasTitleText": true, "hasLegend": true, "customTextElements": [ { "CityName": "Redlands" }, { "MapCenterCoordinates": ""}, { "SelectedParcelID": ""} ], "mapSurroundInfos": [ { "name": "North Arrow", "type": "CIMMarkerNorthArrow", "visible": true } ] } }]

  • 関連する Web マップのエクスポートツールで使用されているものと同じフォルダーの場所を使用します。

  • 詳細については、ArcGIS Enterprise のヘルプにある Web アプリケーションでの印刷をご参照ください。

パラメーター

ラベル 説明 データ タイプ

レイアウト テンプレート フォルダー

(オプション)

レイアウト テンプレートとして使用されるレイアウト ファイル (.pagx) が格納されているフォルダーの絶対パス。 デフォルトの場所は、<install_directory>\Resources\ArcToolBox\Templates\ExportWebMapTemplates です。

Folder

レイアウト アイテム ID

(オプション)

テンプレートに使用されるレイアウト アイテムのポータル ID (JSON 形式)。 {"id": "<portal-id>"} 形式を使用します。

String

派生した出力

ラベル 説明 データ タイプ

JSON 文字列

JSON 形式の文字列。 この文字列には、利用可能な .pagx ファイルのリストと追加情報が含まれます。 詳細については、ツールの使用上のヒントをご参照ください。

String

環境

このツールは、ジオプロセシング環境を一切使用しません。

ライセンス情報

  • Basic: はい
  • Standard: はい
  • Advanced: はい