UNPKG

@mapgis/webclient-common

Version:

mapgis ES6 format for igserver

2,595 lines (803 loc) 37.6 kB
<header id="page-title" class="page-title"> <span class="page-title-main">类名</span> <span class="page-title-sub">IGSSceneSubLayer</span> </header> <section> <article> <div class="container-overview"> <div class='vertical-section'> <div class="members"> <div class="member"> <h4 class="name" id="IGSSceneSubLayer"> <a class="href-link" href="#IGSSceneSubLayer">#</a> <span class="code-name" id="IGSSceneSubLayer" style="font-size:30px"> new IGSSceneSubLayer<span class="signature">(options)</span> </span> </h4> <div class="description"> <p>IGS的SceneLayer子图层</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="renderer"><code>renderer</code></td> <td class="type"> <span class="param-type"><a link="BaseRenderer.html" onclick="getTypeHTML(event)" class="mapgis-link-name" title="BaseRenderer" BaseRenderer.html>BaseRenderer</a></span> </td> <td class="default"> </td> <td class="description last"><p>渲染器</p></td> </tr> <tr class="deep-level-1"> <td class="name" id="labelingInfo"><code>labelingInfo</code></td> <td class="type"> <span class="param-type">Array.&lt;<a link="Array.<LabelClass>.html" onclick="getTypeHTML(event)" href="LabelClass.html">LabelClass</a>></span> </td> <td class="default"> [] </td> <td class="description last"><p>注记图层样式,仅当此图层类型为注记图层时生效</p></td> </tr> <tr class="deep-level-1"> <td class="name" id="extendOptions"><code>extendOptions</code></td> <td class="type"> <span class="param-type">Object</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> <h3 class="subsection-title">继承关系</h3> <ul> <li><a link="SubLayer.html" onclick="getTypeHTML(event)" class="mapgis-link-name" title="SubLayer" SubLayer.html>SubLayer</a></li> </ul> <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="#beginLevel">beginLevel</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="#endLevel">endLevel</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="#extendOptions">extendOptions</a></code></td> <td class="name"> <code> <span class="param-type">Object</span> </code> </td> <td class="name"><code><p>初始化图层的额外参数,三维引擎专有的初始化参数请传入此对象</p></code></td> </tr> <tr class="deep-level-0"> <td class="name"><code><a href="#id">id</a></code></td> <td class="name"> <code> <span class="param-type">String</span> </code> </td> <td class="name"><code><p>子图层的id</p></code></td> </tr> <tr class="deep-level-0"> <td class="name"><code><a href="#labelingInfo">labelingInfo</a></code></td> <td class="name"> <code> <span class="param-type">Array.&lt;<a link="Array.<LabelClass>.html" onclick="getTypeHTML(event)" href="LabelClass.html">LabelClass</a>></span> </code> </td> <td class="name"><code><p>注记图层样式,仅当此图层类型为注记图层时生效</p></code></td> </tr> <tr class="deep-level-0"> <td class="name"><code><a href="#labelingInfo">labelingInfo</a></code></td> <td class="name"> <code> <span class="param-type">Array.&lt;<a link="Array.<LabelClass>.html" onclick="getTypeHTML(event)" href="LabelClass.html">LabelClass</a>></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="Layer.html" onclick="getTypeHTML(event)" class="mapgis-link-name" title="Layer" Layer.html>Layer</a></span> </code> </td> <td class="name"><code><p>父图层对象</p></code></td> </tr> <tr class="deep-level-0"> <td class="name"><code><a href="#layerIndex">layerIndex</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="#maxFrameSize">maxFrameSize</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="#opacity">opacity</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="#originPoint">originPoint</a></code></td> <td class="name"> <code> <span class="param-type"><a link="Point.html" onclick="getTypeHTML(event)" class="mapgis-link-name" title="Point" Point.html>Point</a></span> </code> </td> <td class="name"><code><p>网格划分的源点</p></code></td> </tr> <tr class="deep-level-0"> <td class="name"><code><a href="#range">range</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="#range3D">range3D</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="#renderer">renderer</a></code></td> <td class="name"> <code> <span class="param-type"><a link="BaseRenderer.html" onclick="getTypeHTML(event)" class="mapgis-link-name" title="BaseRenderer" BaseRenderer.html>BaseRenderer</a></span> </code> </td> <td class="name"><code><p>渲染器</p></code></td> </tr> <tr class="deep-level-0"> <td class="name"><code><a href="#renderType">renderType</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="#sublayers">sublayers</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="#title">title</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="#type">type</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="#url">url</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="#visible">visible</a></code></td> <td class="name"> <code> <span class="param-type">Boolean</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">Number</span> </span> <h4 class="name" id="beginLevel"> <a class="href-link" href="#beginLevel">#</a> <span class="code-name"> beginLevel </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="endLevel"> <a class="href-link" href="#endLevel">#</a> <span class="code-name"> endLevel </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">Object</span> </span> <h4 class="name" id="extendOptions"> <a class="href-link" href="#extendOptions">#</a> <span class="code-name"> extendOptions </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="id"> <a class="href-link" href="#id">#</a> <span class="code-name"> id </span> </h4> <div class="description"> <p>子图层的id</p> </div> <dl class="details"> <dt class="tag-overrides">Overrides:</dt> <dd class="tag-overrides"><ul class="dummy"><li> <a class="mapgis-link-name" title="SubLayer#id" SubLayer.html#id>SubLayer#id</a> </li></ul></dd> </dl> </div> <div class="member"> <span class="method-parameter is-pulled-right"> <label>类型:</label> <span class="param-type">Array.&lt;<a link="Array.<LabelClass>.html" onclick="getTypeHTML(event)" href="LabelClass.html">LabelClass</a>></span> </span> <h4 class="name" id="labelingInfo"> <a class="href-link" href="#labelingInfo">#</a> <span class="code-name"> labelingInfo </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">Array.&lt;<a link="Array.<LabelClass>.html" onclick="getTypeHTML(event)" href="LabelClass.html">LabelClass</a>></span> </span> <h4 class="name" id="labelingInfo"> <a class="href-link" href="#labelingInfo">#</a> <span class="code-name"> labelingInfo </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="Layer.html" onclick="getTypeHTML(event)" class="mapgis-link-name" title="Layer" Layer.html>Layer</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"> <dt class="tag-overrides">Overrides:</dt> <dd class="tag-overrides"><ul class="dummy"><li> <a class="mapgis-link-name" title="SubLayer#layer" SubLayer.html#layer>SubLayer#layer</a> </li></ul></dd> </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="layerIndex"> <a class="href-link" href="#layerIndex">#</a> <span class="code-name"> layerIndex </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="maxFrameSize"> <a class="href-link" href="#maxFrameSize">#</a> <span class="code-name"> maxFrameSize </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="opacity"> <a class="href-link" href="#opacity">#</a> <span class="code-name"> opacity </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="Point.html" onclick="getTypeHTML(event)" class="mapgis-link-name" title="Point" Point.html>Point</a></span> </span> <h4 class="name" id="originPoint"> <a class="href-link" href="#originPoint">#</a> <span class="code-name"> originPoint </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="range"> <a class="href-link" href="#range">#</a> <span class="code-name"> range </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="range3D"> <a class="href-link" href="#range3D">#</a> <span class="code-name"> range3D </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="BaseRenderer.html" onclick="getTypeHTML(event)" class="mapgis-link-name" title="BaseRenderer" BaseRenderer.html>BaseRenderer</a></span> </span> <h4 class="name" id="renderer"> <a class="href-link" href="#renderer">#</a> <span class="code-name"> renderer </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="renderType"> <a class="href-link" href="#renderType">#</a> <span class="code-name"> renderType </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">Array</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"> <dt class="tag-overrides">Overrides:</dt> <dd class="tag-overrides"><ul class="dummy"><li> <a class="mapgis-link-name" title="SubLayer#sublayers" SubLayer.html#sublayers>SubLayer#sublayers</a> </li></ul></dd> </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="title"> <a class="href-link" href="#title">#</a> <span class="code-name"> title </span> </h4> <div class="description"> <p>图层名称</p> </div> <dl class="details"> <dt class="inherited-from">Inherited From:</dt> <dd class="inherited-from"><ul class="dummy"><li> <a goto="title" link="SubLayer.html" onclick="getTypeHTML(event)" class="mapgis-link-name" title="SubLayer#title" SubLayer.html#title>SubLayer#title</a> </li></ul></dd> </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="type"> <a class="href-link" href="#type">#</a> <span class="code-name"> type </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="url"> <a class="href-link" href="#url">#</a> <span class="code-name"> url </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">Boolean</span> </span> <h4 class="name" id="visible"> <a class="href-link" href="#visible">#</a> <span class="code-name"> visible </span> </h4> <div class="description"> <p>子图层可见性</p> </div> <dl class="details"> <dt class="tag-overrides">Overrides:</dt> <dd class="tag-overrides"><ul class="dummy"><li> <a class="mapgis-link-name" title="SubLayer#visible" SubLayer.html#visible>SubLayer#visible</a> </li></ul></dd> </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="#fromJSON">fromJSON</a></code></td> <td class="name"> <code> </code> </td> <td class="name"><code><p>通过json对象初始化该对象</p></code></td> </tr> <tr class="deep-level-0"> <td class="name"><code><a href="#clone">clone</a></code></td> <td class="name"> <code> <span class="param-type"><a link="SubLayer.html" onclick="getTypeHTML(event)" class="mapgis-link-name" title="SubLayer" SubLayer.html>SubLayer</a></span> </code> </td> <td class="name"><code><p>克隆方法</p></code></td> </tr> <tr class="deep-level-0"> <td class="name"><code><a href="#reset">reset</a></code></td> <td class="name"> <code> </code> </td> <td class="name"><code><p>重置视角到子图层外包盒处</p></code></td> </tr> <tr class="deep-level-0"> <td class="name"><code><a href="#toJSON">toJSON</a></code></td> <td class="name"> <code> <span class="param-type">Object</span> </code> </td> <td class="name"><code><p>将对象转为json对象</p></code></td> </tr> </tbody> </table> </div> <h4 style="margin-top: 20px;margin-bottom: 20px;">方法详情</h4> <div class="member"> <h4 class="name" id=".fromJSON"> <a class="href-link" href="#.fromJSON">#</a> <span class='tag'>static</span> <span class="code-name" id="fromJSON" style="font-size:30px"> fromJSON<span class="signature">(json)</span> </span> </h4> <div class="description"> <p>通过json对象初始化该对象</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="json"><code>json</code></td> <td class="type"> <span class="param-type">Object</span> </td> <td class="description last"><p>json对象</p></td> </tr> </tbody> </table> </div> <dl class="details"> </dl> </div> <div class="member"> <h4 class="name" id="clone"> <a class="href-link" href="#clone">#</a> <span class="code-name" id="clone" style="font-size:30px"> clone<span class="signature">()</span> </span> </h4> <div class="description"> <p>克隆方法</p> </div> <dl class="details"> <dt class="inherited-from">Inherited From:</dt> <dd class="inherited-from"><ul class="dummy"><li> <a goto="clone" link="SubLayer.html" onclick="getTypeHTML(event)" class="mapgis-link-name" title="SubLayer#clone" SubLayer.html#clone>SubLayer#clone</a> </li></ul></dd> </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="SubLayer.html" onclick="getTypeHTML(event)" class="mapgis-link-name" title="SubLayer" SubLayer.html>SubLayer</a></span> </div> </div> </div> </div> </div> <div class="member"> <h4 class="name" id="reset"> <a class="href-link" href="#reset">#</a> <span class="code-name" id="reset" style="font-size:30px"> reset<span class="signature">()</span> </span> </h4> <div class="description"> <p>重置视角到子图层外包盒处</p> </div> <dl class="details"> </dl> </div> <div class="member"> <h4 class="name" id="toJSON"> <a class="href-link" href="#toJSON">#</a> <span class="code-name" id="toJSON" style="font-size:30px"> toJSON<span class="signature">()</span> </span> </h4> <div class="description"> <p>将对象转为json对象</p> </div> <dl class="details"> <dt class="tag-overrides">Overrides:</dt> <dd class="tag-overrides"><ul class="dummy"><li> <a class="mapgis-link-name" title="SubLayer#toJSON" SubLayer.html#toJSON>SubLayer#toJSON</a> </li></ul></dd> </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>json对象</p></div> <div class='column is-5 has-text-left'> <label>类型: </label> <span class="param-type">Object</span> </div> </div> </div> </div> </div> </div> </div> </article> </section>