UNPKG

@mapgis/webclient-common

Version:

mapgis ES6 format for igserver

1,402 lines (451 loc) 20.2 kB
<header id="page-title" class="page-title"> <span class="page-title-main">类名</span> <span class="page-title-sub">Scene</span> </header> <section> <article> <div class="container-overview"> <div class='vertical-section'> <div class="members"> <div class="member"> <h4 class="name" id="Scene"> <a class="href-link" href="#Scene">#</a> <span class="code-name" id="Scene" style="font-size:30px"> new Scene<span class="signature">(options)</span> </span> </h4> <div class="description"> <p>场景对象</p> </div> <h4>参数</h4> <div class="table-container"> <table class="params table"> <thead> <tr> <th>名称</th> <th>类型</th> <th style="min-width: 100px;">默认值</th> <th class="last">描述</th> </tr> </thead> <tbody> <tr class="deep-level-0"> <td class="name" id="options"><code>options</code></td> <td class="type"> <span class="param-type">Object</span> </td> <td class="default"> </td> <td class="description last"><p>构造参数</p></td> </tr> <tr class="deep-level-1"> <td class="name" id="sceneIndex"><code>sceneIndex</code></td> <td class="type"> <span class="param-type">Number</span> </td> <td class="default"> 0 </td> <td class="description last"><p>该场景在场景文档中的索引</p></td> </tr> <tr class="deep-level-1"> <td class="name" id="sceneName"><code>sceneName</code></td> <td class="type"> <span class="param-type">String</span> </td> <td class="default"> </td> <td class="description last"><p>场景名</p></td> </tr> <tr class="deep-level-1"> <td class="name" id="sceneMode"><code>sceneMode</code></td> <td class="type"> <span class="param-type">String</span> </td> <td class="default"> </td> <td class="description last"><p>场景类型</p></td> </tr> <tr class="deep-level-1"> <td class="name" id="sceneMode"><code>sceneMode</code></td> <td class="type"> <span class="param-type"><a link="Extent.html" onclick="getTypeHTML(event)" class="mapgis-link-name" title="Extent" Extent.html>Extent</a></span> </td> <td class="default"> </td> <td class="description last"><p>场景包围盒</p></td> </tr> <tr class="deep-level-1"> <td class="name" id="sublayers"><code>sublayers</code></td> <td class="type"> <span class="param-type">Array.&lt;<a link="Array.<IGSSceneSubLayer>.html" onclick="getTypeHTML(event)" href="IGSSceneSubLayer.html">IGSSceneSubLayer</a>></span> </td> <td class="default"> </td> <td class="description last"><p>场景中包含的图层列表</p></td> </tr> <tr class="deep-level-1"> <td class="name" id="layer"><code>layer</code></td> <td class="type"> <span class="param-type"><a link="IGSSceneLayer.html" onclick="getTypeHTML(event)" class="mapgis-link-name" title="IGSSceneLayer" IGSSceneLayer.html>IGSSceneLayer</a></span> </td> <td class="default"> </td> <td class="description last"><p>场景所属的场景服务图层</p></td> </tr> <tr class="deep-level-1"> <td class="name" id="extendedProps"><code>extendedProps</code></td> <td class="type"> <span class="param-type">Array</span> </td> <td class="default"> </td> <td class="description last"><p>扩展属性</p></td> </tr> </tbody> </table> </div> <dl class="details"> </dl> </div> </div> </div> </div> <div class='vertical-section'> <h3 id='member'>成员变量</h3> <h4 style="margin-top: 20px;margin-bottom: 20px;">成员变量概述</h4> <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="#extendedProps">extendedProps</a></code></td> <td class="name"> <code> <span class="param-type">Array</span> </code> </td> <td class="name"><code><p>扩展属性</p></code></td> </tr> <tr class="deep-level-0"> <td class="name"><code><a href="#layer">layer</a></code></td> <td class="name"> <code> <span class="param-type"><a link="IGSSceneLayer.html" onclick="getTypeHTML(event)" class="mapgis-link-name" title="IGSSceneLayer" IGSSceneLayer.html>IGSSceneLayer</a></span> </code> </td> <td class="name"><code><p>场景所属的场景服务图层</p></code></td> </tr> <tr class="deep-level-0"> <td class="name"><code><a href="#sceneIndex">sceneIndex</a></code></td> <td class="name"> <code> <span class="param-type">Number</span> </code> </td> <td class="name"><code><p>该场景在场景文档中的索引</p></code></td> </tr> <tr class="deep-level-0"> <td class="name"><code><a href="#sceneMode">sceneMode</a></code></td> <td class="name"> <code> <span class="param-type">String</span> </code> </td> <td class="name"><code><p>场景类型</p></code></td> </tr> <tr class="deep-level-0"> <td class="name"><code><a href="#sceneName">sceneName</a></code></td> <td class="name"> <code> <span class="param-type">String</span> </code> </td> <td class="name"><code><p>场景名</p></code></td> </tr> <tr class="deep-level-0"> <td class="name"><code><a href="#sceneRange">sceneRange</a></code></td> <td class="name"> <code> <span class="param-type"><a link="Extent.html" onclick="getTypeHTML(event)" class="mapgis-link-name" title="Extent" Extent.html>Extent</a></span> </code> </td> <td class="name"><code><p>场景包围盒</p></code></td> </tr> <tr class="deep-level-0"> <td class="name"><code><a href="#sublayers">sublayers</a></code></td> <td class="name"> <code> <span class="param-type"><a link="Collection.html" onclick="getTypeHTML(event)" class="mapgis-link-name" title="Collection" Collection.html>Collection</a></span> </code> </td> <td class="name"><code><p>场景中包含的图层列表</p></code></td> </tr> </tbody> </table> </div> <h4 style="margin-top: 20px;margin-bottom: 20px;">成员变量详情</h4> <div class="members"> <div class="member"> <span class="method-parameter is-pulled-right"> <label>类型:</label> <span class="param-type">Array</span> </span> <h4 class="name" id="extendedProps"> <a class="href-link" href="#extendedProps">#</a> <span class="code-name"> extendedProps </span> </h4> <div class="description"> <p>扩展属性</p> </div> <dl class="details"> </dl> </div> <div class="member"> <span class="method-parameter is-pulled-right"> <label>类型:</label> <span class="param-type"><a link="IGSSceneLayer.html" onclick="getTypeHTML(event)" class="mapgis-link-name" title="IGSSceneLayer" IGSSceneLayer.html>IGSSceneLayer</a></span> </span> <h4 class="name" id="layer"> <a class="href-link" href="#layer">#</a> <span class="code-name"> layer </span> </h4> <div class="description"> <p>场景所属的场景服务图层</p> </div> <dl class="details"> </dl> </div> <div class="member"> <span class="method-parameter is-pulled-right"> <label>类型:</label> <span class="param-type">Number</span> </span> <h4 class="name" id="sceneIndex"> <a class="href-link" href="#sceneIndex">#</a> <span class="code-name"> sceneIndex </span> </h4> <div class="description"> <p>该场景在场景文档中的索引</p> </div> <dl class="details"> </dl> </div> <div class="member"> <span class="method-parameter is-pulled-right"> <label>类型:</label> <span class="param-type">String</span> </span> <h4 class="name" id="sceneMode"> <a class="href-link" href="#sceneMode">#</a> <span class="code-name"> sceneMode </span> </h4> <div class="description"> <p>场景类型</p> </div> <dl class="details"> </dl> </div> <div class="member"> <span class="method-parameter is-pulled-right"> <label>类型:</label> <span class="param-type">String</span> </span> <h4 class="name" id="sceneName"> <a class="href-link" href="#sceneName">#</a> <span class="code-name"> sceneName </span> </h4> <div class="description"> <p>场景名</p> </div> <dl class="details"> </dl> </div> <div class="member"> <span class="method-parameter is-pulled-right"> <label>类型:</label> <span class="param-type"><a link="Extent.html" onclick="getTypeHTML(event)" class="mapgis-link-name" title="Extent" Extent.html>Extent</a></span> </span> <h4 class="name" id="sceneRange"> <a class="href-link" href="#sceneRange">#</a> <span class="code-name"> sceneRange </span> </h4> <div class="description"> <p>场景包围盒</p> </div> <dl class="details"> </dl> </div> <div class="member"> <span class="method-parameter is-pulled-right"> <label>类型:</label> <span class="param-type"><a link="Collection.html" onclick="getTypeHTML(event)" class="mapgis-link-name" title="Collection" Collection.html>Collection</a></span> </span> <h4 class="name" id="sublayers"> <a class="href-link" href="#sublayers">#</a> <span class="code-name"> sublayers </span> </h4> <div class="description"> <p>场景中包含的图层列表</p> </div> <dl class="details"> </dl> </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="#findSublayerByGDBP">findSublayerByGDBP</a></code></td> <td class="name"> <code> <span class="param-type"><a link="IGSSceneSubLayer.html" onclick="getTypeHTML(event)" class="mapgis-link-name" title="IGSSceneSubLayer" IGSSceneSubLayer.html>IGSSceneSubLayer</a></span> </code> </td> <td class="name"><code><p>通过GDBP查询子图层</p></code></td> </tr> <tr class="deep-level-0"> <td class="name"><code><a href="#findSublayerById">findSublayerById</a></code></td> <td class="name"> <code> <span class="param-type"><a link="IGSSceneSubLayer.html" onclick="getTypeHTML(event)" class="mapgis-link-name" title="IGSSceneSubLayer" IGSSceneSubLayer.html>IGSSceneSubLayer</a></span> | <span class="param-type">null</span> </code> </td> <td class="name"><code><p>通过子图层ID来查询子图层</p></code></td> </tr> </tbody> </table> </div> <h4 style="margin-top: 20px;margin-bottom: 20px;">方法详情</h4> <div class="member"> <h4 class="name" id="findSublayerByGDBP"> <a class="href-link" href="#findSublayerByGDBP">#</a> <span class="code-name" id="findSublayerByGDBP" style="font-size:30px"> findSublayerByGDBP<span class="signature">(url)</span> </span> </h4> <div class="description"> <p>通过GDBP查询子图层</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" id="url"><code>url</code></td> <td class="type"> <span class="param-type">String</span> </td> <td class="description last"><p>GDBP地址</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='param-desc column is-7'><p>子图层</p></div> <div class='column is-5 has-text-left'> <label>类型: </label> <span class="param-type"><a link="IGSSceneSubLayer.html" onclick="getTypeHTML(event)" class="mapgis-link-name" title="IGSSceneSubLayer" IGSSceneSubLayer.html>IGSSceneSubLayer</a></span> </div> </div> </div> </div> </div> <div class="member"> <h4 class="name" id="findSublayerById"> <a class="href-link" href="#findSublayerById">#</a> <span class="code-name" id="findSublayerById" style="font-size:30px"> findSublayerById<span class="signature">(id)</span> </span> </h4> <div class="description"> <p>通过子图层ID来查询子图层</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" id="id"><code>id</code></td> <td class="type"> <span class="param-type">String</span> </td> <td class="description last"><p>子图层id</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='param-desc column is-7'><p>查询到的子图层</p></div> <div class='column is-5 has-text-left'> <label>类型: </label> <span class="param-type"><a link="IGSSceneSubLayer.html" onclick="getTypeHTML(event)" class="mapgis-link-name" title="IGSSceneSubLayer" IGSSceneSubLayer.html>IGSSceneSubLayer</a></span> | <span class="param-type">null</span> </div> </div> </div> </div> </div> </div> </div> </article> </section>