@mapgis/webclient-common

<header id="page-title" class="page-title"> <span class="page-title-main">类名</span> <span class="page-title-sub">VectorTileSubLayer</span> </header> <section> <article> <div class="container-overview"> <div class='vertical-section'> <div class="members"> <div class="member"> <h4 class="name" id="VectorTileSubLayer"> <a class="href-link" href="#VectorTileSubLayer">#</a> <span class="code-name" id="VectorTileSubLayer" style="font-size:30px"> new VectorTileSubLayer<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"><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>id</code></td> <td class="type"> <span class="param-type"> String </span> </td> <td class="default"> </td> <td class="description last"><p>矢量瓦片子图层的id</p></td> </tr> <tr class="deep-level-1"> <td class="name"><code>title</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>visible</code></td> <td class="type"> <span class="param-type"> Boolean </span> </td> <td class="default"> true </td> <td class="description last"><p>图层可见性</p></td> </tr> <tr class="deep-level-1"> <td class="name"><code>styleLayers</code></td> <td class="type"> <span class="param-type"> Array.<Object> </span> </td> <td class="default"> </td> <td class="description last"><p>矢量瓦片子图层关联的矢量瓦片样式图层数组，只读属性</p></td> </tr> <tr class="deep-level-1"> <td class="name"><code>layer</code></td> <td class="type"> <span class="param-type"> <a link="VectorTileLayer.html" onclick="getTypeHTML(event)" href="VectorTileLayer.html">VectorTileLayer</a> </span> </td> <td class="default"> </td> <td class="description last"><p>矢量瓦片父图层对象</p></td> </tr> <tr class="deep-level-1"> <td class="name"><code>renderer</code></td> <td class="type"> <span class="param-type"> <a link="BaseRenderer.html" onclick="getTypeHTML(event)" href="BaseRenderer.html">BaseRenderer</a> </span> </td> <td class="default"> </td> <td class="description last"><p>专题图渲染样式对象，支持如下渲染样式：<br/> <a href="UniqueValueRenderer.html"><code>1、单值渲染</code></a><br/> <a href="ClassBreakRenderer.html"><code>2、分段渲染</code></a><br/> <a href="SimpleRenderer.html"><code>3、统一专题图</code></a></p></td> </tr> <tr class="deep-level-1"> <td class="name"><code>labelingInfo</code></td> <td class="type"> <span class="param-type"> Array.<<a onclick="getTypeHTML(event)" link="LabelClass.html">LabelClass</a>> </span> </td> <td class="default"> [] </td> <td class="description last"><p>三维注记参数，仅当igs矢量瓦片图层labelsRenderMode设置非'off-screen'属性时生效。为性能考虑，当前所有子图层labelingInfo内labelClass必须保证renderMode一致，不支持同时设置label或canvas两种形式。</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)" href="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="#extendProps">extendProps</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="#extensionOptions">extensionOptions</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，不给则生成随机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.<<a onclick="getTypeHTML(event)" link="LabelClass.html">LabelClass</a>> </span> </code> </td> <td class="name"><code><p>三维注记参数，仅当igs矢量瓦片图层labelsRenderMode设置非'off-screen'属性时生效。为性能考虑，当前所有子图层labelingInfo内labelClass必须保证renderMode一致，不支持同时设置label或canvas两种形式。</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)" href="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="#renderer">renderer</a></code></td> <td class="name"> <code> <span class="param-type"> <a link="UniqueValueRenderer.html" onclick="getTypeHTML(event)" href="UniqueValueRenderer.html">UniqueValueRenderer</a> </span> | <span class="param-type"> <a link="ClassBreakRenderer.html" onclick="getTypeHTML(event)" href="ClassBreakRenderer.html">ClassBreakRenderer</a> </span> | <span class="param-type"> <a link="SimpleRenderer.html" onclick="getTypeHTML(event)" href="SimpleRenderer.html">SimpleRenderer</a> </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)" href="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="#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="#type">type</a></code></td> <td class="name"> <code> <span class="param-type"> Array.<Object> </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"> Object </span> </span> <h4 class="name" id="extendProps"> <a class="href-link" href="#extendProps">#</a> <span class="code-name"> extendProps </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="extendProps" link="SubLayer.html" onclick="getTypeHTML(event)" href="SubLayer.html#extendProps">SubLayer#extendProps</a> </li></ul></dd> <dt class="tag-default">Default Value:</dt> <dd class="tag-default"><ul class="dummy"> <li>{}</li> </ul></dd> </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="extensionOptions"> <a class="href-link" href="#extensionOptions">#</a> <span class="code-name"> extensionOptions </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="extensionOptions" link="SubLayer.html" onclick="getTypeHTML(event)" href="SubLayer.html#extensionOptions">SubLayer#extensionOptions</a> </li></ul></dd> <dt class="tag-default">Default Value:</dt> <dd class="tag-default"><ul class="dummy"> <li>{}</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="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)" href="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.<<a onclick="getTypeHTML(event)" link="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>三维注记参数，仅当igs矢量瓦片图层labelsRenderMode设置非'off-screen'属性时生效。为性能考虑，当前所有子图层labelingInfo内labelClass必须保证renderMode一致，不支持同时设置label或canvas两种形式。</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)" href="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 href="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"> <a link="UniqueValueRenderer.html" onclick="getTypeHTML(event)" href="UniqueValueRenderer.html">UniqueValueRenderer</a> </span> | <span class="param-type"> <a link="ClassBreakRenderer.html" onclick="getTypeHTML(event)" href="ClassBreakRenderer.html">ClassBreakRenderer</a> </span> | <span class="param-type"> <a link="SimpleRenderer.html" onclick="getTypeHTML(event)" href="SimpleRenderer.html">SimpleRenderer</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"> <a link="SpatialReference.html" onclick="getTypeHTML(event)" href="SpatialReference.html">SpatialReference</a> </span> </span> <h4 class="name" id="spatialReference"> <a class="href-link" href="#spatialReference">#</a> <span class="code-name"> spatialReference </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="spatialReference" link="SubLayer.html" onclick="getTypeHTML(event)" href="SubLayer.html#spatialReference">SubLayer#spatialReference</a> </li></ul></dd> </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)" href="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)" href="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='tag'>readonly</span> <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"> Array.<Object> </span> </span> <h4 class="name" id="type"> <a class="href-link" href="#type">#</a> <span class='tag'>readonly</span> <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"> 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 href="SubLayer.html#visible">SubLayer#visible</a> </li></ul></dd> <dt class="tag-default">Default Value:</dt> <dd class="tag-default"><ul class="dummy"> <li>true</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="VectorTileSubLayer.html" onclick="getTypeHTML(event)" href="VectorTileSubLayer.html">VectorTileSubLayer</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=".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"><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="tag-overrides">Overrides:</dt> <dd class="tag-overrides"><ul class="dummy"><li> <a href="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="VectorTileSubLayer.html" onclick="getTypeHTML(event)" href="VectorTileSubLayer.html">VectorTileSubLayer</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 href="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>