类:线串

ol/geom/LineString~线串


import LineString from 'ol/geom/LineString.js';

线串几何。

new LineString(coordinates, layout)

Name Type 描述
coordinates Array<Coordinate> | Array.<number>

坐标。供内部使用,平面坐标与layout同样被接受。

layout GeometryLayout | undefined

布局。

触发事件:

继承

方法

appendCoordinate(coordinate)

将传入的坐标追加到线串的坐标上。

Name Type 描述
coordinate Coordinate

坐标

applyTransform(transformFn) inherited

对几何体的坐标应用变换函数。几何体被原地修改。如果您不希望几何体被原地修改,请首先 clone() 它,然后在克隆上使用此函数。

Name Type 描述
transformFn TransformFunction

变换函数。接收一个几何坐标的扁平数组。

递增修订计数器并触发变更事件。

创建几何体的完整副本。

返回:
克隆。

dispatchEvent(event){boolean | undefined} inherited

触发一个事件,并调用所有监听此类型事件的监听器。事件参数既可以是字符串,也可以是具有 type 属性的对象。

Name Type 描述
event BaseEvent | string

事件对象。

返回:
false 如果事件对象上调用了 preventDefault 或任何侦听器返回了 false。

forEachSegment(callback){T | boolean}

遍历每个段,调用提供的回调函数。如果回调返回真值,则函数立即返回该值;否则返回 false

Name Type 描述
callback function

针对每个线段调用的函数。该函数接收两个参数:线段的起始坐标和结束坐标。

返回:
值。

获取值。

Name Type 描述
key string

键名。

返回:
值。

getClosestPoint(point, closestPoint){Coordinate} inherited

返回几何体上离输入点最近的点作为 coordinate

Name Type 描述
point Coordinate

点.

closestPoint Coordinate | undefined

最近点。

返回:
最近点。

getCoordinateAt(fraction, dest){Coordinate}

返回沿线串指定分数处的坐标。fraction 是一个介于0和1之间的数字,其中0表示线串的起点,1表示终点。

Name Type 描述
fraction number

分数。

dest Coordinate | undefined

可选坐标,其值将被修改;若未提供,则返回新坐标。

返回:
插值点的坐标。

getCoordinateAtM(m, extrapolate){Coordinate | null}

使用线性插值返回 m 处的坐标;若不存在,则返回 null

extrapolate 控制对 MultiLineString 中 Ms 范围之外的外推操作。若 extrapolate 等于 true,则当 Ms 小于第一个 M 值时返回第一个坐标,当 Ms 大于最后一个 M 值时返回最后一个坐标。

Name Type 描述
m number

M.

extrapolate boolean | undefined

外推。默认为false.

返回:
坐标。

getCoordinates(){Array<Coordinate>}

返回线串的坐标。

返回:
坐标。

获取几何体的范围。

Name Type 描述
extent Extent | undefined

范围.

返回:
范围 范围.

返回几何体的首个坐标。

返回:
第一个坐标。

getKeys(){Array.<string>} inherited

获取对象属性名称列表。

返回:
属性列表。

返回几何对象的最后一个坐标。

返回:
最后一点。

返回几何的 layout

返回:
布局。

getLength(){number}

返回投影平面上的线串长度。

返回:
投影平面上的长度。

getProperties(){Object.<string, *>} inherited

获取包含所有属性名和值的对象。

返回:
对象。

getRevision(){number} inherited

获取此对象的版本号。每当对象发生修改时,其版本号将自动递增。

返回:
修订

获取该几何体的类型。

返回:
几何 类型.

intersectsCoordinate(coordinate){boolean} inherited

如果该几何体包含指定坐标,则返回 true;如果坐标位于几何体边界上,则返回 false。

Name Type 描述
coordinate Coordinate

坐标

返回:
包含坐标。

intersectsExtent(extent){boolean}

测试几何体与传入范围是否相交。

Name Type 描述
extent Extent

范围.

返回:
当几何与范围相交时,true

on(type, listener){EventsKey | Array<EventsKey>} inherited

监听特定类型的事件。

Name Type 描述
type string | Array.<string>

事件类型或事件类型数组。

listener function

监听器函数。

返回:
监听器的唯一键。若以事件类型数组作为第一个参数调用,则返回值将是键的数组。

once(type, listener){EventsKey | Array<EventsKey>} inherited

一次性监听特定类型的事件。

Name Type 描述
type string | Array.<string>

事件类型或事件类型数组。

listener function

监听器函数

返回:
监听器的唯一键。如果以事件类型数组作为第一个参数调用,则返回将是键的数组。

rotate(angle, anchor) inherited

围绕给定坐标旋转几何体,并原地修改其坐标。

Name Type 描述
angle number

逆时针弧度表示的旋转角度。

anchor Coordinate

旋转中心。

scale(sx, sy, anchor) inherited

缩放几何体(可选原点)。此操作将就地修改几何坐标。

Name Type 描述
sx number

x轴方向的缩放因子。

sy number | undefined

Y方向的缩放因子(默认值为sx)。

anchor Coordinate | undefined

缩放原点(默认为几何范围的中心)。

set(key, value, silent) inherited

设置值。

Name Type 描述
key string

键名。

value *

值。

silent boolean | undefined

在不触发事件的情况下更新

setCoordinates(coordinates, layout)

设置线串的坐标。

Name Type 描述
coordinates Array<Coordinate>

坐标。

layout GeometryLayout | undefined

布局。

setProperties(values, silent) inherited

设置键值对集合。注意:此操作将修改现有属性并添加新属性,且不会删除任何现有属性。

Name Type 描述
values Object.<string, *>

值。

silent boolean | undefined

更新时不触发事件。

创建此几何的简化版本:对于线串,使用 Douglas Peucker 算法;对于多边形,采用基于量化的简化以保留拓扑。

Name Type 描述
tolerance number

简化容差距离

返回:
原始几何的简化新版本。

transform(source, destination){this} inherited

将几何的每个坐标从一个坐标参考系统变换到另一个坐标参考系统。几何对象将被原地修改。例如,线将变换为线,圆将变换为圆。若不想原地修改几何对象,请首先对其实施 clone() 操作,然后在此克隆上使用此函数。

Name Type 描述
source ProjectionLike

当前投影可以是字符串标识符或Projection对象。

destination ProjectionLike

所需的投影可以是字符串标识符或Projection对象。

返回:
此几何。请注意,原始几何已就地修改。

translate(deltaX, deltaY) inherited

变换几何图形。这将原地修改几何坐标。若需新的几何图形,请先 clone() 该几何图形。

Name Type 描述
deltaX number

X轴增量

deltaY number

ΔY

un(type, listener) inherited

取消对特定类型事件的监听。

Name Type 描述
type string | Array.<string>

事件类型或事件类型数组。

listener function

监听器函数。

unset(key, silent) inherited

清除属性。

Name Type 描述
key string

键名。

silent boolean | undefined

取消设置而不触发事件。