@mapgis/webclient-cesium-plugin 17.8.1 → 17.10.9

package/{documention → documentation}/Deferred.html

@@ -88,7 +88,7 @@
     
         
         <div class="tag-source">
-            engineExtensions/util/when.js, line 255
+            engineExtensions/util/when.js, line 264
         </div>
         
     </div>
@@ -178,7 +178,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}/DrawElement.html

@@ -99,7 +99,9 @@
     
     
     <div class="description">
-        <p>几何绘制类</p>
+        <p>几何绘制工具。</p>
+<p>该工具负责在 Cesium 场景中提供点、线、面、矩形、圆等几何对象的交互绘制能力，
+并统一管理绘制状态、可编辑 primitive 与辅助工具栏。</p>
     </div>
     
 
@@ -146,7 +148,7 @@
             
             <td class="description last">
                 
-                <p>视图对象</p></td>
+                <p>Cesium 视图对象。</p></td>
         </tr>
 	
 	
@@ -197,11 +199,12 @@
     
     <pre class="prettyprint"><code>// ES5引入方式
 const { DrawElement } = zondy.cesium
+
 // ES6引入方式
 import { DrawElement } from "@mapgis/webclient-cesium-plugin"
 
-var drawElement = new DrawElement();
-// 修改绘制类型，支持，贴地，贴模型等参数设置</code></pre>
+const drawElement = new DrawElement(viewer)
+drawElement.setGroundPrimitiveType('TERRAIN')</code></pre>
     
 
     
@@ -229,6 +232,248 @@ var drawElement = new DrawElement();
         
         <dl>
             
+<dt>
+    <div class="nameContainer">
+        <h4 class="name" id="addToolbar">
+            
+            addToolbar<span class="signature">(container, options)</span><span class="glyphicon glyphicon-circle-arrow-right"></span><span class="type-signature returnType">{DrawElement.DrawHelperWidget}</span>
+        </h4>
+    
+        
+        <div class="tag-source">
+            engineExtensions/tools/DrawElement.js, line 1835
+        </div>
+        
+    </div>
+
+    
+</dt>
+<dd>
+    
+    
+    <div class="description">
+        <p>创建绘制工具栏组件。</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>container</code></td>
+            
+            
+            <td class="type">
+            
+                
+<span class="param-type">Element</span>
+|
+
+<span class="param-type">String</span>
+
+
+            
+            </td>
+            
+            
+            
+            <td class="description last">
+                
+                <p>工具栏容器。</p></td>
+        </tr>
+	
+	
+	
+        <tr>
+            
+                <td class="name"><code>options</code></td>
+            
+            
+            <td class="type">
+            
+                
+<span class="param-type">Object</span>
+
+
+            
+            </td>
+            
+            
+            
+            <td class="description last">
+                
+                <p>工具栏配置项。</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">
+            
+                        DrawElement.DrawHelperWidget
+                        
+                    
+            </td>
+            <td class="description last">创建后的工具栏对象。</td>
+        </tr>
+    
+    </tbody>
+</table>
+
+    
+    
+    
+</dd>
+
+        
+            
+<dt>
+    <div class="nameContainer">
+        <h4 class="name" id="clearDrawElement">
+            
+            clearDrawElement<span class="signature">()</span>
+        </h4>
+    
+        
+        <div class="tag-source">
+            engineExtensions/tools/DrawElement.js, line 1886
+        </div>
+        
+    </div>
+
+    
+</dt>
+<dd>
+    
+    
+    <div class="description">
+        <p>清空当前场景中由该工具管理的 primitive。</p>
+    </div>
+    
+
+    
+    
+    
+    
+    
+    
+    
+<dl class="details">
+    
+        
+    
+    
+    
+
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+</dl>
+
+    
+    
+
+    
+
+    
+    
+    
+    
+    
+    
+    
+</dd>
+
+        
+            
 <dt>
     <div class="nameContainer">
         <h4 class="name" id="destroy">
@@ -238,7 +483,7 @@ var drawElement = new DrawElement();
     
         
         <div class="tag-source">
-            engineExtensions/tools/DrawElement.js, line 1869
+            engineExtensions/tools/DrawElement.js, line 1893
         </div>
         
     </div>
@@ -249,7 +494,7 @@ var drawElement = new DrawElement();
     
     
     <div class="description">
-        <p>销毁对象</p>
+        <p>销毁绘制工具并恢复默认贴地配置。</p>
     </div>
     
 
@@ -309,7 +554,7 @@ var drawElement = new DrawElement();
     
         
         <div class="tag-source">
-            engineExtensions/tools/DrawElement.js, line 505
+            engineExtensions/tools/DrawElement.js, line 509
         </div>
         
     </div>
@@ -320,7 +565,7 @@ var drawElement = new DrawElement();
     
     
     <div class="description">
-        <p>修改自定义绘图时Primitive是否贴合地面或者贴合模型的属性</p>
+        <p>设置后续绘制 primitive 的贴地或贴模型分类方式。</p>
     </div>
     
 
@@ -382,7 +627,7 @@ var drawElement = new DrawElement();
                         
                     
                 
-                <p>{NONE, TERRAIN, MODEL, BOTH}，NONE不贴地也不贴模型，TERRAIN仅贴地，MODEL仅贴模型，BOTH都贴</p></td>
+                <p>支持 <code>NONE</code>、<code>TERRAIN</code>、<code>MODEL</code>、<code>BOTH</code> 四种类型。</p></td>
         </tr>
 	
 	
@@ -435,6 +680,145 @@ var drawElement = new DrawElement();
     
 
     
+</dd>
+
+        
+            
+<dt>
+    <div class="nameContainer">
+        <h4 class="name" id="startDrawElement">
+            
+            startDrawElement<span class="signature">(typeString, callbackFun)</span>
+        </h4>
+    
+        
+        <div class="tag-source">
+            engineExtensions/tools/DrawElement.js, line 1846
+        </div>
+        
+    </div>
+
+    
+</dt>
+<dd>
+    
+    
+    <div class="description">
+        <p>以内置类型快捷启动绘制流程。</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>typeString</code></td>
+            
+            
+            <td class="type">
+            
+                
+<span class="param-type">String</span>
+
+
+            
+            </td>
+            
+            
+            
+            <td class="description last">
+                
+                <p>内置绘制类型，例如 <code>polygon</code>、<code>point</code>、<code>Rectangle</code>。</p></td>
+        </tr>
+	
+	
+	
+        <tr>
+            
+                <td class="name"><code>callbackFun</code></td>
+            
+            
+            <td class="type">
+            
+                
+<span class="param-type">function</span>
+
+
+            
+            </td>
+            
+            
+            
+            <td class="description last">
+                
+                <p>绘制或编辑完成回调。</p></td>
+        </tr>
+	
+	
+	</tbody>
+</table>
+    
+    
+    
+<dl class="details">
+    
+        
+    
+    
+    
+
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+</dl>
+
+    
+    
+
+    
+
+    
+    
+    
+    
+    
+    
+    
 </dd>
 
         
@@ -443,12 +827,12 @@ var drawElement = new DrawElement();
     <div class="nameContainer">
         <h4 class="name" id="startDrawingCircle">
             
-            startDrawingCircle<span class="signature">(options)</span>
+            startDrawingCircle<span class="signature">(ops)</span>
         </h4>
     
         
         <div class="tag-source">
-            engineExtensions/tools/DrawElement.js, line 1069
+            engineExtensions/tools/DrawElement.js, line 1077
         </div>
         
     </div>
@@ -459,7 +843,7 @@ var drawElement = new DrawElement();
     
     
     <div class="description">
-        <p>绘制圆</p>
+        <p>交互式绘制圆。</p>
     </div>
     
 
@@ -490,7 +874,7 @@ var drawElement = new DrawElement();
 	
         <tr>
             
-                <td class="name"><code>options</code></td>
+                <td class="name"><code>ops</code></td>
             
             
             <td class="type">
@@ -506,7 +890,7 @@ var drawElement = new DrawElement();
             
             <td class="description last">
                 
-                
+                <p>绘制配置项。</p>
                 
 
 <table class="params">
@@ -545,7 +929,7 @@ var drawElement = new DrawElement();
             
             <td class="description last">
                 
-                <p>回调函数，用于返回绘制的圆的中心点和半径</p></td>
+                <p>绘制完成回调，返回圆心、半径和高度。</p></td>
         </tr>
 	
 	
@@ -634,7 +1018,7 @@ drawElement.startDrawingCircle({
     
         
         <div class="tag-source">
-            engineExtensions/tools/DrawElement.js, line 908
+            engineExtensions/tools/DrawElement.js, line 915
         </div>
         
     </div>
@@ -645,7 +1029,7 @@ drawElement.startDrawingCircle({
     
     
     <div class="description">
-        <p>绘制矩形区功能</p>
+        <p>交互式绘制矩形范围。</p>
     </div>
     
 
@@ -692,7 +1076,7 @@ drawElement.startDrawingCircle({
             
             <td class="description last">
                 
-                
+                <p>绘制配置项。</p>
                 
 
 <table class="params">
@@ -731,7 +1115,7 @@ drawElement.startDrawingCircle({
             
             <td class="description last">
                 
-                <p>回调函数，用于返回绘制的矩形的点</p></td>
+                <p>绘制完成回调，返回矩形范围与高度。</p></td>
         </tr>
 	
 	
@@ -818,7 +1202,7 @@ drawElement.startDrawingExtent({
     
         
         <div class="tag-source">
-            engineExtensions/tools/DrawElement.js, line 574
+            engineExtensions/tools/DrawElement.js, line 578
         </div>
         
     </div>
@@ -829,7 +1213,7 @@ drawElement.startDrawingExtent({
     
     
     <div class="description">
-        <p>绘制圆</p>
+        <p>交互式绘制点标记。</p>
     </div>
     
 
@@ -876,7 +1260,7 @@ drawElement.startDrawingExtent({
             
             <td class="description last">
                 
-                
+                <p>绘制配置项。</p>
                 
 
 <table class="params">
@@ -915,7 +1299,7 @@ drawElement.startDrawingExtent({
             
             <td class="description last">
                 
-                <p>回调函数，用于返回绘制的圆的中心点和半径</p></td>
+                <p>绘制完成回调，返回标记位置与结果对象。</p></td>
         </tr>
 	
 	
@@ -1009,7 +1393,7 @@ drawElement.startDrawingMarker({
     
         
         <div class="tag-source">
-            engineExtensions/tools/DrawElement.js, line 664
+            engineExtensions/tools/DrawElement.js, line 669
         </div>
         
     </div>
@@ -1020,7 +1404,7 @@ drawElement.startDrawingMarker({
     
     
     <div class="description">
-        <p>绘制多边形区功能</p>
+        <p>交互式绘制多边形。</p>
     </div>
     
 
@@ -1067,7 +1451,7 @@ drawElement.startDrawingMarker({
             
             <td class="description last">
                 
-                
+                <p>绘制配置项。</p>
                 
 
 <table class="params">
@@ -1106,7 +1490,7 @@ drawElement.startDrawingMarker({
             
             <td class="description last">
                 
-                <p>回调函数，用于返回绘制多边形的点</p></td>
+                <p>绘制完成回调，返回多边形坐标集合。</p></td>
         </tr>
 	
 	
@@ -1194,7 +1578,7 @@ drawElement.startDrawingPolygon({
     
         
         <div class="tag-source">
-            engineExtensions/tools/DrawElement.js, line 693
+            engineExtensions/tools/DrawElement.js, line 699
         </div>
         
     </div>
@@ -1205,7 +1589,7 @@ drawElement.startDrawingPolygon({
     
     
     <div class="description">
-        <p>绘制线功能</p>
+        <p>交互式绘制折线。</p>
     </div>
     
 
@@ -1252,7 +1636,7 @@ drawElement.startDrawingPolygon({
             
             <td class="description last">
                 
-                
+                <p>绘制配置项。</p>
                 
 
 <table class="params">
@@ -1291,7 +1675,7 @@ drawElement.startDrawingPolygon({
             
             <td class="description last">
                 
-                <p>回调函数，用于返回绘制的线的点</p></td>
+                <p>绘制完成回调，返回折线坐标集合。</p></td>
         </tr>
 	
 	
@@ -1376,7 +1760,7 @@ drawElement.startDrawingPolyline({
     
         
         <div class="tag-source">
-            engineExtensions/tools/DrawElement.js, line 462
+            engineExtensions/tools/DrawElement.js, line 465
         </div>
         
     </div>
@@ -1387,7 +1771,7 @@ drawElement.startDrawingPolyline({
     
     
     <div class="description">
-        <p>停止绘制</p>
+        <p>停止当前绘制流程并释放本次绘制的临时资源。</p>
     </div>
     
 
@@ -1459,7 +1843,7 @@ drawElement.stopDrawing();</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>