@mapgis/webclient-cesium-plugin 17.8.1 → 17.10.9

package/{documention → documentation}/SketchEditor.html

@@ -83,12 +83,12 @@
     <div class="nameContainer">
         <h4 class="name" id="SketchEditor">
             
-            new SketchEditor<span class="signature">(options)</span>
+            new SketchEditor<span class="signature">(<span class="optional">options</span>)</span>
         </h4>
     
         
         <div class="tag-source">
-            sketchEditor/SketchEditor.js, line 15
+            sketchEditor/SketchEditor.js, line 34
         </div>
         
     </div>
@@ -99,12 +99,8 @@
     
     
     <div class="description">
-        <p>Cesium引擎草图编辑类<br/>
-继承自<a href='http://10.10.130.72:8086/static/modules/common/api/common-mapgis/SketchEditor3D.html' target='_blank'>zondy.SketchEditor3D</a><br/>
-<br>[ES5引入方式]：<br/>
-const { SketchEditor } = zondy.tool.sketch  <br/>
-[ES6引入方式]：<br/>
-import { SketchEditor } from &quot;@mapgis/webclient-leaflet-plugin&quot; <br/></p>
+        <p>Cesium 引擎草图编辑类，用于在三维场景中创建、选中、编辑、分割和转换草图几何。
+继承自 <a href='http://10.10.130.72:8086/static/modules/common/api/common-mapgis/SketchEditor3D.html' target='_blank'>zondy.SketchEditor3D</a>。</p>
     </div>
     
 
@@ -125,6 +121,8 @@ import { SketchEditor } from &quot;@mapgis/webclient-leaflet-plugin&quot; <br/><
 		<th>Type</th>
 		
 		
+		<th>Default</th>
+		
 		
 		<th class="last">Description</th>
 	</tr>
@@ -148,10 +146,23 @@ import { SketchEditor } from &quot;@mapgis/webclient-leaflet-plugin&quot; <br/><
             </td>
             
             
+                <td class="default">
+                
+                    {}
+                
+                </td>
+            
             
             <td class="description last">
                 
-                <p>构造参数</p>
+                    
+                        <span class="optional"> 可选</span>
+                    
+                    
+                        
+                    
+                
+                <p>构造参数。</p>
                 
 
 <table class="params">
@@ -182,7 +193,7 @@ import { SketchEditor } from &quot;@mapgis/webclient-leaflet-plugin&quot; <br/><
             <td class="type">
             
                 
-<span class="param-type"><a href="MapView.html">MapView</a></span>
+<span class="param-type">MapView</span>
 |
 
 <span class="param-type"><a href="SceneView.html">SceneView</a></span>
@@ -206,7 +217,7 @@ import { SketchEditor } from &quot;@mapgis/webclient-leaflet-plugin&quot; <br/><
                         
                     
                 
-                <p>地图视图对象</p></td>
+                <p>Cesium 三维场景视图对象。</p></td>
         </tr>
 	
 	
@@ -240,7 +251,7 @@ import { SketchEditor } from &quot;@mapgis/webclient-leaflet-plugin&quot; <br/><
                         
                     
                 
-                <p>草图图层管对象</p></td>
+                <p>草图图层对象，用于承载绘制完成的草图要素。</p></td>
         </tr>
 	
 	
@@ -274,7 +285,7 @@ import { SketchEditor } from &quot;@mapgis/webclient-leaflet-plugin&quot; <br/><
                         
                     
                 
-                <p>草图符号</p></td>
+                <p>草图符号样式。</p></td>
         </tr>
 	
 	
@@ -308,7 +319,43 @@ import { SketchEditor } from &quot;@mapgis/webclient-leaflet-plugin&quot; <br/><
                         
                     
                 
-                <p>草图捕获配置项</p></td>
+                <p>草图捕获配置项。</p></td>
+        </tr>
+	
+	
+	
+        <tr>
+            
+                <td class="name"><code>snapAndReferFeatures</code></td>
+            
+            
+            <td class="type">
+            
+                
+<span class="param-type">Array.&lt;Feature></span>
+
+
+            
+            </td>
+            
+            
+                <td class="default">
+                
+                    []
+                
+                </td>
+            
+            
+            <td class="description last">
+                
+                    
+                        <span class="optional"> 可选</span>
+                    
+                    
+                        
+                    
+                
+                <p>捕获和线造区边界参考要素集合。</p></td>
         </tr>
 	
 	
@@ -344,15 +391,14 @@ import { SketchEditor } from &quot;@mapgis/webclient-leaflet-plugin&quot; <br/><
                         
                     
                 
-                <p>草图图形弧线类型<br>
+                <p>草图图形弧线类型。绘制线、区、矩形时生效；贴地和贴场景模式下 <code>ArcType.none</code> 会按大地线处理。
 可选类型为：<br>
 1、ArcType.none:不考虑弧度<br>
 2、ArcType.geodesic:大地线（或称为大圆线）<br>
 3、ArcType.rhumb:等角航线<br>
 目前绘制线、区、矩形时，该属性生效<br>
 请注意当绘制几何的高程模式设置为OnTheGround(贴地)和OnTheScene(贴场景)时，arcType支持设置为ArcType.geodesic和ArcType.rhumb，
-当设置为ArcType.none时，内部会将该属性设置为ArcType.geodesic
-*</p></td>
+当设置为ArcType.none时，内部会将该属性设置为ArcType.geodesic</p></td>
         </tr>
 	
 	
@@ -393,13 +439,6 @@ import { SketchEditor } from &quot;@mapgis/webclient-leaflet-plugin&quot; <br/><
 
     
     
-    <h5>Fires</h5>
-    <ul>
-        <li>SketchEditor#event:草图绘制完成事件</li>
-    
-        <li>SketchEditor#event:草图被选中事件</li>
-    </ul>
-    
 
     
 
@@ -410,6 +449,25 @@ import { SketchEditor } from &quot;@mapgis/webclient-leaflet-plugin&quot; <br/><
     
     
     
+        <h5>Example</h5>
+        
+        <p class="code-caption">创建 Cesium 草图编辑器</p>
+    
+
+    
+    <pre class="prettyprint"><code>// ES5 引入方式
+const { SketchEditor } = zondy.cesium.tool.sketch
+
+// ES6 引入方式
+import { SketchEditor, SceneView } from '@mapgis/webclient-cesium-plugin'
+
+const sketchEditor = new SketchEditor({
+  view: sceneView,
+  layer: graphicsLayer
+})</code></pre>
+    
+
+    
 </dd>
 
     
@@ -506,7 +564,7 @@ import { SketchEditor } from &quot;@mapgis/webclient-leaflet-plugin&quot; <br/><
     
         
         <div class="tag-source">
-            sketchEditor/SketchEditor.js, line 59
+            sketchEditor/SketchEditor.js, line 81
         </div>
         
     </div>
@@ -517,7 +575,8 @@ import { SketchEditor } from &quot;@mapgis/webclient-leaflet-plugin&quot; <br/><
     
     
     <div class="description">
-        <p>向当前线或区草图中插入新的顶点<a id='addVertex'></a></p>
+        <p>向当前线或区草图中插入新的顶点。</p>
+<p>在 Cesium 三维场景中，如果编辑器提供当前绘制高度，会先将该高度写入新增点的 Z 坐标。</p>
     </div>
     
 
@@ -564,7 +623,7 @@ import { SketchEditor } from &quot;@mapgis/webclient-leaflet-plugin&quot; <br/><
             
             <td class="description last">
                 
-                <p>新增/插入顶点</p></td>
+                <p>新增或插入的顶点。</p></td>
         </tr>
 	
 	
@@ -587,7 +646,7 @@ import { SketchEditor } from &quot;@mapgis/webclient-leaflet-plugin&quot; <br/><
             
             <td class="description last">
                 
-                <p>新增点的索引值，索引值从0开始</p></td>
+                <p>新增顶点的索引值，索引值从 0 开始。</p></td>
         </tr>
 	
 	
@@ -652,7 +711,7 @@ import { SketchEditor } from &quot;@mapgis/webclient-leaflet-plugin&quot; <br/><
                         
                     
             </td>
-            <td class="description last">改变后的图形几何</td>
+            <td class="description last">更新后的草图几何。</td>
         </tr>
     
     </tbody>
@@ -674,7 +733,7 @@ import { SketchEditor } from &quot;@mapgis/webclient-leaflet-plugin&quot; <br/><
     
         
         <div class="tag-source">
-            sketchEditor/SketchEditor.js, line 210
+            sketchEditor/SketchEditor.js, line 164
         </div>
         
     </div>
@@ -685,7 +744,7 @@ import { SketchEditor } from &quot;@mapgis/webclient-leaflet-plugin&quot; <br/><
     
     
     <div class="description">
-        <p>线拓扑造区<a id='drawPolylineToPolygon'></a></p>
+        <p>启动线拓扑造区流程。</p>
     </div>
     
 
@@ -732,7 +791,7 @@ import { SketchEditor } from &quot;@mapgis/webclient-leaflet-plugin&quot; <br/><
             
             <td class="description last">
                 
-                <p>捕获参考几何对象数组</p></td>
+                <p>捕获参考几何对象数组。</p></td>
         </tr>
 	
 	
@@ -783,71 +842,29 @@ import { SketchEditor } from &quot;@mapgis/webclient-leaflet-plugin&quot; <br/><
     
 
     
-    <pre class="prettyprint"><code>// [ES5引入方式]：
-const { Polygon, LineString } = zondy.geometry
-const { SceneView} = zondy.cesium
+    <pre class="prettyprint"><code>// ES5引入方式
+const { Polygon } = zondy.geometry
+const { SceneView } = zondy.cesium
 const { SketchEditor } = zondy.cesium.tool.sketch
+
 [ES6引入方式]：
-import { SceneView, SketchEditor } from "@mapgis/webclient-cesium-plugin" <br/>
-import { Polygon, LineString } from "@mapgis/webclient-common" <br/>
-var map = new Map()
-var sceneView = new SceneView({
-  viewId: "mapgis-3d-viewer",
-  map: map,
+import { SceneView, SketchEditor } from '@mapgis/webclient-cesium-plugin'
+import { Polygon } from '@mapgis/webclient-common'
+
+const map = new Map()
+const sceneView = new SceneView({
+  viewId: 'mapgis-3d-viewer',
+  map
 })
-var testGeometries = [
- new Polygon({
-   coordinates: [
-     [
-       [114.0, 29.0],
-       [117.0, 29.0],
-       [117.0, 35.0],
-       [114.0, 35.0],
-       [114.0, 29.0]
-     ]
-   ]
- }),
- new Polygon({
-   coordinates: [
-     [
-       [113.0, 29.0],
-       [116.0, 29.0],
-       [116.0, 35.0],
-       [113.0, 35.0],
-       [113.0, 29.0]
-     ]
-   ]
- })
-]
-testFeatures = [
-new Feature({
-    id: '11114',
-    geometry: this.testGeometries[0],
-    symbol: new SimpleFillSymbol({
-      color: new Color(0, 255, 255, 0.5),
-      outline: new SimpleLineSymbol({
-        color: new Color(0, 255, 255, 0.8),
-        width: 2
-      })
-    })
-  }),
-  new Feature({
-    id: '11115',
-    geometry: this.testGeometries[1],
-    symbol: new SimpleFillSymbol({
-      color: new Color(0, 255, 255, 0.5),
-      outline: new SimpleLineSymbol({
-        color: new Color(0, 255, 255, 0.8),
-        width: 2
-      })
-    })
+const testGeometries = [
+  new Polygon({
+    coordinates: [[[114.0, 29.0], [117.0, 29.0], [117.0, 35.0], [114.0, 35.0], [114.0, 29.0]]]
   }),
+  new Polygon({
+    coordinates: [[[113.0, 29.0], [116.0, 29.0], [116.0, 35.0], [113.0, 35.0], [113.0, 29.0]]]
+  })
 ]
-var testLayer = new GraphicsLayer({
-   graphics: this.testFeatures
-})
-map.add(testLayer)
-var sketchEditor = new SketchEditor({
+const sketchEditor = new SketchEditor({
   view: sceneView,
   layer: new GraphicsLayer()
 })
@@ -868,7 +885,7 @@ sketchEditor.drawPolylineToPolygon(testGeometries)</code></pre>
     
         
         <div class="tag-source">
-            sketchEditor/SketchEditor.js, line 86
+            sketchEditor/SketchEditor.js, line 117
         </div>
         
     </div>
@@ -879,7 +896,7 @@ sketchEditor.drawPolylineToPolygon(testGeometries)</code></pre>
     
     
     <div class="description">
-        <p>移除草图图形的某个顶点<a id='removeVertex'></a></p>
+        <p>移除当前草图图形的指定顶点。</p>
     </div>
     
 
@@ -926,7 +943,7 @@ sketchEditor.drawPolylineToPolygon(testGeometries)</code></pre>
             
             <td class="description last">
                 
-                <p>需移除的顶点的索引值，索引值从0开始</p></td>
+                <p>需要移除的顶点索引值，索引值从 0 开始。</p></td>
         </tr>
 	
 	
@@ -991,7 +1008,152 @@ sketchEditor.drawPolylineToPolygon(testGeometries)</code></pre>
                         
                     
             </td>
-            <td class="description last">改变后的图形几何</td>
+            <td class="description last">更新后的草图几何。</td>
+        </tr>
+    
+    </tbody>
+</table>
+
+    
+    
+    
+</dd>
+
+        
+            
+<dt>
+    <div class="nameContainer">
+        <h4 class="name" id="setSnapAndReferFeatures">
+            
+            setSnapAndReferFeatures<span class="signature">(features)</span><span class="glyphicon glyphicon-circle-arrow-right"></span><span class="type-signature returnType">{void}</span>
+        </h4>
+    
+        
+        <div class="tag-source">
+            sketchEditor/SketchEditor.js, line 202
+        </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>features</code></td>
+            
+            
+            <td class="type">
+            
+                
+<span class="param-type">Array.&lt;Feature></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">
+            
+                        void
+                        
+                    
+            </td>
+            <td class="description last"></td>
         </tr>
     
     </tbody>
@@ -1013,7 +1175,7 @@ sketchEditor.drawPolylineToPolygon(testGeometries)</code></pre>
     
         
         <div class="tag-source">
-            sketchEditor/SketchEditor.js, line 132
+            sketchEditor/SketchEditor.js, line 160
         </div>
         
     </div>
@@ -1024,7 +1186,7 @@ sketchEditor.drawPolylineToPolygon(testGeometries)</code></pre>
     
     
     <div class="description">
-        <p>分割草图对象或区几何对象<a id='split'></a></p>
+        <p>分割草图对象或区几何对象。</p>
     </div>
     
 
@@ -1177,40 +1339,30 @@ sketchEditor.drawPolylineToPolygon(testGeometries)</code></pre>
     
 
     
-    <pre class="prettyprint"><code>// [ES5引入方式]：
+    <pre class="prettyprint"><code>// ES5引入方式
 const { Polygon, LineString } = zondy.geometry
-const { SceneView} = zondy.cesium
+const { SceneView } = zondy.cesium
 const { SketchEditor } = zondy.cesium.tool.sketch
 [ES6引入方式]：
-import { SceneView, SketchEditor } from "@mapgis/webclient-cesium-plugin" <br/>
-import { Polygon, LineString } from "@mapgis/webclient-common" <br/>
-var map = new Map()
-var sceneView = new SceneView({
-  viewId: "mapgis-3d-viewer",
-  map: map,
+import { SceneView, SketchEditor } from '@mapgis/webclient-cesium-plugin'
+import { Polygon, LineString } from '@mapgis/webclient-common'
+
+const map = new Map()
+const sceneView = new SceneView({
+  viewId: 'mapgis-3d-viewer',
+  map
 })
-var SketchEditor = new SketchEditor({
+const sketchEditor = new SketchEditor({
   view: sceneView,
   layer: new GraphicsLayer()
 })
 const polygon = new Polygon({
-  coordinates: [
-  [
-      [108, 29],
-      [116, 29],
-      [116, 33],
-      [108, 33],
-      [108, 29]
-    ]
-  ]
+  coordinates: [[[108, 29], [116, 29], [116, 33], [108, 33], [108, 29]]]
 })
 const polyline = new LineString({
-  coordinates: [
-    [100, 30],
-    [120, 30]
-  ]
+  coordinates: [[100, 30], [120, 30]]
 })
-const newSketchEditors = SketchEditor.split(polygon,polyline)</code></pre>
+const polygons = sketchEditor.split(polygon, polyline)</code></pre>
     
 
     
@@ -1227,7 +1379,7 @@ const newSketchEditors = SketchEditor.split(polygon,polyline)</code></pre>
     
         
         <div class="tag-source">
-            sketchEditor/SketchEditor.js, line 73
+            sketchEditor/SketchEditor.js, line 99
         </div>
         
     </div>
@@ -1238,7 +1390,8 @@ const newSketchEditors = SketchEditor.split(polygon,polyline)</code></pre>
     
     
     <div class="description">
-        <p>更新当前选中或区草图图形的某个顶点<a id='updateVertex'></a></p>
+        <p>更新当前线或区草图的指定顶点。</p>
+<p>在 Cesium 三维场景中，如果编辑器提供当前绘制高度，会先将该高度写入新顶点的 Z 坐标。</p>
     </div>
     
 
@@ -1285,7 +1438,7 @@ const newSketchEditors = SketchEditor.split(polygon,polyline)</code></pre>
             
             <td class="description last">
                 
-                <p>新的顶点</p></td>
+                <p>新的顶点。</p></td>
         </tr>
 	
 	
@@ -1308,7 +1461,7 @@ const newSketchEditors = SketchEditor.split(polygon,polyline)</code></pre>
             
             <td class="description last">
                 
-                <p>需更新的顶点的索引值，索引值从0开始</p></td>
+                <p>需要更新的顶点索引值，索引值从 0 开始。</p></td>
         </tr>
 	
 	
@@ -1373,7 +1526,7 @@ const newSketchEditors = SketchEditor.split(polygon,polyline)</code></pre>
                         
                     
             </td>
-            <td class="description last">改变后的图形几何</td>
+            <td class="description last">更新后的草图几何。</td>
         </tr>
     
     </tbody>
@@ -1398,7 +1551,7 @@ const newSketchEditors = SketchEditor.split(polygon,polyline)</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>