@mapgis/webclient-cesium-plugin 17.8.1 → 17.10.9

package/{documention → documentation}/Promise.html

@@ -88,7 +88,7 @@
     
         
         <div class="tag-source">
-            engineExtensions/util/when.js, line 126
+            engineExtensions/util/when.js, line 127
         </div>
         
     </div>
@@ -181,7 +181,7 @@ untrusted.</p>
     
         
         <div class="tag-source">
-            engineExtensions/util/when.js, line 146
+            engineExtensions/util/when.js, line 149
         </div>
         
     </div>
@@ -369,7 +369,7 @@ Shortcut for .then(onFulfilledOrRejected, onFulfilledOrRejected, onProgress)</p>
     
         
         <div class="tag-source">
-            engineExtensions/util/when.js, line 155
+            engineExtensions/util/when.js, line 159
         </div>
         
     </div>
@@ -521,7 +521,7 @@ Shortcut for .then(onFulfilledOrRejected, onFulfilledOrRejected, onProgress)</p>
     
         
         <div class="tag-source">
-            engineExtensions/util/when.js, line 180
+            engineExtensions/util/when.js, line 186
         </div>
         
     </div>
@@ -668,7 +668,7 @@ i.e. onFulfilled.spread(undefined, array).</p>
     
         
         <div class="tag-source">
-            engineExtensions/util/when.js, line 167
+            engineExtensions/util/when.js, line 172
         </div>
         
     </div>
@@ -821,7 +821,7 @@ with its reason.</li>
 
 
         <footer>
-            Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc</a> on Fri Feb 06 2026 14:59:55 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}/ProviderBaseUrlRegExp.html

@@ -99,7 +99,7 @@
     
     
     <div class="description">
-        <p>服务基地址匹配正则表达式</p>
+        <p>服务基地址匹配正则表达式工具，用于从完整请求地址中提取符合规范的服务基地址。</p>
     </div>
     
 
@@ -146,6 +146,22 @@
     
     
     
+        <h5>Example</h5>
+        
+
+    
+    <pre class="prettyprint"><code>// ES5引入方式
+const { ProviderBaseUrlRegExp } = zondy.cesium.util
+
+// ES6引入方式
+import { ProviderBaseUrlRegExp } from "@mapgis/webclient-cesium-plugin"
+
+const baseUrl = ProviderBaseUrlRegExp.matchString(
+  "http://localhost:6163/igs/rest/services/World/MapServer?f=json"
+)</code></pre>
+    
+
+    
 </dd>
 
     
@@ -179,7 +195,7 @@
     
         
         <div class="tag-source">
-            util/ProviderBaseUrlRegExp.js, line 12
+            util/ProviderBaseUrlRegExp.js, line 24
         </div>
         
     </div>
@@ -250,7 +266,7 @@
     
         
         <div class="tag-source">
-            util/ProviderBaseUrlRegExp.js, line 132
+            util/ProviderBaseUrlRegExp.js, line 139
         </div>
         
     </div>
@@ -399,7 +415,7 @@ https://shimo.im/sheets/zdkyd7WLLvTGogq6/skgBW</td>
 
 
         <footer>
-            Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc</a> on Fri Feb 06 2026 14:59:55 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}/Puddle.html

@@ -205,7 +205,7 @@
                         
                     
                 
-                <p>Cesium Viewer实例</p></td>
+                <p>Cesium Viewer 实例</p></td>
         </tr>
 	
 	
@@ -275,7 +275,7 @@
                         
                     
                 
-                <p>是否显示积水效果，默认显示</p></td>
+                <p>是否显示积水效果</p></td>
         </tr>
 	
 	
@@ -311,7 +311,7 @@
                         
                     
                 
-                <p>积水整体透明度，取值范围[0,1],0完全透明，1完全不透明，默认值为0.5</p></td>
+                <p>积水整体透明度，取值范围 <code>[0, 1]</code></p></td>
         </tr>
 	
 	
@@ -347,7 +347,7 @@
                         
                     
                 
-                <p>水坑大小，取值范围[0,1],0最小，1最大，默认值为0.5</p></td>
+                <p>水坑大小，取值范围 <code>[0, 1]</code></p></td>
         </tr>
 	
 	
@@ -419,7 +419,7 @@
                         
                     
                 
-                <p>涟漪数量，取值范围[0,1],0最小，1最大，默认值为0.5</p></td>
+                <p>涟漪数量，取值范围 <code>[0, 1]</code></p></td>
         </tr>
 	
 	
@@ -455,7 +455,7 @@
                         
                     
                 
-                <p>涟漪大小，取值范围[0,1],0最小，1最大，默认值为0.5</p></td>
+                <p>涟漪大小，取值范围 <code>[0, 1]</code></p></td>
         </tr>
 	
 	
@@ -546,7 +546,28 @@
     
 
     
-    <pre class="prettyprint"><code>const puddle = new Puddle( {
  viewer,
  rectangle,
  show: true,              // 显示积水效果
  alpha: 0.7,            // 设置积水透明度为0.7
  puddleSize: 0.8,         // 设置水坑大小为0.8
  showRipple: true,        // 开启涟漪效果
  rippleNumber: 0.6,       // 设置涟漪数量为0.6
  rippleSize: 0.4          // 设置涟漪大小为0.4
+    <pre class="prettyprint"><code>// ES5引入方式
+const { Puddle } = zondy.cesium
+
+// ES6引入方式
+import { Puddle } from "@mapgis/webclient-cesium-plugin"
+
+const puddle = new Puddle({
+  viewer,
+  rectangle,
+  show: true,
+  alpha: 0.7,
+  puddleSize: 0.8,
+  showRipple: true,
+  rippleNumber: 0.6,
+  rippleSize: 0.4
+})
+
+// 动态修改积水参数
+puddle.alpha = 0.9
+puddle.puddleSize = 1.0
+puddle.show = false
+puddle.reflection.alpha = 1.0</code></pre>
     
 
     
@@ -947,7 +968,7 @@
     
         
         <div class="tag-source">
-            engineExtensions/effects/puddle/Puddle.js, line 321
+            engineExtensions/effects/puddle/Puddle.js, line 316
         </div>
         
     </div>
@@ -1029,7 +1050,7 @@
 
 
         <footer>
-            Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc</a> on Fri Feb 06 2026 14:59:55 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}/RadarMaterialProperty.html

@@ -83,7 +83,7 @@
     <div class="nameContainer">
         <h4 class="name" id="RadarMaterialProperty">
             
-            new RadarMaterialProperty<span class="signature">(options)</span>
+            new RadarMaterialProperty<span class="signature">(options)</span><span class="glyphicon glyphicon-circle-arrow-right"></span><span class="type-signature returnType">{Object}</span>
         </h4>
     
         
@@ -99,7 +99,7 @@
     
     
     <div class="description">
-        <p>雷达扫描材质</p>
+        <p>雷达扫描材质属性。</p>
     </div>
     
 
@@ -146,12 +146,7 @@
             
             <td class="description last">
                 
-                    
-                    
-                        
-                    
-                
-                <p>附加属性</p>
+                <p>创建雷达扫描材质属性的参数。</p>
                 
 
 <table class="params">
@@ -164,6 +159,8 @@
 		<th>Type</th>
 		
 		
+		<th>Default</th>
+		
 		
 		<th class="last">Description</th>
 	</tr>
@@ -187,6 +184,10 @@
             </td>
             
             
+                <td class="default">
+                
+                </td>
+            
             
             <td class="description last">
                 
@@ -197,20 +198,14 @@
                         
                     
                 
-                <p>颜色，<a href='http://10.10.130.72:8086/static/modules/cesium/api/cesium/index.html?classFilter=Color' target='_blank'>详见Cesium.Color</a></p></td>
-        </tr>
-	
-	
-	</tbody>
-</table>
-            </td>
+                <p>扫描颜色，<a href='http://10.10.130.72:8086/static/modules/cesium/api/cesium/index.html?classFilter=Color' target='_blank'>详见Cesium.Color</a>。</p></td>
         </tr>
 	
 	
 	
         <tr>
             
-                <td class="name"><code>option.speed</code></td>
+                <td class="name"><code>speed</code></td>
             
             
             <td class="type">
@@ -223,6 +218,12 @@
             </td>
             
             
+                <td class="default">
+                
+                    1
+                
+                </td>
+            
             
             <td class="description last">
                 
@@ -233,7 +234,13 @@
                         
                     
                 
-                <p>速度因子，推荐值域范围0到1之间</p></td>
+                <p>扫描速度因子，值越大扫描动画越快。</p></td>
+        </tr>
+	
+	
+	</tbody>
+</table>
+            </td>
         </tr>
 	
 	
@@ -276,7 +283,55 @@
     
     
     
+    <h5>Returns:</h5>
     
+
+
+<table class="params">
+    <thead>
+    <tr>
+        
+        <th>Type</th>
+        <th class="last">Description</th>
+    </tr>
+    </thead>
+    <tbody>
+    
+        <tr>
+            
+            <td class="type">
+            
+                        Object
+                        
+                    
+            </td>
+            <td class="description last">返回雷达扫描材质属性实例。</td>
+        </tr>
+    
+    </tbody>
+</table>
+
+    
+    
+    
+        <h5>Example</h5>
+        
+        <p class="code-caption"><h7>创建雷达扫描材质属性</h7></p>
+    
+
+    
+    <pre class="prettyprint"><code>// ES5引入方式
+const { RadarMaterialProperty } = zondy.cesium
+
+// ES6引入方式
+import { RadarMaterialProperty } from "@mapgis/webclient-cesium-plugin"
+
+const material = new RadarMaterialProperty({
+  color: Cesium.Color.LIME,
+  speed: 0.8
+})</code></pre>
+    
+
     
 </dd>
 
@@ -310,7 +365,7 @@
 
 
         <footer>
-            Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc</a> on Fri Feb 06 2026 14:59:55 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}/ReImg.html

@@ -99,7 +99,7 @@
     
     
     <div class="description">
-        <p>截图(保存图片)</p>
+        <p>画布或 SVG 导出工具，用于将当前渲染结果转换为图片、画布或 Base64 数据。</p>
     </div>
     
 
@@ -148,16 +148,19 @@
     
         <h5>Example</h5>
         
+        <p class="code-caption"><h7>导出场景截图</h7></p>
+    
 
     
     <pre class="prettyprint"><code>// ES5引入方式
 const { ReImg } = zondy.cesium
+
 // ES6引入方式
-import { ReImg } from "@mapgis/webclient-cesium-plugin"
+import { ReImg } from '@mapgis/webclient-cesium-plugin'
 
 viewer.render()
-const res = ReImg.fromCanvas(viewer.canvas)
-res.downloadPng()</code></pre>
+const result = ReImg.fromCanvas(viewer.canvas)
+result.downloadPng('scene.png')</code></pre>
     
 
     
@@ -194,7 +197,7 @@ res.downloadPng()</code></pre>
     
         
         <div class="tag-source">
-            engineExtensions/tools/ReImg.js, line 43
+            engineExtensions/tools/ReImg.js, line 45
         </div>
         
     </div>
@@ -205,7 +208,7 @@ res.downloadPng()</code></pre>
     
     
     <div class="description">
-        <p>从 canvas 中获取图片信息</p>
+        <p>从 Canvas 创建导出处理器。</p>
     </div>
     
 
@@ -242,7 +245,7 @@ res.downloadPng()</code></pre>
             <td class="type">
             
                 
-<span class="param-type">Object</span>
+<span class="param-type">HTMLCanvasElement</span>
 
 
             
@@ -252,7 +255,7 @@ res.downloadPng()</code></pre>
             
             <td class="description last">
                 
-                </td>
+                <p>要导出的画布对象。</p></td>
         </tr>
 	
 	
@@ -317,7 +320,7 @@ res.downloadPng()</code></pre>
                         
                     
             </td>
-            <td class="description last">返回对象组 {toBase64, toImg, toCanvas, toPng, toJpeg, downloadPng}</td>
+            <td class="description last">导出处理器，包含 <code>toBase64</code>、<code>toImg</code>、<code>toCanvas</code>、<code>toPng</code>、<code>toJpeg</code> 和 <code>downloadPng</code> 方法。</td>
         </tr>
     
     </tbody>
@@ -328,17 +331,163 @@ res.downloadPng()</code></pre>
     
         <h5>Example</h5>
         
+        <p class="code-caption"><h7>从 Canvas 导出图片</h7></p>
+    
 
     
-    <pre class="prettyprint"><code>// 获取 canvas 方法对象
-viewer.render();
-ReImg.fromCanvas(viewer.canvas);
+    <pre class="prettyprint"><code>// 获取导出处理器
+viewer.render()
+const result = ReImg.fromCanvas(viewer.canvas)
 
 // 将画布保存为图片
-viewer.render();
-ReImg.fromCanvas(viewer.canvas).downloadPng(fileName);</code></pre>
+result.downloadPng(fileName)</code></pre>
+    
+
+    
+</dd>
+
+        
+            
+<dt>
+    <div class="nameContainer">
+        <h4 class="name" id=".fromSvg">
+            
+            ReImg.fromSvg<span class="signature">(svgElement)</span><span class="glyphicon glyphicon-circle-arrow-right"></span><span class="type-signature returnType">{Object}</span>
+        </h4>
+    
+        
+        <div class="tag-source">
+            engineExtensions/tools/ReImg.js, line 26
+        </div>
+        
+    </div>
+
+    
+</dt>
+<dd>
+    
+    
+    <div class="description">
+        <p>从 SVG 元素创建导出处理器。</p>
+    </div>
+    
+
+    
     
+    
+    
+    
+        
 
+<table class="params">
+    <thead>
+	<tr>
+		
+		<th>Name</th>
+		
+		
+		<th>Type</th>
+		
+		
+		
+		<th class="last">Description</th>
+	</tr>
+	</thead>
+	
+	<tbody>
+	
+	
+        <tr>
+            
+                <td class="name"><code>svgElement</code></td>
+            
+            
+            <td class="type">
+            
+                
+<span class="param-type">SVGElement</span>
+
+
+            
+            </td>
+            
+            
+            
+            <td class="description last">
+                
+                <p>要导出的 SVG 根节点。</p></td>
+        </tr>
+	
+	
+	</tbody>
+</table>
+    
+    
+    
+<dl class="details">
+    
+        
+    
+    
+    
+
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+</dl>
+
+    
+    
+
+    
+
+    
+    
+    
+    
+    
+    <h5>Returns:</h5>
+    
+
+
+<table class="params">
+    <thead>
+    <tr>
+        
+        <th>Type</th>
+        <th class="last">Description</th>
+    </tr>
+    </thead>
+    <tbody>
+    
+        <tr>
+            
+            <td class="type">
+            
+                        Object
+                        
+                    
+            </td>
+            <td class="description last">导出处理器，包含 <code>toBase64</code>、<code>toImg</code>、<code>toCanvas</code>、<code>toPng</code>、<code>toJpeg</code> 和 <code>downloadPng</code> 方法。</td>
+        </tr>
+    
+    </tbody>
+</table>
+
+    
+    
     
 </dd>
 
@@ -356,7 +505,7 @@ ReImg.fromCanvas(viewer.canvas).downloadPng(fileName);</code></pre>
 
 
         <footer>
-            Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc</a> on Fri Feb 06 2026 14:59:55 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>