@mapgis/webclient-common/documention/WMTSLayer.html

mapgis ES6 format for igserver

<header id="page-title" class="page-title">
    
        <span class="page-title-main">类名</span>
        <span class="page-title-sub">WMTSLayer</span>
    
</header>





<section>

<article>
    <div class="container-overview">
    
        
            <div class='vertical-section'>
                <div class="members">
                    <div class="member">
                        


    
    <h4 class="name" id="WMTSLayer">
        <a class="href-link" href="#WMTSLayer">#</a>
        
        <span class="code-name" id="WMTSLayer" style="font-size:30px">
            
                new WMTSLayer<span class="signature">(options)</span>
            
        </span>
    </h4>
    

    
    <div class="description">
        <p>WMTS图层，<br>
除了支持常见的4326(包括4490，4214以及4610)，3857参考系以外，还支持能在EPSG官网(https://epsg.io/)上查询到的坐标系<br/>
会自动读取图层元信息，不需要用户手动设置<br/>
WMTS图层中存在多个子图层，每个子图层中又有多个TileMatrixSet，因此每个子图层以及其对应的每一个TileMatrixSet，都对应一套实际的瓦片数据，默认会使用第0个图层的第0个TileMatrixSet来构建图层，同时用户也可以自己指定要加载的子图层，可以参考示例：<a href='#activeLayer'>[指定要激活的子图层]</a>
<br><br>[ES5引入方式]：<br/>
Zondy.Layer.WMTSLayer() <br/>
[ES6引入方式]：<br/>
import { WMTSLayer } from &quot;@mapgis/webclient-common&quot; <br/>
<br/>
针对图层的操作请在图层加载完毕事件中进行<br/>
Layer.on('layerview-created', function (result) {<br/>
console.log(&quot;加载完毕:&quot;, 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的WMTS服务，格式为：<br/>
IGS1.0的基地址：http://{ip}:{port}/igs/rest/ogc/{ServiceName}/WMTSServer<br/>
IGS2.0的基地址：http://{ip}:{port}/igs/rest/services/{ServiceName}/WMTSServer<br/>
请注意，当在IGS中发布自定义坐标系的WMTS服务时，可能会有部分地图无法正确的进行预览，
并且该服务中的范围参数是错误的，请自行指定跳转范围，或从该服务对应的瓦片服务中获取，参考示例：<a href='#MapIGS'>[加载MapGIS的WMTS服务]</a><br/>
2、支持ArcGIS的WMTS服务，格式为：http://{ip}:{port}/arcgis/rest/services/{ServiceName}/MapServer/WMTS，参考示例：<a href='#ArcGIS'>[加载ArcGIS的WMTS服务]</a><br/>
3、支持天地图的WMTS服务：格式为：http://t{0~6的随机数}.tianditu.gov.cn/{图层类型}_{坐标系}/wmts，<br/>
其中天地图层类型如下：<br/>
vec：矢量底图、img：卫星影像底图、cva: 矢量注记图层（中文）、eva: 矢量注记图层（英文）、cia: 注记图层（中文）、eia: 注记图层（英文）、ter: 地形晕渲底图、cta: 注记（中文）、ibo: 全球国界<br/>
坐标系如下：<br/>
w：墨卡托坐标系(3857)、c：经纬度坐标系(4326)<br/>
参考示例：<a href='#tdt'>[加载天地图的WMTS服务]</a><br/></p></td>
</tr>


  
    
<tr class="deep-level-1">
  
      <td class="name" id="activeLayer"><code>activeLayer</code></td>
  

  <td class="type">
  
      
<span class="param-type"><a link="WMTSSubLayer.html" onclick="getTypeHTML(event)" class="mapgis-link-name" title="WMTSSubLayer" WMTSSubLayer.html>WMTSSubLayer</a></span>



  
  </td>

  
      <td class="default">
      
      </td>
  

  <td class="description last"><p>当前处于活动状态的子图层，会用该子图层来构建整个图层的参数，默认会使用第0个图层的第0个TileMatrixSet来构建图层，同时用户也可以自己指定要加载的子图层，可以参考示例：<a href='#activeLayer'>[指定要激活的子图层]</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'>[修改图层透明度]</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'>[设置图层显隐]</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="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>


  
    
<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>


  



        
        </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>
            </ul>
        </div>
    </div>

















<p class="summary"><h5>支持如下方法：</h5>
<a href='#load'>[1、加载图层资源]</a><br/>
<a href='#findSublayerById'>[2、根据子图层id查询图层]</a><br/>
<a href='#fromServerUrl'>[3、通过url创建图层对象]</a><br/>
<a href='#fromJSON'>[4、通过传入的json构造并返回一个新的几何对象]</a><br/>
<a href='#getCurrentTileInfo'>[5、获取当前图层瓦片裁图信息]</a><br/>
<a class="mapgis-link-name" title="OGCLayer#toJSON" OGCLayer.html#toJSON><code>6、导出为json对象</code></a><br/>
<a class="mapgis-link-name" title="OGCLayer#clone" OGCLayer.html#clone><code>7、克隆几何对象</code></a></p>



    <h5>示例</h5>
    
        <p class="code-caption"><h7 id='MapIGS'>加载WMTS图层</h7></p>
    
    
        <pre class="prettyprint"><code>// ES5引入方式
const { WMTSLayer } = Zondy.Layer
// ES6引入方式
import { WMTSLayer } from "@mapgis/webclient-common"
// 初始化WMTS图层
const wmtsLayer = new WMTSLayer({
  // 服务基地址
  url: 'http://{ip}:{port}/igs/rest/services/{serviceName}/WMTSServer'
});</code></pre>
    

        <p class="code-caption"><h7 id='ArcGIS'>添加ArcGIS的WMTS图层示例</h7></p>
    
    
        <pre class="prettyprint"><code>// ES5引入方式
const { WMTSLayer } = Zondy.Layer
// ES6引入方式
import { WMTSLayer } from "@mapgis/webclient-common"
// 初始化WMTS图层
const wmtsLayer = new WMTSLayer({
  url: 'http://{ip}:{port}/arcgis/rest/services/{serviceName}/MapServer/WMTS'
});</code></pre>
    

        <p class="code-caption"><h7 id='tdt'>加载天地图的WMTS服务</h7></p>
    
    
        <pre class="prettyprint"><code>// ES5引入方式
const { WMTSLayer } = Zondy.Layer
// ES6引入方式
import { WMTSLayer } from "@mapgis/webclient-common"
初始化WMTS图层
const wmtsLayer = new WMTSLayer({
  // 加载经纬度的影像地图
  url: 'http://t6.tianditu.gov.cn/img_c/wmts',
  // 天地图必须加token，且token名为tk
  tokenKey: 'tk',
  // token请在天地图官网申请
  tokenValue: '天地图token'
});</code></pre>
    

        <p class="code-caption"><h7 id='opacity'>修改图层透明度</h7></p>
    
    
        <pre class="prettyprint"><code>// ES5引入方式
const { WMTSLayer } = Zondy.Layer
// ES6引入方式
import { WMTSLayer } from "@mapgis/webclient-common"
// 初始化时设置
const wmtsLayer = new WMTSLayer({
  // 服务基地址
  url: 'http://{ip}:{port}/igs/rest/services/{serviceName}/WMTSServer',
  // 设置透明度
  opacity: 1.0
});

// 加载完成后设置
wmtsLayer.on('layerview-created', function (result) {
  console.log("加载完毕:", result.layer)
  // 设置透明度
  wmtsLayer.opacity = 0.5
})</code></pre>
    

        <p class="code-caption"><h7 id='visible'>设置图层显隐</h7></p>
    
    
        <pre class="prettyprint"><code>// ES5引入方式
const { WMTSLayer } = Zondy.Layer
// ES6引入方式
import { WMTSLayer } from "@mapgis/webclient-common"
// 初始化时设置
const wmtsLayer = new WMTSLayer({
  // 服务基地址
  url: 'http://{ip}:{port}/igs/rest/services/{serviceName}/WMTSServer',
  // 设置图层显隐
  visible: true
});

// 加载完成后设置
wmtsLayer.on('layerview-created', function (result) {
  console.log("加载完毕:", result.layer)
  // 设置图层显隐
  wmtsLayer.visible = !wmtsLayer.visible
})</code></pre>
    

        <p class="code-caption"><h7>删除图层</h7></p>
    
    
        <pre class="prettyprint"><code>map.remove(wmtsLayer)</code></pre>
    

        <p class="code-caption"><h7 id='activeLayer'>指定要激活的子图层</h7></p>
    
    
        <pre class="prettyprint"><code>// ES5引入方式
const { WMTSLayer } = Zondy.Layer
// ES6引入方式
import { WMTSLayer } from "@mapgis/webclient-common"
// 初始化一个WMTS图层
const wmtsLayer = new WMTSLayer({
  // 服务基地址
  url: 'http://{ip}:{port}/{path}'
})
// 加载图层元信息
wmtsLayer.load().then(function (layer) {
  // 从子图层列表中，获取一个子图层
  const subLayer = layer.sublayers.getItemAt(0)
  // 每一个子图层中，有多个tileMatrixSet，一个tileMatrixSet代表了一个坐标系
  // 指定子图层的tileMatrixSetId
  subLayer.tileMatrixSetId = subLayer.tileMatrixSets[1].identifier
  // 指定当前激活的子图层
  layer.activeLayer = subLayer
})
// 将WMTS图层添加到Map中
map.add(layer)</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="#activeLayer">activeLayer</a></code></td>
                                <td class="name">
                                    <code>
                                        
<span class="param-type"><a link="WMTSSubLayer.html" onclick="getTypeHTML(event)" class="mapgis-link-name" title="WMTSSubLayer" WMTSSubLayer.html>WMTSSubLayer</a></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="#corporationType">corporationType</a></code></td>
                                <td class="name">
                                    <code>
                                        
<span class="param-type">String</span>



                                    </code>
                                </td>
                                <td class="name"><code><p>WMTS 公司代码</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="#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="#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>最大缩放比例尺</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>最小缩放比例尺</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="#sublayers">sublayers</a></code></td>
                                <td class="name">
                                    <code>
                                        
<span class="param-type">Array.&lt;<a link="Array.<WMTSSubLayer>.html" onclick="getTypeHTML(event)" href="WMTSSubLayer.html">WMTSSubLayer</a>></span>



                                    </code>
                                </td>
                                <td class="name"><code><p>WMTSSublayer 子图层对象的集合</p></code></td>
                            </tr>
                        
                            <tr class="deep-level-0">
                                <td class="name"><code><a href="#tileMatrixSets">tileMatrixSets</a></code></td>
                                <td class="name">
                                    <code>
                                        
<span class="param-type">Array.&lt;<a link="Array.<TileMatrixSet>.html" onclick="getTypeHTML(event)" href="TileMatrixSet.html">TileMatrixSet</a>></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">type</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>ogc版本号</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"><a link="WMTSSubLayer.html" onclick="getTypeHTML(event)" class="mapgis-link-name" title="WMTSSubLayer" WMTSSubLayer.html>WMTSSubLayer</a></span>



    </span>

<h4 class="name" id="activeLayer">
    <a class="href-link" href="#activeLayer">#</a>
    
    <span class="code-name">
        activeLayer
    </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">String</span>



    </span>

<h4 class="name" id="corporationType">
    <a class="href-link" href="#corporationType">#</a>
    
        
            <span class='tag'>readonly</span>
        
    
    <span class="code-name">
        corporationType
    </span>
    
</h4>




<div class="description">
    <p>WMTS 公司代码</p>
</div>





<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    
    

    

    

    
</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="code-name">
        extent
    </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#extent" OGCLayer.html#extent>OGCLayer#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">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">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="tag-overrides">Overrides:</dt>
    <dd class="tag-overrides"><ul class="dummy"><li>
        <a class="mapgis-link-name" title="OGCLayer#loaded" OGCLayer.html#loaded>OGCLayer#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="tag-overrides">Overrides:</dt>
    <dd class="tag-overrides"><ul class="dummy"><li>
        <a class="mapgis-link-name" title="OGCLayer#loadStatus" OGCLayer.html#loadStatus>OGCLayer#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>最大缩放比例尺</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#maxScale" OGCLayer.html#maxScale>OGCLayer#maxScale</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="minScale">
    <a class="href-link" href="#minScale">#</a>
    
    <span class="code-name">
        minScale
    </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#minScale" OGCLayer.html#minScale>OGCLayer#minScale</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="opacity">
    <a class="href-link" href="#opacity">#</a>
    
    <span class="code-name">
        opacity
    </span>
    
</h4>




<div class="description">
    <p>图层透明度，0到1之间的值，0为完全透明，1为不透明，会触发图层更新完毕事件</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='tag'>readonly</span>
        
    
    <span class="code-name">
        spatialReference
    </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#spatialReference" OGCLayer.html#spatialReference>OGCLayer#spatialReference</a>
    </li></ul></dd>
    

    

    

    

    

    

    

    

    
    

    

    

    
</dl>





</div>
            
                <div class="member">

    <span class="method-parameter is-pulled-right">
        <label>类型:</label>
        
<span class="param-type">Array.&lt;<a link="Array.<WMTSSubLayer>.html" onclick="getTypeHTML(event)" href="WMTSSubLayer.html">WMTSSubLayer</a>></span>



    </span>

<h4 class="name" id="sublayers">
    <a class="href-link" href="#sublayers">#</a>
    
        
            <span class='tag'>readonly</span>
        
    
    <span class="code-name">
        sublayers
    </span>
    
</h4>




<div class="description">
    <p>WMTSSublayer 子图层对象的集合</p>
</div>





<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    
    

    

    

    
</dl>





</div>
            
                <div class="member">

    <span class="method-parameter is-pulled-right">
        <label>类型:</label>
        
<span class="param-type">Array.&lt;<a link="Array.<TileMatrixSet>.html" onclick="getTypeHTML(event)" href="TileMatrixSet.html">TileMatrixSet</a>></span>



    </span>

<h4 class="name" id="tileMatrixSets">
    <a class="href-link" href="#tileMatrixSets">#</a>
    
        
            <span class='tag'>readonly</span>
        
    
    <span class="code-name">
        tileMatrixSets
    </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="tag-overrides">Overrides:</dt>
    <dd class="tag-overrides"><ul class="dummy"><li>
        <a class="mapgis-link-name" title="OGCLayer#title" OGCLayer.html#title>OGCLayer#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="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">Inheri