#### # new MultiPolygon(options)

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

#### 参数

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

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

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

##### 示例

创建几何对象

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

### 继承关系

- Geometry

### 成员变量

#### 成员变量概述

名称 | 类型 | 描述
--- | --- | ---
`coordinates` | `Array` | `几何点的坐标`
`extendOptions` | `Object` | `初始化图层的额外参数，可以通过该参数传入引擎原生的构造参数`
`extent` | `Number` | `外包盒`
`hasZ` | `Boolean` | `是否含有z坐标`
`spatialReference` | `SpatialReference` | `几何点的空间参考系`

#### 成员变量详情

类型: Array

#### # coordinates

几何点的坐标

类型: Object

#### # extendOptions

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

Inherited From:
  - Geometry#extendOptions
Default Value:
  - {}

类型: Number

#### # extent

外包盒

Overrides:
  - Geometry#extent

类型: Boolean

#### # readonly hasZ

是否含有z坐标

Overrides:
  - Geometry#hasZ

类型: SpatialReference

#### # spatialReference

几何点的空间参考系

Inherited From:
  - Geometry#spatialReference

### 方法

#### 方法概述

名称 | 返回值类型 | 描述
--- | --- | ---
`fromJSON` | `` | `通过传入的json构造并返回一个新的几何对象`
`addPolygon` | `MultiPolygon` | `在多区末尾添加区`
`clone` | `Geometry` | `克隆几何对象`
`contains` | `Boolean` | `检查输入点是否在多边形内。多边形线上的一个点被认为是内部`
`fromGeoJSON` | `` | `导入GeoJSON`
`getGeometryType` | `String` | `获取GeometryModule型`
`getIGSType` | `` | `返回IGS所对应的GeometryModule型`
`getType` | `String` | `返回所对应的GeometryModule型`
`off` | `Object` | `移除事件 示例如下:`
`on` | `Object` | `注册一个新的监听事件; 示例如下：`
`removePolygon` | `Polygon | null` | `根据区几何的下标删除的区对象`
`toGeoJSON` | `Object` | `导出为GeoJSON`
`toJSON` | `Object` | ``
`toOldIGSGeometry` | `` | `返回igs1.0的几何对象`
`toPolygonArray` | `Array.<Polygon>` | `多区对象转区对象数组`
`toString` | `` | `返回如下格式的字符串："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"`
`toXMl` | `String` | `导出为OGC服务要求的xml字符串`
`toXML` | `String` | `导出为OGC服务要求的xml字符串，子类实现`

#### 方法详情

#### # static fromJSON(jsonopt)

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

#### 参数

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

##### 示例

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

在多区末尾添加区

#### 参数

名称 | 类型 | 默认值 | 描述
--- | --- | --- | ---
`polygon` | Polygon |  | 要添加区几何对象
`mode` | String | 'add' | 添加模式，add:正常添加，deduplication:去除重复点，即当新加的区几何和现有的一个或多个几何相交时，会合并几何对象

返回值

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

类型: MultiPolygon

##### 示例

在多区末尾添加区

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

克隆几何对象

Overrides:
  - Geometry#clone

返回值

克隆后的几何对象

类型: Geometry

#### # contains(point)

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

#### 参数

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

返回值

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

类型: Boolean

##### 示例

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

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

#### # fromGeoJSON(GeoJSON)

导入GeoJSON

#### 参数

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

Inherited From:
  - Geometry#fromGeoJSON

#### # getGeometryType()

获取GeometryModule型

Inherited From:
  - Geometry#getGeometryType

返回值

GeometryModule型

类型: String

#### # getIGSType()

返回IGS所对应的GeometryModule型

Overrides:
  - Geometry#getIGSType

返回值

string GeometryModule型

#### # getType()

返回所对应的GeometryModule型

Inherited From:
  - Geometry#getType

返回值

GeometryModule型

类型: String

#### # 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

返回值

当前实例

类型: 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

返回值

当前实例

类型: 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)

#### # removePolygon(polygonIndex)

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

#### 参数

名称 | 类型 | 描述
--- | --- | ---
`polygonIndex` | Number |

返回值

返回删除的区对象

类型: Polygon | null

##### 示例

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

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

#### # toGeoJSON()

导出为GeoJSON

Inherited From:
  - Geometry#toGeoJSON

返回值

GeoJSON对象

类型: Object

#### # toJSON()

导出为json对象

Overrides:
  - Geometry#toJSON

返回值

json对象

类型: Object

#### # toOldIGSGeometry()

返回igs1.0的几何对象

返回值

Object igs1.0的几何对象

#### # toPolygonArray()

多区对象转区对象数组

返回值

区对象数组

类型: Array.<Polygon>

#### # toString()

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

Overrides:
  - Geometry#toString

返回值

string

#### # toXMl()

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

返回值

字符串

类型: String

#### # toXML()

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

Inherited From:
  - Geometry#toXML

返回值

字符串

类型: String