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

mapgis ES6 format for igserver

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





<section>

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


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

    
    <div class="description">
        <p>符号基类</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="color"><code>color</code></td>
  

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

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

<span class="param-type">Array</span>
|

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



  
  </td>

  
      <td class="default">
      
          new Color(255, 255, 255, 0.25)
      
      </td>
  

  <td class="description last"><p>颜色</p></td>
</tr>


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

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



  
  </td>

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

  <td class="description last"><p>符号的扩展参数。可以通过该属性传入引擎原生图元的样式参数。
该参数的优先级高于二维符号、三维符号图层自身属性的优先级（如果有冲突时采用extendOptions中指定的）。符号类型与原生图元类型的对照表参见： <a href="tutorial-符号.html"><h7>目前支持的几种符号类型</h7></a></p></td>
</tr>


  



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






<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    
    

    
    <dt class="tag-see">See:</dt>
    <dd class="tag-see">
        <ul>
            <li><p><a href="tutorial-符号.html"><h4>目前支持的几种符号类型</h4></a></p></li>
        </ul>
    </dd>
    

    

    
</dl>























    <h5>示例</h5>
    
    
        <pre class="prettyprint"><code>设置颜色的几种方式
1.结构化形式
symbol.color = new Color(255, 255, 255, 0.25)
symbol.color ={
   red:255,
   green:0,
   blue:0,
   alpha:1
}
2.数组
symbol.color = [255,0,0]
symbol.color = [255,0,0,1]
3.字符串
symbol.color = '#ff0000'
symbol.color = 'rgba(255,0,0,1)'</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="#color">color</a></code></td>
                                <td class="name">
                                    <code>
                                        
<span class="param-type"><a link="Color.html" onclick="getTypeHTML(event)" class="mapgis-link-name" title="Color" Color.html>Color</a></span>



                                    </code>
                                </td>
                                <td class="name"><code><p>颜色</p></code></td>
                            </tr>
                        
                            <tr class="deep-level-0">
                                <td class="name"><code><a href="#extendOptions">extendOptions</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="#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>
                        
                    </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="Color.html" onclick="getTypeHTML(event)" class="mapgis-link-name" title="Color" Color.html>Color</a></span>



    </span>

<h4 class="name" id="color">
    <a class="href-link" href="#color">#</a>
    
    <span class="code-name">
        color
    </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">Object</span>



    </span>

<h4 class="name" id="extendOptions">
    <a class="href-link" href="#extendOptions">#</a>
    
    <span class="code-name">
        extendOptions
    </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="type">
    <a class="href-link" href="#type">#</a>
    
    <span class="code-name">
        type
    </span>
    
</h4>




<div class="description">
    <p>符号类型</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>
                                        
                                    </code>
                                </td>
                                <td class="name"><code><p>通过json文件构建symbol</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="Symbol.html" onclick="getTypeHTML(event)" class="mapgis-link-name" title="Symbol" Symbol.html>Symbol</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">(json)</span>
            
        </span>
    </h4>
    

    
    <div class="description">
        <p>通过json文件构建symbol</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>























    <h5>示例</h5>
    
    
        <pre class="prettyprint"><code>// ES5引入方式
const { Symbol, Color } = Zondy
// ES6引入方式
import { Symbol, Color } from "@mapgis/webclient-common"
const simpleLineSymbol = Symbol.fromJSON({
    type:'simple-line',
    color:new Color(255,255,255,1),
    width:2
})</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">

    

    

    

    

    

    

    

    

    

    

    

    
    

    

    

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