JavaScript ArcGIS PrintTemplate.layoutOptions用法及代碼示例

基本信息

以下是所在類或對象的基本信息。

AMD: require(["esri/rest/support/PrintTemplate"], (PrintTemplate) => { /* code goes here */ });

ESM: import PrintTemplate from "@arcgis/core/rest/support/PrintTemplate";

類： esri/rest/support/PrintTemplate

繼承: PrintTemplate > Accessor

自從：用於 JavaScript 4.20 的 ArcGIS API

用法說明

PrintTemplate.layoutOptions函數(或屬性)的定義如下：

layoutOptions Object

定義布局元素。它是一個具有以下屬性的對象：

屬性：

類型	說明
titleText String	可選的如果指定的布局包含標題文本元素，則用於Map標題的文本。
authorText String	可選的如果指定的布局包含作者文本元素，則用於作者的文本。
copyrightText String	可選的如果指定的布局包含版權文本元素，則用於版權的文本。
scalebarUnit String	可選的默認值：英裏用於比例尺的單位。可能的值："Miles"\|"Kilometers"\|"Meters"\|"Feet"
legendLayers LegendLayer []	可選的 LegendLayer 的數組，包含將包含在圖例中的圖層的 ID。 GraphicsLayer 不會出現在圖例中。如果未指定 `legendLayers`，則 `legendEnabled` 為 `true` 的所有圖層(GraphicsLayer 除外)都將出現在圖例中。要指定圖例中不包含任何圖層，請設置 `legendLayer = []` 。
customTextElements Object []	可選的 name-value 對對象的數組。使用此屬性更新頁麵布局上自定義文本元素的文本。值必須是字符串。自定義文本元素必須存在於打印服務中。所有out-of-the-box 打印服務布局模板都包含一個名為`date` 的文本元素，默認情況下會使用係統日期時間填充該文本元素，但可以被覆蓋。

例子：

layoutOptions: {
  titleText: "My Print",
  authorText: "Sam",
  copyrightText: "My Company",
  scalebarUnit: "Miles",
  // the following text elements must
  // exist in the print service to appear
  customTextElements: [
    {"description": "My description"},
    {"location": "My Location"},
    {"date": "11/11/2020, 11:11:20 AM"}
  ]
}

相關用法

注：本文由純淨天空篩選整理自arcgis.com大神的英文原創作品 PrintTemplate.layoutOptions。非經特殊聲明，原始代碼版權歸原作者所有，本譯文未經允許或授權，請勿轉載或複製。