你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站,请访问 https://docs.azure.cn

math module

AffineTransform

从一组引用点生成的 Affine Transform 类。

枚举

AccelerationUnits

加速的度量单位。

AreaUnits

区域的度量单位。

DistanceUnits

距离的度量单位。

SpeedUnits

速度度量单位。

TimeUnits

时间度量单位。

函数

boundingBoxToPolygon(BoundingBox)

获取 BoundingBox 并将其转换为多边形。

convertAcceleration(number, string | AccelerationUnits, string | AccelerationUnits, number)

将加速值从一个单元转换为另一个单元。 支持的单位:milesPerSecondSquared、kmsPerSecondSquared、metersPerSecondSquared、footPerSecondSquared 码PerSecondSquared、kmsPerHoursSecond、milesPerHourSecond、knotsPerSecond、standardGravity

convertArea(number, string, string, number)

将区域值从一个单位转换为另一个单位。 支持单位:平方计、英亩、公顷、squareFeet、squareYards、squareMiles、squareKilometers

convertDistance(number, string | DistanceUnits, string | DistanceUnits, number)

将距离从一个距离单位转换为另一个单位。 支持的单位:英里、海里米尔斯、码、米、公里、英尺

convertSpeed(number, string | SpeedUnits, string | SpeedUnits, number)

将速度值从一个单位转换为另一个单位。 支持的单位:kmsPerHour、milesPerHour、metersPerSecond、footPerSecond、knots、mach

convertTimespan(number, string | TimeUnits, string | TimeUnits, number)

将时间跨度值从一个单位转换为另一个单位。 支持的单位:ms (毫秒) 、小时、分钟、秒

getAcceleration(number, number, number, string | SpeedUnits, string | DistanceUnits, string | TimeUnits, string | AccelerationUnits, number)

根据初始速度、行程距离和时间跨度计算加速。 公式:a = 2* (d - v*t) /t^2

getAccelerationFromFeatures(Feature<Point, any>, Feature<Point, any>, string, string, string | SpeedUnits, string | AccelerationUnits, number)

计算具有时间戳属性和可选速度属性的两个点特征之间的加速。 如果提供了速度,则忽略点之间的距离,因为路径可能不是直线并计算:a = (v2 - v1) / (t2 - t1) 如果未提供速度或仅在第一个点上提供的速度,则计算点之间的直线距离并计算:a = 2* (d - v*t) /t^2

getAccelerationFromSpeeds(number, number, number, string | SpeedUnits, string | TimeUnits, string | AccelerationUnits, number)

根据初始速度、最终速度和时间跨度计算加速。 公式:a = 2* (v2 - v1) /t

getArea(atlas.data.Geometry | Feature<atlas.data.Geometry, any> | Shape, AreaUnits, number)

计算指定单位中几何图形的近似面积

getCardinalSpline(Position[], number, number, boolean)

计算构成指定位置数组之间的基数样条的位置数组。

getClosestPointOnGeometry(Position | Point | Feature<Point, any> | Shape, atlas.data.Geometry | Feature<atlas.data.Geometry, any> | Shape, string | DistanceUnits, number)

计算几何图形边缘上最接近指定点或位置的点。 返回的点特征将具有一个 distance 属性,该属性指定指定单位中两个点之间的距离。 如果几何图形是点,该点位置将用于结果。 如果几何图形是 MultiPoint,将使用各个位置的距离。 如果几何图形是多边形或 MultiPolygon,则无论点是否与几何图形相交,最接近任何边缘的点都将返回。

getConvexHull(Position[] | atlas.data.Geometry | Feature<atlas.data.Geometry, any> | FeatureCollection | GeometryCollection | atlas.data.Geometry[] | Array<Feature<atlas.data.Geometry, any> | Shape> | Shape)

从位置、几何图形或特征数组计算凸体外壳。

getDestination(Position | Point, number, number, string | DistanceUnits)

根据起始位置、标题、距离和距离单位类型计算目标位置。

getDistanceTo(Position | Point, Position | Point, string | DistanceUnits)

使用 Haversine 公式计算地球表面的两个位置对象之间的距离。

getEarthRadius(string | DistanceUnits)

检索 WGS84 的特定距离单位中的地球半径。

getGeodesicPath(LineString | Position[], number)

获取一组位置对象,并填充它们之间的空间,并准确定位位置以形成近似地理路径。

getGeodesicPaths(LineString | Position[], number)

获取一个位置对象数组,并填充它们之间的空间,其位置准确定位,形成一个近似地理路径,由一个时间线分解成多个子路径。

getHeading(Position | Point, Position | Point)

计算从一个位置对象到另一个位置对象的标题。

getLengthOfPath(LineString | Position[], string | DistanceUnits)

计算数组中所有位置对象之间的距离。

getPathDenormalizedAtAntimerian(LineString | Position[])

非规范化安时里田上的路径,这使得具有坐标的线条在时里线的对面,以始终交叉它。 请注意,穿越时间线的路径将包含 -180 到 180 范围的经度。 如果不需要,请参阅 getPathSplitByAntimeridian。

getPathSplitByAntimeridian(LineString | Position[])

将timeridian 上的路径拆分为多个路径。 如果不需要,请参阅 getPathDenormalizedAtAntimerian。

getPixelHeading(Position | Point, Position | Point)

根据 Mercator 地图投影计算从一个位置到另一个位置的像素准确标题。 此标题直观准确。

getPointsWithHeadingsAlongPath(LineString | Position[], number)

获取一个包含沿路径标题的均匀间距点的数组。

getPointWithHeadingAlongPath(LineString | Position[], number, string | DistanceUnits)

获取具有沿路径的指定距离的点。

getPosition(Position | Point | Feature<Point, any> | Shape)

获取作为位置、点、点特征或圆的对象的位置。 如果它是一个圆,则返回其中心坐标。

getPositionAlongPath(LineString | Position[], number, string | DistanceUnits)

计算与路径起点相距指定距离的路径上的位置对象。 如果指定的距离长于路径的长度,将返回路径的最后一个位置。

getPositions(Position[] | atlas.data.Geometry | Feature<atlas.data.Geometry, any> | FeatureCollection | GeometryCollection | atlas.data.Geometry[] | Array<Feature<atlas.data.Geometry, any> | Shape> | Shape)

检索提供的几何图形、特征或几何特征数组中所有位置的数组。

getPositionsAlongPath(LineString | Position[], number)

获取路径上均匀间距位置的数组。

getRegularPolygonPath(Position | Point, number, number, string | DistanceUnits, number)

计算与中心点相等距离的位置对象数组,以创建常规多边形。

getRegularPolygonPaths(Position | Point, number, number, string | DistanceUnits, number)

计算与中心点相等距离的位置对象数组,以创建一个正则多边形,该多边形被一个timeridian 分解为多个子路径。

getSpeed(Position | Point | Feature<Point, any>, Position | Point | Feature<Point, any>, number, string | TimeUnits, string | SpeedUnits, number)

根据提供的时间量计算两个点之间的平均行程速度。

getSpeedFromFeatures(Feature<Point, any>, Feature<Point, any>, string, string | SpeedUnits, number)

计算具有包含时间戳的属性的两个点特征之间的平均行程速度。 时间戳可以是;

  • JavaScript Date 对象
  • 一个数字,表示自 1970 年 1 月 1 日起的毫秒数。
  • 使用以下格式之一的字符串:
    • ISO8601 日期格式 (例如 2012-04-23T18:25:43.511Z)
    • RFC282 / IETF 日期语法 (第 3.3 节)
    • OData 日期字符串 (即“/Date (1235764800000) /”)
getTimespan(Date | string | number, Date | string | number, TimeUnits, number)

计算两个日期或时间戳之间的时间跨度。 时间戳可以是:

  • JavaScript Date 对象
  • 一个数字,表示自 1970 年 1 月 1 日起的毫秒数。
  • 使用以下格式之一的字符串:
    • ISO8601 日期格式 (,即 2012-04-23T18:25:43.511Z)
    • RFC282 / IETF 日期语法 (第 3.3 节)
    • OData 日期字符串 (,即“/Date (1235764800000) /”)
getTravelDistance(string, number, number, number, string | TimeUnits, string | SpeedUnits, string, number)

计算指定时间跨度、速度和可选加速度的距离。 公式:d = vt + 0.5a*t^2

interpolate(Position | Point, Position | Point, number)

计算一个位置对象,该对象是两个位置对象之间的小数距离。

mercatorPixelsToPositions(Pixel[], number)

将全局 Mercator 像素坐标数组转换为指定缩放级别的地理空间位置数组。 全局像素坐标相对于地图左上角 [-180, 90]。

mercatorPositionsToPixels(Position[], number)

将位置数组转换为指定缩放级别的全局 Mercator 像素坐标数组。

normalizeLatitude(number)

规范化介于 -90 和 90 度之间的纬度值。

normalizeLongitude(number)

规范化 -180 到 180 度之间的经度值。

parseTimestamp(Date | string | number)

将时间戳分析为 JavaScript Date 对象。 时间戳可以是:

  • JavaScript Date 对象
  • 一个数字,表示自 1970 年 1 月 1 日起的毫秒数。
  • 使用以下格式之一的字符串:
    • ISO8601 日期格式 (,即 2012-04-23T18:25:43.511Z)
    • RFC282 / IETF 日期语法 (第 3.3 节)
    • OData 日期字符串 (,即“/Date (1235764800000) /”)
rotatePositions(Position[], Position | Point, number)

获取一组位置,并在指定旋转角度的给定位置周围旋转它们。

simplify((Position | Pixel)[], number)

对位置或像素数组执行Douglas-Peucker简化。

函数详细信息

boundingBoxToPolygon(BoundingBox)

获取 BoundingBox 并将其转换为多边形。

function boundingBoxToPolygon(bounds: BoundingBox): Polygon

参数

bounds
BoundingBox

要转换为多边形的 BoundingBox。

返回

BoundingBox 的多边形表示形式。

convertAcceleration(number, string | AccelerationUnits, string | AccelerationUnits, number)

将加速值从一个单元转换为另一个单元。 支持的单位:milesPerSecondSquared、kmsPerSecondSquared、metersPerSecondSquared、footPerSecondSquared 码PerSecondSquared、kmsPerHoursSecond、milesPerHourSecond、knotsPerSecond、standardGravity

function convertAcceleration(acceleration: number, fromUnits: string | AccelerationUnits, toUnits: string | AccelerationUnits, decimals?: number): number

参数

acceleration

number

要转换的加速值。

fromUnits

string | AccelerationUnits

值的加速单位。

toUnits

string | AccelerationUnits

要转换为的加速单位。

decimals

number

要舍入结果的小数位数。

返回

number

从一个单元转换到另一个单元的加速值。

convertArea(number, string, string, number)

将区域值从一个单位转换为另一个单位。 支持单位:平方计、英亩、公顷、squareFeet、squareYards、squareMiles、squareKilometers

function convertArea(area: number, fromUnits: string, toUnits: string, decimals?: number): number

参数

area

number

要转换的区域值。

fromUnits

string

值位于的区域单位。

toUnits

string

要转换为的区域单位。

decimals

number

要舍入结果的小数位数。

返回

number

从一个单位转换到另一个单位的区域值。

convertDistance(number, string | DistanceUnits, string | DistanceUnits, number)

将距离从一个距离单位转换为另一个单位。 支持的单位:英里、海里米尔斯、码、米、公里、英尺

function convertDistance(distance: number, fromUnits: string | DistanceUnits, toUnits: string | DistanceUnits, decimals?: number): number

参数

distance

number

表示要转换的距离的数字。

fromUnits

string | DistanceUnits

原始距离的距离单位。

toUnits

string | DistanceUnits

要转换为的所需距离单位。

decimals

number

指定要将结果舍入到的小数位数。 如果未定义,则不会发生舍入。

返回

number

新单位中的距离。

convertSpeed(number, string | SpeedUnits, string | SpeedUnits, number)

将速度值从一个单位转换为另一个单位。 支持的单位:kmsPerHour、milesPerHour、metersPerSecond、footPerSecond、knots、mach

function convertSpeed(speed: number, fromUnits: string | SpeedUnits, toUnits: string | SpeedUnits, decimals?: number): number

参数

speed

number

要转换的速度值。

fromUnits

string | SpeedUnits

要从中转换的速度单位。

toUnits

string | SpeedUnits

要转换为的速度单位。

decimals

number

要舍入结果的小数位数。

返回

number

从一个单元转换为另一个单元的速度值。

convertTimespan(number, string | TimeUnits, string | TimeUnits, number)

将时间跨度值从一个单位转换为另一个单位。 支持的单位:ms (毫秒) 、小时、分钟、秒

function convertTimespan(timespan: number, fromUnits: string | TimeUnits, toUnits: string | TimeUnits, decimals?: number): number

参数

timespan

number

要转换的时间值。

fromUnits

string | TimeUnits

要转换的时间单位。

toUnits

string | TimeUnits

要转换为的时间单位。

decimals

number

要舍入结果的小数位数。

返回

number

从一个单位转换为另一个单位的时间值。

getAcceleration(number, number, number, string | SpeedUnits, string | DistanceUnits, string | TimeUnits, string | AccelerationUnits, number)

根据初始速度、行程距离和时间跨度计算加速。 公式:a = 2* (d - v*t) /t^2

function getAcceleration(initialSpeed: number, distance: number, timespan: number, speedUnits?: string | SpeedUnits, distanceUnits?: string | DistanceUnits, timeUnits?: string | TimeUnits, accelerationUnits?: string | AccelerationUnits, decimals?: number): number

参数

initialSpeed

number

初始速度。

distance

number

已行驶的距离。

timespan

number

旅行的时间跨度。

speedUnits

string | SpeedUnits

速度信息的单位。 如果未指定 m/s,则使用。

distanceUnits

string | DistanceUnits

距离信息的单位。 如果未指定计量,则使用。

timeUnits

string | TimeUnits

时间跨度信息的单位。 如果未指定秒,则使用。

accelerationUnits

string | AccelerationUnits

要返回加速值的单位。 如果未指定 m/s^2,则使用。

decimals

number

要舍入结果的小数位数。

返回

number

基于初始速度、行程距离和时间跨度的加速。

getAccelerationFromFeatures(Feature<Point, any>, Feature<Point, any>, string, string, string | SpeedUnits, string | AccelerationUnits, number)

计算具有时间戳属性和可选速度属性的两个点特征之间的加速。 如果提供了速度,则忽略点之间的距离,因为路径可能不是直线并计算:a = (v2 - v1) / (t2 - t1) 如果未提供速度或仅在第一个点上提供的速度,则计算点之间的直线距离并计算:a = 2* (d - v*t) /t^2

function getAccelerationFromFeatures(origin: Feature<Point, any>, destination: Feature<Point, any>, timestampProperty: string, speedProperty?: string, speedUnits?: string | SpeedUnits, accelerationUnits?: string | AccelerationUnits, decimals?: number): number

参数

origin

Feature<Point, any>

从中计算加速的初始点。

destination

Feature<Point, any>

计算加速的最后一点。

timestampProperty

string

包含时间戳信息的功能的属性的名称。

speedProperty

string

包含速度信息的功能的属性的名称。

speedUnits

string | SpeedUnits

速度信息的单位。 如果未指定 m/s,则使用。

accelerationUnits

string | AccelerationUnits

要返回加速值的单位。 如果未指定 m/s^2,则使用。

decimals

number

要舍入结果的小数位数。

返回

number

具有时间戳属性和可选速度属性的两个点特征之间的加速。 如果无法分析时间戳,则返回 NaN。

getAccelerationFromSpeeds(number, number, number, string | SpeedUnits, string | TimeUnits, string | AccelerationUnits, number)

根据初始速度、最终速度和时间跨度计算加速。 公式:a = 2* (v2 - v1) /t

function getAccelerationFromSpeeds(initialSpeed: number, finalSpeed: number, timespan: number, speedUnits?: string | SpeedUnits, timeUnits?: string | TimeUnits, accelerationUnits?: string | AccelerationUnits, decimals?: number): number

参数

initialSpeed

number

初始速度。

finalSpeed

number

最终的速度。

timespan

number

旅行的时间跨度。

speedUnits

string | SpeedUnits

速度信息的单位。 如果未指定计量,则使用。

timeUnits

string | TimeUnits

时间跨度信息的单位。 如果未指定秒,则使用。

accelerationUnits

string | AccelerationUnits

要返回加速值的单位。 如果未指定 m/s^2,则使用。

decimals

number

要舍入结果的小数位数。

返回

number

基于初始速度、最终速度和时间跨度的加速。

getArea(atlas.data.Geometry | Feature<atlas.data.Geometry, any> | Shape, AreaUnits, number)

计算指定单位中几何图形的近似面积

function getArea(data: atlas.data.Geometry | Feature<atlas.data.Geometry, any> | Shape, areaUnits?: AreaUnits, decimals?: number): number

参数

data

Geometry | Feature<Geometry, any> | Shape

areaUnits
AreaUnits

面积度量单位。 默认值为 squareMeters。

decimals

number

要舍入结果的小数位数。

返回

number

指定单位中几何图形的区域。

getCardinalSpline(Position[], number, number, boolean)

计算构成指定位置数组之间的基数样条的位置数组。

function getCardinalSpline(positions: Position[], tension?: number, nodeSize?: number, close?: boolean): Position[]

参数

positions

Position[]

要计算样条通过的位置数组。

tension

number

一个数字,指示曲线的紧度。 可以是任意数字,尽管通常使用介于 0 和 1 之间的值。 默认值:0.5

nodeSize

number

要在每个位置之间插入的节点数。 默认值:15

close

boolean

一个布尔值,指示样条是否应为封闭环。 默认值:false

返回

构成指定位置数组之间的基数样条的位置数组。

getClosestPointOnGeometry(Position | Point | Feature<Point, any> | Shape, atlas.data.Geometry | Feature<atlas.data.Geometry, any> | Shape, string | DistanceUnits, number)

计算几何图形边缘上最接近指定点或位置的点。 返回的点特征将具有一个 distance 属性,该属性指定指定单位中两个点之间的距离。 如果几何图形是点,该点位置将用于结果。 如果几何图形是 MultiPoint,将使用各个位置的距离。 如果几何图形是多边形或 MultiPolygon,则无论点是否与几何图形相交,最接近任何边缘的点都将返回。

function getClosestPointOnGeometry(pt: Position | Point | Feature<Point, any> | Shape, geom: atlas.data.Geometry | Feature<atlas.data.Geometry, any> | Shape, units?: string | DistanceUnits, decimals?: number): Feature<Point, { distance: number }>

参数

pt

Position | Point | Feature<Point, any> | Shape

要查找几何图形边缘上最近的点的点或位置。

geom

Geometry | Feature<Geometry, any> | Shape

要查找最近点的几何图形。

units

string | DistanceUnits

距离度量单位。 默认值为计量。

decimals

number

要舍入结果的小数位数。

返回

Feature<Point, { distance: number }>

getConvexHull(Position[] | atlas.data.Geometry | Feature<atlas.data.Geometry, any> | FeatureCollection | GeometryCollection | atlas.data.Geometry[] | Array<Feature<atlas.data.Geometry, any> | Shape> | Shape)

从位置、几何图形或特征数组计算凸体外壳。

function getConvexHull(data: Position[] | atlas.data.Geometry | Feature<atlas.data.Geometry, any> | FeatureCollection | GeometryCollection | atlas.data.Geometry[] | Array<Feature<atlas.data.Geometry, any> | Shape> | Shape): Polygon

参数

data

Position[] | Geometry | Feature<Geometry, any> | FeatureCollection | GeometryCollection | Geometry[] | Array<Feature<Geometry, any> | Shape> | Shape

要计算其凸体的位置、几何图形或特征数组。

返回

来自位置、几何图形或特征数组的凸体赫尔。

getDestination(Position | Point, number, number, string | DistanceUnits)

根据起始位置、标题、距离和距离单位类型计算目标位置。

function getDestination(origin: Position | Point, heading: number, distance: number, units?: string | DistanceUnits): Position

参数

origin

Position | Point

目标相对于的位置。

heading

number

0 - 360 度之间的标题角度。 0 - 北,90 - 东部,180 - 南,270 - 西部。

distance

number

目的地距离。

units

string | DistanceUnits

距离度量单位。 默认值为计量。

返回

距离原点的指定距离的位置。

getDistanceTo(Position | Point, Position | Point, string | DistanceUnits)

使用 Haversine 公式计算地球表面的两个位置对象之间的距离。

function getDistanceTo(origin: Position | Point, destination: Position | Point, units?: string | DistanceUnits): number

参数

origin

Position | Point

要计算之间的距离的第一个位置。

destination

Position | Point

要计算两者之间距离的第二个位置。

units

string | DistanceUnits

距离度量单位。 默认值为计量。

返回

number

指定单位中两个位置之间的最短距离。

getEarthRadius(string | DistanceUnits)

检索 WGS84 的特定距离单位中的地球半径。

function getEarthRadius(units?: string | DistanceUnits): number

参数

units

string | DistanceUnits

距离度量单位。 默认值:计量

返回

number

一个数字,表示特定距离单位中的地球半径。

getGeodesicPath(LineString | Position[], number)

获取一组位置对象,并填充它们之间的空间,并准确定位位置以形成近似地理路径。

function getGeodesicPath(path: LineString | Position[], nodeSize?: number): Position[]

参数

path

LineString | Position[]

构成要填充的路径的位置对象的数组。

nodeSize

number

要在每个位置之间插入的节点数。 默认值:15

返回

构成地理路径的位置对象数组,地理线路径跨越时态路径将包含 -180 到 180 范围之外的经度。 如果出现这种情况,请参阅 getGeodesicPaths () 。

getGeodesicPaths(LineString | Position[], number)

获取一个位置对象数组,并填充它们之间的空间,其位置准确定位,形成一个近似地理路径,由一个时间线分解成多个子路径。

function getGeodesicPaths(path: LineString | Position[], nodeSize?: number): Position[][]

参数

path

LineString | Position[]

构成要填充的路径的位置对象的数组。

nodeSize

number

要在每个位置之间插入的节点数。 默认值:15

返回

Position[][]

构成地理路径的路径数组,与 getGeodesicPath 进行比较,子路径将始终包含 -180 到 180 范围内的经度

getHeading(Position | Point, Position | Point)

计算从一个位置对象到另一个位置对象的标题。

function getHeading(origin: Position | Point, destination: Position | Point): number

参数

origin

Position | Point

起点。

destination

Position | Point

要计算到的相对标题的目标。

返回

number

0 到 360 之间的标题。 0 度点由于北。

getLengthOfPath(LineString | Position[], string | DistanceUnits)

计算数组中所有位置对象之间的距离。

function getLengthOfPath(path: LineString | Position[], units?: string | DistanceUnits): number

参数

path

LineString | Position[]

构成用于计算长度的路径的位置对象的数组。

units

string | DistanceUnits

距离度量单位。 默认值:计量

返回

number

在指定单位中地球表面的数组中所有位置对象之间的所有位置之间的距离。

getPathDenormalizedAtAntimerian(LineString | Position[])

非规范化安时里田上的路径,这使得具有坐标的线条在时里线的对面,以始终交叉它。 请注意,穿越时间线的路径将包含 -180 到 180 范围的经度。 如果不需要,请参阅 getPathSplitByAntimeridian。

function getPathDenormalizedAtAntimerian(path: LineString | Position[]): Position[]

参数

path

LineString | Position[]

要非规范化的位置对象或线字符串数组

返回

位置对象的非规范化数组,路径交叉安时里迪安将包含 -180 到 180 范围之外的经度。

getPathSplitByAntimeridian(LineString | Position[])

将timeridian 上的路径拆分为多个路径。 如果不需要,请参阅 getPathDenormalizedAtAntimerian。

function getPathSplitByAntimeridian(path: LineString | Position[]): Position[][]

参数

path

LineString | Position[]

要拆分的位置对象或行字符串数组

返回

Position[][]

按timeridian 拆分为多个路径的路径。

getPixelHeading(Position | Point, Position | Point)

根据 Mercator 地图投影计算从一个位置到另一个位置的像素准确标题。 此标题直观准确。

function getPixelHeading(origin: Position | Point, destination: Position | Point): number

参数

origin

Position | Point

destination

Position | Point

返回

number

getPointsWithHeadingsAlongPath(LineString | Position[], number)

获取一个包含沿路径标题的均匀间距点的数组。

function getPointsWithHeadingsAlongPath(path: LineString | Position[], numPoints: number): Array<Feature<Point, { heading: number }>>

参数

path

LineString | Position[]

从中获取位置的路径。

numPoints

number

要获取的点数。

返回

Array<Feature<Point, { heading: number }>>

一个由均匀分隔的点数组,其标题沿路径。

getPointWithHeadingAlongPath(LineString | Position[], number, string | DistanceUnits)

获取具有沿路径的指定距离的点。

function getPointWithHeadingAlongPath(path: LineString | Position[], distance: number, units?: string | DistanceUnits): Feature<Point, { heading: number }>

参数

path

LineString | Position[]

要从中获取点的路径。

distance

number

沿路径获取点的距离。

units

string | DistanceUnits

距离单位。

返回

Feature<Point, { heading: number }>

具有沿路径的指定距离的点。

getPosition(Position | Point | Feature<Point, any> | Shape)

获取作为位置、点、点特征或圆的对象的位置。 如果它是一个圆,则返回其中心坐标。

function getPosition(data: Position | Point | Feature<Point, any> | Shape): Position

参数

data

Position | Point | Feature<Point, any> | Shape

要从中提取位置的数据对象。

返回

作为位置、点或点特征的对象的位置。 如果传入的数据无效,则返回 null。

getPositionAlongPath(LineString | Position[], number, string | DistanceUnits)

计算与路径起点相距指定距离的路径上的位置对象。 如果指定的距离长于路径的长度,将返回路径的最后一个位置。

function getPositionAlongPath(path: LineString | Position[], distance: number, units?: string | DistanceUnits): Position

参数

path

LineString | Position[]

构成路径的位置坐标的折线或数组。

distance

number

路径的距离 (从开始) 计算位置。

units

string | DistanceUnits

距离度量单位。 默认值为计量。

返回

一个位置对象,该位置对象位于路径的开头与路径的开头之间的指定距离。

getPositions(Position[] | atlas.data.Geometry | Feature<atlas.data.Geometry, any> | FeatureCollection | GeometryCollection | atlas.data.Geometry[] | Array<Feature<atlas.data.Geometry, any> | Shape> | Shape)

检索提供的几何图形、特征或几何特征数组中所有位置的数组。

function getPositions(data: Position[] | atlas.data.Geometry | Feature<atlas.data.Geometry, any> | FeatureCollection | GeometryCollection | atlas.data.Geometry[] | Array<Feature<atlas.data.Geometry, any> | Shape> | Shape): Position[]

参数

data

Position[] | Geometry | Feature<Geometry, any> | FeatureCollection | GeometryCollection | Geometry[] | Array<Feature<Geometry, any> | Shape> | Shape

要从中检索位置的几何图形或特征。

返回

提供几何图形、特征或几何特征数组中所有位置的数组。

getPositionsAlongPath(LineString | Position[], number)

获取路径上均匀间距位置的数组。

function getPositionsAlongPath(path: LineString | Position[], numPositions: number): Position[]

参数

path

LineString | Position[]

从中获取位置的路径。

numPositions

number

要获取的位置数。

返回

沿路径的均匀间距位置数组。

getRegularPolygonPath(Position | Point, number, number, string | DistanceUnits, number)

计算与中心点相等距离的位置对象数组,以创建常规多边形。

function getRegularPolygonPath(origin: Position | Point, radius: number, numberOfPositions: number, units?: string | DistanceUnits, offset?: number): Position[]

参数

origin

Position | Point

正则多边形的中心。

radius

number

常规多边形的半径。

numberOfPositions

number

多边形应具有的位置数。

units

string | DistanceUnits

距离度量单位。 默认值为计量。

offset

number

旋转多边形的偏移量。 当第 0 个位置与北对齐时。

返回

构成常规多边形的位置对象的数组。

getRegularPolygonPaths(Position | Point, number, number, string | DistanceUnits, number)

计算与中心点相等距离的位置对象数组,以创建一个正则多边形,该多边形被一个timeridian 分解为多个子路径。

function getRegularPolygonPaths(origin: Position | Point, radius: number, numberOfPositions: number, units?: string | DistanceUnits, offset?: number): Position[][]

参数

origin

Position | Point

正则多边形的中心。

radius

number

常规多边形的半径。

numberOfPositions

number

多边形应具有的位置数。

units

string | DistanceUnits

距离度量单位。 默认值为计量。

offset

number

旋转多边形的偏移量。 当第 0 个位置与北对齐时。

返回

Position[][]

构成常规多边形的路径数组。 与 getRegularPolygonPath 相比,子路径始终包含 -180 到 180 范围内的经度

getSpeed(Position | Point | Feature<Point, any>, Position | Point | Feature<Point, any>, number, string | TimeUnits, string | SpeedUnits, number)

根据提供的时间量计算两个点之间的平均行程速度。

function getSpeed(origin: Position | Point | Feature<Point, any>, destination: Position | Point | Feature<Point, any>, timespan: number, timeUnits?: string | TimeUnits, speedUnits?: string | SpeedUnits, decimals?: number): number

参数

origin

Position | Point | Feature<Point, any>

从中计算速度的初始点。

destination

Position | Point | Feature<Point, any>

从中计算速度的最后一个点。

timespan

number

timeUnits

string | TimeUnits

时间值的单位。 如果未指定秒,则使用。

speedUnits

string | SpeedUnits

要返回速度值的单位。 如果未指定 m/s,则使用。

decimals

number

要舍入结果的小数位数。

返回

number

根据提供的时间量在两个点之间的平均行程速度。

getSpeedFromFeatures(Feature<Point, any>, Feature<Point, any>, string, string | SpeedUnits, number)

计算具有包含时间戳的属性的两个点特征之间的平均行程速度。 时间戳可以是;

  • JavaScript Date 对象
  • 一个数字,表示自 1970 年 1 月 1 日起的毫秒数。
  • 使用以下格式之一的字符串:
    • ISO8601 日期格式 (例如 2012-04-23T18:25:43.511Z)
    • RFC282 / IETF 日期语法 (第 3.3 节)
    • OData 日期字符串 (即“/Date (1235764800000) /”)
function getSpeedFromFeatures(origin: Feature<Point, any>, destination: Feature<Point, any>, timestampProperty: string, speedUnits?: string | SpeedUnits, decimals?: number): number

参数

origin

Feature<Point, any>

从中计算速度的初始点。

destination

Feature<Point, any>

从中计算速度的最后一个点。

timestampProperty

string

具有时间戳信息的功能的属性的名称。

speedUnits

string | SpeedUnits

要返回速度值的单位。 如果未指定 m/s,则使用。

decimals

number

要舍入结果的小数位数。

返回

number

如果未找到有效的时间戳,则指定单位或 NaN 中的速度。

getTimespan(Date | string | number, Date | string | number, TimeUnits, number)

计算两个日期或时间戳之间的时间跨度。 时间戳可以是:

  • JavaScript Date 对象
  • 一个数字,表示自 1970 年 1 月 1 日起的毫秒数。
  • 使用以下格式之一的字符串:
    • ISO8601 日期格式 (,即 2012-04-23T18:25:43.511Z)
    • RFC282 / IETF 日期语法 (第 3.3 节)
    • OData 日期字符串 (,即“/Date (1235764800000) /”)
function getTimespan(startTime: Date | string | number, endTime: Date | string | number, units?: TimeUnits, decimals?: number): number

参数

startTime

Date | string | number

开始日期或时间。

endTime

Date | string | number

结束日期或时间。

units
TimeUnits

要返回时间值的单位。 如果未指定秒,则使用。

decimals

number

返回

number

两个日期或时间戳之间的时间跨度。 如果无法分析时间戳,则返回 NaN。

getTravelDistance(string, number, number, number, string | TimeUnits, string | SpeedUnits, string, number)

计算指定时间跨度、速度和可选加速度的距离。 公式:d = vt + 0.5a*t^2

function getTravelDistance(distanceUnits: string, timespan: number, speed: number, acceleration?: number, timeUnits?: string | TimeUnits, speedUnits?: string | SpeedUnits, accelerationUnits?: string, decimals?: number): number

参数

distanceUnits

string

要在其中返回距离的距离单位。

timespan

number

要计算其距离的时间跨度。

speed

number

初始或恒定的速度。

acceleration

number

可选。 一种加速,可随时间推移提高速度。

timeUnits

string | TimeUnits

时间跨度单位。 如果未指定秒,则使用。

speedUnits

string | SpeedUnits

速度值的单位。 如果未指定 m/s,则使用。

accelerationUnits

string

可选。 加速值的单位。 如果未指定 m/s^2,则使用。

decimals

number

要舍入结果的小数位数。

返回

number

为指定的时间跨度、速度和加速度(可选)行驶的距离。

interpolate(Position | Point, Position | Point, number)

计算一个位置对象,该对象是两个位置对象之间的小数距离。

function interpolate(origin: Position | Point, destination: Position | Point, fraction?: number): Position

参数

origin

Position | Point

计算中间点之间的第一个位置。

destination

Position | Point

要计算中间点之间的第二个位置。

fraction

number

要计算中点的小数部分参数。 默认为 0.5。

返回

一个位置,位于两个位置对象之间的距离的一小部分,相对于第一个位置对象。

mercatorPixelsToPositions(Pixel[], number)

将全局 Mercator 像素坐标数组转换为指定缩放级别的地理空间位置数组。 全局像素坐标相对于地图左上角 [-180, 90]。

function mercatorPixelsToPositions(pixels: Pixel[], zoom: number): Position[]

参数

pixels

Pixel[]

像素坐标数组。

zoom

number

缩放级别。

返回

位置数组。

mercatorPositionsToPixels(Position[], number)

将位置数组转换为指定缩放级别的全局 Mercator 像素坐标数组。

function mercatorPositionsToPixels(positions: Position[], zoom: number): Pixel[]

参数

positions

Position[]

位置数组。

zoom

number

缩放级别。

返回

Pixel[]

全局 Mercator 像素的数组。

normalizeLatitude(number)

规范化介于 -90 和 90 度之间的纬度值。

function normalizeLatitude(lat: number): number

参数

lat

number

要规范化的纬度值。

返回

number

normalizeLongitude(number)

规范化 -180 到 180 度之间的经度值。

function normalizeLongitude(lng: number): number

参数

lng

number

要规范化的经度值。

返回

number

parseTimestamp(Date | string | number)

将时间戳分析为 JavaScript Date 对象。 时间戳可以是:

  • JavaScript Date 对象
  • 一个数字,表示自 1970 年 1 月 1 日起的毫秒数。
  • 使用以下格式之一的字符串:
    • ISO8601 日期格式 (,即 2012-04-23T18:25:43.511Z)
    • RFC282 / IETF 日期语法 (第 3.3 节)
    • OData 日期字符串 (,即“/Date (1235764800000) /”)
function parseTimestamp(timestamp: Date | string | number): Date

参数

timestamp

Date | string | number

要分析的时间戳值。

返回

Date

一个 Date 对象,表示时间戳或 null(如果无法分析时间戳)。

rotatePositions(Position[], Position | Point, number)

获取一组位置,并在指定旋转角度的给定位置周围旋转它们。

function rotatePositions(positions: Position[], origin: Position | Point, angle: number): Position[]

参数

positions

Position[]

要旋转的位置数组。

origin

Position | Point

旋转位置的位置。

angle

number

顺时针旋转位置数组的量。

返回

simplify((Position | Pixel)[], number)

对位置或像素数组执行Douglas-Peucker简化。

function simplify(points: (Position | Pixel)[], tolerance: number): (Position | Pixel)[]

参数

points

(Position | Pixel)[]

要简化的位置或像素点。

tolerance

number

简化中使用的容差。

返回

(Position | Pixel)[]

简化的点集的新数组。