MapGIS Client for JavaScript API

new MultiPoint(options)

base/geometry/MultiPoint.js, line 9

多点几何对象。

MultiPoint 用于组织一组离散点坐标，常用于批量点要素表达、几何集合运算和空间分析入参构造。

Name Type Default Description

options

Object

{}

可选

构造参数

Name	Type	Default	Description
`coordinates`	Array.<Number>	[]	可选点坐标数组，元素格式为 `[x, y]` 或 `[x, y, z]`。
`spatialReference`	SpatialReference \| Object		可选空间参考系。未显式指定时沿用几何基类默认值。

Examples

创建多点几何对象

// ES5引入方式
const { MultiPoint } = zondy.geometry

// ES6引入方式
import { MultiPoint } from "@mapgis/webclient-common"
new MultiPoint({
  coordinates:[
    // 第一个点
    [100, 0.0],
    // 第二个点
    [101, 1.0]
  ]
})

指定坐标系

// ES5引入方式
const { MultiPoint } = zondy.geometry
const { SpatialReference } = zondy

// ES6引入方式
import { MultiPoint, SpatialReference } from "@mapgis/webclient-common"
new MultiPoint({
  // 现在为3857坐标系
  coordinates:[
    // 第一个点
    [12929863.44711455, 3934286.575385226],
    // 第二个点
    [12060733.232006868, 3377247.5680546067]
  ],
  // 当不是4326时请指定坐标系，方便进行投影转换
  spatialReference: new SpatialReference('EPSG:3857')
})

Extends

Geometry

Members

coordinatesArray

几何点的坐标

extensionOptionsObject

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

Default Value:

extentNumber

外包盒

hasZBoolean

是否含有z坐标

spatialReferenceSpatialReference

几何点的空间参考系

typeGeometryType

几何类型

Methods

addPoint(point, mode){MultiPoint} base/geometry/MultiPoint.js, line 106

添加点坐标，可以为Point对象、[x, y, z(可选)]数组、Point对象数组、[x, y, z(可选)]对象数组

Name	Type	Default	Description
`point`	Point \| Array.<Number>		可以是point，也可以是表示XY坐标的数字数组
`mode`	String	'add'	可选添加模式，add:正常添加，deduplication:去除重复点

Returns:

Type	Description
MultiPoint	多点对象

Example

添加点坐标

// ES5引入方式
const { MultiPoint } = zondy.geometry

// ES6引入方式
import { MultiPoint } from "@mapgis/webclient-common"
const multiPoint = new MultiPoint({
  coordinates:[
    // 第一个点
    [100, 0.0],
    // 第二个点
    [101, 1.0]
  ]
})
multiPoint.addPoint([102,2.0])

clone(){Geometry} base/geometry/MultiPoint.js, line 497

克隆几何对象

Returns:

Type	Description
Geometry	克隆后的几何对象

contains(point){Boolean} base/geometry/MultiPoint.js, line 222

判断多点对象是否包含某一个点

Name	Type	Description
`point`	Point \| Array.<Number>	点对象

Returns:

Type	Description
Boolean	是否包含

inherited fire(type, data, propagate){Object} base/Evented.js, line 523

激发指定类型的事件

Name	Type	Description
`type`	string	可选事件类型
`data`	Object	可选待传递的数据
`propagate`	Boolean	可选是否传播到父级

Returns:

Type	Description
Object	当前实例

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

导入GeoJSON

Name	Type	Description
`GeoJSON`	Object	Object

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

获取GeometryModule型

Returns:

Type	Description
String	GeometryModule型

getIGSType() base/geometry/MultiPoint.js, line 348

返回IGS所对应的GeometryModule型

Returns:

string GeometryModule型

getPoint(index){Point} base/geometry/MultiPoint.js, line 268

返回指定索引处的点

Name	Type	Description
`index`	Number	点对象

Returns:

Type	Description
Point	在指定下标处的点

Example

返回指定索引处的点

// ES5引入方式
const { MultiPoint } = zondy.geometry

// ES6引入方式
import { MultiPoint } from "@mapgis/webclient-common"
const multiPoint = new MultiPoint({
  coordinates:[
    // 第一个点
    [100, 0.0],
    // 第二个点
    [101, 1.0]
  ]
})
const point = multiPoint.getPoint(0)

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

返回所对应的GeometryModule型

Returns:

Type	Description
String	GeometryModule型

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

移除事件
示例如下:
[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 240

注册一个新的监听事件;
示例如下：
[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)

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

事件监听，仅触发一次

Name	Type	Description
`types`	string	可选将侦听器函数（fn）添加到对象的特定事件类型中。您还可以传递几个空格分隔的类型（例如“click dblclick”），也可以传入例如 {click: onClick, mousemove: onMouseMove}。
`fn`	function	可选侦听器函数
`context`	Object	可选指定侦听器的上下文（this关键字将指向的对象）

Returns:

Type	Description
Object	当前实例

removePoint(index){Point|null} base/geometry/MultiPoint.js, line 299

从多点中移除一个点。索引指定要删除的点

Name	Type	Description
`index`	Number	点对象

Returns:

Type	Description
Point \| null	返回被移除的点

Example

从多点中移除一个点

// ES5引入方式
const { MultiPoint } = zondy.geometry

// ES6引入方式
import { MultiPoint } from "@mapgis/webclient-common"
const multiPoint = new MultiPoint({
  coordinates:[
    // 第一个点
    [100, 0.0],
    // 第二个点
    [101, 1.0]
  ]
})
const point = multiPoint.removePoint(0)

setPoint(index, point){MultiPoint} base/geometry/MultiPoint.js, line 331

更新指定索引处的点

Name	Type	Description
`index`	Number	点在points属性中的索引
`point`	Point \| Array.<Number>	在新位置指定的几何点

Returns:

Type	Description
MultiPoint	返回更新后的多点

Example

更新指定索引处的点

// ES5引入方式
const { MultiPoint } = zondy.geometry

// ES6引入方式
import { MultiPoint } from "@mapgis/webclient-common"
const multiPoint = new MultiPoint({
  coordinates:[
    // 第一个点
    [100, 0.0],
    // 第二个点
    [101, 1.0]
  ]
})
multiPoint.setPoint(1, [103, 3.0])

toDots() base/geometry/MultiPoint.js, line 434

返回Dots对象，仅包括多边形的外圈

Returns:

Array Dots对象

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

导出为GeoJSON

Returns:

Type	Description
Object	GeoJSON对象

toJSON(){Object} base/geometry/MultiPoint.js, line 380

导出为 JSON 对象

Returns:

Type	Description
Object	JSON对象

toOldIGSGeometry() base/geometry/MultiPoint.js, line 391

返回igs1.0的几何对象

Returns:

Object igs1.0的几何对象

toString() base/geometry/MultiPoint.js, line 413

返回如下格式的字符串："x0,y0,x1,y1,x2,y2"

Returns:

string

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

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

Returns:

Type	Description
String	字符串

MultiPoint.fromJSON(json) base/geometry/MultiPoint.js, line 371

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

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

Example

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

// ES5引入方式
const { MultiPoint } = zondy.geometry

// ES6引入方式
import { MultiPoint } from "@mapgis/webclient-common"
const json = {
  coordinates:[
    // 第一个点
    [100, 0.0],
    // 第二个点
    [101, 1.0]
  ]
}
const multiPoint = MultiPoint.fromJSON(json)

Class: MultiPoint

new MultiPoint(options)

Examples

指定坐标系

Extends

Members

coordinatesArray

extensionOptionsObject

extentNumber

hasZBoolean

spatialReferenceSpatialReference

typeGeometryType

Methods

addPoint(point, mode){MultiPoint}

Returns:

Example

clone(){Geometry}

Returns:

contains(point){Boolean}

Returns:

inherited fire(type, data, propagate){Object}

Returns:

inherited fromGeoJSON(GeoJSON)

inherited getGeometryType(){String}

Returns:

getIGSType()

Returns:

getPoint(index){Point}

Returns:

Example

inherited getType(){String}

Returns:

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

Returns:

Examples

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

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

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

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

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

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

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

Returns:

Examples

注册一个事件

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

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

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

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

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

Returns:

removePoint(index){Point|null}

Returns:

Example

setPoint(index, point){MultiPoint}

Returns:

Example

toDots()

Returns:

inherited toGeoJSON(){Object}

Returns:

toJSON(){Object}

Returns:

toOldIGSGeometry()

Returns:

toString()

Returns:

inherited toXML(){String}

Returns:

MultiPoint.fromJSON(json)

Example