@mapgis/webclient-cesium-plugin 17.8.1 → 17.10.9

package/{documention → documentation}/MapGISTileAvailability.html

@@ -83,7 +83,7 @@
     <div class="nameContainer">
         <h4 class="name" id="MapGISTileAvailability">
             
-            new MapGISTileAvailability<span class="signature">(layers)</span>
+            new MapGISTileAvailability<span class="signature">(<span class="optional">layers</span>)</span>
         </h4>
     
         
@@ -99,7 +99,9 @@
     
     
     <div class="description">
-        <p>MapGIS的TileAvailability类，重写了Cesium.TileAvailability的所有方法，支持在内部自动筛选要使用的地形图层</p>
+        <p>MapGIS 地形瓦片可用性管理器。</p>
+<p>该类用于聚合多个地形图层的 <code>availability</code> 信息，并在查询瓦片可用性时自动选择当前
+坐标范围内应使用的地形子图层。适用于多 DEM 服务混合加载场景。</p>
     </div>
     
 
@@ -120,6 +122,8 @@
 		<th>Type</th>
 		
 		
+		<th>Default</th>
+		
 		
 		<th class="last">Description</th>
 	</tr>
@@ -143,10 +147,23 @@
             </td>
             
             
+                <td class="default">
+                
+                    []
+                
+                </td>
+            
             
             <td class="description last">
                 
-                <p>地形图层数组</p></td>
+                    
+                        <span class="optional"> 可选</span>
+                    
+                    
+                        
+                    
+                
+                <p>地形图层数组。每个图层对象需提供 <code>availability</code> 与范围判断所需信息。</p></td>
         </tr>
 	
 	
@@ -191,6 +208,21 @@
     
     
     
+        <h5>Example</h5>
+        
+
+    
+    <pre class="prettyprint"><code>// ES5引入方式
+const { MapGISTileAvailability } = zondy.cesium
+
+// ES6引入方式
+import { MapGISTileAvailability } from '@mapgis/webclient-cesium-plugin'
+
+const availability = new MapGISTileAvailability(layers)
+const visible = availability.isTileAvailable(level, x, y)</code></pre>
+    
+
+    
 </dd>
 
     
@@ -219,12 +251,12 @@
     <div class="nameContainer">
         <h4 class="name" id="addAvailableTileRange">
             
-            addAvailableTileRange<span class="signature">(level, startX, startY, endX, endY)</span>
+            addAvailableTileRange<span class="signature">(level, startX, startY, endX, endY)</span><span class="glyphicon glyphicon-circle-arrow-right"></span><span class="type-signature returnType">{void}</span>
         </h4>
     
         
         <div class="tag-source">
-            engineExtensions/core/MapGISTileAvailability.js, line 27
+            engineExtensions/core/MapGISTileAvailability.js, line 41
         </div>
         
     </div>
@@ -235,8 +267,9 @@
     
     
     <div class="description">
-        <p>Marks a rectangular range of tiles in a particular level as being available.  For best performance,
-add your ranges in order of increasing level.</p>
+        <p>向目标地形子图层登记指定级别的可用瓦片范围。</p>
+<p>该方法会先依据级别与范围中心点选择一个应答地形图层，再把当前范围转发到该图层
+自身的 <code>availability</code> 对象中。</p>
     </div>
     
 
@@ -283,7 +316,7 @@ add your ranges in order of increasing level.</p>
             
             <td class="description last">
                 
-                <p>The level.</p></td>
+                <p>瓦片级别。</p></td>
         </tr>
 	
 	
@@ -306,7 +339,7 @@ add your ranges in order of increasing level.</p>
             
             <td class="description last">
                 
-                <p>The X coordinate of the first available tiles at the level.</p></td>
+                <p>范围起始瓦片的 X 坐标。</p></td>
         </tr>
 	
 	
@@ -329,7 +362,7 @@ add your ranges in order of increasing level.</p>
             
             <td class="description last">
                 
-                <p>The Y coordinate of the first available tiles at the level.</p></td>
+                <p>范围起始瓦片的 Y 坐标。</p></td>
         </tr>
 	
 	
@@ -352,7 +385,7 @@ add your ranges in order of increasing level.</p>
             
             <td class="description last">
                 
-                <p>The X coordinate of the last available tiles at the level.</p></td>
+                <p>范围结束瓦片的 X 坐标。</p></td>
         </tr>
 	
 	
@@ -375,7 +408,7 @@ add your ranges in order of increasing level.</p>
             
             <td class="description last">
                 
-                <p>The Y coordinate of the last available tiles at the level.</p></td>
+                <p>范围结束瓦片的 Y 坐标。</p></td>
         </tr>
 	
 	
@@ -418,6 +451,35 @@ add your ranges in order of increasing level.</p>
     
     
     
+    <h5>Returns:</h5>
+    
+
+
+<table class="params">
+    <thead>
+    <tr>
+        
+        <th>Type</th>
+        <th class="last">Description</th>
+    </tr>
+    </thead>
+    <tbody>
+    
+        <tr>
+            
+            <td class="type">
+            
+                        void
+                        
+                    
+            </td>
+            <td class="description last"></td>
+        </tr>
+    
+    </tbody>
+</table>
+
+    
     
     
 </dd>
@@ -433,7 +495,7 @@ add your ranges in order of increasing level.</p>
     
         
         <div class="tag-source">
-            engineExtensions/core/MapGISTileAvailability.js, line 77
+            engineExtensions/core/MapGISTileAvailability.js, line 81
         </div>
         
     </div>
@@ -444,10 +506,9 @@ add your ranges in order of increasing level.</p>
     
     
     <div class="description">
-        <p>Finds the most detailed level that is available <em>everywhere</em> within a given rectangle.  More detailed
-tiles may be available in parts of the rectangle, but not the whole thing.  The return value of this
-function may be safely passed to Cesium.sampleTerrain for any position within the rectangle.  This function
-usually completes in time logarithmic to the number of rectangles added with zondy.cesium.MapGISTileAvailability.addAvailableTileRange()</p>
+        <p>计算指定范围整体都可用的最高瓦片级别。</p>
+<p>与“局部区域有更高精度瓦片”不同，该方法返回的是整个矩形范围内都能稳定使用的最高级别。
+适用于在执行范围级高程采样、裁剪分析或预取地形数据前确定统一的安全级别。</p>
     </div>
     
 
@@ -494,7 +555,7 @@ usually completes in time logarithmic to the number of rectangles added with zon
             
             <td class="description last">
                 
-                <p>The rectangle.</p></td>
+                <p>待查询的范围。</p></td>
         </tr>
 	
 	
@@ -559,7 +620,7 @@ usually completes in time logarithmic to the number of rectangles added with zon
                         
                     
             </td>
-            <td class="description last">The best available level for the entire rectangle.</td>
+            <td class="description last">当前矩形范围整体可用的最高级别；若没有可用结果，则返回 <code>0</code>。</td>
         </tr>
     
     </tbody>
@@ -581,7 +642,7 @@ usually completes in time logarithmic to the number of rectangles added with zon
     
         
         <div class="tag-source">
-            engineExtensions/core/MapGISTileAvailability.js, line 126
+            engineExtensions/core/MapGISTileAvailability.js, line 125
         </div>
         
     </div>
@@ -592,16 +653,9 @@ usually completes in time logarithmic to the number of rectangles added with zon
     
     
     <div class="description">
-        <p>Computes a bit mask indicating which of a tile's four children exist.
-If a child's bit is set, a tile is available for that child.  If it is cleared,
-the tile is not available.  The bit values are as follows:</p>
-<table>
-    <tr><th>Bit Position</th><th>Bit Value</th><th>Child Tile</th></tr>
-    <tr><td>0</td><td>1</td><td>Southwest</td></tr>
-    <tr><td>1</td><td>2</td><td>Southeast</td></tr>
-    <tr><td>2</td><td>4</td><td>Northwest</td></tr>
-    <tr><td>3</td><td>8</td><td>Northeast</td></tr>
-</table>
+        <p>计算父瓦片四个子瓦片的可用性掩码。</p>
+<p>返回值遵循 Cesium 的子瓦片位标记约定：<code>1</code> 表示西南，<code>2</code> 表示东南，<code>4</code> 表示西北，
+<code>8</code> 表示东北。可用于判断后续是否继续细分某个父瓦片。</p>
     </div>
     
 
@@ -648,7 +702,7 @@ the tile is not available.  The bit values are as follows:</p>
             
             <td class="description last">
                 
-                <p>The level of the parent tile.</p></td>
+                <p>父瓦片级别。</p></td>
         </tr>
 	
 	
@@ -671,7 +725,7 @@ the tile is not available.  The bit values are as follows:</p>
             
             <td class="description last">
                 
-                <p>The X coordinate of the parent tile.</p></td>
+                <p>父瓦片的 X 坐标。</p></td>
         </tr>
 	
 	
@@ -694,7 +748,7 @@ the tile is not available.  The bit values are as follows:</p>
             
             <td class="description last">
                 
-                <p>The Y coordinate of the parent tile.</p></td>
+                <p>父瓦片的 Y 坐标。</p></td>
         </tr>
 	
 	
@@ -759,7 +813,7 @@ the tile is not available.  The bit values are as follows:</p>
                         
                     
             </td>
-            <td class="description last">The bit mask indicating child availability.</td>
+            <td class="description last">子瓦片可用性掩码；若未命中任何地形图层，则返回 <code>0</code>。</td>
         </tr>
     
     </tbody>
@@ -781,7 +835,7 @@ the tile is not available.  The bit values are as follows:</p>
     
         
         <div class="tag-source">
-            engineExtensions/core/MapGISTileAvailability.js, line 55
+            engineExtensions/core/MapGISTileAvailability.js, line 60
         </div>
         
     </div>
@@ -792,8 +846,9 @@ the tile is not available.  The bit values are as follows:</p>
     
     
     <div class="description">
-        <p>Determines the level of the most detailed tile covering the position.  This function
-usually completes in time logarithmic to the number of rectangles added with zondy.cesium.MapGISTileAvailability.addAvailableTileRange()</p>
+        <p>计算指定位置可命中的最高可用瓦片级别。</p>
+<p>该方法会依次查询当前聚合的地形图层，并返回第一个大于 <code>0</code> 的可用级别。
+适用于在采样高程或决定请求精度前，先判断当前位置可以使用到的地形细节层级。</p>
     </div>
     
 
@@ -840,7 +895,7 @@ usually completes in time logarithmic to the number of rectangles added with zon
             
             <td class="description last">
                 
-                <p>The position for which to determine the maximum available level.  The height component is ignored.</p></td>
+                <p>待查询的位置。仅使用经纬度，忽略高度值。</p></td>
         </tr>
 	
 	
@@ -888,7 +943,7 @@ usually completes in time logarithmic to the number of rectangles added with zon
 <dl>
     <dt>
         <div class="param-desc">
-        <p>If position is outside any tile according to the tiling scheme.</p>
+        <p>当位置超出当前平铺方案支持范围时，底层 Cesium 可能抛出异常。</p>
         </div>
     </dt>
     <dt>
@@ -932,7 +987,7 @@ usually completes in time logarithmic to the number of rectangles added with zon
                         
                     
             </td>
-            <td class="description last">The level of the most detailed tile covering the position.</td>
+            <td class="description last">当前位置可用的最高级别；若所有图层都未命中，则返回 <code>0</code>。</td>
         </tr>
     
     </tbody>
@@ -954,7 +1009,7 @@ usually completes in time logarithmic to the number of rectangles added with zon
     
         
         <div class="tag-source">
-            engineExtensions/core/MapGISTileAvailability.js, line 99
+            engineExtensions/core/MapGISTileAvailability.js, line 104
         </div>
         
     </div>
@@ -965,7 +1020,9 @@ usually completes in time logarithmic to the number of rectangles added with zon
     
     
     <div class="description">
-        <p>Determines if a particular tile is available.</p>
+        <p>判断指定行列号的瓦片是否可用。</p>
+<p>该方法会先根据级别和瓦片坐标选出当前应使用的地形子图层，再委托对应图层的
+<code>availability</code> 对象完成最终判断。适用于在发起地形请求前做快速可用性检查。</p>
     </div>
     
 
@@ -1012,7 +1069,7 @@ usually completes in time logarithmic to the number of rectangles added with zon
             
             <td class="description last">
                 
-                <p>The tile level to check.</p></td>
+                <p>待检查的瓦片级别。</p></td>
         </tr>
 	
 	
@@ -1035,7 +1092,7 @@ usually completes in time logarithmic to the number of rectangles added with zon
             
             <td class="description last">
                 
-                <p>The X coordinate of the tile to check.</p></td>
+                <p>待检查瓦片的 X 坐标。</p></td>
         </tr>
 	
 	
@@ -1058,7 +1115,7 @@ usually completes in time logarithmic to the number of rectangles added with zon
             
             <td class="description last">
                 
-                <p>The Y coordinate of the tile to check.</p></td>
+                <p>待检查瓦片的 Y 坐标。</p></td>
         </tr>
 	
 	
@@ -1123,7 +1180,7 @@ usually completes in time logarithmic to the number of rectangles added with zon
                         
                     
             </td>
-            <td class="description last">True if the tile is available; otherwise, false.</td>
+            <td class="description last"><code>true</code> 表示当前瓦片在至少一个可见地形图层中可用；否则返回 <code>false</code>。</td>
         </tr>
     
     </tbody>
@@ -1148,7 +1205,7 @@ usually completes in time logarithmic to the number of rectangles added with zon
 
 
         <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 Sat Sep 12 2026 11:55:59 GMT+0800 (中国标准时间)
         </footer>
     </div>
 </div>