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

mapgis ES6 format for igserver

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





<section>

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


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

    
    <div class="description">
        <p>ArcGIS地图图片图层，<br/>
目前二维上支持4326(包括4490，4214以及4610)，3857以及EPSG支持的自定义坐标系，三维上仅支持4326(包括4490，4214以及4610)以及3857坐标系，会自动读取元信息上的坐标系，不需要用户指定
<br><br>[ES5引入方式]：<br/>
Zondy.Layer.ArcGISMapImageLayer() <br/>
[ES6引入方式]：<br/>
import { ArcGISMapImageLayer } 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/>
https://{ip}:{port}/arcgis/rest/services/{serviceName}/MapServer，参考示例：<a href='#arcgis'>[ArcGIS的地图图片图层示例]</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>图层坐标系，支持4326(包含4490，4214以及4610)、3857以及EPSG上的自定义坐标系，坐标系默认从元信息中获取，也可指定坐标系，
参考示例：<a href='#spatialReference'>[指定图层的坐标系示例]</a></p></td>
</tr>


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

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



  
  </td>

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

  <td class="description last"><p>图片宽度，单位px，参考示例：<a href='#tileSize'>[设置图片大小]</a></p></td>
</tr>


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

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



  
  </td>

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

  <td class="description last"><p>图片高度，单位px，参考示例：<a href='#tileSize'>[设置图片大小]</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="imageTransparency"><code>imageTransparency</code></td>
  

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



  
  </td>

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

  <td class="description last"><p>图片中没有数据的地方是否透明，默认为true，即透明</p></td>
</tr>


  



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

















<p class="summary"><h5>支持如下方法：</h5>
<a href='#load'>[1、加载图层资源]</a><br/>
<a href='#findSublayerById'>[2、根据子图层id查询子图层]</a><br/>
<a href='#refresh'>[3、刷新图层]</a><br/>
<a href='#fetchImage'>[4、根据范围和大小获取image标签]</a><br/>
<a href='#createServiceSublayers'>[5、创建一个该服务的子图层克隆对象]</a><br/>
<a href='#getImageUrl'>[6、根据参数获取图片的url]</a><br/>
<a href='#setSubLayer'>[7、更新子图层]</a><br/>
<a href='#fromJSON'>[8、通过传入的json构造并返回一个新的几何对象]</a><br/>
<a class="mapgis-link-name" title="OGCLayer#toJSON" OGCLayer.html#toJSON><code>9、导出为json对象</code></a><br/>
<a class="mapgis-link-name" title="OGCLayer#clone" OGCLayer.html#clone><code>10、克隆几何对象</code></a></p>



    <h5>示例</h5>
    
        <p class="code-caption"><h7 id='arcgis'>ArcGIS的地图图片图层示例</h7></p>
    
    
        <pre class="prettyprint"><code>// 初始化图层管理容器
// ES5引入方式
const { ArcGISMapImageLayer } = Zondy.Layer
// ES6引入方式
import { ArcGISMapImageLayer } from "@mapgis/webclient-common"
// 添加图层
const arcGISMapImageLayer = new ArcGISMapImageLayer({
  // 服务基地址
  url: 'http://{ip}:{port}/arcgis/rest/services/{serviceName}/MapServer'
});</code></pre>
    

        <p class="code-caption"><h7 id='spatialReference'>指定图层的坐标系示例</h7></p>
    
    
        <pre class="prettyprint"><code>// ES5引入方式
const { ArcGISMapImageLayer } = Zondy.Layer
const { SpatialReference } = Zondy
// ES6引入方式
import { ArcGISMapImageLayer,SpatialReference } from "@mapgis/webclient-common"
// 添加图层
const arcGISMapImageLayer = new ArcGISMapImageLayer({
  // 服务基地址
  url: 'http://{ip}:{port}/arcgis/rest/services/{serviceName}/MapServer',
  // 自定义坐标新
  spatialReference: new SpatialReference({
    // 指定的wkid号，可在https://epsg.io/网站查询
    wkid: '指定的wkid号'
  })
});</code></pre>
    

        <p class="code-caption"><h7 id='tileSize'>地图图层示例 - 设置图片大小</h7></p>
    
    
        <pre class="prettyprint"><code>// ES5引入方式
const { ArcGISMapImageLayer } = Zondy.Layer
// ES6引入方式
import { ArcGISMapImageLayer } from "@mapgis/webclient-common"
// 添加图层
const arcGISMapImageLayer = new ArcGISMapImageLayer({
  // 服务基地址
  url: 'http://{ip}:{port}/arcgis/rest/services/{serviceName}/MapServer',
  // 瓦片宽度
  imageWidth: 512,
  // 瓦片高度
  imageHeight: 512
});</code></pre>
    

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

// 加载完成后设置
arcGISMapImageLayer.on('layerview-created', function (result) {
  console.log("加载完毕:", result.layer)
  // 视点跳转
  ArcGISMapImageLayer.opacity = 0.5
})</code></pre>
    

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

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

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

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



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

        


    <ul>
        <li><a link="MapImageLayer.html" onclick="getTypeHTML(event)" class="mapgis-link-name" title="MapImageLayer" MapImageLayer.html>MapImageLayer</a></li>
    </ul>


    

    

    

    

    

    

    
        <div class='vertical-section'>
            <h3 id='member'>成员变量</h3>
            <h4 style="margin-top: 20px;margin-bottom: 20px;">成员变量概述</h4>
            <div class="table-container">
                <table class="params table">
                    <thead>
                    <tr>
                        <th>名称</th>
                        <th>类型</th>
                        <th>描述</th>
                    </tr>
                    </thead>
                    <tbody>
                        
                            <tr class="deep-level-0">
                                <td class="name"><code><a href="#allSublayers">allSublayers</a></code></td>
                                <td class="name">
                                    <code>
                                        
<span class="param-type"><a link="Collection.html" onclick="getTypeHTML(event)" class="mapgis-link-name" title="Collection" Collection.html>Collection</a></span>



                                    </code>
                                </td>
                                <td class="name"><code><p>所有子图层信息</p></code></td>
                            </tr>
                        
                            <tr class="deep-level-0">
                                <td class="name"><code><a href="#capabilities">capabilities</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="#documentInfo">documentInfo</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="#dynamicProjectionEnabled">dynamicProjectionEnabled</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="#dynamicProjectionEnabled">dynamicProjectionEnabled</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="#extent">extent</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="#imageFormat">imageFormat</a></code></td>
                                <td class="name">
                                    <code>
                                        
<span class="param-type">String</span>



                                    </code>
                                </td>
                                <td class="name"><code><p>图片格式</p></code></td>
                            </tr>
                        
                            <tr class="deep-level-0">
                                <td class="name"><code><a href="#imageHeight">imageHeight</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="#imageTransparency">imageTransparency</a></code></td>
                                <td class="name">
                                    <code>
                                        
<span class="param-type">Boolean</span>



                                    </code>
                                </td>
                                <td class="name"><code><p>图片中没有数据的地方是否透明</p></code></td>
                            </tr>
                        
                            <tr class="deep-level-0">
                                <td class="name"><code><a href="#imageWidth">imageWidth</a></code></td>
                                <td class="name">
                                    <code>
                                        
<span class="param-type">Number</span>



                                    </code>
                                </td>
                                <td class="name"><code><p>瓦片化显示时，瓦片宽度</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="#renderMode">renderMode</a></code></td>
                                <td class="name">
                                    <code>
                                        
<span class="param-type">String</span>



                                    </code>
                                </td>
                                <td class="name"><code><p>渲染模式，分为瓦片渲染'tile'和图像渲染'image'</p></code></td>
                            </tr>
                        
                            <tr class="deep-level-0">
                                <td class="name"><code><a href="#spatialReference">spatialReference</a></code></td>
                                <td class="name">
                                    <code>
                                        
<span class="param-type"><a link="SpatialReference.html" onclick="getTypeHTML(event)" class="mapgis-link-name" title="SpatialReference" SpatialReference.html>SpatialReference</a></span>



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



                                    </code>
                                </td>
                                <td class="name"><code><p>子图层对象</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>
                        
                    </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="Collection.html" onclick="getTypeHTML(event)" class="mapgis-link-name" title="Collection" Collection.html>Collection</a></span>



    </span>

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




<div class="description">
    <p>所有子图层信息</p>
</div>





<dl class="details">

    

    

    

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

    

    

    

    

    

    

    

    

    

    

    

    
    

    

    

    
</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="documentInfo">
    <a class="href-link" href="#documentInfo">#</a>
    
        
            <span class='tag'>readonly</span>
        
    
    <span class="code-name">
        documentInfo
    </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="MapImageLayer#documentInfo" MapImageLayer.html#documentInfo>MapImageLayer#documentInfo</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="dynamicProjectionEnabled">
    <a class="href-link" href="#dynamicProjectionEnabled">#</a>
    
    <span class="code-name">
        dynamicProjectionEnabled
    </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">Boolean</span>



    </span>

<h4 class="name" id="dynamicProjectionEnabled">
    <a class="href-link" href="#dynamicProjectionEnabled">#</a>
    
    <span class="code-name">
        dynamicProjectionEnabled
    </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="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="tag-overrides">Overrides:</dt>
    <dd class="tag-overrides"><ul class="dummy"><li>
        <a class="mapgis-link-name" title="MapImageLayer#extent" MapImageLayer.html#extent>MapImageLayer#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="imageFormat">
    <a class="href-link" href="#imageFormat">#</a>
    
    <span class="code-name">
        imageFormat
    </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="MapImageLayer#imageFormat" MapImageLayer.html#imageFormat>MapImageLayer#imageFormat</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="imageHeight">
    <a class="href-link" href="#imageHeight">#</a>
    
    <span class="code-name">
        imageHeight
    </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="MapImageLayer#imageHeight" MapImageLayer.html#imageHeight>MapImageLayer#imageHeight</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="imageTransparency">
    <a class="href-link" href="#imageTransparency">#</a>
    
    <span class="code-name">
        imageTransparency
    </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="MapImageLayer#imageTransparency" MapImageLayer.html#imageTransparency>MapImageLayer#imageTransparency</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="imageWidth">
    <a class="href-link" href="#imageWidth">#</a>
    
    <span class="code-name">
        imageWidth
    </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="MapImageLayer#imageWidth" MapImageLayer.html#imageWidth>MapImageLayer#imageWidth</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="mapName">
    <a class="href-link" href="#mapName">#</a>
    
        
            <span class='tag'>readonly</span>
        
    
    <span class="code-name">
        mapName
    </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="MapImageLayer#mapName" MapImageLayer.html#mapName>MapImageLayer#mapName</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="renderMode">
    <a class="href-link" href="#renderMode">#</a>
    
    <span class="code-name">
        renderMode
    </span>
    
</h4>




<div class="description">
    <p>渲染模式，分为瓦片渲染'tile'和图像渲染'image'</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="MapImageLayer#renderMode" MapImageLayer.html#renderMode>MapImageLayer#renderMode</a>
    </li></ul></dd>
    

    

    

    

    

    

    

    

    
    

    

    

    
</dl>





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

    <span class="method-parameter is-pulled-right">
        <label>类型:</label>
        
<span class="param-type"><a link="SpatialReference.html" onclick="getTypeHTML(event)" class="mapgis-link-name" title="SpatialReference" SpatialReference.html>SpatialReference</a></span>



    </span>

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




<div class="description">
    <p>图层坐标系对象</p>
</div>





<dl class="details">

    

    

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

    

    

    

    

    

    

    

    

    
    

    

    

    
</dl>





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

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



    </span>

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




<div class="description">
    <p>子图层对象</p>
</div>





<dl class="details">

    

    

    

    
    <dt class="tag-overrides">Overrides:</dt>
    <dd class="tag-overrides"><ul class="dummy"><li>
        <a class="mapgis-link-name" title="MapImageLayer#sublayers" MapImageLayer.html#sublayers>MapImageLayer#sublayers</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">

    

    

    

    

    

    

    

    

    

    

    

    
    

    

    

    
</dl>





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

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



    </span>

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




<div class="description">
    <p>服务基地址</p>
</div>





<dl class="details">

    

    

    

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



                                            
                                    </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="FeatureLayer.html" onclick="getTypeHTML(event)" class="mapgis-link-name" title="FeatureLayer" FeatureLayer.html>FeatureLayer</a></span>



                                            
                                    </code>
                                </td>
                                <td class="name"><code><p>克隆方法</p></code></td>
                            </tr>
                        
                            <tr class="deep-level-0">
                                <td class="name"><code><a href="#createServiceSublayers">createServiceSublayers</a></code></td>
                                <td class="name">
                                    <code>
                                        
                                                
<span class="param-type">Array</span>



                                            
                                    </code>
                                </td>
                                <td class="name"><code><p>创建一个该服务的子图层克隆对象，注意不是本地的子图层对象<a id='createServiceSublayers'></a></p></code></td>
                            </tr>
                        
                            <tr class="deep-level-0">
                                <td class="name"><code><a href="#fetchImage">fetchImage</a></code></td>
                                <td class="name">
                                    <code>
                                        
                                                
<span class="param-type">Promise</span>



                                            
                                    </code>
                                </td>
                                <td class="name"><code><p>根据范围和大小获取image标签</p></code></td>
                            </tr>
                        
                            <tr class="deep-level-0">
                                <td class="name"><code><a href="#findSublayerById">findSublayerById</a></code></td>
                                <td class="name">
                                    <code>
                                        
                                                
<span class="param-type">Object</span>



                                            
                                    </code>
                                </td>
                                <td class="name"><code><p>根据子图层id查询子图层<a id='findSublayerById'></a></p></code></td>
                            </tr>
                        
                            <tr class="deep-level-0">
                                <td class="name"><code><a href="#getImageUrl">getImageUrl</a></code></td>
                                <td class="name">
                                    <code>
                                        
                                                
<span class="param-type">String</span>



                                            
                                    </code>
                                </td>
                                <td class="name"><code><p>根据参数获取图片的url</p></code></td>
                            </tr>
                        
                            <tr class="deep-level-0">
                                <td class="name"><code><a href="#refresh">refresh</a></code></td>
                                <td class="name">
                                    <code>
                                        
                                    </code>
                                </td>
                                <td class="name"><code><p>刷新图层<a id='refresh'></a></p></code></td>
                            </tr>
                        
                            <tr class="deep-level-0">
                                <td class="name"><code><a href="#setSubLayer">setSubLayer</a></code></td>
                                <td class="name">
                                    <code>
                                        
                                    </code>
                                </td>
                                <td class="name"><code><p>更新子图层<a id='setSubLayer'></a></p></code></td>
                            </tr>
                        
                            <tr class="deep-level-0">
                                <td class="name"><code><a href="#toJSON">toJSON</a></code></td>
                                <td class="name">
                                    <code>
                                        
                                                
<span class="param-type">Object</span>



                                            
                                    </code>
                                </td>
                                <td class="name"><code><p>转换为json对象</p></code></td>
                            </tr>
                        
                    </tbody>
                </table>
            </div>
            <h4 style="margin-top: 20px;margin-bottom: 20px;">方法详情</h4>
            
                <div class="member">


    
    <h4 class="name" id=".fromJSON">
        <a class="href-link" href="#.fromJSON">#</a>
        
            
                <span class='tag'>static</span>
            
        
        <span class="code-name" id="fromJSON" style="font-size:30px">
            
                fromJSON<span class="signature">(json<span class="signature-attributes">opt</span>)</span>
            
        </span>
    </h4>
    

    
    <div class="description">
        <p>通过传入的json构造并返回一个新的几何对象<a id='fromJSON'></a></p>
    </div>
    









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

            <th>类型</th>

            

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

        <tbody>
        

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

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



  
  </td>

  

  <td class="description last"><p>JSON对象</p></td>
</tr>



        
        </tbody>
    </table>
</div>






<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    
    

    

    

    
</dl>


















    <div class='columns method-parameter'>
        <div class="column is-2"><label>返回值</label></div>
        <div class="column is-10">
            
                    

<div class="columns">
    
    <div class='param-desc column is-7'><p>新的ArcGISMapImageLayer对象</p></div>
    
    
    <div class='column is-5 has-text-left'>
        <label>类型: </label>
        
<span class="param-type"><a link="ArcGISMapImageLayer.html" onclick="getTypeHTML(event)" class="mapgis-link-name" title="ArcGISMapImageLayer" ArcGISMapImageLayer.html>ArcGISMapImageLayer</a></span>



    </div>
    
</div>

                
        </div>
    </div>






    <h5>示例</h5>
    
        <p class="code-caption"><h7>通过传入的json构造并返回一个新的几何对象</h7></p>
    
    
        <pre class="prettyprint"><code> // ES5引入方式
const { ArcGISMapImageLayer } = Zondy.Layer
// ES6引入方式
import { ArcGISMapImageLayer } from "@mapgis/webclient-common"
const json = {
  // 服务基地址
  url: 'http://{ip}:{port}/arcgis/rest/services/{serviceName}/MapServer',
}
const arcGISMapImageLayer = new ArcGISMapImageLayer.fromJSON(json)</code></pre>
    


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


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

    
    <div class="description">
        <p>克隆方法</p>
    </div>
    













<dl class="details">

    

    

    

    
    <dt class="tag-overrides">Overrides:</dt>
    <dd class="tag-overrides"><ul class="dummy"><li>
        <a class="mapgis-link-name" title="MapImageLayer#clone" MapImageLayer.html#clone>MapImageLayer#clone</a>
    </li></ul></dd>
    

    

    

    

    

    

    

    

    
    

    

    

    
</dl>


















    <div class='columns method-parameter'>
        <div class="column is-2"><label>返回值</label></div>
        <div class="column is-10">
            
                    

<div class="columns">
    
    <div class='param-desc column is-7'><p>图层</p></div>
    
    
    <div class='column is-5 has-text-left'>
        <label>类型: </label>
        
<span class="param-type"><a link="FeatureLayer.html" onclick="getTypeHTML(event)" class="mapgis-link-name" title="FeatureLayer" FeatureLayer.html>FeatureLayer</a></span>



    </div>
    
</div>

                
        </div>
    </div>






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


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

    
    <div class="description">
        <p>创建一个该服务的子图层克隆对象，注意不是本地的子图层对象<a id='createServiceSublayers'></a></p>
    </div>
    













<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    
    

    

    

    
</dl>


















    <div class='columns method-parameter'>
        <div class="column is-2"><label>返回值</label></div>
        <div class="column is-10">
            
                    

<div class="columns">
    
    <div class='param-desc column is-7'><p>服务上的子图层对象</p></div>
    
    
    <div class='column is-5 has-text-left'>
        <label>类型: </label>
        
<span class="param-type">Array</span>



    </div>
    
</div>

                
        </div>
    </div>






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


    
    <h4 class="name" id="fetchImage">
        <a class="href-link" href="#fetchImage">#</a>
        
        <span class="code-name" id="fetchImage" style="font-size:30px">
            
                fetchImage<span class="signature">(extent, width<span class="signature-attributes">opt</span>, height<span class="signature-attributes">opt</span>)</span>
            
        </span>
    </h4>
    

    
    <div class="description">
        <p>根据范围和大小获取image标签</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="extent"><code>extent</code></td>
  

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



  
  </td>

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

  <td class="description last"><p>范围参数</p></td>
</tr>



        

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

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



  
  </td>

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

  <td class="description last"><p>图片宽度，单位px</p></td>
</tr>



        

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

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



  
  </td>

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

  <td class="description last"><p>图片高度，单位px</p></td>
</tr>



        
        </tbody>
    </table>
</div>






<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    
    

    

    

    
</dl>


















    <div class='columns method-parameter'>
        <div class="colu