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

mapgis ES6 format for igserver

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





<section>

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


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

    
    <div class="description">
        <p>矢量瓦片图层基类
<br>
<br>
可通过重写VectorTileLayer的load方法，来自定义矢量瓦片业务逻辑，示例如下：<br>
<a href='#custom-es5'>[自定义矢量瓦片业务逻辑-es5]</a>，<a href='#custom-es6'>[自定义矢量瓦片业务逻辑-es6]</a>
<br>
<br></p>
    </div>
    









    <h4>参数</h4>
    
<div class="table-container">
    <table class="params table">
        <thead>
        <tr>
            
            <th>名称</th>
            

            <th>类型</th>

            
            <th style="min-width: 100px;">默认值</th>
            

            <th class="last">描述</th>
        </tr>
        </thead>

        <tbody>
        

            
<tr class="deep-level-0">
  
      <td class="name"><code>options</code></td>
  

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



  
  </td>

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

  <td class="description last"><p>构造参数</p></td>
</tr>


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

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



  
  </td>

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

  <td class="description last"><p>服务基地址</p></td>
</tr>


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

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



  
  </td>

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

  <td class="description last"><p>图层透明度，0到1之间的值，0为完全透明，1为不透明</p></td>
</tr>


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

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



  
  </td>

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

  <td class="description last"><p>最小显示比例尺，图层在视图中可见的最小比例尺。</p></td>
</tr>


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

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



  
  </td>

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

  <td class="description last"><p>最大显示比例尺，图层在视图中可见的最大比例尺。</p></td>
</tr>


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

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



  
  </td>

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

  <td class="description last"><p>token名</p></td>
</tr>


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

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



  
  </td>

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

  <td class="description last"><p>token值，只有当tokenValue存在时，才会绑定token</p></td>
</tr>


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

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



  
  </td>

  
      <td class="default">
      
          'off-screen'
      
      </td>
  

  <td class="description last"><p>指定矢量瓦片注记的渲染模式,仅在三维上有效<br/>
on-screen: 使用Cesium接口实时渲染注记<br/>
off-screen: 使用矢量瓦片来绘制注记<br/>
三维注记目前不支持修改透明度和显隐参数<br>
请注意模式切换时，会造成性能损失，在显卡较弱的机器上会出现卡顿现象<br/>
示例请参考<a href="IGSVectorTileLayer.html"><code>IGSVectorTileLayer</code></a></p></td>
</tr>


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

  <td class="type">
  
      
<span class="param-type">
    
             <a link="Polygon.html" onclick="getTypeHTML(event)" href="Polygon.html">Polygon</a>
    
</span>
|

<span class="param-type">
    
             <a link="Extent.html" onclick="getTypeHTML(event)" href="Extent.html">Extent</a>
    
</span>
|

<span class="param-type">
    
             <a link="Circle.html" onclick="getTypeHTML(event)" href="Circle.html">Circle</a>
    
</span>
|

<span class="param-type">
    
             <a link="MultiPolygon.html" onclick="getTypeHTML(event)" href="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 href="#图层加载完毕事件">图层加载完毕事件</a></li>
            
                <li><a href="#图层销毁完毕事件">图层销毁完毕事件</a></li>
            
                <li><a href="#图层更新完毕事件">图层更新完毕事件</a></li>
            
                <li><a href="#图层显隐更新完毕事件">图层显隐更新完毕事件</a></li>
            
                <li><a href="#图层透明度更新完毕事件">图层透明度更新完毕事件</a></li>
            </ul>
        </div>
    </div>

















<p class="summary"><h5>支持如下方法：</h5>
<a href='#getStyleLayer'>[1、通过矢量瓦片样式图层的id，找到对应的矢量瓦片样式图层对象]</a><br/>
<a href='#getStyleLayerIndex'>[2、通过矢量瓦片样式图层的id，找到对应的矢量瓦片样式图层的序号]</a><br/>
<a href='#getStyleLayerId'>[3、通过矢量瓦片样式图层的序号，找到对应的矢量瓦片样式图层的id]</a><br/>
<a href='#setStyleLayer'>[4、设置样式图层属性对象]</a><br/>
<a href='#deleteStyleLayer'>[5、删除样式图层]</a><br/>
<a href='#setStyleLayerVisibility'>[6、设置样式图层可见性]</a><br/>
<a href='#getStyleLayerVisibility'>[7、获取样式图层可见性]</a><br/>
<a href='#getPaintProperties'>[8、获取样式图层绘制属性]</a><br/>
<a href='#setPaintProperties'>[9、设置样式图层绘制属性]</a><br/>
<a href='#getLayoutProperties'>[10、获取样式图层布局属性]</a><br/>
<a href='#setLayoutProperties'>[11、设置样式图层布局属性]</a><br/>
<a href='#setExtendProperties'>[12、设置样式图层的额外属性]</a><br/>
<a href='#getExtendProperties'>[13、获取样式图层的额外属性]</a><br/>
<a href='#fromJSON'>[14、通过传入的json构造并返回一个新的VectorTileLayer对象]</a><br/>
<a href='#toJSON'>[15、转换为json对象]</a><br/>
<a href='#clone'>[16、克隆方法]</a><br/></p>



    <h5>示例</h5>
    
        <p class="code-caption"><h7 id='custom-es5'>自定义矢量瓦片业务逻辑-es5</h7></p>
    
    
        <pre class="prettyprint"><code>// ES5引入方式
const { VectorTileLayer } = zondy.layer
// ES6引入方式
import { VectorTileLayer } from "@mapgis/webclient-common"
// 初始化矢量瓦片图层
const vectorTileLayerCustom = new VectorTileLayer({
  // 矢量瓦片基地址
  url: ''
});
// 例如通过重写vectorTileLayerCustom对象的load方法，来自定义矢量瓦片业务逻辑
vectorTileLayerCustom.load = (customStyle) => {
  // 你自己的业务逻辑，必须完成如下步骤
  // 1 初始化参考系
  // this.spatialReference = 参考系
  // 2 设置图层瓦片参数
  // this.tileInfo = 图层瓦片参数
  // 3 设置图层范围
  // this.extent = 图层范围
  // 4 设置矢量瓦片mvt样式
  // this.style = 矢量瓦片mvt样式
  // 5 如果有雪碧图参数，则要设置
  // this._style.sprite = 雪碧图参数
  // 6 必须返回一个Promise对象，并更新图层状态
  return new Promise((resolve) => {
    this.loadStatus = LoadStatus.loaded
    this.loaded = true
    resolve(this)
  })
}
// 在ES5模式下，如果更改了图层的业务逻辑，则必须通过图层的load方法来加载元信息，之后再添加图层
vectorTileLayerCustom.load().then(() => {
  // 添加图层
  map.add(vectorTileLayerCustom)
})</code></pre>
    

        <p class="code-caption"><h7 id='custom-es6'>自定义矢量瓦片业务逻辑-es6</h7></p>
    
    
        <pre class="prettyprint"><code>// ES6引入方式
import { VectorTileLayer } from "@mapgis/webclient-common"
// 在ES6模式下继承VectorTileLayer，并重写其业务逻辑
class VectorTileLayerCustom extends VectorTileLayer {
  constructor(options) {
    super(options)
  }
}
// 重写方法
VectorTileLayerCustom.prototype.load = (customStyle) => {
  // 你自己的业务逻辑，必须完成如下步骤
  // 1 初始化参考系
  // this.spatialReference = 参考系
  // 2 设置图层瓦片参数
  // this.tileInfo = 图层瓦片参数
  // 3 设置图层范围
  // this.extent = 图层范围
  // 4 设置矢量瓦片mvt样式
  // this.style = 矢量瓦片mvt样式
  // 5 如果有雪碧图参数，则要设置
  // this._style.sprite = 雪碧图参数
  // 6 必须返回一个Promise对象，并更新图层状态
  return new Promise((resolve) => {
    this.loadStatus = LoadStatus.loaded
    this.loaded = true
    resolve(this)
  })
}
const customLayer = new VectorTileLayerCustom({
  // 矢量瓦片基地址
  url: ''
})</code></pre>
    



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

        


    <ul>
        <li><a link="Layer.html" onclick="getTypeHTML(event)" href="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="#capabilities">capabilities</a></code></td>
                                <td class="name">
                                    <code>
                                        
<span class="param-type">
    
         Array.&lt;String>
    
</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)" href="Polygon.html">Polygon</a>
    
</span>
|

<span class="param-type">
    
             <a link="Extent.html" onclick="getTypeHTML(event)" href="Extent.html">Extent</a>
    
</span>
|

<span class="param-type">
    
             <a link="Circle.html" onclick="getTypeHTML(event)" href="Circle.html">Circle</a>
    
</span>
|

<span class="param-type">
    
             <a link="MultiPolygon.html" onclick="getTypeHTML(event)" href="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="#currentStyleInfo">currentStyleInfo</a></code></td>
                                <td class="name">
                                    <code>
                                        
<span class="param-type">
    
             Object
    
</span>



                                    </code>
                                </td>
                                <td class="name"><code><p>当前的矢量瓦片样式信息，包含serviceUrl 、styleUrl 、spriteUrl 、glyphsUrl 以及style</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="#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="#extensionOptions">extensionOptions</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)" href="Extent.html">Extent</a>
    
</span>



                                    </code>
                                </td>
                                <td class="name"><code><p>图层范围，从服务元信息中获取</p></code></td>
                            </tr>
                        
                            <tr class="deep-level-0">
                                <td class="name"><code><a href="#headers">headers</a></code></td>
                                <td class="name">
                                    <code>
                                        
<span class="param-type">
    
             String
    
</span>



                                    </code>
                                </td>
                                <td class="name"><code><p>设置服务请求头</p></code></td>
                            </tr>
                        
                            <tr class="deep-level-0">
                                <td class="name"><code><a href="#httpMethod">httpMethod</a></code></td>
                                <td class="name">
                                    <code>
                                        
<span class="param-type">
    
             <a link="FetchMethod.html" onclick="getTypeHTML(event)" href="global.html#FetchMethod">FetchMethod</a>
    
</span>



                                    </code>
                                </td>
                                <td class="name"><code><p>http请求方式</p></code></td>
                            </tr>
                        
                            <tr class="deep-level-0">
                                <td class="name"><code><a href="#id">id</a></code></td>
                                <td class="name">
                                    <code>
                                        
<span class="param-type">
    
             String
    
</span>



                                    </code>
                                </td>
                                <td class="name"><code><p>图层id</p></code></td>
                            </tr>
                        
                            <tr class="deep-level-0">
                                <td class="name"><code><a href="#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="#labelsRenderMode">labelsRenderMode</a></code></td>
                                <td class="name">
                                    <code>
                                        
<span class="param-type">
    
             String
    
</span>



                                    </code>
                                </td>
                                <td class="name"><code><p>指定矢量瓦片注记的渲染模式,仅在三维上有效；
on-screen: 使用Cesium接口实时渲染注记；
off-screen: 使用矢量瓦片来绘制注记；
请注意模式切换时，会造成性能损失，在显卡较弱的机器上会出现卡顿现象；</p></code></td>
                            </tr>
                        
                            <tr class="deep-level-0">
                                <td class="name"><code><a href="#loaded">loaded</a></code></td>
                                <td class="name">
                                    <code>
                                        
<span class="param-type">
    
             Boolean
    
</span>



                                    </code>
                                </td>
                                <td class="name"><code><p>是否加载完毕</p></code></td>
                            </tr>
                        
                            <tr class="deep-level-0">
                                <td class="name"><code><a href="#loadStatus">loadStatus</a></code></td>
                                <td class="name">
                                    <code>
                                        
<span class="param-type">
    
             String
    
</span>



                                    </code>
                                </td>
                                <td class="name"><code><p>图层加载状态</p></code></td>
                            </tr>
                        
                            <tr class="deep-level-0">
                                <td class="name"><code><a href="#maxScale">maxScale</a></code></td>
                                <td class="name">
                                    <code>
                                        
<span class="param-type">
    
             Number
    
</span>



                                    </code>
                                </td>
                                <td class="name"><code><p>最大显示比例尺，图层在视图中可见的最大比例尺(最放大)。如果地图被放大到超过这个比例，图层将不可见。默认值为0，0表示图层没有最大比例尺、可见性不受最大比例尺限制。maxScale应该始终小于minScale。</p></code></td>
                            </tr>
                        
                            <tr class="deep-level-0">
                                <td class="name"><code><a href="#minScale">minScale</a></code></td>
                                <td class="name">
                                    <code>
                                        
<span class="param-type">
    
             Number
    
</span>



                                    </code>
                                </td>
                                <td class="name"><code><p>最小显示比例尺，图层在视图中可见的最小比例尺(最缩小)。如果地图被缩小到超过这个比例，图层将不可见。默认值为0，0表示图层没有最小比例尺、可见性不受最小比例尺限制。minScale应该始终大于maxScale。</p></code></td>
                            </tr>
                        
                            <tr class="deep-level-0">
                                <td class="name"><code><a href="#mvtExtent">mvtExtent</a></code></td>
                                <td class="name">
                                    <code>
                                        
<span class="param-type">
    
             Number
    
</span>



                                    </code>
                                </td>
                                <td class="name"><code><p>mvt矢量瓦片相对坐标范围,默认为4096,表示矢量瓦片相对坐标的范围为0到4096</p></code></td>
                            </tr>
                        
                            <tr class="deep-level-0">
                                <td class="name"><code><a href="#opacity">opacity</a></code></td>
                                <td class="name">
                                    <code>
                                        
<span class="param-type">
    
             Number
    
</span>



                                    </code>
                                </td>
                                <td class="name"><code><p>图层透明度，0到1之间的值，0为完全透明，1为不透明，会触发图层更新完毕事件。IGSSceneLayer图层类型为地形时，不支持该属性。</p></code></td>
                            </tr>
                        
                            <tr class="deep-level-0">
                                <td class="name"><code><a href="#spatialReference">spatialReference</a></code></td>
                                <td class="name">
                                    <code>
                                        
<span class="param-type">
    
             <a link="SpatialReference.html" onclick="getTypeHTML(event)" href="SpatialReference.html">SpatialReference</a>
    
</span>



                                    </code>
                                </td>
                                <td class="name"><code><p>图层坐标系对象</p></code></td>
                            </tr>
                        
                            <tr class="deep-level-0">
                                <td class="name"><code><a href="#style">style</a></code></td>
                                <td class="name">
                                    <code>
                                        
<span class="param-type">
    
             Object
    
</span>



                                    </code>
                                </td>
                                <td class="name"><code><p>矢量瓦片的mvt样式对象</p></code></td>
                            </tr>
                        
                            <tr class="deep-level-0">
                                <td class="name"><code><a href="#tileInfo">tileInfo</a></code></td>
                                <td class="name">
                                    <code>
                                        
<span class="param-type">
    
             <a link="TileInfo.html" onclick="getTypeHTML(event)" href="TileInfo.html">TileInfo</a>
    
</span>
|

<span class="param-type">
    
             undefined
    
</span>



                                    </code>
                                </td>
                                <td class="name"><code><p>瓦片切图信息</p></code></td>
                            </tr>
                        
                            <tr class="deep-level-0">
                                <td class="name"><code><a href="#title">title</a></code></td>
                                <td class="name">
                                    <code>
                                        
<span class="param-type">
    
             String
    
</span>



                                    </code>
                                </td>
                                <td class="name"><code><p>图层名称</p></code></td>
                            </tr>
                        
                            <tr class="deep-level-0">
                                <td class="name"><code><a href="#tokenAttachType">tokenAttachType</a></code></td>
                                <td class="name">
                                    <code>
                                        
<span class="param-type">
    
             String
    
</span>



                                    </code>
                                </td>
                                <td class="name"><code><p>token附加类型。默认psot请求优先附加到body，get请求优先附加到url末尾</p></code></td>
                            </tr>
                        
                            <tr class="deep-level-0">
                                <td class="name"><code><a href="#tokenKey">tokenKey</a></code></td>
                                <td class="name">
                                    <code>
                                        
<span class="param-type">
    
             String
    
</span>



                                    </code>
                                </td>
                                <td class="name"><code><p>token名</p></code></td>
                            </tr>
                        
                            <tr class="deep-level-0">
                                <td class="name"><code><a href="#tokenValue">tokenValue</a></code></td>
                                <td class="name">
                                    <code>
                                        
<span class="param-type">
    
             String
    
</span>



                                    </code>
                                </td>
                                <td class="name"><code><p>token值</p></code></td>
                            </tr>
                        
                            <tr class="deep-level-0">
                                <td class="name"><code><a href="#type">type</a></code></td>
                                <td class="name">
                                    <code>
                                        
<span class="param-type">
    
             String
    
</span>



                                    </code>
                                </td>
                                <td class="name"><code><p>图层类型</p></code></td>
                            </tr>
                        
                            <tr class="deep-level-0">
                                <td class="name"><code><a href="#url">url</a></code></td>
                                <td class="name">
                                    <code>
                                        
<span class="param-type">
    
             String
    
</span>



                                    </code>
                                </td>
                                <td class="name"><code><p>矢量瓦片服务地址</p></code></td>
                            </tr>
                        
                            <tr class="deep-level-0">
                                <td class="name"><code><a href="#visible">visible</a></code></td>
                                <td class="name">
                                    <code>
                                        
<span class="param-type">
    
             Number
    
</span>



                                    </code>
                                </td>
                                <td class="name"><code><p>图层显示或隐藏，true则显示，false则隐藏，会触发图层更新完毕事件</p></code></td>
                            </tr>
                        
                    </tbody>
                </table>
            </div>
            <h4 style="margin-top: 20px;margin-bottom: 20px;">成员变量详情</h4>
            <div class="members">
            
                <div class="member">

    <span class="method-parameter is-pulled-right">
        <label>类型:</label>
        
<span class="param-type">
    
         Array.&lt;String>
    
</span>



    </span>

<h4 class="name" id="capabilities">
    <a class="href-link" href="#capabilities">#</a>
    
    <span class="code-name">
        capabilities
    </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)" href="Polygon.html">Polygon</a>
    
</span>
|

<span class="param-type">
    
             <a link="Extent.html" onclick="getTypeHTML(event)" href="Extent.html">Extent</a>
    
</span>
|

<span class="param-type">
    
             <a link="Circle.html" onclick="getTypeHTML(event)" href="Circle.html">Circle</a>
    
</span>
|

<span class="param-type">
    
             <a link="MultiPolygon.html" onclick="getTypeHTML(event)" href="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)" href="Layer.html#copyright">Layer#copyright</a>
    </li></ul></dd>
    

    

    

    

    

    

    

    

    

    
    

    

    

    
</dl>





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

    <span class="method-parameter is-pulled-right">
        <label>类型:</label>
        
<span class="param-type">
    
             Object
    
</span>



    </span>

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




<div class="description">
    <p>当前的矢量瓦片样式信息，包含serviceUrl 、styleUrl 、spriteUrl 、glyphsUrl 以及style</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="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)" href="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="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)" href="Layer.html#extendProps">Layer#extendProps</a>
    </li></ul></dd>
    

    

    

    

    

    

    

    

    

    
    <dt class="tag-default">Default Value:</dt>
    <dd class="tag-default"><ul class="dummy">
            <li>{}</li>
        </ul></dd>
    
    

    

    

    
</dl>





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

    <span class="method-parameter is-pulled-right">
        <label>类型:</label>
        
<span class="param-type">
    
             Object
    
</span>



    </span>

<h4 class="name" id="extensionOptions">
    <a class="href-link" href="#extensionOptions">#</a>
    
    <span class="code-name">
        extensionOptions
    </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="extensionOptions" link="Layer.html" onclick="getTypeHTML(event)" href="Layer.html#extensionOptions">Layer#extensionOptions</a>
    </li></ul></dd>
    

    

    

    

    

    

    

    

    

    
    <dt class="tag-default">Default Value:</dt>
    <dd class="tag-default"><ul class="dummy">
            <li>{}</li>
        </ul></dd>
    
    

    

    

    
</dl>





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

    <span class="method-parameter is-pulled-right">
        <label>类型:</label>
        
<span class="param-type">
    
             <a link="Extent.html" onclick="getTypeHTML(event)" href="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)" href="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)" href="Layer.html#headers">Layer#headers</a>
    </li></ul></dd>
    

    

    

    

    

    

    

    

    

    
    

    

    

    
</dl>





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

    <span class="method-parameter is-pulled-right">
        <label>类型:</label>
        
<span class="param-type">
    
             <a link="FetchMethod.html" onclick="getTypeHTML(event)" href="global.html#FetchMethod">FetchMethod</a>
    
</span>



    </span>

<h4 class="name" id="httpMethod">
    <a class="href-link" href="#httpMethod">#</a>
    
    <span class="code-name">
        httpMethod
    </span>
    
</h4>




<div class="description">
    <p>http请求方式</p>
</div>





<dl class="details">

    

    

    
    <dt class="inherited-from">Inherited From:</dt>
    <dd class="inherited-from"><ul class="dummy"><li>
        <a goto="httpMethod" link="Layer.html" onclick="getTypeHTML(event)" href="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)" href="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)" href="Layer.html#index">Layer#index</a>
    </li></ul></dd>
    

    

    

    

    

    

    

    

    

    
    

    

    

    
</dl>





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

    <span class="method-parameter is-pulled-right">
        <label>类型:</label>
        
<span class="param-type">
    
             String
    
</span>



    </span>

<h4 class="name" id="labelsRenderMode">
    <a class="href-link" href="#labelsRenderMode">#</a>
    
    <span class="code-name">
        labelsRenderMode
    </span>
    
</h4>




<div class="description">
    <p>指定矢量瓦片注记的渲染模式,仅在三维上有效；
on-screen: 使用Cesium接口实时渲染注记；
off-screen: 使用矢量瓦片来绘制注记；
请注意模式切换时，会造成性能损失，在显卡较弱的机器上会出现卡顿现象；</p>
</div>





<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    
    

    

    

    
</dl>





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

    <span class="method-parameter is-pulled-right">
        <label>类型:</label>
        
<span class="param-type">
    
             Boolean
    
</span>



    </span>

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




<div class="description">
    <p>是否加载完毕</p>
</div>





<dl class="details">

    

    

    
    <dt class="inherited-from">Inherited From:</dt>
    <dd class="inherited-from"><ul class="dummy"><li>
        <a goto="loaded" link="Layer.html" onclick="getTypeHTML(event)" href="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)" href="Layer.html#loadStatus">Layer#loadStatus</a>
    </li></ul></dd>
    

    

    

    

    

    

    

    

    

    
    <dt class="tag-default">Default Value:</dt>
    <dd class="tag-default"><ul class="dummy">
            <li>not-loaded</li>
        </ul></dd>
    
    

    

    

    
</dl>





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

    <span class="method-parameter is-pulled-right">
        <label>类型:</label>
        
<span class="param-type">
    
             Number
    
</span>



    </span>

<h4 class="name" id="maxScale">
    <a class="href-link" href="#maxScale">#</a>
    
    <span class="code-name">
        maxScale
    </span>
    
</h4>




<div class="description">
    <p>最大显示比例尺，图层在视图中可见的最大比例尺(最放大)。如果地图被放大到超过这个比例，图层将不可见。默认值为0，0表示图层没有最大比例尺、可见性不受最大比例尺限制。maxScale应该始终小于minScale。</p>
</div>





<dl class="details">

    

    

    
    <dt class="inherited-from">Inherited From:</dt>
    <dd class="inherited-from"><ul class="dummy"><li>
        <a goto="maxScale" link="Layer.html" onclick="getTypeHTML(event)" href="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)" href="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="mvtExtent">
    <a class="href-link" href="#mvtExtent">#</a>
    
    <span class="code-name">
        mvtExtent
    </span>
    
</h4>




<div class="description">
    <p>mvt矢量瓦片相对坐标范围,默认为4096,表示矢量瓦片相对坐标的范围为0到4096</p>
</div>





<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    
    <dt class="tag-default">Default Value:</dt>
    <dd class="tag-default"><ul class="dummy">
            <li>4096</li>
        </ul></dd>
    
    

    

    

    
</dl>





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

    <span class="method-parameter is-pulled-right">
        <label>类型:</label>
        
<span class="param-type">
    
             Number
    
</span>



    </span>

<h4 class="name" id="opacity">
    <a class="href-link" href="#opacity">#</a>
    
    <span class="code-name">
        opacity
    </span>
    
</h4>




<div class="description">
    <p>图层透明度，0到1之间的值，0为完全透明，1为不透明，会触发图层更新完毕事件。IGSSceneLayer图层类型为地形时，不支持该属性。</p>
</div>





<dl class="details">

    

    

    
    <dt class="inherited-from">Inherited From:</dt>
    <dd class="inherited-from"><ul class="dummy"><li>
        <a goto="opacity" link="Layer.html" onclick="getTypeHTML(event)" href="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)" href="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 href="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">
    
             Object
    
</span>



    </span>

<h4 class="name" id="style">
    <a class="href-link" href="#style">#</a>
    
    <span class="code-name">
        style
    </span>
    
</h4>




<div class="description">
    <p>矢量瓦片的mvt样式对象</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="TileInfo.html" onclick="getTypeHTML(event)" href="TileInfo.html">TileInfo</a>
    
</span>
|

<span class="param-type">
    
             undefined
    
</span>



    </span>

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




<div class="description">
    <p>瓦片切图信息</p>
</div>





<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    
    

    

    

    
</dl>





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

    <span class="method-parameter is-pulled-right">
        <label>类型:</label>
        
<span class="param-type">
    
             String
    
</span>



    </span>

<h4 class="name" id="title">
    <a class="href-link" href="#title">#</a>
    
    <span class="code-name">
        title
    </span>
    
</h4>




<div class="description">
    <p>图层名称</p>
</div>





<dl class="details">

    

    

    
    <dt class="inherited-from">Inherited From:</dt>
    <dd class="inherited-from"><ul class="dummy"><li>
        <a goto="title" link="Layer.html" onclick="getTypeHTML(event)" href="Layer.html#title">Layer#title</a>
    </li></ul></dd>
    

    

    

    

    

    

    

    

    

    
    

    

    

    
</dl>





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

    <span class="method-parameter is-pulled-right">
        <label>类型:</label>
        
<span class="param-type">
    
             String
    
</span>



    </span>

<h4 class="name" id="tokenAttachType">
    <a class="href-link" href="#tokenAttachType">#</a>
    
    <span class="code-name">
        tokenAttachType
    </span>
    
</h4>




<div class="description">
    <p>token附加类型。默认psot请求优先附加到body，get请求优先附加到url末尾</p>
</div>





<dl class="details">

    

    

    
    <dt class="inherited-from">Inherited From:</dt>
    <dd class="inherited-from"><ul class="dummy"><li>
        <a goto="tokenAttachType" link="Layer.html" onclick="getTypeHTML(event)" href="Layer.html#tokenAttachType">Layer#tokenAttachType</a>
    </li></ul></dd>
    

    

    

    

    

    

    

    

    

    
    

    

    

    
</dl>





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

    <span class="method-parameter is-pulled-right">
        <label>类型:</label>
        
<span class="param-type">
    
             String
    
</span>



    </span>

<h4 class="name" id="tokenKey">
    <a class="href-link" href="#tokenKey">#</a>
    
    <span class="code-name">
        tokenKey
    </span>
    
</h4>




<div class="description">
    <p>token名</p>
</div>





<dl class="details">

    

    

    
    <dt class="inherited-from">Inherited From:</dt>
    <dd class="inherited-from"><ul class="dummy"><li>
        <a goto="tokenKey" link="Layer.html" onc