@mapgis/webclient-cesium-plugin 17.8.1 → 17.10.10

package/{documention → documentation}/MapGISImageServerSingleImageryProvider.html

@@ -88,7 +88,7 @@
     
         
         <div class="tag-source">
-            engineExtensions/scene/imageryProvider/MapGISImageServerSingleImageryProvider.js, line 14
+            engineExtensions/scene/imageryProvider/MapGISImageServerSingleImageryProvider.js, line 8
         </div>
         
     </div>
@@ -99,7 +99,9 @@
     
     
     <div class="description">
-        <p>IGS影像服务一张图出图接入类</p>
+        <p>MapGIS 影像服务一张图出图提供器。</p>
+<p>该类用于把 <code>ImageServer</code> 影像服务封装为按视口动态出图的 imagery provider，
+支持波段重排、重采样方式和栅格渲染规则配置，适合多光谱影像和 DEM 派生渲染场景。</p>
     </div>
     
 
@@ -146,7 +148,7 @@
             
             <td class="description last">
                 
-                
+                <p>初始化参数。</p>
                 
 
 <table class="params">
@@ -203,9 +205,9 @@
                         
                     
                 
-                <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/>
-http://{ip}:{port}/igs/rest/services/{文件夹名(可选)}/{serviceName}/ImageServer</p></td>
+                <p>影像服务基地址。
+格式如下：
+<code>http://{ip}:{port}/igs/rest/services/{folder}/{serviceName}/ImageServer</code></p></td>
         </tr>
 	
 	
@@ -239,7 +241,7 @@ http://{ip}:{port}/igs/rest/services/{文件夹名(可选)}/{serviceName}/ImageS
                         
                     
                 
-                <p>波段id列表,例如[2,0,1]</p></td>
+                <p>波段 ID 列表，例如 <code>[2,0,1]</code>。</p></td>
         </tr>
 	
 	
@@ -273,7 +275,7 @@ http://{ip}:{port}/igs/rest/services/{文件夹名(可选)}/{serviceName}/ImageS
                         
                     
                 
-                <p>重采样方式，支持NearestNeighbor/BilinearInterpolation，默认数据本身的重采样方式</p></td>
+                <p>重采样方式，支持 <code>NearestNeighbor</code> 和 <code>BilinearInterpolation</code>。</p></td>
         </tr>
 	
 	
@@ -307,7 +309,7 @@ http://{ip}:{port}/igs/rest/services/{文件夹名(可选)}/{serviceName}/ImageS
                         
                     
                 
-                <p>渲染规则，NDVI应用于多光谱影像数据，HILLSHADE应用于DEM高程数据。例如renderingRule={type:HILLSHADE,altitude:75,azimuth:120,zFactor:1.0}或renderingRule={type:NDVI,redIndex:0,nirIndex:2}</p></td>
+                <p>栅格渲染规则，例如 NDVI 或 HILLSHADE。</p></td>
         </tr>
 	
 	
@@ -346,7 +348,7 @@ http://{ip}:{port}/igs/rest/services/{文件夹名(可选)}/{serviceName}/ImageS
                         
                     
                 
-                <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>
 	
 	
@@ -382,7 +384,7 @@ http://{ip}:{port}/igs/rest/services/{文件夹名(可选)}/{serviceName}/ImageS
                         
                     
                 
-                <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>
 	
 	
@@ -418,7 +420,7 @@ http://{ip}:{port}/igs/rest/services/{文件夹名(可选)}/{serviceName}/ImageS
                         
                     
                 
-                <p>HTTP请求方式，&quot;GET&quot;、&quot;POST&quot;，默认为GET请求</p></td>
+                <p>HTTP 请求方式。</p></td>
         </tr>
 	
 	
@@ -454,7 +456,7 @@ http://{ip}:{port}/igs/rest/services/{文件夹名(可选)}/{serviceName}/ImageS
                         
                     
                 
-                <p>HTTP请求头，传入方式见下方示例，请严格按照HTTP请求头属性填写，可传入请求方式为POST时的编码方式，默认方式为&quot;text/plain&quot;，请注意IGS.NET版本服务目前只支持&quot;text/plain&quot;的编码方式</p></td>
+                <p>HTTP 请求头，可显式传入 <code>POST</code> 编码方式。</p></td>
         </tr>
 	
 	
@@ -490,7 +492,7 @@ http://{ip}:{port}/igs/rest/services/{文件夹名(可选)}/{serviceName}/ImageS
                         
                     
                 
-                <p>图像格式</p></td>
+                <p>输出图像格式。</p></td>
         </tr>
 	
 	
@@ -526,7 +528,7 @@ http://{ip}:{port}/igs/rest/services/{文件夹名(可选)}/{serviceName}/ImageS
                         
                     
                 
-                <p>请求图像宽度</p></td>
+                <p>请求图像宽度。</p></td>
         </tr>
 	
 	
@@ -562,7 +564,7 @@ http://{ip}:{port}/igs/rest/services/{文件夹名(可选)}/{serviceName}/ImageS
                         
                     
                 
-                <p>请求图像高度</p></td>
+                <p>请求图像高度。</p></td>
         </tr>
 	
 	
@@ -598,7 +600,7 @@ http://{ip}:{port}/igs/rest/services/{文件夹名(可选)}/{serviceName}/ImageS
                         
                     
                 
-                <p>图层最小请求瓦片级别，小于该级别不再请求瓦片</p></td>
+                <p>最小请求级别。</p></td>
         </tr>
 	
 	
@@ -632,7 +634,7 @@ http://{ip}:{port}/igs/rest/services/{文件夹名(可选)}/{serviceName}/ImageS
                         
                     
                 
-                <p>图层最大请求瓦片级别，大于该级别不再请求瓦片</p></td>
+                <p>最大请求级别。</p></td>
         </tr>
 	
 	
@@ -668,7 +670,7 @@ http://{ip}:{port}/igs/rest/services/{文件夹名(可选)}/{serviceName}/ImageS
                         
                     
                 
-                <p>自定义扩展参数，将参数里面的对象解析出来拼装在出图地址后面</p></td>
+                <p>追加到服务请求中的自定义扩展参数。</p></td>
         </tr>
 	
 	
@@ -704,7 +706,7 @@ http://{ip}:{port}/igs/rest/services/{文件夹名(可选)}/{serviceName}/ImageS
                         
                     
                 
-                <p>转发代理</p></td>
+                <p>转发代理。</p></td>
         </tr>
 	
 	
@@ -740,7 +742,7 @@ http://{ip}:{port}/igs/rest/services/{文件夹名(可选)}/{serviceName}/ImageS
                         
                     
                 
-                <p>重载build2DImageResource方法，来重载瓦片的请求逻辑</p></td>
+                <p>自定义图片请求资源构造函数。</p></td>
         </tr>
 	
 	
@@ -776,7 +778,7 @@ http://{ip}:{port}/igs/rest/services/{文件夹名(可选)}/{serviceName}/ImageS
                         
                     
                 
-                <p>“视图的显示级别，超出瓦片数据自身支持的级别”时，是否对瓦片进行拉伸显示。此值未定义或者设置为true时，超出范围后，会采用最接近一级的瓦片进行拉伸或缩放显示。反之，超出范围后，瓦片不再显示</p></td>
+                <p>超出原始级别时是否拉伸最近一级图片继续显示。</p></td>
         </tr>
 	
 	
@@ -827,6 +829,25 @@ http://{ip}:{port}/igs/rest/services/{文件夹名(可选)}/{serviceName}/ImageS
     
     
     
+        <h5>Example</h5>
+        
+
+    
+    <pre class="prettyprint"><code>// ES5引入方式
+const { MapGISImageServerSingleImageryProvider } = zondy.cesium
+
+// ES6引入方式
+import { MapGISImageServerSingleImageryProvider } from '@mapgis/webclient-cesium-plugin'
+
+const imageryProvider = new MapGISImageServerSingleImageryProvider({
+  url: 'http://localhost:8089/igs/rest/services/example/ImageServer',
+  bandIds: [2, 0, 1],
+  imageFormat: 'PNG'
+})
+viewer.imageryLayers.addImageryProvider(imageryProvider)</code></pre>
+    
+
+    
 </dd>
 
     
@@ -857,7 +878,7 @@ http://{ip}:{port}/igs/rest/services/{文件夹名(可选)}/{serviceName}/ImageS
 <dd>
     
     <div class="description">
-        <p>gdbps地址数组</p>
+        <p>当前影像请求使用的波段 ID 列表。</p>
     </div>
     
     
@@ -947,7 +968,7 @@ http://{ip}:{port}/igs/rest/services/{文件夹名(可选)}/{serviceName}/ImageS
 <dd>
     
     <div class="description">
-        <p>获取当前图层是否创建完成</p>
+        <p>当前图层是否已完成初始化。</p>
     </div>
     
     
@@ -992,7 +1013,7 @@ http://{ip}:{port}/igs/rest/services/{文件夹名(可选)}/{serviceName}/ImageS
 <dd>
     
     <div class="description">
-        <p>渲染规则，NDVI应用于多光谱影像数据，HILLSHADE应用于DEM高程数据</p>
+        <p>当前影像渲染规则。</p>
     </div>
     
     
@@ -1127,14 +1148,14 @@ http://{ip}:{port}/igs/rest/services/{文件夹名(可选)}/{serviceName}/ImageS
             
 <dt>
     <div class="nameContainer">
-        <h4 class="name" id=".fromUrl">
+        <h4 class="name" id="requestImage">
             
-            MapGISImageServerSingleImageryProvider.fromUrl<span class="signature">(url, options)</span><span class="glyphicon glyphicon-circle-arrow-right"></span><span class="type-signature returnType">{Cesium.MapGISImageServerSingleImageryProvider}</span>
+            requestImage<span class="signature">(x, y, level, request)</span><span class="glyphicon glyphicon-circle-arrow-right"></span><span class="type-signature returnType">{<a href="Promise.html">Promise</a>.&lt;(HTMLImageElement|HTMLCanvasElement)>|undefined}</span>
         </h4>
     
         
         <div class="tag-source">
-            engineExtensions/scene/imageryProvider/MapGISImageServerSingleImageryProvider.js, line 90
+            engineExtensions/scene/imageryProvider/MapGISImageServerSingleImageryProvider.js, line 188
         </div>
         
     </div>
@@ -1145,7 +1166,7 @@ http://{ip}:{port}/igs/rest/services/{文件夹名(可选)}/{serviceName}/ImageS
     
     
     <div class="description">
-        <p>通过MapGIS地图服务的url获取MapGISImageServerSingleImageryProvider对象<a id='fromUrl'/></p>
+        <p>请求指定瓦片的影像结果。</p>
     </div>
     
 
@@ -1176,16 +1197,36 @@ http://{ip}:{port}/igs/rest/services/{文件夹名(可选)}/{serviceName}/ImageS
 	
         <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>
 
 
             
@@ -1195,14 +1236,37 @@ http://{ip}:{port}/igs/rest/services/{文件夹名(可选)}/{serviceName}/ImageS
             
             <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">
@@ -1218,7 +1282,7 @@ http://{ip}:{port}/igs/rest/services/{文件夹名(可选)}/{serviceName}/ImageS
             
             <td class="description last">
                 
-                <p>实例化对象时提供的额外配置参数，若该对象中包含构造参数则会覆盖对应的构造参数</p></td>
+                <p>Cesium 请求对象。</p></td>
         </tr>
 	
 	
@@ -1279,11 +1343,14 @@ http://{ip}:{port}/igs/rest/services/{文件夹名(可选)}/{serviceName}/ImageS
             
             <td class="type">
             
-                        Cesium.MapGISImageServerSingleImageryProvider
+                        <a href="Promise.html">Promise</a>.&lt;(HTMLImageElement|HTMLCanvasElement)>
+                         | 
+                    
+                        undefined
                         
                     
             </td>
-            <td class="description last">初始化完毕的MapGISImageServerSingleImageryProvider对象</td>
+            <td class="description last">Cesium 可消费的图片结果。</td>
         </tr>
     
     </tbody>
@@ -1298,14 +1365,14 @@ http://{ip}:{port}/igs/rest/services/{文件夹名(可选)}/{serviceName}/ImageS
             
 <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>
+            MapGISImageServerSingleImageryProvider.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="MapGISImageServerSingleImageryProvider.html">MapGISImageServerSingleImageryProvider</a>>}</span>
         </h4>
     
         
         <div class="tag-source">
-            engineExtensions/scene/imageryProvider/MapGISImageServerSingleImageryProvider.js, line 190
+            engineExtensions/scene/imageryProvider/MapGISImageServerSingleImageryProvider.js, line 98
         </div>
         
     </div>
@@ -1316,7 +1383,7 @@ http://{ip}:{port}/igs/rest/services/{文件夹名(可选)}/{serviceName}/ImageS
     
     
     <div class="description">
-        <p>请求给定贴图的图像<a id='requestImage'/></p>
+        <p>根据服务地址解析影像服务元信息并返回新的 provider 实例。</p>
     </div>
     
 
@@ -1337,6 +1404,8 @@ http://{ip}:{port}/igs/rest/services/{文件夹名(可选)}/{serviceName}/ImageS
 		<th>Type</th>
 		
 		
+		<th>Default</th>
+		
 		
 		<th class="last">Description</th>
 	</tr>
@@ -1347,92 +1416,71 @@ http://{ip}:{port}/igs/rest/services/{文件夹名(可选)}/{serviceName}/ImageS
 	
         <tr>
             
-                <td class="name"><code>x</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>
+|
+
+<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">
-            
+                <td class="default">
                 
-<span class="param-type">Number</span>
-
-
-            
-            </td>
-            
+                </td>
             
             
             <td class="description last">
                 
-                <p>瓦片的Y坐标</p></td>
+                    
+                    
+                        
+                    
+                
+                <p>影像服务基地址。</p></td>
         </tr>
 	
 	
 	
         <tr>
             
-                <td class="name"><code>level</code></td>
+                <td class="name"><code>options</code></td>
             
             
             <td class="type">
             
                 
-<span class="param-type">Number</span>
+<span class="param-type">Object</span>
 
 
             
             </td>
             
             
-            
-            <td class="description last">
+                <td class="default">
                 
-                <p>瓦片的详细级别</p></td>
-        </tr>
-	
-	
-	
-        <tr>
-            
-                <td class="name"><code>request</code></td>
-            
-            
-            <td class="type">
-            
+                    {}
                 
-<span class="param-type">Object</span>
-
-
-            
-            </td>
-            
+                </td>
             
             
             <td class="description last">
                 
-                <p>请求对象</p></td>
+                    
+                        <span class="optional"> 可选</span>
+                    
+                    
+                        
+                    
+                
+                <p>附加配置。若与服务元信息存在同名项，优先使用传入值。</p></td>
         </tr>
 	
 	
@@ -1493,11 +1541,11 @@ http://{ip}:{port}/igs/rest/services/{文件夹名(可选)}/{serviceName}/ImageS
             
             <td class="type">
             
-                        Object
+                        <a href="Promise.html">Promise</a>.&lt;<a href="MapGISImageServerSingleImageryProvider.html">MapGISImageServerSingleImageryProvider</a>>
                         
                     
             </td>
-            <td class="description last">瓦片的Resource对象</td>
+            <td class="description last">已初始化的 provider 实例。</td>
         </tr>
     
     </tbody>
@@ -1522,7 +1570,7 @@ http://{ip}:{port}/igs/rest/services/{文件夹名(可选)}/{serviceName}/ImageS
 
 
         <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>