CustomTemplate

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

定义“打印”微件用于生成打印页面的自定义布局模板选项。虽然自定义模板可以从 GeoScene Pro 发布到门户,但自定义布局模板是在门户中定义的,可在其中根据需要添加、移除或编辑这些模板,而无需重新发布打印服务。可用于自定义的选项数量有限。

这个类的主要好处是允许开发人员以可重用的方式为首选的 formatlayout 命名,以及是否应该存在 Legend。这就是UI在门户中的外观:该类的主要优点是,它允许开发人员以可重用的方式为首选名称,并且是否应该存在。这是 UI 在门户中的外观:

Create-Print-Template

另参阅:

构造函数

new CustomTemplate(properties)
参数:
properties Object
optional

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

属性列表

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

类名。

更多信息Accessor
String更多信息

模板的说明。

更多信息CustomTemplate
String更多信息

打印地图的输出格式。

更多信息CustomTemplate
String更多信息

显示在打印微件 Select template 按钮内的文本。

更多信息CustomTemplate
String更多信息

用于打印输出的布局。

更多信息CustomTemplate
Object更多信息

定义布局元素。

更多信息CustomTemplate

属性详细说明

declaredClass Stringreadonly inherited

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

description Stringreadonly

模板的说明。

format String

打印地图的输出格式。

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

默认值:pdf
label Stringreadonly

显示在打印微件的 Select template 按钮内的文本。这是门户中定义的模板的标注。

layout Stringreadonly

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

下面列出了可能的值:

描述
map-only 地图不包含任何布局元素。仅打印地图图像。
a3-landscape A3 景观
a3-portrait A3 肖像
a4-landscape A3 肖像
a4-portrait A4 肖像
letter-ansi-a-landscape Letter ANSI A 景观
letter-ansi-a-portrait Letter ANSI A 景观
tabloid-ansi-b-landscape Tabloid ANSI B 景观
tabloid-ansi-b-portrait Tabloid 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
layoutOptions Objectreadonly

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

属性:
legend Boolean
optional

指示图例是否将包含在打印输出中。

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