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

概要

レイアウト テンプレートの内容を JSON (JavaScript Object Notation) 形式で返します。フォルダー以下にあるレイアウト ファイル (.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 legend element available
      "customTextElements": []
    }
  },
  {
    "layoutTemplate": "MyTemplatesWithCustomTextElements",
    "pageSize": [11, 8.5],
    "pageUnits": "INCH",
    "activeDataFrameSize": [6.65, 7.34],
    "layoutOptions": {
      "hasAuthorText": false,
      "hasCopyrightText": true,
      "hasTitleText": true,
      "hasLegend": true,
      "customTextElements": [               //available list of custom text elements
        { "CityName": "Redlands" },
        { "MapCenterCoordinates": "" }
        { "SelectedParcelID": ""}
      ]  
  }
  }]

• このツールでは、関連する [Web マップのエクスポート (Export Web Map)] ツールで使用されているフォルダーの場所と同じ場所を使用する必要があります。

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

構文

GetLayoutTemplatesInfo({Layout_Templates_Folder})

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

派生した出力

名前	説明	データ タイプ
Output_JSON	JSON 形式の文字列。この文字列には、使用可能なレイアウト ファイル (*.pagx ファイル) のリストと追加情報が含まれます。詳細については、ツールの使用上のヒントをご参照ください。	String

コードのサンプル

GetLayoutTemplatesInfo (レイアウト テンプレート情報の取得) の例 (Python ウィンドウ)

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

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

環境

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

ライセンス情報

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