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

mapgis ES6 format for igserver

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





<section>

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


    
    <h4 class="name" id="IGSMapImageSubLayer">
        <a class="href-link" href="#IGSMapImageSubLayer">#</a>
        
        <span class="code-name" id="IGSMapImageSubLayer" style="font-size:30px">
            
                new IGSMapImageSubLayer<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"><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">
      
      </td>
  

  <td class="description last"><p>gdbp路径地址</p></td>
</tr>


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

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



  
  </td>

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

  <td class="description last"><p>渲染样式对象，支持如下渲染样式：<br/>
<a href="UniqueValueRenderer.html"><code>1、单值渲染</code></a><br/>
<a href="ClassBreakRenderer.html"><code>2、分段渲染</code></a></p></td>
</tr>


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

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



  
  </td>

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

  <td class="description last"><p>要素过滤参数，类似sql语句</p></td>
</tr>


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

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



  
  </td>

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

  <td class="description last"><p>几何过滤条件对象，通过次参数可以在出图时，通过几何进行要素过滤</p></td>
</tr>


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

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



  
  </td>

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

  <td class="description last"><p>图层名称</p></td>
</tr>


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

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



  
  </td>

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

  <td class="description last"><p>图层坐标系</p></td>
</tr>


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

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



  
  </td>

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

  <td class="description last"><p>图层可见性</p></td>
</tr>


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

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



  
  </td>

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

  <td class="description last"><p>图层的父图层对象</p></td>
</tr>


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

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



  
  </td>

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

  <td class="description last"><p>图层id</p></td>
</tr>


  



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






<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    
    

    

    

    
</dl>























    <h5>示例</h5>
    
        <p class="code-caption"><h7 id='definitionExpression'>过滤要显示的要素 - 初始化时设置</h7></p>
    
    
        <pre class="prettyprint"><code>// ES5引入方式
const { Map } = zondy
const { IGSMapImageLayer } = zondy.layer
// ES6引入方式
import { Map, IGSMapImageLayer  } from "@mapgis/webclient-common"
// 初始化地图图片图层
const igsMapImageLayer = new IGSMapImageLayer({
  url: '服务基地址',
  // 设置子图层的要素过滤参数
  sublayers: [
    {
      id: "子图层id",
      definitionExpression: "类sql的查询语句"
    }
  ]
});
map.add(igsMapImageLayer);</code></pre>
    



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

        


    <ul>
        <li><a link="SubLayer.html" onclick="getTypeHTML(event)" href="SubLayer.html">SubLayer</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="#definitionExpression">definitionExpression</a></code></td>
                                <td class="name">
                                    <code>
                                        
<span class="param-type">
    
             String
    
</span>



                                    </code>
                                </td>
                                <td class="name"><code><p>要素过滤参数，类似sql语句</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="#id">id</a></code></td>
                                <td class="name">
                                    <code>
                                        
<span class="param-type">
    
             String
    
</span>



                                    </code>
                                </td>
                                <td class="name"><code><p>图层id，不给则生成随机id</p></code></td>
                            </tr>
                        
                            <tr class="deep-level-0">
                                <td class="name"><code><a href="#layer">layer</a></code></td>
                                <td class="name">
                                    <code>
                                        
<span class="param-type">
    
             <a link="Layer.html" onclick="getTypeHTML(event)" href="Layer.html">Layer</a>
    
</span>



                                    </code>
                                </td>
                                <td class="name"><code><p>父图层对象</p></code></td>
                            </tr>
                        
                            <tr class="deep-level-0">
                                <td class="name"><code><a href="#renderer">renderer</a></code></td>
                                <td class="name">
                                    <code>
                                        
<span class="param-type">
    
             <a link="BaseRenderer.html" onclick="getTypeHTML(event)" href="BaseRenderer.html">BaseRenderer</a>
    
</span>



                                    </code>
                                </td>
                                <td class="name"><code><p>渲染样式对象</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="#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="#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="#visible">visible</a></code></td>
                                <td class="name">
                                    <code>
                                        
<span class="param-type">
    
             Boolean
    
</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">
    
             String
    
</span>



    </span>

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




<div class="description">
    <p>要素过滤参数，类似sql语句</p>
</div>





<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    
    

    

    

    
</dl>





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

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



    </span>

<h4 class="name" id="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="SubLayer.html" onclick="getTypeHTML(event)" href="SubLayer.html#extendProps">SubLayer#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="SubLayer.html" onclick="getTypeHTML(event)" href="SubLayer.html#extensionOptions">SubLayer#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">
    
             String
    
</span>



    </span>

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




<div class="description">
    <p>图层id，不给则生成随机id</p>
</div>





<dl class="details">

    

    

    

    
    <dt class="tag-overrides">Overrides:</dt>
    <dd class="tag-overrides"><ul class="dummy"><li>
        <a href="SubLayer.html#id">SubLayer#id</a>
    </li></ul></dd>
    

    

    

    

    

    

    

    

    
    

    

    

    
</dl>





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

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



    </span>

<h4 class="name" id="layer">
    <a class="href-link" href="#layer">#</a>
    
    <span class="code-name">
        layer
    </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="SubLayer.html#layer">SubLayer#layer</a>
    </li></ul></dd>
    

    

    

    

    

    

    

    

    
    

    

    

    
</dl>





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

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



    </span>

<h4 class="name" id="renderer">
    <a class="href-link" href="#renderer">#</a>
    
        
            <span class='tag'>readonly</span>
        
    
    <span class="code-name">
        renderer
    </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="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="SubLayer.html#spatialReference">SubLayer#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 href="SubLayer.html#sublayers">SubLayer#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="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="SubLayer.html" onclick="getTypeHTML(event)" href="SubLayer.html#title">SubLayer#title</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="visible">
    <a class="href-link" href="#visible">#</a>
    
    <span class="code-name">
        visible
    </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="SubLayer.html#visible">SubLayer#visible</a>
    </li></ul></dd>
    

    

    

    

    

    

    

    

    
    

    

    

    
</dl>





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

    
        <div class='vertical-section'>
            <h3 id='function'>方法</h3>
            <h4 style="margin-top: 20px;margin-bottom: 20px;">方法概述</h4>
            <div class="members">
            <div class="table-container">
                <table class="params table">
                    <thead>
                    <tr>
                        <th>名称</th>
                        <th>返回值类型</th>
                        <th>描述</th>
                    </tr>
                    </thead>
                    <tbody>
                        
                            <tr class="deep-level-0">
                                <td class="name"><code><a href="#clone">clone</a></code></td>
                                <td class="name">
                                    <code>
                                        
                                                
<span class="param-type">
    
             <a link="IGSMapImageSubLayer.html" onclick="getTypeHTML(event)" href="IGSMapImageSubLayer.html">IGSMapImageSubLayer</a>
    
</span>



                                            
                                    </code>
                                </td>
                                <td class="name"><code><p>克隆图层对象</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="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 href="SubLayer.html#clone">SubLayer#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="IGSMapImageSubLayer.html" onclick="getTypeHTML(event)" href="IGSMapImageSubLayer.html">IGSMapImageSubLayer</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 href="SubLayer.html#toJSON">SubLayer#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>josn对象</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>