@mapgis/webclient-common
Version:
mapgis ES6 format for igserver
3,928 lines • 65.1 kB
HTML
<header id="page-title" class="page-title">
<span class="page-title-main">类名</span>
<span class="page-title-sub">MultiPolygon</span>
</header>
<section>
<article>
<div class="container-overview">
<div class='vertical-section'>
<div class="members">
<div class="member">
<h4 class="name" id="MultiPolygon">
<a class="href-link" href="#MultiPolygon">#</a>
<span class="code-name" id="MultiPolygon" style="font-size:30px">
new MultiPolygon<span class="signature">(options)</span>
</span>
</h4>
<div class="description">
<p>多区几何
<br><br>[ES5引入方式]：<br/>
Zondy.Geometry.MultiPolygon() <br/>
[ES6引入方式]：<br/>
import { MultiPolygon } from "@mapgis/webclient-common" <br/>
<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="options"><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" id="coordinates"><code>coordinates</code></td>
<td class="type">
<span class="param-type">Array</span>
</td>
<td class="default">
[]
</td>
<td class="description last"><p>几何点的坐标数组，参考示例：<a href='#MultiPolygon'>[多区几何对象]</a></p></td>
</tr>
<tr class="deep-level-1">
<td class="name" id="spatialReference"><code>spatialReference</code></td>
<td class="type">
<span class="param-type"><a class="mapgis-link-name" title="SpatialReference" SpatialReference.html>SpatialReference</a></span>
</td>
<td class="default">
new Zondy.SpatialReference('EPSG:4326')
</td>
<td class="description last"><p>几何点的空间参考系，默认4326，当不是4326时请指定坐标系，方便进行投影转换，参考示例：<a href='#SpatialReference'>[指定坐标系]</a></p></td>
</tr>
</tbody>
</table>
</div>
<dl class="details">
</dl>
<p class="summary"><h5>支持如下方法：</h5>
<a href='#addPolygon'>[1、在多区末尾添加区]</a><br/>
<a href='#removePolygon'>[2、根据区几何的下标删除的区对象]</a><br/>
<a href='#toXMl'>[3、导出为OGC服务要求的xml字符串]</a><br/>
<a href='#contains'>[4、检查输入点是否在多边形内]</a><br/>
<a href='#toString'>[5、返回字符串]</a><br/>
<a href='#toOldIGSGeometry'>[6、返回igs1.0的几何对象]</a><br/>
<a href='#getIGSType'>[7、返回IGS所对应的GeometryModule型]</a><br/>
<a href='#fromJSON'>[8、通过传入的json构造并返回一个新的几何对象]</a><br/>
<a href='#toJSON'>[9、导出为json对象]</a><br/>
<a class="mapgis-link-name" title="Geometry#clone" Geometry.html#clone><code>10、克隆几何对象</code></a></p>
<h5>示例</h5>
<p class="code-caption"><h7 id='MultiPolygon'>创建几何对象</h7></p>
<pre class="prettyprint"><code>// ES5引入方式
const { MultiPolygon } = Zondy.Geometry
// ES6引入方式
import { MultiPolygon } from "@mapgis/webclient-common"
new MultiPolygon({
coordinates: [
// 第一个区
[
// 外圈
[
// 区要首尾相连
[102.0, 2.0],
[103.0, 2.0],
[103.0, 3.0],
[102.0, 3.0],
[102.0, 2.0]
],
// 第一个内圈
[],
// 第二个内圈
[],
...
],
// 第二个区
[
// 外圈
[
[100.0, 0.0],
[101.0, 0.0],
[101.0, 1.0],
[100.0, 1.0],
[100.0, 0.0]
],
// 第一个内圈
[
[100.2, 0.2],
[100.2, 0.8],
[100.8, 0.8],
[100.8, 0.2],
[100.2, 0.2]
]
]
]
})</code></pre>
<p class="code-caption"><h7 id='spatialReference'>指定坐标系</h7></p>
<pre class="prettyprint"><code>// ES5引入方式
const { MultiPolygon } = Zondy.Geometry
const { SpatialReference } = Zondy.SpatialReference
// ES6引入方式
import { MultiPolygon, SpatialReference } from "@mapgis/webclient-common"
new MultiPolygon({
coordinates: [
// 第一个区
[
// 外圈
[
// 区要首尾相连
[12060733.232006868, 3377247.5680546067],
[12929863.44711455, 3377247.5680546067],
[12929863.44711455, 3934286.575385226],
[12060733.232006868, 3934286.575385226],
[12060733.232006868, 3377247.5680546067]
]
],
// 第二个区
[
// 外圈
[
[12060733.232006868, 3377247.5680546067],
[12929863.44711455, 3377247.5680546067],
[12929863.44711455, 3934286.575385226],
[12060733.232006868, 3934286.575385226],
[12060733.232006868, 3377247.5680546067]
]
]
],
// 当不是4326时请指定坐标系，方便进行投影转换
spatialReference: new SpatialReference('EPSG:3857')
})</code></pre>
</div>
</div>
</div>
</div>
<h3 class="subsection-title">继承关系</h3>
<ul>
<li><a class="mapgis-link-name" title="Geometry" Geometry.html>Geometry</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="MultiPolygon.html#coordinates">coordinates</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="MultiPolygon.html#extent">extent</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="MultiPolygon.html#hasZ">hasZ</a></code></td>
<td class="name">
<code>
<span class="param-type">Boolean</span>
</code>
</td>
<td class="name"><code><p>是否含有z坐标</p></code></td>
</tr>
<tr class="deep-level-0">
<td class="name"><code><a href="MultiPolygon.html#spatialReference">spatialReference</a></code></td>
<td class="name">
<code>
<span class="param-type"><a class="mapgis-link-name" title="SpatialReference" SpatialReference.html>SpatialReference</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">Array</span>
</span>
<h4 class="name" id="coordinates">
<a class="href-link" href="#coordinates">#</a>
<span class="code-name">
coordinates
</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="extent">
<a class="href-link" href="#extent">#</a>
<span class="code-name">
extent
</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="Geometry#extent" Geometry.html#extent>Geometry#extent</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="hasZ">
<a class="href-link" href="#hasZ">#</a>
<span class='tag'>readonly</span>
<span class="code-name">
hasZ
</span>
</h4>
<div class="description">
<p>是否含有z坐标</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="Geometry#hasZ" Geometry.html#hasZ>Geometry#hasZ</a>
</li></ul></dd>
</dl>
</div>
<div class="member">
<span class="method-parameter is-pulled-right">
<label>类型:</label>
<span class="param-type"><a 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="inherited-from">Inherited From:</dt>
<dd class="inherited-from"><ul class="dummy"><li>
<a class="mapgis-link-name" title="Geometry#spatialReference" Geometry.html#spatialReference>Geometry#spatialReference</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="MultiPolygon.html#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="MultiPolygon.html#addPolygon">addPolygon</a></code></td>
<td class="name">
<code>
<span class="param-type"><a class="mapgis-link-name" title="MultiPolygon" MultiPolygon.html>MultiPolygon</a></span>
</code>
</td>
<td class="name"><code><p>在多区末尾添加区</p></code></td>
</tr>
<tr class="deep-level-0">
<td class="name"><code><a href="MultiPolygon.html#clone">clone</a></code></td>
<td class="name">
<code>
<span class="param-type"><a class="mapgis-link-name" title="Geometry" 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="MultiPolygon.html#contains">contains</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="MultiPolygon.html#fromGeoJSON">fromGeoJSON</a></code></td>
<td class="name">
<code>
</code>
</td>
<td class="name"><code><p>导入GeoJSON</p></code></td>
</tr>
<tr class="deep-level-0">
<td class="name"><code><a href="MultiPolygon.html#getGeometryType">getGeometryType</a></code></td>
<td class="name">
<code>
<span class="param-type">String</span>
</code>
</td>
<td class="name"><code><p>获取GeometryModule型</p></code></td>
</tr>
<tr class="deep-level-0">
<td class="name"><code><a href="MultiPolygon.html#getIGSType">getIGSType</a></code></td>
<td class="name">
<code>
</code>
</td>
<td class="name"><code><p>返回IGS所对应的GeometryModule型<a id='getIGSType'></a></p></code></td>
</tr>
<tr class="deep-level-0">
<td class="name"><code><a href="MultiPolygon.html#getType">getType</a></code></td>
<td class="name">
<code>
<span class="param-type">String</span>
</code>
</td>
<td class="name"><code><p>返回所对应的GeometryModule型</p></code></td>
</tr>
<tr class="deep-level-0">
<td class="name"><code><a href="MultiPolygon.html#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="MultiPolygon.html#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="MultiPolygon.html#removePolygon">removePolygon</a></code></td>
<td class="name">
<code>
<span class="param-type"><a class="mapgis-link-name" title="Polygon" Polygon.html>Polygon</a></span>
|
<span class="param-type">null</span>
</code>
</td>
<td class="name"><code><p>根据区几何的下标删除的区对象</p></code></td>
</tr>
<tr class="deep-level-0">
<td class="name"><code><a href="MultiPolygon.html#toGeoJSON">toGeoJSON</a></code></td>
<td class="name">
<code>
<span class="param-type">Object</span>
</code>
</td>
<td class="name"><code><p>导出为GeoJSON</p></code></td>
</tr>
<tr class="deep-level-0">
<td class="name"><code><a href="MultiPolygon.html#toJSON">toJSON</a></code></td>
<td class="name">
<code>
<span class="param-type">Object</span>
</code>
</td>
<td class="name"><code><p><a id='toJSON'></a>
导出为json对象</p></code></td>
</tr>
<tr class="deep-level-0">
<td class="name"><code><a href="MultiPolygon.html#toOldIGSGeometry">toOldIGSGeometry</a></code></td>
<td class="name">
<code>
</code>
</td>
<td class="name"><code><p>返回igs1.0的几何对象<a id='toOldIGSGeometry'></a></p></code></td>
</tr>
<tr class="deep-level-0">
<td class="name"><code><a href="MultiPolygon.html#toPolygonArray">toPolygonArray</a></code></td>
<td class="name">
<code>
<span class="param-type">Array.<<a href="Polygon.html">Polygon</a>></span>
</code>
</td>
<td class="name"><code><p>多区对象转区对象数组</p></code></td>
</tr>
<tr class="deep-level-0">
<td class="name"><code><a href="MultiPolygon.html#toString">toString</a></code></td>
<td class="name">
<code>
</code>
</td>
<td class="name"><code><p>返回如下格式的字符串："x0,y0,x1,y1,x2,y2,x0,y0|x3,y3,x4,y4,x5,y5,x3,y3;x6,y6,x7,y7,x8,y8,x6,y6|x9,y9,x10,y10,x11,y11,x9,y9"<a id='toString'></a>
多边形内每个的多边形由|号分割，多个多边形由;号分割</p></code></td>
</tr>
<tr class="deep-level-0">
<td class="name"><code><a href="MultiPolygon.html#toXMl">toXMl</a></code></td>
<td class="name">
<code>
<span class="param-type">String</span>
</code>
</td>
<td class="name"><code><p>导出为OGC服务要求的xml字符串<a id='toXMl'></a></p></code></td>
</tr>
<tr class="deep-level-0">
<td class="name"><code><a href="MultiPolygon.html#toXML">toXML</a></code></td>
<td class="name">
<code>
<span class="param-type">String</span>
</code>
</td>
<td class="name"><code><p>导出为OGC服务要求的xml字符串，子类实现</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 class="signature-attributes">opt</span>)</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" id="json"><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>
<h5>示例</h5>
<p class="code-caption"><h7 id='fromJSON'>通过传入的json构造并返回一个新的几何对象</h7></p>
<pre class="prettyprint"><code>// ES5引入方式
const { MultiPolygon } = Zondy.Geometry
// ES6引入方式
import { MultiPolygon } from "@mapgis/webclient-common"
const json = {
coordinates: [
// 第一个区
[
// 外圈
[
// 区要首尾相连
[102.0, 2.0],
[103.0, 2.0],
[103.0, 3.0],
[102.0, 3.0],
[102.0, 2.0]
]
]
]
}
const multiPolygon = new MultiPolygon.fromJSON(json)</code></pre>
</div>
<div class="member">
<h4 class="name" id="addPolygon">
<a class="href-link" href="#addPolygon">#</a>
<span class="code-name" id="addPolygon" style="font-size:30px">
addPolygon<span class="signature">(polygon, mode<span class="signature-attributes">opt</span>)</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" id="polygon"><code>polygon</code></td>
<td class="type">
<span class="param-type"><a class="mapgis-link-name" title="Polygon" Polygon.html>Polygon</a></span>
</td>
<td class="default">
</td>
<td class="description last"><p>要添加区几何对象</p></td>
</tr>
<tr class="deep-level-0">
<td class="name" id="mode"><code>mode</code></td>
<td class="type">
<span class="param-type">String</span>
</td>
<td class="default">
'add'
</td>
<td class="description last"><p>添加模式，add:正常添加，deduplication:去除重复点，即当新加的区几何和现有的一个或多个几何相交时，会合并几何对象</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>表示给定范围的多边形实例</p></div>
<div class='column is-5 has-text-left'>
<label>类型: </label>
<span class="param-type"><a class="mapgis-link-name" title="MultiPolygon" MultiPolygon.html>MultiPolygon</a></span>
</div>
</div>
</div>
</div>
<h5>示例</h5>
<p class="code-caption"><h7 id='addPolygon'>在多区末尾添加区</h7></p>
<pre class="prettyprint"><code>// ES5引入方式
const { MultiPolygon, Polygon } = Zondy.Geometry
// ES6引入方式
import { MultiPolygon, Polygon } from "@mapgis/webclient-common"
const multiPolygon = new MultiPolygon({
coordinates: [
// 第一个区
[
// 外圈
[
// 区要首尾相连
[102.0, 2.0],
[103.0, 2.0],
[103.0, 3.0],
[102.0, 3.0],
[102.0, 2.0]
]
]
]
})
const polygon = new Polygon({
coordinates:[
// 外圈
[
[100.0, 0.0],
[101.0, 0.0],
[101.0, 1.0],
[100.0, 1.0],
[100.0, 0.0]
]
]
})
multiPolygon.addPolygon(polygon)</code></pre>
</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 class="mapgis-link-name" title="Geometry#clone" Geometry.html#clone>Geometry#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 class="mapgis-link-name" title="Geometry" Geometry.html>Geometry</a></span>
</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">(point)</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="point"><code>point</code></td>
<td class="type">
<span class="param-type"><a class="mapgis-link-name" title="Point" Point.html>Point</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>如果该点位于多边形内，则返回true</p></div>
<div class='column is-5 has-text-left'>
<label>类型: </label>
<span class="param-type">Boolean</span>
</div>
</div>
</div>
</div>
<h5>示例</h5>
<p class="code-caption"><h7 id='contains'>检查输入点是否在多边形内</h7></p>
<pre class="prettyprint"><code>// ES5引入方式
const { MultiPolygon, Point } = Zondy.Geometry
// ES6引入方式
import { MultiPolygon, Point } from "@mapgis/webclient-common"
const multiPolygon = new MultiPolygon({
coordinates: [
// 第一个区
[
// 外圈
[
// 区要首尾相连
[102.0, 2.0],
[103.0, 2.0],
[103.0, 3.0],
[102.0, 3.0],
[102.0, 2.0]
]
]
]
})
const point = new Point({
coordinates: [100.0, 0.0]
})
const isIn = multiPolygon.contains(point)</code></pre>
</div>
<div class="member">
<h4 class="name" id="fromGeoJSON">
<a class="href-link" href="#fromGeoJSON">#</a>
<span class="code-name" id="fromGeoJSON" style="font-size:30px">
fromGeoJSON<span class="signature">(GeoJSON)</span>
</span>
</h4>
<div class="description">
<p>导入GeoJSON</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="GeoJSON"><code>GeoJSON</code></td>
<td class="type">
<span class="param-type">Object</span>
</td>
<td class="description last"><p>Object</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 class="mapgis-link-name" title="Geometry#fromGeoJSON" Geometry.html#fromGeoJSON>Geometry#fromGeoJSON</a>
</li></ul></dd>
</dl>
</div>
<div class="member">
<h4 class="name" id="getGeometryType">
<a class="href-link" href="#getGeometryType">#</a>
<span class="code-name" id="getGeometryType" style="font-size:30px">
getGeometryType<span class="signature">()</span>
</span>
</h4>
<div class="description">
<p>获取GeometryModule型</p>
</div>
<dl class="details">
<dt class="inherited-from">Inherited From:</dt>
<dd class="inherited-from"><ul class="dummy"><li>
<a class="mapgis-link-name" title="Geometry#getGeometryType" Geometry.html#getGeometryType>Geometry#getGeometryType</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>GeometryModule型</p></div>
<div class='column is-5 has-text-left'>
<label>类型: </label>
<span class="param-type">String</span>
</div>
</div>
</div>
</div>
</div>
<div class="member">
<h4 class="name" id="getIGSType">
<a class="href-link" href="#getIGSType">#</a>
<span class="code-name" id="getIGSType" style="font-size:30px">
getIGSType<span class="signature">()</span>
</span>
</h4>
<div class="description">
<p>返回IGS所对应的GeometryModule型<a id='getIGSType'></a></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="Geometry#getIGSType" Geometry.html#getIGSType>Geometry#getIGSType</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>string GeometryModule型</p></div>
</div>
</div>
</div>
</div>
<div class="member">
<h4 class="name" id="getType">
<a class="href-link" href="#getType">#</a>
<span class="code-name" id="getType" style="font-size:30px">
getType<span class="signature">()</span>
</span>
</h4>
<div class="description">
<p>返回所对应的GeometryModule型</p>
</div>
<dl class="details">
<dt class="inherited-from">Inherited From:</dt>
<dd class="inherited-from"><ul class="dummy"><li>
<a class="mapgis-link-name" title="Geometry#getType" Geometry.html#getType>Geometry#getType</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>GeometryModule型</p></div>
<div class='column is-5 has-text-left'>
<label>类型: </label>
<span class="param-type">String</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 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 class="mapgis-link-name" title="Evented#on" Evented.html#on>Evented#on</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='event1'>注册一个事件</h5></p>
<pre class="prettyprint"><code>// 初始化一个点击事件回调函数
const clickFunction = function (event) {
console.log("点击事件:", event)
}
// 调用MapView或SceneView的on方法注册一个点击事件
view.on('click', clickFunction)</code></pre>
<p class="code-caption"><h5 id='event2'>一次注册多个事件 - 同一个回调函数</h5></p>
<pre class="prettyprint"><code>// 初始化一个事件回调函数
const eventFunction = function (event) {
console.log("事件:", event)
}
// 调用MapView或SceneView的on方法注册多个事件
// 多个事件类型使用同一个回调函数
view.on('click right-click-down', eventFunction)</code></pre>
<p class="code-caption"><h5 id='event3'>一次注册多个事件 - 分别指回调应函数</h5></p>
<pre class="prettyprint"><code>// 初始化一个左键点击事件回调函数
const clickFunction = function (event) {
console.log("click事件:", event)
}
// 初始化一个右键按下事件回调函数
const rightClickFunction = function (event) {
console.log("right-click-down事件:", event)
}
// 调用MapView或SceneView的on方法注册多个事件
// 每一个事件类型，使用单独的回调函数
// 注意使用此种方式，一种类型的事件仅能指定一个回调函数
view.on({
"click": clickFunction,
"right-click-down": rightClickFunction
})</code></pre>
<p class="code-caption"><h5 id='event4'>指定上下文 - types类型为字符串</h5></p>
<pre class="prettyprint"><code>// 初始化一个点击事件回调函数
const clickFunction = function (event) {
console.log("点击事件:", event)
console.log("上下文对象:", this)
}
// 调用MapView或SceneView的on方法注册一个点击事件
// 指定view为回调函数的上下文对象
view.on('click', clickFunction, view)</code></pre>
<p class="code-caption"><h5 id='event5'>指定上下文 - types类型为对象</h5></p>
<pre class="prettyprint"><code>// 初始化一个点击事件回调函数
const clickFunction = function (event) {
console.log("点击事件:", event)
console.log("上下文对象:", this)
}
// 调用MapView或SceneView的on方法注册一个点击事件
// 指定view为回调函数的上下文对象
view.on({
"click": clickFunction,
"right-click-down": clickFunction
}, view)</code></pre>
</div>
<div class="member">
<h4 class="name" id="removePolygon">
<a class="href-link" href="#removePolygon">#</a>
<span class="code-name" id="removePolygon" style="font-size:30px">
removePolygon<span class="signature">(polygonIndex)</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="polygonIndex"><code>polygonIndex</code></td>
<td class="type">
<span class="param-type">Number</span>
</td>
<td class="description last"></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>返回删除的区对象</p></div>
<div class='column is-5 has-text-left'>
<label>类型: </label>
<span class="param-type"><a class="mapgis-link-name" title="Polygon" Polygon.html>Polygon</a></span>
|
<span class="param-type">null</span>
</div>
</div>
</div>
</div>
<h5>示例</h5>
<p class="code-caption"><h7 id='removePolygon'>根据区几何的下标删除的区对象</h7></p>
<pre class="prettyprint"><code>// ES5引入方式
const { MultiPolygon } = Zondy.Geometry
// ES6引入方式
import { MultiPolygon } from "@mapgis/webclient-common"
const multiPolygon = new MultiPolygon({
coordinates: [
// 第一个区
[
// 外圈
[
// 区要首尾相连
[102.0, 2.0],
[103.0, 2.0],
[103.0, 3.0],
[102.0, 3.0],
[102.0, 2.0]
]
]
]
})
multiPolygon.removePolygon(0)</code></pre>
</div>
<div class="member">
<h4 class="name" id="toGeoJSON">
<a class="href-link" href="#toGeoJSON">#</a>
<span class="code-name" id="toGeoJSON" style="font-size:30px">
toGeoJSON<span class="signature">()</span>
</span>
</h4>
<div class="description">
<p>导出为GeoJSON</p>
</div>
<dl class="details">
<dt class="inherited-from">Inherited From:</dt>
<dd class="inherited-from"><ul class="dummy"><li>
<a class="mapgis-link-name" title="Geometry#toGeoJSON" Geometry.html#toGeoJSON>Geometry#toGeoJSON</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>GeoJSON对象</p></div>
<div class='column is-5 has-text-left'>
<label>类型: </label>
<span class="param-type">Object</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><a id='toJSON'></a>
导出为json对象</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="Geometry#toJSON" Geometry.html#toJSON>Geometry#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 class="member">
<h4 class="name" id="toOldIGSGeometry">
<a class="href-link" href="#toOldIGSGeometry">#</a>
<span class="code-name" id="toOldIGSGeometry" style="font-size:30px">
toOldIGSGeometry<span class="signature">()</span>
</span>
</h4>
<div class="description">
<p>返回igs1.0的几何对象<a id='toOldIGSGeometry'></a></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>Object igs1.0的几何对象</p></div>
</div>
</div>
</div>
</div>
<div class="member">
<h4 class="name" id="toPolygonArray">
<a class="href-link" href="#toPolygonArray">#</a>
<span class="code-name" id="toPolygonArray" style="font-size:30px">
toPolygonArray<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">Array.<<a href="Polygon.html">Polygon</a>></span>
</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>返回如下格式的字符串："x0,y0,x1,y1,x2,y2,x0,y0|x3,y3,x4,y4,x5,y5,x3,y3;x6,y6,x7,y7,x8,y8,x6,y6|x9,y9,x10,y10,x11,y11,x9,y9"<a id='toString'></a>
多边形内每个的多边形由|号分割，多个多边形由;号分割</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="Geometry#toString" Geometry.html#toString>Geometry#toString</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>string</p></div>
</div>
</div>
</div>
</div>
<div class="member">
<h4 class="name" id="toXMl">
<a class="href-link" href="#toXMl">#</a>
<span class="code-name" id="toXMl" style="font-size:30px">
toXMl<span class="signature">()</span>
</span>
</h4>
<div class="description">
<p>导出为OGC服务要求的xml字符串<a id='toXMl'></a></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">String</span>
</div>
</div>
</div>
</div>
</div>
<div class="member">
<h4 class="name" id="toXML">
<a class="href-link" href="#toXML">#</a>
<span class="code-name" id="toXML" style="font-size:30px">
toXML<span class="signature">()</span>
</span>
</h4>
<div class="description">
<p>导出为OGC服务要求的xml字符串，子类实现</p>
</div>
<dl class="details">
<dt class="inherited-from">Inherited From:</dt>
<dd class="inherited-from"><ul class="dummy"><li>
<a class="mapgis-link-name" title="Geometry#toXML" Geometry.html#toXML>Geometry#toXML</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">String</span>
</div>
</div>
</div>
</div>
</div>
</div>
</div>
</article>
</section>