@mapgis/webclient-cesium-plugin 17.2.2 → 17.2.4

package/documention/MeasureSlopeTool.html

@@ -0,0 +1,1141 @@
+<header id="page-title" class="page-title">
+    
+        <span class="page-title-main">类名</span>
+        <span class="page-title-sub">MeasureSlopeTool</span>
+    
+</header>
+
+
+
+
+
+<section>
+
+<article>
+    <div class="container-overview">
+    
+        
+            <div class='vertical-section'>
+                <div class="members">
+                    <div class="member">
+                        
+
+
+    
+    <h4 class="name" id="MeasureSlopeTool">
+        <a class="href-link" href="#MeasureSlopeTool">#</a>
+        
+        <span class="code-name" id="MeasureSlopeTool" style="font-size:30px">
+            
+                new MeasureSlopeTool<span class="signature">(viewer, options)</span>
+            
+        </span>
+    </h4>
+    
+
+    
+
+
+
+
+
+
+
+
+
+    <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>viewer</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-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>callBack</code></td>
+  
+
+  <td class="type">
+  
+      
+<span class="param-type">
+    
+             Boolean
+    
+</span>
+
+
+
+  
+  </td>
+
+  
+      <td class="default">
+      
+          function(result, positions){}
+      
+      </td>
+  
+
+  <td class="description last"><p>回调函数</p></td>
+</tr>
+
+
+  
+    
+<tr class="deep-level-1">
+  
+      <td class="name"><code>labelCallBack</code></td>
+  
+
+  <td class="type">
+  
+      
+<span class="param-type">
+    
+             Boolean
+    
+</span>
+
+
+
+  
+  </td>
+
+  
+      <td class="default">
+      
+          function(result, label){}
+      
+      </td>
+  
+
+  <td class="description last"><p>测量完毕后提示框的回调函数，可以覆盖提示内容</p></td>
+</tr>
+
+
+  
+    
+<tr class="deep-level-1">
+  
+      <td class="name"><code>disableDepthTestDistance</code></td>
+  
+
+  <td class="type">
+  
+      
+<span class="param-type">
+    
+             Number
+    
+</span>
+
+
+
+  
+  </td>
+
+  
+      <td class="default">
+      
+          Number.POSITIVE_INFINITY
+      
+      </td>
+  
+
+  <td class="description last"><p>只要小于这个距离深度检测就会失效，就会一直显示在最前面 不会被遮挡</p></td>
+</tr>
+
+
+  
+    
+<tr class="deep-level-1">
+  
+      <td class="name"><code>lineColor</code></td>
+  
+
+  <td class="type">
+  
+      
+<span class="param-type">
+    
+             Cesium.Color
+    
+</span>
+
+
+
+  
+  </td>
+
+  
+      <td class="default">
+      
+      </td>
+  
+
+  <td class="description last"><p>线段颜色</p></td>
+</tr>
+
+
+  
+    
+<tr class="deep-level-1">
+  
+      <td class="name"><code>pointColor</code></td>
+  
+
+  <td class="type">
+  
+      
+<span class="param-type">
+    
+             Cesium.Color
+    
+</span>
+
+
+
+  
+  </td>
+
+  
+      <td class="default">
+      
+      </td>
+  
+
+  <td class="description last"><p>点颜色</p></td>
+</tr>
+
+
+  
+    
+<tr class="deep-level-1">
+  
+      <td class="name"><code>style</code></td>
+  
+
+  <td class="type">
+  
+      
+<span class="param-type">
+    
+             Cesium.LabelStyle
+    
+</span>
+
+
+
+  
+  </td>
+
+  
+      <td class="default">
+      
+          Cesium.LabelStyle.FILL
+      
+      </td>
+  
+
+  <td class="description last"><p>label 文字的样式，支持填充、线框。填充和线框， FILL, OUTLINE, FILL_AND_OUTLINE</p></td>
+</tr>
+
+
+  
+    
+<tr class="deep-level-1">
+  
+      <td class="name"><code>font</code></td>
+  
+
+  <td class="type">
+  
+      
+<span class="param-type">
+    
+             String
+    
+</span>
+
+
+
+  
+  </td>
+
+  
+      <td class="default">
+      
+          '12pt 楷体'
+      
+      </td>
+  
+
+  <td class="description last"><p>label 的字体以及大小 @see <a class="mapgis-link-name" title="https://html.spec.whatwg.org/multipage/canvas.html#text-styles" https://html.spec.whatwg.org/multipage/canvas.html#text-styles>https://html.spec.whatwg.org/multipage/canvas.html#text-styles</a></p></td>
+</tr>
+
+
+  
+    
+<tr class="deep-level-1">
+  
+      <td class="name"><code>fillColor</code></td>
+  
+
+  <td class="type">
+  
+      
+<span class="param-type">
+    
+             Cesium.Color
+    
+</span>
+
+
+
+  
+  </td>
+
+  
+      <td class="default">
+      
+          Cesium.Color.WHITE
+      
+      </td>
+  
+
+  <td class="description last"><p>label 的字体颜色</p></td>
+</tr>
+
+
+  
+    
+<tr class="deep-level-1">
+  
+      <td class="name"><code>outlineColor</code></td>
+  
+
+  <td class="type">
+  
+      
+<span class="param-type">
+    
+             Cesium.Color
+    
+</span>
+
+
+
+  
+  </td>
+
+  
+      <td class="default">
+      
+          Cesium.Color.WHITE
+      
+      </td>
+  
+
+  <td class="description last"><p>label 文字线框的颜色</p></td>
+</tr>
+
+
+  
+    
+<tr class="deep-level-1">
+  
+      <td class="name"><code>outlineWidth</code></td>
+  
+
+  <td class="type">
+  
+      
+<span class="param-type">
+    
+             Number
+    
+</span>
+
+
+
+  
+  </td>
+
+  
+      <td class="default">
+      
+          4.0
+      
+      </td>
+  
+
+  <td class="description last"><p>label 的外轮廓边线</p></td>
+</tr>
+
+
+  
+    
+<tr class="deep-level-1">
+  
+      <td class="name"><code>verticalOrigin</code></td>
+  
+
+  <td class="type">
+  
+      
+<span class="param-type">
+    
+             Cesium.VerticalOrigin
+    
+</span>
+
+
+
+  
+  </td>
+
+  
+      <td class="default">
+      
+          Cesium.VerticalOrigin.BOTTOM
+      
+      </td>
+  
+
+  <td class="description last"><p>label 的摆放位置</p></td>
+</tr>
+
+
+  
+    
+<tr class="deep-level-1">
+  
+      <td class="name"><code>showBackground</code></td>
+  
+
+  <td class="type">
+  
+      
+<span class="param-type">
+    
+             Boolean
+    
+</span>
+
+
+
+  
+  </td>
+
+  
+      <td class="default">
+      
+          true
+      
+      </td>
+  
+
+  <td class="description last"><p>是否显示 label 的背景</p></td>
+</tr>
+
+
+  
+    
+<tr class="deep-level-1">
+  
+      <td class="name"><code>backgroundColor</code></td>
+  
+
+  <td class="type">
+  
+      
+<span class="param-type">
+    
+             Cesium.Color
+    
+</span>
+
+
+
+  
+  </td>
+
+  
+      <td class="default">
+      
+          new Cesium.Color(0, 0, 0, 0.4)
+      
+      </td>
+  
+
+  <td class="description last"><p>lable 背景的颜色</p></td>
+</tr>
+
+
+  
+    
+<tr class="deep-level-1">
+  
+      <td class="name"><code>pixelOffset</code></td>
+  
+
+  <td class="type">
+  
+      
+<span class="param-type">
+    
+             Cesium.Cartesian2
+    
+</span>
+
+
+
+  
+  </td>
+
+  
+      <td class="default">
+      
+          new Cesium.Cartesian2(0, -4)
+      
+      </td>
+  
+
+  <td class="description last"><p>label 相对于设定点的偏移位置</p></td>
+</tr>
+
+
+  
+
+
+
+        
+        </tbody>
+    </table>
+</div>
+
+
+
+
+
+
+<dl class="details">
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+    <dt class="tag-author">作者:</dt>
+    <dd class="tag-author">
+        <ul>
+            <li>韩彦生</li>
+        </ul>
+    </dd>
+    
+
+    
+
+    
+
+    
+    
+
+    
+
+    
+
+    
+</dl>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+    <h5>示例</h5>
+    
+    
+        <pre class="prettyprint"><code>function callBack(arg){
+   }
+  var MeasureSlopeTool = new Cesium.MeasureSlopeTool(viewer,{callBack:callBack});
+  MeasureSlopeTool.startTool();  //开始测量
+  //MeasureSlopeTool.stopTool(); //结束测量</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="#angle">angle</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="#rightClickReBegin">rightClickReBegin</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">
+    
+             Number
+    
+</span>
+
+
+
+    </span>
+
+<h4 class="name" id="angle">
+    <a class="href-link" href="#angle">#</a>
+    
+    <span class="code-name">
+        angle
+    </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">
+    
+             Boolean
+    
+</span>
+
+
+
+    </span>
+
+<h4 class="name" id="rightClickReBegin">
+    <a class="href-link" href="#rightClickReBegin">#</a>
+    
+    <span class="code-name">
+        rightClickReBegin
+    </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="#startTool">startTool</a></code></td>
+                                <td class="name">
+                                    <code>
+                                        
+                                    </code>
+                                </td>
+                                <td class="name"><code><p>开始测量</p></code></td>
+                            </tr>
+                        
+                            <tr class="deep-level-0">
+                                <td class="name"><code><a href="#stopTool">stopTool</a></code></td>
+                                <td class="name">
+                                    <code>
+                                        
+                                    </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="member">
+
+
+    
+    <h4 class="name" id="startTool">
+        <a class="href-link" href="#startTool">#</a>
+        
+        <span class="code-name" id="startTool" style="font-size:30px">
+            
+                startTool<span class="signature">()</span>
+            
+        </span>
+    </h4>
+    
+
+    
+    <div class="description">
+        <p>开始测量</p>
+    </div>
+    
+
+
+
+
+
+
+
+
+
+
+
+
+
+<dl class="details">
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+    
+
+    
+
+    
+
+    
+</dl>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+</div>
+            
+                <div class="member">
+
+
+    
+    <h4 class="name" id="stopTool">
+        <a class="href-link" href="#stopTool">#</a>
+        
+        <span class="code-name" id="stopTool" style="font-size:30px">
+            
+                stopTool<span class="signature">()</span>
+            
+        </span>
+    </h4>
+    
+
+    
+    <div class="description">
+        <p>结束测量</p>
+    </div>
+    
+
+
+
+
+
+
+
+
+
+
+
+
+
+<dl class="details">
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+    
+
+    
+
+    
+
+    
+</dl>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+</div>
+            
+            </div>
+        </div>
+    
+
+    
+
+    
+</article>
+
+</section>