Class: WebPrintingJobLayoutOptions

WebPrintingJobLayoutOptions

Web 打印的布局参数类。此类用于设置 Web 地图打印的布局模板信息,包括地图的标题、作者、版权描述信息、小地图、图例、比例尺、指北针等参数。

new WebPrintingJobLayoutOptions(option)

Usage
import { WebPrintingJobLayoutOptions } from '@supermapgis/iclient-ol';

new WebPrintingJobLayoutOptions(option);
<script type="text/javascript" src="https://iclient.supermap.io/dist/openlayers/iclient-ol.js"></script>
<script>
  new ol.supermap.WebPrintingJobLayoutOptions({paramsNames});
  // 弃用的写法
  new SuperMap.WebPrintingJobLayoutOptions(option);
</script>
common/iServer/WebPrintingJobLayoutOptions.js, line 10
Name Type Description
option Object

参数。

Name Type Description
templateName string

布局模板的名称。

title string

地图主标题名称。

subTitle string

地图副标题名称。

author string

地图作者名称。

copyright string

版权描述信息。

summaryText string 可选

自定义描述信息。

time string 可选

打印时间。

littleMapOptions WebPrintingJobLittleMapOptions 可选

小地图参数类。

legendOptions WebPrintingJobLegendOptions 可选

图例参数类。

scaleBarOptions WebPrintingJobScaleBarOptions 可选

地图比例尺参数类。

northArrowOptions WebPrintingJobNorthArrowOptions 可选

地图指北针参数类。

Version:
  • 10.1.0

API Relations

As constructor parameter: WebPrintingJobParameters.

Members

authorstring

地图作者名称。

地图版权描述信息。

图例参数类。

小地图参数类。

地图指北针参数类。

地图比例尺参数类。

subTitlestring

地图副标题名称。

summaryTextstring

自定义描述信息。

templateNamestring

布局模板的名称。

timestring

打印时间

titlestring

地图主标题名称。

Methods

destroy()

common/iServer/WebPrintingJobLayoutOptions.js, line 92

释放资源,将引用资源的属性置空。