#### # new Polygon(options)

区几何，由多个环(ring)构成的几何对象，仅支持带洞区和非带洞区，不支持带岛区，即三个圈重叠
多边形的第一个环(ring)即外圈，从第二个环开始为内圈，内圈可以重合、相交、自相交，但是不能超过外圈
[ES5引入方式]：
Zondy.Geometry.Polygon()
[ES6引入方式]：
import { Polygon } from "@mapgis/webclient-common"

#### 参数:

名称 | 类型 | 默认值 | 描述
--- | --- | --- | ---
`options` | Object |  | 构造参数
`coordinates` | Array | [] | 几何点的坐标数组，参考示例如下： [1、不带洞的区几何对象] [2、带洞的区几何对象]
`spatialReference` | SpatialReference | new Zondy.SpatialReference('EPSG:4326') | 几何点的空间参考系，默认4326，当不是4326时请指定坐标系，方便进行投影转换，参考示例：[指定坐标系]

查看源代码 common/base/geometry/Polygon.js, line 9

##### 支持如下方法：

[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、克隆几何对象`

##### 示例

不带洞的区几何

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

### 继承关系

- Geometry

### 成员变量

类型: Point

#### # centroid

多边形质心

查看源代码 common/base/geometry/Polygon.js, line 763

类型: Array

#### # coordinates

几何点的坐标

查看源代码 common/base/geometry/Polygon.js, line 111

类型: Number

#### # extent

外包盒

Overrides:
  - Geometry#extent

查看源代码 common/base/geometry/Polygon.js, line 742

类型: Boolean

#### # readonly hasZ

是否含有z坐标

Overrides:
  - Geometry#hasZ

查看源代码 common/base/geometry/Geometry.js, line 36

类型: Boolean

#### # isSelfIntersecting

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

Default Value:
  - false

查看源代码 common/base/geometry/Polygon.js, line 752

类型: SpatialReference

#### # spatialReference

几何点的空间参考系

Inherited From:
  - Geometry#spatialReference

查看源代码 common/base/geometry/Geometry.js, line 28

### 方法

#### # static fromExtent(extent)

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

#### 参数:

名称 | 类型 | 描述
--- | --- | ---
`extent` | Extent |

查看源代码 common/base/geometry/Polygon.js, line 161

返回值:

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

类型: Polygon

##### 示例

将给定的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)

#### # static fromJSON(jsonopt)

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

#### 参数:

名称 | 类型 | 描述
--- | --- | ---
`json` | Object | JSON对象

查看源代码 common/base/geometry/Polygon.js, line 296

##### 示例

通过传入的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)

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

#### 参数:

名称 | 类型 | 描述
--- | --- | ---
`points` | Array.<Point> | 一个多边形环。环中的第一个和最后一个坐标/点必须相同。可以将其定义为Point几何图形数组或XY坐标数组。

查看源代码 common/base/geometry/Polygon.js, line 224

返回值:

返回包含新环的多边形

类型: Polygon

##### 示例

在多边形中添加一个环

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

克隆几何对象

Overrides:
  - Geometry#clone

查看源代码 common/base/geometry/Polygon.js, line 737

返回值:

克隆后的几何对象

类型: Geometry

#### # contains(point)

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

#### 参数:

名称 | 类型 | 描述
--- | --- | ---
`point` | Point | 用于测试是否包含在测试多边形中的点

查看源代码 common/base/geometry/Polygon.js, line 340

返回值:

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

类型: Boolean

##### 示例

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

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

#### # fromGeoJSON(GeoJSON)

导入GeoJSON

#### 参数:

名称 | 类型 | 描述
--- | --- | ---
`GeoJSON` | Object | Object

Inherited From:
  - Geometry#fromGeoJSON

查看源代码 common/base/geometry/Geometry.js, line 120

#### # getGeometryType()

获取GeometryModule型

Inherited From:
  - Geometry#getGeometryType

查看源代码 common/base/geometry/Geometry.js, line 157

返回值:

GeometryModule型

类型: String

#### # getIGSType()

返回IGS所对应的GeometryModule型

Overrides:
  - Geometry#getIGSType

查看源代码 common/base/geometry/Polygon.js, line 575

返回值:

string GeometryModule型

#### # getPoint(ringIndex, pointIndex)

根据下标返回指定的点

#### 参数:

名称 | 类型 | 描述
--- | --- | ---
`ringIndex` | Number | 包含所需点的环的下标
`pointIndex` | Number | 环内所需点的下标

查看源代码 common/base/geometry/Polygon.js, line 371

返回值:

返回位于指定环索引和点索引处的点

类型: Point | null

##### 示例

根据下标返回指定的点

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

#### # getType()

返回所对应的GeometryModule型

Inherited From:
  - Geometry#getType

查看源代码 common/base/geometry/Geometry.js, line 141

返回值:

GeometryModule型

类型: String

#### # insertPoint(ringIndex, pointIndex, point)

在多边形中插入一个新点

#### 参数:

名称 | 类型 | 描述
--- | --- | ---
`ringIndex` | Number | 插入点的环的下标。
`pointIndex` | Number | 要插入环内的点的下标
`point` | Point | 插入点

查看源代码 common/base/geometry/Polygon.js, line 407

返回值:

返回更新后的多边形

类型: Polygon | null

##### 示例

在多边形中插入一个新点

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

多边形的环是否是顺时针

#### 参数:

名称 | 类型 | 描述
--- | --- | ---
`ring` | Array | Array.<Point> | 多边形的环，坐标数组或者点几何数组

查看源代码 common/base/geometry/Polygon.js, line 602

返回值:

是否是顺时针

类型: Boolean

#### # off(typesopt, fnopt, contextopt)

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

#### 参数:

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

Inherited From:
  - Evented#off

查看源代码 common/base/Evented.js, line 269

返回值:

当前实例

类型: Object

##### 示例

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

    // 一个事件的回调函数
    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)

#### # on(typesopt, fnopt, contextopt)

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

#### 参数:

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

Inherited From:
  - Evented#on

查看源代码 common/base/Evented.js, line 173

返回值:

当前实例

类型: Object

##### 示例

##### 注册一个事件

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

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

#### 参数:

名称 | 类型 | 描述
--- | --- | ---
`ringIndex` | Number | 包含要移除的点的环的下标。
`pointIndex` | Number | 要在环内移除的点的下标。

查看源代码 common/base/geometry/Polygon.js, line 441

返回值:

返回被移除点

类型: Point | null

##### 示例

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

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

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

#### 参数:

名称 | 类型 | 描述
--- | --- | ---
`ringIndex` | Number | 要移除的环的索引

查看源代码 common/base/geometry/Polygon.js, line 257

返回值:

返回表示已移除的环的点数组

类型: Array

##### 示例

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

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

更新多边形中的一个点

#### 参数:

名称 | 类型 | 描述
--- | --- | ---
`ringIndex` | Number | 包含要更新点的环的索引。
`pointIndex` | Number | 在环内要更新的点的索引。
`point` | Point | Number | 新的点

查看源代码 common/base/geometry/Polygon.js, line 483

返回值:

返回更新后的多边形

类型: Polygon

##### 示例

更新多边形中的一个点

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

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

查看源代码 common/base/geometry/Polygon.js, line 583

返回值:

Array Dots对象

#### # toGeoJSON()

导出为GeoJSON

Inherited From:
  - Geometry#toGeoJSON

查看源代码 common/base/geometry/Geometry.js, line 109

返回值:

GeoJSON对象

类型: Object

#### # toJSON()

导出为json对象

Overrides:
  - Geometry#toJSON

查看源代码 common/base/geometry/Polygon.js, line 306

返回值:

json对象

类型: Object

#### # toOldIGSGeometry()

返回igs1.0的几何对象

查看源代码 common/base/geometry/Polygon.js, line 539

返回值:

Object igs1.0的几何对象

#### # toString()

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

Overrides:
  - Geometry#toString

查看源代码 common/base/geometry/Polygon.js, line 509

返回值:

string

#### # toXMl()

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

查看源代码 common/base/geometry/Polygon.js, line 500

返回值:

字符串

类型: String

#### # toXML()

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

Inherited From:
  - Geometry#toXML

查看源代码 common/base/geometry/Geometry.js, line 133

返回值:

字符串

类型: String