UNPKG

@mapgis/webclient-common

Version:

mapgis ES6 format for igserver

1,811 lines (604 loc) 25.7 kB
<header id="page-title" class="page-title"> <span class="page-title-main">类名</span> <span class="page-title-sub">WMSSubLayer</span> </header> <section> <article> <div class="container-overview"> <div class='vertical-section'> <div class="members"> <div class="member"> <h4 class="name" id="WMSSubLayer"> <a class="href-link" href="#WMSSubLayer">#</a> <span class="code-name" id="WMSSubLayer" style="font-size:30px"> new WMSSubLayer<span class="signature">(options)</span> </span> </h4> <div class="description"> <p>WMS子图层</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"><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"><code>name</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"><code>description</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"><code>queryable</code></td> <td class="type"> <span class="param-type"> Boolean </span> </td> <td class="default"> </td> <td class="description last"><p>是否参与查询</p></td> </tr> <tr class="deep-level-1"> <td class="name"><code>spatialReferences</code></td> <td class="type"> <span class="param-type"> Array.&lt;<a onclick="getTypeHTML(event)" link="SpatialReference.html">SpatialReference</a>> </span> </td> <td class="default"> [] </td> <td class="description last"><p>图层坐标系列表</p></td> </tr> <tr class="deep-level-1"> <td class="name"><code>spatialReference</code></td> <td class="type"> <span class="param-type"> <a link="SpatialReference.html" onclick="getTypeHTML(event)" class="mapgis-link-name" title="SpatialReference" SpatialReference.html>SpatialReference</a> </span> </td> <td class="default"> </td> <td class="description last"><p>图层坐标系</p></td> </tr> <tr class="deep-level-1"> <td class="name"><code>extent</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> </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="#description">description</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="#extent">extent</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="#id">id</a></code></td> <td class="name"> <code> <span class="param-type"> String </span> </code> </td> <td class="name"><code><p>图层id,不给则生成随机id</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="#name">name</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="#queryable">queryable</a></code></td> <td class="name"> <code> <span class="param-type"> Boolean </span> </code> </td> <td class="name"><code><p>是否参与查询</p></code></td> </tr> <tr class="deep-level-0"> <td class="name"><code><a href="#spatialReference">spatialReference</a></code></td> <td class="name"> <code> <span class="param-type"> <a link="SpatialReference.html" onclick="getTypeHTML(event)" class="mapgis-link-name" title="SpatialReference" SpatialReference.html>SpatialReference</a> </span> </code> </td> <td class="name"><code><p>图层坐标系</p></code></td> </tr> <tr class="deep-level-0"> <td class="name"><code><a href="#spatialReferences">spatialReferences</a></code></td> <td class="name"> <code> <span class="param-type"> Array.&lt;<a onclick="getTypeHTML(event)" link="SpatialReference.html">SpatialReference</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"> 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="#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"> String </span> </span> <h4 class="name" id="description"> <a class="href-link" href="#description">#</a> <span class='tag'>readonly</span> <span class="code-name"> description </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="extent"> <a class="href-link" href="#extent">#</a> <span class='tag'>readonly</span> <span class="code-name"> extent </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,不给则生成随机id</p> </div> <dl class="details"> <dt class="inherited-from">Inherited From:</dt> <dd class="inherited-from"><ul class="dummy"><li> <a goto="id" link="SubLayer.html" onclick="getTypeHTML(event)" 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"> <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"> String </span> </span> <h4 class="name" id="name"> <a class="href-link" href="#name">#</a> <span class='tag'>readonly</span> <span class="code-name"> name </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="queryable"> <a class="href-link" href="#queryable">#</a> <span class='tag'>readonly</span> <span class="code-name"> queryable </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="SpatialReference.html" onclick="getTypeHTML(event)" class="mapgis-link-name" title="SpatialReference" SpatialReference.html>SpatialReference</a> </span> </span> <h4 class="name" id="spatialReference"> <a class="href-link" href="#spatialReference">#</a> <span class='tag'>readonly</span> <span class="code-name"> spatialReference </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 onclick="getTypeHTML(event)" link="SpatialReference.html">SpatialReference</a>> </span> </span> <h4 class="name" id="spatialReferences"> <a class="href-link" href="#spatialReferences">#</a> <span class='tag'>readonly</span> <span class="code-name"> spatialReferences </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="inherited-from">Inherited From:</dt> <dd class="inherited-from"><ul class="dummy"><li> <a goto="sublayers" link="SubLayer.html" onclick="getTypeHTML(event)" 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"> 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="#clone">clone</a></code></td> <td class="name"> <code> <span class="param-type"> <a link="WMSSubLayer.html" onclick="getTypeHTML(event)" class="mapgis-link-name" title="WMSSubLayer" WMSSubLayer.html>WMSSubLayer</a> </span> </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="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="tag-overrides">Overrides:</dt> <dd class="tag-overrides"><ul class="dummy"><li> <a 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="WMSSubLayer.html" onclick="getTypeHTML(event)" class="mapgis-link-name" title="WMSSubLayer" WMSSubLayer.html>WMSSubLayer</a> </span> </div> </div> </div> </div> </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>josn对象</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>