Class: LineString

LineString

new LineString(options)

base/geometry/LineString.js, line 8

支持如下方法:
[1、获取线上点]
[2、插入点到线上a>
[3、删除线上点]
[4、修改线上点]
[5、返回字符串]
[6、导出为OGC服务要求的xml字符串]
[7、返回igs1.0的几何对象]
[8、返回IGS所对应的GeometryModule型]
[9、返回Dots对象,仅包括多边形的外圈]
[10、通过传入的json构造并返回一个新的几何对象]
[11、导出为json对象]
12、克隆几何对象

线几何对象

[ES5引入方式]:
zondy.geometry.LineString()
[ES6引入方式]:
import { LineString } 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 { LineString } = zondy.geometry
// ES6引入方式
import { LineString } from "@mapgis/webclient-common"
new LineString({
  // 点数量必须大于等于2
  coordinates: [
    [100.0, 0.0],
    [101.0, 1.0]
  ]
})

指定坐标系

// ES5引入方式
const { LineString } = zondy.geometry
const { SpatialReference } = zondy
// ES6引入方式
import { LineString, SpatialReference } from "@mapgis/webclient-common"
new LineString({
  // 点数量必须大于等于2
  coordinates: [
    [12929863.44711455, 3934286.575385226],
    [12060733.232006868, 3377247.5680546067]
  ],
  // 当不是4326时请指定坐标系,方便进行投影转换
  spatialReference: new SpatialReference('EPSG:3857')
})

Extends

Members

coordinatesArray

几何点的坐标数组

extensionOptionsObject

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

Default Value:
{}

extentNumber

外包盒

hasZBoolean

是否含有z坐标

spatialReferenceSpatialReference

几何点的空间参考系

几何类型

Methods

LineString.fromJSON(json)

base/geometry/LineString.js, line 217

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

Name Type Description
json Object 可选

JSON对象

Example

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

// ES5引入方式
const { LineString } = zondy.geometry
// ES6引入方式
import { LineString } from "@mapgis/webclient-common"
const json = {
  // 点数量必须大于等于2
  coordinates: [
    [100.0, 0.0],
    [101.0, 1.0]
  ]
}
const line = LineString.fromJSON(json)

clone(){Geometry}

base/geometry/LineString.js, line 363

克隆几何对象

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/LineString.js, line 298

返回IGS所对应的GeometryModule型

Returns:
string GeometryModule型

getPoint(pointIndex){Point|null}

base/geometry/LineString.js, line 107

获取线上点

Name Type Description
pointIndex Number

数组下标

Returns:
Type Description
Point | null
Example

获取线上点

// ES5引入方式
const { LineString } = zondy.geometry
// ES6引入方式
import { LineString } from "@mapgis/webclient-common"
const lineString = new LineString({
  // 点数量必须大于等于2
  coordinates: [
    [100.0, 0.0],
    [101.0, 1.0]
  ]
})
const point = lineString.getPoint(0)

inherited getType(){String}

base/geometry/Geometry.js, line 154

返回所对应的GeometryModule型

Returns:
Type Description
String GeometryModule型

insertPoint(pointIndex, point){LineString}

base/geometry/LineString.js, line 134

插入点到线上

Name Type Description
pointIndex Number

数组下标

point Point | Array.<Number>

Returns:
Type Description
LineString 插入点后的线对象
Example

插入点到线上

// ES5引入方式
const { LineString } = zondy.geometry
// ES6引入方式
import { LineString } from "@mapgis/webclient-common"
const lineString = new LineString({
  // 点数量必须大于等于2
  coordinates: [
    [100.0, 0.0],
    [101.0, 1.0]
  ]
})
lineString.insertPoint(1, [102.0, 2.0])

inherited off(types, fn, context){Object}

base/Evented.js, line 328
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
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(pointIndex){Point}

base/geometry/LineString.js, line 161

删除线上点

Name Type Description
pointIndex Number

数组下标

Returns:
Type Description
Point 删除点
Example

删除线上点

// ES5引入方式
const { LineString } = zondy.geometry
// ES6引入方式
import { LineString } from "@mapgis/webclient-common"
const lineString = new LineString({
  // 点数量必须大于等于2
  coordinates: [
    [100.0, 0.0],
    [101.0, 1.0]
  ]
})
lineString.removePoint(0)

setPoint(pointIndex, point){LineString}

base/geometry/LineString.js, line 191

修改线上点

Name Type Description
pointIndex Number

数组下标

point Point | Array.<Number>

Returns:
Type Description
LineString 修改后的线对象
Example

修改线上点

// ES5引入方式
const { LineString } = zondy.geometry
// ES6引入方式
import { LineString } from "@mapgis/webclient-common"
const lineString = new LineString({
  // 点数量必须大于等于2
  coordinates: [
    [100.0, 0.0],
    [101.0, 1.0]
  ]
})
lineString.setPoint(0, [11.0, 1.2])

toDots()

base/geometry/LineString.js, line 306

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

Returns:
Array Dots对象

inherited toGeoJSON(){Object}

base/geometry/Geometry.js, line 122

导出为GeoJSON

Returns:
Type Description
Object GeoJSON对象

toJSON(){Object}

base/geometry/LineString.js, line 227

导出为json对象

Returns:
Type Description
Object json对象

toOldIGSGeometry()

base/geometry/LineString.js, line 265

返回igs1.0的几何对象

Returns:
Object igs1.0的几何对象

toString()

base/geometry/LineString.js, line 238

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

Returns:
string

toXMl(){String}

base/geometry/LineString.js, line 259

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

Returns:
Type Description
String 字符串

inherited toXML(){String}

base/geometry/Geometry.js, line 146

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

Returns:
Type Description
String 字符串