PrintTemplate

属性概述

属性详情

attributionVisible Boolean

当为 false时，属性不会显示在打印输出上。这仅适用于布局 值为 map-only 的情况。请参阅我们的许可和归属政策，了解具体的归属要求。

默认值:true

declaredClass Stringreadonly inherited

类的名称。声明的类名的格式为 geoscene.folder.className。

exportOptions Object

定义地图宽度、高度和 dpi。当 layout = 'map-only' 时需要。 有关为 exportOptions 设置的可用选项，请参阅下面的对象规范表。

属性：

width Number 可选 地图宽度。默认值为 800。如果修改了 dpi 值，那么 width 和 height 将与 dpi 变化成比例地修改。如果单独修改 width 值，则不会修改 dpi 和height 值。

height Number 可选 地图高度。默认值为 1100。如果修改了 dpi 值，那么 width 和 height 将与 dpi 变化成比例地修改。如果单独修改 height 值，则不会修改 dpi 和width 值。

dpi Number 可选 以每英寸点数为单位的分辨率。默认值为 96。如果修改了 dpi 值，那么 width 和 height 将与 dpi 变化成比例地修改。

forceFeatureAttributes Boolean

如果为 true，则要素的属性将包含在要素集合图层中，即使渲染不需要这些属性也是如此。默认情况下，它们被删除以减少请求大小。仅适用于使用要素属性的自定义打印服务，例如显示要素及其属性的表格。

默认值：false

format String

打印地图的输出格式。

可能值："pdf"|"png32"|"png8"|"jpg"|"gif"|"eps"|"svg"|"svgz"

默认值：png32

layout String

用于打印输出的布局。当值为 map-only 或为空时，输出地图将不包含任何页面布局元素（例如，标题、图例、比例尺等）。打印服务提供在可能的值中列出的现成模板。服务器管理员可以向打印服务添加其他模板。

下面列出可能值为：

值	说明
map-only	地图不包含任何布局元素。仅打印地图图像。
a3-landscape	A3 景观
a3-portrait	A3 肖像
a4-landscape	A4 景观
a4-portrait	A4 肖像
letter-ansi-a-landscape	字母 ANSI A 景观
letter-ansi-a-portrait	信件 ANSI A 肖像
tabloid-ansi-b-landscape	小报 ANSI B 景观
tabloid-ansi-b-portrait	小报 ANSI B 肖像

可能值:"map-only"|"a3-landscape"|"a3-portrait"|"a4-landscape"|"a4-portrait"|"letter-ansi-a-landscape"|"letter-ansi-a-portrait"|"tabloid-ansi-b-landscape"|"tabloid-ansi-b-portrait"

默认值：map-only

layoutOptions Object

定义布局元素。它是具有以下属性的对象：

属性：

titleText String 可选 如果指定的布局包含标题文本元素，则用于地图标题的文本。

authorText String 可选 如果指定的布局包含作者文本元素，则用于作者的文本。

copyrightText String 可选 如果指定的布局包含版权文本元素，则用于版权的文本。

scalebarUnit String 可选 默认值：Miles 用于比例尺的单位。 可能值:"Miles"|"Kilometers"|"Meters"|"Feet"

legendLayers LegendLayer[] 可选 一个图例图层数组，其中包含将包含在图例中的图层的 ID。图形图层将不会出现在图例中。如果未指定 legendLayers，则 legendEnabled 为 true 的所有图层（GraphicsLayer 除外）都将出现在图例中。要指定图例中不包含任何图层，请设置 legendLayer = []。

customTextElements Object[] 可选 一组名称-值对对象。使用此属性更新页面布局上自定义文本元素的文本。值必须为字符串。自定义文本元素必须存在于打印服务中。所有开箱即用的打印服务布局模板都包含一个名为 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"}
  ]
}

outScale Number

打印地图的可选地图比例尺。仅在 scalePreserved 为 true 时适用。如果 outScale 为 0，则打印的地图将使用输入地图的比例。

默认值:0

scalePreserved Boolean

定义打印的地图是否应保留地图比例或地图范围。如果为 true，则打印的地图将使用 outScale 属性或默认为输入地图的比例。如果为 false，则打印的地图将使用与输入地图相同的范围，因此比例可能会改变。

默认值:true

showLabels Boolean

当 true 时，标签将显示在布局上。

默认值:true