@mapgis/webclient-leaflet-plugin
Version:
开发时需要引入MapGIS Client for JavaScript（Leaflet）开发包；其中包括必备的 CSS 文件和 JS 文件；
934 lines (299 loc) • 11.8 kB
HTML
<header id="page-title" class="page-title">
<span class="page-title-main">类名</span>
<span class="page-title-sub">Screenshot</span>
</header>
<section>
<article>
<div class="container-overview">
<div class='vertical-section'>
<div class="members">
<div class="member">
<h4 class="name" id="Screenshot">
<a class="href-link" href="#Screenshot">#</a>
<span class="code-name" id="Screenshot" style="font-size:30px">
new Screenshot<span class="signature">(options)</span>
</span>
</h4>
<div class="description">
<p>屏幕打印工具</p>
</div>
<h4>参数</h4>
<div class="table-container">
<table class="params table">
<thead>
<tr>
<th>名称</th>
<th>类型</th>
<th class="last">描述</th>
</tr>
</thead>
<tbody>
<tr class="deep-level-0">
<td class="name"><code>options</code></td>
<td class="type">
<span class="param-type">
Object
</span>
</td>
<td class="description last"><p>构造参数</p></td>
</tr>
<tr class="deep-level-1">
<td class="name"><code>sizeModes</code></td>
<td class="type">
<span class="param-type">
Array.<String>
</span>
</td>
<td class="description last"><p>目前支持 ['Current', 'A4Landscape', 'A4Portrait']</p></td>
</tr>
<tr class="deep-level-1">
<td class="name"><code>filename</code></td>
<td class="type">
<span class="param-type">
String
</span>
</td>
<td class="description last"><p>打印文件名</p></td>
</tr>
<tr class="deep-level-1">
<td class="name"><code>exportOnly</code></td>
<td class="type">
<span class="param-type">
Boolean
</span>
</td>
<td class="description last"><p>是否仅导出</p></td>
</tr>
<tr class="deep-level-1">
<td class="name"><code>hideControlContainer</code></td>
<td class="type">
<span class="param-type">
Boolean
</span>
</td>
<td class="description last"><p>隐藏控件容器</p></td>
</tr>
</tbody>
</table>
</div>
<dl class="details">
</dl>
<h5>示例</h5>
<p class="code-caption"><h7>初始化打印工具</h7></p>
<pre class="prettyprint"><code>// ES5引入方式
const { Map } = zondy
const { MapView } = zondy.leaflet
const { Screenshot } = zondy.leaflet.tool
// ES6引入方式
import { MapView, Screenshot } from "@mapgis/webclient-leaflet-plugin"
import { Map } from "@mapgis/webclient-common"
// 初始化图层管理容器
const map = new Map();
// 初始化地图视图对象
const mapView = new MapView({
// 视图id
viewId: "viewer-id",
// 图层管理容器
map: map
});
// 打印控件
const screenshot = new Screenshot({
view: mapView,
visible: true
})
// 添加控件
mapView.ui.add(screenshot)</code></pre>
</div>
</div>
</div>
</div>
<div class='vertical-section'>
<h3 id='member'>成员变量</h3>
<h4 style="margin-top: 20px;margin-bottom: 20px;">成员变量概述</h4>
<div class="table-container">
<table class="params table">
<thead>
<tr>
<th>名称</th>
<th>类型</th>
<th>描述</th>
</tr>
</thead>
<tbody>
<tr class="deep-level-0">
<td class="name"><code><a href="#filename">filename</a></code></td>
<td class="name">
<code>
</code>
</td>
<td class="name"><code><p>浏览器下载文件名</p></code></td>
</tr>
<tr class="deep-level-0">
<td class="name"><code><a href="#format">format</a></code></td>
<td class="name">
<code>
</code>
</td>
<td class="name"><code><p>打印图片类型，支持输出png、jpeg、svg格式图片</p></code></td>
</tr>
<tr class="deep-level-0">
<td class="name"><code><a href="#height">height</a></code></td>
<td class="name">
<code>
</code>
</td>
<td class="name"><code><p>图片高度</p></code></td>
</tr>
<tr class="deep-level-0">
<td class="name"><code><a href="#isDownload">isDownload</a></code></td>
<td class="name">
<code>
</code>
</td>
<td class="name"><code><p>是否下载图片</p></code></td>
</tr>
<tr class="deep-level-0">
<td class="name"><code><a href="#view">view</a></code></td>
<td class="name">
<code>
</code>
</td>
<td class="name"><code><p>视图对象</p></code></td>
</tr>
<tr class="deep-level-0">
<td class="name"><code><a href="#width">width</a></code></td>
<td class="name">
<code>
</code>
</td>
<td class="name"><code><p>图片宽度</p></code></td>
</tr>
<tr class="deep-level-0">
<td class="name"><code><a href="#x">x</a></code></td>
<td class="name">
<code>
</code>
</td>
<td class="name"><code><p>图片原点x</p></code></td>
</tr>
<tr class="deep-level-0">
<td class="name"><code><a href="#y">y</a></code></td>
<td class="name">
<code>
</code>
</td>
<td class="name"><code><p>图片原点y</p></code></td>
</tr>
</tbody>
</table>
</div>
<h4 style="margin-top: 20px;margin-bottom: 20px;">成员变量详情</h4>
<div class="members">
<div class="member">
<h4 class="name" id="filename">
<a class="href-link" href="#filename">#</a>
<span class="code-name">
filename
</span>
</h4>
<div class="description">
<p>浏览器下载文件名</p>
</div>
<dl class="details">
</dl>
</div>
<div class="member">
<h4 class="name" id="format">
<a class="href-link" href="#format">#</a>
<span class="code-name">
format
</span>
</h4>
<div class="description">
<p>打印图片类型，支持输出png、jpeg、svg格式图片</p>
</div>
<dl class="details">
</dl>
</div>
<div class="member">
<h4 class="name" id="height">
<a class="href-link" href="#height">#</a>
<span class="code-name">
height
</span>
</h4>
<div class="description">
<p>图片高度</p>
</div>
<dl class="details">
</dl>
</div>
<div class="member">
<h4 class="name" id="isDownload">
<a class="href-link" href="#isDownload">#</a>
<span class="code-name">
isDownload
</span>
</h4>
<div class="description">
<p>是否下载图片</p>
</div>
<dl class="details">
</dl>
</div>
<div class="member">
<h4 class="name" id="view">
<a class="href-link" href="#view">#</a>
<span class="code-name">
view
</span>
</h4>
<div class="description">
<p>视图对象</p>
</div>
<dl class="details">
</dl>
</div>
<div class="member">
<h4 class="name" id="width">
<a class="href-link" href="#width">#</a>
<span class="code-name">
width
</span>
</h4>
<div class="description">
<p>图片宽度</p>
</div>
<dl class="details">
</dl>
</div>
<div class="member">
<h4 class="name" id="x">
<a class="href-link" href="#x">#</a>
<span class="code-name">
x
</span>
</h4>
<div class="description">
<p>图片原点x</p>
</div>
<dl class="details">
</dl>
</div>
<div class="member">
<h4 class="name" id="y">
<a class="href-link" href="#y">#</a>
<span class="code-name">
y
</span>
</h4>
<div class="description">
<p>图片原点y</p>
</div>
<dl class="details">
</dl>
</div>
</div>
</div>
</article>
</section>