@mapgis/webclient-common
Version:
mapgis ES6 format for igserver
9,958 lines • 152 kB
HTML
<header id="page-title" class="page-title">
<span class="page-title-main">类名</span>
<span class="page-title-sub">WMSLayer</span>
</header>
<section>
<article>
<div class="container-overview">
<div class='vertical-section'>
<div class="members">
<div class="member">
<h4 class="name" id="WMSLayer">
<a class="href-link" href="#WMSLayer">#</a>
<span class="code-name" id="WMSLayer" style="font-size:30px">
new WMSLayer<span class="signature">(options)</span>
</span>
</h4>
<div class="description">
<p>WMS图层,<br/>
目前二维上支持4326(包括4490,4214以及4610),3857以及EPSG支持的自定义坐标系,三维上仅支持4326(包括4490,4214以及4610)以及3857坐标系,会自动读取元信息上的坐标系,不需要用户指定,同时所有的WMS服务都支持动态投影,用户也可指定任意该服务支持的坐标系<br/>
<br>[ES5引入方式]:<br/>
zondy.layer.WMSLayer() <br/>
[ES6引入方式]:<br/>
import { WMSLayer } from "@mapgis/webclient-common" <br/>
<br/>
针对图层的操作请在图层加载完毕事件中进行<br/>
Layer.on('layerview-created', function (result) {<br/>
console.log("加载完毕:", result.layer)<br/>
});<br/>
如果不想在该事件中放入业务代码,则请确认图层资源已加载完毕后再进行操作<br/>
if(layer.loadStatus === 'loaded') {<br/>
// 你的业务逻辑<br/>
}</p>
</div>
<h4>参数</h4>
<div class="table-container">
<table class="params table">
<thead>
<tr>
<th>名称</th>
<th>类型</th>
<th style="min-width: 100px;">默认值</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="default">
</td>
<td class="description last"><p>构造参数</p></td>
</tr>
<tr class="deep-level-1">
<td class="name"><code>url</code></td>
<td class="type">
<span class="param-type">
String
</span>
</td>
<td class="default">
</td>
<td class="description last"><p>服务基地址,支持的服务如下:<br/>
1、支持MapGIS的WMS服务,格式为:http://{ip}:{port}/igs/rest/services/{ServiceName}/WMSServer,参考示例:<a href='#MapIGS'>[加载MapGIS的WMS服务]</a><br/>
2、支持ArcGIS的WMS服务,格式为:http://{ip}:{port}/arcgis/rest/services/{ServiceName}/WMSServer,参考示例:<a href='#ArcGIS'>[加载ArcGIS的WMS服务]</a></p></td>
</tr>
<tr class="deep-level-1">
<td class="name"><code>title</code></td>
<td class="type">
<span class="param-type">
String
</span>
</td>
<td class="default">
</td>
<td class="description last"><p>图层名称</p></td>
</tr>
<tr class="deep-level-1">
<td class="name"><code>spatialReference</code></td>
<td class="type">
<span class="param-type">
<a link="SpatialReference.html" onclick="getTypeHTML(event)" class="mapgis-link-name" title="SpatialReference" SpatialReference.html>SpatialReference</a>
</span>
</td>
<td class="default">
</td>
<td class="description last"><p>图层坐标系,支持4326、3857以及EPSG上的自定义坐标系,坐标系默认从元信息中获取,也可指定坐标系,
参考示例:<a href='#spatialReference'>[设置图层坐标系]</a></p></td>
</tr>
<tr class="deep-level-1">
<td class="name"><code>opacity</code></td>
<td class="type">
<span class="param-type">
Number
</span>
</td>
<td class="default">
1
</td>
<td class="description last"><p>图层透明度,0到1之间的值,0为完全透明,1为不透明,参考示例:<a href='#opacity'>[设置图层透明度]</a></p></td>
</tr>
<tr class="deep-level-1">
<td class="name"><code>visible</code></td>
<td class="type">
<span class="param-type">
Boolean
</span>
</td>
<td class="default">
true
</td>
<td class="description last"><p>图层显示或隐藏,true则显示,false则隐藏,参考示例:<a href='#visible'>[设置图层显隐]</a></p></td>
</tr>
<tr class="deep-level-1">
<td class="name"><code>imageWidth</code></td>
<td class="type">
<span class="param-type">
Number
</span>
</td>
<td class="default">
256
</td>
<td class="description last"><p>图片宽度,单位px</p></td>
</tr>
<tr class="deep-level-1">
<td class="name"><code>imageHeight</code></td>
<td class="type">
<span class="param-type">
Number
</span>
</td>
<td class="default">
256
</td>
<td class="description last"><p>图片高度,单位px</p></td>
</tr>
<tr class="deep-level-1">
<td class="name"><code>minScale</code></td>
<td class="type">
<span class="param-type">
Number
</span>
</td>
<td class="default">
0
</td>
<td class="description last"><p>最小显示比例尺,图层在视图中可见的最小比例尺。</p></td>
</tr>
<tr class="deep-level-1">
<td class="name"><code>maxScale</code></td>
<td class="type">
<span class="param-type">
Number
</span>
</td>
<td class="default">
0
</td>
<td class="description last"><p>最大显示比例尺,图层在视图中可见的最大比例尺。</p></td>
</tr>
<tr class="deep-level-1">
<td class="name"><code>imageTransparency</code></td>
<td class="type">
<span class="param-type">
Boolean
</span>
</td>
<td class="default">
true
</td>
<td class="description last"><p>图片中没有数据的地方是否透明,默认为true,即透明</p></td>
</tr>
<tr class="deep-level-1">
<td class="name"><code>clippingArea</code></td>
<td class="type">
<span class="param-type">
<a link="Polygon.html" onclick="getTypeHTML(event)" class="mapgis-link-name" title="Polygon" Polygon.html>Polygon</a>
</span>
|
<span class="param-type">
<a link="Extent.html" onclick="getTypeHTML(event)" class="mapgis-link-name" title="Extent" Extent.html>Extent</a>
</span>
|
<span class="param-type">
<a link="Circle.html" onclick="getTypeHTML(event)" class="mapgis-link-name" title="Circle" Circle.html>Circle</a>
</span>
|
<span class="param-type">
<a link="MultiPolygon.html" onclick="getTypeHTML(event)" class="mapgis-link-name" title="MultiPolygon" MultiPolygon.html>MultiPolygon</a>
</span>
|
<span class="param-type">
null
</span>
</td>
<td class="default">
null
</td>
<td class="description last"><p>图层空间裁剪范围,仅支持多多边形裁剪、多边形裁剪、矩形裁剪、圆形裁剪</p></td>
</tr>
<tr class="deep-level-1">
<td class="name"><code>sublayers</code></td>
<td class="type">
<span class="param-type">
Array
</span>
</td>
<td class="default">
[]
</td>
<td class="description last"><p>指定子图层参数,可设置子图层是否显示,若不填则显示所有子图层,若有值则只显示visible为true的子图层,<br/>
参考示例:<br/>
<a href='#SubLayers'>[1、初始化时,设置子图层显隐]</a><br/>
<a href='#SubLayers-Method'>[2、通过方法,设置子图层显隐]</a><br/>
<a href='#SubLayers-Property'>[3、通过修改子图参数,设置子图层显隐]</a></p></td>
</tr>
<tr class="deep-level-1">
<td class="name"><code>tokenKey</code></td>
<td class="type">
<span class="param-type">
String
</span>
</td>
<td class="default">
'token'
</td>
<td class="description last"><p>token名</p></td>
</tr>
<tr class="deep-level-1">
<td class="name"><code>tokenValue</code></td>
<td class="type">
<span class="param-type">
String
</span>
</td>
<td class="default">
</td>
<td class="description last"><p>token值,只有当tokenValue存在时,才会绑定token</p></td>
</tr>
</tbody>
</table>
</div>
<dl class="details">
</dl>
<div class="method-parameter columns">
<div class="column is-2"><label>绑定事件</label></div>
<div class="column is-10">
<ul>
<li><a href="#图层加载完毕事件">图层加载完毕事件</a></li>
<li><a href="#图层销毁完毕事件">图层销毁完毕事件</a></li>
<li><a href="#图层更新完毕事件">图层更新完毕事件</a></li>
<li><a href="#图层显隐更新完毕事件">图层显隐更新完毕事件</a></li>
<li><a href="#图层透明度更新完毕事件">图层透明度更新完毕事件</a></li>
<li><a href="#图层顺序更新完毕事件">图层顺序更新完毕事件</a></li>
<li><a href="#图层刷新完毕事件">图层刷新完毕事件</a></li>
<li><a href="#子图层显隐更新完毕事件">子图层显隐更新完毕事件</a></li>
</ul>
</div>
</div>
<p class="summary"><h5>支持如下方法:</h5>
<a href='#load'>[1、加载图层资源]</a><br/>
<a href='#setSubLayer'>[2、设置子图层参数]</a><br/>
<a href='#findSublayerById'>[3、根据子图层id查询图层]</a><br/>
<a href='#fromJSON'>[4、通过传入的json构造并返回一个新的几何对象]</a><br/>
<a class="mapgis-link-name" title="OGCLayer#toJSON" OGCLayer.html#toJSON><code>5、导出为json对象</code></a><br/>
<a class="mapgis-link-name" title="OGCLayer#clone" OGCLayer.html#clone><code>6、克隆几何对象</code></a></p>
<h5>示例</h5>
<p class="code-caption"><h7 id='MapIGS'>添加WMS图层示例</h7></p>
<pre class="prettyprint"><code>// ES5引入方式
const { WMSLayer } = zondy.layer
// ES6引入方式
import { WMSLayer } from "@mapgis/webclient-common"
// 初始化wms图层
const wmsLayer = new WMSLayer({
// 服务基地址
url: 'http://{ip}:{port}/igs/rest/services/{serviceName}/WMSServer'
});</code></pre>
<p class="code-caption"><h7 id='opacity'>设置图层透明度</h7></p>
<pre class="prettyprint"><code>// ES5引入方式
const { WMSLayer } = zondy.layer
// ES6引入方式
import { WMSLayer } from "@mapgis/webclient-common"
// 初始化时设置
const wmsLayer = new WMSLayer({
// 服务基地址
url: 'http://{ip}:{port}/igs/rest/services/{serviceName}/WMSServer',
// 设置透明度
opacity: 1.0
});</code></pre>
<p class="code-caption"><h7 id='visible'>显示或隐藏图层</h7></p>
<pre class="prettyprint"><code>// ES5引入方式
const { WMSLayer } = zondy.layer
// ES6引入方式
import { WMSLayer } from "@mapgis/webclient-common"
// 初始化时设置
const wmsLayer = new WMSLayer({
// 服务基地址
url: 'http://{ip}:{port}/igs/rest/services/{serviceName}/WMSServer',
// 显示或隐藏图层
visible: true
});</code></pre>
<p class="code-caption"><h7 id='spatialReference'>设置图层坐标系</h7></p>
<pre class="prettyprint"><code>// ES5引入方式
const { WMSLayer } = zondy.layer
const { SpatialReference } = zondy
// ES6引入方式
import { WMSLayer, SpatialReference } from "@mapgis/webclient-common"
// 初始化wms图层
const wmsLayer = new WMSLayer({
// 服务基地址
url: 'http://{ip}:{port}/igs/rest/services/{serviceName}/WMSServer',
// 指定图层坐标系
spatialReference: new SpatialReference({
// 坐标系的wkid,可在https://epsg.io/网站查询
wkid: 4326
})
});</code></pre>
<p class="code-caption"><h7>删除图层</h7></p>
<pre class="prettyprint"><code>map.remove(wmsLayer)</code></pre>
<p class="code-caption"><h7 id='ArcGIS'>添加ArcGIS的WMS图层示例</h7></p>
<pre class="prettyprint"><code>// ES5引入方式
const { WMSLayer } = zondy.layer
// ES6引入方式
import { WMSLayer } from "@mapgis/webclient-common"
// 初始化WMS图层
const wmsLayer = new WMSLayer({
url: 'http://219.142.81.85/arcgis/rest/services/10wanZH/MapServer/WMSServer',
// 注意一个WMS图层可能支持多个坐标系,这里指定3857坐标系
spatialReference: new zondy.SpatialReference({
wkid: 3857
})
});</code></pre>
<p class="code-caption"><h7 id='SubLayers'>初始化时,设置子图层显隐</h7></p>
<pre class="prettyprint"><code>// ES5引入方式
const { WMSLayer } = zondy.layer
// ES6引入方式
import { WMSLayer } from "@mapgis/webclient-common"
// 初始化WMS图层
const wmsLayer = new WMSLayer({
// 服务基地址
url: 'http://{ip}:{port}/igs/rest/services/{ServiceName}/WMSServer',
// 要显示的子图层,若不填,则默显示所有子图层
sublayers: [{
id: 0,
visible: true
}, {
id: 1,
visible: true
}]
});</code></pre>
<p class="code-caption"><h7 id='SubLayers-Method'>通过方法,设置子图层显隐</h7></p>
<pre class="prettyprint"><code>// ES5引入方式
const { WMSLayer } = zondy.layer
// ES6引入方式
import { WMSLayer } from "@mapgis/webclient-common"
// 初始化WMS图层
const wmsLayer = new WMSLayer({
// 服务基地址
url: 'http://{ip}:{port}/igs/rest/services/{ServiceName}/WMSServer'
});
// 通过图层id来设置显隐
wmsLayer.setSubLayer({
id: 0,
visible: false
})
// 或者通过图层名称设置显隐
wmsLayer.setSubLayer({
name: "Map_Hubei4326:t1",
visible: true
})</code></pre>
<p class="code-caption"><h7 id='SubLayers-Property'>通过修改子图参数,设置子图层显隐</h7></p>
<pre class="prettyprint"><code>// ES5引入方式
const { WMSLayer } = zondy.layer
// ES6引入方式
import { WMSLayer } from "@mapgis/webclient-common"
// 初始化WMS图层
const wmsLayer = new WMSLayer({
// 服务基地址
url: 'http://{ip}:{port}/igs/rest/services/{ServiceName}/WMSServer'
});
// 根据id获取子图层
const wmsSubLayer = wmsLayer.findSublayerById(0)
// 设置子图层显隐
wmsSubLayer.visible = false</code></pre>
</div>
</div>
</div>
</div>
<h3 class="subsection-title">继承关系</h3>
<ul>
<li><a link="OGCLayer.html" onclick="getTypeHTML(event)" class="mapgis-link-name" title="OGCLayer" OGCLayer.html>OGCLayer</a></li>
</ul>
<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="#allSublayers">allSublayers</a></code></td>
<td class="name">
<code>
<span class="param-type">
Array
</span>
</code>
</td>
<td class="name"><code><p>所有子图层对象信息</p></code></td>
</tr>
<tr class="deep-level-0">
<td class="name"><code><a href="#clippingArea">clippingArea</a></code></td>
<td class="name">
<code>
<span class="param-type">
<a link="Polygon.html" onclick="getTypeHTML(event)" class="mapgis-link-name" title="Polygon" Polygon.html>Polygon</a>
</span>
|
<span class="param-type">
<a link="Extent.html" onclick="getTypeHTML(event)" class="mapgis-link-name" title="Extent" Extent.html>Extent</a>
</span>
|
<span class="param-type">
<a link="Circle.html" onclick="getTypeHTML(event)" class="mapgis-link-name" title="Circle" Circle.html>Circle</a>
</span>
|
<span class="param-type">
<a link="MultiPolygon.html" onclick="getTypeHTML(event)" class="mapgis-link-name" title="MultiPolygon" MultiPolygon.html>MultiPolygon</a>
</span>
|
<span class="param-type">
null
</span>
</code>
</td>
<td class="name"><code><p>空间裁剪范围</p></code></td>
</tr>
<tr class="deep-level-0">
<td class="name"><code><a href="#copyright">copyright</a></code></td>
<td class="name">
<code>
<span class="param-type">
String
</span>
</code>
</td>
<td class="name"><code><p>版权所有</p></code></td>
</tr>
<tr class="deep-level-0">
<td class="name"><code><a href="#customParameters">customParameters</a></code></td>
<td class="name">
<code>
<span class="param-type">
Object
</span>
</code>
</td>
<td class="name"><code><p>自定义查询参数customParameters</p></code></td>
</tr>
<tr class="deep-level-0">
<td class="name"><code><a href="#description">description</a></code></td>
<td class="name">
<code>
<span class="param-type">
String
</span>
</code>
</td>
<td class="name"><code><p>图层描述</p></code></td>
</tr>
<tr class="deep-level-0">
<td class="name"><code><a href="#extendOptions">extendOptions</a></code></td>
<td class="name">
<code>
<span class="param-type">
Object
</span>
</code>
</td>
<td class="name"><code><p>初始化图层的额外参数,可以通过该参数传入引擎原生的构造参数</p></code></td>
</tr>
<tr class="deep-level-0">
<td class="name"><code><a href="#extendProps">extendProps</a></code></td>
<td class="name">
<code>
<span class="param-type">
Object
</span>
</code>
</td>
<td class="name"><code><p>当前图层对象上不支持的属性,二次开发用户希望挂在图层对像上的属性可以存储到该属性中</p></code></td>
</tr>
<tr class="deep-level-0">
<td class="name"><code><a href="#extent">extent</a></code></td>
<td class="name">
<code>
<span class="param-type">
<a link="Extent.html" onclick="getTypeHTML(event)" class="mapgis-link-name" title="Extent" Extent.html>Extent</a>
</span>
</code>
</td>
<td class="name"><code><p>图层范围,从服务元信息中获取</p></code></td>
</tr>
<tr class="deep-level-0">
<td class="name"><code><a href="#headers">headers</a></code></td>
<td class="name">
<code>
<span class="param-type">
String
</span>
</code>
</td>
<td class="name"><code><p>设置服务请求头</p></code></td>
</tr>
<tr class="deep-level-0">
<td class="name"><code><a href="#httpMethod">httpMethod</a></code></td>
<td class="name">
<code>
<span class="param-type">
<a link="FetchMethod.html" onclick="getTypeHTML(event)" class="mapgis-link-name" title="FetchMethod" global.html#FetchMethod>FetchMethod</a>
</span>
</code>
</td>
<td class="name"><code><p>http请求方式</p></code></td>
</tr>
<tr class="deep-level-0">
<td class="name"><code><a href="#id">id</a></code></td>
<td class="name">
<code>
<span class="param-type">
String
</span>
</code>
</td>
<td class="name"><code><p>图层id</p></code></td>
</tr>
<tr class="deep-level-0">
<td class="name"><code><a href="#imageFormat">imageFormat</a></code></td>
<td class="name">
<code>
<span class="param-type">
String
</span>
</code>
</td>
<td class="name"><code><p>图片格式</p></code></td>
</tr>
<tr class="deep-level-0">
<td class="name"><code><a href="#imageFormats">imageFormats</a></code></td>
<td class="name">
<code>
<span class="param-type">
Array
</span>
</code>
</td>
<td class="name"><code><p>图片格式数组,表示服务支持的所有图片格式</p></code></td>
</tr>
<tr class="deep-level-0">
<td class="name"><code><a href="#imageHeight">imageHeight</a></code></td>
<td class="name">
<code>
<span class="param-type">
Number
</span>
</code>
</td>
<td class="name"><code><p>图片高度,单位px</p></code></td>
</tr>
<tr class="deep-level-0">
<td class="name"><code><a href="#imageTransparency">imageTransparency</a></code></td>
<td class="name">
<code>
<span class="param-type">
Boolean
</span>
</code>
</td>
<td class="name"><code><p>图层中的非数据部分是否透明</p></code></td>
</tr>
<tr class="deep-level-0">
<td class="name"><code><a href="#imageWidth">imageWidth</a></code></td>
<td class="name">
<code>
<span class="param-type">
Number
</span>
</code>
</td>
<td class="name"><code><p>图片宽度,单位px</p></code></td>
</tr>
<tr class="deep-level-0">
<td class="name"><code><a href="#index">index</a></code></td>
<td class="name">
<code>
<span class="param-type">
Number
</span>
</code>
</td>
<td class="name"><code><p>图层顺序</p></code></td>
</tr>
<tr class="deep-level-0">
<td class="name"><code><a href="#layers">layers</a></code></td>
<td class="name">
<code>
<span class="param-type">
String
</span>
</code>
</td>
<td class="name"><code><p>WMS服务要加载的图层id,多个id以逗号分割</p></code></td>
</tr>
<tr class="deep-level-0">
<td class="name"><code><a href="#loaded">loaded</a></code></td>
<td class="name">
<code>
<span class="param-type">
Boolean
</span>
</code>
</td>
<td class="name"><code><p>是否加载完毕</p></code></td>
</tr>
<tr class="deep-level-0">
<td class="name"><code><a href="#loadStatus">loadStatus</a></code></td>
<td class="name">
<code>
<span class="param-type">
String
</span>
</code>
</td>
<td class="name"><code><p>图层加载状态</p></code></td>
</tr>
<tr class="deep-level-0">
<td class="name"><code><a href="#maxScale">maxScale</a></code></td>
<td class="name">
<code>
<span class="param-type">
Number
</span>
</code>
</td>
<td class="name"><code><p>最大显示比例尺,图层在视图中可见的最大比例尺(最放大)。如果地图被放大到超过这个比例,图层将不可见。默认值为0,0表示图层没有最大比例尺、可见性不受最大比例尺限制。maxScale应该始终小于minScale。</p></code></td>
</tr>
<tr class="deep-level-0">
<td class="name"><code><a href="#minScale">minScale</a></code></td>
<td class="name">
<code>
<span class="param-type">
Number
</span>
</code>
</td>
<td class="name"><code><p>最小显示比例尺,图层在视图中可见的最小比例尺(最缩小)。如果地图被缩小到超过这个比例,图层将不可见。默认值为0,0表示图层没有最小比例尺、可见性不受最小比例尺限制。minScale应该始终大于maxScale。</p></code></td>
</tr>
<tr class="deep-level-0">
<td class="name"><code><a href="#opacity">opacity</a></code></td>
<td class="name">
<code>
<span class="param-type">
Number
</span>
</code>
</td>
<td class="name"><code><p>图层透明度,0到1之间的值,0为完全透明,1为不透明,会触发图层更新完毕事件。IGSSceneLayer图层类型为地形时,不支持该属性。</p></code></td>
</tr>
<tr class="deep-level-0">
<td class="name"><code><a href="#spatialReference">spatialReference</a></code></td>
<td class="name">
<code>
<span class="param-type">
<a link="SpatialReference.html" onclick="getTypeHTML(event)" class="mapgis-link-name" title="SpatialReference" SpatialReference.html>SpatialReference</a>
</span>
</code>
</td>
<td class="name"><code><p>图层坐标系对象</p></code></td>
</tr>
<tr class="deep-level-0">
<td class="name"><code><a href="#spatialReferences">spatialReferences</a></code></td>
<td class="name">
<code>
<span class="param-type">
Array.<<a onclick="getTypeHTML(event)" link="SpatialReference.html">SpatialReference</a>>
</span>
</code>
</td>
<td class="name"><code><p>图层支持的所有坐标系</p></code></td>
</tr>
<tr class="deep-level-0">
<td class="name"><code><a href="#sublayers">sublayers</a></code></td>
<td class="name">
<code>
<span class="param-type">
Array
</span>
</code>
</td>
<td class="name"><code><p>用户自定义的子图层参数</p></code></td>
</tr>
<tr class="deep-level-0">
<td class="name"><code><a href="#sublayers">sublayers</a></code></td>
<td class="name">
<code>
<span class="param-type">
Array
</span>
</code>
</td>
<td class="name"><code><p>子图层对象</p></code></td>
</tr>
<tr class="deep-level-0">
<td class="name"><code><a href="#title">title</a></code></td>
<td class="name">
<code>
<span class="param-type">
String
</span>
</code>
</td>
<td class="name"><code><p>图层名称</p></code></td>
</tr>
<tr class="deep-level-0">
<td class="name"><code><a href="#tokenAttachType">tokenAttachType</a></code></td>
<td class="name">
<code>
<span class="param-type">
String
</span>
</code>
</td>
<td class="name"><code><p>token附加类型。默认psot请求优先附加到body,get请求优先附加到url末尾</p></code></td>
</tr>
<tr class="deep-level-0">
<td class="name"><code><a href="#tokenKey">tokenKey</a></code></td>
<td class="name">
<code>
<span class="param-type">
String
</span>
</code>
</td>
<td class="name"><code><p>token名</p></code></td>
</tr>
<tr class="deep-level-0">
<td class="name"><code><a href="#tokenValue">tokenValue</a></code></td>
<td class="name">
<code>
<span class="param-type">
String
</span>
</code>
</td>
<td class="name"><code><p>token值</p></code></td>
</tr>
<tr class="deep-level-0">
<td class="name"><code><a href="#type">type</a></code></td>
<td class="name">
<code>
<span class="param-type">
String
</span>
</code>
</td>
<td class="name"><code><p>图层类型</p></code></td>
</tr>
<tr class="deep-level-0">
<td class="name"><code><a href="#url">url</a></code></td>
<td class="name">
<code>
<span class="param-type">
String
</span>
</code>
</td>
<td class="name"><code><p>服务基地址</p></code></td>
</tr>
<tr class="deep-level-0">
<td class="name"><code><a href="#version">version</a></code></td>
<td class="name">
<code>
<span class="param-type">
String
</span>
</code>
</td>
<td class="name"><code><p>WMS服务版本号</p></code></td>
</tr>
<tr class="deep-level-0">
<td class="name"><code><a href="#visible">visible</a></code></td>
<td class="name">
<code>
<span class="param-type">
Number
</span>
</code>
</td>
<td class="name"><code><p>图层显示或隐藏,true则显示,false则隐藏,会触发图层更新完毕事件</p></code></td>
</tr>
</tbody>
</table>
</div>
<h4 style="margin-top: 20px;margin-bottom: 20px;">成员变量详情</h4>
<div class="members">
<div class="member">
<span class="method-parameter is-pulled-right">
<label>类型:</label>
<span class="param-type">
Array
</span>
</span>
<h4 class="name" id="allSublayers">
<a class="href-link" href="#allSublayers">#</a>
<span class="code-name">
allSublayers
</span>
</h4>
<div class="description">
<p>所有子图层对象信息</p>
</div>
<dl class="details">
</dl>
</div>
<div class="member">
<span class="method-parameter is-pulled-right">
<label>类型:</label>
<span class="param-type">
<a link="Polygon.html" onclick="getTypeHTML(event)" class="mapgis-link-name" title="Polygon" Polygon.html>Polygon</a>
</span>
|
<span class="param-type">
<a link="Extent.html" onclick="getTypeHTML(event)" class="mapgis-link-name" title="Extent" Extent.html>Extent</a>
</span>
|
<span class="param-type">
<a link="Circle.html" onclick="getTypeHTML(event)" class="mapgis-link-name" title="Circle" Circle.html>Circle</a>
</span>
|
<span class="param-type">
<a link="MultiPolygon.html" onclick="getTypeHTML(event)" class="mapgis-link-name" title="MultiPolygon" MultiPolygon.html>MultiPolygon</a>
</span>
|
<span class="param-type">
null
</span>
</span>
<h4 class="name" id="clippingArea">
<a class="href-link" href="#clippingArea">#</a>
<span class="code-name">
clippingArea
</span>
</h4>
<div class="description">
<p>空间裁剪范围</p>
</div>
<dl class="details">
</dl>
</div>
<div class="member">
<span class="method-parameter is-pulled-right">
<label>类型:</label>
<span class="param-type">
String
</span>
</span>
<h4 class="name" id="copyright">
<a class="href-link" href="#copyright">#</a>
<span class='tag'>readonly</span>
<span class="code-name">
copyright
</span>
</h4>
<div class="description">
<p>版权所有</p>
</div>
<dl class="details">
<dt class="inherited-from">Inherited From:</dt>
<dd class="inherited-from"><ul class="dummy"><li>
<a goto="copyright" link="Layer.html" onclick="getTypeHTML(event)" class="mapgis-link-name" title="Layer#copyright" Layer.html#copyright>Layer#copyright</a>
</li></ul></dd>
</dl>
</div>
<div class="member">
<span class="method-parameter is-pulled-right">
<label>类型:</label>
<span class="param-type">
Object
</span>
</span>
<h4 class="name" id="customParameters">
<a class="href-link" href="#customParameters">#</a>
<span class="code-name">
customParameters
</span>
</h4>
<div class="description">
<p>自定义查询参数customParameters</p>
</div>
<dl class="details">
<dt class="inherited-from">Inherited From:</dt>
<dd class="inherited-from"><ul class="dummy"><li>
<a goto="customParameters" link="OGCLayer.html" onclick="getTypeHTML(event)" class="mapgis-link-name" title="OGCLayer#customParameters" OGCLayer.html#customParameters>OGCLayer#customParameters</a>
</li></ul></dd>
</dl>
</div>
<div class="member">
<span class="method-parameter is-pulled-right">
<label>类型:</label>
<span class="param-type">
String
</span>
</span>
<h4 class="name" id="description">
<a class="href-link" href="#description">#</a>
<span class='tag'>readonly</span>
<span class="code-name">
description
</span>
</h4>
<div class="description">
<p>图层描述</p>
</div>
<dl class="details">
<dt class="inherited-from">Inherited From:</dt>
<dd class="inherited-from"><ul class="dummy"><li>
<a goto="description" link="Layer.html" onclick="getTypeHTML(event)" class="mapgis-link-name" title="Layer#description" Layer.html#description>Layer#description</a>
</li></ul></dd>
</dl>
</div>
<div class="member">
<span class="method-parameter is-pulled-right">
<label>类型:</label>
<span class="param-type">
Object
</span>
</span>
<h4 class="name" id="extendOptions">
<a class="href-link" href="#extendOptions">#</a>
<span class="code-name">
extendOptions
</span>
</h4>
<div class="description">
<p>初始化图层的额外参数,可以通过该参数传入引擎原生的构造参数</p>
</div>
<dl class="details">
<dt class="inherited-from">Inherited From:</dt>
<dd class="inherited-from"><ul class="dummy"><li>
<a goto="extendOptions" link="Layer.html" onclick="getTypeHTML(event)" class="mapgis-link-name" title="Layer#extendOptions" Layer.html#extendOptions>Layer#extendOptions</a>
</li></ul></dd>
<dt class="tag-default">Default Value:</dt>
<dd class="tag-default"><ul class="dummy">
<li>{}</li>
</ul></dd>
</dl>
</div>
<div class="member">
<span class="method-parameter is-pulled-right">
<label>类型:</label>
<span class="param-type">
Object
</span>
</span>
<h4 class="name" id="extendProps">
<a class="href-link" href="#extendProps">#</a>
<span class="code-name">
extendProps
</span>
</h4>
<div class="description">
<p>当前图层对象上不支持的属性,二次开发用户希望挂在图层对像上的属性可以存储到该属性中</p>
</div>
<dl class="details">
<dt class="inherited-from">Inherited From:</dt>
<dd class="inherited-from"><ul class="dummy"><li>
<a goto="extendProps" link="Layer.html" onclick="getTypeHTML(event)" class="mapgis-link-name" title="Layer#extendProps" Layer.html#extendProps>Layer#extendProps</a>
</li></ul></dd>
<dt class="tag-default">Default Value:</dt>
<dd class="tag-default"><ul class="dummy">
<li>{}</li>
</ul></dd>
</dl>
</div>
<div class="member">
<span class="method-parameter is-pulled-right">
<label>类型:</label>
<span class="param-type">
<a link="Extent.html" onclick="getTypeHTML(event)" class="mapgis-link-name" title="Extent" Extent.html>Extent</a>
</span>
</span>
<h4 class="name" id="extent">
<a class="href-link" href="#extent">#</a>
<span class='tag'>readonly</span>
<span class="code-name">
extent
</span>
</h4>
<div class="description">
<p>图层范围,从服务元信息中获取</p>
</div>
<dl class="details">
<dt class="inherited-from">Inherited From:</dt>
<dd class="inherited-from"><ul class="dummy"><li>
<a goto="extent" link="Layer.html" onclick="getTypeHTML(event)" class="mapgis-link-name" title="Layer#extent" Layer.html#extent>Layer#extent</a>
</li></ul></dd>
</dl>
</div>
<div class="member">
<span class="method-parameter is-pulled-right">
<label>类型:</label>
<span class="param-type">
String
</span>
</span>
<h4 class="name" id="headers">
<a class="href-link" href="#headers">#</a>
<span class="code-name">
headers
</span>
</h4>
<div class="description">
<p>设置服务请求头</p>
</div>
<dl class="details">
<dt class="inherited-from">Inherited From:</dt>
<dd class="inherited-from"><ul class="dummy"><li>
<a goto="headers" link="Layer.html" onclick="getTypeHTML(event)" class="mapgis-link-name" title="Layer#headers" Layer.html#headers>Layer#headers</a>
</li></ul></dd>
</dl>
</div>
<div class="member">
<span class="method-parameter is-pulled-right">
<label>类型:</label>
<span class="param-type">
<a link="FetchMethod.html" onclick="getTypeHTML(event)" class="mapgis-link-name" title="FetchMethod" global.html#FetchMethod>FetchMethod</a>
</span>
</span>
<h4 class="name" id="httpMethod">
<a class="href-link" href="#httpMethod">#</a>
<span class="code-name">
httpMethod
</span>
</h4>
<div class="description">
<p>http请求方式</p>
</div>
<dl class="details">
<dt class="inherited-from">Inherited From:</dt>
<dd class="inherited-from"><ul class="dummy"><li>
<a goto="httpMethod" link="Layer.html" onclick="getTypeHTML(event)" class="mapgis-link-name" title="Layer#httpMethod" Layer.html#httpMethod>Layer#httpMethod</a>
</li></ul></dd>
</dl>
</div>
<div class="member">
<span class="method-parameter is-pulled-right">
<label>类型:</label>
<span class="param-type">
String
</span>
</span>
<h4 class="name" id="id">
<a class="href-link" href="#id">#</a>
<span class='tag'>readonly</span>
<span class="code-name">
id
</span>
</h4>
<div class="description">
<p>图层id</p>
</div>
<dl class="details">
<dt class="inherited-from">Inherited From:</dt>
<dd class="inherited-from"><ul class="dummy"><li>
<a goto="id" link="Layer.html" onclick="getTypeHTML(event)" class="mapgis-link-name" title="Layer#id" Layer.html#id>Layer#id</a>
</li></ul></dd>
</dl>
</div>
<div class="member">
<span class="method-parameter is-pulled-right">
<label>类型:</label>
<span class="param-type">
String
</span>
</span>
<h4 class="name" id="imageFormat">
<a class="href-link" href="#imageFormat">#</a>
<span class="code-name">
imageFormat
</span>
</h4>
<div class="description">
<p>图片格式</p>
</div>
<dl class="details">
</dl>
</div>
<div class="member">
<span class="method-parameter is-pulled-right">
<label>类型:</label>
<span class="param-type">
Array
</span>
</span>
<h4 class="name" id="imageFormats">
<a class="href-link" href="#imageFormats">#</a>
<span class='tag'>readonly</span>
<span class="code-name">
imageFormats
</span>
</h4>
<div class="description">
<p>图片格式数组,表示服务支持的所有图片格式</p>
</div>
<dl class="details">
</dl>
</div>
<div class="member">
<span class="method-parameter is-pulled-right">
<label>类型:</label>
<span class="param-type">
Number
</span>
</span>
<h4 class="name" id="imageHeight">
<a class="href-link" href="#imageHeight">#</a>
<span class="code-name">
imageHeight
</span>
</h4>
<div class="description">
<p>图片高度,单位px</p>
</div>
<dl class="details">
</dl>
</div>
<div class="member">
<span class="method-parameter is-pulled-right">
<label>类型:</label>
<span class="param-type">
Boolean
</span>
</span>
<h4 class="name" id="imageTransparency">
<a class="href-link" href="#imageTransparency">#</a>
<span class="code-name">
imageTransparency
</span>
</h4>
<div class="description">
<p>图层中的非数据部分是否透明</p>
</div>
<dl class="details">
</dl>
</div>
<div class="member">
<span class="method-parameter is-pulled-right">
<label>类型:</label>
<span class="param-type">
Number
</span>
</span>
<h4 class="name" id="imageWidth">
<a class="href-link" href="#imageWidth">#</a>
<span class="code-name">
imageWidth
</span>
</h4>
<div class="description">
<p>图片宽度,单位px</p>
</div>
<dl class="details">
</dl>
</div>
<div class="member">
<span class="method-parameter is-pulled-right">
<label>类型:</label>
<span class="param-type">
Number
</span>
</span>
<h4 class="name" id="index">
<a class="href-link" href="#index">#</a>
<span class="code-name">
index
</span>
</h4>
<div class="description">
<p>图层顺序</p>
</div>
<dl class="details">
<dt class="inherited-from">Inherited From:</dt>
<dd class="inherited-from"><ul class="dummy"><li>
<a goto="index" link="Layer.html" onclick="getTypeHTML(event)" class="mapgis-link-name" title="Layer#index" Layer.html#index>Layer#index</a>
</li></ul></dd>
</dl>
</div>
<div class="member">
<span class="method-parameter is-pulled-right">
<label>类型:</label>
<span class="param-type">
String
</span>
</span>
<h4 class="name" id="layers">
<a class="href-link" href="#layers">#</a>
<span class='tag'>readonly</span>
<span class="code-name">
layers
</span>
</h4>
<div class="description">
<p>WMS服务要加载的图层id,多个id以逗号分割</p>
</div>
<dl class="details">
</dl>
</div>
<div class="member">
<span class="method-parameter is-pulled-right">
<label>类型:</label>
<span class="param-type">
Boolean
</span>
</span>
<h4 class="name" id="loaded">
<a class="href-link" href="#loaded">#</a>
<span class='tag'>readonly</span>
<span class="code-name">
loaded
</span>
</h4>
<div class="description">
<p>是否加载完毕</p>
</div>
<dl class="details">
<dt class="inherited-from">Inherited From:</dt>
<dd class="inherited-from"><ul class="dummy"><li>
<a goto="loaded" link="Layer.html" onclick="getTypeHTML(event)" class="mapgis-link-name" title="Layer#loaded" Layer.html#loaded>Layer#loaded</a>
</li></ul></dd>
<dt class="tag-default">Default Value:</dt>
<dd class="tag-default"><ul class="dummy">
<li>false</li>
</ul></dd>
</dl>
</div>
<div class="member">
<span class="method-parameter is-pulled-right">
<label>类型:</label>
<span class="param-type">
String
</span>
</span>
<h4 class="name" id="loadStatus">
<a class="href-link" href="#loadStatus">#</a>
<span class='tag'>readonly</span>
<span class="code-name">
loadStatus
</span>
</h4>
<div class="description">
<p>图层加载状态</p>
</div>
<dl class="details">
<dt class="inherited-from">Inherited From:</dt>
<dd class="inherited-from"><ul class="dummy"><li>
<a goto="loadStatus" link="Layer.html" onclick="getTypeHTML(event)" class="mapgis-link-name" title="Layer#loadStatus" Layer.html#loadStatus>Layer#loadStatus</a>
</li></ul></dd>
<dt class="tag-default">Default Value:</dt>
<dd class="tag-default"><ul class="dummy">
<li>not-loaded</li>
</ul></dd>
</dl>
</div>
<div class="member">
<span class="method-parameter is-pulled-right">
<label>类型:</label>
<span class="param-type">
Number
</span>
</span>
<h4 class="name" id="maxScale">
<a class="href-link" href="#maxScale">#</a>
<span class="code-name">
maxScale
</span>
</h4>
<div class="description">
<p>最大显示比例尺,图层在视图中可见的最大比例尺(最放大)。如果地图被放大到超过这个比例,图层将不可见。默认值为0,0表示图层没有最大比例尺、可见性不受最大比例尺限制。maxScale应该始终小于minScale。</p>
</div>
<dl class="details">
<dt class="inherited-from">Inherited From:</dt>
<dd class="inherited-from"><ul class="dummy"><li>
<a goto="maxScale" link="Layer.html" onclick="getTypeHTML(event)" class="mapgis-link-name" title="Layer#maxScale" Layer.html#maxScale>Layer#maxScale</a>
</li></ul></dd>
<dt class="tag-default">Default Value:</dt>
<dd class="tag-default"><ul class="dummy">
<li>0</li>
</ul></dd>
</dl>
</div>
<div class="member">
<span class="method-parameter is-pulled-right">
<label>类型:</label>
<span class="param-type">
Number
</span>
</span>
<h4 class="name" id="minScale">
<a class="href-link" href="#minScale">#</a>
<span class="code-name">
minScale
</span>
</h4>
<div class="description">
<p>最小显示比例尺,图层在视图中可见的最小比例尺(最缩小)。如果地图被缩小到超过这个比例,图层将不可见。默认值为0,0表示图层没有最小比例尺、可见性不受最小比例尺限制。minScale应该始终大于maxScale。</p>
</div>
<dl class="details">
<dt class="inherited-from">Inherited From:</dt>
<dd class="inherited-from"><ul class="dummy"><li>
<a goto="minScale" link="Layer.html" onclick="getTypeHTML(event)" class="mapgis-link-name" title="Layer#minScale" Layer.html#minScale>Layer#minScale</a>
</li></ul></dd>
<dt class="tag-default">Default Value:</dt>
<dd class="tag-default"><ul class="dummy">
<li>0</li>
</ul></dd>
</dl>
</div>
<div class="member">
<span class="method-parameter is-pulled-right">
<label>类型:</label>
<span class="param-type">
Number
</span>
</span>
<h4 class="name" id="opacity">
<a class="href-link" href="#opacity">#</a>
<span class="code-name">
opacity
</span>
</h4>
<div class="description">
<p>图层透明度,0到1之间的值,0为完全透明,1为不透明,会触发图层更新完毕事件。IGSSceneLayer图层类型为地形时,不支持该属性。</p>
</div>
<dl class="details">
<dt class="inherited-from">Inherited From:</dt>
<dd class="inherited-from"><ul class="dummy"><li>
<a goto="opacity" link="Layer.html" onclick="getTypeHTML(event)" class="mapgis-link-name" title="Layer#opacity" Layer.html#opacity>Layer#opacity</a>
</li></ul></dd>
</dl>
</div>
<div class="member">
<span class="method-parameter is-pulled-right">
<label>类型:</label>
<span class="param-type">
<a link="SpatialReference.html" onclick="getTypeHTML(event)" class="mapgis-link-name" title="SpatialReference" SpatialReference.html>SpatialReference</a>
</span>
</span>
<h4 class="name" id="spatialReference">
<a class="href-link" href="#spatialReference">#</a>
<span class="code-name">
spatialReference
</span>
</h4>
<div class="description">
<p>图层坐标系对象</p>
</div>
<dl class="details">
<dt class="inherited-from">Inherited From:</dt>
<dd class="inherited-from"><ul class="dummy"><li>
<a goto="spatialReference" link="Layer.html" onclick="getTypeHTML(event)" class="mapgis-link-name" title="Layer#spatialReference" Layer.html#spatialReference>Layer#spatialReference</a>
</li></ul></dd>
</dl>
</div>
<div class="member">
<span class="method-parameter is-pulled-right">
<label>类型:</label>
<span class="param-type">
Array.<<a onclick="getTypeHTML(event)" link="SpatialReference.html">SpatialReference</a>>
</span>
</span>
<h4 class="name" id="spatialReferences">
<a class="href-link" href="#spatialReferences">#</a>
<span class="code-name">
spatialReferences
</span>
</h4>
<div class="description">
<p>图层支持的所有坐标系</p>
</div>
<dl class="details">
</dl>
</div>
<div class="member">
<span class="method-parameter is-pulled-right">
<label>类型:</label>
<span class="param-type">
Array
</span>
</span>
<h4 class="name" id="sublayers">
<a class="href-link" href="#sublayers">#</a>
<span class="code-name">
sublayers
</span>
</h4>
<div class="description">
<p>用户自定义的子图层参数</p>
</div>
<dl class="details">
</dl>
</div>
<div class="member">
<span class="method-parameter is-pulled-right">
<label>类型:</label>
<span class="param-type">
Array
</span>
</span>
<h4 class="name" id="sublayers">
<a class="href-link" href="#sublayers">#</a>
<span class="code-name">
sublayers
</span>
</h4>
<div class="description">
<p>子图层对象</p>
</div>
<dl class="details">
</dl>
</div>
<div class="member">
<span class="method-parameter is-pulled-right">
<label>类型:</label>
<span class="param-type">
String
</span>
</span>
<h4 class="name" id="title">
<a class="href-link" href="#title">#</a>
<span class="code-name">
title
</span>
</h4>
<div class="description">
<p>图层名称</p>
</div>
<dl class="details">
<dt class="inherited-from">Inherited From:</dt>
<dd class="inherited-from"><ul class="dummy"><li>
<a goto="title" link="Layer.html" onclick="getTypeHTML(event)" class="mapgis-link-name" title="Layer#title" Layer.html#title>Layer#title</a>
</li></ul></dd>
</dl>
</div>
<div class="member">
<span class="method-parameter is-pulled-right">
<label>类型:</label>
<span class="param-type">
String
</span>
</span>
<h4 class="name" id="tokenAttachType">
<a class="href-link" href="#tokenAttachType">#</a>
<span class="code-name">
tokenAttachType
</span>
</h4>
<div class="description">
<p>token附加类型。默认psot请求优先附加到body,get请求优先附加到url末尾</p>
</div>
<dl class="details">
<dt class="inherited-from">Inherited From:</dt>
<dd class="inherited-from"><ul class="dummy"><li>
<a goto="tokenAttachType" link="Layer.html" onclick="getTypeHTML(event)" class="mapgis-link-name" title="Layer#tokenAttachType" Layer.html#tokenAttachType>Layer#tokenAttachType</a>
</li></ul></dd>
</dl>
</div>
<div class="member">
<span class="method-parameter is-pulled-right">
<label>类型:</label>
<span class="param-type">
String
</span>
</span>
<h4 class="name" id="tokenKey">
<a class="href-link" href="#tokenKey">#</a>
<span class="code-name">
tokenKey
</span>
</h4>
<div class="description">
<p>token名</p>
</div>
<dl class="details">
<dt class="inherited-from">Inherited From:</dt>
<dd class="inherited-from"><ul class="dummy"><li>
<a goto="tokenKey" link="Layer.html" onclick="getTypeHTML(event)" class="mapgis-link-name" title="Layer#tokenKey" Layer.html#tokenKey>Layer#tokenKey</a>
</li></ul></dd>
<dt class="tag-default">Default Value:</dt>
<dd class="tag-default"><ul class="dummy">
<li>token</li>
</ul></dd>
</dl>
</div>
<div class="member">
<span class="method-parameter is-pulled-right">
<label>类型:</label>
<span class="param-type">
String
</span>
</span>
<h4 class="name" id="tokenValue">
<a class="href-link" href="#tokenValue">#</a>
<span class="code-name">
tokenValue
</span>
</h4>
<div class="description">
<p>token值</p>
</div>
<dl class="details">
<dt class="inherited-from">Inherited From:</dt>
<dd class="inherited-from"><ul class="dummy"><li>
<a goto="tokenValue" link="Layer.html" onclick="getTypeHTML(event)" class="mapgis-link-name" title="Layer#tokenValue" Layer.html#tokenValue>Layer#tokenValue</a>
</li></ul></dd>
</dl>
</div>
<div class="member">
<span class="method-parameter is-pulled-right">
<label>类型:</label>
<span class="param-type">
String
</span>
</span>
<h4 class="name" id="type">
<a class="href-link" href="#type">#</a>
<span class='tag'>readonly</span>
<span class="code-name">
type
</span>
</h4>
<div class="description">
<p>图层类型</p>
</div>
<dl class="details">
<dt class="tag-overrides">Overrides:</dt>
<dd class="tag-overrides"><ul class="dummy"><li>
<a class="mapgis-link-name" title="OGCLayer#type" OGCLayer.html#type>OGCLayer#type</a>
</li></ul></dd>
</dl>
</div>
<div class="member">
<span class="method-parameter is-pulled-right">
<label>类型:</label>
<span class="param-type">
String
</span>
</span>
<h4 class="name" id="url">
<a class="href-link" href="#url">#</a>
<span class='tag'>readonly</span>
<span class="code-name">
url
</span>
</h4>
<div class="description">
<p>服务基地址</p>
</div>
<dl class="details">
</dl>
</div>
<div class="member">
<span class="method-parameter is-pulled-right">
<label>类型:</label>
<span class="param-type">
String
</span>
</span>
<h4 class="name" id="version">
<a class="href-link" href="#version">#</a>
<span class='tag'>readonly</span>
<span class="code-name">
version
</span>
</h4>
<div class="description">
<p>WMS服务版本号</p>
</div>
<dl class="details">
<dt class="tag-overrides">Overrides:</dt>
<dd class="tag-overrides"><ul class="dummy"><li>
<a class="mapgis-link-name" title="OGCLayer#version" OGCLayer.html#version>OGCLayer#version</a>
</li></ul></dd>
</dl>
</div>
<div class="member">
<span class="method-parameter is-pulled-right">
<label>类型:</label>
<span class="param-type">
Number
</span>
</span>
<h4 class="name" id="visible">
<a class="href-link" href="#visible">#</a>
<span class="code-name">
visible
</span>
</h4>
<div class="description">
<p>图层显示或隐藏,true则显示,false则隐藏,会触发图层更新完毕事件</p>
</div>
<dl class="details">
<dt class="inherited-from">Inherited From:</dt>
<dd class="inherited-from"><ul class="dummy"><li>
<a goto="visible" link="Layer.html" onclick="getTypeHTML(event)" class="mapgis-link-name" title="Layer#visible" Layer.html#visible>Layer#visible</a>
</li></ul></dd>
</dl>
</div>
</div>
</div>
<div class='vertical-section'>
<h3 id='function'>方法</h3>
<h4 style="margin-top: 20px;margin-bottom: 20px;">方法概述</h4>
<div class="members">
<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="#fromJSON">fromJSON</a></code></td>
<td class="name">
<code>
</code>
</td>
<td class="name"><code><p>通过传入的json构造并返回一个新的几何对象</code></td>
</tr>
<tr class="deep-level-0">
<td class="name"><code><a href="#fromServerUrl">fromServerUrl</a></code></td>
<td class="name">
<code>
<span class="param-type">
<a link="WMSLayer.html" onclick="getTypeHTML(event)" class="mapgis-link-name" title="WMSLayer" WMSLayer.html>WMSLayer</a>
</span>
</code>
</td>
<td class="name"><code><p>通过url创建图层对象</p></code></td>
</tr>
<tr class="deep-level-0">
<td class="name"><code><a href="#clone">clone</a></code></td>
<td class="name">
<code>
<span class="param-type">
<a link="Layer.html" onclick="getTypeHTML(event)" class="mapgis-link-name" title="Layer" Layer.html>Layer</a>
</span>
</code>
</td>
<td class="name"><code><p>克隆方法</p></code></td>
</tr>
<tr class="deep-level-0">
<td class="name"><code><a href="#destroy">destroy</a></code></td>
<td class="name">
<code>
<span class="param-type">
*
</span>
</code>
</td>
<td class="name"><code></code></td>
</tr>
<tr class="deep-level-0">
<td class="name"><code><a href="#findSublayerById">findSublayerById</a></code></td>
<td class="name">
<code>
<span class="param-type">
<a link="IGSVectorTileSubLayer.html" onclick="getTypeHTML(event)" class="mapgis-link-name" title="IGSVectorTileSubLayer" IGSVectorTileSubLayer.html>IGSVectorTileSubLayer</a>
</span>
</code>
</td>
<td class="name"><code><p>根据子图层id查询图层</code></td>
</tr>
<tr class="deep-level-0">
<td class="name"><code><a href="#isLoaded">isLoaded</a></code></td>
<td class="name">
<code>
<span class="param-type">
Boolean
</span>
</code>
</td>
<td class="name"><code><p>判断图层是否加载成功</p></code></td>
</tr>
<tr class="deep-level-0">
<td class="name"><code><a href="#load">load</a></code></td>
<td class="name">
<code>
</code>
</td>
<td class="name"><code><p>加载图层资源</code></td>
</tr>
<tr class="deep-level-0">
<td class="name"><code><a href="#refresh">refresh</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="#setSubLayer">setSubLayer</a></code></td>
<td class="name">
<code>
</code>
</td>
<td class="name"><code><p>通过图层名称或id来设置子图层,若找到相同图层仅会覆盖相同名称的参数,若没有则在最后新增一个</code></td>
</tr>
<tr class="deep-level-0">
<td class="name"><code><a href="#toJSON">toJSON</a></code></td>
<td class="name">
<code>
<span class="param-type">
Object
</span>
</code>
</td>
<td class="name"><code><p>转换为json对象</p></code></td>
</tr>
</tbody>
</table>
</div>
<h4 style="margin-top: 20px;margin-bottom: 20px;">方法详情</h4>
<div class="member">
<h4 class="name" id=".fromJSON">
<a class="href-link" href="#.fromJSON">#</a>
<span class='tag'>static</span>
<span class="code-name" id="fromJSON" style="font-size:30px">
fromJSON<span class="signature">(json<span class="signature-attributes">opt</span>)</span>
</span>
</h4>
<div class="description">
<p>通过传入的json构造并返回一个新的几何对象<a id='fromJSON'></a></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>json</code></td>
<td class="type">
<span class="param-type">
Object
</span>
</td>
<td class="description last"><p>JSON对象</p></td>
</tr>
</tbody>
</table>
</div>
<dl class="details">
</dl>
<h5>示例</h5>
<p class="code-caption"><h7>通过传入的json构造并返回一个新的几何对象</h7></p>
<pre class="prettyprint"><code>// ES5引入方式
const { WMSLayer } = zondy.layer
// ES6引入方式
import { WMSLayer } from "@mapgis/webclient-common"
const json = {
// 服务基地址
url: 'http://{ip}:{port}/igs/rest/services/{ServiceName}/WMSServer'
}
const wmsLayer = new WMSLayer.fromJSON(json)</code></pre>
</div>
<div class="member">
<h4 class="name" id=".fromServerUrl">
<a class="href-link" href="#.fromServerUrl">#</a>
<span class='tag'>static</span>
<span class="code-name" id="fromServerUrl" style="font-size:30px">
fromServerUrl<span class="signature">(url)</span>
</span>
</h4>
<div class="description">
<p>通过url创建图层对象</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>url</code></td>
<td class="type">
<span class="param-type">
String
</span>
</td>
<td class="description last"><p>服务基地址</p></td>
</tr>
</tbody>
</table>
</div>
<dl class="details">
</dl>
<div class='columns method-parameter'>
<div class="column is-2"><label>返回值</label></div>
<div class="column is-10">
<div class="columns">
<div class='param-desc column is-7'><p>新的图层对象</p></div>
<div class='column is-5 has-text-left'>
<label>类型: </label>
<span class="param-type">
<a link="WMSLayer.html" onclick="getTypeHTML(event)" class="mapgis-link-name" title="WMSLayer" WMSLayer.html>WMSLayer</a>
</span>
</div>
</div>
</div>
</div>
</div>
<div class="member">
<h4 class="name" id="clone">
<a class="href-link" href="#clone">#</a>
<span class="code-name" id="clone" style="font-size:30px">
clone<span class="signature">()</span>
</span>
</h4>
<div class="description">
<p>克隆方法</p>
</div>
<dl class="details">
<dt class="inherited-from">Inherited From:</dt>
<dd class="inherited-from"><ul class="dummy"><li>
<a goto="clone" link="Layer.html" onclick="getTypeHTML(event)" class="mapgis-link-name" title="Layer#clone" Layer.html#clone>Layer#clone</a>
</li></ul></dd>
</dl>
<div class='columns method-parameter'>
<div class="column is-2"><label>返回值</label></div>
<div class="column is-10">
<div class="columns">
<div class='param-desc column is-7'><p>图层</p></div>
<div class='column is-5 has-text-left'>
<label>类型: </label>
<span class="param-type">
<a link="Layer.html" onclick="getTypeHTML(event)" class="mapgis-link-name" title="Layer" Layer.html>Layer</a>
</span>
</div>
</div>
</div>
</div>
</div>
<div class="member">
<h4 class="name" id="destroy">
<a class="href-link" href="#destroy">#</a>
<span class="code-name" id="destroy" style="font-size:30px">
destroy<span class="signature">()</span>
</span>
</h4>
<dl class="details">
<dt class="inherited-from">Inherited From:</dt>
<dd class="inherited-from"><ul class="dummy"><li>
<a goto="destroy" link="Layer.html" onclick="getTypeHTML(event)" class="mapgis-link-name" title="Layer#destroy" Layer.html#destroy>Layer#destroy</a>
</li></ul></dd>
</dl>
<div class='columns method-parameter'>
<div class="column is-2"><label>返回值</label></div>
<div class="column is-10">
<div class="columns">
<div class='column is-5 has-text-left'>
<label>类型: </label>
<span class="param-type">
*
</span>
</div>
</div>
</div>
</div>
</div>
<div class="member">
<h4 class="name" id="findSublayerById">
<a class="href-link" href="#findSublayerById">#</a>
<span class="code-name" id="findSublayerById" style="font-size:30px">
findSublayerById<span class="signature">(sublayerID)</span>
</span>
</h4>
<div class="description">
<p>根据子图层id查询图层<a id='findSublayerById'></a></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>sublayerID</code></td>
<td class="type">
<span class="param-type">
String
</span>
</td>
<td class="description last"><p>图层ID</p></td>
</tr>
</tbody>
</table>
</div>
<dl class="details">
</dl>
<div class='columns method-parameter'>
<div class="column is-2"><label>返回值</label></div>
<div class="column is-10">
<div class="columns">
<div class='param-desc column is-7'><p>子图层</p></div>
<div class='column is-5 has-text-left'>
<label>类型: </label>
<span class="param-type">
<a link="IGSVectorTileSubLayer.html" onclick="getTypeHTML(event)" class="mapgis-link-name" title="IGSVectorTileSubLayer" IGSVectorTileSubLayer.html>IGSVectorTileSubLayer</a>
</span>
</div>
</div>
</div>
</div>
<h5>示例</h5>
<p class="code-caption"><h7>根据子图层id查询图层</h7></p>
<pre class="prettyprint"><code>// ES5引入方式
const { WMSLayer } = zondy.layer
// ES6引入方式
import { WMSLayer } from "@mapgis/webclient-common"
// 初始化WMS图层
const wmsLayer = new WMSLayer({
// 服务基地址
url: 'http://{ip}:{port}/igs/rest/services/{ServiceName}/WMSServer'
});
map.add(wmsLayer);
// 根据id获取子图层
const wmsSubLayer = wmsLayer.findSublayerById(0)</code></pre>
</div>
<div class="member">
<h4 class="name" id="isLoaded">
<a class="href-link" href="#isLoaded">#</a>
<span class="code-name" id="isLoaded" style="font-size:30px">
isLoaded<span class="signature">()</span>
</span>
</h4>
<div class="description">
<p>判断图层是否加载成功</p>
</div>
<dl class="details">
<dt class="inherited-from">Inherited From:</dt>
<dd class="inherited-from"><ul class="dummy"><li>
<a goto="isLoaded" link="Layer.html" onclick="getTypeHTML(event)" class="mapgis-link-name" title="Layer#isLoaded" Layer.html#isLoaded>Layer#isLoaded</a>
</li></ul></dd>
</dl>
<div class='columns method-parameter'>
<div class="column is-2"><label>返回值</label></div>
<div class="column is-10">
<div class="columns">
<div class='param-desc column is-7'><p>图层是否加载成功</p></div>
<div class='column is-5 has-text-left'>
<label>类型: </label>
<span class="param-type">
Boolean
</span>
</div>
</div>
</div>
</div>
</div>
<div class="member">
<h4 class="name" id="load">
<a class="href-link" href="#load">#</a>
<span class="code-name" id="load" style="font-size:30px">
load<span class="signature">()</span>
</span>
</h4>
<div class="description">
<p>加载图层资源<a id='load'></a></p>
</div>
<dl class="details">
</dl>
<h5>示例</h5>
<p class="code-caption"><h7>不加载图层,仅获取图层信息</h7></p>
<pre class="prettyprint"><code>// ES5引入方式
const { WMSLayer } = zondy.layer
// ES6引入方式
import { WMSLayer } from "@mapgis/webclient-common"
// 初始化图层
const wmsLayer = new WMSLayer({
// 服务基地址
url: 'http://{ip}:{port}/igs/rest/services/{serviceName}/WMSServer'
});
wmsLayer.load().then((result) => {
// 获取完图层信息
console.log(wmsLayer)
})</code></pre>
</div>
<div class="member">
<h4 class="name" id="refresh">
<a class="href-link" href="#refresh">#</a>
<span class="code-name" id="refresh" style="font-size:30px">
refresh<span class="signature">()</span>
</span>
</h4>
<div class="description">
<p>刷新图层</p>
</div>
<dl class="details">
<dt class="inherited-from">Inherited From:</dt>
<dd class="inherited-from"><ul class="dummy"><li>
<a goto="refresh" link="Layer.html" onclick="getTypeHTML(event)" class="mapgis-link-name" title="Layer#refresh" Layer.html#refresh>Layer#refresh</a>
</li></ul></dd>
</dl>
</div>
<div class="member">
<h4 class="name" id="setSubLayer">
<a class="href-link" href="#setSubLayer">#</a>
<span class="code-name" id="setSubLayer" style="font-size:30px">
setSubLayer<span class="signature">(wmsSublayer)</span>
</span>
</h4>
<div class="description">
<p>通过图层名称或id来设置子图层,若找到相同图层仅会覆盖相同名称的参数,若没有则在最后新增一个<a id='setSubLayer'></a></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>wmsSublayer</code></td>
<td class="type">
<span class="param-type">
<a link="WMSSubLayer.html" onclick="getTypeHTML(event)" class="mapgis-link-name" title="WMSSubLayer" WMSSubLayer.html>WMSSubLayer</a>
</span>
|
<span class="param-type">
Object
</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 { WMSLayer } = zondy.layer
// ES6引入方式
import { WMSLayer } from "@mapgis/webclient-common"
// 初始化WMS图层
const wmsLayer = new WMSLayer({
// 服务基地址
url: 'http://{ip}:{port}/igs/rest/services/{ServiceName}/WMSServer'
});
map.add(wmsLayer);
// 通过setSubLayer方法设置子图层显隐
// 通过图层id来设置显隐
wmsLayer.setSubLayer({
id: 0,
visible: false
})
// 或者通过图层名称设置显隐
wmsLayer.setSubLayer({
name: "Map_Hubei4326:t1",
visible: true
})</code></pre>
</div>
<div class="member">
<h4 class="name" id="toJSON">
<a class="href-link" href="#toJSON">#</a>
<span class="code-name" id="toJSON" style="font-size:30px">
toJSON<span class="signature">()</span>
</span>
</h4>
<div class="description">
<p>转换为json对象</p>
</div>
<dl class="details">
<dt class="tag-overrides">Overrides:</dt>
<dd class="tag-overrides"><ul class="dummy"><li>
<a class="mapgis-link-name" title="OGCLayer#toJSON" OGCLayer.html#toJSON>OGCLayer#toJSON</a>
</li></ul></dd>
</dl>
<div class='columns method-parameter'>
<div class="column is-2"><label>返回值</label></div>
<div class="column is-10">
<div class="columns">
<div class='param-desc column is-7'><p>json对象</p></div>
<div class='column is-5 has-text-left'>
<label>类型: </label>
<span class="param-type">
Object
</span>
</div>
</div>
</div>
</div>
</div>
</div>
</div>
<div class='vertical-section' style='margin-top: 10px'>
<h3 id='event'>事件</h3>
<h4 style="margin-top: 20px;margin-bottom: 20px;">事件概述</h4>
<div class="table-container">
<table class="params table">
<thead>
<tr>
<th>名称</th>
<th>描述</th>
</tr>
</thead>
<tbody>
<tr class="deep-level-0">
<td class="name"><code><a href="#图层刷新完毕事件">图层刷新完毕事件</a></code></td>
<td class="name"><code>图层刷新完毕事件</code></td>
</tr>
<tr class="deep-level-0">
<td class="name"><code><a href="#图层加载完毕事件">图层加载完毕事件</a></code></td>
<td class="name"><code>图层加载完毕事件</code></td>
</tr>
<tr class="deep-level-0">
<td class="name"><code><a href="#图层显隐更新完毕事件">图层显隐更新完毕事件</a></code></td>
<td class="name"><code>图层显隐更新完毕事件</code></td>
</tr>
<tr class="deep-level-0">
<td class="name"><code><a href="#图层更新完毕事件">图层更新完毕事件</a></code></td>
<td class="name"><code>图层更新完毕事件</code></td>
</tr>
<tr class="deep-level-0">
<td class="name"><code><a href="#图层透明度更新完毕事件">图层透明度更新完毕事件</a></code></td>
<td class="name"><code>图层透明度更新完毕事件</code></td>
</tr>
<tr class="deep-level-0">
<td class="name"><code><a href="#图层销毁完毕事件">图层销毁完毕事件</a></code></td>
<td class="name"><code>图层销毁完毕事件</code></td>
</tr>
<tr class="deep-level-0">
<td class="name"><code><a href="#图层顺序更新完毕事件">图层顺序更新完毕事件</a></code></td>
<td class="name"><code>图层顺序更新完毕事件</code></td>
</tr>
<tr class="deep-level-0">
<td class="name"><code><a href="#子图层显隐更新完毕事件">子图层显隐更新完毕事件</a></code></td>
<td class="name"><code>子图层显隐更新完毕事件</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="event:%E5%9B%BE%E5%B1%82%E5%88%B7%E6%96%B0%E5%AE%8C%E6%AF%95%E4%BA%8B%E4%BB%B6">
<a class="href-link" href="#event:%E5%9B%BE%E5%B1%82%E5%88%B7%E6%96%B0%E5%AE%8C%E6%AF%95%E4%BA%8B%E4%BB%B6">#</a>
<span class="code-name" id="图层刷新完毕事件" style="font-size:30px">
图层刷新完毕事件
</span>
</h4>
<div class="description">
<p>图层刷新完毕事件,请注意该事件是图层更新事件(layerview-update)的子事件</p>
</div>
<h5 class="subsection-title">属性:</h5>
<div class="table-container">
<table class="props table">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th>Attributes</th>
<th>Default</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr class="deep-level-0">
<td class="name"><code>event</code></td>
<td class="type">
<span class="param-type">
Object
</span>
</td>
<td class="attributes">
</td>
<td class="default">
</td>
<td class="description last"><p>事件对象</p></td>
</tr>
<tr class="deep-level-1">
<td class="name"><code>type</code></td>
<td class="type">
<span class="param-type">
String
</span>
</td>
<td class="attributes">
<optional><br>
</td>
<td class="default">
'layerview-update'
</td>
<td class="description last"><p>图层更新完毕事件</p></td>
</tr>
<tr class="deep-level-1">
<td class="name"><code>message</code></td>
<td class="type">
<span class="param-type">
String
</span>
</td>
<td class="attributes">
<optional><br>
</td>
<td class="default">
null
</td>
<td class="description last"><p>更新描述</p></td>
</tr>
<tr class="deep-level-1">
<td class="name"><code>updateContent</code></td>
<td class="type">
<span class="param-type">
Array.<<a onclick="getTypeHTML(event)" link="UpdateContent.html">UpdateContent</a>>
</span>
</td>
<td class="attributes">
<optional><br>
</td>
<td class="default">
null
</td>
<td class="description last"><p>更新详情对象</p></td>
</tr>
<tr class="deep-level-1">
<td class="name"><code>layer</code></td>
<td class="type">
<span class="param-type">
<a link="Layer.html" onclick="getTypeHTML(event)" class="mapgis-link-name" title="Layer" Layer.html>Layer</a>
</span>
</td>
<td class="attributes">
<optional><br>
</td>
<td class="default">
null
</td>
<td class="description last"><p>地图图层对象</p></td>
</tr>
<tr class="deep-level-1">
<td class="name"><code>layerView</code></td>
<td class="type">
<span class="param-type">
<a link="MapView.html" onclick="getTypeHTML(event)" class="mapgis-link-name" title="MapView" MapView.html>MapView</a>
</span>
</td>
<td class="attributes">
<optional><br>
</td>
<td class="default">
null
</td>
<td class="description last"><p>图层的视图对象</p></td>
</tr>
<tr class="deep-level-1">
<td class="name"><code>sourceTarget</code></td>
<td class="type">
<span class="param-type">
<a link="Layer.html" onclick="getTypeHTML(event)" class="mapgis-link-name" title="Layer" Layer.html>Layer</a>
</span>
</td>
<td class="attributes">
<optional><br>
</td>
<td class="default">
null
</td>
<td class="description last"><p>事件发起对象</p></td>
</tr>
<tr class="deep-level-1">
<td class="name"><code>target</code></td>
<td class="type">
<span class="param-type">
<a link="Map.html" onclick="getTypeHTML(event)" class="mapgis-link-name" title="Map" Map.html>Map</a>
</span>
</td>
<td class="attributes">
<optional><br>
</td>
<td class="default">
null
</td>
<td class="description last"><p>事件接收对象</p></td>
</tr>
</tbody>
</table>
</div>
<dl class="details">
<dt class="inherited-from">Inherited From:</dt>
<dd class="inherited-from"><ul class="dummy"><li>
<a goto="event:图层刷新完毕事件" link="Layer.html" onclick="getTypeHTML(event)" class="mapgis-link-name" title="Layer#event:图层刷新完毕事件" Layer.html#event:%25E5%259B%25BE%25E5%25B1%2582%25E5%2588%25B7%25E6%2596%25B0%25E5%25AE%258C%25E6%25AF%2595%25E4%25BA%258B%25E4%25BB%25B6>Layer#event:图层刷新完毕事件</a>
</li></ul></dd>
</dl>
<h5>示例</h5>
<p class="code-caption"><h5>图层刷新完毕事件</h5></p>
<pre class="prettyprint"><code>Layer.on('layerview-update', function (event) {
// 获取更新事件对象
console.log("更新完毕:", event)
// 获取更新详情数组
const updateContent = event.updateContent
// 循环数组,根据事件名进行后续操作
for (let i = 0; i < updateContent.length; i++) {
// 图层刷新完毕事件
if(updateContent[i].name === 'refresh'){
console.log("图层刷新完毕事件:", event);
}
}
});</code></pre>
</div>
<div class="member">
<h4 class="name" id="event:%E5%9B%BE%E5%B1%82%E5%8A%A0%E8%BD%BD%E5%AE%8C%E6%AF%95%E4%BA%8B%E4%BB%B6">
<a class="href-link" href="#event:%E5%9B%BE%E5%B1%82%E5%8A%A0%E8%BD%BD%E5%AE%8C%E6%AF%95%E4%BA%8B%E4%BB%B6">#</a>
<span class="code-name" id="图层加载完毕事件" style="font-size:30px">
图层加载完毕事件
</span>
</h4>
<div class="description">
<p>图层加载完毕事件</p>
</div>
<h5 class="subsection-title">属性:</h5>
<div class="table-container">
<table class="props table">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th>Attributes</th>
<th>Default</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr class="deep-level-0">
<td class="name"><code>event</code></td>
<td class="type">
<span class="param-type">
Object
</span>
</td>
<td class="attributes">
</td>
<td class="default">
</td>
<td class="description last"><p>事件对象</p></td>
</tr>
<tr class="deep-level-1">
<td class="name"><code>type</code></td>
<td class="type">
<span class="param-type">
String
</span>
</td>
<td class="attributes">
<optional><br>
</td>
<td class="default">
'layerview-created'
</td>
<td class="description last"><p>图层加载完毕事件</p></td>
</tr>
<tr class="deep-level-1">
<td class="name"><code>message</code></td>
<td class="type">
<span class="param-type">
String
</span>
</td>
<td class="attributes">
<optional><br>
</td>
<td class="default">
null
</td>
<td class="description last"><p>更新描述</p></td>
</tr>
<tr class="deep-level-1">
<td class="name"><code>UpdateContent</code></td>
<td class="type">
<span class="param-type">
Array.<<a onclick="getTypeHTML(event)" link="UpdateContent.html">UpdateContent</a>>
</span>
</td>
<td class="attributes">
<optional><br>
</td>
<td class="default">
null
</td>
<td class="description last"><p>更新详情对象</p></td>
</tr>
<tr class="deep-level-1">
<td class="name"><code>layer</code></td>
<td class="type">
<span class="param-type">
<a link="Layer.html" onclick="getTypeHTML(event)" class="mapgis-link-name" title="Layer" Layer.html>Layer</a>
</span>
</td>
<td class="attributes">
<optional><br>
</td>
<td class="default">
null
</td>
<td class="description last"><p>地图图层对象</p></td>
</tr>
<tr class="deep-level-1">
<td class="name"><code>layerView</code></td>
<td class="type">
<span class="param-type">
<a link="MapView.html" onclick="getTypeHTML(event)" class="mapgis-link-name" title="MapView" MapView.html>MapView</a>
</span>
</td>
<td class="attributes">
<optional><br>
</td>
<td class="default">
null
</td>
<td class="description last"><p>图层的视图对象</p></td>
</tr>
<tr class="deep-level-1">
<td class="name"><code>sourceTarget</code></td>
<td class="type">
<span class="param-type">
<a link="Layer.html" onclick="getTypeHTML(event)" class="mapgis-link-name" title="Layer" Layer.html>Layer</a>
</span>
</td>
<td class="attributes">
<optional><br>
</td>
<td class="default">
null
</td>
<td class="description last"><p>事件发起对象</p></td>
</tr>
<tr class="deep-level-1">
<td class="name"><code>target</code></td>
<td class="type">
<span class="param-type">
<a link="Map.html" onclick="getTypeHTML(event)" class="mapgis-link-name" title="Map" Map.html>Map</a>
</span>
</td>
<td class="attributes">
<optional><br>
</td>
<td class="default">
null
</td>
<td class="description last"><p>事件接收对象</p></td>
</tr>
</tbody>
</table>
</div>
<dl class="details">
<dt class="inherited-from">Inherited From:</dt>
<dd class="inherited-from"><ul class="dummy"><li>
<a goto="event:图层加载完毕事件" link="Layer.html" onclick="getTypeHTML(event)" class="mapgis-link-name" title="Layer#event:图层加载完毕事件" Layer.html#event:%25E5%259B%25BE%25E5%25B1%2582%25E5%258A%25A0%25E8%25BD%25BD%25E5%25AE%258C%25E6%25AF%2595%25E4%25BA%258B%25E4%25BB%25B6>Layer#event:图层加载完毕事件</a>
</li></ul></dd>
</dl>
<h5>示例</h5>
<p class="code-caption"><h7>图层加载完毕事件</h7></p>
<pre class="prettyprint"><code>Layer.on('layerview-created', function (result) {
console.log("加载完毕:", result.layer)
});</code></pre>
</div>
<div class="member">
<h4 class="name" id="event:%E5%9B%BE%E5%B1%82%E6%98%BE%E9%9A%90%E6%9B%B4%E6%96%B0%E5%AE%8C%E6%AF%95%E4%BA%8B%E4%BB%B6">
<a class="href-link" href="#event:%E5%9B%BE%E5%B1%82%E6%98%BE%E9%9A%90%E6%9B%B4%E6%96%B0%E5%AE%8C%E6%AF%95%E4%BA%8B%E4%BB%B6">#</a>
<span class="code-name" id="图层显隐更新完毕事件" style="font-size:30px">
图层显隐更新完毕事件
</span>
</h4>
<div class="description">
<p>图层显隐更新完毕事件,请注意该事件是图层更新事件(layerview-update)的子事件</p>
</div>
<h5 class="subsection-title">属性:</h5>
<div class="table-container">
<table class="props table">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th>Attributes</th>
<th>Default</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr class="deep-level-0">
<td class="name"><code>event</code></td>
<td class="type">
<span class="param-type">
Object
</span>
</td>
<td class="attributes">
</td>
<td class="default">
</td>
<td class="description last"><p>事件对象</p></td>
</tr>
<tr class="deep-level-1">
<td class="name"><code>type</code></td>
<td class="type">
<span class="param-type">
String
</span>
</td>
<td class="attributes">
<optional><br>
</td>
<td class="default">
'layerview-update'
</td>
<td class="description last"><p>图层更新完毕事件</p></td>
</tr>
<tr class="deep-level-1">
<td class="name"><code>message</code></td>
<td class="type">
<span class="param-type">
String
</span>
</td>
<td class="attributes">
<optional><br>
</td>
<td class="default">
null
</td>
<td class="description last"><p>更新描述</p></td>
</tr>
<tr class="deep-level-1">
<td class="name"><code>updateContent</code></td>
<td class="type">
<span class="param-type">
Array.<<a onclick="getTypeHTML(event)" link="UpdateContent.html">UpdateContent</a>>
</span>
</td>
<td class="attributes">
<optional><br>
</td>
<td class="default">
null
</td>
<td class="description last"><p>更新详情对象</p></td>
</tr>
<tr class="deep-level-1">
<td class="name"><code>layer</code></td>
<td class="type">
<span class="param-type">
<a link="Layer.html" onclick="getTypeHTML(event)" class="mapgis-link-name" title="Layer" Layer.html>Layer</a>
</span>
</td>
<td class="attributes">
<optional><br>
</td>
<td class="default">
null
</td>
<td class="description last"><p>地图图层对象</p></td>
</tr>
<tr class="deep-level-1">
<td class="name"><code>layerView</code></td>
<td class="type">
<span class="param-type">
<a link="MapView.html" onclick="getTypeHTML(event)" class="mapgis-link-name" title="MapView" MapView.html>MapView</a>
</span>
</td>
<td class="attributes">
<optional><br>
</td>
<td class="default">
null
</td>
<td class="description last"><p>图层的视图对象</p></td>
</tr>
<tr class="deep-level-1">
<td class="name"><code>sourceTarget</code></td>
<td class="type">
<span class="param-type">
<a link="Layer.html" onclick="getTypeHTML(event)" class="mapgis-link-name" title="Layer" Layer.html>Layer</a>
</span>
</td>
<td class="attributes">
<optional><br>
</td>
<td class="default">
null
</td>
<td class="description last"><p>事件发起对象</p></td>
</tr>
<tr class="deep-level-1">
<td class="name"><code>target</code></td>
<td class="type">
<span class="param-type">
<a link="Map.html" onclick="getTypeHTML(event)" class="mapgis-link-name" title="Map" Map.html>Map</a>
</span>
</td>
<td class="attributes">
<optional><br>
</td>
<td class="default">
null
</td>
<td class="description last"><p>事件接收对象</p></td>
</tr>
</tbody>
</table>
</div>
<dl class="details">
<dt class="inherited-from">Inherited From:</dt>
<dd class="inherited-from"><ul class="dummy"><li>
<a goto="event:图层显隐更新完毕事件" link="Layer.html" onclick="getTypeHTML(event)" class="mapgis-link-name" title="Layer#event:图层显隐更新完毕事件" Layer.html#event:%25E5%259B%25BE%25E5%25B1%2582%25E6%2598%25BE%25E9%259A%2590%25E6%259B%25B4%25E6%2596%25B0%25E5%25AE%258C%25E6%25AF%2595%25E4%25BA%258B%25E4%25BB%25B6>Layer#event:图层显隐更新完毕事件</a>
</li></ul></dd>
</dl>
<h5>示例</h5>
<p class="code-caption"><h5>图层显隐更新完毕事件</h5></p>
<pre class="prettyprint"><code>Layer.on('layerview-update', function (event) {
// 获取更新事件对象
console.log("更新完毕:", event)
// 获取更新详情数组
const updateContent = event.updateContent
// 循环数组,根据事件名进行后续操作
for (let i = 0; i < updateContent.length; i++) {
// 图层显隐事件
if(updateContent[i].name === 'visible'){
console.log("图层显隐更新事件:", event);
}
}
});</code></pre>
</div>
<div class="member">
<h4 class="name" id="event:%E5%9B%BE%E5%B1%82%E6%9B%B4%E6%96%B0%E5%AE%8C%E6%AF%95%E4%BA%8B%E4%BB%B6">
<a class="href-link" href="#event:%E5%9B%BE%E5%B1%82%E6%9B%B4%E6%96%B0%E5%AE%8C%E6%AF%95%E4%BA%8B%E4%BB%B6">#</a>
<span class="code-name" id="图层更新完毕事件" style="font-size:30px">
图层更新完毕事件
</span>
</h4>
<div class="description">
<p>图层更新完毕事件</p>
</div>
<h5 class="subsection-title">属性:</h5>
<div class="table-container">
<table class="props table">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th>Attributes</th>
<th>Default</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr class="deep-level-0">
<td class="name"><code>event</code></td>
<td class="type">
<span class="param-type">
Object
</span>
</td>
<td class="attributes">
</td>
<td class="default">
</td>
<td class="description last"><p>事件对象</p></td>
</tr>
<tr class="deep-level-1">
<td class="name"><code>type</code></td>
<td class="type">
<span class="param-type">
String
</span>
</td>
<td class="attributes">
<optional><br>
</td>
<td class="default">
'layerview-update'
</td>
<td class="description last"><p>图层更新完毕事件</p></td>
</tr>
<tr class="deep-level-1">
<td class="name"><code>message</code></td>
<td class="type">
<span class="param-type">
String
</span>
</td>
<td class="attributes">
<optional><br>
</td>
<td class="default">
null
</td>
<td class="description last"><p>更新描述</p></td>
</tr>
<tr class="deep-level-1">
<td class="name"><code>updateContent</code></td>
<td class="type">
<span class="param-type">
Array.<<a onclick="getTypeHTML(event)" link="UpdateContent.html">UpdateContent</a>>
</span>
</td>
<td class="attributes">
<optional><br>
</td>
<td class="default">
null
</td>
<td class="description last"><p>更新详情对象</p></td>
</tr>
<tr class="deep-level-1">
<td class="name"><code>layer</code></td>
<td class="type">
<span class="param-type">
<a link="Layer.html" onclick="getTypeHTML(event)" class="mapgis-link-name" title="Layer" Layer.html>Layer</a>
</span>
</td>
<td class="attributes">
<optional><br>
</td>
<td class="default">
null
</td>
<td class="description last"><p>地图图层对象</p></td>
</tr>
<tr class="deep-level-1">
<td class="name"><code>layerView</code></td>
<td class="type">
<span class="param-type">
<a link="MapView.html" onclick="getTypeHTML(event)" class="mapgis-link-name" title="MapView" MapView.html>MapView</a>
</span>
</td>
<td class="attributes">
<optional><br>
</td>
<td class="default">
null
</td>
<td class="description last"><p>图层的视图对象</p></td>
</tr>
<tr class="deep-level-1">
<td class="name"><code>sourceTarget</code></td>
<td class="type">
<span class="param-type">
<a link="Layer.html" onclick="getTypeHTML(event)" class="mapgis-link-name" title="Layer" Layer.html>Layer</a>
</span>
</td>
<td class="attributes">
<optional><br>
</td>
<td class="default">
null
</td>
<td class="description last"><p>事件发起对象</p></td>
</tr>
<tr class="deep-level-1">
<td class="name"><code>target</code></td>
<td class="type">
<span class="param-type">
<a link="Map.html" onclick="getTypeHTML(event)" class="mapgis-link-name" title="Map" Map.html>Map</a>
</span>
</td>
<td class="attributes">
<optional><br>
</td>
<td class="default">
null
</td>
<td class="description last"><p>事件接收对象</p></td>
</tr>
</tbody>
</table>
</div>
<dl class="details">
<dt class="inherited-from">Inherited From:</dt>
<dd class="inherited-from"><ul class="dummy"><li>
<a goto="event:图层更新完毕事件" link="Layer.html" onclick="getTypeHTML(event)" class="mapgis-link-name" title="Layer#event:图层更新完毕事件" Layer.html#event:%25E5%259B%25BE%25E5%25B1%2582%25E6%259B%25B4%25E6%2596%25B0%25E5%25AE%258C%25E6%25AF%2595%25E4%25BA%258B%25E4%25BB%25B6>Layer#event:图层更新完毕事件</a>
</li></ul></dd>
</dl>
<h5>示例</h5>
<p class="code-caption"><h7>图层更新完毕事件</h7></p>
<pre class="prettyprint"><code>Layer.on('layerview-update', function (result) {
console.log("更新完毕:", result.layer)
});</code></pre>
</div>
<div class="member">
<h4 class="name" id="event:%E5%9B%BE%E5%B1%82%E9%80%8F%E6%98%8E%E5%BA%A6%E6%9B%B4%E6%96%B0%E5%AE%8C%E6%AF%95%E4%BA%8B%E4%BB%B6">
<a class="href-link" href="#event:%E5%9B%BE%E5%B1%82%E9%80%8F%E6%98%8E%E5%BA%A6%E6%9B%B4%E6%96%B0%E5%AE%8C%E6%AF%95%E4%BA%8B%E4%BB%B6">#</a>
<span class="code-name" id="图层透明度更新完毕事件" style="font-size:30px">
图层透明度更新完毕事件
</span>
</h4>
<div class="description">
<p>图层透明度更新完毕事件,请注意该事件是图层更新事件(layerview-update)的子事件</p>
</div>
<h5 class="subsection-title">属性:</h5>
<div class="table-container">
<table class="props table">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th>Attributes</th>
<th>Default</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr class="deep-level-0">
<td class="name"><code>event</code></td>
<td class="type">
<span class="param-type">
Object
</span>
</td>
<td class="attributes">
</td>
<td class="default">
</td>
<td class="description last"><p>事件对象</p></td>
</tr>
<tr class="deep-level-1">
<td class="name"><code>type</code></td>
<td class="type">
<span class="param-type">
String
</span>
</td>
<td class="attributes">
<optional><br>
</td>
<td class="default">
'layerview-update'
</td>
<td class="description last"><p>图层更新完毕事件</p></td>
</tr>
<tr class="deep-level-1">
<td class="name"><code>message</code></td>
<td class="type">
<span class="param-type">
String
</span>
</td>
<td class="attributes">
<optional><br>
</td>
<td class="default">
null
</td>
<td class="description last"><p>更新描述</p></td>
</tr>
<tr class="deep-level-1">
<td class="name"><code>updateContent</code></td>
<td class="type">
<span class="param-type">
Array.<<a onclick="getTypeHTML(event)" link="UpdateContent.html">UpdateContent</a>>
</span>
</td>
<td class="attributes">
<optional><br>
</td>
<td class="default">
null
</td>
<td class="description last"><p>更新详情对象</p></td>
</tr>
<tr class="deep-level-1">
<td class="name"><code>layer</code></td>
<td class="type">
<span class="param-type">
<a link="Layer.html" onclick="getTypeHTML(event)" class="mapgis-link-name" title="Layer" Layer.html>Layer</a>
</span>
</td>
<td class="attributes">
<optional><br>
</td>
<td class="default">
null
</td>
<td class="description last"><p>地图图层对象</p></td>
</tr>
<tr class="deep-level-1">
<td class="name"><code>layerView</code></td>
<td class="type">
<span class="param-type">
<a link="MapView.html" onclick="getTypeHTML(event)" class="mapgis-link-name" title="MapView" MapView.html>MapView</a>
</span>
</td>
<td class="attributes">
<optional><br>
</td>
<td class="default">
null
</td>
<td class="description last"><p>图层的视图对象</p></td>
</tr>
<tr class="deep-level-1">
<td class="name"><code>sourceTarget</code></td>
<td class="type">
<span class="param-type">
<a link="Layer.html" onclick="getTypeHTML(event)" class="mapgis-link-name" title="Layer" Layer.html>Layer</a>
</span>
</td>
<td class="attributes">
<optional><br>
</td>
<td class="default">
null
</td>
<td class="description last"><p>事件发起对象</p></td>
</tr>
<tr class="deep-level-1">
<td class="name"><code>target</code></td>
<td class="type">
<span class="param-type">
<a link="Map.html" onclick="getTypeHTML(event)" class="mapgis-link-name" title="Map" Map.html>Map</a>
</span>
</td>
<td class="attributes">
<optional><br>
</td>
<td class="default">
null
</td>
<td class="description last"><p>事件接收对象</p></td>
</tr>
</tbody>
</table>
</div>
<dl class="details">
<dt class="inherited-from">Inherited From:</dt>
<dd class="inherited-from"><ul class="dummy"><li>
<a goto="event:图层透明度更新完毕事件" link="Layer.html" onclick="getTypeHTML(event)" class="mapgis-link-name" title="Layer#event:图层透明度更新完毕事件" Layer.html#event:%25E5%259B%25BE%25E5%25B1%2582%25E9%2580%258F%25E6%2598%258E%25E5%25BA%25A6%25E6%259B%25B4%25E6%2596%25B0%25E5%25AE%258C%25E6%25AF%2595%25E4%25BA%258B%25E4%25BB%25B6>Layer#event:图层透明度更新完毕事件</a>
</li></ul></dd>
</dl>
<h5>示例</h5>
<p class="code-caption"><h5>图层透明度更新完毕事件</h5></p>
<pre class="prettyprint"><code>Layer.on('layerview-update', function (event) {
// 获取更新事件对象
console.log("更新完毕:", event)
// 获取更新详情数组
const updateContent = event.updateContent
// 循环数组,根据事件名进行后续操作
for (let i = 0; i < updateContent.length; i++) {
// 图层透明度更新事件
if(updateContent[i].name === 'opacity'){
console.log("图层透明度更新事件:", event);
}
}
});</code></pre>
</div>
<div class="member">
<h4 class="name" id="event:%E5%9B%BE%E5%B1%82%E9%94%80%E6%AF%81%E5%AE%8C%E6%AF%95%E4%BA%8B%E4%BB%B6">
<a class="href-link" href="#event:%E5%9B%BE%E5%B1%82%E9%94%80%E6%AF%81%E5%AE%8C%E6%AF%95%E4%BA%8B%E4%BB%B6">#</a>
<span class="code-name" id="图层销毁完毕事件" style="font-size:30px">
图层销毁完毕事件
</span>
</h4>
<div class="description">
<p>图层销毁完毕事件</p>
</div>
<h5 class="subsection-title">属性:</h5>
<div class="table-container">
<table class="props table">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th>Attributes</th>
<th>Default</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr class="deep-level-0">
<td class="name"><code>event</code></td>
<td class="type">
<span class="param-type">
Object
</span>
</td>
<td class="attributes">
</td>
<td class="default">
</td>
<td class="description last"><p>事件对象</p></td>
</tr>
<tr class="deep-level-1">
<td class="name"><code>type</code></td>
<td class="type">
<span class="param-type">
String
</span>
</td>
<td class="attributes">
<optional><br>
</td>
<td class="default">
'layerview-remove'
</td>
<td class="description last"><p>图层销毁完毕事件</p></td>
</tr>
<tr class="deep-level-1">
<td class="name"><code>message</code></td>
<td class="type">
<span class="param-type">
String
</span>
</td>
<td class="attributes">
<optional><br>
</td>
<td class="default">
null
</td>
<td class="description last"><p>更新描述</p></td>
</tr>
<tr class="deep-level-1">
<td class="name"><code>updateContent</code></td>
<td class="type">
<span class="param-type">
Array.<<a onclick="getTypeHTML(event)" link="UpdateContent.html">UpdateContent</a>>
</span>
</td>
<td class="attributes">
<optional><br>
</td>
<td class="default">
null
</td>
<td class="description last"><p>更新详情对象</p></td>
</tr>
<tr class="deep-level-1">
<td class="name"><code>layer</code></td>
<td class="type">
<span class="param-type">
<a link="Layer.html" onclick="getTypeHTML(event)" class="mapgis-link-name" title="Layer" Layer.html>Layer</a>
</span>
</td>
<td class="attributes">
<optional><br>
</td>
<td class="default">
null
</td>
<td class="description last"><p>要销毁的地图图层对象</p></td>
</tr>
<tr class="deep-level-1">
<td class="name"><code>layerView</code></td>
<td class="type">
<span class="param-type">
<a link="MapView.html" onclick="getTypeHTML(event)" class="mapgis-link-name" title="MapView" MapView.html>MapView</a>
</span>
</td>
<td class="attributes">
<optional><br>
</td>
<td class="default">
null
</td>
<td class="description last"><p>图层的视图对象</p></td>
</tr>
<tr class="deep-level-1">
<td class="name"><code>sourceTarget</code></td>
<td class="type">
<span class="param-type">
<a link="Layer.html" onclick="getTypeHTML(event)" class="mapgis-link-name" title="Layer" Layer.html>Layer</a>
</span>
</td>
<td class="attributes">
<optional><br>
</td>
<td class="default">
null
</td>
<td class="description last"><p>事件发起对象</p></td>
</tr>
<tr class="deep-level-1">
<td class="name"><code>target</code></td>
<td class="type">
<span class="param-type">
<a link="Map.html" onclick="getTypeHTML(event)" class="mapgis-link-name" title="Map" Map.html>Map</a>
</span>
</td>
<td class="attributes">
<optional><br>
</td>
<td class="default">
null
</td>
<td class="description last"><p>事件接收对象</p></td>
</tr>
</tbody>
</table>
</div>
<dl class="details">
<dt class="inherited-from">Inherited From:</dt>
<dd class="inherited-from"><ul class="dummy"><li>
<a goto="event:图层销毁完毕事件" link="Layer.html" onclick="getTypeHTML(event)" class="mapgis-link-name" title="Layer#event:图层销毁完毕事件" Layer.html#event:%25E5%259B%25BE%25E5%25B1%2582%25E9%2594%2580%25E6%25AF%2581%25E5%25AE%258C%25E6%25AF%2595%25E4%25BA%258B%25E4%25BB%25B6>Layer#event:图层销毁完毕事件</a>
</li></ul></dd>
</dl>
<h5>示例</h5>
<p class="code-caption"><h7>图层销毁完毕事件</h7></p>
<pre class="prettyprint"><code>Layer.on('layerview-remove', function (result) {
console.log("销毁完毕:", result.layer)
});</code></pre>
</div>
<div class="member">
<h4 class="name" id="event:%E5%9B%BE%E5%B1%82%E9%A1%BA%E5%BA%8F%E6%9B%B4%E6%96%B0%E5%AE%8C%E6%AF%95%E4%BA%8B%E4%BB%B6">
<a class="href-link" href="#event:%E5%9B%BE%E5%B1%82%E9%A1%BA%E5%BA%8F%E6%9B%B4%E6%96%B0%E5%AE%8C%E6%AF%95%E4%BA%8B%E4%BB%B6">#</a>
<span class="code-name" id="图层顺序更新完毕事件" style="font-size:30px">
图层顺序更新完毕事件
</span>
</h4>
<div class="description">
<p>图层顺序更新完毕事件,请注意该事件是图层更新事件(layerview-update)的子事件</p>
</div>
<h5 class="subsection-title">属性:</h5>
<div class="table-container">
<table class="props table">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th>Attributes</th>
<th>Default</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr class="deep-level-0">
<td class="name"><code>event</code></td>
<td class="type">
<span class="param-type">
Object
</span>
</td>
<td class="attributes">
</td>
<td class="default">
</td>
<td class="description last"><p>事件对象</p></td>
</tr>
<tr class="deep-level-1">
<td class="name"><code>type</code></td>
<td class="type">
<span class="param-type">
String
</span>
</td>
<td class="attributes">
<optional><br>
</td>
<td class="default">
'layerview-update'
</td>
<td class="description last"><p>图层更新完毕事件</p></td>
</tr>
<tr class="deep-level-1">
<td class="name"><code>message</code></td>
<td class="type">
<span class="param-type">
String
</span>
</td>
<td class="attributes">
<optional><br>
</td>
<td class="default">
null
</td>
<td class="description last"><p>更新描述</p></td>
</tr>
<tr class="deep-level-1">
<td class="name"><code>updateContent</code></td>
<td class="type">
<span class="param-type">
Array.<<a onclick="getTypeHTML(event)" link="UpdateContent.html">UpdateContent</a>>
</span>
</td>
<td class="attributes">
<optional><br>
</td>
<td class="default">
null
</td>
<td class="description last"><p>更新详情对象</p></td>
</tr>
<tr class="deep-level-1">
<td class="name"><code>layer</code></td>
<td class="type">
<span class="param-type">
<a link="Layer.html" onclick="getTypeHTML(event)" class="mapgis-link-name" title="Layer" Layer.html>Layer</a>
</span>
</td>
<td class="attributes">
<optional><br>
</td>
<td class="default">
null
</td>
<td class="description last"><p>地图图层对象</p></td>
</tr>
<tr class="deep-level-1">
<td class="name"><code>layerView</code></td>
<td class="type">
<span class="param-type">
<a link="MapView.html" onclick="getTypeHTML(event)" class="mapgis-link-name" title="MapView" MapView.html>MapView</a>
</span>
</td>
<td class="attributes">
<optional><br>
</td>
<td class="default">
null
</td>
<td class="description last"><p>图层的视图对象</p></td>
</tr>
<tr class="deep-level-1">
<td class="name"><code>sourceTarget</code></td>
<td class="type">
<span class="param-type">
<a link="Layer.html" onclick="getTypeHTML(event)" class="mapgis-link-name" title="Layer" Layer.html>Layer</a>
</span>
</td>
<td class="attributes">
<optional><br>
</td>
<td class="default">
null
</td>
<td class="description last"><p>事件发起对象</p></td>
</tr>
<tr class="deep-level-1">
<td class="name"><code>target</code></td>
<td class="type">
<span class="param-type">
<a link="Map.html" onclick="getTypeHTML(event)" class="mapgis-link-name" title="Map" Map.html>Map</a>
</span>
</td>
<td class="attributes">
<optional><br>
</td>
<td class="default">
null
</td>
<td class="description last"><p>事件接收对象</p></td>
</tr>
</tbody>
</table>
</div>
<dl class="details">
<dt class="inherited-from">Inherited From:</dt>
<dd class="inherited-from"><ul class="dummy"><li>
<a goto="event:图层顺序更新完毕事件" link="Layer.html" onclick="getTypeHTML(event)" class="mapgis-link-name" title="Layer#event:图层顺序更新完毕事件" Layer.html#event:%25E5%259B%25BE%25E5%25B1%2582%25E9%25A1%25BA%25E5%25BA%258F%25E6%259B%25B4%25E6%2596%25B0%25E5%25AE%258C%25E6%25AF%2595%25E4%25BA%258B%25E4%25BB%25B6>Layer#event:图层顺序更新完毕事件</a>
</li></ul></dd>
</dl>
<h5>示例</h5>
<p class="code-caption"><h5>图层顺序更新完毕事件</h5></p>
<pre class="prettyprint"><code>Layer.on('layerview-update', function (event) {
// 获取更新事件对象
console.log("更新完毕:", event)
// 获取更新详情数组
const updateContent = event.updateContent
// 循环数组,根据事件名进行后续操作
for (let i = 0; i < updateContent.length; i++) {
// 图层顺序更新完毕事件
if(updateContent[i].name === 'index'){
console.log("图层顺序更新完毕事件:", event);
}
}
});</code></pre>
</div>
<div class="member">
<h4 class="name" id="event:%E5%AD%90%E5%9B%BE%E5%B1%82%E6%98%BE%E9%9A%90%E6%9B%B4%E6%96%B0%E5%AE%8C%E6%AF%95%E4%BA%8B%E4%BB%B6">
<a class="href-link" href="#event:%E5%AD%90%E5%9B%BE%E5%B1%82%E6%98%BE%E9%9A%90%E6%9B%B4%E6%96%B0%E5%AE%8C%E6%AF%95%E4%BA%8B%E4%BB%B6">#</a>
<span class="code-name" id="子图层显隐更新完毕事件" style="font-size:30px">
子图层显隐更新完毕事件
</span>
</h4>
<div class="description">
<p>子图层显隐更新完毕事件,请注意该事件是图层更新事件(layerview-update)的子事件</p>
</div>
<h5 class="subsection-title">属性:</h5>
<div class="table-container">
<table class="props table">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th>Attributes</th>
<th>Default</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr class="deep-level-0">
<td class="name"><code>event</code></td>
<td class="type">
<span class="param-type">
Object
</span>
</td>
<td class="attributes">
</td>
<td class="default">
</td>
<td class="description last"><p>事件对象</p></td>
</tr>
<tr class="deep-level-1">
<td class="name"><code>type</code></td>
<td class="type">
<span class="param-type">
String
</span>
</td>
<td class="attributes">
<optional><br>
</td>
<td class="default">
'layerview-update'
</td>
<td class="description last"><p>图层更新完毕事件</p></td>
</tr>
<tr class="deep-level-1">
<td class="name"><code>message</code></td>
<td class="type">
<span class="param-type">
String
</span>
</td>
<td class="attributes">
<optional><br>
</td>
<td class="default">
null
</td>
<td class="description last"><p>更新描述</p></td>
</tr>
<tr class="deep-level-1">
<td class="name"><code>updateContent</code></td>
<td class="type">
<span class="param-type">
Array.<<a onclick="getTypeHTML(event)" link="UpdateContent.html">UpdateContent</a>>
</span>
</td>
<td class="attributes">
<optional><br>
</td>
<td class="default">
null
</td>
<td class="description last"><p>更新详情对象</p></td>
</tr>
<tr class="deep-level-1">
<td class="name"><code>layer</code></td>
<td class="type">
<span class="param-type">
<a link="Layer.html" onclick="getTypeHTML(event)" class="mapgis-link-name" title="Layer" Layer.html>Layer</a>
</span>
</td>
<td class="attributes">
<optional><br>
</td>
<td class="default">
null
</td>
<td class="description last"><p>地图图层对象</p></td>
</tr>
<tr class="deep-level-1">
<td class="name"><code>layerView</code></td>
<td class="type">
<span class="param-type">
<a link="MapView.html" onclick="getTypeHTML(event)" class="mapgis-link-name" title="MapView" MapView.html>MapView</a>
</span>
</td>
<td class="attributes">
<optional><br>
</td>
<td class="default">
null
</td>
<td class="description last"><p>图层的视图对象</p></td>
</tr>
<tr class="deep-level-1">
<td class="name"><code>sourceTarget</code></td>
<td class="type">
<span class="param-type">
<a link="Layer.html" onclick="getTypeHTML(event)" class="mapgis-link-name" title="Layer" Layer.html>Layer</a>
</span>
</td>
<td class="attributes">
<optional><br>
</td>
<td class="default">
null
</td>
<td class="description last"><p>事件发起对象</p></td>
</tr>
<tr class="deep-level-1">
<td class="name"><code>target</code></td>
<td class="type">
<span class="param-type">
<a link="Map.html" onclick="getTypeHTML(event)" class="mapgis-link-name" title="Map" Map.html>Map</a>
</span>
</td>
<td class="attributes">
<optional><br>
</td>
<td class="default">
null
</td>
<td class="description last"><p>事件接收对象</p></td>
</tr>
</tbody>
</table>
</div>
<dl class="details">
</dl>
<h5>示例</h5>
<p class="code-caption"><h5>子图层显隐更新完毕事件</h5></p>
<pre class="prettyprint"><code>Layer.on('layerview-update', function (event) {
// 获取更新事件对象
console.log("更新完毕:", event)
// 获取更新详情数组
const updateContent = event.updateContent
// 循环数组,根据事件名进行后续操作
for (let i = 0; i < updateContent.length; i++) {
// 子图层显隐更新完毕事件
if(updateContent[i].name === 'sublayerVisible'){
console.log("子图层显隐更新完毕事件:", event);
}
}
});</code></pre>
</div>
</div>
</div>
</article>
</section>