@mapgis/webclient-cesium-plugin 17.8.1 → 17.10.9

package/{documention → documentation}/NavigationControl.html

@@ -71,8 +71,6 @@
     
     </h2>
     
-        <div class="class-description"><p>The view-model for a control in the navigation control tool bar</p></div>
-    
 </header>  
 
 <article>
@@ -90,7 +88,7 @@
     
         
         <div class="tag-source">
-            engineExtensions/widgets/navigation/NavigationControl.js, line 12
+            engineExtensions/widgets/navigation/NavigationControl.js, line 3
         </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>
 	
 	
@@ -189,6 +191,24 @@
     
     
     
+        <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"
+
+// NavigationControl 为抽象基类，通常由导航组件内部派生类使用。
+const viewer = new Cesium.Viewer('cesiumContainer')
+viewer.extend(NavigationTool)</code></pre>
+    
+
+    
 </dd>
 
     
@@ -221,7 +241,7 @@
 
 
         <footer>
-            Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc</a> on Fri Feb 06 2026 14:59:54 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}/NavigationTool.html

@@ -83,12 +83,12 @@
     <div class="nameContainer">
         <h4 class="name" id="NavigationTool">
             
-            new NavigationTool<span class="signature">(viewer, options)</span>
+            new NavigationTool<span class="signature">(viewer, <span class="optional">options</span>)</span>
         </h4>
     
         
         <div class="tag-source">
-            engineExtensions/widgets/navigation/NavigationTool.js, line 32
+            engineExtensions/widgets/navigation/NavigationTool.js, line 29
         </div>
         
     </div>
@@ -99,9 +99,8 @@
     
     
     <div class="description">
-        <p>A mixin which adds the Compass/Navigation widget to the Viewer widget.
-Rather than being called directly, this function is normally passed as
-a parameter to <code>Viewer#extend</code>, as shown in the example below.</p>
+        <p>为 <code>Viewer</code> 混入导航控件的扩展函数。
+通常通过 <code>viewer.extend()</code> 调用，而不是直接作为普通函数执行。</p>
     </div>
     
 
@@ -148,7 +147,12 @@ a parameter to <code>Viewer#extend</code>, as shown in the example below.</p>
             
             <td class="description last">
                 
-                <p>The viewer instance.</p></td>
+                    
+                    
+                        
+                    
+                
+                <p>Cesium Viewer 实例。</p></td>
         </tr>
 	
 	
@@ -171,7 +175,14 @@ a parameter to <code>Viewer#extend</code>, as shown in the example below.</p>
             
             <td class="description last">
                 
-                <p>The options.</p></td>
+                    
+                        <span class="optional"> 可选</span>
+                    
+                    
+                        
+                    
+                
+                <p>导航控件配置参数。</p></td>
         </tr>
 	
 	
@@ -219,7 +230,7 @@ a parameter to <code>Viewer#extend</code>, as shown in the example below.</p>
 <dl>
     <dt>
         <div class="param-desc">
-        <p>viewer is required.</p>
+        <p><code>viewer</code> is required.</p>
         </div>
     </dt>
     <dt>
@@ -245,10 +256,21 @@ a parameter to <code>Viewer#extend</code>, as shown in the example below.</p>
     
         <h5>Example</h5>
         
+        <p class="code-caption"><h7>为 Viewer 混入导航控件</h7></p>
+    
 
     
-    <pre class="prettyprint"><code>var viewer = new Cesium.Viewer('cesiumContainer');
-viewer.extend(NavigationTool);</code></pre>
+    <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, {
+  enableCompass: true,
+  enableZoomControls: true
+})</code></pre>
     
 
     
@@ -285,7 +307,7 @@ viewer.extend(NavigationTool);</code></pre>
     
         
         <div class="tag-source">
-            engineExtensions/widgets/navigation/NavigationTool.js, line 80
+            engineExtensions/widgets/navigation/NavigationTool.js, line 87
         </div>
         
     </div>
@@ -296,7 +318,7 @@ viewer.extend(NavigationTool);</code></pre>
     
     
     <div class="description">
-        <p>混入组件</p>
+        <p>为 <code>CesiumWidget</code> 或 <code>Viewer</code> 直接初始化导航控件。</p>
     </div>
     
 
@@ -363,7 +385,7 @@ viewer.extend(NavigationTool);</code></pre>
                         
                     
             </td>
-            <td class="description last">cesiumNavigation对象</td>
+            <td class="description last">返回 <code>CesiumNavigation</code> 对象。</td>
         </tr>
     
     </tbody>
@@ -388,7 +410,7 @@ viewer.extend(NavigationTool);</code></pre>
 
 
         <footer>
-            Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc</a> on Fri Feb 06 2026 14:59:54 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}/NormalPerspective.html

@@ -88,7 +88,7 @@
     
         
         <div class="tag-source">
-            engineExtensions/tools/routeAnimationTool/RouteAnimationPerspective.js, line 146
+            engineExtensions/tools/routeAnimationTool/RouteAnimationPerspective.js, line 154
         </div>
         
     </div>
@@ -99,7 +99,7 @@
     
     
     <div class="description">
-        <p>常规视角</p>
+        <p>常规视角。</p>
     </div>
     
 
@@ -120,6 +120,8 @@
 		<th>Type</th>
 		
 		
+		<th>Default</th>
+		
 		
 		<th class="last">Description</th>
 	</tr>
@@ -143,6 +145,12 @@
             </td>
             
             
+                <td class="default">
+                
+                    {}
+                
+                </td>
+            
             
             <td class="description last">
                 
@@ -153,7 +161,7 @@
                         
                     
                 
-                <p>可选参数</p>
+                <p>视角初始化参数。</p>
                 
 
 <table class="params">
@@ -207,7 +215,7 @@
                         
                     
                 
-                <p>航向角</p></td>
+                <p>航向角。</p></td>
         </tr>
 	
 	
@@ -243,7 +251,7 @@
                         
                     
                 
-                <p>俯仰角</p></td>
+                <p>俯仰角。</p></td>
         </tr>
 	
 	
@@ -279,7 +287,7 @@
                         
                     
                 
-                <p>距离</p></td>
+                <p>相机距离。</p></td>
         </tr>
 	
 	
@@ -330,6 +338,24 @@
     
     
     
+        <h5>Example</h5>
+        
+
+    
+    <pre class="prettyprint"><code>// ES5引入方式
+const { NormalPerspective } = zondy.cesium
+
+// ES6引入方式
+import { NormalPerspective } from "@mapgis/webclient-cesium-plugin"
+
+const perspective = new NormalPerspective({
+  heading: 0,
+  pitch: -0.5,
+  range: 100
+})</code></pre>
+    
+
+    
 </dd>
 
     
@@ -512,7 +538,7 @@
 
 
         <footer>
-            Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc</a> on Fri Feb 06 2026 14:59:54 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>