TemplateOptions

templateOptions = new TemplateOptions({
  title: "My Print",
  author: "Sam",
  copyright: "My Company",
  legendEnabled: false
});

属性概述

属性详细信息

attributionEnabled Boolean

当为 false 时，打印输出上不显示属性。这仅适用于 layout 值为 map-only 时的情况。参考授权和归属策略，了解具体的归属要求。

默认值：true

author String

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

copyright String

更多详情 如果指定的布局包含版权文本元素，则为用于版权的文本。

customTextElements Object[]

起始版本：GeoScene Maps SDK for JavaScript 4.22

使用此参数可显示来自打印服务的自定义文本元素的文本字段。

请注意，这些选项列在“高级选项”面板下

declaredClass Stringreadonly inherited

起始版本：GeoScene Maps SDK for JavaScript 4.7

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

dpi String

分辨率，单位为每英寸点数。

默认值：96

fileName String

起始版本：GeoScene Maps SDK for JavaScript 4.14

此属性仅适用于 layout 值为 map-only 时的情况。如果 layout 值不是 map-only，请参阅 title。

如果应用程序和打印服务位于同一来源，则此属性定义了可下载打印地图的文件名，以及打印输出中的地图标题。单击下载图标或文件名将下载打印的地图。

如果应用程序和打印服务不在同一来源，则此属性定义了打印输出中的地图标题。可下载打印地图的文件名将由托管打印服务的 GeoScene Enterprise 生成。单击外部链接图标或文件名将在新窗口中打开打印的地图。

forceFeatureAttributes Boolean

起始版本：GeoScene Maps SDK for JavaScript 4.8

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

默认值：false

format String

打印地图的输出格式。

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

默认值：pdf

height Number

地图高度。这仅适用于 layout 值为 map-only 时的情况。

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"

默认值：letter-ansi-a-landscape

legendEnabled Boolean

当为 false 时，打印输出上不显示图例。

默认值：true

northArrowEnabled Boolean

如果为 true，则打印输出中将包含北箭头。

默认值：false

scale Number

打印地图的地图比例。仅在 scaleEnabled 为 true 时适用。

scaleEnabled Boolean

定义打印的地图是否应保留地图比例或地图范围。当为 true 时，打印地图使用比例。当为 false 时，打印地图使用当前地图范围。

默认值：false

title String

如果指定的布局包含标题文本元素，则为用于地图标题的文本。这仅适用于 layout 值不为 map-only 的情况。对于 map-only，请参阅 fileName。

如果应用程序和打印服务位于同一来源，则此属性定义了可下载打印地图的文件名，以及打印输出中的地图标题。单击下载图标或文件名将下载打印的地图。

如果应用程序和打印服务不在同一来源，则此属性定义了打印输出中的地图标题。可下载打印地图的文件名将由托管打印服务的 GeoScene Enterprise 生成。单击外部链接图标或文件名将在新窗口中打开打印的地图。

width Number

地图宽度。这仅适用于 layout 值为 map-only 时的情况。

方法概述

方法详细说明

addHandles(handleOrHandles, groupKey)inherited

起始版本：GeoScene Maps SDK for JavaScript 4.25

添加一个或多个与对象的生命周期相关联的句柄。当对象被销毁时，将移除句柄。

// Manually manage handles
const handle = reactiveUtils.when(
  () => !view.updating,
  () => {
    wkidSelect.disabled = false;
  },
  { once: true }
);

// Handle gets removed when the object is destroyed.
this.addHandles(handle);

参数

handleOrHandles WatchHandle|WatchHandle[] 对象销毁后，标记为要移除的句柄。

groupKey * optional 标识句柄应添加到的组的键。组中的所有句柄稍后都可使用 Accessor.removeHandles() 进行删除。如果未提供键，则句柄将被添加到默认组。

hasHandles(groupKey){Boolean}inherited

起始版本：GeoScene Maps SDK for JavaScript 4.25

如果存在指定的句柄组，则返回 true。

参数

groupKey * optional 组键。

返回

类型	描述
Boolean	如果存在指定的句柄组，则返回 true。

示例

// Remove a named group of handles if they exist.
if (obj.hasHandles("watch-view-updates")) {
  obj.removeHandles("watch-view-updates");
}

removeHandles(groupKey)inherited

起始版本：GeoScene Maps SDK for JavaScript 4.25

移除对象拥有的句柄组。

参数

groupKey * optional 要移除的组键或组键的数组或集合。

示例

obj.removeHandles(); // removes handles from default group

obj.removeHandles("handle-group");
obj.removeHandles("other-handle-group");