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。非经特殊声明，原始代码版权归原作者所有，本译文未经允许或授权，请勿转载或复制。