@mapgis/webclient-cesium-plugin 17.2.2 → 17.2.4

package/documention/Promise.html

@@ -0,0 +1,980 @@
+<header id="page-title" class="page-title">
+    
+        <span class="page-title-main">类名</span>
+        <span class="page-title-sub">Promise</span>
+    
+</header>
+
+
+
+
+
+<section>
+
+<article>
+    <div class="container-overview">
+    
+        
+            <div class='vertical-section'>
+                <div class="members">
+                    <div class="member">
+                        
+
+
+    
+    <h4 class="name" id="Promise">
+        <a class="href-link" href="#Promise">#</a>
+        
+        <span class="code-name" id="Promise" style="font-size:30px">
+            
+                new Promise<span class="signature">()</span>
+            
+        </span>
+    </h4>
+    
+
+    
+    <div class="description">
+        <p>Trusted Promise constructor.  A Promise created from this constructor is
+a trusted when.js promise.  Any other duck-typed promise is considered
+untrusted.</p>
+    </div>
+    
+
+
+
+
+
+
+
+
+
+
+
+
+
+<dl class="details">
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+    
+
+    
+
+    
+
+    
+</dl>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+                    </div>
+                </div>
+            </div>
+        
+    
+    </div>
+    
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+        <div class='vertical-section'>
+            <h3 id='function'>方法</h3>
+            <h4 style="margin-top: 20px;margin-bottom: 20px;">方法概述</h4>
+            <div class="members">
+            <div class="table-container">
+                <table class="params table">
+                    <thead>
+                    <tr>
+                        <th>名称</th>
+                        <th>返回值类型</th>
+                        <th>描述</th>
+                    </tr>
+                    </thead>
+                    <tbody>
+                        
+                            <tr class="deep-level-0">
+                                <td class="name"><code><a href="#always">always</a></code></td>
+                                <td class="name">
+                                    <code>
+                                        
+                                                
+<span class="param-type">
+    
+             <a link="Promise.html" onclick="getTypeHTML(event)" class="mapgis-link-name" title="Promise" Promise.html>Promise</a>
+    
+</span>
+
+
+
+                                            
+                                    </code>
+                                </td>
+                                <td class="name"><code><p>Register a callback that will be called when a promise is
+fulfilled or rejected.  Optionally also register a progress handler.
+Shortcut for .then(onFulfilledOrRejected, onFulfilledOrRejected, onProgress)</p></code></td>
+                            </tr>
+                        
+                            <tr class="deep-level-0">
+                                <td class="name"><code><a href="#otherwise">otherwise</a></code></td>
+                                <td class="name">
+                                    <code>
+                                        
+                                                
+<span class="param-type">
+    
+             <a link="Promise.html" onclick="getTypeHTML(event)" class="mapgis-link-name" title="Promise" Promise.html>Promise</a>
+    
+</span>
+
+
+
+                                            
+                                    </code>
+                                </td>
+                                <td class="name"><code><p>Register a rejection handler.  Shortcut for .then(undefined, onRejected)</p></code></td>
+                            </tr>
+                        
+                            <tr class="deep-level-0">
+                                <td class="name"><code><a href="#spread">spread</a></code></td>
+                                <td class="name">
+                                    <code>
+                                        
+                                                
+<span class="param-type">
+    
+             <a link="Promise.html" onclick="getTypeHTML(event)" class="mapgis-link-name" title="Promise" Promise.html>Promise</a>
+    
+</span>
+
+
+
+                                            
+                                    </code>
+                                </td>
+                                <td class="name"><code><p>Assumes that this promise will fulfill with an array, and arranges
+for the onFulfilled to be called with the array as its argument list
+i.e. onFulfilled.spread(undefined, array).</p></code></td>
+                            </tr>
+                        
+                            <tr class="deep-level-0">
+                                <td class="name"><code><a href="#yield">yield</a></code></td>
+                                <td class="name">
+                                    <code>
+                                        
+                                                
+<span class="param-type">
+    
+             <a link="Promise.html" onclick="getTypeHTML(event)" class="mapgis-link-name" title="Promise" Promise.html>Promise</a>
+    
+</span>
+
+
+
+                                            
+                                    </code>
+                                </td>
+                                <td class="name"><code><p>Shortcut for .then(function() { return value; })</p></code></td>
+                            </tr>
+                        
+                    </tbody>
+                </table>
+            </div>
+            <h4 style="margin-top: 20px;margin-bottom: 20px;">方法详情</h4>
+            
+                <div class="member">
+
+
+    
+    <h4 class="name" id="always">
+        <a class="href-link" href="#always">#</a>
+        
+        <span class="code-name" id="always" style="font-size:30px">
+            
+                always<span class="signature">(onFulfilledOrRejected<span class="signature-attributes">opt, nullable</span>, onProgress<span class="signature-attributes">opt, nullable</span>)</span>
+            
+        </span>
+    </h4>
+    
+
+    
+    <div class="description">
+        <p>Register a callback that will be called when a promise is
+fulfilled or rejected.  Optionally also register a progress handler.
+Shortcut for .then(onFulfilledOrRejected, onFulfilledOrRejected, onProgress)</p>
+    </div>
+    
+
+
+
+
+
+
+
+
+
+    <h4>参数</h4>
+    
+<div class="table-container">
+    <table class="params table">
+        <thead>
+        <tr>
+            
+            <th>名称</th>
+            
+
+            <th>类型</th>
+
+            
+
+            <th class="last">描述</th>
+        </tr>
+        </thead>
+
+        <tbody>
+        
+
+            
+<tr class="deep-level-0">
+  
+      <td class="name"><code>onFulfilledOrRejected</code></td>
+  
+
+  <td class="type">
+  
+      
+<span class="param-type">
+    
+             function
+    
+</span>
+
+
+
+  
+  </td>
+
+  
+
+  <td class="description last"></td>
+</tr>
+
+
+
+        
+
+            
+<tr class="deep-level-0">
+  
+      <td class="name"><code>onProgress</code></td>
+  
+
+  <td class="type">
+  
+      
+<span class="param-type">
+    
+             function
+    
+</span>
+
+
+
+  
+  </td>
+
+  
+
+  <td class="description last"></td>
+</tr>
+
+
+
+        
+        </tbody>
+    </table>
+</div>
+
+
+
+
+
+
+<dl class="details">
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+    
+
+    
+
+    
+
+    
+</dl>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+    <div class='columns method-parameter'>
+        <div class="column is-2"><label>返回值</label></div>
+        <div class="column is-10">
+            
+                    
+
+<div class="columns">
+    
+    
+    <div class='column is-5 has-text-left'>
+        <label>类型: </label>
+        
+<span class="param-type">
+    
+             <a link="Promise.html" onclick="getTypeHTML(event)" class="mapgis-link-name" title="Promise" Promise.html>Promise</a>
+    
+</span>
+
+
+
+    </div>
+    
+</div>
+
+                
+        </div>
+    </div>
+
+
+
+
+
+
+</div>
+            
+                <div class="member">
+
+
+    
+    <h4 class="name" id="otherwise">
+        <a class="href-link" href="#otherwise">#</a>
+        
+        <span class="code-name" id="otherwise" style="font-size:30px">
+            
+                otherwise<span class="signature">(onRejected<span class="signature-attributes">nullable</span>)</span>
+            
+        </span>
+    </h4>
+    
+
+    
+    <div class="description">
+        <p>Register a rejection handler.  Shortcut for .then(undefined, onRejected)</p>
+    </div>
+    
+
+
+
+
+
+
+
+
+
+    <h4>参数</h4>
+    
+<div class="table-container">
+    <table class="params table">
+        <thead>
+        <tr>
+            
+            <th>名称</th>
+            
+
+            <th>类型</th>
+
+            
+
+            <th class="last">描述</th>
+        </tr>
+        </thead>
+
+        <tbody>
+        
+
+            
+<tr class="deep-level-0">
+  
+      <td class="name"><code>onRejected</code></td>
+  
+
+  <td class="type">
+  
+      
+<span class="param-type">
+    
+             function
+    
+</span>
+
+
+
+  
+  </td>
+
+  
+
+  <td class="description last"></td>
+</tr>
+
+
+
+        
+        </tbody>
+    </table>
+</div>
+
+
+
+
+
+
+<dl class="details">
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+    
+
+    
+
+    
+
+    
+</dl>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+    <div class='columns method-parameter'>
+        <div class="column is-2"><label>返回值</label></div>
+        <div class="column is-10">
+            
+                    
+
+<div class="columns">
+    
+    
+    <div class='column is-5 has-text-left'>
+        <label>类型: </label>
+        
+<span class="param-type">
+    
+             <a link="Promise.html" onclick="getTypeHTML(event)" class="mapgis-link-name" title="Promise" Promise.html>Promise</a>
+    
+</span>
+
+
+
+    </div>
+    
+</div>
+
+                
+        </div>
+    </div>
+
+
+
+
+
+
+</div>
+            
+                <div class="member">
+
+
+    
+    <h4 class="name" id="spread">
+        <a class="href-link" href="#spread">#</a>
+        
+        <span class="code-name" id="spread" style="font-size:30px">
+            
+                spread<span class="signature">(onFulfilled)</span>
+            
+        </span>
+    </h4>
+    
+
+    
+    <div class="description">
+        <p>Assumes that this promise will fulfill with an array, and arranges
+for the onFulfilled to be called with the array as its argument list
+i.e. onFulfilled.spread(undefined, array).</p>
+    </div>
+    
+
+
+
+
+
+
+
+
+
+    <h4>参数</h4>
+    
+<div class="table-container">
+    <table class="params table">
+        <thead>
+        <tr>
+            
+            <th>名称</th>
+            
+
+            <th>类型</th>
+
+            
+
+            <th class="last">描述</th>
+        </tr>
+        </thead>
+
+        <tbody>
+        
+
+            
+<tr class="deep-level-0">
+  
+      <td class="name"><code>onFulfilled</code></td>
+  
+
+  <td class="type">
+  
+      
+<span class="param-type">
+    
+             function
+    
+</span>
+
+
+
+  
+  </td>
+
+  
+
+  <td class="description last"><p>function to receive spread arguments</p></td>
+</tr>
+
+
+
+        
+        </tbody>
+    </table>
+</div>
+
+
+
+
+
+
+<dl class="details">
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+    
+
+    
+
+    
+
+    
+</dl>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+    <div class='columns method-parameter'>
+        <div class="column is-2"><label>返回值</label></div>
+        <div class="column is-10">
+            
+                    
+
+<div class="columns">
+    
+    
+    <div class='column is-5 has-text-left'>
+        <label>类型: </label>
+        
+<span class="param-type">
+    
+             <a link="Promise.html" onclick="getTypeHTML(event)" class="mapgis-link-name" title="Promise" Promise.html>Promise</a>
+    
+</span>
+
+
+
+    </div>
+    
+</div>
+
+                
+        </div>
+    </div>
+
+
+
+
+
+
+</div>
+            
+                <div class="member">
+
+
+    
+    <h4 class="name" id="yield">
+        <a class="href-link" href="#yield">#</a>
+        
+        <span class="code-name" id="yield" style="font-size:30px">
+            
+                yield<span class="signature">(value)</span>
+            
+        </span>
+    </h4>
+    
+
+    
+    <div class="description">
+        <p>Shortcut for .then(function() { return value; })</p>
+    </div>
+    
+
+
+
+
+
+
+
+
+
+    <h4>参数</h4>
+    
+<div class="table-container">
+    <table class="params table">
+        <thead>
+        <tr>
+            
+            <th>名称</th>
+            
+
+            <th>类型</th>
+
+            
+
+            <th class="last">描述</th>
+        </tr>
+        </thead>
+
+        <tbody>
+        
+
+            
+<tr class="deep-level-0">
+  
+      <td class="name"><code>value</code></td>
+  
+
+  <td class="type">
+  
+      
+<span class="param-type">
+    
+             *
+    
+</span>
+
+
+
+  
+  </td>
+
+  
+
+  <td class="description last"></td>
+</tr>
+
+
+
+        
+        </tbody>
+    </table>
+</div>
+
+
+
+
+
+
+<dl class="details">
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+    
+
+    
+
+    
+
+    
+</dl>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+    <div class='columns method-parameter'>
+        <div class="column is-2"><label>返回值</label></div>
+        <div class="column is-10">
+            
+                    
+
+<div class="columns">
+    
+    <div class='param-desc column is-7'><p>a promise that:</p>
+<ul>
+<li>is fulfilled if value is not a promise, or</li>
+<li>if value is a promise, will fulfill with its value, or reject
+with its reason.</li>
+</ul></div>
+    
+    
+    <div class='column is-5 has-text-left'>
+        <label>类型: </label>
+        
+<span class="param-type">
+    
+             <a link="Promise.html" onclick="getTypeHTML(event)" class="mapgis-link-name" title="Promise" Promise.html>Promise</a>
+    
+</span>
+
+
+
+    </div>
+    
+</div>
+
+                
+        </div>
+    </div>
+
+
+
+
+
+
+</div>
+            
+            </div>
+        </div>
+    
+
+    
+
+    
+</article>
+
+</section>