@mapgis/webclient-cesium-plugin 17.8.1 → 17.10.10

package/{documention → documentation}/MapGISDynamicLabelCollection.html

@@ -88,7 +88,7 @@
     
         
         <div class="tag-source">
-            engineExtensions/scene/MapGISDynamicLabelCollection.js, line 16
+            engineExtensions/scene/MapGISDynamicLabelCollection.js, line 8
         </div>
         
     </div>
@@ -99,7 +99,7 @@
     
     
     <div class="description">
-        <p>动态注记容器</p>
+        <p>动态注记容器，用于按注记样式批量管理标签、贴图文字或贴地注记，并可接入动态避让能力。</p>
     </div>
     
 
@@ -169,6 +169,38 @@
 	<tbody>
 	
 	
+        <tr>
+            
+                <td class="name"><code>scene</code></td>
+            
+            
+            <td class="type">
+            
+                
+<span class="param-type">Cesium.Scene</span>
+
+
+            
+            </td>
+            
+            
+                <td class="default">
+                
+                </td>
+            
+            
+            <td class="description last">
+                
+                    
+                    
+                        
+                    
+                
+                <p>Cesium 场景对象</p></td>
+        </tr>
+	
+	
+	
         <tr>
             
                 <td class="name"><code>id</code></td>
@@ -177,7 +209,7 @@
             <td class="type">
             
                 
-<span class="param-type">Number</span>
+<span class="param-type">String</span>
 
 
             
@@ -198,7 +230,7 @@
                         
                     
                 
-                <p>容器id</p></td>
+                <p>容器 ID</p></td>
         </tr>
 	
 	
@@ -268,7 +300,7 @@
                         
                     
                 
-                <p>要素JSON的请求资源路径</p></td>
+                <p>要素 JSON 的请求资源路径</p></td>
         </tr>
 	
 	
@@ -340,7 +372,43 @@
                         
                     
                 
-                <p>注记样式</p></td>
+                <p>注记样式列表</p></td>
+        </tr>
+	
+	
+	
+        <tr>
+            
+                <td class="name"><code>symbolScale</code></td>
+            
+            
+            <td class="type">
+            
+                
+<span class="param-type">Number</span>
+
+
+            
+            </td>
+            
+            
+                <td class="default">
+                
+                    1
+                
+                </td>
+            
+            
+            <td class="description last">
+                
+                    
+                        <span class="optional"> 可选</span>
+                    
+                    
+                        
+                    
+                
+                <p>请求注记资源转换时使用的符号缩放因子</p></td>
         </tr>
 	
 	
@@ -376,7 +444,7 @@
                         
                     
                 
-                <p>开启卷帘对比分析</p></td>
+                <p>是否开启卷帘对比分析</p></td>
         </tr>
 	
 	
@@ -412,7 +480,7 @@
                         
                     
                 
-                <p>单独控制该图层是否进行反转。小于0不反转，大于0时反转，等于0失效。该属性的控制优先级高于<code>Scene#swipeController</code>中的inverse属性.若要取消该属性对本图层的独立控制需要将该属性置为0。</p></td>
+                <p>图层级卷帘反转控制值；小于 <code>0</code> 不反转，大于 <code>0</code> 时反转，等于 <code>0</code> 时失效</p></td>
         </tr>
 	
 	
@@ -463,6 +531,26 @@
     
     
     
+        <h5>Example</h5>
+        
+        <p class="code-caption"><h7>创建动态注记容器</h7></p>
+    
+
+    
+    <pre class="prettyprint"><code>// ES5引入方式
+const { MapGISDynamicLabelCollection } = zondy.cesium
+
+// ES6引入方式
+import { MapGISDynamicLabelCollection } from "@mapgis/webclient-cesium-plugin"
+
+const labelCollection = new MapGISDynamicLabelCollection({
+  scene: viewer.scene,
+  visible: true
+})
+viewer.scene.primitives.add(labelCollection)</code></pre>
+    
+
+    
 </dd>
 
     
@@ -493,7 +581,7 @@
 <dd>
     
     <div class="description">
-        <p>显隐设置</p>
+        <p>图层显隐状态。</p>
     </div>
     
     
@@ -515,7 +603,7 @@
     
     
     <dt class="tag-default">Default Value:</dt>
-    false</li></ul></dd>
+    true</li></ul></dd>
     
     
     
@@ -541,7 +629,7 @@
 <dd>
     
     <div class="description">
-        <p>开启卷帘对比分析</p>
+        <p>是否开启卷帘对比分析。</p>
     </div>
     
     
@@ -589,7 +677,7 @@
 <dd>
     
     <div class="description">
-        <p>单独控制该图层是否进行反转，小于0不反转，大于0时反转，等于0失效。该属性的控制优先级高于<code>Scene#swipeController</code>中的inverse属性.若要取消该属性对本图层的独立控制需要将该属性置为0.</p>
+        <p>图层级卷帘反转控制值。</p>
     </div>
     
     
@@ -625,119 +713,21 @@
     
 </dd>
 
-        </dl>
-    
-
-    
-
-    
-        <h3 class="subsection-title">Methods</h3>
         
-        <dl>
             
 <dt>
     <div class="nameContainer">
-        <h4 class="name" id=".initializeBillBoardOptions">
-            
-            MapGISDynamicLabelCollection.initializeBillBoardOptions<span class="signature">(position, textSymbol)</span><span class="glyphicon glyphicon-circle-arrow-right"></span><span class="type-signature returnType">{Object}</span>
-        </h4>
-    
-        
-        <div class="tag-source">
-            engineExtensions/scene/MapGISDynamicLabelCollection.js, line 329
-        </div>
-        
+        <h4 class="name" id="translucency">translucency<span class="type-signature type number">Number</span> </h4>
     </div>
-
+    
     
 </dt>
 <dd>
     
-    
     <div class="description">
-        <p>根据cesium笛卡尔坐标和文字符号生成BillBoards样式</p>
+        <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>position</code></td>
-            
-            
-            <td class="type">
-            
-                
-<span class="param-type">Cesium.Cartersian3</span>
-
-
-            
-            </td>
-            
-            
-            
-            <td class="description last">
-                
-                </td>
-        </tr>
-	
-	
-	
-        <tr>
-            
-                <td class="name"><code>textSymbol</code></td>
-            
-            
-            <td class="type">
-            
-                
-<span class="param-type">TextSymbol</span>
-|
-
-<span class="param-type">MapGISTextSymbol</span>
-|
-
-<span class="param-type">Object</span>
-
-
-            
-            </td>
-            
-            
-            
-            <td class="description last">
-                
-                </td>
-        </tr>
-	
-	
-	</tbody>
-</table>
-    
     
     
 <dl class="details">
@@ -756,6 +746,9 @@
     
     
     
+    <dt class="tag-default">Default Value:</dt>
+    1</li></ul></dd>
+    
     
     
     
@@ -766,48 +759,17 @@
 
     
     
+</dd>
 
+        </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">参考Cesium.Billboard.ConstructorOptions</td>
-        </tr>
-    
-    </tbody>
-</table>
 
     
-    
-    
-</dd>
-
+        <h3 class="subsection-title">Methods</h3>
         
+        <dl>
             
 <dt>
     <div class="nameContainer">
@@ -818,7 +780,7 @@
     
         
         <div class="tag-source">
-            engineExtensions/scene/MapGISDynamicLabelCollection.js, line 266
+            engineExtensions/scene/MapGISDynamicLabelCollection.js, line 300
         </div>
         
     </div>
@@ -918,7 +880,7 @@
     
         
         <div class="tag-source">
-            engineExtensions/scene/MapGISDynamicLabelCollection.js, line 197
+            engineExtensions/scene/MapGISDynamicLabelCollection.js, line 213
         </div>
         
     </div>
@@ -928,6 +890,10 @@
 <dd>
     
     
+    <div class="description">
+        <p>根据要素列表创建并添加动态注记。</p>
+    </div>
+    
 
     
     
@@ -1063,7 +1029,7 @@
                         
                     
             </td>
-            <td class="description last"></td>
+            <td class="description last">已添加的注记对象列表</td>
         </tr>
     
     </tbody>
@@ -1078,14 +1044,14 @@
             
 <dt>
     <div class="nameContainer">
-        <h4 class="name" id="destroy">
+        <h4 class="name" id="clearLabels">
             
-            destroy<span class="signature">()</span><span class="glyphicon glyphicon-circle-arrow-right"></span><span class="type-signature returnType">{*}</span>
+            clearLabels<span class="signature">()</span>
         </h4>
     
         
         <div class="tag-source">
-            engineExtensions/scene/MapGISDynamicLabelCollection.js, line 304
+            engineExtensions/scene/MapGISDynamicLabelCollection.js, line 340
         </div>
         
     </div>
@@ -1095,6 +1061,12 @@
 <dd>
     
     
+    <div class="description">
+        <p>清空当前容器中的所有动态注记，保留内部 collection 与动态避让顺序。</p>
+<p>labelClass 更新时复用已有 MapGISDynamicLabelCollection，只清空并重新添加注记，
+可以避免删除重建导致 DynamicEntityVisualizer 中的 collection 顺序变化。</p>
+    </div>
+    
 
     
     
@@ -1137,36 +1109,78 @@
     
     
     
-    <h5>Returns:</h5>
     
+    
+</dd>
 
-
-<table class="params">
-    <thead>
-    <tr>
         
-        <th>Type</th>
-        <th class="last">Description</th>
-    </tr>
-    </thead>
-    <tbody>
-    
-        <tr>
             
-            <td class="type">
+<dt>
+    <div class="nameContainer">
+        <h4 class="name" id="destroy">
             
-                        *
-                        
-                    
-            </td>
-            <td class="description last"></td>
-        </tr>
+            destroy<span class="signature">()</span>
+        </h4>
     
-    </tbody>
-</table>
+        
+        <div class="tag-source">
+            engineExtensions/scene/MapGISDynamicLabelCollection.js, line 360
+        </div>
+        
+    </div>
+
+    
+</dt>
+<dd>
+    
+    
+    <div class="description">
+        <p>销毁动态注记容器，并从动态避让视图或场景中移除已托管容器。</p>
+    </div>
+    
+
+    
+    
+    
+    
+    
+    
+    
+<dl class="details">
+    
+        
+    
+    
+    
+
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+</dl>
 
     
     
+
+    
+
+    
+    
+    
+    
+    
+    
     
 </dd>
 
@@ -1181,7 +1195,7 @@
     
         
         <div class="tag-source">
-            engineExtensions/scene/MapGISDynamicLabelCollection.js, line 318
+            engineExtensions/scene/MapGISDynamicLabelCollection.js, line 375
         </div>
         
     </div>
@@ -1191,6 +1205,10 @@
 <dd>
     
     
+    <div class="description">
+        <p>判断容器是否已销毁。</p>
+    </div>
+    
 
     
     
@@ -1277,7 +1295,7 @@
     
         
         <div class="tag-source">
-            engineExtensions/scene/MapGISDynamicLabelCollection.js, line 209
+            engineExtensions/scene/MapGISDynamicLabelCollection.js, line 226
         </div>
         
     </div>
@@ -1287,6 +1305,10 @@
 <dd>
     
     
+    <div class="description">
+        <p>根据要素列表删除对应动态注记。</p>
+    </div>
+    
 
     
     
@@ -1379,6 +1401,176 @@
     
     
     
+</dd>
+
+        
+            
+<dt>
+    <div class="nameContainer">
+        <h4 class="name" id=".initializeBillBoardOptions">
+            
+            MapGISDynamicLabelCollection.initializeBillBoardOptions<span class="signature">(position, textSymbol)</span><span class="glyphicon glyphicon-circle-arrow-right"></span><span class="type-signature returnType">{Object}</span>
+        </h4>
+    
+        
+        <div class="tag-source">
+            engineExtensions/scene/MapGISDynamicLabelCollection.js, line 387
+        </div>
+        
+    </div>
+
+    
+</dt>
+<dd>
+    
+    
+
+    
+    
+    
+    
+    
+        
+
+<table class="params">
+    <thead>
+	<tr>
+		
+		<th>Name</th>
+		
+		
+		<th>Type</th>
+		
+		
+		
+		<th class="last">Description</th>
+	</tr>
+	</thead>
+	
+	<tbody>
+	
+	
+        <tr>
+            
+                <td class="name"><code>position</code></td>
+            
+            
+            <td class="type">
+            
+                
+<span class="param-type">Cesium.Cartesian3</span>
+
+
+            
+            </td>
+            
+            
+            
+            <td class="description last">
+                
+                <p>标注位置</p></td>
+        </tr>
+	
+	
+	
+        <tr>
+            
+                <td class="name"><code>textSymbol</code></td>
+            
+            
+            <td class="type">
+            
+                
+<span class="param-type">TextSymbol</span>
+|
+
+<span class="param-type">MapGISTextSymbol</span>
+|
+
+<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">
+            
+                        Object
+                        
+                    
+            </td>
+            <td class="description last">参考 <code>Cesium.Billboard.ConstructorOptions</code></td>
+        </tr>
+    
+    </tbody>
+</table>
+
+    
+    
+    
 </dd>
 
         </dl>
@@ -1395,7 +1587,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 Fri Sep 18 2026 14:59:30 GMT+0800 (中国标准时间)
         </footer>
     </div>
 </div>