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

mapgis ES6 format for igserver

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





<section>

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


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

    
    <div class="description">
        <p>IGS瓦片图层，<br>
支持IGS1.0和2.0两个服务版本，支持自定义坐标系，当IGS版本是1.0时，需要手动设置图层坐标系，当IGS版本是2.0时，会自动读取元信息上的坐标系，不需要用户指定，
<br><br>[ES5引入方式]：<br/>
Zondy.Layer.IGSTileLayer() <br/>
[ES6引入方式]：<br/>
import { IGSTileLayer } 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/>
IGS1.0的服务为：http://{ip}:{port}/igs/rest/mrms/tile/{serviceName}，暂时无法从元信息中获取坐标系，请自行指定图层坐标系，参考示例：<a href='#igs-1'>[IGS1.0的瓦片图层示例]</a><br/>
IGS2.0的服务为：http://{ip}:{port}/igs/rest/services/{folder}/{serviceName}/TileServer，参考示例：<a href='#igs-2'>[IGS2.0的瓦片图层示例]</a><br/>
删除图层方法：<a href='#remove-layer'>[删除图层]</a></p></td>
</tr>


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

  <td class="type">
  
      
<span class="param-type">String</span>



  
  </td>

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

  <td class="description last"><p>图层id，不给则给一个随机的id</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="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>图层坐标系，默认从服务元信息上读取，当为igs1.0服务时，需要用户指定坐标系，
参考示例：<a href='#igs-1'>[设置图层坐标系(IGS1.0)]</a></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='#getTileUrl'>[2、根据级数以及行列号获取瓦片的url]</a><br/>
<a href='#toJSON'>[3、将图层转为json对象]</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='igs-1'>IGS1.0的瓦片图层示例</h7></p>
    
    
        <pre class="prettyprint"><code>// ES5引入方式
const { Map ,MapView,SpatialReference} = Zondy
const { IGSTileLayer} = Zondy.Layer
// ES6引入方式
import { IGSTileLayer } from "@mapgis/webclient-common"
const igsTileLayer = new IGSTileLayer({
  // 服务基地址
  url: 'http://{ip}:{port}/igs/rest/mrms/tile/{serviceName}',
  // IGS1.0服务，暂时无法从元信息中获取坐标系，请自行指定图层坐标系
  spatialReference: new SpatialReference({
    wkid: 4326
  })
});</code></pre>
    

        <p class="code-caption"><h7 id='igs-2'>IGS2.0的瓦片图层示例</h7></p>
    
    
        <pre class="prettyprint"><code>// ES5引入方式
const { Map ,MapView,SpatialReference} = Zondy
const { IGSTileLayer} = Zondy.Layer
// ES6引入方式
import { IGSTileLayer } from "@mapgis/webclient-common"
const igsTileLayer = new IGSTileLayer({
  // 服务基地址
  url: 'http://{ip}:{port}/igs/rest/services/Tile/{serviceName}/TileServer'
});</code></pre>
    

        <p class="code-caption"><h7 id='opacity'>设置图层透明度</h7></p>
    
    
        <pre class="prettyprint"><code>// ES5引入方式
const { IGSTileLayer} = Zondy.Layer
// ES6引入方式
import { IGSTileLayer } from "@mapgis/webclient-common"
// 初始化时设置
const igsTileLayer = new IGSTileLayer({
  // 服务基地址
  url: 'http://{ip}:{port}/igs/rest/services/Tile/{serviceName}/TileServer',
  // 设置图层透明度
  opacity: 1.0
});
// 加载完成后设置
arcgisTileLayer.on('layerview-created', function (result) {
  console.log("加载完毕:", result.layer)
  igsTileLayer.opacity = 0.5
})</code></pre>
    

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

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

        <p class="code-caption"><h7>ArcGIS的瓦片图层示例</h7></p>
    
    
        <pre class="prettyprint"><code> // ES5引入方式
const { IGSTileLayer} = Zondy.Layer
// ES6引入方式
import { IGSTileLayer } from "@mapgis/webclient-common"
const arcgisTileLayer = new IGSTileLayer({
  url: 'https://services.arcgisonline.com/arcgis/rest/services/World_Terrain_Base/MapServer'
});</code></pre>
    

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

        <p class="code-caption"><h7 id='index'>图层顺序</h7></p>
    
    
        <pre class="prettyprint"><code>// 加载完毕后，更改图层顺序
map.reorder(igsTileLayer, '要移动到的index');</code></pre>
    



                    </div>
                </div>
            </div>
        
    
    </div>
    
    
        <h3 class="subsection-title">继承关系</h3>

        


    <ul>
        <li><a link="Layer.html" onclick="getTypeHTML(event)" class="mapgis-link-name" title="Layer" Layer.html>Layer</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="#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="#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="#mapName">mapName</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="#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="#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="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="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="tag-overrides">Overrides:</dt>
    <dd class="tag-overrides"><ul class="dummy"><li>
        <a 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">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="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">String</span>



    </span>

<h4 class="name" id="mapName">
    <a class="href-link" href="#mapName">#</a>
    
    <span class="code-name">
        mapName
    </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="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为不透明，会触发图层更新完毕事件</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="tag-overrides">Overrides:</dt>
    <dd class="tag-overrides"><ul class="dummy"><li>
        <a 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">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="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="Layer#type" Layer.html#type>Layer#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="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">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构造并返回一个新的几何对象<a id='fromJSON'></a></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"><co