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

mapgis ES6 format for igserver

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





<section>

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


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

    
    <div class="description">
        <p>三维注记符号，用于在三维场景中渲染线几何要素，不支持在二维视图中使用；<br/>
三维注记符号必须包含如下符号图层中的一个或多个，才能在三维场景中显示要素：<br/>
<a href="TextSymbol3DLayer.html"><code>三维文字符号图层</code></a><br/>
示例如下：<br/>
<a href='#LabelSymbol3D'>[1、创建一个三维注记符号对象]</a><br/></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"><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"><code>symbolLayers</code></td>
  

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



  
  </td>

  

  <td class="description last"><p>symbolLayers 符号图层集合，用于可视化要素对象</p></td>
</tr>


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

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



  
  </td>

  

  <td class="description last"><p>注记索引线样式，该线会链接注记和所属要素，当一个符号相对于原始位置有偏移时，该符号能显示其真实位置</p></td>
</tr>


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

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



  
  </td>

  

  <td class="description last"><p>符号垂直偏移量，将一个符号在竖直世界轴的方向上进行平移</p></td>
</tr>


  



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






<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    
    

    

    

    
</dl>





















<p class="summary"><h5>支持如下方法：</h5>
<a href='#fromJSON'>[1、通过json数据构造一个LabelSymbol3D对象]</a><br/>
<a href='#toJSON'>[2、导出为JSON对象]</a><br/>
<a href='#clone'>[3、克隆并返回一个新的LabelSymbol3D对象]</a><br/></p>



    <h5>示例</h5>
    
        <p class="code-caption"><h7 id='LabelSymbol3D'>创建一个三维注记符号对象</h7></p>
    
    
        <pre class="prettyprint"><code>// ES5引入方式
const { Color } = zondy
const { LabelSymbol3D, TextSymbol3DLayer } = zondy.symbol
// ES6引入方式
import { LabelSymbol3D, TextSymbol3DLayer, Color } from "@mapgis/webclient-common"

// 创建一个三维点符号
const symbol = new LabelSymbol3D({
  // 设置符号图层，可以设置多个
  symbolLayers: [
    // 设置三维文字符号图层
    new TextSymbol3DLayer({
      // 文字内容
      text: '你的文字内容',
      // 文字大小
      size: 40,
      // 文字颜色
      material: new ColorMaterial({
        color: new Color(255, 1, 1, 1)
      })
    })
  ]
})</code></pre>
    



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

        


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



                                    </code>
                                </td>
                                <td class="name"><code><p>注记索引线样式，该线会链接注记和所属要素，当一个符号相对于原始位置有偏移时，该符号能显示其真实位置</p></code></td>
                            </tr>
                        
                            <tr class="deep-level-0">
                                <td class="name"><code><a href="#symbolLayers">symbolLayers</a></code></td>
                                <td class="name">
                                    <code>
                                        
<span class="param-type">
    
             <a link="Collection.html" onclick="getTypeHTML(event)" href="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="#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="#verticalOffset">verticalOffset</a></code></td>
                                <td class="name">
                                    <code>
                                        
<span class="param-type">
    
             <a link="Symbol3DVerticalOffset.html" onclick="getTypeHTML(event)" href="Symbol3DVerticalOffset.html">Symbol3DVerticalOffset</a>
    
</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="LineCallout3D.html" onclick="getTypeHTML(event)" href="LineCallout3D.html">LineCallout3D</a>
    
</span>



    </span>

<h4 class="name" id="callout">
    <a class="href-link" href="#callout">#</a>
    
    <span class="code-name">
        callout
    </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="Collection.html" onclick="getTypeHTML(event)" href="Collection.html">Collection</a>
    
</span>



    </span>

<h4 class="name" id="symbolLayers">
    <a class="href-link" href="#symbolLayers">#</a>
    
    <span class="code-name">
        symbolLayers
    </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="symbolLayers" link="Symbol3D.html" onclick="getTypeHTML(event)" href="Symbol3D.html#symbolLayers">Symbol3D#symbolLayers</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="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">
    
             <a link="Symbol3DVerticalOffset.html" onclick="getTypeHTML(event)" href="Symbol3DVerticalOffset.html">Symbol3DVerticalOffset</a>
    
</span>



    </span>

<h4 class="name" id="verticalOffset">
    <a class="href-link" href="#verticalOffset">#</a>
    
    <span class="code-name">
        verticalOffset
    </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>
                                        
                                                
<span class="param-type">
    
             <a link="LabelSymbol3D.html" onclick="getTypeHTML(event)" href="LabelSymbol3D.html">LabelSymbol3D</a>
    
</span>



                                            
                                    </code>
                                </td>
                                <td class="name"><code></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="LabelSymbol3D.html" onclick="getTypeHTML(event)" href="LabelSymbol3D.html">LabelSymbol3D</a>
    
</span>



                                            
                                    </code>
                                </td>
                                <td class="name"><code></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></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">
        <a id='fromJSON'/>
通过json数据构造一个LabelSymbol3D对象
    </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"><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>新的LabelSymbol3D对象</p></div>
    
    
    <div class='column is-5 has-text-left'>
        <label>类型: </label>
        
<span class="param-type">
    
             <a link="LabelSymbol3D.html" onclick="getTypeHTML(event)" href="LabelSymbol3D.html">LabelSymbol3D</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">
        <a id='clone'/>
克隆并返回一个新的LabelSymbol3D对象
    </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>新的LabelSymbol3D对象</p></div>
    
    
    <div class='column is-5 has-text-left'>
        <label>类型: </label>
        
<span class="param-type">
    
             <a link="LabelSymbol3D.html" onclick="getTypeHTML(event)" href="LabelSymbol3D.html">LabelSymbol3D</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><a id='toJSON'></a>
导出为JSON对象</p>
    </div>
    













<dl class="details">

    

    

    

    
    <dt class="tag-overrides">Overrides:</dt>
    <dd class="tag-overrides"><ul class="dummy"><li>
        <a href="Symbol3D.html#toJSON">Symbol3D#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>