print

AMD: require(["geoscene/rest/print"], (print) => { /* 代码 */ });
ESM: import * as print from "@geoscene/core/rest/print";
Object: geoscene/rest/print
起始版本: GeoScene API for JavaScript 4.22

打印模块提供了一种executePrint方法,该方法使用 导出 Web 地图任务 生成可打印的地图版本。当您希望对用户界面进行更精细的控制时使用此类,例如,如果您希望为用户提供定义打印页面上显示内容的能力。

有关使用MAP_ONLY布局打印的更多信息,请参阅 exportOptions

使用PrintParameters设置任务的打印选项。

已知限制

不支持

版本支持

  • 使用 ArcMap 发布的任何打印服务都无法打印 CIMSymbol 。
  • 当前无法使用 GeoScene Server 2.0 或任何使用 ArcMap 发布的打印服务打印标签作为 FeatureLayer 的一部分
  • ImageryLayer 无法使用 GeoScene Server 2.0 或更早版本或使用 ArcMap 发布的任何打印服务打印。
  • VectorTileLayer 打印需要 GeoScene Server 2.0 或更高版本。
  • 打印使用 DotDensityRenderer 渲染的 图层 将使用 GeoScene Server 2.0 或更早版本在打印输出中创建图层的客户端图像。
  • 使用集群打印图层将使用 GeoScene Server 3.0 或更早版本在打印输出中创建图层的客户端图像。
  • 对于使用 GeoScene Server 2.0 打印安全 VectorTileLayers,或使用 GeoScene Server 2.0 或使用ArcMap发布的任何打印服务打印 VectorTileLayers ,打印 将为 VectorTileLayer创建客户端图像以在打印输出中使用。 这有一些与大尺寸打印质量相关的限制以及对浏览器窗口高度/宽度比的依赖性。
  • 打印MapViewWebMap的背景颜色需要 GeoScene Server 3.0 或更高版本。
  • 使用非标准 URL 打印图层(例如 URL 中没有 MapServer、FeatureServer 或 ImageServer)需要 GeoScene Server 3.1 或更高版本。
  • 使用受支持的blendMode打印图层需要 GeoScene Server 3.1 或更高版本。这是当前支持的类型列表: "color-burn", "color-dodge", "color", "darken", "difference", "exclusion", "hard-light", "hue", "lighten", "luminosity", "multiply", "normal", "overlay", "saturation", "screen", "soft-light".

需要注意的是

  • 使用 效果 打印图层将在打印输出中创建图层的客户端图像。
  • 打印服务器不直接打印 SVG 符号。相反,它们被转换为 PictureMarkerSymbols 以供显示。
  • 如果应用程序和打印服务位于同一来源,则可以使用 fileName 或 title 属性自定义可下载文件的名称。如果没有,可下载文件的名称将由托管打印服务的 GeoScene Enterprise 生成。
  • 确保打印服务器可以访问任何要打印的资源。例如,如果打印包含 PictureMarkerSymbols 的地图,打印服务器必须可以访问这些符号的 URL 才能正常工作。

方法列表

属性 返回值类型 描述 Object
Promise<PrintResponse>更多信息

使用 PrintParameters 中指定的选项向打印服务发送请求以创建地图的可打印静态图像。

更多信息print
String更多信息

请求打印服务的模式。

更多信息print

方法详细说明

execute(url, params, requestOptions){Promise<PrintResponse>}

使用 PrintParameters 中指定的选项向打印服务发送请求以创建地图的可打印静态图像。

参数:
url String

导出 Web 地图任务的 REST 端点的 URL。

定义打印选项。

requestOptions Object
optional

用于数据请求的 其他选项

返回值:
类型 描述
Promise<PrintResponse> 解析为包含生成的视图打印输出的 URL 的对象。
示例代码:
const template = new PrintTemplate({
 format: "pdf",
 exportOptions: {
   dpi: 300
 },
 layout: "a4-portrait",
 layoutOptions: {
   titleText: "Gillette Stadium",
   authorText: "Thomas"
 }
});

const params = new PrintParameters({
 view: view,
 template: template
});

execute(url, params).then(printResult).catch(printError);
getMode(url){String}

请求打印服务的模式。仅在至少发出一次打印请求后才能检查模式。

参数:
url String

导出 Web 地图任务的 REST 端点的 URL。

返回值:
类型 描述
String

返回打印请求执行的模式,“同步”或“异步”。

类型定义

PrintResponse

表示 execute() 方法的响应。

Property:
url String

URL 指向生成的视图打印输出的位置。

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