MapGIS Client for JavaScript API

new MultiPolygon(options)

base/geometry/MultiPolygon.js, line 12

支持如下方法：

[1、在多区末尾添加区]
[2、根据区几何的下标删除的区对象]
[3、导出为OGC服务要求的xml字符串]
[4、检查输入点是否在多边形内]
[5、返回字符串]
[6、返回igs1.0的几何对象]
[7、返回IGS所对应的GeometryModule型]
[8、通过传入的json构造并返回一个新的几何对象]
[9、导出为json对象]
10、克隆几何对象

多区几何

[ES5引入方式]：
zondy.geometry.MultiPolygon()
[ES6引入方式]：
import { MultiPolygon } from "@mapgis/webclient-common"

Name Type Description

options

Object

构造参数

Name	Type	Default	Description
`coordinates`	Array	[]	可选几何点的坐标数组，参考示例：[多区几何对象]
`spatialReference`	SpatialReference	new zondy.SpatialReference('EPSG:4326')	可选几何点的空间参考系，默认4326，当不是4326时请指定坐标系，方便进行投影转换，参考示例：[指定坐标系]

Examples

创建几何对象

// 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]
      ]
    ]
  ]
})

指定坐标系

// 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')
})

Extends

Geometry

Members

coordinatesArray

几何点的坐标

extensionOptionsObject

初始化几何的额外参数，可以通过该参数传入引擎原生的构造参数

Default Value:

extentNumber

外包盒

hasZBoolean

是否含有z坐标

spatialReferenceSpatialReference

几何点的空间参考系

Methods

MultiPolygon.fromJSON(json) base/geometry/MultiPolygon.js, line 351

通过传入的json构造并返回一个新的几何对象

Name	Type	Description
`json`	Object	可选 JSON对象

Example

通过传入的json构造并返回一个新的几何对象

// 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)

addPolygon(polygon, mode){MultiPolygon} base/geometry/MultiPolygon.js, line 200

在多区末尾添加区

Name	Type	Default	Description
`polygon`	Polygon		要添加区几何对象
`mode`	String	'add'	可选添加模式，add:正常添加，deduplication:去除重复点，即当新加的区几何和现有的一个或多个几何相交时，会合并几何对象

Returns:

Type	Description
MultiPolygon	表示给定范围的多边形实例

Example

在多区末尾添加区

// 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)

clone(){Geometry} base/geometry/MultiPolygon.js, line 515

克隆几何对象

Returns:

Type	Description
Geometry	克隆后的几何对象

contains(point){Boolean} base/geometry/MultiPolygon.js, line 318

检查输入点是否在多边形内。多边形线上的一个点被认为是内部

Name	Type	Description
`point`	Point	用于测试是否包含在测试多边形中的点

Returns:

Type	Description
Boolean	如果该点位于多边形内，则返回true

Example

检查输入点是否在多边形内

// 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)

inherited fromGeoJSON(GeoJSON) base/geometry/Geometry.js, line 133

导入GeoJSON

Name	Type	Description
`GeoJSON`	Object	Object

inherited getGeometryType(){String} base/geometry/Geometry.js, line 170

获取GeometryModule型

Returns:

Type	Description
String	GeometryModule型

getIGSType() base/geometry/MultiPolygon.js, line 490

返回IGS所对应的GeometryModule型

Returns:

string GeometryModule型

inherited getType(){String} base/geometry/Geometry.js, line 154

返回所对应的GeometryModule型

Returns:

Type	Description
String	GeometryModule型

inherited off(types, fn, context){Object} base/Evented.js, line 328

移除事件
示例如下:
[1、移除一个事件的指定回调函数]
[2、移除一个事件的所有回调函数]
[3、移除多个事件的同一个指定的回调函数]
[4、移除多个指定事件的回调函数]
[5、删除时指定上下文 - types类型为字符串]
[6、删除时指定上下文 - types类型为对象]

Name	Type	Description
`types`	string	可选移除指定事件类型上绑定的回调函数当类型为字符串时，可以移除单个或多个事件类型绑定的回调函数，单个事件："click"，多个事件：以空格分割:"click double-click"；当types为对象时，使用如下方式移除事件：{'click': onClickFun, 'mouse-move': onMouseMoveFun}
`fn`	function	可选事件回调函数，当types为字符串，且不指定要删除的回调函数时，删除该事件上的所有回调函数
`context`	Object	可选事件回调函数的this关键字将指向的对象

Returns:

Type	Description
Object	当前实例

Examples

移除一个事件的指定回调函数

// 一个事件的回调函数
const clickFunction = function (event) {
  console.log("点击事件:", event)
}
// 调用MapView或SceneView的off方法移除一个事件的回调函数
view.off('click', clickFunction)

移除一个事件的所有回调函数

// 一个事件的回调函数1
const clickFunction1 = function (event) {
  console.log("点击事件1:", event)
}

// 一个事件的回调函数2
const clickFunction2 = function (event) {
  console.log("点击事件2:", event)
}

// 调用MapView或SceneView的off方法移除一个事件的所有回调函数
// 不指定回调函数，则移除该事件上的所有绑定的回调函数
view.off('click')

移除多个事件的同一个指定的回调函数

// 多个事件的同一个回调函数
const eventFunction = function (event) {
  console.log("事件:", event)
}
// 调用MapView或SceneView的off方法移除多个事件的同一个指定的回调函数
view.off('click double-click', eventFunction)

移除多个指定事件的回调函数

// 一个事件的回调函数
const clickFunction = function (event) {
  console.log("click事件:", event)
}
// 调用MapView或SceneView的off方法移除多个指定事件的回调函数
view.off({
   // 移除click事件上一个指定的函数
  "click": clickFunction,
  // 移除double-click上所有指定的函数
  "double-click": undefined
})

删除时指定上下文 - types类型为字符串

// 一个事件的回调函数
const clickFunction = function (event) {
  console.log("点击事件:", event)
}
// 调用MapView或SceneView的off方法移除一个事件的回调函数
view.off('click', clickFunction, view)
// 调用MapView或SceneView的off方法移除一个事件的所有回调函数
view.off('click', undefined, view)

删除时指定上下文 - types类型为对象

// 一个事件的回调函数
const clickFunction = function (event) {
  console.log("click事件:", event)
}
// 调用MapView或SceneView的off方法移除多个指定事件的回调函数
view.off({
   // 移除click事件上一个指定的函数
  "click": clickFunction,
  // 移除double-click上所有指定的函数
  "double-click": undefined
}, view)

inherited on(types, fn, context){Object} base/Evented.js, line 232

注册一个新的监听事件;
示例如下：
[1、注册一个事件]
[2、一次注册多个事件 - 同一个回调函数]
[3、一次注册多个事件 - 分别指回调应函数]
[4、当types为字符串时 - 指定上下文]
[5、当types为对象时 - 指定上下文]

Name	Type	Default	Description
`types`	String \| Object	null	可选事件类型当types为字符串时，可以定义单个或多个事件，单个事件："click"，多个事件：以空格分割:"click double-click"；当types为对象时，使用如下方式指定事件：{'click': onClickFun, 'mouse-move': onMouseMoveFun}
`fn`	function	null	可选事件回调函数
`context`	Object	null	可选事件回调函数的this关键字将指向的对象

Returns:

Type	Description
Object	当前实例

Examples

注册一个事件

// 初始化一个点击事件回调函数
const clickFunction = function (event) {
  console.log("点击事件:", event)
}
// 调用MapView或SceneView的on方法注册一个点击事件
view.on('click', clickFunction)

一次注册多个事件 - 同一个回调函数

// 初始化一个事件回调函数
const eventFunction = function (event) {
  console.log("事件:", event)
}

// 调用MapView或SceneView的on方法注册多个事件
// 多个事件类型使用同一个回调函数
view.on('click right-click-down', eventFunction)

一次注册多个事件 - 分别指回调应函数

// 初始化一个左键点击事件回调函数
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
})

指定上下文 - types类型为字符串

// 初始化一个点击事件回调函数
const clickFunction = function (event) {
  console.log("点击事件:", event)
  console.log("上下文对象:", this)
}
// 调用MapView或SceneView的on方法注册一个点击事件
// 指定view为回调函数的上下文对象
view.on('click', clickFunction, view)

指定上下文 - types类型为对象

// 初始化一个点击事件回调函数
const clickFunction = function (event) {
  console.log("点击事件:", event)
  console.log("上下文对象:", this)
}
// 调用MapView或SceneView的on方法注册一个点击事件
// 指定view为回调函数的上下文对象
view.on({
  "click": clickFunction,
  "right-click-down": clickFunction
}, view)

removePolygon(polygonIndex){Polygon|null} base/geometry/MultiPolygon.js, line 268

根据区几何的下标删除的区对象

Name	Type	Description
`polygonIndex`	Number

Returns:

Type	Description
Polygon \| null	返回删除的区对象

Example

根据区几何的下标删除的区对象

// 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)

inherited toGeoJSON(){Object} base/geometry/Geometry.js, line 122

导出为GeoJSON

Returns:

Type	Description
Object	GeoJSON对象

toJSON(){Object} base/geometry/MultiPolygon.js, line 361

导出为json对象

Returns:

Type	Description
Object	json对象

toOldIGSGeometry() base/geometry/MultiPolygon.js, line 412

返回igs1.0的几何对象

Returns:

Object igs1.0的几何对象

toPolygonArray(){Array.<Polygon>} base/geometry/MultiPolygon.js, line 498

多区对象转区对象数组

Returns:

Type	Description
Array.<Polygon>	区对象数组

toString() base/geometry/MultiPolygon.js, line 373

返回如下格式的字符串："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" 多边形内每个的多边形由|号分割，多个多边形由;号分割

Returns:

string

toXMl(){String} base/geometry/MultiPolygon.js, line 284

导出为OGC服务要求的xml字符串

Returns:

Type	Description
String	字符串

inherited toXML(){String} base/geometry/Geometry.js, line 146

导出为OGC服务要求的xml字符串，子类实现

Returns:

Type	Description
String	字符串

Class: MultiPolygon

new MultiPolygon(options)

支持如下方法：

Examples

Extends

Members

coordinatesArray

extensionOptionsObject

extentNumber

hasZBoolean

spatialReferenceSpatialReference

Methods

MultiPolygon.fromJSON(json)

Example

addPolygon(polygon, mode){MultiPolygon}

Returns:

Example

clone(){Geometry}

Returns:

contains(point){Boolean}

Returns:

Example

inherited fromGeoJSON(GeoJSON)

inherited getGeometryType(){String}

Returns:

getIGSType()

Returns:

inherited getType(){String}

Returns:

inherited off(types, fn, context){Object}

Returns:

Examples

移除一个事件的指定回调函数

移除一个事件的所有回调函数

移除多个事件的同一个指定的回调函数

移除多个指定事件的回调函数

删除时指定上下文 - types类型为字符串

删除时指定上下文 - types类型为对象

inherited on(types, fn, context){Object}

Returns:

Examples

注册一个事件

一次注册多个事件 - 同一个回调函数

一次注册多个事件 - 分别指回调应函数

指定上下文 - types类型为字符串

指定上下文 - types类型为对象

removePolygon(polygonIndex){Polygon|null}

Returns:

Example

inherited toGeoJSON(){Object}

Returns:

toJSON(){Object}

Returns:

toOldIGSGeometry()

Returns:

toPolygonArray(){Array.<Polygon>}

Returns:

toString()

Returns:

toXMl(){String}

Returns:

inherited toXML(){String}

Returns: