@mapgis/webclient-cesium-plugin 17.8.1 → 17.10.10

package/{documention → documentation}/MapGISMapServerSingleImageryProvider.html

@@ -88,7 +88,7 @@
     
         
         <div class="tag-source">
-            engineExtensions/scene/imageryProvider/MapGISMapServerSingleImageryProvider.js, line 12
+            engineExtensions/scene/imageryProvider/MapGISMapServerSingleImageryProvider.js, line 7
         </div>
         
     </div>
@@ -99,7 +99,15 @@
     
     
     <div class="description">
-        <p>IGS地图服务一张图出图接入类</p>
+        <p>MapGIS 一张图出图影像提供器。</p>
+<p>该类用于把 MapGIS 地图服务、场景覆盖物出图接口或 gdbp 出图接口封装为
+Cesium 可直接加载的单张出图 imagery provider。适用于需要按视口动态请求
+一张大图，而不是按标准瓦片服务逐块拉取的场景。</p>
+<p>常见服务地址包括：
+<code>.../mrms/docs/{folder}:{serviceName}</code>、
+<code>.../services/{folder}/{serviceName}/MapServer</code>、
+<code>.../services/{folder}/{serviceName}/SceneServer</code>、
+<code>.../services/system/ResourceServer</code>。</p>
     </div>
     
 
@@ -146,7 +154,7 @@
             
             <td class="description last">
                 
-                <p>初始化时的构造参数</p>
+                <p>初始化参数。</p>
                 
 
 <table class="params">
@@ -196,7 +204,7 @@
                         
                     
                 
-                <p>cesium视图对象</p></td>
+                <p>Cesium 视图对象。</p></td>
         </tr>
 	
 	
@@ -235,17 +243,19 @@
                         
                     
                 
-                <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><br/>
-格式如下：<br/>
-1、动态出图:<br/>
-1.1、IGS1.0服务基地址: http://{ip}:{port}/igs/rest/mrms/docs/{folder}:{serviceName}<br/>
-1.2、IGS2.0服务基地址: http://{ip}:{port}/igs/rest/services/{folder}/{serviceName}/MapServer<br/>
-2、场景覆盖物图层:<br/>
-2.1、IGS1.0服务基地址: http://{ip}:{port}/igs/rest/g3d/{folder}:{serviceName}<br/>
-2.2、IGS2.0服务基地址: http://{ip}:{port}/igs/rest/services/{folder}/{serviceName}/SceneServer<br/>
-3、gdbp出图:<br/>
-3.1、IGS1.0服务基地址: http://{ip}:{port}/igs/rest/mrms/layers
-3.2、IGS2.0服务基地址: http://{ip}:{port}/igs/rest/services/system/ResourceServer</p></td>
+                <p>服务基地址，可传字符串或 <code>Cesium.Resource</code>。
+格式如下：</p>
+<ol>
+<li>动态出图：
+<code>http://{ip}:{port}/igs/rest/mrms/docs/{folder}:{serviceName}</code>
+<code>http://{ip}:{port}/igs/rest/services/{folder}/{serviceName}/MapServer</code></li>
+<li>场景覆盖物出图：
+<code>http://{ip}:{port}/igs/rest/g3d/{folder}:{serviceName}</code>
+<code>http://{ip}:{port}/igs/rest/services/{folder}/{serviceName}/SceneServer</code></li>
+<li>gdbp 出图：
+<code>http://{ip}:{port}/igs/rest/mrms/layers</code>
+<code>http://{ip}:{port}/igs/rest/services/system/ResourceServer</code></li>
+</ol></td>
         </tr>
 	
 	
@@ -281,7 +291,7 @@
                         
                     
                 
-                <p>要显示的子图层id，多个子图层以逗号分隔，'layer1,layer2,...'，如果要显示所有层，则请传一个空字符串</p></td>
+                <p>需要显示的子图层 ID 字符串，多个图层以逗号分隔。</p></td>
         </tr>
 	
 	
@@ -320,7 +330,7 @@
                         
                     
                 
-                <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>
 	
 	
@@ -356,7 +366,7 @@
                         
                     
                 
-                <p>地图图层显示范围，超出范围不会额外请求瓦片，<a href='http://10.10.130.72:8086/static/modules/cesium/api/cesium/index.html?classFilter=Rectangle' target='_blank'>详见Cesium.Rectangle</a></p></td>
+                <p>图层显示范围，超出范围不再额外请求图片。</p></td>
         </tr>
 	
 	
@@ -392,7 +402,7 @@
                         
                     
                 
-                <p>图层空间参考系</p></td>
+                <p>图层空间参考。</p></td>
         </tr>
 	
 	
@@ -428,7 +438,7 @@
                         
                     
                 
-                <p>HTTP请求方式，&quot;GET&quot;、&quot;POST&quot;，默认为GET请求</p></td>
+                <p>HTTP 请求方式，支持 <code>GET</code> 和 <code>POST</code>。</p></td>
         </tr>
 	
 	
@@ -464,7 +474,7 @@
                         
                     
                 
-                <p>图层最小请求瓦片级别，小于该级别不再请求瓦片</p></td>
+                <p>最小请求级别。</p></td>
         </tr>
 	
 	
@@ -500,7 +510,7 @@
                         
                     
                 
-                <p>图层最大请求瓦片级别，大于该级别不再请求瓦片</p></td>
+                <p>最大请求级别。</p></td>
         </tr>
 	
 	
@@ -536,7 +546,7 @@
                         
                     
                 
-                <p>gdbps地址数组</p></td>
+                <p>gdbp 地址数组。</p></td>
         </tr>
 	
 	
@@ -572,7 +582,7 @@
                         
                     
                 
-                <p>用户指定的图层过滤条件，它由多个键值对组成，值为过滤条件</p></td>
+                <p>图层过滤条件。</p></td>
         </tr>
 	
 	
@@ -608,7 +618,7 @@
                         
                     
                 
-                <p>转发代理</p></td>
+                <p>转发代理。</p></td>
         </tr>
 	
 	
@@ -644,7 +654,7 @@
                         
                     
                 
-                <p>动态图层信息</p></td>
+                <p>动态图层信息。</p></td>
         </tr>
 	
 	
@@ -680,7 +690,7 @@
                         
                     
                 
-                <p>重载build2DImageResource方法，来重载瓦片的请求逻辑</p></td>
+                <p>自定义图片请求资源构造函数。</p></td>
         </tr>
 	
 	
@@ -714,7 +724,7 @@
                         
                     
                 
-                <p>客户端id，用户的唯一标识；在地图服务中，调用接口时如果修改了地图的状态，包括设置动态投影、设置图层显示隐藏等，为了提升并发性能，服务端会根据clientId来生成临时地图，最佳做法是一个浏览器生成一个固定的唯一值；建议普通用户不要传该参数，webclient会根据当前浏览器生成一个固定的唯一值</p></td>
+                <p>客户端唯一标识，用于服务端临时地图复用。</p></td>
         </tr>
 	
 	
@@ -753,7 +763,7 @@
                         
                     
                 
-                <p>返回的图片时，是否开启服务端抗锯齿功能；启用抗锯齿功能后，显示效果会更清晰，但会导致出图速度变慢，true表示开启抗锯齿，false表示关闭抗锯齿，如果没有设置，则默认应用地图文档(MapX)上的设置参数</p></td>
+                <p>是否启用服务端抗锯齿。</p></td>
         </tr>
 	
 	
@@ -789,7 +799,7 @@
                         
                     
                 
-                <p>场景服务-覆盖物出图时指定的图层下标</p></td>
+                <p>场景覆盖物出图时指定的图层下标。</p></td>
         </tr>
 	
 	
@@ -825,7 +835,7 @@
                         
                     
                 
-                <p>图片格式</p></td>
+                <p>返回图片格式。</p></td>
         </tr>
 	
 	
@@ -861,7 +871,7 @@
                         
                     
                 
-                <p>图层背景是否可以透明</p></td>
+                <p>图片背景是否透明。</p></td>
         </tr>
 	
 	
@@ -897,7 +907,7 @@
                         
                     
                 
-                <p>动态投影坐标系字符串</p></td>
+                <p>动态投影坐标系字符串。</p></td>
         </tr>
 	
 	
@@ -948,6 +958,27 @@
     
     
     
+        <h5>Example</h5>
+        
+
+    
+    <pre class="prettyprint"><code>// ES5引入方式
+const { MapGISMapServerSingleImageryProvider } = zondy.cesium
+
+// ES6引入方式
+import { MapGISMapServerSingleImageryProvider } from '@mapgis/webclient-cesium-plugin'
+
+const imageryProvider = new MapGISMapServerSingleImageryProvider({
+  viewer,
+  url: 'http://localhost:8089/igs/rest/services/Map/湖北省4326/MapServer',
+  layers: '',
+  imageFormat: 'png',
+  imageTransparent: true
+})
+viewer.imageryLayers.addImageryProvider(imageryProvider)</code></pre>
+    
+
+    
 </dd>
 
     
@@ -976,12 +1007,12 @@
     <div class="nameContainer">
         <h4 class="name" id="fromUrl">
             
-            fromUrl<span class="signature">(url, options)</span><span class="glyphicon glyphicon-circle-arrow-right"></span><span class="type-signature returnType">{zondy.cesium.MapGISMapServerSingleImageryProvider}</span>
+            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;<a href="MapGISMapServerSingleImageryProvider.html">MapGISMapServerSingleImageryProvider</a>>}</span>
         </h4>
     
         
         <div class="tag-source">
-            engineExtensions/scene/imageryProvider/MapGISMapServerSingleImageryProvider.js, line 141
+            engineExtensions/scene/imageryProvider/MapGISMapServerSingleImageryProvider.js, line 151
         </div>
         
     </div>
@@ -991,6 +1022,12 @@
 <dd>
     
     
+    <div class="description">
+        <p>根据服务地址解析图层元信息并返回新的 provider 实例。</p>
+<p>该方法会先加载服务元信息，再将解析出的默认配置与调用方传入的 <code>options</code>
+合并，最终返回一个新的 <code>MapGISMapServerSingleImageryProvider</code>。</p>
+    </div>
+    
 
     
     
@@ -1009,6 +1046,8 @@
 		<th>Type</th>
 		
 		
+		<th>Default</th>
+		
 		
 		<th class="last">Description</th>
 	</tr>
@@ -1035,10 +1074,19 @@
             </td>
             
             
+                <td class="default">
+                
+                </td>
+            
             
             <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>服务基地址。</p></td>
         </tr>
 	
 	
@@ -1058,10 +1106,23 @@
             </td>
             
             
+                <td class="default">
+                
+                    {}
+                
+                </td>
+            
             
             <td class="description last">
                 
-                <p>实例化对象时提供的额外配置参数，若该对象中包含构造参数则会覆盖对应的构造参数</p></td>
+                    
+                        <span class="optional"> 可选</span>
+                    
+                    
+                        
+                    
+                
+                <p>附加配置。若与服务元信息存在同名项，优先使用传入值。</p></td>
         </tr>
 	
 	
@@ -1122,11 +1183,11 @@
             
             <td class="type">
             
-                        zondy.cesium.MapGISMapServerSingleImageryProvider
+                        <a href="Promise.html">Promise</a>.&lt;<a href="MapGISMapServerSingleImageryProvider.html">MapGISMapServerSingleImageryProvider</a>>
                         
                     
             </td>
-            <td class="description last">初始化完毕的MapGISMapServerSingleImageryProvider对象</td>
+            <td class="description last">已初始化的 provider 实例。</td>
         </tr>
     
     </tbody>
@@ -1137,11 +1198,18 @@
     
         <h5>Example</h5>
         
-        <p class="code-caption"><h7 id='fromUrl'>通过ArcGIS地图服务的url获取MapGISMapServerSingleImageryProvider对象</h7></p>
-    
 
     
-    <pre class="prettyprint"><code>// ES5引入方式
  const imageryProvider = await MapGISMapServerSingleImageryProvider.fromUrl(url)
  viewer.imageryLayers.addImageryProvider(imageryProvider)
+    <pre class="prettyprint"><code>// ES5引入方式
+const { MapGISMapServerSingleImageryProvider } = zondy.cesium
+
+// ES6引入方式
+import { MapGISMapServerSingleImageryProvider } from '@mapgis/webclient-cesium-plugin'
+
+const provider = await new MapGISMapServerSingleImageryProvider({ viewer }).fromUrl(
+  'http://localhost:8089/igs/rest/services/Map/湖北省4326/MapServer'
+)
+viewer.imageryLayers.addImageryProvider(provider)</code></pre>
     
 
     
@@ -1161,7 +1229,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>