TemplateOptions

AMD: require(["geoscene/widgets/Print/TemplateOptions"], (TemplateOptions) => { /* 代码 */ });
ESM: import TemplateOptions from "@geoscene/core/widgets/Print/TemplateOptions";
类: geoscene/widgets/Print/TemplateOptions
继承于: TemplateOptions Accessor
起始版本: GeoScene API for JavaScript 4.22

定义 Print 微件用于生成打印页面的布局模板选项。

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

构造函数

new TemplateOptions(properties)
参数:
properties Object
optional

所有可传入构造函数的属性,请参见属性列表

属性列表

可以设置、检索或监听的属性。参见 使用属性
展示继承属性 隐藏继承属性
属性 类型 描述
Boolean更多信息

false 时,属性不显示在打印输出上。

更多信息TemplateOptions
String更多信息

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

更多信息TemplateOptions
String更多信息

如果指定的布局包含版权文本元素,则用于版权的文本。

更多信息TemplateOptions
Object[]更多信息

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

更多信息TemplateOptions
String更多信息

类名。

更多信息Accessor
String更多信息

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

更多信息TemplateOptions
String更多信息

此属性仅在 layout 值为 map-only 时适用。

更多信息TemplateOptions
Boolean更多信息

为 true 时,要素的属性将包含在要素集合图层中,即使在渲染不需要它们时也是如此。

更多信息TemplateOptions
String更多信息

打印地图的输出格式。

更多信息TemplateOptions
Number更多信息

地图高度。

更多信息TemplateOptions
String更多信息

用于打印输出的布局。

更多信息TemplateOptions
Boolean更多信息

false 时,打印输出不显示图例。

更多信息TemplateOptions
Number更多信息

打印地图的地图比例。

更多信息TemplateOptions
Boolean更多信息

定义打印的地图是否应保留地图比例或地图范围。

更多信息TemplateOptions
String更多信息

如果指定的布局包含标题文本元素,则用于地图标题的文本。

更多信息TemplateOptions
Number更多信息

地图宽度。

更多信息TemplateOptions

属性详细说明

attributionEnabled Boolean

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

默认值:true
author String

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

如果指定的布局包含版权文本元素,则用于版权的文本。

customTextElements Object[]
起始版本: GeoScene API for JavaScript 4.22

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

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

declaredClass Stringreadonly inherited
起始版本: GeoScene API for JavaScript 4.22

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

dpi String

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

默认值:96
fileName String
起始版本: GeoScene API for JavaScript 4.22

此属性仅在 layout 值为 map-only 时适用。如果 layout 值不是 map-only,请参阅 title

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

Download-Link

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

External-Link

forceFeatureAttributes Boolean
起始版本: GeoScene API for JavaScript 4.22

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

默认值:false
format String

The output format for the printed map.

可选值:"pdf"|"png32"|"png8"|"jpg"|"gif"|"eps"|"svg"|"svgz"

默认值:pdf
height Number

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

layout String

用于打印输出的布局。当值为 map-only 或为空时,输出地图不包含任何页面布局环境(例如:图例、比例尺等)。打印服务提供在可能值中列出的开箱即用模板。服务器管理员可以向打印服务添加其他模板。

下面列出了可能的值:

描述
map-only 地图不包含任何布局元素。仅打印地图图像。
a3-landscape A3 Landscape
a3-portrait A3 Portrait
a4-landscape A4 Landscape
a4-portrait A4 Portrait
letter-ansi-a-landscape Letter ANSI A Landscape
letter-ansi-a-portrait Letter ANSI A Portrait
tabloid-ansi-b-landscape Tabloid ANSI B Landscape
tabloid-ansi-b-portrait Tabloid ANSI B Portrait

可选值:"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

<p><code>false</code> 时,打印输出不显示图例。</p>

默认值:true
scale Number

The map scale of the printed map. Only applies when scaleEnabled is true.

scaleEnabled Boolean

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

默认值:false
title String

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

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

Download-Link

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

External-Link

width Number

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

Your browser is no longer supported. Please upgrade your browser for the best experience. See our browser deprecation post for more details.