@mapgis/webclient-cesium-plugin 17.8.1 → 17.10.10

package/{documention → documentation}/MapGISM3DSet.html

@@ -94,28 +94,15 @@
     </div>
 
     
-    <p class="summary"><h5>请参考以下示例：</h5>
-<a href='#example1'>1、加载M3D</a><br>
-<a href='http://10.10.130.72:8086/#/example-gallery/cesium#sceneLayer' target='_blank'>2、场景图层</a><br>
-<a href='http://10.10.130.72:8086/#/example-gallery/cesium#modelCacheLayer' target='_blank'>3、模型缓存图层</a><br>
-<a href='http://10.10.130.72:8086/#/example-gallery/cesium#clientQuery' target='_blank'>4、客户端查询</a><br>
-<a href='http://10.10.130.72:8086/#/modules/cesium/edit/modelEditor/m3d-model-editor' target='_blank'>5、模型编辑(M3D)</a><br>
-<a href='http://10.10.130.72:8086/#/modules/cesium/analyse/compareAnalyse/roller-shutter' target='_blank'>6、卷帘</a><br>
-<a href='http://10.10.130.72:8086/#/example-gallery/cesium#commonAnalyse' target='_blank'>7、三维分析</a><br>
-<a href='http://10.10.130.72:8086/#/example-gallery/cesium#modelAnalyse' target='_blank'>8、模型分析</a><br>
-<a href='http://10.10.130.72:8086/#/example-gallery/cesium#geologyAnalyse' target='_blank'>9、地质体分析</a><br>
-<a href='http://10.10.130.72:8086/#/example-gallery/cesium#themeLayer' target='_blank'>10、专题图</a><br>
-<a href='http://10.10.130.72:8086/#/example-gallery/cesium#commonVisualization' target='_blank'>11、场景美化</a><br>
-<a href='http://10.10.130.72:8086/#/example-gallery/cesium#postEffect' target='_blank'>12、后处理特效</a><br>
-<h5>支持如下方法：</h5>
-<a href='#fromUrl'>[1、通过ArcGIS地图服务的url获取ArcGISMapServerImageryProvider对象]</a><br/></p>
-    
 </dt>
 <dd>
     
     
     <div class="description">
-        <p>MapGISM3DSet对象</p>
+        <p>MapGIS M3D 场景模型封装类。</p>
+<p>该类用于接入 MapGIS M3D 场景模型数据，并统一不同 Cesium 版本下的加载路径。
+在高版本中优先调用 <code>Cesium.MapGISM3DSet.fromUrl</code>，低版本自动回退到构造函数创建。
+调用方可通过 <code>fromUrl</code> 传入 <code>viewer</code>、<code>scene</code> 等上下文参数，避免直接处理底层兼容细节。</p>
     </div>
     
 
@@ -164,17 +151,15 @@
     
         <h5>Example</h5>
         
-        <p class="code-caption"><h7 id='example1'>加载M3D</h7></p>
+        <p class="code-caption"><h7 id='example1'>加载 M3D 场景模型</h7></p>
     
 
     
-    <pre class="prettyprint"><code>// 参考示例：
-http://10.10.130.72:8086/#/modules/cesium/layer/modelCacheLayer/geologic-body-native
-
-// ES5引入方式
+    <pre class="prettyprint"><code>// ES5引入方式
 const { MapGISM3DSet } = zondy.cesium
+
 // ES6引入方式
-import { MapGISM3DSet } from "@mapgis/webclient-cesium-plugin"
+import { MapGISM3DSet } from '@mapgis/webclient-cesium-plugin'
 
 // webclient-cesium 1.84版本必须传入_scene参数，而webclient-cesium 1.122版本无需传入_scene参数
 const options = {
@@ -186,7 +171,7 @@ const options = {
 MapGISM3DSet.fromUrl(options.url, options).then(m3dset => {
   viewer.scene.primitives.add(m3dset)
   viewer.zoomTo(m3dset)
-});</code></pre>
+})</code></pre>
     
 
     
@@ -218,12 +203,12 @@ MapGISM3DSet.fromUrl(options.url, options).then(m3dset => {
     <div class="nameContainer">
         <h4 class="name" id=".fromUrl">
             
-            MapGISM3DSet.fromUrl<span class="signature">(url, options)</span><span class="glyphicon glyphicon-circle-arrow-right"></span><span class="type-signature returnType">{Cesium.MapGISM3DSet}</span>
+            MapGISM3DSet.fromUrl<span class="signature">(url, <span class="optional">options</span>)</span><span class="glyphicon glyphicon-circle-arrow-right"></span><span class="type-signature returnType">{<a href="Promise.html">Promise</a>.&lt;Cesium.MapGISM3DSet>|Cesium.MapGISM3DSet}</span>
         </h4>
     
         
         <div class="tag-source">
-            engineExtensions/scene/M3D/MapGISM3DSet.js, line 73
+            engineExtensions/scene/M3D/MapGISM3DSet.js, line 33
         </div>
         
     </div>
@@ -234,7 +219,10 @@ MapGISM3DSet.fromUrl(options.url, options).then(m3dset => {
     
     
     <div class="description">
-        <p>通过MapGIS M3D服务的url获取MapGISM3DSet对象<a id='fromUrl'/></p>
+        <p>通过 MapGIS M3D 服务地址创建场景模型对象。</p>
+<p>当业务同时兼容多个 Cesium 版本时，推荐统一通过该工厂方法加载 M3D 模型。
+旧版本在使用自定义着色器或剖切封边功能时，仍需通过 <code>options._scene</code> 或 <code>options.viewer</code>
+提供底层场景对象。</p>
     </div>
     
 
@@ -255,6 +243,8 @@ MapGISM3DSet.fromUrl(options.url, options).then(m3dset => {
 		<th>Type</th>
 		
 		
+		<th>Default</th>
+		
 		
 		<th class="last">Description</th>
 	</tr>
@@ -281,10 +271,19 @@ MapGISM3DSet.fromUrl(options.url, options).then(m3dset => {
             </td>
             
             
+                <td class="default">
+                
+                </td>
+            
             
             <td class="description last">
                 
-                <p>服务的基地址</p></td>
+                    
+                    
+                        
+                    
+                
+                <p>M3D 服务地址或资源对象。</p></td>
         </tr>
 	
 	
@@ -304,10 +303,23 @@ MapGISM3DSet.fromUrl(options.url, options).then(m3dset => {
             </td>
             
             
+                <td class="default">
+                
+                    {}
+                
+                </td>
+            
             
             <td class="description last">
                 
-                <p>实例化对象时提供的额外配置参数，若该对象中包含构造参数则会覆盖对应的构造参数，参考<a href='http://10.10.130.72:8086/static/modules/cesium/api/cesium/MapGISM3DSet.html' target='_blank'>MapGISM3DSet</a>的初始化参数</p></td>
+                    
+                        <span class="optional"> 可选</span>
+                    
+                    
+                        
+                    
+                
+                <p>附加初始化参数。若其中包含与 URL 解析结果同名的字段，会以 <code>options</code> 为准。</p></td>
         </tr>
 	
 	
@@ -368,11 +380,14 @@ MapGISM3DSet.fromUrl(options.url, options).then(m3dset => {
             
             <td class="type">
             
+                        <a href="Promise.html">Promise</a>.&lt;Cesium.MapGISM3DSet>
+                         | 
+                    
                         Cesium.MapGISM3DSet
                         
                     
             </td>
-            <td class="description last">详见<a href='http://10.10.130.72:8086/static/modules/cesium/api/cesium/MapGISM3DSet.html' target='_blank'>Cesium.MapGISM3DSet</a></td>
+            <td class="description last">已初始化的 M3D 模型对象。</td>
         </tr>
     
     </tbody>
@@ -387,8 +402,9 @@ MapGISM3DSet.fromUrl(options.url, options).then(m3dset => {
     
     <pre class="prettyprint"><code>// ES5引入方式
 const { MapGISM3DSet } = zondy.cesium
+
 // ES6引入方式
-import { MapGISM3DSet } from "@mapgis/webclient-cesium-plugin"
+import { MapGISM3DSet } from '@mapgis/webclient-cesium-plugin'
 
 // webclient-cesium 1.84版本必须传入_scene参数，而webclient-cesium 1.122版本无需传入_scene参数
 const options = {
@@ -400,7 +416,7 @@ const options = {
 MapGISM3DSet.fromUrl(options.url, options).then(m3dset => {
   viewer.scene.primitives.add(m3dset)
   viewer.zoomTo(m3dset)
-});</code></pre>
+})</code></pre>
     
 
     
@@ -420,7 +436,7 @@ MapGISM3DSet.fromUrl(options.url, options).then(m3dset => {
 
 
         <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>

package/{documention → documentation}/MapGISMapServerImageryProvider.html

@@ -88,33 +88,21 @@
     
         
         <div class="tag-source">
-            engineExtensions/scene/imageryProvider/MapGISMapServerImageryProvider.js, line 13
+            engineExtensions/scene/imageryProvider/MapGISMapServerImageryProvider.js, line 7
         </div>
         
     </div>
 
     
-    <p class="summary"><h5>请参考以下示例：</h5>
-<a href='#example1'>1、添加一个MapGIS地图图片图层：原生接口开发</a><br>
-<a href='#example2'>2、添加一个MapGIS瓦片图层：混合接口</a><br>
-<a href='#example3'>3、extensions参数的配置方法</a><br>
-<a href='#example4'>4、headers参数的配置方法</a><br>
-<a href='http://10.10.130.72:8086/#/modules/cesium/layer/layerControl/mapgis-map-image-layers' target='_blank'>5、子图层过滤</a><br>
-<a href='http://10.10.130.72:8086/#/modules/cesium/layer/layerControl/image-layer-elevation-mode-setting' target='_blank'>6、影像图层高程模式设置</a><br>
-<a href='http://10.10.130.72:8086/#/modules/cesium/analyse/compareAnalyse/roller-shutter' target='_blank'>7、卷帘</a><br>
-<a href='http://10.10.130.72:8086/#/modules/cesium/sceneControl/scene/globe-independent-translucency' target='_blank'>8、地表透明度独立控制</a><br>
-<a href='http://10.10.130.72:8086/#/example-gallery/cesium#mapPictureLayer' target='_blank'>9、更多图层加载示例</a>
-<h5 style='margin-top: 10px;'>支持如下方法：</h5>
-<a href='#fromUrl'>[1、通过MapGIS地图服务的url获取MapGISMapServerImageryProvider对象]</a><br/>
-<a href='#pickFeatures'>[2、获取瓦片的要素]</a><br/>
-<a href='#requestImage'>[3、请求给定贴图的图像]</a><br/></p>
-    
 </dt>
 <dd>
     
     
     <div class="description">
         <p>IGS地图服务接入类</p>
+<p>该类用于将 IGS 地图服务封装为 Cesium 影像数据源，支持地图图片、场景覆盖物和 gdbp 出图三类常见接入方式。
+建议优先使用 <code>fromUrl</code> 读取服务元信息后再创建实例，以保持图层参数与服务端能力一致。
+当业务需要控制子图层过滤、动态图层、动态投影或请求头时，可在 <code>options</code> 中集中配置。</p>
     </div>
     
 
@@ -1081,6 +1069,7 @@
     
     <pre class="prettyprint"><code>// ES5引入方式
 const { MapGISMapServerImageryProvider } = zondy
+
 // ES6引入方式
 import { MapGISMapServerImageryProvider } from "@mapgis/webclient-cesium-plugin"
 
@@ -1104,6 +1093,7 @@ addIGSMapImageLayer(url)</code></pre>
 const { MapGISMapServerImageryProvider } = zondy
 const { IGSMapImageLayer } = zondy.layer
 const { initializeOptions } = zondy.cesium.util
+
 // ES6引入方式
 import { MapGISMapServerImageryProvider, initializeOptions } from "@mapgis/webclient-cesium-plugin"
 import { IGSMapImageLayer } from "@mapgis/webclient-common"
@@ -1133,8 +1123,9 @@ igsMapImageLayer.load().then((layer) => {
     
     <pre class="prettyprint"><code>// ES5引入方式
 const { MapGISMapServerImageryProvider } = zondy
+
 // ES6引入方式
-import { MapGISMapServerImageryProvider } from "@mapgis/webclient-cesium-pulgin-mini"
+import { MapGISMapServerImageryProvider } from "@mapgis/webclient-cesium-plugin"
 
 // extensions参数为自定义扩展参数，需要确保服务端支持此类参数
 const imageryProvider = new MapGISMapServerImageryProvider({
@@ -1460,14 +1451,14 @@ const options = {
             
 <dt>
     <div class="nameContainer">
-        <h4 class="name" id=".fromUrl">
+        <h4 class="name" id="requestImage">
             
-            MapGISMapServerImageryProvider.fromUrl<span class="signature">(url, options)</span><span class="glyphicon glyphicon-circle-arrow-right"></span><span class="type-signature returnType">{zondy.cesium.MapGISMapServerImageryProvider}</span>
+            requestImage<span class="signature">(x, y, level, request)</span><span class="glyphicon glyphicon-circle-arrow-right"></span><span class="type-signature returnType">{Object}</span>
         </h4>
     
         
         <div class="tag-source">
-            engineExtensions/scene/imageryProvider/MapGISMapServerImageryProvider.js, line 210
+            engineExtensions/scene/imageryProvider/MapGISMapServerImageryProvider.js, line 254
         </div>
         
     </div>
@@ -1478,7 +1469,7 @@ const options = {
     
     
     <div class="description">
-        <p>通过MapGIS地图服务的url获取MapGISMapServerImageryProvider对象<a id='fromUrl'/></p>
+        <p>请求给定贴图的图像<a id='requestImage'/></p>
     </div>
     
 
@@ -1509,16 +1500,36 @@ const options = {
 	
         <tr>
             
-                <td class="name"><code>url</code></td>
+                <td class="name"><code>x</code></td>
             
             
             <td class="type">
             
                 
-<span class="param-type">Cesium.Resource</span>
-|
+<span class="param-type">Number</span>
 
-<span class="param-type">String</span>
+
+            
+            </td>
+            
+            
+            
+            <td class="description last">
+                
+                <p>瓦片的X坐标</p></td>
+        </tr>
+	
+	
+	
+        <tr>
+            
+                <td class="name"><code>y</code></td>
+            
+            
+            <td class="type">
+            
+                
+<span class="param-type">Number</span>
 
 
             
@@ -1528,14 +1539,37 @@ const options = {
             
             <td class="description last">
                 
-                <p>服务的基地址，支持url字符串和Cesium.Resource两种类型，当类型为Cesium.Resource时，支持传入额外请求参数、请求头参数等，具体请参考<a href='http://10.10.130.72:8086/static/modules/cesium/api/cesium/Resource.html' target='_blank'>Cesium.Resource</a></p></td>
+                <p>瓦片的Y坐标</p></td>
         </tr>
 	
 	
 	
         <tr>
             
-                <td class="name"><code>options</code></td>
+                <td class="name"><code>level</code></td>
+            
+            
+            <td class="type">
+            
+                
+<span class="param-type">Number</span>
+
+
+            
+            </td>
+            
+            
+            
+            <td class="description last">
+                
+                <p>瓦片的详细级别</p></td>
+        </tr>
+	
+	
+	
+        <tr>
+            
+                <td class="name"><code>request</code></td>
             
             
             <td class="type">
@@ -1551,7 +1585,7 @@ const options = {
             
             <td class="description last">
                 
-                <p>实例化对象时提供的额外配置参数，若该对象中包含构造参数则会覆盖对应的构造参数</p></td>
+                <p>请求对象</p></td>
         </tr>
 	
 	
@@ -1612,11 +1646,11 @@ const options = {
             
             <td class="type">
             
-                        zondy.cesium.MapGISMapServerImageryProvider
+                        Object
                         
                     
             </td>
-            <td class="description last">初始化完毕的MapGISMapServerImageryProvider对象</td>
+            <td class="description last">瓦片的Resource对象</td>
         </tr>
     
     </tbody>
@@ -1631,14 +1665,14 @@ const options = {
             
 <dt>
     <div class="nameContainer">
-        <h4 class="name" id="requestImage">
+        <h4 class="name" id=".fromUrl">
             
-            requestImage<span class="signature">(x, y, level, request)</span><span class="glyphicon glyphicon-circle-arrow-right"></span><span class="type-signature returnType">{Object}</span>
+            MapGISMapServerImageryProvider.fromUrl<span class="signature">(url, options)</span><span class="glyphicon glyphicon-circle-arrow-right"></span><span class="type-signature returnType">{zondy.cesium.MapGISMapServerImageryProvider}</span>
         </h4>
     
         
         <div class="tag-source">
-            engineExtensions/scene/imageryProvider/MapGISMapServerImageryProvider.js, line 270
+            engineExtensions/scene/imageryProvider/MapGISMapServerImageryProvider.js, line 189
         </div>
         
     </div>
@@ -1649,7 +1683,7 @@ const options = {
     
     
     <div class="description">
-        <p>请求给定贴图的图像<a id='requestImage'/></p>
+        <p>通过MapGIS地图服务的url获取MapGISMapServerImageryProvider对象<a id='fromUrl'/></p>
     </div>
     
 
@@ -1680,59 +1714,16 @@ const options = {
 	
         <tr>
             
-                <td class="name"><code>x</code></td>
-            
-            
-            <td class="type">
-            
-                
-<span class="param-type">Number</span>
-
-
-            
-            </td>
-            
-            
-            
-            <td class="description last">
-                
-                <p>瓦片的X坐标</p></td>
-        </tr>
-	
-	
-	
-        <tr>
-            
-                <td class="name"><code>y</code></td>
+                <td class="name"><code>url</code></td>
             
             
             <td class="type">
             
                 
-<span class="param-type">Number</span>
-
+<span class="param-type">Cesium.Resource</span>
+|
 
-            
-            </td>
-            
-            
-            
-            <td class="description last">
-                
-                <p>瓦片的Y坐标</p></td>
-        </tr>
-	
-	
-	
-        <tr>
-            
-                <td class="name"><code>level</code></td>
-            
-            
-            <td class="type">
-            
-                
-<span class="param-type">Number</span>
+<span class="param-type">String</span>
 
 
             
@@ -1742,14 +1733,14 @@ const options = {
             
             <td class="description last">
                 
-                <p>瓦片的详细级别</p></td>
+                <p>服务的基地址，支持url字符串和Cesium.Resource两种类型，当类型为Cesium.Resource时，支持传入额外请求参数、请求头参数等，具体请参考<a href='http://10.10.130.72:8086/static/modules/cesium/api/cesium/Resource.html' target='_blank'>Cesium.Resource</a></p></td>
         </tr>
 	
 	
 	
         <tr>
             
-                <td class="name"><code>request</code></td>
+                <td class="name"><code>options</code></td>
             
             
             <td class="type">
@@ -1765,7 +1756,7 @@ const options = {
             
             <td class="description last">
                 
-                <p>请求对象</p></td>
+                <p>实例化对象时提供的额外配置参数，若该对象中包含构造参数则会覆盖对应的构造参数</p></td>
         </tr>
 	
 	
@@ -1826,11 +1817,11 @@ const options = {
             
             <td class="type">
             
-                        Object
+                        zondy.cesium.MapGISMapServerImageryProvider
                         
                     
             </td>
-            <td class="description last">瓦片的Resource对象</td>
+            <td class="description last">初始化完毕的MapGISMapServerImageryProvider对象</td>
         </tr>
     
     </tbody>
@@ -1855,7 +1846,7 @@ const options = {
 
 
         <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>