@mapgis/webclient-cesium-plugin 17.8.1 → 17.10.10

package/{documention → documentation}/MapGISTerrainService.html

@@ -83,7 +83,7 @@
     <div class="nameContainer">
         <h4 class="name" id="MapGISTerrainService">
             
-            new MapGISTerrainService<span class="signature">(options)</span>
+            new MapGISTerrainService<span class="signature">(<span class="optional">options</span>)</span>
         </h4>
     
         
@@ -94,17 +94,15 @@
     </div>
 
     
-    <p class="summary"><h5>支持如下方法：</h5>
-<a href='#fromJSON'>[1、通过JSON构造地形服务对象]</a><br/>
-<a href='#toJSON'>[1、将地形服务对象导出为JSON对象]</a><br/>
-<a href='#clone'>[1、克隆并返回一个新的地形服务对象]</a></p>
-    
 </dt>
 <dd>
     
     
     <div class="description">
-        <p>MapGIS地形服务对象</p>
+        <p>MapGIS 单个地形服务描述对象。</p>
+<p>该类用于描述单个 DEM 地形服务的地址、范围、法向量请求开关和显示级别限制，
+是 <code>MapGISTerrainProvider</code> 管理多地形来源时的基础数据结构。支持 JSON 序列化、
+反序列化和克隆，便于在配置持久化与运行时切换之间复用同一份参数。</p>
     </div>
     
 
@@ -125,6 +123,8 @@
 		<th>Type</th>
 		
 		
+		<th>Default</th>
+		
 		
 		<th class="last">Description</th>
 	</tr>
@@ -148,10 +148,23 @@
             </td>
             
             
+                <td class="default">
+                
+                    {}
+                
+                </td>
+            
             
             <td class="description last">
                 
+                    
+                        <span class="optional"> 可选</span>
+                    
+                    
+                        
+                    
                 
+                <p>构造参数。</p>
                 
 
 <table class="params">
@@ -203,7 +216,7 @@
                         
                     
                 
-                <p>地形服务id，没有则给一个随机Id</p></td>
+                <p>地形服务标识。未传入时自动生成随机 ID。</p></td>
         </tr>
 	
 	
@@ -242,11 +255,7 @@
                         
                     
                 
-                <p>服务基地址，
-当仅加载一个DEM地形服务时，使用该初始化参数，当加载多个DEM地形服务时，请使用serviceList初始化参数，<br>
-基地址格式为:<br>
-IGS1.0: http://{ip}:{port}/igs/rest/g3d/{folder}:{serviceName}/GetTerrain<br>
-IGS2.0: http://{ip}:{port}/igs/rest/services/{folder}/{serviceName}/SceneServer/layers/{layerId}/terrains</p></td>
+                <p>地形服务地址。单服务模式下直接使用该地址，多服务模式下由 <code>MapGISTerrainProvider.serviceList</code> 统一管理。</p></td>
         </tr>
 	
 	
@@ -282,7 +291,7 @@ IGS2.0: http://{ip}:{port}/igs/rest/services/{folder}/{serviceName}/SceneServer/
                         
                     
                 
-                <p>地形服务是否显示</p></td>
+                <p>是否参与当前地形显示与可用性计算。</p></td>
         </tr>
 	
 	
@@ -318,7 +327,7 @@ IGS2.0: http://{ip}:{port}/igs/rest/services/{folder}/{serviceName}/SceneServer/
                         
                     
                 
-                <p>地形服务最大显示级数</p></td>
+                <p>当前地形服务允许响应的最大级别。</p></td>
         </tr>
 	
 	
@@ -354,7 +363,7 @@ IGS2.0: http://{ip}:{port}/igs/rest/services/{folder}/{serviceName}/SceneServer/
                         
                     
                 
-                <p>地形服务是否请求法向量</p></td>
+                <p>是否请求当前地形服务的法向量数据。</p></td>
         </tr>
 	
 	
@@ -390,7 +399,7 @@ IGS2.0: http://{ip}:{port}/igs/rest/services/{folder}/{serviceName}/SceneServer/
                         
                     
                 
-                <p>地形服务二维范围</p></td>
+                <p>地形服务的二维范围。</p></td>
         </tr>
 	
 	
@@ -426,7 +435,7 @@ IGS2.0: http://{ip}:{port}/igs/rest/services/{folder}/{serviceName}/SceneServer/
                         
                     
                 
-                <p>地形服务三维范围</p></td>
+                <p>地形服务的三维范围。</p></td>
         </tr>
 	
 	
@@ -462,7 +471,7 @@ IGS2.0: http://{ip}:{port}/igs/rest/services/{folder}/{serviceName}/SceneServer/
                         
                     
                 
-                <p>地形服务的平铺方案，<a href='http://10.10.130.72:8086/static/modules/cesium/api/cesium/index.html?classFilter=TilingScheme' target='_blank'>详见Cesium.TilingScheme</a></p></td>
+                <p>当前地形服务的瓦片平铺方案。</p></td>
         </tr>
 	
 	
@@ -513,6 +522,21 @@ IGS2.0: http://{ip}:{port}/igs/rest/services/{folder}/{serviceName}/SceneServer/
     
     
     
+        <h5>Example</h5>
+        
+
+    
+    <pre class="prettyprint"><code>// ES5引入方式
+const { MapGISTerrainService } = zondy.cesium
+
+// ES6引入方式
+import { MapGISTerrainService } from '@mapgis/webclient-cesium-plugin'
+
+const service = MapGISTerrainService.fromJSON(json)
+const cloned = service.clone()</code></pre>
+    
+
+    
 </dd>
 
     
@@ -909,14 +933,14 @@ IGS2.0: http://{ip}:{port}/igs/rest/services/{folder}/{serviceName}/SceneServer/
             
 <dt>
     <div class="nameContainer">
-        <h4 class="name" id=".fromJSON">
+        <h4 class="name" id="clone">
             
-            MapGISTerrainService.fromJSON<span class="signature">(json)</span><span class="glyphicon glyphicon-circle-arrow-right"></span><span class="type-signature returnType">{<a href="MapGISTerrainService.html">MapGISTerrainService</a>}</span>
+            clone<span class="signature">()</span><span class="glyphicon glyphicon-circle-arrow-right"></span><span class="type-signature returnType">{<a href="MapGISTerrainService.html">MapGISTerrainService</a>}</span>
         </h4>
     
         
         <div class="tag-source">
-            engineExtensions/core/MapGISTerrainService.js, line 93
+            engineExtensions/core/MapGISTerrainService.js, line 126
         </div>
         
     </div>
@@ -927,7 +951,8 @@ IGS2.0: http://{ip}:{port}/igs/rest/services/{folder}/{serviceName}/SceneServer/
     
     
     <div class="description">
-        <p>通过JSON构造地形服务对象<a id='fromJSON'/></p>
+        <p>克隆当前地形服务对象。</p>
+<p>克隆结果会复制当前实例的配置字段，但不会共享引用状态。</p>
     </div>
     
 
@@ -936,51 +961,6 @@ IGS2.0: http://{ip}:{port}/igs/rest/services/{folder}/{serviceName}/SceneServer/
     
     
     
-        
-
-<table class="params">
-    <thead>
-	<tr>
-		
-		<th>Name</th>
-		
-		
-		<th>Type</th>
-		
-		
-		
-		<th class="last">Description</th>
-	</tr>
-	</thead>
-	
-	<tbody>
-	
-	
-        <tr>
-            
-                <td class="name"><code>json</code></td>
-            
-            
-            <td class="type">
-            
-                
-<span class="param-type">Object</span>
-
-
-            
-            </td>
-            
-            
-            
-            <td class="description last">
-                
-                <p>json对象</p></td>
-        </tr>
-	
-	
-	</tbody>
-</table>
-    
     
     
 <dl class="details">
@@ -1039,7 +1019,7 @@ IGS2.0: http://{ip}:{port}/igs/rest/services/{folder}/{serviceName}/SceneServer/
                         
                     
             </td>
-            <td class="description last">地形服务对象</td>
+            <td class="description last">新的地形服务副本。</td>
         </tr>
     
     </tbody>
@@ -1054,14 +1034,14 @@ IGS2.0: http://{ip}:{port}/igs/rest/services/{folder}/{serviceName}/SceneServer/
             
 <dt>
     <div class="nameContainer">
-        <h4 class="name" id="clone">
+        <h4 class="name" id="toJSON">
             
-            clone<span class="signature">()</span><span class="glyphicon glyphicon-circle-arrow-right"></span><span class="type-signature returnType">{<a href="MapGISTerrainService.html">MapGISTerrainService</a>}</span>
+            toJSON<span class="signature">()</span><span class="glyphicon glyphicon-circle-arrow-right"></span><span class="type-signature returnType">{Object}</span>
         </h4>
     
         
         <div class="tag-source">
-            engineExtensions/core/MapGISTerrainService.js, line 117
+            engineExtensions/core/MapGISTerrainService.js, line 106
         </div>
         
     </div>
@@ -1072,7 +1052,8 @@ IGS2.0: http://{ip}:{port}/igs/rest/services/{folder}/{serviceName}/SceneServer/
     
     
     <div class="description">
-        <p>克隆并返回一个新的地形服务对象<a id='clone'/></p>
+        <p>导出当前地形服务的 JSON 配置。</p>
+<p>适用于持久化当前地形服务状态，通常与 <code>fromJSON</code> 配合使用。</p>
     </div>
     
 
@@ -1135,11 +1116,11 @@ IGS2.0: http://{ip}:{port}/igs/rest/services/{folder}/{serviceName}/SceneServer/
             
             <td class="type">
             
-                        <a href="MapGISTerrainService.html">MapGISTerrainService</a>
+                        Object
                         
                     
             </td>
-            <td class="description last">新的地形服务对象</td>
+            <td class="description last">当前地形服务的序列化配置对象。</td>
         </tr>
     
     </tbody>
@@ -1154,14 +1135,14 @@ IGS2.0: http://{ip}:{port}/igs/rest/services/{folder}/{serviceName}/SceneServer/
             
 <dt>
     <div class="nameContainer">
-        <h4 class="name" id="toJSON">
+        <h4 class="name" id=".fromJSON">
             
-            toJSON<span class="signature">()</span><span class="glyphicon glyphicon-circle-arrow-right"></span><span class="type-signature returnType">{Object}</span>
+            MapGISTerrainService.fromJSON<span class="signature">(<span class="optional">json</span>)</span><span class="glyphicon glyphicon-circle-arrow-right"></span><span class="type-signature returnType">{<a href="MapGISTerrainService.html">MapGISTerrainService</a>}</span>
         </h4>
     
         
         <div class="tag-source">
-            engineExtensions/core/MapGISTerrainService.js, line 101
+            engineExtensions/core/MapGISTerrainService.js, line 93
         </div>
         
     </div>
@@ -1172,7 +1153,8 @@ IGS2.0: http://{ip}:{port}/igs/rest/services/{folder}/{serviceName}/SceneServer/
     
     
     <div class="description">
-        <p>将地形服务对象导出为JSON对象<a id='toJSON'/></p>
+        <p>通过 JSON 配置恢复地形服务对象。</p>
+<p>适用于从持久化配置、接口返回结果或 <code>toJSON</code> 输出中重新创建地形服务实例。</p>
     </div>
     
 
@@ -1181,6 +1163,66 @@ IGS2.0: http://{ip}:{port}/igs/rest/services/{folder}/{serviceName}/SceneServer/
     
     
     
+        
+
+<table class="params">
+    <thead>
+	<tr>
+		
+		<th>Name</th>
+		
+		
+		<th>Type</th>
+		
+		
+		<th>Default</th>
+		
+		
+		<th class="last">Description</th>
+	</tr>
+	</thead>
+	
+	<tbody>
+	
+	
+        <tr>
+            
+                <td class="name"><code>json</code></td>
+            
+            
+            <td class="type">
+            
+                
+<span class="param-type">Object</span>
+
+
+            
+            </td>
+            
+            
+                <td class="default">
+                
+                    {}
+                
+                </td>
+            
+            
+            <td class="description last">
+                
+                    
+                        <span class="optional"> 可选</span>
+                    
+                    
+                        
+                    
+                
+                <p>地形服务配置对象。</p></td>
+        </tr>
+	
+	
+	</tbody>
+</table>
+    
     
     
 <dl class="details">
@@ -1235,11 +1277,11 @@ IGS2.0: http://{ip}:{port}/igs/rest/services/{folder}/{serviceName}/SceneServer/
             
             <td class="type">
             
-                        Object
+                        <a href="MapGISTerrainService.html">MapGISTerrainService</a>
                         
                     
             </td>
-            <td class="description last">json对象</td>
+            <td class="description last">恢复后的地形服务对象。</td>
         </tr>
     
     </tbody>
@@ -1264,7 +1306,7 @@ IGS2.0: http://{ip}:{port}/igs/rest/services/{folder}/{serviceName}/SceneServer/
 
 
         <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>