@mapgis/webclient-common

<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" id="options"><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" id="url"><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" id="title"><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" id="spatialReference"><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" id="opacity"><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" id="visible"><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" id="imageWidth"><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" id="imageHeight"><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" id="minScale"><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" id="maxScale"><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" id="imageTransparency"><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" id="clippingArea"><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" id="sublayers"><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" id="tokenKey"><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" id="tokenValue"><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 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> <li><a 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> <li><a 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> <li><a 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> <li><a 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> <li><a 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> <li><a 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> <li><a class="mapgis-link-name" title="WMSLayer#event:子图层显隐更新完毕事件" WMSLayer.html#event:%25E5%25AD%2590%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>WMSLayer#event:子图层显隐更新完毕事件</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">String</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为不透明，会触发图层更新完毕事件</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 link="Array.<SpatialReference>.html" onclick="getTypeHTML(event)" href="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="#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> </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> </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">String</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"> la