@mapgis/webclient-common

<header id="page-title" class="page-title"> <span class="page-title-main">类名</span> <span class="page-title-sub">OverlayLayer</span> </header> <section> <article> <div class="container-overview"> <div class='vertical-section'> <div class="members"> <div class="member"> <h4 class="name" id="OverlayLayer"> <a class="href-link" href="#OverlayLayer">#</a> <span class="code-name" id="OverlayLayer" style="font-size:30px"> new OverlayLayer<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 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="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="Layer.html" onclick="getTypeHTML(event)" class="mapgis-link-name" title="Layer" Layer.html>Layer</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="#copyright">copyright</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="#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="#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="#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="#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="#headers">headers</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="#httpMethod">httpMethod</a></code></td> <td class="name"> <code> <span class="param-type">String</span> </code> </td> <td class="name"><code><p>http请求方式</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="#index">index</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="#loaded">loaded</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="#loadStatus">loadStatus</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="#maxScale">maxScale</a></code></td> <td class="name"> <code> <span class="param-type">Number</span> </code> </td> <td class="name"><code><p>最大显示比例尺，图层在视图中可见的最大比例尺(最放大)。如果地图被放大到超过这个比例，图层将不可见。默认值为0，0表示图层没有最大比例尺、可见性不受最大比例尺限制。maxScale应该始终小于minScale。</p></code></td> </tr> <tr class="deep-level-0"> <td class="name"><code><a href="#minScale">minScale</a></code></td> <td class="name"> <code> <span class="param-type">Number</span> </code> </td> <td class="name"><code><p>最小显示比例尺，图层在视图中可见的最小比例尺(最缩小)。如果地图被缩小到超过这个比例，图层将不可见。默认值为0，0表示图层没有最小比例尺、可见性不受最小比例尺限制。minScale应该始终大于maxScale。</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>图层透明度，0到1之间的值，0为完全透明，1为不透明，会触发图层更新完毕事件</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="#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="#tokenKey">tokenKey</a></code></td> <td class="name"> <code> <span class="param-type">String</span> </code> </td> <td class="name"><code><p>token名</p></code></td> </tr> <tr class="deep-level-0"> <td class="name"><code><a href="#tokenValue">tokenValue</a></code></td> <td class="name"> <code> <span class="param-type">String</span> </code> </td> <td class="name"><code><p>token值</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="#visible">visible</a></code></td> <td class="name"> <code> <span class="param-type">Number</span> </code> </td> <td class="name"><code><p>图层显示或隐藏，true则显示，false则隐藏，会触发图层更新完毕事件</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="copyright"> <a class="href-link" href="#copyright">#</a> <span class='tag'>readonly</span> <span class="code-name"> copyright </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="copyright" link="Layer.html" onclick="getTypeHTML(event)" class="mapgis-link-name" title="Layer#copyright" Layer.html#copyright>Layer#copyright</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="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"> <dt class="inherited-from">Inherited From:</dt> <dd class="inherited-from"><ul class="dummy"><li> <a goto="description" link="Layer.html" onclick="getTypeHTML(event)" class="mapgis-link-name" title="Layer#description" Layer.html#description>Layer#description</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="Layer.html" onclick="getTypeHTML(event)" class="mapgis-link-name" title="Layer#extendOptions" Layer.html#extendOptions>Layer#extendOptions</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="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="Layer.html" onclick="getTypeHTML(event)" class="mapgis-link-name" title="Layer#extendProps" Layer.html#extendProps>Layer#extendProps</a> </li></ul></dd> </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"> <dt class="inherited-from">Inherited From:</dt> <dd class="inherited-from"><ul class="dummy"><li> <a goto="extent" link="Layer.html" onclick="getTypeHTML(event)" class="mapgis-link-name" title="Layer#extent" Layer.html#extent>Layer#extent</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="headers"> <a class="href-link" href="#headers">#</a> <span class="code-name"> headers </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="headers" link="Layer.html" onclick="getTypeHTML(event)" class="mapgis-link-name" title="Layer#headers" Layer.html#headers>Layer#headers</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="httpMethod"> <a class="href-link" href="#httpMethod">#</a> <span class="code-name"> httpMethod </span> </h4> <div class="description"> <p>http请求方式</p> </div> <dl class="details"> <dt class="inherited-from">Inherited From:</dt> <dd class="inherited-from"><ul class="dummy"><li> <a goto="httpMethod" link="Layer.html" onclick="getTypeHTML(event)" class="mapgis-link-name" title="Layer#httpMethod" Layer.html#httpMethod>Layer#httpMethod</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="id"> <a class="href-link" href="#id">#</a> <span class='tag'>readonly</span> <span class="code-name"> id </span> </h4> <div class="description"> <p>图层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="Layer.html" onclick="getTypeHTML(event)" class="mapgis-link-name" title="Layer#id" Layer.html#id>Layer#id</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="index"> <a class="href-link" href="#index">#</a> <span class="code-name"> index </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="index" link="Layer.html" onclick="getTypeHTML(event)" class="mapgis-link-name" title="Layer#index" Layer.html#index>Layer#index</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="loaded"> <a class="href-link" href="#loaded">#</a> <span class='tag'>readonly</span> <span class="code-name"> loaded </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="loaded" link="Layer.html" onclick="getTypeHTML(event)" class="mapgis-link-name" title="Layer#loaded" Layer.html#loaded>Layer#loaded</a> </li></ul></dd> <dt class="tag-default">Default Value:</dt> <dd class="tag-default"><ul class="dummy"> <li>false</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="loadStatus"> <a class="href-link" href="#loadStatus">#</a> <span class='tag'>readonly</span> <span class="code-name"> loadStatus </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="loadStatus" link="Layer.html" onclick="getTypeHTML(event)" class="mapgis-link-name" title="Layer#loadStatus" Layer.html#loadStatus>Layer#loadStatus</a> </li></ul></dd> <dt class="tag-default">Default Value:</dt> <dd class="tag-default"><ul class="dummy"> <li>not-loaded</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="maxScale"> <a class="href-link" href="#maxScale">#</a> <span class="code-name"> maxScale </span> </h4> <div class="description"> <p>最大显示比例尺，图层在视图中可见的最大比例尺(最放大)。如果地图被放大到超过这个比例，图层将不可见。默认值为0，0表示图层没有最大比例尺、可见性不受最大比例尺限制。maxScale应该始终小于minScale。</p> </div> <dl class="details"> <dt class="inherited-from">Inherited From:</dt> <dd class="inherited-from"><ul class="dummy"><li> <a goto="maxScale" link="Layer.html" onclick="getTypeHTML(event)" class="mapgis-link-name" title="Layer#maxScale" Layer.html#maxScale>Layer#maxScale</a> </li></ul></dd> <dt class="tag-default">Default Value:</dt> <dd class="tag-default"><ul class="dummy"> <li>0</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="minScale"> <a class="href-link" href="#minScale">#</a> <span class="code-name"> minScale </span> </h4> <div class="description"> <p>最小显示比例尺，图层在视图中可见的最小比例尺(最缩小)。如果地图被缩小到超过这个比例，图层将不可见。默认值为0，0表示图层没有最小比例尺、可见性不受最小比例尺限制。minScale应该始终大于maxScale。</p> </div> <dl class="details"> <dt class="inherited-from">Inherited From:</dt> <dd class="inherited-from"><ul class="dummy"><li> <a goto="minScale" link="Layer.html" onclick="getTypeHTML(event)" class="mapgis-link-name" title="Layer#minScale" Layer.html#minScale>Layer#minScale</a> </li></ul></dd> <dt class="tag-default">Default Value:</dt> <dd class="tag-default"><ul class="dummy"> <li>0</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="opacity"> <a class="href-link" href="#opacity">#</a> <span class="code-name"> opacity </span> </h4> <div class="description"> <p>图层透明度，0到1之间的值，0为完全透明，1为不透明，会触发图层更新完毕事件</p> </div> <dl class="details"> <dt class="inherited-from">Inherited From:</dt> <dd class="inherited-from"><ul class="dummy"><li> <a goto="opacity" link="Layer.html" onclick="getTypeHTML(event)" class="mapgis-link-name" title="Layer#opacity" Layer.html#opacity>Layer#opacity</a> </li></ul></dd> </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="code-name"> spatialReference </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="Layer#spatialReference" Layer.html#spatialReference>Layer#spatialReference</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="Layer.html" onclick="getTypeHTML(event)" class="mapgis-link-name" title="Layer#title" Layer.html#title>Layer#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="tokenKey"> <a class="href-link" href="#tokenKey">#</a> <span class="code-name"> tokenKey </span> </h4> <div class="description"> <p>token名</p> </div> <dl class="details"> <dt class="inherited-from">Inherited From:</dt> <dd class="inherited-from"><ul class="dummy"><li> <a goto="tokenKey" link="Layer.html" onclick="getTypeHTML(event)" class="mapgis-link-name" title="Layer#tokenKey" Layer.html#tokenKey>Layer#tokenKey</a> </li></ul></dd> <dt class="tag-default">Default Value:</dt> <dd class="tag-default"><ul class="dummy"> <li>token</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="tokenValue"> <a class="href-link" href="#tokenValue">#</a> <span class="code-name"> tokenValue </span> </h4> <div class="description"> <p>token值</p> </div> <dl class="details"> <dt class="inherited-from">Inherited From:</dt> <dd class="inherited-from"><ul class="dummy"><li> <a goto="tokenValue" link="Layer.html" onclick="getTypeHTML(event)" class="mapgis-link-name" title="Layer#tokenValue" Layer.html#tokenValue>Layer#tokenValue</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"> <dt class="tag-overrides">Overrides:</dt> <dd class="tag-overrides"><ul class="dummy"><li> <a class="mapgis-link-name" title="Layer#type" Layer.html#type>Layer#type</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="visible"> <a class="href-link" href="#visible">#</a> <span class="code-name"> visible </span> </h4> <div class="description"> <p>图层显示或隐藏，true则显示，false则隐藏，会触发图层更新完毕事件</p> </div> <dl class="details"> <dt class="inherited-from">Inherited From:</dt> <dd class="inherited-from"><ul class="dummy"><li> <a goto="visible" link="Layer.html" onclick="getTypeHTML(event)" class="mapgis-link-name" title="Layer#visible" Layer.html#visible>Layer#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="OverlayLayer.html" onclick="getTypeHTML(event)" class="mapgis-link-name" title="OverlayLayer" OverlayLayer.html>OverlayLayer</a></span> </code> </td> <td class="name"><code><p>克隆并返回一个新图层</p></code></td> </tr> <tr class="deep-level-0"> <td class="name"><code><a href="#destroy">destroy</a></code></td> <td class="name"> <code> <span class="param-type">*</span> </code> </td> <td class="name"><code></code></td> </tr> <tr class="deep-level-0"> <td class="name"><code><a href="#isLoaded">isLoaded</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="#off">off</a></code></td> <td class="name"> <code> <span class="param-type">Object</span> </code> </td> <td class="name"><code><p>移除事件<br/> 示例如下:<br/> <a href='#off1'>[1、移除一个事件的指定回调函数]</a><br/> <a href='#off2'>[2、移除一个事件的所有回调函数]</a><br/> <a href='#off3'>[3、移除多个事件的同一个指定的回调函数]</a><br/> <a href='#off4'>[4、移除多个指定事件的回调函数]</a><br/> <a href='#off5'>[5、删除时指定上下文 - types类型为字符串]</a><br/> <a href='#off6'>[6、删除时指定上下文 - types类型为对象]</a><br/></p></code></td> </tr> <tr class="deep-level-0"> <td class="name"><code><a href="#on">on</a></code></td> <td class="name"> <code> <span class="param-type">Object</span> </code> </td> <td class="name"><code><p>注册一个新的监听事件;<br/> 示例如下：<br/> <a href='#event1'>[1、注册一个事件]</a><br/> <a href='#event2'>[2、一次注册多个事件 - 同一个回调函数]</a><br/> <a href='#event3'>[3、一次注册多个事件 - 分别指回调应函数]</a><br/> <a href='#event4'>[4、当types为字符串时 - 指定上下文]</a><br/> <a href='#event5'>[5、当types为对象时 - 指定上下文]</a><br/></p></code></td> </tr> <tr class="deep-level-0"> <td class="name"><code><a href="#refresh">refresh</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="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="Layer#clone" Layer.html#clone>Layer#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="OverlayLayer.html" onclick="getTypeHTML(event)" class="mapgis-link-name" title="OverlayLayer" OverlayLayer.html>OverlayLayer</a></span> </div> </div> </div> </div> </div> <div class="member"> <h4 class="name" id="destroy"> <a class="href-link" href="#destroy">#</a> <span class="code-name" id="destroy" style="font-size:30px"> destroy<span class="signature">()</span> </span> </h4> <dl class="details"> <dt class="inherited-from">Inherited From:</dt> <dd class="inherited-from"><ul class="dummy"><li> <a goto="destroy" link="Layer.html" onclick="getTypeHTML(event)" class="mapgis-link-name" title="Layer#destroy" Layer.html#destroy>Layer#destroy</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='column is-5 has-text-left'> <label>类型: </label> <span class="param-type">*</span> </div> </div> </div> </div> </div> <div class="member"> <h4 class="name" id="isLoaded"> <a class="href-link" href="#isLoaded">#</a> <span class="code-name" id="isLoaded" style="font-size:30px"> isLoaded<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="isLoaded" link="Layer.html" onclick="getTypeHTML(event)" class="mapgis-link-name" title="Layer#isLoaded" Layer.html#isLoaded>Layer#isLoaded</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">Boolean</span> </div> </div> </div> </div> </div> <div class="member"> <h4 class="name" id="off"> <a class="href-link" href="#off">#</a> <span class="code-name" id="off" style="font-size:30px"> off<span class="signature">(types<span class="signature-attributes">opt</span>, fn<span class="signature-attributes">opt</span>, context<span class="signature-attributes">opt</span>)</span> </span> </h4> <div class="description"> <p>移除事件<br/> 示例如下:<br/> <a href='#off1'>[1、移除一个事件的指定回调函数]</a><br/> <a href='#off2'>[2、移除一个事件的所有回调函数]</a><br/> <a href='#off3'>[3、移除多个事件的同一个指定的回调函数]</a><br/> <a href='#off4'>[4、移除多个指定事件的回调函数]</a><br/> <a href='#off5'>[5、删除时指定上下文 - types类型为字符串]</a><br/> <a href='#off6'>[6、删除时指定上下文 - types类型为对象]</a><br/></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="types"><code>types</code></td> <td class="type"> <span class="param-type">string</span> </td> <td class="description last"><p>移除指定事件类型上绑定的回调函数<br/> 当类型为字符串时，可以移除单个或多个事件类型绑定的回调函数，单个事件："click"，多个事件：以空格分割:"click double-click"；<br/> 当types为对象时，使用如下方式移除事件：{'click': onClickFun, 'mouse-move': onMouseMoveFun}</p></td> </tr> <tr class="deep-level-0"> <td class="name" id="fn"><code>fn</code></td> <td class="type"> <span class="param-type">function</span> </td> <td class="description last"><p>事件回调函数，当types为字符串，且不指定要删除的回调函数时，删除该事件上的所有回调函数</p></td> </tr> <tr class="deep-level-0"> <td class="name" id="context"><code>context</code></td> <td class="type"> <span class="param-type">Object</span> </td> <td class="description last"><p>事件回调函数的this关键字将指向的对象</p></td> </tr> </tbody> </table> </div> <dl class="details"> <dt class="inherited-from">Inherited From:</dt> <dd class="inherited-from"><ul class="dummy"><li> <a goto="off" link="Evented.html" onclick="getTypeHTML(event)" class="mapgis-link-name" title="Evented#off" Evented.html#off>Evented#off</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">Object</span> </div> </div> </div> </div> <h5>示例</h5> <p class="code-caption"><h5 id='off1'>移除一个事件的指定回调函数</h5></p> <pre class="prettyprint"><code>// 一个事件的回调函数 const clickFunction = function (event) { console.log("点击事件:", event) } // 调用MapView或SceneView的off方法移除一个事件的回调函数 view.off('click', clickFunction)</code></pre> <p class="code-caption"><h5 id='off2'>移除一个事件的所有回调函数</h5></p> <pre class="prettyprint"><code>// 一个事件的回调函数1 const clickFunction1 = function (event) { console.log("点击事件1:", event) } // 一个事件的回调函数2 const clickFunction2 = function (event) { console.log("点击事件2:", event) } // 调用MapView或SceneView的off方法移除一个事件的所有回调函数 // 不指定回调函数，则移除该事件上的所有绑定的回调函数 view.off('click')</code></pre> <p class="code-caption"><h5 id='off3'>移除多个事件的同一个指定的回调函数</h5></p> <pre class="prettyprint"><code>// 多个事件的同一个回调函数 const eventFunction = function (event) { console.log("事件:", event) } // 调用MapView或SceneView的off方法移除多个事件的同一个指定的回调函数 view.off('click double-click', eventFunction)</code></pre> <p class="code-caption"><h5 id='off4'>移除多个指定事件的回调函数</h5></p> <pre class="prettyprint"><code>// 一个事件的回调函数 const clickFunction = function (event) { console.log("click事件:", event) } // 调用MapView或SceneView的off方法移除多个指定事件的回调函数 view.off({ // 移除click事件上一个指定的函数 "click": clickFunction, // 移除double-click上所有指定的函数 "double-click": undefined })</code></pre> <p class="code-caption"><h5 id='off5'>删除时指定上下文 - types类型为字符串</h5></p> <pre class="prettyprint"><code>// 一个事件的回调函数 const clickFunction = function (event) { console.log("点击事件:", event) } // 调用MapView或SceneView的off方法移除一个事件的回调函数 view.off('click', clickFunction, view) // 调用MapView或SceneView的off方法移除一个事件的所有回调函数 view.off('click', undefined, view)</code></pre> <p class="code-caption"><h5 id='off6'>删除时指定上下文 - types类型为对象</h5></p> <pre class="prettyprint"><code>// 一个事件的回调函数 const clickFunction = function (event) { console.log("click事件:", event) } // 调用MapView或SceneView的off方法移除多个指定事件的回调函数 view.off({ // 移除click事件上一个指定的函数 "click": clickFunction, // 移除double-click上所有指定的函数 "double-click": undefined }, view)</code></pre> </div> <div class="member"> <h4 class="name" id="on"> <a class="href-link" href="#on">#</a> <span class="code-name" id="on" style="font-size:30px"> on<span class="signature">(types<span class="signature-attributes">opt</span>, fn<span class="signature-attributes">opt</span>, context<span class="signature-attributes">opt</span>)</span> </span> </h4> <div class="description"> <p>注册一个新的监听事件;<br/> 示例如下：<br/> <a href='#event1'>[1、注册一个事件]</a><br/> <a href='#event2'>[2、一次注册多个事件 - 同一个回调函数]</a><br/> <a href='#event3'>[3、一次注册多个事件 - 分别指回调应函数]</a><br/> <a href='#event4'>[4、当types为字符串时 - 指定上下文]</a><br/> <a href='#event5'>[5、当types为对象时 - 指定上下文]</a><br/></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="types"><code>types</code></td> <td class="type"> <span class="param-type">String</span> | <span class="param-type">Object</span> </td> <td class="default"> null </td> <td class="description last"><p>事件类型<br/> 当types为字符串时，可以定义单个或多个事件，单个事件："click"，多个事件：以空格分割:"click double-click"；<br/> 当types为对象时，使用如下方式指定事件：{'click': onClickFun, 'mouse-move': onMouseMoveFun}</p></td> </tr> <tr class="deep-level-0"> <td class="name" id="fn"><code>fn</code></td> <td class="type"> <span class="param-type">function</span> </td> <td class="default"> null </td> <td class="description last"><p>事件回调函数</p></td> </tr> <tr class="deep-level-0"> <td class="name" id="context"><code>context</code></td> <td class="type"> <span class="param-type">Object</span> </td> <td class="default"> null </td> <td class="description last"><p>事件回调函数的this关键字将指向的对象</p></td> </tr> </tbody> </table> </div> <dl class="details"> <dt class="inherited-from">Inherited From:</dt> <dd class="inherited-from"><ul class="dummy"><li> <a goto="on" link="Evented.html" onclick="getTyp