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

mapgis ES6 format for igserver

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





<section>

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


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

    
    <div class="description">
        <p>IGS影像图层</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>服务链接</p></td>
</tr>


  



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






<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    
    

    

    

    
</dl>
























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

        


    <ul>
        <li><a 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="IGSImageLayer.html#allSublayers">allSublayers</a></code></td>
                                <td class="name">
                                    <code>
                                        
<span class="param-type"><a 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="IGSImageLayer.html#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="IGSImageLayer.html#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="IGSImageLayer.html#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="IGSImageLayer.html#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="IGSImageLayer.html#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="IGSImageLayer.html#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="IGSImageLayer.html#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="IGSImageLayer.html#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="IGSImageLayer.html#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="IGSImageLayer.html#sublayers">sublayers</a></code></td>
                                <td class="name">
                                    <code>
                                        
<span class="param-type"><a 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="IGSImageLayer.html#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 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="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">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 class="mapgis-link-name" title="Collection" Collection.html>Collection</a></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="inherited-from">Inherited From:</dt>
    <dd class="inherited-from"><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="url">
    <a class="href-link" href="#url">#</a>
    
    <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="IGSImageLayer.html#clone">clone</a></code></td>
                                <td class="name">
                                    <code>
                                        
                                                
<span class="param-type"><a class="mapgis-link-name" title="IGSImageLayer" IGSImageLayer.html>IGSImageLayer</a></span>


                                            
                                    </code>
                                </td>
                                <td class="name"><code><p>克隆方法</p></code></td>
                            </tr>
                        
                            <tr class="deep-level-0">
                                <td class="name"><code><a href="IGSImageLayer.html#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="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 class="mapgis-link-name" title="IGSImageLayer" IGSImageLayer.html>IGSImageLayer</a></span>


    </div>
    
</div>

                
        </div>
    </div>






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


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

    
    <div class="description">
        <p>转换为json对象</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#toJSON" MapImageLayer.html#toJSON>MapImageLayer#toJSON</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>json对象</p></div>
    
    
    <div class='column is-5 has-text-left'>
        <label>类型: </label>
        
<span class="param-type">Object</span>


    </div>
    
</div>

                
        </div>
    </div>






</div>
            
            </div>
        </div>
    

    

    
</article>

</section>