@mapgis/webclient-common

<header id="page-title" class="page-title"> <span class="page-title-main">类名</span> <span class="page-title-sub">WaterSymbol3DLayer</span> </header> <section> <article> <div class="container-overview"> <div class='vertical-section'> <div class="members"> <div class="member"> <h4 class="name" id="WaterSymbol3DLayer"> <a class="href-link" href="#WaterSymbol3DLayer">#</a> <span class="code-name" id="WaterSymbol3DLayer" style="font-size:30px"> new WaterSymbol3DLayer<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>color</code></td> <td class="type"> <span class="param-type"> <a link="Color.html" onclick="getTypeHTML(event)" class="mapgis-link-name" title="Color" Color.html>Color</a> </span> </td> <td class="default"> new Color() </td> <td class="description last"><p>水面颜色</p></td> </tr> <tr class="deep-level-1"> <td class="name"><code>waterbodySize</code></td> <td class="type"> <span class="param-type"> <a link="WaterbodySize.html" onclick="getTypeHTML(event)" class="mapgis-link-name" title="WaterbodySize" global.html#WaterbodySize>WaterbodySize</a> </span> </td> <td class="default"> WaterbodySize.medium </td> <td class="description last"><p>水体大小</p></td> </tr> <tr class="deep-level-1"> <td class="name"><code>waveDirection</code></td> <td class="type"> <span class="param-type"> Number </span> </td> <td class="default"> </td> <td class="description last"><p>波浪频率</p></td> </tr> <tr class="deep-level-1"> <td class="name"><code>waveStrength</code></td> <td class="type"> <span class="param-type"> <a link="WaveStrength.html" onclick="getTypeHTML(event)" class="mapgis-link-name" title="WaveStrength" global.html#WaveStrength>WaveStrength</a> </span> </td> <td class="default"> WaveStrength.moderate </td> <td class="description last"><p>波浪强度</p></td> </tr> </tbody> </table> </div> <dl class="details"> </dl> <p class="summary"><h5>支持如下方法：</h5> <a href='#fromJSON'>[1、通过json数据构造一个WaterSymbol3DLayer对象]</a><br/> <a href='#toJSON'>[2、导出为json数据]</a><br/> <a href='#clone'>[3、克隆并返回一个新的WaterSymbol3DLayer对象]</a><br/></p> </div> </div> </div> </div> <h3 class="subsection-title">继承关系</h3> <ul> <li><a link="Symbol3DLayer.html" onclick="getTypeHTML(event)" class="mapgis-link-name" title="Symbol3DLayer" Symbol3DLayer.html>Symbol3DLayer</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="#color">color</a></code></td> <td class="name"> <code> <span class="param-type"> <a link="Color.html" onclick="getTypeHTML(event)" class="mapgis-link-name" title="Color" Color.html>Color</a> </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="#type">type</a></code></td> <td class="name"> <code> <span class="param-type"> <a link="Symbol3DLayerType.html" onclick="getTypeHTML(event)" class="mapgis-link-name" title="Symbol3DLayerType" global.html#Symbol3DLayerType>Symbol3DLayerType</a> </span> </code> </td> <td class="name"><code><p>三维符号图层类型</p></code></td> </tr> <tr class="deep-level-0"> <td class="name"><code><a href="#waterbodySize">waterbodySize</a></code></td> <td class="name"> <code> <span class="param-type"> <a link="WaterbodySize.html" onclick="getTypeHTML(event)" class="mapgis-link-name" title="WaterbodySize" global.html#WaterbodySize>WaterbodySize</a> </span> </code> </td> <td class="name"><code><p>水体大小</p></code></td> </tr> <tr class="deep-level-0"> <td class="name"><code><a href="#waveDirection">waveDirection</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="#waveStrength">waveStrength</a></code></td> <td class="name"> <code> <span class="param-type"> <a link="WaveStrength.html" onclick="getTypeHTML(event)" class="mapgis-link-name" title="WaveStrength" global.html#WaveStrength>WaveStrength</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"> <a link="Color.html" onclick="getTypeHTML(event)" class="mapgis-link-name" title="Color" Color.html>Color</a> </span> </span> <h4 class="name" id="color"> <a class="href-link" href="#color">#</a> <span class="code-name"> color </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="Symbol3DLayer#color" Symbol3DLayer.html#color>Symbol3DLayer#color</a> </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="extendOptions"> <a class="href-link" href="#extendOptions">#</a> <span class="code-name"> extendOptions </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="extendOptions" link="Symbol.html" onclick="getTypeHTML(event)" class="mapgis-link-name" title="Symbol#extendOptions" Symbol.html#extendOptions>Symbol#extendOptions</a> </li></ul></dd> </dl> </div> <div class="member"> <span class="method-parameter is-pulled-right"> <label>类型:</label> <span class="param-type"> <a link="Symbol3DLayerType.html" onclick="getTypeHTML(event)" class="mapgis-link-name" title="Symbol3DLayerType" global.html#Symbol3DLayerType>Symbol3DLayerType</a> </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"> <dt class="tag-overrides">Overrides:</dt> <dd class="tag-overrides"><ul class="dummy"><li> <a class="mapgis-link-name" title="Symbol3DLayer#type" Symbol3DLayer.html#type>Symbol3DLayer#type</a> </li></ul></dd> </dl> </div> <div class="member"> <span class="method-parameter is-pulled-right"> <label>类型:</label> <span class="param-type"> <a link="WaterbodySize.html" onclick="getTypeHTML(event)" class="mapgis-link-name" title="WaterbodySize" global.html#WaterbodySize>WaterbodySize</a> </span> </span> <h4 class="name" id="waterbodySize"> <a class="href-link" href="#waterbodySize">#</a> <span class="code-name"> waterbodySize </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="waveDirection"> <a class="href-link" href="#waveDirection">#</a> <span class="code-name"> waveDirection </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="WaveStrength.html" onclick="getTypeHTML(event)" class="mapgis-link-name" title="WaveStrength" global.html#WaveStrength>WaveStrength</a> </span> </span> <h4 class="name" id="waveStrength"> <a class="href-link" href="#waveStrength">#</a> <span class="code-name"> waveStrength </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="#fromJSON">fromJSON</a></code></td> <td class="name"> <code> <span class="param-type"> <a link="LineCallout3D.html" onclick="getTypeHTML(event)" class="mapgis-link-name" title="LineCallout3D" LineCallout3D.html>LineCallout3D</a> </span> </code> </td> <td class="name"><code></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="WaterSymbol3DLayer.html" onclick="getTypeHTML(event)" class="mapgis-link-name" title="WaterSymbol3DLayer" WaterSymbol3DLayer.html>WaterSymbol3DLayer</a> </span> </code> </td> <td class="name"><code></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></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"> <a id='fromJSON'/> 通过json数据构造一个WaterSymbol3DLayer对象 </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 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>新的WaterSymbol3DLayer对象</p></div> <div class='column is-5 has-text-left'> <label>类型: </label> <span class="param-type"> <a link="LineCallout3D.html" onclick="getTypeHTML(event)" class="mapgis-link-name" title="LineCallout3D" LineCallout3D.html>LineCallout3D</a> </span> </div> </div> </div> </div> </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"> <a id='clone'/> 克隆并返回一个新的WaterSymbol3DLayer对象 </div> <dl class="details"> <dt class="tag-overrides">Overrides:</dt> <dd class="tag-overrides"><ul class="dummy"><li> <a class="mapgis-link-name" title="Symbol3DLayer#clone" Symbol3DLayer.html#clone>Symbol3DLayer#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>新的WaterSymbol3DLayer对象</p></div> <div class='column is-5 has-text-left'> <label>类型: </label> <span class="param-type"> <a link="WaterSymbol3DLayer.html" onclick="getTypeHTML(event)" class="mapgis-link-name" title="WaterSymbol3DLayer" WaterSymbol3DLayer.html>WaterSymbol3DLayer</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"> <a id='toJSON'/> 导出为json数据 </div> <dl class="details"> <dt class="tag-overrides">Overrides:</dt> <dd class="tag-overrides"><ul class="dummy"><li> <a class="mapgis-link-name" title="Symbol3DLayer#toJSON" Symbol3DLayer.html#toJSON>Symbol3DLayer#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>