UNPKG

@mapgis/webclient-common

Version:

mapgis ES6 format for igserver

1,779 lines (523 loc) 23.5 kB
<header id="page-title" class="page-title"> <span class="page-title-main">类名</span> <span class="page-title-sub">ArcGisExtent</span> </header> <section> <article> <div class="container-overview"> <div class='vertical-section'> <div class="members"> <div class="member"> <h4 class="name" id="ArcGisExtent"> <a class="href-link" href="#ArcGisExtent">#</a> <span class="code-name" id="ArcGisExtent" style="font-size:30px"> new ArcGisExtent<span class="signature">(options)</span> </span> </h4> <div class="description"> <p>ArcGisExtent对象</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>必选项,构造Extent对象参数。</p></td> </tr> <tr class="deep-level-0"> <td class="name" id="query.xmin"><code>query.xmin</code></td> <td class="type"> <span class="param-type">String</span> </td> <td class="description last"><p>可选项,x轴最小坐标。</p></td> </tr> <tr class="deep-level-0"> <td class="name" id="query.ymin"><code>query.ymin</code></td> <td class="type"> <span class="param-type">String</span> </td> <td class="description last"><p>可选项,x轴最大坐标。</p></td> </tr> <tr class="deep-level-0"> <td class="name" id="query.ymin"><code>query.ymin</code></td> <td class="type"> <span class="param-type">String</span> </td> <td class="description last"><p>可选项,y轴最小坐标。</p></td> </tr> <tr class="deep-level-0"> <td class="name" id="query.ymax"><code>query.ymax</code></td> <td class="type"> <span class="param-type">String</span> </td> <td class="description last"><p>可选项,y轴最小坐标。</p></td> </tr> <tr class="deep-level-0"> <td class="name" id="query.zmin"><code>query.zmin</code></td> <td class="type"> <span class="param-type">String</span> </td> <td class="description last"><p>可选项,z轴最小坐标。</p></td> </tr> <tr class="deep-level-0"> <td class="name" id="query.zmax"><code>query.zmax</code></td> <td class="type"> <span class="param-type">String</span> </td> <td class="description last"><p>可选项,z轴最小坐标。</p></td> </tr> <tr class="deep-level-0"> <td class="name" id="query.mmin"><code>query.mmin</code></td> <td class="type"> <span class="param-type">String</span> </td> <td class="description last"><p>可选项,m轴最小坐标。</p></td> </tr> <tr class="deep-level-0"> <td class="name" id="query.mmax"><code>query.mmax</code></td> <td class="type"> <span class="param-type">String</span> </td> <td class="description last"><p>可选项,m轴最小坐标。</p></td> </tr> </tbody> </table> </div> <dl class="details"> <dt class="tag-author">作者:</dt> <dd class="tag-author"> <ul> <li>基础平台-杨琨</li> </ul> </dd> </dl> </div> </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="#centerAt">centerAt</a></code></td> <td class="name"> <code> </code> </td> <td class="name"><code><p>根据输入的ArcGisPoint对象,生成衣蛾新的中心点</p></code></td> </tr> <tr class="deep-level-0"> <td class="name"><code><a href="#contains">contains</a></code></td> <td class="name"> <code> </code> </td> <td class="name"><code><p>判断是否包含一个点或者一个ArcGisExtent对象</p></code></td> </tr> <tr class="deep-level-0"> <td class="name"><code><a href="#equals">equals</a></code></td> <td class="name"> <code> </code> </td> <td class="name"><code><p>比较两个Extent对象是否相等</p></code></td> </tr> <tr class="deep-level-0"> <td class="name"><code><a href="#expand">expand</a></code></td> <td class="name"> <code> </code> </td> <td class="name"><code><p>根据输入的值,扩大或缩小一个ArcGisExtent</p></code></td> </tr> <tr class="deep-level-0"> <td class="name"><code><a href="#intersects">intersects</a></code></td> <td class="name"> <code> </code> </td> <td class="name"><code><p>比较点、多点、线、多边形、extent是否与当前extent相交</p></code></td> </tr> <tr class="deep-level-0"> <td class="name"><code><a href="#offset">offset</a></code></td> <td class="name"> <code> </code> </td> <td class="name"><code><p>根据输入的dx, dy, dz值,平移extend</p></code></td> </tr> <tr class="deep-level-0"> <td class="name"><code><a href="#toString">toString</a></code></td> <td class="name"> <code> </code> </td> <td class="name"><code><p>返回如下格式的字符串:&quot;xmin,ymin,xmax,ymax&quot;</p></code></td> </tr> <tr class="deep-level-0"> <td class="name"><code><a href="#union">union</a></code></td> <td class="name"> <code> </code> </td> <td class="name"><code><p>输入一个ArcGisExtent对象,与原extent对象合并,生成一个新的extent</p></code></td> </tr> </tbody> </table> </div> <h4 style="margin-top: 20px;margin-bottom: 20px;">方法详情</h4> <div class="member"> <h4 class="name" id="centerAt"> <a class="href-link" href="#centerAt">#</a> <span class="code-name" id="centerAt" style="font-size:30px"> centerAt<span class="signature">(point)</span> </span> </h4> <div class="description"> <p>根据输入的ArcGisPoint对象,生成衣蛾新的中心点</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="point"><code>point</code></td> <td class="type"> <span class="param-type">ArcGisPoint</span> </td> <td class="description last"><p>必选项,新的中心点。</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>ArcGisExtent</p></div> </div> </div> </div> </div> <div class="member"> <h4 class="name" id="contains"> <a class="href-link" href="#contains">#</a> <span class="code-name" id="contains" style="font-size:30px"> contains<span class="signature">(geometry)</span> </span> </h4> <div class="description"> <p>判断是否包含一个点或者一个ArcGisExtent对象</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="geometry"><code>geometry</code></td> <td class="type"> <span class="param-type"><a link="Geometry.html" onclick="getTypeHTML(event)" class="mapgis-link-name" title="Geometry" Geometry.html>Geometry</a></span> </td> <td class="description last"><p>必选项,要比较的ArcGisExtent对象或者ArcGisPoint对象。</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>Boolean,是否包含</p></div> </div> </div> </div> </div> <div class="member"> <h4 class="name" id="equals"> <a class="href-link" href="#equals">#</a> <span class="code-name" id="equals" style="font-size:30px"> equals<span class="signature">(extent)</span> </span> </h4> <div class="description"> <p>比较两个Extent对象是否相等</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="extent"><code>extent</code></td> <td class="type"> <span class="param-type">ArcGisExtent</span> </td> <td class="description last"><p>必选项,要比较的ArcGisExtent对象。</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>Boolean,对象是否相等</p></div> </div> </div> </div> </div> <div class="member"> <h4 class="name" id="expand"> <a class="href-link" href="#expand">#</a> <span class="code-name" id="expand" style="font-size:30px"> expand<span class="signature">(factor)</span> </span> </h4> <div class="description"> <p>根据输入的值,扩大或缩小一个ArcGisExtent</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="factor"><code>factor</code></td> <td class="type"> <span class="param-type">Number</span> </td> <td class="description last"><p>必选项,放大或缩小系数。</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>ArcGisExtent,缩放后的ArcGisExtent</p></div> </div> </div> </div> </div> <div class="member"> <h4 class="name" id="intersects"> <a class="href-link" href="#intersects">#</a> <span class="code-name" id="intersects" style="font-size:30px"> intersects<span class="signature">(geometry)</span> </span> </h4> <div class="description"> <p>比较点、多点、线、多边形、extent是否与当前extent相交</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="geometry"><code>geometry</code></td> <td class="type"> <span class="param-type"><a link="Geometry.html" onclick="getTypeHTML(event)" class="mapgis-link-name" title="Geometry" Geometry.html>Geometry</a></span> </td> <td class="description last"><p>必选项,要比较的几何对象。</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>Boolean,是否相交</p></div> </div> </div> </div> </div> <div class="member"> <h4 class="name" id="offset"> <a class="href-link" href="#offset">#</a> <span class="code-name" id="offset" style="font-size:30px"> offset<span class="signature">(dx, dx, dx)</span> </span> </h4> <div class="description"> <p>根据输入的dx, dy, dz值,平移extend</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="dx"><code>dx</code></td> <td class="type"> <span class="param-type">Number</span> </td> <td class="description last"><p>必选项,要平移的x值。</p></td> </tr> <tr class="deep-level-0"> <td class="name" id="dx"><code>dx</code></td> <td class="type"> <span class="param-type">Number</span> </td> <td class="description last"><p>必选项,要平移的y值。</p></td> </tr> <tr class="deep-level-0"> <td class="name" id="dx"><code>dx</code></td> <td class="type"> <span class="param-type">Number</span> </td> <td class="description last"><p>必选项,要平移的z值。</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>ArcGisExtent,平移后的ArcGisExtent对象</p></div> </div> </div> </div> </div> <div class="member"> <h4 class="name" id="toString"> <a class="href-link" href="#toString">#</a> <span class="code-name" id="toString" style="font-size:30px"> toString<span class="signature">()</span> </span> </h4> <div class="description"> <p>返回如下格式的字符串:&quot;xmin,ymin,xmax,ymax&quot;</p> </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>Sting</p></div> </div> </div> </div> </div> <div class="member"> <h4 class="name" id="union"> <a class="href-link" href="#union">#</a> <span class="code-name" id="union" style="font-size:30px"> union<span class="signature">(extent)</span> </span> </h4> <div class="description"> <p>输入一个ArcGisExtent对象,与原extent对象合并,生成一个新的extent</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="extent"><code>extent</code></td> <td class="type"> <span class="param-type">ArcGisExtent</span> </td> <td class="description last"><p>必选项,要合并的ArcGisExtent对象。</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>ArcGisExtent,新的Extent对象</p></div> </div> </div> </div> </div> </div> </div> </article> </section>