Class: Polygon

Polygon

new Polygon(options)

base/geometry/Polygon.js, line 10

支持如下方法：
[1、将给定的Extent转换为多边形实例]
[2、在多边形中添加一个环]
[3、根据索引从多边形中移除一个环]
[4、检查输入点是否在多边形内]
[5、根据下标返回指定的点]
[6、在多边形中插入一个新点]
[7、根据下标从多边形中移除一个点]
[8、导出为OGC服务要求的xml字符串]
[9、返回字符串]
[10、返回igs1.0的几何对象]
[11、返回IGS所对应的GeometryModule型]
[12、返回Dots对象，仅包括多边形的外圈] [13、通过传入的json构造并返回一个新的几何对象]
[14、导出为json对象]
15、克隆几何对象

区几何，由多个环(ring)构成的几何对象，仅支持带洞区和非带洞区，不支持带岛区，即三个圈重叠
多边形的第一个环(ring)即外圈，从第二个环开始为内圈，内圈可以重合、相交、自相交，但是不能超过外圈

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

Name Type Description
options Object

构造参数

Name Type Default Description
coordinates Array [] 可选

几何点的坐标数组，参考示例如下：
[1、不带洞的区几何对象]
[2、带洞的区几何对象]
spatialReference SpatialReference new zondy.SpatialReference('EPSG:4326') 可选

几何点的空间参考系，默认4326，当不是4326时请指定坐标系，方便进行投影转换，参考示例：[指定坐标系]
Examples

不带洞的区几何

// ES5引入方式
const { Polygon } = zondy.geometry
// ES6引入方式
import { Polygon } from "@mapgis/webclient-common"
new Polygon({
  coordinates:[
    // 外圈
    [
      [100.0, 0.0],
      [101.0, 0.0],
      [101.0, 1.0],
      [100.0, 1.0],
      [100.0, 0.0]
    ]
  ]
})

带洞的区几何

// ES5引入方式
const { Polygon } = zondy.geometry
// ES6引入方式
import { Polygon } from "@mapgis/webclient-common"
new Polygon({
  coordinates:[
    // 外圈
    [
      [100.0, 0.0],
      [101.0, 0.0],
      [101.0, 1.0],
      [100.0, 1.0],
      [100.0, 0.0]
    ],
    // 第一个内圈
    [
      [100.8, 0.8],
      [100.8, 0.2],
      [100.2, 0.2],
      [100.2, 0.8],
      [100.8, 0.8]
    ],
    // 第二个内圈
    [],
    ...
  ]
})

指定坐标系

// ES5引入方式
const { Polygon } = zondy.geometry
// ES6引入方式
import { Polygon } from "@mapgis/webclient-common"
new Polygon({
  coordinates:[
    // 外圈
    [
      [12060733.232006868, 3377247.5680546067],
      [12929863.44711455, 3377247.5680546067],
      [12929863.44711455, 3934286.575385226],
      [12060733.232006868, 3934286.575385226],
      [12060733.232006868, 3377247.5680546067]
    ]
  ]
})

Extends

Members

centroidPoint

多边形质心

coordinatesArray

几何点的坐标

extensionOptionsObject

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

Default Value:
{}

extentNumber

外包盒

hasZBoolean

是否含有z坐标

isSelfIntersectingBoolean

多边形是否自相交；判断多边形内的环是否互相相交；或多边形内部的环是否自相交

Default Value:
false

spatialReferenceSpatialReference

几何点的空间参考系

Methods

Polygon.fromExtent(extent){Polygon}

base/geometry/Polygon.js, line 165

将给定的Extent转换为多边形实例

Name Type Description
extent Extent

传入的Extent范围,当传入Extent的hasZ为true时，则此多边形实例的hasZ为true
Returns:
Type Description
Polygon 表示给定范围的多边形实例
Example

将给定的Extent转换为多边形实例

// ES5引入方式
const { Extent, Polygon } = zondy.geometry
// ES6引入方式
import { Extent, Polygon } from "@mapgis/webclient-common"
const extent = new Extent({
  "xmin":10,
  "xmax":210,
  "ymin":0,
  "ymax":100
})
const polygon = Polygon.fromExtent(extent)

Polygon.fromJSON(json)

base/geometry/Polygon.js, line 303

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

Name Type Description
json Object 可选

JSON对象
Example

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

// ES5引入方式
const { Polygon } = zondy.geometry
// ES6引入方式
import { Polygon } from "@mapgis/webclient-common"
const json = {
  coordinates:[
    // 外圈
    [
      [100.0, 0.0],
      [101.0, 0.0],
      [101.0, 1.0],
      [100.0, 1.0],
      [100.0, 0.0]
    ]
  ]
}
const polygon = new Polygon.fromJSON(json)

addRing(points){Polygon}

base/geometry/Polygon.js, line 229

在多边形中添加一个环,环可以是一个数字数组或一个点数组

Name Type Description
points Array.<Point>

一个多边形环。环中的第一个和最后一个坐标/点必须相同。可以将其定义为Point几何图形数组或XY坐标数组。
Returns:
Type Description
Polygon 返回包含新环的多边形
Example

在多边形中添加一个环

// ES5引入方式
const { Polygon, Point } = zondy.geometry
// ES6引入方式
import { Polygon, Point } from "@mapgis/webclient-common"
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]
    ]
  ]
})
const ring = [
  new Point({
    coordinates: [100.2, 0.0]
  }),
  new Point({
    coordinates: [101.3, 0.0]
  }),
  new Point({
    coordinates: [100.3, 0.7]
  }),
  new Point({
    coordinates: [104.2, 0.7]
  }),
  new Point({
    coordinates: [100.2, 0.0]
  })
]
polygon.addRing(ring)

clone(){Geometry}

base/geometry/Polygon.js, line 697

克隆几何对象

Returns:
Type Description
Geometry 克隆后的几何对象

contains(point){Boolean}

base/geometry/Polygon.js, line 346

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

Name Type Description
point Point

用于测试是否包含在测试多边形中的点
Returns:
Type Description
Boolean 如果该点位于多边形内，则返回true
Example

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

// ES5引入方式
const { Polygon, Point } = zondy.geometry
// ES6引入方式
import { Polygon, Point } from "@mapgis/webclient-common"
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]
    ]
  ]
})
const point = new Point({
  coordinates: [100.0, 0.0]
})
const isOnPolygon = polygon.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/Polygon.js, line 584

返回IGS所对应的GeometryModule型

Returns:
string GeometryModule型

getPoint(ringIndex, pointIndex){Point|null}

base/geometry/Polygon.js, line 377

根据下标返回指定的点

Name Type Description
ringIndex Number

包含所需点的环的下标
pointIndex Number

环内所需点的下标
Returns:
Type Description
Point | null 返回位于指定环索引和点索引处的点
Example

根据下标返回指定的点

// ES5引入方式
const { Polygon } = zondy.geometry
// ES6引入方式
import { Polygon } from "@mapgis/webclient-common"
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]
    ]
  ]
})
const point = polygon.getPoint(0, 1)

inherited getType(){String}

base/geometry/Geometry.js, line 154

返回所对应的GeometryModule型

Returns:
Type Description
String GeometryModule型

insertPoint(ringIndex, pointIndex, point){Polygon|null}

base/geometry/Polygon.js, line 413

在多边形中插入一个新点

Name Type Description
ringIndex Number

插入点的环的下标。
pointIndex Number

要插入环内的点的下标
point Point

插入点
Returns:
Type Description
Polygon | null 返回更新后的多边形
Example

在多边形中插入一个新点

// ES5引入方式
const { Polygon, Point } = zondy.geometry
// ES6引入方式
import { Polygon, Point } from "@mapgis/webclient-common"
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]
    ]
  ]
})
const point = new Point({
  coordinates: [99, 1.0],
})
polygon.insertPoint(0, 3, point)

isClockwise(ring){Boolean}

base/geometry/Polygon.js, line 611

多边形的环是否是顺时针

Name Type Description
ring Array | Array.<Point>

多边形的环，坐标数组或者点几何数组
Returns:
Type Description
Boolean 是否是顺时针

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)

removePoint(ringIndex, pointIndex){Point|null}

base/geometry/Polygon.js, line 448

根据下标从多边形中移除一个点

Name Type Description
ringIndex Number

包含要移除的点的环的下标。
pointIndex Number

要在环内移除的点的下标。
Returns:
Type Description
Point | null 返回被移除点
Example

根据下标从多边形中移除一个点

// ES5引入方式
const { Polygon } = zondy.geometry
// ES6引入方式
import { Polygon } from "@mapgis/webclient-common"
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]
    ]
  ]
})
polygon.removePoint(0, 1)

removeRing(ringIndex){Array}

base/geometry/Polygon.js, line 263

根据索引从多边形中移除一个环

Name Type Description
ringIndex Number

要移除的环的索引
Returns:
Type Description
Array 返回表示已移除的环的点数组
Example

根据索引从多边形中移除一个环

// ES5引入方式
const { Polygon } = zondy.geometry
// ES6引入方式
import { Polygon } from "@mapgis/webclient-common"
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]
    ]
  ]
})
polygon.removeRing(1)

setPoint(ringIndex, pointIndex, point){Polygon}

base/geometry/Polygon.js, line 491

更新多边形中的一个点

Name Type Description
ringIndex Number

包含要更新点的环的索引。
pointIndex Number

在环内要更新的点的索引。
point Point | Number

新的点
Returns:
Type Description
Polygon 返回更新后的多边形
Example

更新多边形中的一个点

// ES5引入方式
const { Polygon, Point } = zondy.geometry
// ES6引入方式
import { Polygon, Point } from "@mapgis/webclient-common"
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]
    ]
  ]
})
const point = new Point({
  coordinates: [99, 1.0],
})
polygon.setPoint(0, 3, point)

toDots()

base/geometry/Polygon.js, line 592

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

Returns:
Array Dots对象

inherited toGeoJSON(){Object}

base/geometry/Geometry.js, line 122

导出为GeoJSON

Returns:
Type Description
Object GeoJSON对象

toJSON(){Object}

base/geometry/Polygon.js, line 313

导出为json对象

Returns:
Type Description
Object json对象

toOldIGSGeometry()

base/geometry/Polygon.js, line 548

返回igs1.0的几何对象

Returns:
Object igs1.0的几何对象

toString()

base/geometry/Polygon.js, line 518

返回如下格式的字符串："x0,y0,x1,y1,x2,y2,x0,y0|x3,y3,x4,y4,x5,y5,x3,y3" 多边形内每个的多边形由|号分割

Returns:
string

toXMl(){String}

base/geometry/Polygon.js, line 509

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

Returns:
Type Description
String 字符串

inherited toXML(){String}

base/geometry/Geometry.js, line 146

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

Returns:
Type Description
String 字符串