@mapgis/webclient-cesium-plugin 17.2.2 → 17.2.4

package/documention/MeasureAreaTool.html

@@ -0,0 +1,1182 @@
+<header id="page-title" class="page-title">
+    
+        <span class="page-title-main">类名</span>
+        <span class="page-title-sub">MeasureAreaTool</span>
+    
+</header>
+
+
+
+
+
+<section>
+
+<article>
+    <div class="container-overview">
+    
+        
+            <div class='vertical-section'>
+                <div class="members">
+                    <div class="member">
+                        
+
+
+    
+    <h4 class="name" id="MeasureAreaTool">
+        <a class="href-link" href="#MeasureAreaTool">#</a>
+        
+        <span class="code-name" id="MeasureAreaTool" style="font-size:30px">
+            
+                new MeasureAreaTool<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">
+    
+             function
+    
+</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">
+    
+             function
+    
+</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>labelStyle</code></td>
+  
+
+  <td class="type">
+  
+      
+<span class="param-type">
+    
+             LabelGraphics
+    
+</span>
+
+
+
+  
+  </td>
+
+  
+      <td class="default">
+      
+          {}
+      
+      </td>
+  
+
+  <td class="description last"><p>labelStyle 提示框样式，参考<code>LabelGraphics</code></p></td>
+</tr>
+
+
+  
+    
+<tr class="deep-level-1">
+  
+      <td class="name"><code>lineStyle</code></td>
+  
+
+  <td class="type">
+  
+      
+<span class="param-type">
+    
+             PolylineGraphics
+    
+</span>
+
+
+
+  
+  </td>
+
+  
+      <td class="default">
+      
+          {}
+      
+      </td>
+  
+
+  <td class="description last"><p>lineStyle 测量线式，参考<code>PolylineGraphics</code></p></td>
+</tr>
+
+
+  
+    
+<tr class="deep-level-1">
+  
+      <td class="name"><code>polygonStyle</code></td>
+  
+
+  <td class="type">
+  
+      
+<span class="param-type">
+    
+             PolygonGraphics
+    
+</span>
+
+
+
+  
+  </td>
+
+  
+      <td class="default">
+      
+          {}
+      
+      </td>
+  
+
+  <td class="description last"><p>polygonStyle 测量点样式，参考<code>PolygonGraphics</code></p></td>
+</tr>
+
+
+  
+    
+<tr class="deep-level-1">
+  
+      <td class="name"><code>closePointStyle</code></td>
+  
+
+  <td class="type">
+  
+      
+<span class="param-type">
+    
+             Billboard
+    
+</span>
+
+
+
+  
+  </td>
+
+  
+      <td class="default">
+      
+          {}
+      
+      </td>
+  
+
+  <td class="description last"><p>closePointStyle 删除测量结果图标样式，参考<code>Billboard</code></p></td>
+</tr>
+
+
+  
+    
+<tr class="deep-level-1">
+  
+      <td class="name"><code>exHeight</code></td>
+  
+
+  <td class="type">
+  
+      
+<span class="param-type">
+    
+             Number
+    
+</span>
+
+
+
+  
+  </td>
+
+  
+      <td class="default">
+      
+          0
+      
+      </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>spaceArea</code></td>
+  
+
+  <td class="type">
+  
+      
+<span class="param-type">
+    
+             Boolean
+    
+</span>
+
+
+
+  
+  </td>
+
+  
+      <td class="default">
+      
+      </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>areaColor</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>isTerrain</code></td>
+  
+
+  <td class="type">
+  
+      
+<span class="param-type">
+    
+             Boolean
+    
+</span>
+
+
+
+  
+  </td>
+
+  
+      <td class="default">
+      
+          false
+      
+      </td>
+  
+
+  <td class="description last"><p>是否针对地形，为true时对地形数据进行贴地面积测量，为false时进行空间面积测量</p></td>
+</tr>
+
+
+  
+    
+<tr class="deep-level-1">
+  
+      <td class="name"><code>xPaneNum</code></td>
+  
+
+  <td class="type">
+  
+      
+<span class="param-type">
+    
+             Number
+    
+</span>
+
+
+
+  
+  </td>
+
+  
+      <td class="default">
+      
+          32
+      
+      </td>
+  
+
+  <td class="description last"><p>地形贴地面积测量中，向经度方向插入采样点的数量</p></td>
+</tr>
+
+
+  
+    
+<tr class="deep-level-1">
+  
+      <td class="name"><code>yPaneNum</code></td>
+  
+
+  <td class="type">
+  
+      
+<span class="param-type">
+    
+             Number
+    
+</span>
+
+
+
+  
+  </td>
+
+  
+      <td class="default">
+      
+          32
+      
+      </td>
+  
+
+  <td class="description last"><p>地形贴地面积测量中，向纬度方向插入采样点的数量</p></td>
+</tr>
+
+
+  
+    
+<tr class="deep-level-1">
+  
+      <td class="name"><code>classificationType</code></td>
+  
+
+  <td class="type">
+  
+      
+<span class="param-type">
+    
+             Number
+    
+</span>
+
+
+
+  
+  </td>
+
+  
+      <td class="default">
+      
+          0
+      
+      </td>
+  
+
+  <td class="description last"><p>测量区域的绘制结果显示，区分地形、模型，为0代表在地形上绘制，为1代表在模型上绘制，为2代表同时在地形和模型上绘制</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">
+    
+             Cartesian2
+    
+</span>
+
+
+
+  
+  </td>
+
+  
+      <td class="default">
+      
+          new Cesium.Cartesian2(0, -4)
+      
+      </td>
+  
+
+  <td class="description last"><p>label 相对于设定点的偏移位置</p></td>
+</tr>
+
+
+  
+    
+<tr class="deep-level-1">
+  
+      <td class="name"><code>enableScaleByDistance</code></td>
+  
+
+  <td class="type">
+  
+      
+<span class="param-type">
+    
+             Number
+    
+</span>
+
+
+
+  
+  </td>
+
+  
+      <td class="default">
+      
+          true
+      
+      </td>
+  
+
+  <td class="description last"><p>是否启用标签随视角高度缩放功能</p></td>
+</tr>
+
+
+  
+    
+<tr class="deep-level-1">
+  
+      <td class="name"><code>scaleByDistance</code></td>
+  
+
+  <td class="type">
+  
+      
+<span class="param-type">
+    
+             Number
+    
+</span>
+
+
+
+  
+  </td>
+
+  
+      <td class="default">
+      
+      </td>
+  
+
+  <td class="description last"><p>标签代销随视角高度缩放函数，用户可自定义，不传则使用默认函数,会传入一个当前的相机视角高度,返回一个NearFarScale函数对象，详见下方示例</p></td>
+</tr>
+
+
+  
+    
+<tr class="deep-level-1">
+  
+      <td class="name"><code>isContinueDraw</code></td>
+  
+
+  <td class="type">
+  
+      
+<span class="param-type">
+    
+             Number
+    
+</span>
+
+
+
+  
+  </td>
+
+  
+      <td class="default">
+      
+          true
+      
+      </td>
+  
+
+  <td class="description last"><p>是否连续绘制，true：是，false：否</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(measureResult){
+}
+var measureAreaTool = new Cesium.MeasureAreaTool(viewer,
+    {
+        callBack:callBack,
+        isTerrain:true,
+        xPaneNum:32,
+        yPaneNum:32,
+         scaleByDistance: function(height) {
+                 if (height &lt; 30) {
+                     return new NearFarScalar(30, 3, 180, 0);
+                 } else if (height &lt; 60) {
+                     return new NearFarScalar(60, 3, 360, 0);
+                 } else if (height &lt; 120) {
+                     return new NearFarScalar(120, 3, 720, 0);
+                 } else if (height &lt; 240) {
+                     return new NearFarScalar(240, 2, 1200, 0);
+                 } else if (height &lt; 480) {
+                     return new NearFarScalar(480, 2, 2400, 0);
+                 } else if (height &lt; 960) {
+                     return new NearFarScalar(960, 2, 4800, 0);
+                 } else if (height &lt; 1920) {
+                     return new NearFarScalar(1920, 2, 9600, 0);
+                 } else if (height &lt; 3840) {
+                     return new NearFarScalar(3840, 2, 19200, 0);
+                 } else if (height &lt; 7680) {
+                     return new NearFarScalar(7680, 2, 38400, 0);
+                 } else if (height &lt; 15360) {
+                     return new NearFarScalar(15360, 2, 76800, 0);
+                 } else if (height &lt; 30720) {
+                     return new NearFarScalar(30720, 2, 153600, 0);
+                 } else if (height &lt; 61440) {
+                     return new NearFarScalar(61440, 2, 307200, 0);
+                 } else if (height &lt; 122880) {
+                     return new NearFarScalar(122880, 2, 614400, 0);
+                 } else if (height &lt; 245760) {
+                     return new NearFarScalar(245760, 2, 1228800, 0);
+                 } else if (height &lt; 491520) {
+                     return new NearFarScalar(491520, 2, 2457600, 0);
+                 } else if (height &lt; 983040) {
+                     return new NearFarScalar(983040, 2, 4915200, 0);
+                 } else if (height &lt; 1966080) {
+                     return new NearFarScalar(1966080, 2, 9830400, 0);
+                 } else if (height &lt; 3932160) {
+                     return new NearFarScalar(3932160, 1, 19660800, 0);
+                 } else if (height &lt; 7864320) {
+                     return new NearFarScalar(7864320, 1, 39321600, 0);
+                 } else if (height &lt; 15728640) {
+                     return new NearFarScalar(15728640, 1, 78643200, 0);
+                 }
+                 return new NearFarScalar(15728640, 1, 78643200, 0);
+          }
+    });
+measureAreaTool.startTool();  //开始测量
+//measureAreaTool.stopTool(); //结束测量</code></pre>
+    
+
+
+
+                    </div>
+                </div>
+            </div>
+        
+    
+    </div>
+    
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+</article>
+
+</section>