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

mapgis ES6 format for igserver

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





<section>

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


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

    
    <div class="description">
        <p>size视觉变量</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="options"><code>options</code></td>
  

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



  
  </td>

  

  <td class="description last"><p>初始化参数</p></td>
</tr>


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

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



  
  </td>

  

  <td class="description last"><p>最大数据值,超过这个数值以最大size显示</p></td>
</tr>


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

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



  
  </td>

  

  <td class="description last"><p>符号最大size</p></td>
</tr>


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

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



  
  </td>

  

  <td class="description last"><p>最小数据值，小于这个数值以最小size显示</p></td>
</tr>


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

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



  
  </td>

  

  <td class="description last"><p>符号最小size</p></td>
</tr>


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

  <td class="type">
  
      
<span class="param-type">Array.&lt;<a link="Array.<SizeStop>.html" onclick="getTypeHTML(event)" href="SizeStop.html">SizeStop</a>></span>



  
  </td>

  

  <td class="description last"><p>颜色分段数组</p></td>
</tr>


  



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






<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    
    

    

    

    
</dl>























    <h5>示例</h5>
    
    
        <pre class="prettyprint"><code>// 获取layer上renderer对象
 const renderer = layer.renderer
// 根据FID取值设置符号大小
// FID取值小于0时，设置符号大小为5
// FID取值大于300时 ，设置符号大小为20
// FID取值在0-300之间时，显示符号大小过渡值
// 设置size视觉变量方法一
 renderer.visualVariables = [{
          type: "size",
          field: "FID",
          minDataValue:0,
          maxDataValue:300,
          minSize:5,
          maxSize:20,
    }]
   // 设置size视觉变量方法二
 renderer.visualVariables = [
     {
          type: "size",
          valueExpression: "$feature.FID",
          stops:[
            {
              size:5,
              value:0
            },
            {
              size:20,
              value:300
            }
          ]
     }
  ]  </code></pre>
    



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

    

    

    

    

    

    
        <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="#maxDataValue">maxDataValue</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="#maxSize">maxSize</a></code></td>
                                <td class="name">
                                    <code>
                                        
<span class="param-type">Number</span>



                                    </code>
                                </td>
                                <td class="name"><code><p>符号最大size</p></code></td>
                            </tr>
                        
                            <tr class="deep-level-0">
                                <td class="name"><code><a href="#minDataValue">minDataValue</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="#minSize">minSize</a></code></td>
                                <td class="name">
                                    <code>
                                        
<span class="param-type">Number</span>



                                    </code>
                                </td>
                                <td class="name"><code><p>符号最小size</p></code></td>
                            </tr>
                        
                            <tr class="deep-level-0">
                                <td class="name"><code><a href="#stops">stops</a></code></td>
                                <td class="name">
                                    <code>
                                        
<span class="param-type">Array.&lt;<a link="Array.<SizeStop>.html" onclick="getTypeHTML(event)" href="SizeStop.html">SizeStop</a>></span>



                                    </code>
                                </td>
                                <td class="name"><code><p>size分段数组</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">Number</span>



    </span>

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




<div class="description">
    <p>最大数据值</p>
</div>





<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    
    

    

    

    
</dl>





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

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



    </span>

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




<div class="description">
    <p>符号最大size</p>
</div>





<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    
    

    

    

    
</dl>





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

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



    </span>

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




<div class="description">
    <p>最小数据值</p>
</div>





<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    
    

    

    

    
</dl>





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

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



    </span>

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




<div class="description">
    <p>符号最小size</p>
</div>





<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    
    

    

    

    
</dl>





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

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



    </span>

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




<div class="description">
    <p>size分段数组</p>
</div>





<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    
    

    

    

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



                                            
                                    </code>
                                </td>
                                <td class="name"><code><p>通过json构造SizeVariable对象</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="SizeVariable.html" onclick="getTypeHTML(event)" class="mapgis-link-name" title="SizeVariable" SizeVariable.html>SizeVariable</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=".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">()</span>
            
        </span>
    </h4>
    

    
    <div class="description">
        <p>通过json构造SizeVariable对象</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>json对象</p></div>
    
    
    <div class='column is-5 has-text-left'>
        <label>类型: </label>
        
<span class="param-type"><a link="SizeVariable.html" onclick="getTypeHTML(event)" class="mapgis-link-name" title="SizeVariable" SizeVariable.html>SizeVariable</a></span>



    </div>
    
</div>

                
        </div>
    </div>






</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">

    

    

    

    

    

    

    

    

    

    

    

    
    

    

    

    
</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>克隆后的SizeVariable对象</p></div>
    
    
    <div class='column is-5 has-text-left'>
        <label>类型: </label>
        
<span class="param-type"><a link="SizeVariable.html" onclick="getTypeHTML(event)" class="mapgis-link-name" title="SizeVariable" SizeVariable.html>SizeVariable</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">

    

    

    

    

    

    

    

    

    

    

    

    
    

    

    

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