Class: MultiLineString

MultiLineString

new MultiLineString(options)

base/geometry/MultiLineString.js, line 8

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

多线段几何

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

Name Type Description
options Object

构造参数

Name Type Default Description
coordinates Array [] 可选

几何点的坐标数组，支持任意单位，参考示例：[多线段几何对象]
spatialReference SpatialReference new zondy.SpatialReference('EPSG:4326') 可选

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

创建几何对象

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

Extends

Members

coordinatesArray

几何点的坐标

extensionOptionsObject

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

Default Value:
{}

extentNumber

外包盒

hasZBoolean

是否含有z坐标

spatialReferenceSpatialReference

几何点的空间参考系

typeGeometryType

几何类型

Methods

MultiLineString.clone(multiLineString){MultiLineString}

base/geometry/MultiLineString.js, line 212

克隆几何对象

Name Type Description
multiLineString MultiLineString

被克隆的几何对象
Returns:
Type Description
MultiLineString 克隆后的几何对象
Example

克隆几何对象

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

MultiLineString.fromJSON(json)

base/geometry/MultiLineString.js, line 238

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

Name Type Description
json Object 可选

JSON对象
Example

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

base/geometry/MultiLineString.js, line 141

添加线段

Name Type Description
points Array.<Point>

控制点组
Returns:
Type Description
MultiLineString 更新后的几何对象
Example

添加线段

// 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(){Geometry}

base/geometry/MultiLineString.js, line 508

克隆几何对象

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

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

返回IGS所对应的GeometryModule型

Returns:
string GeometryModule型

getPoint(pathIndex, pointIndex){Point|null}

base/geometry/MultiLineString.js, line 279

获取指定线段上的点

Name Type Description
pathIndex Number

路径下标
pointIndex Number

数组下标
Returns:
Type Description
Point | null 点
Example

获取指定线段上的点

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

inherited getType(){String}

base/geometry/Geometry.js, line 154

返回所对应的GeometryModule型

Returns:
Type Description
String GeometryModule型

insertPoint(pathIndex, pointIndex, point){MultiLineString|null}

base/geometry/MultiLineString.js, line 315

插入点到指定线段上

Name Type Description
pathIndex Number

路径下标
pointIndex Number

数组下标
point Point

点
Returns:
Type Description
MultiLineString | null 插入点后的线对象
Example

插入点到指定线段上

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

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)

removePath(pathIndex){Array.<Point>|null}

base/geometry/MultiLineString.js, line 175

移除线段

Name Type Description
pathIndex Number

路径下标
Returns:
Type Description
Array.<Point> | null 删除的线段点
Example

移除线段

// 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){MultiLineString}

base/geometry/MultiLineString.js, line 350

删除指定线段上的点

Name Type Description
pathIndex Number

路径下标
pointIndex Number

数组下标
Returns:
Type Description
MultiLineString 删除点后的线对象
Example

删除指定线段上的点

// 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){MultiLineString}

base/geometry/MultiLineString.js, line 389

修改指定线段上的点

Name Type Description
pathIndex Number

路径下标
pointIndex Number

数组下标
point Point

要更新的点
Returns:
Type Description
MultiLineString 修改后的线对象
Example

修改指定线段上的点

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

inherited toGeoJSON(){Object}

base/geometry/Geometry.js, line 122

导出为GeoJSON

Returns:
Type Description
Object GeoJSON对象

toJSON(){Object}

base/geometry/MultiLineString.js, line 248

导出为json对象

Returns:
Type Description
Object json对象

toOldIGSGeometry()

base/geometry/MultiLineString.js, line 428

返回igs1.0的几何对象

Returns:
Object igs1.0的几何对象

toString()

base/geometry/MultiLineString.js, line 404

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

Returns:
string

toXMl(){String}

base/geometry/MultiLineString.js, line 412

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

Returns:
Type Description
String 字符串

inherited toXML(){String}

base/geometry/Geometry.js, line 146

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

Returns:
Type Description
String 字符串