UNPKG

@mapgis/webclient-common

Version:

mapgis ES6 format for igserver

1,888 lines (616 loc) 25.2 kB
<header id="page-title" class="page-title"> <span class="page-title-main">类名</span> <span class="page-title-sub">SpatialReference</span> </header> <section> <article> <div class="container-overview"> <div class='vertical-section'> <div class="members"> <div class="member"> <h4 class="name" id="SpatialReference"> <a class="href-link" href="#SpatialReference">#</a> <span class="code-name" id="SpatialReference" style="font-size:30px"> new SpatialReference<span class="signature">(options)</span> </span> </h4> <div class="description"> <p>空间参考系 <br><br>[ES5引入方式]:<br/> zondy.SpatialReference() <br/> [ES6引入方式]:<br/> import { SpatialReference } from &quot;@mapgis/webclient-common&quot; <br/> <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"><code>options</code></td> <td class="type"> <span class="param-type"> Object </span> | <span class="param-type"> String </span> </td> <td class="description last"><p>构造参数</p></td> </tr> <tr class="deep-level-1"> <td class="name"><code>wkid</code></td> <td class="type"> <span class="param-type"> Number </span> | <span class="param-type"> undefined </span> </td> <td class="description last"><p>空间参考系的wkid</p></td> </tr> <tr class="deep-level-1"> <td class="name"><code>wkt</code></td> <td class="type"> <span class="param-type"> String </span> | <span class="param-type"> undefined </span> </td> <td class="description last"><p>空间参考系Well Known Text 或 proj4js字符串,仅支持proj4js能够支持的字符串。OGC WKT标准<a href="https://www.ogc.org/standard/wkt-crs/">https://www.ogc.org/standard/wkt-crs/</a>, EPSG坐标系查询<a href="https://epsg.io/">https://epsg.io/</a></p></td> </tr> <tr class="deep-level-1"> <td class="name"><code>unit</code></td> <td class="type"> <span class="param-type"> String </span> | <span class="param-type"> undefined </span> </td> <td class="description last"><p>空间参考系单位</p></td> </tr> </tbody> </table> </div> <dl class="details"> </dl> </div> </div> </div> </div> <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="#isGeographic">isGeographic</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="#isWebMercator">isWebMercator</a></code></td> <td class="name"> <code> <span class="param-type"> Boolean </span> </code> </td> <td class="name"><code><p>是否是Web墨卡托坐标系</p></code></td> </tr> <tr class="deep-level-0"> <td class="name"><code><a href="#isWGS84">isWGS84</a></code></td> <td class="name"> <code> <span class="param-type"> Boolean </span> </code> </td> <td class="name"><code><p>是否是WGS84相关坐标系</p></code></td> </tr> <tr class="deep-level-0"> <td class="name"><code><a href="#isWrappable">isWrappable</a></code></td> <td class="name"> <code> <span class="param-type"> Boolean </span> </code> </td> <td class="name"><code><p>坐标系否支持环绕国际日期线,当参考系是Web Mercator或WGS84</p></code></td> </tr> <tr class="deep-level-0"> <td class="name"><code><a href="#unit">unit</a></code></td> <td class="name"> <code> <span class="param-type"> String </span> | <span class="param-type"> undefined </span> </code> </td> <td class="name"><code><p>投影坐标系的描述</p></code></td> </tr> <tr class="deep-level-0"> <td class="name"><code><a href="#WebMercator">WebMercator</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>一个便捷的Web墨卡托对象,只有当类型为Web墨卡托时才有</p></code></td> </tr> <tr class="deep-level-0"> <td class="name"><code><a href="#WGS84">WGS84</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>一个便捷的WGS84对象,只有当类型为WGS84时才有</p></code></td> </tr> <tr class="deep-level-0"> <td class="name"><code><a href="#wkid">wkid</a></code></td> <td class="name"> <code> <span class="param-type"> Number </span> </code> </td> <td class="name"><code><p>投影坐标系的id</p></code></td> </tr> <tr class="deep-level-0"> <td class="name"><code><a href="#wkt">wkt</a></code></td> <td class="name"> <code> <span class="param-type"> String </span> | <span class="param-type"> undefined </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"> Boolean </span> </span> <h4 class="name" id="isGeographic"> <a class="href-link" href="#isGeographic">#</a> <span class='tag'>readonly</span> <span class="code-name"> isGeographic </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="isWebMercator"> <a class="href-link" href="#isWebMercator">#</a> <span class='tag'>readonly</span> <span class="code-name"> isWebMercator </span> </h4> <div class="description"> <p>是否是Web墨卡托坐标系</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="isWGS84"> <a class="href-link" href="#isWGS84">#</a> <span class='tag'>readonly</span> <span class="code-name"> isWGS84 </span> </h4> <div class="description"> <p>是否是WGS84相关坐标系</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="isWrappable"> <a class="href-link" href="#isWrappable">#</a> <span class='tag'>readonly</span> <span class="code-name"> isWrappable </span> </h4> <div class="description"> <p>坐标系否支持环绕国际日期线,当参考系是Web Mercator或WGS84</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 class="param-type"> undefined </span> </span> <h4 class="name" id="unit"> <a class="href-link" href="#unit">#</a> <span class="code-name"> unit </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="WebMercator"> <a class="href-link" href="#WebMercator">#</a> <span class='tag'>readonly</span> <span class="code-name"> WebMercator </span> </h4> <div class="description"> <p>一个便捷的Web墨卡托对象,只有当类型为Web墨卡托时才有</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="WGS84"> <a class="href-link" href="#WGS84">#</a> <span class='tag'>readonly</span> <span class="code-name"> WGS84 </span> </h4> <div class="description"> <p>一个便捷的WGS84对象,只有当类型为WGS84时才有</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="wkid"> <a class="href-link" href="#wkid">#</a> <span class="code-name"> wkid </span> </h4> <div class="description"> <p>投影坐标系的id</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 class="param-type"> undefined </span> </span> <h4 class="name" id="wkt"> <a class="href-link" href="#wkt">#</a> <span class="code-name"> wkt </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> </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="Geometry.html" onclick="getTypeHTML(event)" href="Geometry.html">Geometry</a> </span> </code> </td> <td class="name"><code><p>克隆几何对象</p></code></td> </tr> <tr class="deep-level-0"> <td class="name"><code><a href="#equals">equals</a></code></td> <td class="name"> <code> <span class="param-type"> Boolean </span> </code> </td> <td class="name"><code><p>判断坐标系对象的wkid和wkt的值是否相等</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"> </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="Geometry.html" onclick="getTypeHTML(event)" href="Geometry.html">Geometry</a> </span> </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">(spatialReference)</span> </span> </h4> <div class="description"> <p>判断坐标系对象的wkid和wkt的值是否相等</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>spatialReference</code></td> <td class="type"> <span class="param-type"> <a link="SpatialReference.html" onclick="getTypeHTML(event)" href="SpatialReference.html">SpatialReference</a> </span> | <span class="param-type"> Object </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>wkid和wkt的值是否相等</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="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"> </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>