@mapgis/webclient-cesium-plugin 17.8.1 → 17.10.10

package/{documention → documentation}/Wind3D.html

@@ -71,8 +71,6 @@
     
     </h2>
     
-        <div class="class-description"><p>Wind3D</p></div>
-    
 </header>  
 
 <article>
@@ -85,12 +83,12 @@
     <div class="nameContainer">
         <h4 class="name" id="Wind3D">
             
-            new Wind3D<span class="signature">(viewer, data, options)</span>
+            new Wind3D<span class="signature">(viewer, data, <span class="optional">options</span>)</span><span class="glyphicon glyphicon-circle-arrow-right"></span><span class="type-signature returnType">{Object}</span>
         </h4>
     
         
         <div class="tag-source">
-            engineExtensions/analysis/wind/Wind3D.js, line 33
+            engineExtensions/analysis/wind/Wind3D.js, line 3
         </div>
         
     </div>
@@ -101,7 +99,7 @@
     
     
     <div class="description">
-        <p>风场系统</p>
+        <p>三维风场粒子系统。</p>
     </div>
     
 
@@ -138,7 +136,7 @@
             <td class="type">
             
                 
-<span class="param-type">Object</span>
+<span class="param-type"><a href="Cesium.Viewer.html">Cesium.Viewer</a></span>
 
 
             
@@ -148,7 +146,12 @@
             
             <td class="description last">
                 
-                <p>视图对象</p></td>
+                    
+                    
+                        
+                    
+                
+                <p>视图对象。</p></td>
         </tr>
 	
 	
@@ -171,7 +174,12 @@
             
             <td class="description last">
                 
-                <p>由nc数据解析后的风场数据</p></td>
+                    
+                    
+                        
+                    
+                
+                <p>由 nc 数据解析得到的风场数据。</p></td>
         </tr>
 	
 	
@@ -194,7 +202,14 @@
             
             <td class="description last">
                 
-                <p>附加粒子配置参数</p>
+                    
+                        <span class="optional"> 可选</span>
+                    
+                    
+                        
+                    
+                
+                <p>附加粒子配置参数。</p>
                 
 
 <table class="params">
@@ -234,7 +249,7 @@
             
                 <td class="default">
                 
-                    150000
+                    250000
                 
                 </td>
             
@@ -248,7 +263,7 @@
                         
                     
                 
-                <p>最大粒子数</p></td>
+                <p>最大粒子数。</p></td>
         </tr>
 	
 	
@@ -270,7 +285,7 @@
             
                 <td class="default">
                 
-                    0.950
+                    0.95
                 
                 </td>
             
@@ -284,7 +299,7 @@
                         
                     
                 
-                <p>拖尾透明度，控制每帧粒子轨迹消失的速度，透明度越高，消失得越快，粒子呈现出的轨迹越短</p></td>
+                <p>拖尾透明度；值越高，轨迹消失越快。</p></td>
         </tr>
 	
 	
@@ -320,7 +335,7 @@
                         
                     
                 
-                <p>粒子速度，决定了粒子移动的速度有多快</p></td>
+                <p>粒子速度因子。</p></td>
         </tr>
 	
 	
@@ -342,7 +357,7 @@
             
                 <td class="default">
                 
-                    2
+                    4.0
                 
                 </td>
             
@@ -356,7 +371,41 @@
                         
                     
                 
-                <p>线宽</p></td>
+                <p>粒子线宽。</p></td>
+        </tr>
+	
+	
+	
+        <tr>
+            
+                <td class="name"><code>colors</code></td>
+            
+            
+            <td class="type">
+            
+                
+<span class="param-type">Array.&lt;Array.&lt;Number>></span>
+
+
+            
+            </td>
+            
+            
+                <td class="default">
+                
+                </td>
+            
+            
+            <td class="description last">
+                
+                    
+                        <span class="optional"> 可选</span>
+                    
+                    
+                        
+                    
+                
+                <p>风速色表数组。</p></td>
         </tr>
 	
 	
@@ -405,27 +454,59 @@
     
     
     
+    <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 { Wind3D } = zondy.cesium
+
 // ES6引入方式
 import { Wind3D } from "@mapgis/webclient-cesium-plugin"
 
 loadNetCDF('http://127.0.0.1:5500/demo.nc').then((data) => {
-     var userInput = {
-         particlesNumber: particlesNumber,
-         fadeOpacity: fadeOpacity,
-         speedFactor: speedFactor,
-         lineWidth: lineWidth
-     };
-     particleObj = new Wind3D(viewer, data, userInput);
-     particleObj.init();
- });</code></pre>
+  const userInput = {
+    particlesNumber,
+    fadeOpacity,
+    speedFactor,
+    lineWidth
+  }
+  const wind3D = new Wind3D(viewer, data, userInput)
+  wind3D.init()
+})</code></pre>
     
 
     
@@ -641,12 +722,12 @@ loadNetCDF('http://127.0.0.1:5500/demo.nc').then((data) => {
     <div class="nameContainer">
         <h4 class="name" id="addPrimitives">
             
-            addPrimitives<span class="signature">()</span><span class="glyphicon glyphicon-circle-arrow-right"></span><span class="type-signature returnType">{Object}</span>
+            addPrimitives<span class="signature">()</span><span class="glyphicon glyphicon-circle-arrow-right"></span><span class="type-signature returnType">{void}</span>
         </h4>
     
         
         <div class="tag-source">
-            engineExtensions/analysis/wind/Wind3D.js, line 217
+            engineExtensions/analysis/wind/Wind3D.js, line 220
         </div>
         
     </div>
@@ -657,8 +738,8 @@ loadNetCDF('http://127.0.0.1:5500/demo.nc').then((data) => {
     
     
     <div class="description">
-        <p>添加风场粒子系统的渲染命令到场景中的渲染列表
-依次添加计算速度、更新位置、后处理位置、绘制粒子段、绘制拖尾和屏幕显示的渲染命令。</p>
+        <p>将风场粒子系统的渲染命令加入场景渲染列表。
+依次添加计算速度、更新位置、后处理位置、绘制粒子段、绘制拖尾和屏幕显示命令。</p>
     </div>
     
 
@@ -721,7 +802,7 @@ loadNetCDF('http://127.0.0.1:5500/demo.nc').then((data) => {
             
             <td class="type">
             
-                        Object
+                        void
                         
                     
             </td>
@@ -747,7 +828,7 @@ loadNetCDF('http://127.0.0.1:5500/demo.nc').then((data) => {
     
         
         <div class="tag-source">
-            engineExtensions/analysis/wind/Wind3D.js, line 393
+            engineExtensions/analysis/wind/Wind3D.js, line 385
         </div>
         
     </div>
@@ -758,7 +839,7 @@ loadNetCDF('http://127.0.0.1:5500/demo.nc').then((data) => {
     
     
     <div class="description">
-        <p>隐藏风场系统</p>
+        <p>隐藏风场系统。</p>
     </div>
     
 
@@ -818,7 +899,7 @@ loadNetCDF('http://127.0.0.1:5500/demo.nc').then((data) => {
     
         
         <div class="tag-source">
-            engineExtensions/analysis/wind/Wind3D.js, line 198
+            engineExtensions/analysis/wind/Wind3D.js, line 200
         </div>
         
     </div>
@@ -829,7 +910,7 @@ loadNetCDF('http://127.0.0.1:5500/demo.nc').then((data) => {
     
     
     <div class="description">
-        <p>风场系统初始化</p>
+        <p>初始化风场系统。</p>
     </div>
     
 
@@ -884,12 +965,12 @@ loadNetCDF('http://127.0.0.1:5500/demo.nc').then((data) => {
     <div class="nameContainer">
         <h4 class="name" id="optionsChange">
             
-            optionsChange<span class="signature">(userInput)</span><span class="glyphicon glyphicon-circle-arrow-right"></span><span class="type-signature returnType">{Object}</span>
+            optionsChange<span class="signature">(userInput)</span><span class="glyphicon glyphicon-circle-arrow-right"></span><span class="type-signature returnType">{void}</span>
         </h4>
     
         
         <div class="tag-source">
-            engineExtensions/analysis/wind/Wind3D.js, line 378
+            engineExtensions/analysis/wind/Wind3D.js, line 370
         </div>
         
     </div>
@@ -947,7 +1028,7 @@ loadNetCDF('http://127.0.0.1:5500/demo.nc').then((data) => {
             
             <td class="description last">
                 
-                </td>
+                <p>用户配置参数。</p></td>
         </tr>
 	
 	
@@ -1008,7 +1089,7 @@ loadNetCDF('http://127.0.0.1:5500/demo.nc').then((data) => {
             
             <td class="type">
             
-                        Object
+                        void
                         
                     
             </td>
@@ -1029,12 +1110,12 @@ loadNetCDF('http://127.0.0.1:5500/demo.nc').then((data) => {
     <div class="nameContainer">
         <h4 class="name" id="remove">
             
-            remove<span class="signature">()</span><span class="glyphicon glyphicon-circle-arrow-right"></span><span class="type-signature returnType">{Object}</span>
+            remove<span class="signature">()</span><span class="glyphicon glyphicon-circle-arrow-right"></span><span class="type-signature returnType">{void}</span>
         </h4>
     
         
         <div class="tag-source">
-            engineExtensions/analysis/wind/Wind3D.js, line 443
+            engineExtensions/analysis/wind/Wind3D.js, line 456
         </div>
         
     </div>
@@ -1045,7 +1126,7 @@ loadNetCDF('http://127.0.0.1:5500/demo.nc').then((data) => {
     
     
     <div class="description">
-        <p>移除风场</p>
+        <p>从场景中移除风场。</p>
     </div>
     
 
@@ -1108,7 +1189,7 @@ loadNetCDF('http://127.0.0.1:5500/demo.nc').then((data) => {
             
             <td class="type">
             
-                        Object
+                        void
                         
                     
             </td>
@@ -1134,7 +1215,7 @@ loadNetCDF('http://127.0.0.1:5500/demo.nc').then((data) => {
     
         
         <div class="tag-source">
-            engineExtensions/analysis/wind/Wind3D.js, line 366
+            engineExtensions/analysis/wind/Wind3D.js, line 357
         </div>
         
     </div>
@@ -1145,7 +1226,7 @@ loadNetCDF('http://127.0.0.1:5500/demo.nc').then((data) => {
     
     
     <div class="description">
-        <p>移除监听</p>
+        <p>移除风场交互监听。</p>
     </div>
     
 
@@ -1205,7 +1286,7 @@ loadNetCDF('http://127.0.0.1:5500/demo.nc').then((data) => {
     
         
         <div class="tag-source">
-            engineExtensions/analysis/wind/Wind3D.js, line 356
+            engineExtensions/analysis/wind/Wind3D.js, line 347
         </div>
         
     </div>
@@ -1216,10 +1297,8 @@ loadNetCDF('http://127.0.0.1:5500/demo.nc').then((data) => {
     
     
     <div class="description">
-        <p>添加监听
-设置事件监听器，包括相机移动开始、移动结束、场景渲染前和窗口大小改变事件。
-在相机移动开始时隐藏风场粒子系统，移动结束时更新视图参数并显示风场粒子系统。
-在场景渲染前处理窗口大小改变事件，重新调整风场粒子系统的大小并重新添加渲染命令。</p>
+        <p>添加风场交互监听。
+设置相机移动开始、移动结束、场景渲染前和窗口尺寸变化等监听。</p>
     </div>
     
 
@@ -1274,12 +1353,12 @@ loadNetCDF('http://127.0.0.1:5500/demo.nc').then((data) => {
     <div class="nameContainer">
         <h4 class="name" id="updateViewerParameters">
             
-            updateViewerParameters<span class="signature">()</span><span class="glyphicon glyphicon-circle-arrow-right"></span><span class="type-signature returnType">{Object}</span>
+            updateViewerParameters<span class="signature">()</span><span class="glyphicon glyphicon-circle-arrow-right"></span><span class="type-signature returnType">{void}</span>
         </h4>
     
         
         <div class="tag-source">
-            engineExtensions/analysis/wind/Wind3D.js, line 237
+            engineExtensions/analysis/wind/Wind3D.js, line 240
         </div>
         
     </div>
@@ -1290,7 +1369,7 @@ loadNetCDF('http://127.0.0.1:5500/demo.nc').then((data) => {
     
     
     <div class="description">
-        <p>更新视图参数，包括经纬度范围和像素大小</p>
+        <p>更新视图参数，包括经纬度范围和像素大小。</p>
     </div>
     
 
@@ -1353,7 +1432,7 @@ loadNetCDF('http://127.0.0.1:5500/demo.nc').then((data) => {
             
             <td class="type">
             
-                        Object
+                        void
                         
                     
             </td>
@@ -1382,7 +1461,7 @@ loadNetCDF('http://127.0.0.1:5500/demo.nc').then((data) => {
 
 
         <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 Fri Sep 18 2026 14:59:31 GMT+0800 (中国标准时间)
         </footer>
     </div>
 </div>

package/{documention → documentation}/ZoomNavigationControl.html

@@ -71,8 +71,6 @@
     
     </h2>
     
-        <div class="class-description"><p>The model for a zoom in control in the navigation control tool bar</p></div>
-    
 </header>  
 
 <article>
@@ -90,7 +88,7 @@
     
         
         <div class="tag-source">
-            engineExtensions/widgets/navigation/ZoomNavigationControl.js, line 14
+            engineExtensions/widgets/navigation/ZoomNavigationControl.js, line 4
         </div>
         
     </div>
@@ -100,6 +98,10 @@
 <dd>
     
     
+    <div class="description">
+        <p>导航工具栏中的缩放控件模型。</p>
+    </div>
+    
 
     
     
@@ -144,7 +146,7 @@
             
             <td class="description last">
                 
-                <p>The Terria instance.</p></td>
+                <p>导航控件运行依赖的 Terria/Cesium 宿主对象。</p></td>
         </tr>
 	
 	
@@ -167,7 +169,7 @@
             
             <td class="description last">
                 
-                <p>is used for zooming in (true) or out (false)</p></td>
+                <p><code>true</code> 表示放大，<code>false</code> 表示缩小。</p></td>
         </tr>
 	
 	
@@ -212,6 +214,25 @@
     
     
     
+        <h5>Example</h5>
+        
+        <p class="code-caption"><h7>使用缩放控件</h7></p>
+    
+
+    
+    <pre class="prettyprint"><code>// ES5引入方式
+const { NavigationTool } = zondy.cesium
+
+// ES6引入方式
+import { NavigationTool } from "@mapgis/webclient-cesium-plugin"
+
+const viewer = new Cesium.Viewer('cesiumContainer')
+viewer.extend(NavigationTool, {
+  enableZoomControls: true
+})</code></pre>
+    
+
+    
 </dd>
 
     
@@ -387,7 +408,78 @@ This property is observable.</p>
     
         
         <div class="tag-source">
-            engineExtensions/widgets/navigation/ZoomNavigationControl.js, line 55
+            engineExtensions/widgets/navigation/ZoomNavigationControl.js, line 70
+        </div>
+        
+    </div>
+
+    
+</dt>
+<dd>
+    
+    
+    <div class="description">
+        <p>执行缩放操作。</p>
+    </div>
+    
+
+    
+    
+    
+    
+    
+    
+    
+<dl class="details">
+    
+        
+    
+    
+    
+
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+</dl>
+
+    
+    
+
+    
+
+    
+    
+    
+    
+    
+    
+    
+</dd>
+
+        
+            
+<dt>
+    <div class="nameContainer">
+        <h4 class="name" id="zoom">
+            
+            zoom<span class="signature">(relativeAmount)</span>
+        </h4>
+    
+        
+        <div class="tag-source">
+            engineExtensions/widgets/navigation/ZoomNavigationControl.js, line 79
         </div>
         
     </div>
@@ -398,8 +490,7 @@ This property is observable.</p>
     
     
     <div class="description">
-        <p>When implemented in a derived class, performs an action when the user clicks
-on this control</p>
+        <p>按给定比例调整当前视角远近。</p>
     </div>
     
 
@@ -408,6 +499,51 @@ on this control</p>
     
     
     
+        
+
+<table class="params">
+    <thead>
+	<tr>
+		
+		<th>Name</th>
+		
+		
+		<th>Type</th>
+		
+		
+		
+		<th class="last">Description</th>
+	</tr>
+	</thead>
+	
+	<tbody>
+	
+	
+        <tr>
+            
+                <td class="name"><code>relativeAmount</code></td>
+            
+            
+            <td class="type">
+            
+                
+<span class="param-type">Number</span>
+
+
+            
+            </td>
+            
+            
+            
+            <td class="description last">
+                
+                <p>相对缩放比例。</p></td>
+        </tr>
+	
+	
+	</tbody>
+</table>
+    
     
     
 <dl class="details">
@@ -462,7 +598,7 @@ on this control</p>
 
 
         <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 Fri Sep 18 2026 14:59:31 GMT+0800 (中国标准时间)
         </footer>
     </div>
 </div>