#### # new MultiLineString(options)

多线段几何
[ES5引入方式]：
Zondy.Geometry.MultiLineString()
[ES6引入方式]：
import { MultiLineString } from "@mapgis/webclient-common"

#### 参数:

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

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

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

[1、添加线段]
[2、移除线段]
[3、获取指定线段上的点]
[4、插入点到指定线段上]
[5、删除指定线段上的点]
[6、修改指定线段上的点]
[7、返回字符串]
[8、导出为OGC服务要求的xml字符串]
[9、返回IGS所对应的GeometryModule型]
[10、返回igs1.0的几何对象] [11、通过传入的json构造并返回一个新的几何对象]
[12、导出为json对象]
`13、克隆几何对象`

##### 示例

创建几何对象

    // ES5引入方式
    const { MultiLineString } = Zondy.Geometry
    // ES6引入方式
    import { MultiLineString } from "@mapgis/webclient-common"
    new MultiLineString({
      coordinates: [
        // 第一个线几何
        [
          [100.0, 0.0],[101.0, 1.0]
        ],
        // 第二个线几何
        [
          [102.0, 2.0],[103.0, 3.0]
        ]
      ]
    })

指定坐标系

    // ES5引入方式
    const { MultiLineString } = Zondy.Geometry
    const { SpatialReference } = Zondy
    // ES6引入方式
    import { MultiLineString, SpatialReference } from "@mapgis/webclient-common"
    new MultiLineString({
      // 3857坐标系的点
      coordinates: [
        // 第一个线几何
        [
          [12929863.44711455, 3934286.575385226],
          [12060733.232006868, 3377247.5680546067]
        ],
        // 第二个线几何
        [
          [12929863.44711455, 3934286.575385226],
          [12060733.232006868, 3377247.5680546067]
        ]
      ],
      // 当不是4326时请指定坐标系，方便进行投影转换
      spatialReference: new SpatialReference('EPSG:3857')
    })

### 继承关系

- Geometry

### 成员变量

类型: Array

#### # coordinates

几何点的坐标

查看源代码 common/base/geometry/MultiLineString.js, line 83

类型: Number

#### # extent

外包盒

Overrides:
  - Geometry#extent

查看源代码 common/base/geometry/MultiLineString.js, line 522

类型: Boolean

#### # readonly hasZ

是否含有z坐标

Overrides:
  - Geometry#hasZ

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

类型: SpatialReference

#### # spatialReference

几何点的空间参考系

Inherited From:
  - Geometry#spatialReference

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

类型: GeometryType

#### # type

几何类型

查看源代码 common/base/geometry/MultiLineString.js, line 88

### 方法

#### # static clone(multiLineString)

克隆几何对象

#### 参数:

名称 | 类型 | 描述
--- | --- | ---
`multiLineString` | MultiLineString | 被克隆的几何对象

查看源代码 common/base/geometry/MultiLineString.js, line 210

返回值:

克隆后的几何对象

类型: MultiLineString

##### 示例

克隆几何对象

    // ES5引入方式
    const { MultiLineString } = Zondy.Geometry
    // ES6引入方式
    import { MultiLineString } from "@mapgis/webclient-common"
    const multiLineString = new MultiLineString({
      coordinates: [
        // 第一个线几何
        [
          [100.0, 0.0],[101.0, 1.0]
        ],
        // 第二个线几何
        [
          [102.0, 2.0],[103.0, 3.0]
        ]
      ]
    })
    const newMultiLineString = MultiLineString.clone(multiLineString)

#### # static fromJSON(jsonopt)

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

#### 参数:

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

查看源代码 common/base/geometry/MultiLineString.js, line 236

##### 示例

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

    // ES5引入方式
    const { MultiLineString } = Zondy.Geometry
    // ES6引入方式
    import { MultiLineString } from "@mapgis/webclient-common"
    const json = {
      coordinates: [
        // 第一个线几何
        [
          [100.0, 0.0],[101.0, 1.0]
        ],
        // 第二个线几何
        [
          [102.0, 2.0],[103.0, 3.0]
        ]
      ]
    }
    const newMultiLineString = MultiLineString.fromJSON(json)

#### # addPath(points)

添加线段

#### 参数:

名称 | 类型 | 描述
--- | --- | ---
`points` | Array.<Point> | 控制点组

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

返回值:

更新后的几何对象

类型: MultiLineString

##### 示例

添加线段

    // ES5引入方式
    const { MultiLineString, Point } = Zondy.Geometry
    // ES6引入方式
    import { MultiLineString, Point } from "@mapgis/webclient-common"
    const multiLineString = new MultiLineString({
      coordinates: [
        // 第一个线几何
        [
          [100.0, 0.0],[101.0, 1.0]
        ],
        // 第二个线几何
        [
          [102.0, 2.0],[103.0, 3.0]
        ]
      ]
    })
    const path = [
      new Point({
        coordinates: [100.0, 0.0]
      }),
      new Point({
        coordinates: [101.0, 1.0]
      }),
      new Point({
        coordinates: [102.0, 2.0]
      })
    ]
    multiLineString.addPath(path)

#### # clone()

克隆几何对象

Overrides:
  - Geometry#clone

查看源代码 common/base/geometry/MultiLineString.js, line 517

返回值:

克隆后的几何对象

类型: Geometry

#### # 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/MultiLineString.js, line 416

返回值:

string GeometryModule型

#### # getPoint(pathIndex, pointIndex)

获取指定线段上的点

#### 参数:

名称 | 类型 | 描述
--- | --- | ---
`pathIndex` | Number | 路径下标
`pointIndex` | Number | 数组下标

查看源代码 common/base/geometry/MultiLineString.js, line 278

返回值:

点

类型: Point | null

##### 示例

获取指定线段上的点

    // ES5引入方式
    const { MultiLineString } = Zondy.Geometry
    // ES6引入方式
    import { MultiLineString } from "@mapgis/webclient-common"
    const multiLineString = new MultiLineString({
      coordinates: [
        // 第一个线几何
        [
          [100.0, 0.0],[101.0, 1.0]
        ],
        // 第二个线几何
        [
          [102.0, 2.0],[103.0, 3.0]
        ]
      ]
    })
    const point = multiLineString.getPoint(0, 1)

#### # getType()

返回所对应的GeometryModule型

Inherited From:
  - Geometry#getType

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

返回值:

GeometryModule型

类型: String

#### # insertPoint(pathIndex, pointIndex, point)

插入点到指定线段上

#### 参数:

名称 | 类型 | 描述
--- | --- | ---
`pathIndex` | Number | 路径下标
`pointIndex` | Number | 数组下标
`point` | Point | 点

查看源代码 common/base/geometry/MultiLineString.js, line 314

返回值:

插入点后的线对象

类型: MultiLineString | null

##### 示例

插入点到指定线段上

    // ES5引入方式
    const { MultiLineString, Point } = Zondy.Geometry
    // ES6引入方式
    import { MultiLineString, Point } from "@mapgis/webclient-common"
    const multiLineString = new MultiLineString({
      coordinates: [
        // 第一个线几何
        [
          [100.0, 0.0],[101.0, 1.0]
        ],
        // 第二个线几何
        [
          [102.0, 2.0],[103.0, 3.0]
        ]
      ]
    })
    const point = new Point({
      coordinates: [102.0, 2.0]
    })
    multiLineString.insertPoint(0, 1, point)

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

#### # removePath(pathIndex)

移除线段

#### 参数:

名称 | 类型 | 描述
--- | --- | ---
`pathIndex` | Number | 路径下标

查看源代码 common/base/geometry/MultiLineString.js, line 174

返回值:

删除的线段点

类型: Array.<Point> | null

##### 示例

移除线段

    // ES5引入方式
    const { MultiLineString } = Zondy.Geometry
    // ES6引入方式
    import { MultiLineString } from "@mapgis/webclient-common"
    const multiLineString = new MultiLineString({
      coordinates: [
        // 第一个线几何
        [
          [100.0, 0.0],[101.0, 1.0]
        ],
        // 第二个线几何
        [
          [102.0, 2.0],[103.0, 3.0]
        ]
      ]
    })
    multiLineString.removePath(0)

#### # removePoint(pathIndex, pointIndex)

删除指定线段上的点

#### 参数:

名称 | 类型 | 描述
--- | --- | ---
`pathIndex` | Number | 路径下标
`pointIndex` | Number | 数组下标

查看源代码 common/base/geometry/MultiLineString.js, line 348

返回值:

删除点后的线对象

类型: MultiLineString

##### 示例

删除指定线段上的点

    // ES5引入方式
    const { MultiLineString } = Zondy.Geometry
    // ES6引入方式
    import { MultiLineString } from "@mapgis/webclient-common"
    const multiLineString = new MultiLineString({
      coordinates: [
        // 第一个线几何
        [
          [100.0, 0.0],[101.0, 1.0]
        ],
        // 第二个线几何
        [
          [102.0, 2.0],[103.0, 3.0]
        ]
      ]
    })
    multiLineString.removePoint(0, 1)

#### # setPoint(pathIndex, pointIndex, point)

修改指定线段上的点

#### 参数:

名称 | 类型 | 描述
--- | --- | ---
`pathIndex` | Number | 路径下标
`pointIndex` | Number | 数组下标
`point` | Point | 要更新的点

查看源代码 common/base/geometry/MultiLineString.js, line 386

返回值:

修改后的线对象

类型: MultiLineString

##### 示例

修改指定线段上的点

    // ES5引入方式
    const { MultiLineString, Point } = Zondy.Geometry
    // ES6引入方式
    import { MultiLineString, Point } from "@mapgis/webclient-common"
    const multiLineString = new MultiLineString({
      coordinates: [
        // 第一个线几何
        [
          [100.0, 0.0],[101.0, 1.0]
        ],
        // 第二个线几何
        [
          [102.0, 2.0],[103.0, 3.0]
        ]
      ]
    })
    const point = new Point({
      coordinates: [102.0, 2.0]
    })
    multiLineString.setPoint(0, 1, point)

#### # toGeoJSON()

导出为GeoJSON

Inherited From:
  - Geometry#toGeoJSON

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

返回值:

GeoJSON对象

类型: Object

#### # toJSON()

导出为json对象

Overrides:
  - Geometry#toJSON

查看源代码 common/base/geometry/MultiLineString.js, line 246

返回值:

json对象

类型: Object

#### # toOldIGSGeometry()

返回igs1.0的几何对象

查看源代码 common/base/geometry/MultiLineString.js, line 424

返回值:

Object igs1.0的几何对象

#### # toString()

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

Overrides:
  - Geometry#toString

查看源代码 common/base/geometry/MultiLineString.js, line 400

返回值:

string

#### # toXMl()

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

查看源代码 common/base/geometry/MultiLineString.js, line 408

返回值:

字符串

类型: String

#### # toXML()

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

Inherited From:
  - Geometry#toXML

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

返回值:

字符串

类型: String