@mapgis/webclient-cesium-plugin 17.8.0 → 17.10.9

package/{documention → documentation}/MapGISVectorTileImageryProvider.html

@@ -88,27 +88,21 @@
     
         
         <div class="tag-source">
-            engineExtensions/scene/imageryProvider/MapGISVectorTileImageryProvider.js, line 28
+            engineExtensions/scene/imageryProvider/MapGISVectorTileImageryProvider.js, line 30
         </div>
         
     </div>
 
     
-    <p class="summary"><h5>请参考以下示例：</h5>
-<a href='#example1'>1、添加一个MapGIS矢量瓦片图层：原生接口开发</a><br>
-<a href='http://10.10.130.72:8086/#/modules/cesium/analyse/compareAnalyse/roller-shutter' target='_blank'>2、卷帘</a><br>
-<a href='http://10.10.130.72:8086/#/example-gallery/cesium#vectorTile' target='_blank'>3、更多图层加载示例</a>
-<h5>支持如下方法：</h5>
-<a href='#fromUrl'>[1、通过URL来构造一个MapGISVectorTileImageryProvider对象]</a><br/>
-<a href='#getLabelClass'>[2、获取注记的渲染模式]</a><br/>
-<a href='#destroy'>[3、销毁MapGISVectorTileImageryProvider的相关事件和私有变量]</a><br/></p>
-    
 </dt>
 <dd>
     
     
     <div class="description">
         <p>MapGIS矢量瓦片服务接入类</p>
+<p>该类用于将 MapGIS 矢量瓦片服务适配为 Cesium 可加载的影像提供器，并在内部处理样式转换、瓦片队列和注记渲染。
+适用于需要在三维场景中加载矢量瓦片并保留样式语义的场景。
+调用方可通过 <code>labelsRenderMode</code> 控制注记渲染策略，并通过 <code>fromUrl</code> 快速完成服务初始化。</p>
     </div>
     
 
@@ -155,7 +149,7 @@
             
             <td class="description last">
                 
-                <p>初始化参数</p>
+                <p>初始化参数。</p>
                 
 
 <table class="params">
@@ -209,7 +203,7 @@
                         
                     
                 
-                <p>矢量瓦片样式，必填，请参考Mapboxgl的矢量瓦片标准文档：https://docs.mapbox.com/style-spec/reference/</p></td>
+                <p>矢量瓦片样式对象，格式遵循 Mapbox Style 规范。</p></td>
         </tr>
 	
 	
@@ -245,7 +239,7 @@
                         
                     
                 
-                <p>Cesium的场景对象，必填，<a href='http://10.10.130.72:8086/static/modules/cesium/api/cesium/index.html?classFilter=Scene' target='_blank'>详见Cesium.Scene</a></p></td>
+                <p>Cesium 场景对象。</p></td>
         </tr>
 	
 	
@@ -284,7 +278,7 @@
                         
                     
                 
-                <p>矢量瓦片服务的平铺方案，必填，<a href='http://10.10.130.72:8086/static/modules/cesium/api/cesium/index.html?classFilter=TilingScheme' target='_blank'>详见Cesium.TilingScheme</a></p></td>
+                <p>矢量瓦片平铺方案。</p></td>
         </tr>
 	
 	
@@ -320,7 +314,7 @@
                         
                     
                 
-                <p>瓦片宽度</p></td>
+                <p>瓦片宽度。</p></td>
         </tr>
 	
 	
@@ -356,7 +350,7 @@
                         
                     
                 
-                <p>瓦片高度</p></td>
+                <p>瓦片高度。</p></td>
         </tr>
 	
 	
@@ -392,7 +386,7 @@
                         
                     
                 
-                <p>图层显示范围，超出范围不会额外请求瓦片，若不设置，则从tilingScheme中获取，<a href='http://10.10.130.72:8086/static/modules/cesium/api/cesium/index.html?classFilter=Rectangle' target='_blank'>详见Cesium.Rectangle</a></p></td>
+                <p>图层显示范围，不设置时默认取平铺方案范围。</p></td>
         </tr>
 	
 	
@@ -428,7 +422,7 @@
                         
                     
                 
-                <p>矢量瓦片的最小显示级别</p></td>
+                <p>最小显示级别。</p></td>
         </tr>
 	
 	
@@ -464,7 +458,7 @@
                         
                     
                 
-                <p>矢量瓦片的最大显示级别</p></td>
+                <p>最大显示级别。</p></td>
         </tr>
 	
 	
@@ -503,7 +497,7 @@
                         
                     
                 
-                <p>“视图的显示级别，超出瓦片数据自身支持的级别”时，是否对瓦片进行拉伸显示。此值未定义或者设置为true时，超出范围后，会采用最接近一级的瓦片进行拉伸或缩放显示。反之，超出范围后，瓦片不再显示</p></td>
+                <p>超出原始级别时是否拉伸最近一级图片继续显示。</p></td>
         </tr>
 	
 	
@@ -539,7 +533,7 @@
                         
                     
                 
-                <p>token名</p></td>
+                <p>token 参数名。</p></td>
         </tr>
 	
 	
@@ -575,7 +569,7 @@
                         
                     
                 
-                <p>token值，只有当tokenValue存在时，才会绑定token</p></td>
+                <p>token 参数值。</p></td>
         </tr>
 	
 	
@@ -611,7 +605,7 @@
                         
                     
                 
-                <p>像素缩放因子，既canvas中一个像素对应屏幕像素的大小</p></td>
+                <p>像素缩放因子，即 canvas 像素到屏幕像素的比例。</p></td>
         </tr>
 	
 	
@@ -647,7 +641,7 @@
                         
                     
                 
-                <p>矢量瓦片中绘制的几何内容的缩放矩阵，默认是[0.125, 0, 0, 0.125, 0, 0]，意味着将矢量瓦片里的内容缩放至1/8，并填充到canvas中</p></td>
+                <p>绘制到 canvas 时使用的几何缩放矩阵。</p></td>
         </tr>
 	
 	
@@ -681,7 +675,7 @@
                         
                     
                 
-                <p>矢量瓦片注记参数</p></td>
+                <p>子图层注记参数。</p></td>
         </tr>
 	
 	
@@ -715,7 +709,7 @@
                         
                     
                 
-                <p>指定矢量瓦片注记的渲染模式,仅在三维上有效。on-screen表示使用三维接口实时渲染注记；off-screen表示通过先将注记渲染到图片上，再通过三维接口渲染到屏幕。</p></td>
+                <p>注记渲染模式。<code>on-screen</code> 表示实时渲染，<code>off-screen</code> 表示先渲染到图片后再显示。</p></td>
         </tr>
 	
 	
@@ -749,7 +743,7 @@
                         
                     
                 
-                <p>图层加载成功后的回调函数</p></td>
+                <p>图层加载成功后的回调承诺。</p></td>
         </tr>
 	
 	
@@ -802,14 +796,13 @@
     
         <h5>Example</h5>
         
-        <p class="code-caption"><h7 id='example1'>添加一个MapGIS矢量瓦片图层：原生接口开发</h7></p>
-    
 
     
     <pre class="prettyprint"><code>// ES5引入方式
 const { MapGISVectorTileImageryProvider } = zondy.cesium
+
 // ES6引入方式
-import { MapGISVectorTileImageryProvider } from "@mapgis/webclient-cesium-plugin"
+import { MapGISVectorTileImageryProvider } from '@mapgis/webclient-cesium-plugin'
 
 const url = 'http://localhost:8089/igs/rest/services/VectorTile/example/VectorTileServer'
 const addImageryProvider = async (url) => {
@@ -1042,7 +1035,7 @@ off-screen表示通过先将注记渲染到图片上，再通过三维接口渲
 <dd>
     
     <div class="description">
-        <p>图层是否加载完毕</p>
+        <p>当前 provider 是否已完成初始化。</p>
     </div>
     
     
@@ -1502,16 +1495,87 @@ off-screen表示通过先将注记渲染到图片上，再通过三维接口渲
         
         <dl>
             
+<dt>
+    <div class="nameContainer">
+        <h4 class="name" id="destroy">
+            
+            destroy<span class="signature">()</span>
+        </h4>
+    
+        
+        <div class="tag-source">
+            engineExtensions/scene/imageryProvider/MapGISVectorTileImageryProvider.js, line 934
+        </div>
+        
+    </div>
+
+    
+</dt>
+<dd>
+    
+    
+    <div class="description">
+        <p>销毁 provider 持有的事件与注记图层资源。</p>
+    </div>
+    
+
+    
+    
+    
+    
+    
+    
+    
+<dl class="details">
+    
+        
+    
+    
+    
+
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+</dl>
+
+    
+    
+
+    
+
+    
+    
+    
+    
+    
+    
+    
+</dd>
+
+        
+            
 <dt>
     <div class="nameContainer">
         <h4 class="name" id=".fromUrl">
             
-            MapGISVectorTileImageryProvider.fromUrl<span class="signature">(url, options)</span><span class="glyphicon glyphicon-circle-arrow-right"></span><span class="type-signature returnType">{Cesium.MapGISVectorTileImageryProvider}</span>
+            MapGISVectorTileImageryProvider.fromUrl<span class="signature">(url, <span class="optional">options</span>)</span><span class="glyphicon glyphicon-circle-arrow-right"></span><span class="type-signature returnType">{<a href="Promise.html">Promise</a>.&lt;<a href="MapGISVectorTileImageryProvider.html">MapGISVectorTileImageryProvider</a>>}</span>
         </h4>
     
         
         <div class="tag-source">
-            engineExtensions/scene/imageryProvider/MapGISVectorTileImageryProvider.js, line 247
+            engineExtensions/scene/imageryProvider/MapGISVectorTileImageryProvider.js, line 265
         </div>
         
     </div>
@@ -1522,7 +1586,7 @@ off-screen表示通过先将注记渲染到图片上，再通过三维接口渲
     
     
     <div class="description">
-        <p>通过URL来构造一个MapGISVectorTileImageryProvider对象<a id='fromUrl'/></p>
+        <p>根据服务地址加载矢量瓦片元信息并创建 provider。</p>
     </div>
     
 
@@ -1543,6 +1607,8 @@ off-screen表示通过先将注记渲染到图片上，再通过三维接口渲
 		<th>Type</th>
 		
 		
+		<th>Default</th>
+		
 		
 		<th class="last">Description</th>
 	</tr>
@@ -1569,10 +1635,19 @@ off-screen表示通过先将注记渲染到图片上，再通过三维接口渲
             </td>
             
             
+                <td class="default">
+                
+                </td>
+            
             
             <td class="description last">
                 
-                <p>服务的基地址，支持url字符串和Cesium.Resource两种类型，当类型为Cesium.Resource时，支持传入额外请求参数、请求头参数等，具体请参考<a href='http://10.10.130.72:8086/static/modules/cesium/api/cesium/Resource.html' target='_blank'>Cesium.Resource</a></p></td>
+                    
+                    
+                        
+                    
+                
+                <p>矢量瓦片服务基地址。</p></td>
         </tr>
 	
 	
@@ -1592,10 +1667,23 @@ off-screen表示通过先将注记渲染到图片上，再通过三维接口渲
             </td>
             
             
+                <td class="default">
+                
+                    {}
+                
+                </td>
+            
             
             <td class="description last">
                 
-                <p>额外的构造参数，参考MapGISVectorTileImageryProvider的初始化参数</p></td>
+                    
+                        <span class="optional"> 可选</span>
+                    
+                    
+                        
+                    
+                
+                <p>附加构造参数，支持覆盖服务元信息中的默认值。</p></td>
         </tr>
 	
 	
@@ -1656,11 +1744,11 @@ off-screen表示通过先将注记渲染到图片上，再通过三维接口渲
             
             <td class="type">
             
-                        Cesium.MapGISVectorTileImageryProvider
+                        <a href="Promise.html">Promise</a>.&lt;<a href="MapGISVectorTileImageryProvider.html">MapGISVectorTileImageryProvider</a>>
                         
                     
             </td>
-            <td class="description last">初始化完毕的MapGISVectorTileImageryProvider对象</td>
+            <td class="description last">已初始化的 provider 实例。</td>
         </tr>
     
     </tbody>
@@ -1677,12 +1765,12 @@ off-screen表示通过先将注记渲染到图片上，再通过三维接口渲
     <div class="nameContainer">
         <h4 class="name" id=".getLabelClass">
             
-            MapGISVectorTileImageryProvider.getLabelClass<span class="signature">(sublayerLabelingInfos)</span><span class="glyphicon glyphicon-circle-arrow-right"></span><span class="type-signature returnType">{LabelClass}</span>
+            MapGISVectorTileImageryProvider.getLabelClass<span class="signature">(sublayerLabelingInfos)</span><span class="glyphicon glyphicon-circle-arrow-right"></span><span class="type-signature returnType">{LabelClass|undefined}</span>
         </h4>
     
         
         <div class="tag-source">
-            engineExtensions/scene/imageryProvider/MapGISVectorTileImageryProvider.js, line 265
+            engineExtensions/scene/imageryProvider/MapGISVectorTileImageryProvider.js, line 284
         </div>
         
     </div>
@@ -1693,7 +1781,7 @@ off-screen表示通过先将注记渲染到图片上，再通过三维接口渲
     
     
     <div class="description">
-        <p>获取注记的渲染模式<a id='getLabelClass'/></p>
+        <p>从子图层注记配置中提取首个可用的 <code>LabelClass</code>。</p>
     </div>
     
 
@@ -1740,7 +1828,7 @@ off-screen表示通过先将注记渲染到图片上，再通过三维接口渲
             
             <td class="description last">
                 
-                <p>要添加注记的初始化参数</p></td>
+                <p>子图层注记初始化参数。</p></td>
         </tr>
 	
 	
@@ -1802,10 +1890,13 @@ off-screen表示通过先将注记渲染到图片上，再通过三维接口渲
             <td class="type">
             
                         LabelClass
+                         | 
+                    
+                        undefined
                         
                     
             </td>
-            <td class="description last"></td>
+            <td class="description last">命中的注记样式；若未配置则返回 <code>undefined</code>。</td>
         </tr>
     
     </tbody>
@@ -1814,77 +1905,6 @@ off-screen表示通过先将注记渲染到图片上，再通过三维接口渲
     
     
     
-</dd>
-
-        
-            
-<dt>
-    <div class="nameContainer">
-        <h4 class="name" id="destroy">
-            
-            destroy<span class="signature">()</span>
-        </h4>
-    
-        
-        <div class="tag-source">
-            engineExtensions/scene/imageryProvider/MapGISVectorTileImageryProvider.js, line 932
-        </div>
-        
-    </div>
-
-    
-</dt>
-<dd>
-    
-    
-    <div class="description">
-        <p>销毁MapGISVectorTileImageryProvider的相关事件和私有变量<a id='destroy'/></p>
-    </div>
-    
-
-    
-    
-    
-    
-    
-    
-    
-<dl class="details">
-    
-        
-    
-    
-    
-
-    
-    
-    
-    
-    
-    
-    
-    
-    
-    
-    
-    
-    
-    
-    
-</dl>
-
-    
-    
-
-    
-
-    
-    
-    
-    
-    
-    
-    
 </dd>
 
         </dl>
@@ -1901,7 +1921,7 @@ off-screen表示通过先将注记渲染到图片上，再通过三维接口渲
 
 
         <footer>
-            Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc</a> on Wed Feb 04 2026 18:31:34 GMT+0800 (中国标准时间)
+            Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc</a> on Sat Sep 12 2026 11:55:59 GMT+0800 (中国标准时间)
         </footer>
     </div>
 </div>

package/{documention → documentation}/MeasureAreaTool.html

@@ -88,7 +88,7 @@
     
         
         <div class="tag-source">
-            engineExtensions/tools/MeasureAreaTool.js, line 3
+            engineExtensions/tools/MeasureAreaTool.js, line 8
         </div>
         
     </div>
@@ -99,7 +99,9 @@
     
     
     <div class="description">
-        <p>面积测量工具</p>
+        <p>面积测量工具。</p>
+<p>该工具负责在 Cesium 场景中管理连续或单次的面积量算流程，并封装空间面积、
+贴地面积、结果标注与清理控制。</p>
     </div>
     
 
@@ -146,7 +148,7 @@
             
             <td class="description last">
                 
-                <p>视图</p></td>
+                <p>Cesium 视图对象。</p></td>
         </tr>
 	
 	
@@ -169,7 +171,7 @@
             
             <td class="description last">
                 
-                <p>包含以下属性的对象</p>
+                <p>面积量算配置项。</p>
                 
 
 <table class="params">
@@ -223,7 +225,7 @@
                         
                     
                 
-                <p>回调函数，返回测量结果值</p></td>
+                <p>量算结束回调，返回面积结果与量算坐标点。</p></td>
         </tr>
 	
 	
@@ -259,7 +261,7 @@
                         
                     
                 
-                <p>测量完毕后提示框的回调函数，可以覆盖提示内容</p></td>
+                <p>标注内容回调，用于覆盖默认提示文字。</p></td>
         </tr>
 	
 	
@@ -1227,6 +1229,42 @@
         </tr>
 	
 	
+	
+        <tr>
+            
+                <td class="name"><code>enableAvoidance</code></td>
+            
+            
+            <td class="type">
+            
+                
+<span class="param-type">Boolean</span>
+
+
+            
+            </td>
+            
+            
+                <td class="default">
+                
+                    false
+                
+                </td>
+            
+            
+            <td class="description last">
+                
+                    
+                        <span class="optional"> 可选</span>
+                    
+                    
+                        
+                    
+                
+                <p>是否开启量算结果标签避让</p></td>
+        </tr>
+	
+	
 	</tbody>
 </table>
             </td>
@@ -1287,6 +1325,7 @@
     
     <pre class="prettyprint"><code>// ES5引入方式
 const { MeasureAreaTool } = zondy.cesium
+
 // ES6引入方式
 import { MeasureAreaTool } from "@mapgis/webclient-cesium-plugin"
 
@@ -1381,7 +1420,7 @@ measureAreaTool.startTool();  //开始测量
     
         
         <div class="tag-source">
-            engineExtensions/tools/MeasureAreaTool.js, line 237
+            engineExtensions/tools/MeasureAreaTool.js, line 253
         </div>
         
     </div>
@@ -1392,7 +1431,7 @@ measureAreaTool.startTool();  //开始测量
     
     
     <div class="description">
-        <p>清除所有测量结果，仍可绘制（绘制事件仍然是激活状态）</p>
+        <p>清除全部面积量算结果，并在允许连续绘制时重新进入激活状态。</p>
     </div>
     
 
@@ -1452,7 +1491,7 @@ measureAreaTool.startTool();  //开始测量
     
         
         <div class="tag-source">
-            engineExtensions/tools/MeasureAreaTool.js, line 126
+            engineExtensions/tools/MeasureAreaTool.js, line 138
         </div>
         
     </div>
@@ -1463,7 +1502,7 @@ measureAreaTool.startTool();  //开始测量
     
     
     <div class="description">
-        <p>开始测量</p>
+        <p>激活面积量算流程并创建当前绘制工具。</p>
     </div>
     
 
@@ -1523,7 +1562,7 @@ measureAreaTool.startTool();  //开始测量
     
         
         <div class="tag-source">
-            engineExtensions/tools/MeasureAreaTool.js, line 218
+            engineExtensions/tools/MeasureAreaTool.js, line 234
         </div>
         
     </div>
@@ -1534,7 +1573,7 @@ measureAreaTool.startTool();  //开始测量
     
     
     <div class="description">
-        <p>结束测量，测量工具处于不能绘制(不激活状态)</p>
+        <p>停止面积量算。</p>
     </div>
     
 
@@ -1596,7 +1635,7 @@ measureAreaTool.startTool();  //开始测量
                         
                     
                 
-                <p>是否保留测量结果。默认为false不保留测量结果</p></td>
+                <p>是否保留当前量算结果；默认 <code>false</code>，会同时清理结果与交互状态。</p></td>
         </tr>
 	
 	
@@ -1657,7 +1696,7 @@ measureAreaTool.startTool();  //开始测量
 
 
         <footer>
-            Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc</a> on Wed Feb 04 2026 18:31:34 GMT+0800 (中国标准时间)
+            Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc</a> on Sat Sep 12 2026 11:55:59 GMT+0800 (中国标准时间)
         </footer>
     </div>
 </div>