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

mapgis ES6 format for igserver

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





<section>

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


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

    
    <div class="description">
        <p>注记样式，参考示例：<a href='#new-LabelClass'>[创建注记样式对象]</a></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="symbol"><code>symbol</code></td>
  

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

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



  
  </td>

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

  <td class="description last"><p>文本符号样式</p></td>
</tr>


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

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



  
  </td>

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

  <td class="description last"><p>注记渲染方式,1.canvas 2.label 3.ground(测试)</p></td>
</tr>


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

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



  
  </td>

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

  <td class="description last"><p>渲染模式为ground时，设置像素与实际单位米之间的比例关系。测试接口。假设groundScale为10，20<em>20px的像素范围贴地时会被渲染为200</em>200m的注记。</p></td>
</tr>


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

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



  
  </td>

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

  <td class="description last"><p>注记避让策略，可选1.'static'默认避让策略 2.'none' 无避让策略</p></td>
</tr>


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

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



  
  </td>

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

  <td class="description last"><p>注记显示的最大比例尺（比例尺的分母，该值越小，比例尺越大）。默认值为undefined，undefined表示用户未设置。maxScale的值应该始终小于minScale的值,单位为米,不支持渲染类型renderMode为ground的模式。</p></td>
</tr>


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

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



  
  </td>

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

  <td class="description last"><p>注记显示的最小比例尺（比例尺的分母，该值越大，比例尺越小）。默认值为undefined，undefined表示用户未设置。minScale的值应该始终大于maxScale的值,单位为米,不支持渲染类型renderMode为ground的模式。</p></td>
</tr>


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

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



  
  </td>

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

  <td class="description last"><p>高程描述信息</p></td>
</tr>


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

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



  
  </td>

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

  <td class="description last"><p>布局位置，描述注记和几何之间的关系,此设置会覆盖符号symbol内关于文字布局样式的定义。针对于点类型可选项1.above-left 2.above-center 3.above-right 4.center-left 5.center-center 6.center-right 7.below-left 8.below-center 9.below-right 针对于线类型 1.'on-line' 压线 2.'above-line' 线上 3.'under-line' 线下 针对于区类型1.'parallel' 平行 2.'outside' 区外 3.'bottom' 底部 4.'skeleton' 骨架线</p></td>
</tr>


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

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



  
  </td>

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

  <td class="description last"><p>当前属性字段,属于临时接口,后续可能会扩充字段表达式，拟废弃，推荐使用labelExpression接口</p></td>
</tr>


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

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



  
  </td>

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

  <td class="description last"><p>label字段表达式,例如设置值为&quot;$feature.n&quot;,表示以feature上的n字段的字段值作为文本显示。</p></td>
</tr>


  
    
<tr class="deep-level-1">
  
      <td class="name" id="repeatLabel"><code>repeatLabel</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" id="repeatLabelDistance"><code>repeatLabelDistance</code></td>
  

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



  
  </td>

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

  <td class="description last"><p>重复步长，限制线几何类型使用，单位为米</p></td>
</tr>


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

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



  
  </td>

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

  <td class="description last"><p>开始步长比例，限制线几何、区几何类型使用，范围为0~1。0表示步长分段的开始，1表示步长分段的结尾。</p></td>
</tr>


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

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



  
  </td>

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

  <td class="description last"><p>结束步长比例，限制线几何、区几何类型使用，范围为0~1。0表示步长分段的开始，1表示步长分段的结尾。</p></td>
</tr>


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

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



  
  </td>

  
      <td class="default">
      
          'auto-spread'
      
      </td>
  

  <td class="description last"><p>线注记分布方式  1.'auto-spread' 字母集中，汉字分散 2.'centralization-spread'集中 3.'decentralize-spread' 分散。限制线几何使用。</p></td>
</tr>


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

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



  
  </td>

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

  <td class="description last"><p>线文字与线关系，仅集中注记时生效。1.'start' 线头 2.'middle' 线中点 3.'end' 线尾，限制线使用。</p></td>
</tr>


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

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



  
  </td>

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

  <td class="description last"><p>骨架线开始步长比例，限制区几何类型使用，范围为0~1。0表示步长分段的开始，1表示步长分段的结尾。</p></td>
</tr>


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

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



  
  </td>

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

  <td class="description last"><p>骨架线结束步长比例，限制区几何类型使用，范围为0~1。0表示步长分段的开始，1表示步长分段的结尾。</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>样式的扩展参数，可以通过该属性传入引擎原生图元的样式参数。可以参考cesium上Label、BillBoard、GroundPrimitive相关api进行设置。</p></td>
</tr>


  



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






<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    
    

    

    

    
</dl>





















<p class="summary"><h5>支持如下方法：</h5>
<a href='#toJSON'>[1、转换为json对象]</a><br/>
<a href='#clone'>[2、克隆并返回一个新的LabelClass对象]</a><br/>
<a href='#fromJSON'>[3、将JSON里的数据导入，并返回一个新的LabelClass对象]</a><br/></p>



    <h5>示例</h5>
    
        <p class="code-caption"><h7 id='new-LabelClass'>初始化注记样式</h7></p>
    
    
        <pre class="prettyprint"><code>const labelClass = new Zondy.LabelClass({
  // 指定文本符号样式
  symbol: new Zondy.Symbol.TextSymbol({
    // 文字颜色
    color: new Color(252, 100, 22, 1),
    // 文字样式
    font: new Zondy.Font({
      // 字体
      family: "微软雅黑",
      // 文字大小，单位像素
      size: 30,
      // 文字是否为斜体，正常模式
      style: "normal",
      // 文字粗细
      weight: "normal"
    })
  })
})</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="#currentAttributeName">currentAttributeName</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="#deconflictionStrategy">deconflictionStrategy</a></code></td>
                                <td class="name">
                                    <code>
                                        
<span class="param-type">String</span>



                                    </code>
                                </td>
                                <td class="name"><code><p>避让策略，可选1.'static'默认避让策略 2.'none' 无避让策略</p></code></td>
                            </tr>
                        
                            <tr class="deep-level-0">
                                <td class="name"><code><a href="#elevationInfo">elevationInfo</a></code></td>
                                <td class="name">
                                    <code>
                                        
<span class="param-type"><a link="ElevationInfo.html" onclick="getTypeHTML(event)" class="mapgis-link-name" title="ElevationInfo" ElevationInfo.html>ElevationInfo</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="#groundScale">groundScale</a></code></td>
                                <td class="name">
                                    <code>
                                        
<span class="param-type">Number</span>



                                    </code>
                                </td>
                                <td class="name"><code><p>渲染模式为ground时，设置像素与实际单位米之间的比例关系。测试接口。假设groundScale为10，20<em>20px的逻辑范围贴地时会被渲染为200</em>200m的注记。</p></code></td>
                            </tr>
                        
                            <tr class="deep-level-0">
                                <td class="name"><code><a href="#labelExpression">labelExpression</a></code></td>
                                <td class="name">
                                    <code>
                                        
<span class="param-type">String</span>



                                    </code>
                                </td>
                                <td class="name"><code><p>label字段表达式</p></code></td>
                            </tr>
                        
                            <tr class="deep-level-0">
                                <td class="name"><code><a href="#labelPlacement">labelPlacement</a></code></td>
                                <td class="name">
                                    <code>
                                        
<span class="param-type">String</span>



                                    </code>
                                </td>
                                <td class="name"><code><p>布局位置，描述注记和几何之间的关系。针对于点类型可选项1.above-left 2.above-center 3.above-right 4.center-left 5.center-center 6.center-right 7.below-left 8.below-center 9.below-right 针对于线类型 1.'on-line' 压线 2.'above-line' 线上 3.'under-line' 线下 针对于区类型1.'parallel' 平行 2.'outside' 区外 3.'bottom' 底部 4.'skeleton' 骨架线</p></code></td>
                            </tr>
                        
                            <tr class="deep-level-0">
                                <td class="name"><code><a href="#labelPositionAlong">labelPositionAlong</a></code></td>
                                <td class="name">
                                    <code>
                                        
<span class="param-type">String</span>



                                    </code>
                                </td>
                                <td class="name"><code><p>线文字与线关系，仅集中注记时生效。1.'start' 线头 2.'middle' 线中点 3.'end' 线尾，限制线使用。</p></code></td>
                            </tr>
                        
                            <tr class="deep-level-0">
                                <td class="name"><code><a href="#lineLabelSpread">lineLabelSpread</a></code></td>
                                <td class="name">
                                    <code>
                                        
<span class="param-type">String</span>



                                    </code>
                                </td>
                                <td class="name"><code><p>线注记分布方式  1.'auto-spread' 字母集中，汉字分散 2.'centralization-spread'集中 3.'decentralize-spread' 分散。限制线几何使用。</p></code></td>
                            </tr>
                        
                            <tr class="deep-level-0">
                                <td class="name"><code><a href="#maxScale">maxScale</a></code></td>
                                <td class="name">
                                    <code>
                                        
<span class="param-type">Number</span>



                                    </code>
                                </td>
                                <td class="name"><code><p>注记显示的最大比例尺（比例尺的分母，该值越小，比例尺越大）。默认值为undefined，undefined表示用户未设置。maxScale的值应该始终小于minScale的值,单位为米,不支持渲染类型renderMode为ground的模式。</p></code></td>
                            </tr>
                        
                            <tr class="deep-level-0">
                                <td class="name"><code><a href="#minScale">minScale</a></code></td>
                                <td class="name">
                                    <code>
                                        
<span class="param-type">Number</span>



                                    </code>
                                </td>
                                <td class="name"><code><p>注记显示的最小比例尺（比例尺的分母，该值越大，比例尺越小）。默认值为undefined，undefined表示用户未设置。minScale的值应该始终大于maxScale的值,单位为米,不支持渲染类型renderMode为ground的模式。</p></code></td>
                            </tr>
                        
                            <tr class="deep-level-0">
                                <td class="name"><code><a href="#renderMode">renderMode</a></code></td>
                                <td class="name">
                                    <code>
                                        
<span class="param-type">String</span>



                                    </code>
                                </td>
                                <td class="name"><code><p>注记渲染方式,1.canvas 2.label 3.ground(测试)</p></code></td>
                            </tr>
                        
                            <tr class="deep-level-0">
                                <td class="name"><code><a href="#repeatEndRate">repeatEndRate</a></code></td>
                                <td class="name">
                                    <code>
                                        
<span class="param-type">Number</span>



                                    </code>
                                </td>
                                <td class="name"><code><p>结束步长比例，限制线几何、区几何类型使用，范围为0~1。0表示步长分段的开始，1表示步长分段的结尾。</p></code></td>
                            </tr>
                        
                            <tr class="deep-level-0">
                                <td class="name"><code><a href="#repeatLabel">repeatLabel</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="#repeatLabelDistance">repeatLabelDistance</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="#repeatStartRate">repeatStartRate</a></code></td>
                                <td class="name">
                                    <code>
                                        
<span class="param-type">Number</span>



                                    </code>
                                </td>
                                <td class="name"><code><p>开始步长比例，限制线几何、区几何类型使用，范围为0~1。0表示步长分段的开始，1表示步长分段的结尾。</p></code></td>
                            </tr>
                        
                            <tr class="deep-level-0">
                                <td class="name"><code><a href="#skeletonLineEndRate">skeletonLineEndRate</a></code></td>
                                <td class="name">
                                    <code>
                                        
<span class="param-type">String</span>



                                    </code>
                                </td>
                                <td class="name"><code><p>骨架线结束步长比例，限制区几何类型使用，范围为0~1。0表示步长分段的开始，1表示步长分段的结尾。</p></code></td>
                            </tr>
                        
                            <tr class="deep-level-0">
                                <td class="name"><code><a href="#skeletonLineStartRate">skeletonLineStartRate</a></code></td>
                                <td class="name">
                                    <code>
                                        
<span class="param-type">String</span>



                                    </code>
                                </td>
                                <td class="name"><code><p>骨架线开始步长比例，限制区几何类型使用，范围为0~1。0表示步长分段的开始，1表示步长分段的结尾。</p></code></td>
                            </tr>
                        
                            <tr class="deep-level-0">
                                <td class="name"><code><a href="#symbol">symbol</a></code></td>
                                <td class="name">
                                    <code>
                                        
<span class="param-type"><a link="MapGISTextSymbol.html" onclick="getTypeHTML(event)" class="mapgis-link-name" title="MapGISTextSymbol" MapGISTextSymbol.html>MapGISTextSymbol</a></span>
|

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



    </span>

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




<div class="description">
    <p>避让策略，可选1.'static'默认避让策略 2.'none' 无避让策略</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="ElevationInfo.html" onclick="getTypeHTML(event)" class="mapgis-link-name" title="ElevationInfo" ElevationInfo.html>ElevationInfo</a></span>



    </span>

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



    </span>

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




<div class="description">
    <p>渲染模式为ground时，设置像素与实际单位米之间的比例关系。测试接口。假设groundScale为10，20<em>20px的逻辑范围贴地时会被渲染为200</em>200m的注记。</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="labelExpression">
    <a class="href-link" href="#labelExpression">#</a>
    
    <span class="code-name">
        labelExpression
    </span>
    
</h4>




<div class="description">
    <p>label字段表达式</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="labelPlacement">
    <a class="href-link" href="#labelPlacement">#</a>
    
    <span class="code-name">
        labelPlacement
    </span>
    
</h4>




<div class="description">
    <p>布局位置，描述注记和几何之间的关系。针对于点类型可选项1.above-left 2.above-center 3.above-right 4.center-left 5.center-center 6.center-right 7.below-left 8.below-center 9.below-right 针对于线类型 1.'on-line' 压线 2.'above-line' 线上 3.'under-line' 线下 针对于区类型1.'parallel' 平行 2.'outside' 区外 3.'bottom' 底部 4.'skeleton' 骨架线</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="labelPositionAlong">
    <a class="href-link" href="#labelPositionAlong">#</a>
    
    <span class="code-name">
        labelPositionAlong
    </span>
    
</h4>




<div class="description">
    <p>线文字与线关系，仅集中注记时生效。1.'start' 线头 2.'middle' 线中点 3.'end' 线尾，限制线使用。</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="lineLabelSpread">
    <a class="href-link" href="#lineLabelSpread">#</a>
    
    <span class="code-name">
        lineLabelSpread
    </span>
    
</h4>




<div class="description">
    <p>线注记分布方式  1.'auto-spread' 字母集中，汉字分散 2.'centralization-spread'集中 3.'decentralize-spread' 分散。限制线几何使用。</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="maxScale">
    <a class="href-link" href="#maxScale">#</a>
    
    <span class="code-name">
        maxScale
    </span>
    
</h4>




<div class="description">
    <p>注记显示的最大比例尺（比例尺的分母，该值越小，比例尺越大）。默认值为undefined，undefined表示用户未设置。maxScale的值应该始终小于minScale的值,单位为米,不支持渲染类型renderMode为ground的模式。</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="minScale">
    <a class="href-link" href="#minScale">#</a>
    
    <span class="code-name">
        minScale
    </span>
    
</h4>




<div class="description">
    <p>注记显示的最小比例尺（比例尺的分母，该值越大，比例尺越小）。默认值为undefined，undefined表示用户未设置。minScale的值应该始终大于maxScale的值,单位为米,不支持渲染类型renderMode为ground的模式。</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="renderMode">
    <a class="href-link" href="#renderMode">#</a>
    
    <span class="code-name">
        renderMode
    </span>
    
</h4>




<div class="description">
    <p>注记渲染方式,1.canvas 2.label 3.ground(测试)</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="repeatEndRate">
    <a class="href-link" href="#repeatEndRate">#</a>
    
    <span class="code-name">
        repeatEndRate
    </span>
    
</h4>




<div class="description">
    <p>结束步长比例，限制线几何、区几何类型使用，范围为0~1。0表示步长分段的开始，1表示步长分段的结尾。</p>
</div>





<dl class="details">

    

    

    

    

    

    

    

    

    

    

    

    
    

    

    

    
</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="repeatLabel">
    <a class="href-link" href="#repeatLabel">#</a>
    
    <span class="code-name">
        repeatLabel
    </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="repeatLabelDistance">
    <a class="href-link" href="#repeatLabelDistance">#</a>
    
    <span class="code-name">
        repeatLabelDistance
    </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="repeatStartRate">
    <a class="href-link" href="#repeatStartRate">#</a>
    
    <span class="code-name">
        repeatStartRate
    </span>
    
</h4>




<div class="description">
    <p>开始步长比例，限制线几何、区几何类型使用，范围为0~1。0表示步长分段的开始，1表示步长分段的结尾。</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="skeletonLineEndRate">
    <a class="href-link" href="#skeletonLineEndRate">#</a>
    
    <span class="code-name">
        skeletonLineEndRate
    </span>
    
</h4>




<div class="description">
    <p>骨架线结束步长比例，限制区几何类型使用，范围为0~1。0表示步长分段的开始，1表示步长分段的结尾。</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="skeletonLineStartRate">
    <a class="href-link" href="#skeletonLineStartRate">#</a>
    
    <span class="code-name">
        skeletonLineStartRate
    </span>
    
</h4>




<div class="description">
    <p>骨架线开始步长比例，限制区几何类型使用，范围为0~1。0表示步长分段的开始，1表示步长分段的结尾。</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="MapGISTextSymbol.html" onclick="getTypeHTML(event)" class="mapgis-link-name" title="MapGISTextSymbol" MapGISTextSymbol.html>MapGISTextSymbol</a></span>
|

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



    </span>

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



                                            
                                    </code>
                                </td>
                                <td class="name"><code><p>将JSON里的数据导入，并返回一个新的LabelClass对象<a id='fromJSON'></a></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="LabelClass.html" onclick="getTypeHTML(event)" class="mapgis-link-name" title="LabelClass" LabelClass.html>LabelClass</a></span>



                                            
                                    </code>
                                </td>
                                <td class="name"><code><p>克隆并返回一个新的LabelClass对象<a id='clone'></a></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对象<a id='toJSON'></a></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 class="signature-attributes">opt</span>)</span>
            
        </span>
    </h4>
    

    
    <div class="description">
        <p>将JSON里的数据导入，并返回一个新的LabelClass对象<a id='fromJSON'></a></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>新的LabelClass对象</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>新的LabelClass对象</p></div>
    
    
    <div class='column is-5 has-text-left'>
        <label>类型: </label>
        
<span class="param-type"><a link="LabelClass.html" onclick="getTypeHTML(event)" class="mapgis-link-name" title="LabelClass" LabelClass.html>LabelClass</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>克隆并返回一个新的LabelClass对象<a id='clone'></a></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>新的LabelClass对象</p></div>
    
    
    <div class='column is-5 has-text-left'>
        <label>类型: </label>
        
<span class="param-type"><a link="LabelClass.html" onclick="getTypeHTML(event)" class="mapgis-link-name" title="LabelClass" LabelClass.html>LabelClass</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对象<a id='toJSON'></a></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>