レイアウト テンプレート情報の取得 (Get Layout Templates Info) (サーバー)

サマリー

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

使用法

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

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

    • ページ レイアウトのサイズと単位
    • マップ フレームのサイズ
      • レイアウト上に複数のマップ フレームがある場合は、WEBMAP_MAP_FRAME という名前のマップ フレームに関する情報だけが返されます。
    • 次のレイアウト エレメントの使用可否
      • 凡例エレメント
      • タイトル テキスト エレメント
      • 著作権テキスト エレメント
      • 作成者テキスト エレメント
      • カスタム テキスト エレメントとその名前および既存の値
      • 方位記号エレメント
      • 縮尺記号エレメント
      • エレメントのグループ化
      • ダイナミック テキスト エレメント
      • テーブル フレーム
      • チャート フレーム
    注意:

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

    JSON の出力例

    [{
      "layoutTemplate": "A4 Landscape",      //name of the layout
      "pageSize": [29.7, 21],                //page size
      "pageUnits": "CENTIMETER",             //page units
      "activeDataFrameSize": [27.75, 15.91], //size of the map frame
      "layoutOptions": {
        "hasAuthorText": true,               //is the predefined AuthorText available
        "hasCopyrightText": true,            //is the predefined CopyrightText available
        "hasTitleText": true,                //is the predefined TitleText available
        "hasLegend": true,                   //is the legend element available
        "customTextElements": []             //available list of custom text elements
        "mapSurroundInfos": [{}]             //available list of map surrounds
      }
    },
    {
      "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 マップのエクスポート (Export Web Map)] ツールで使用されているフォルダーの場所と同じ場所を使用します。

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

パラメーター

ラベル説明データ タイプ
レイアウト テンプレート フォルダー
(オプション)

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

Folder
レイアウト アイテム ID
(オプション)

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

String

派生した出力

ラベル説明データ タイプ
JSON 文字列

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

String

arcpy.server.GetLayoutTemplatesInfo({Layout_Templates_Folder}, {Layout_Item_ID})
名前説明データ タイプ
Layout_Templates_Folder
(オプション)

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

Folder
Layout_Item_ID
(オプション)

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

String

派生した出力

名前説明データ タイプ
Output_JSON

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

String

コードのサンプル

GetLayoutTemplatesInfo の例 (Python ウィンドウ)

次のスクリプトは、各レイアウトについて、メタデータの一覧を返します。

import arcpy
arcpy.server.GetLayoutTemplatesInfo(r'C:\Data\MyLayouts')

環境

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

ライセンス情報

  • Basic: Yes
  • Standard: Yes
  • Advanced: Yes

関連トピック