Print

"打印"微件将应用程序与 printing service 连接，以允许打印地图。它使用 GeoScene的 ExportWebMap 服务（可使用自定义布局模板进行配置）利用服务器端、高质量、完整的制图打印功能。一个提供仅显示地图，而另一个提供带有图例等的布局。"打印"微件可与 print 地图的打印件配合使用，这会生成地图的打印机版本。

"打印"微件具有两个必需的属性：view (参考 MapView) and printServiceUrl (导出 Web 地图任务的 REST 端点的 URL)。微件可在打印输出中保留地图比例或地图范围。默认情况下，地图范围将保留。请改用 TemplateOptions 来保留比例。

打印小部件为除t map-only之外的所有 layouts 打印本地化日期。如果使用自定义打印服务，则每个打印模板都支持 customTextElements 。找到的值将填充在 Advanced options.的"打印"微件中。这些值可以在"打印"构件 UI 中覆盖，也可以使用 templateCustomTextElements 属性以编程方式覆盖。

有关使用 MAP_ONLY 布局进行打印的详细信息，请参阅 exportOptions。

已知限制

有关已知限制的详细列表，请参阅 print 。

有关获得对widget样式的完全控制的信息，请参阅样式主题。

示例:

示例代码:

const print = new Print({
  view: view,
  // specify your own print service
  printServiceUrl:
     "https://www.geosceneonline.cn/server/rest/services/Utilities/PrintingTools/GPServer/Export%20Web%20Map%20Task"
});

// Adds widget below other elements in the top left corner of the view
view.ui.add(print, {
  position: "top-left"
});

构造函数

new Print(properties)

参数:

properties Object

optional

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

示例代码:

// typical usage
let print = new Print({
  view: view,
  printServiceUrl: "https://www.geosceneonline.cn/server/rest/services/Utilities/PrintingTools/GPServer/Export%20Web%20Map%20Task"
});

属性列表

可以设置、检索或监听的属性。参见使用属性。

展示继承属性

隐藏继承属性

类型	描述	类
String\|String []	更多信息指定用户可以根据打印服务中提供的选项选择的打印输出文件格式。	更多信息	Print
String\|String []	更多信息指定用户可以根据打印服务中提供的选项选择的打印输出布局。	更多信息	Print
String\|HTMLElement	更多信息包含widget的DOM元素的ID或者节点	更多信息	Widget
String	更多信息类名。	更多信息	Accessor
Collection<FileLink>	更多信息从"打印"微件导出的链接集合。	更多信息	Print
Object	更多信息此选项允许将额外参数（除 templateOptions外）传递给打印（导出 web 地图）请求。	更多信息	extraParameters
Number	更多信息指示用于"导出文件"文本的标题级别，用户可以在其中访问导出的地图打印输出。	更多信息	Print
String	更多信息 widget默认样式图标类	更多信息	Print
String	更多信息创建部件时分配给部件的唯一ID。	更多信息	Widget
Boolean	更多信息指示是否包括 defaultTemplates.	更多信息	Print
String	更多信息 widget 默认的label	更多信息	Print
Portal	更多信息可以搜索指定门户实例的locator services.	更多信息	Print
String	更多信息导出 Web 地图任务的 REST 端点的 URL。	更多信息	Print
Object []	更多信息一个对象，其中包含自定义打印服务中每个打印模板的名称/值对对象数组 `customTextElements`	更多信息	Print
TemplateOptions	更多信息定义 Print微件用于生成打印页面的布局模板选项。	更多信息	Print
MapView	更多信息对 MapView 的引用。	更多信息	Print
PrintViewModel	更多信息 widget的视图模型。	更多信息	Print
Boolean	更多信息是否显示widget	更多信息	Widget

属性详细说明

allowedFormats String|String [] 起始版本: GeoScene API for JavaScript 4.22

指定用户可以根据打印服务中提供的选项选择的打印输出文件格式。此属性可以采用字符串值或字符串值数组。

当此值为 "all" (默认值）时, 可以使用所有打印服务格式。使用字符串值数组时，将仅使用与打印服务中可用选项匹配的值。如果输入字符串值均与打印服务中可用的值不匹配,则 allowedFormats 将回退到默认行为。

默认值:"all"

示例:

TemplateOptions.format

示例代码:

const print = new Print({
  view: view,
  printServiceUrl:
         "https://www.geosceneonline.cn/server/rest/services/Utilities/PrintingTools/GPServer/Export%20Web%20Map%20Task",
  allowedFormats: ["jpg", "png8", "png32"]
});

allowedLayouts String|String [] 起始版本: GeoScene API for JavaScript 4.22

指定用户可以根据打印服务中提供的选项选择的打印输出布局。此属性可以采用字符串值或字符串值数组。

当此值为"all"（默认值）时，可以使用所有打印服务布局。使用字符串值数组时，将仅使用与打印服务中可用选项匹配的值。如果输入字符串值均与打印服务中可用的值不匹配，则, allowedLayouts 将回退到默认行为。

默认值:"all"

示例:

TemplateOptions.layout

示例代码:

const print = new Print({
  view: view,
  printServiceUrl:
         "https://www.geosceneonline.cn/server/rest/services/Utilities/PrintingTools/GPServer/Export%20Web%20Map%20Task",
  allowedLayouts: ["a3-landscape", "a3-portrait"]
});

container String|HTMLElement inherited

包含widget的DOM元素的ID或者节点。此属性只能设置一次。以下示例都是使用小部件时的有效用例。

示例代码:

// 在运行时创建HTML div元素，并将其设置为小部件的容器
const basemapGallery = new BasemapGallery({
  view: view,
  container: document.createElement("div")
});

// 添加widget 在 view的右上角
view.ui.add(basemapGallery, {
  position: "top-right"
});

// 创建 HTML div 元素 并且设置为widget的容器

const basemapGallery = new BasemapGallery({
  view: view,
  container: basemapGalleryDiv
});

// 添加widget 在 view的右上角
view.ui.add(basemapGallery, {
  position: "top-right"
});

// HTML 标签
<body>
  <div id="viewDiv"></div>
  <div id="basemapGalleryDiv"></div>
</body>

// 在添加到视图的UI时指定widget
const basemapGallery = new BasemapGallery({
  view: view
});

// 添加widget 在 view的右上角
view.ui.add(basemapGallery, {
  position: "top-right"
});

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

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

exportedLinks Collection<FileLink>readonly 起始版本: GeoScene API for JavaScript 4.22

从"打印"微件导出的链接集合。

示例代码:

require([
  "geoscene/widgets/Print",
  "geoscene/config"
], function(Print, geosceneConfig) {

  // ...

  view.when(function () {
    print = new Print({
      view: view,
      // specify your own print service
      printServiceUrl:
        "https://www.geosceneonline.cn/server/rest/services/Utilities/PrintingTools/GPServer/Export%20Web%20Map%20Task"
    });

    // Add widget to the top right corner of the view
    view.ui.add(print, "top-right");

    // use a requestInterceptor to monitor the print widget
    // for print completion
    geosceneConfig.request.interceptors.push({
      // set the `urls` property to the URL of the print service so that this
      // interceptor only applies to requests made to the print service URL
      urls: print.printServiceUrl,
      // use the AfterInterceptorCallback to interogate the exportedLinks property
      after: function(response) {
        console.log("exportedLinks: ", print.exportedLinks.items[0]);
      }
    });
  });

extraParameters Objectinner 起始版本: GeoScene API for JavaScript 4.22

此选项允许将额外参数（除templateOptions外）传递给打印（导出 web 地图）请求。

headingLevel Number 起始版本: GeoScene API for JavaScript 4.22

指示用于"导出文件"文本的标题级别，用户可以在其中访问导出的地图打印输出。默认情况下，此文本呈现为级别 3 标题(例如 <h3>Exported files</h3>)。根据小部件在应用程序中的位置，您可能需要调整此标题以获得正确的语义。这对于满足辅助功能标准非常重要。

默认值:3

示例:

Heading Elements

示例代码:

// "Exported files" will render as an <h4>
print.headingLevel = 4;

iconClass String 起始版本: GeoScene API for JavaScript 4.22

widget默认样式图标类

id String inherited

创建部件时分配给部件的唯一ID。如果不是由开发人员设置的，它将默认为容器ID 或者如果没有容器ID，那么它将自动生成

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

Indicates whether or not to include defaultTemplates.

默认值:true

示例代码:

const printWidget = new Print({
   view: view,
   includeDefaultTemplates: false,
   portal: {url: "https://www.geosceneonline.cn/sharing/"},
   container: "printDiv"
});

label String 起始版本: GeoScene API for JavaScript 4.22

widget 默认的label

portal Portal 起始版本: GeoScene API for JavaScript 4.22

可以搜索指定门户实例的 locator services。使用此属性可将此 GeoScene Portal 实例设置为搜索。这在使用 custom print template时特别有用。

如果设置了此属性，则不必设置 printServiceUrl 属性。

示例:

CustomTemplate

示例代码:

const printWidget = new Print({
   view: view,
   portal: {url: "https://www.geosceneonline.cn/sharing/"},
   container: "printDiv"
});

printServiceUrl String

导出 Web 地图任务的 REST 端点的 URL。如果设置了 portal 属性，则无需设置此属性。

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

一个对象，其中包含自定义打印服务中每个打印模板的名称/值对对象数组 customTextElements 使用此属性可以更新页面布局上自定义文本元素的文本。

"打印"微件在 GP 服务器上调用 Get Layout Templates Info 任务，以发现每个模板的可能值 customTextElements 。T任务的名称必须匹配 Get Layout Templates Info, 模板必须与 customTextElements发布，并且值必须是字符串。找到的值将填充在 Advanced options的"打印"微件中。这些值可以在"打印"小组件 UI 中覆盖，也可以使用此属性以编程方式覆盖。若要列出打印服务上可用的所有打印模板以查看哪些模板是使用 customTextElements发布的，请使用 effectiveTemplateCustomTextElements 属性。

示例代码:

const printWidget = new Print({
   view: view,
   // specify your custom print service
   printServiceUrl: "",
   // `customTextElements` are defined per print template
   // this example has one template with `customTextElements`
   templateCustomTextElements: {
      // if there were more applicable templates, then we would
      // create another object with the template name containing
      // an array of more name-value pairs
      "Landscape_TextElements": [
         // the possible values are defined in the print service
         { "headquarters": "Foxborough, Massachusetts" },
         { "division": "AFC East" },
         { "founded": "1959" }
      ]
   }
});

templateOptions TemplateOptionsautocast 起始版本: GeoScene API for JavaScript 4.22

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

示例代码:

templateOptions: {
  title: "My Print",
  author: "Sam",
  copyright: "My Company",
  legendEnabled: false
}

view MapView

对 MapView 的引用。设置此选项可将微件链接到特定视图。

viewModel PrintViewModelautocast

widget的视图模型。这是一个包含控制此小部件行为的所有逻辑（属性和方法）的类。请参阅 PrintViewModel 类以访问小组件上的所有属性和方法。

visible Boolean inherited

是否显示widget

如果为false, 小部件将不再呈现在web文档中。这可能会影响文档中其他元素或小部件的布局。例如，如果此小部件是与 view UI, 右上角关联的三个小部件中的第一个，那么当此小部件不可见时，其他小部件将重新定位。有关更多信息，请参阅CSS display 值"none".

默认值:true

示例代码:

// 在view中隐藏widget
widget.visible = false;

方法列表

展示继承方法

隐藏继承方法

返回值类型	描述	类
String	更多信息用于为widgets的`class`属性构建值的实用方法	更多信息	Widget
	更多信息销毁widget实例。	更多信息	Widget
Boolean	更多信息在实例上触发事件。	更多信息	Widget
Boolean	更多信息指示实例上是否存在与提供的事件名称匹配的事件侦听器。	更多信息	Widget
Boolean	更多信息 `isFulfilled()` 可用于验证创建类的实例是否已完成(无论成功或失败)。	更多信息	Widget
Boolean	更多信息 `isRejected()` 可用于验证创建类的实例是否失败。	更多信息	Widget
Boolean	更多信息 `isResolved()` 可用于验证创建类的实例是否成功。	更多信息	Widget
Object	更多信息在实例上注册事件处理程序。	更多信息	Widget
	更多信息 Widget teardown helper.	更多信息	Widget
	更多信息这种方法主要由开发人员在实现自定义widget时使用。	更多信息	Widget
Object	更多信息这种方法主要由开发人员在实现自定义widget时使用。	更多信息	Widget
	更多信息立即将widget渲染到DOM。	更多信息	Widget
	更多信息这种方法主要由开发人员在实现自定义widget时使用。	更多信息	Widget
Promise	更多信息 `when()` 创建类的实例后，会被执行一次。	更多信息	Widget

方法详细说明

classes(classNames){String}inherited 起始版本: GeoScene API for JavaScript 4.22

用于为widget的类属性构建值的实用方法class 属性. 这有助于简化CSS类设置.

参数:

classNames String|String []|Object

repeatable

class 类名称

返回值:

类型	描述
String	The computed class name.

示例:

Guide - Widget development (rendering)

示例代码:

// .tsx语法显示在渲染widget时如何设置CSS classs .

render() {
  const dynamicIconClasses = {
    [CSS.myIcon]: this.showIcon,
    [CSS.greyIcon]: !this.showIcon
  };

  return (
    <div class={classes(CSS.root, CSS.mixin, dynamicIconClasses)} />
  );
}

destroy()inherited

销毁widget实例。

emit(type, event){Boolean}inherited 起始版本: GeoScene API for JavaScript 4.22

在实例上触发事件。仅当创建此类的子类时才应使用此方法。

参数:

type String

事件名称

event Object

optional

事件负载。

返回值:

类型	描述
Boolean	如果侦听器收到通知,则为`true`

hasEventListener(type){Boolean}inherited

指示实例上是否存在与提供的事件名称匹配的事件侦听器。

参数:

type String

事件名称

返回值:

类型	描述
Boolean	如果类支持输入事件，则返回 true。

isFulfilled(){Boolean}inherited 起始版本: GeoScene API for JavaScript 4.22

isFulfilled() 可用于验证创建类的实例是否已完成(无论成功或失败)。如果已完成，将会返回true。

返回值:

类型	描述
Boolean	指示创建类的实例是否已完成（无论成功或失败）。

isRejected(){Boolean}inherited 起始版本: GeoScene API for JavaScript 4.22

isRejected() 可用于验证创建类的实例是否失败。如果失败, 将会返回 true 。

返回值:

类型	描述
Boolean	指示是否已拒绝创建类的实例。

isResolved(){Boolean}inherited 起始版本: GeoScene API for JavaScript 4.22

isResolved() 可用于验证创建类的实例是否成功。如果成功, 将会返回 true 。

返回值:

类型	描述
Boolean	指示是否已解析创建类的实例。

on(type, listener){Object}inherited

在实例上注册事件处理程序。调用此方法将事件与侦听器挂钩

参数:

type String|String []

要监听的event 或者事件数组

listener Function

事件触发时要调用的函数

返回值:

类型描述

Object

返回一个remove() 方法的事件处理程序，该方法用以停止侦听事件。

属性	类型	描述
remove	Function	当被调用时，从事件中移除监听器。

示例代码:

view.on("click", function(event){
  // event是事件触发后返回的事件句柄。
  console.log(event.mapPoint);
});

own(handles)inherited

Widget teardown helper. 当widget被销毁时，添加到它的任何句柄都将被自动删除。

参数:

handles WatchHandle|WatchHandle []

widget销毁后标记为删除的句柄。

postInitialize()inherited

这种方法主要由开发人员在实现自定义widget时使用。 在widget准备好后执行。

render(){Object}inherited

这种方法主要由开发人员在实现自定义widget时使用。 它必须由子类实现以进行渲染。

返回值:

类型	描述
Object	渲染虚拟节点。

renderNow()inherited

立即将widget渲染到DOM。

scheduleRender()inherited

这种方法主要由开发人员在实现自定义widget时使用。 计划小部件渲染。此方法对于影响UI的更改非常有用。

when(callback, errback){Promise}inherited 起始版本: GeoScene API for JavaScript 4.22

when() 创建类的实例后，会被执行一次。该方法接受两个参数： callback 函数和 errback 函数。 callback 在类的实例加载时执行。如果类的实例无法加载，则执行 errback。

参数:

callback Function

optional

当 Promise 成功时，该函数将被调用。

errback Function

optional

当 Promise 失败时，该函数将被调用。

返回值:

类型	描述
Promise	返回回调结果的新promise，可用于 chain additional functions.

示例代码:

// 尽管此示例使用 BasemapGallery widget，但任何作为 Promise 的类实例都可以以相同的方式使用 when()
let bmGallery = new BasemapGallery();
bmGallery.when(function(){
  // 当 Promise resolved 时，函数将被执行
}, function(error){
  // 当 Promise 通过 rejected 抛错时，这个函数将被执行
});

类型定义

FileLink

表示从"打印"微件的结果导出的地图请求。成功的导出将具有链接到打印输出的 URL。失败的人将提供有关错误的信息。

属性:

count Number

FileLink 元素在数组中的位置。

error String

"打印"微件中的 error

extension String

打印输出的 file 类型

name String

打印输出的 fileName或者 title

state String

打印输出的状态。"ready" or "pending" or "error".

url String

打印输出的printServiceUrl

示例代码:

require([
  "geoscene/widgets/Print",
  "geoscene/config"
], function(Print, geosceneConfig) {

  // ...

  view.when(function () {
    print = new Print({
      view: view,
      // specify your own print service
      printServiceUrl:
        "https://www.geosceneonline.cn/server/rest/services/Utilities/PrintingTools/GPServer/Export%20Web%20Map%20Task"
    });

    // Add widget to the top right corner of the view
    view.ui.add(print, "top-right");

    // use a requestInterceptor to monitor the print widget
    // for print completion
    geosceneConfig.request.interceptors.push({
      // set the `urls` property to the URL of the print service so that this
      // interceptor only applies to requests made to the print service URL
      urls: print.printServiceUrl,
      // use the AfterInterceptorCallback to interogate the exportedLinks property
      after: function(response) {
        console.log("exportedLinks: ", print.exportedLinks.items[0]);
      }
    });
  });

Event Overview

属性	类型	描述	类
	{results: Object,results.link: Collection<FileLink>}	更多信息在打印请求完成并返回其结果时触发	更多信息	Print
	{results: Object,results.link: Collection<FileLink>}	更多信息在导出请求开始时触发，并返回对导出 link 的引用。	更多信息	Print

Event Details

complete 起始版本: GeoScene API for JavaScript 4.22

在打印请求完成并返回其结果时激发。无论导出成功还是失败，都将触发此事件。

属性:

results Object

表示打印结果的对象。

规范:

link Collection<FileLink>

表示从"打印"微件的结果导出的地图请求。

示例代码:

const printWidget = new Print();

printWidget.on("complete", function(results){
  // The results are stored in the results object
  console.log("Results of the print: ", results.link);
});

submit 起始版本: GeoScene API for JavaScript 4.22

在导出请求开始时激发，并返回对导出 link的引用。

属性:

results Object

一个对象，表示提交打印的结果。

规范:

link Collection<FileLink>

表示从"打印"微件的结果导出的地图请求。

示例代码:

const printWidget = new Print();

printWidget.on("submit", function(results){
  // The results are stored in the event object
  console.log("Results of submitting the print: ", results.link);
});

GeoScene API for JavaScript参考手册

构造函数

属性列表

属性详细说明

方法列表

方法详细说明

类型定义

Event Overview

Event Details