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

Position class

包:

azure-maps-control

GeoJSON Position 对象 - 指定位置的经度和纬度的数组。 RFC 7946 中详细介绍了完整说明。

Extends

Array<number>

构造函数

Position(number, number, number)

构造位置。

属性

Array

继承属性

length

获取或设置数组的长度。 此数值比数组中所定义的最高位元素大 1。

方法

areEqual(Position, Position, number)	比较两个位置的经度和纬度值，以确定它们是否相等，其准确度为 6 位小数。
fromLatLng(number, number, number)	从纬度和经度值生成 Position 对象。
fromLatLng(number[])	从格式为 的数组生成 Position 对象;[lat， lng] 或 [lat， lng， elv]
fromLatLng(object)	从包含坐标信息的 对象生成 Position 对象。 使用不区分大小写的测试扫描对象以查找以下属性。 经度：液化天然气、经度、龙、x 纬度：纬度、y 海拔：elv、高程、alt、海拔、z
fromLatLngs(Array<object | number[]>)	将包含坐标信息的 对象的数组转换为 Positions 数组。 无法转换的对象将被丢弃。 每个对象都是 格式的数组;[lat， lng] 或 [lat， lng， elv]，或具有以下属性的任意组合的对象：经度： lng， longitude， lon， x Latitude： lat， latitude， y Elevation： elv， elevation， alt， altitude， z
fromPosition(Position)	克隆位置。

继承的方法

concat((T | ConcatArray<T>)[])	合并两个或多个数组。
concat(ConcatArray<number>[])	合并两个或多个数组。
every((value: number, index: number, array: number[]) => unknown, any)	确定数组的所有成员是否都满足指定的测试。
filter((value: number, index: number, array: number[]) => unknown, any)	返回数组中满足回调函数中指定的条件的元素。
filter<S>((value: number, index: number, array: number[]) => value, any)	返回数组中满足回调函数中指定的条件的元素。
forEach((value: number, index: number, array: number[]) => void, any)	为数组中的每个元素执行指定操作。
indexOf(number, number)	返回某个值在数组中的第一个匹配项的索引。
join(string)	添加由指定分隔符字符串分隔的数组的所有元素。
lastIndexOf(number, number)	返回指定值在数组中的最后一个匹配项的索引。
map<U>((value: number, index: number, array: number[]) => U, any)	对数组的每个元素调用定义的回调函数并返回包含结果的数组。
pop()	从数组中移除最后一个元素并将该元素返回。
push(number[])	将新元素追加到一个数组中，并返回数组的新长度。
reduce((previousValue: number, currentValue: number, currentIndex: number, array: number[]) => number)	为数组中的所有元素调用指定的回调函数。 回调函数的返回值是累积的结果，并且作为对回调函数的下一个调用中的参数提供。
reduce((previousValue: number, currentValue: number, currentIndex: number, array: number[]) => number, number)
reduce<U>((previousValue: U, currentValue: number, currentIndex: number, array: number[]) => U, U)	为数组中的所有元素调用指定的回调函数。 回调函数的返回值是累积的结果，并且作为对回调函数的下一个调用中的参数提供。
reduceRight((previousValue: number, currentValue: number, currentIndex: number, array: number[]) => number)	以降序为数组中的所有元素调用指定的回调函数。 回调函数的返回值是累积的结果，并且作为对回调函数的下一个调用中的参数提供。
reduceRight((previousValue: number, currentValue: number, currentIndex: number, array: number[]) => number, number)
reduceRight<U>((previousValue: U, currentValue: number, currentIndex: number, array: number[]) => U, U)	以降序为数组中的所有元素调用指定的回调函数。 回调函数的返回值是累积的结果，并且作为对回调函数的下一个调用中的参数提供。
reverse()	反转 Array 中的元素。
shift()	从数组中移除第一个元素并将返回该元素。
slice(number, number)	返回一个数组中的一部分。
some((value: number, index: number, array: number[]) => unknown, any)	确定指定的回调函数是否为数组的任何元素返回 true。
sort((a: number, b: number) => number)	对数组进行排序。
splice(number, number)	从一个数组中移除元素，如有必要，在所移除元素的位置上插入新元素，并返回所移除的元素。
splice(number, number, number[])	从一个数组中移除元素，如有必要，在所移除元素的位置上插入新元素，并返回所移除的元素。
toLocaleString()	返回数组的字符串表示形式。 元素使用其 toLocalString 方法转换为字符串。
toString()	返回数组的字符串表示形式。
unshift(number[])	在数组的开头插入新元素。

构造函数详细信息

Position(number, number, number)

构造位置。

new Position(longitude: number, latitude: number, elevation?: number)

参数

longitude

number

位置的经度。

latitude

number

位置的纬度。

elevation

number

位置的提升。

属性详细信息

Array

static Array: ArrayConstructor

属性值

ArrayConstructor

继承属性详细信息

length

获取或设置数组的长度。 此数值比数组中所定义的最高位元素大 1。

length: number

属性值

number

继承自 Array.length

方法详细信息

areEqual(Position, Position, number)

比较两个位置的经度和纬度值，以确定它们是否相等，其准确度为 6 位小数。

static function areEqual(pos1: Position, pos2: Position, precision?: number): boolean

参数

pos1

Position

要比较的第一个位置。

pos2

Position

要比较的第二个位置。

precision

number

要比较的小数位数。 默认值：6。

返回

boolean

一个布尔值，指示两个位置是否在指定精度或 6 个小数位数的准确度下相等。

fromLatLng(number, number, number)

从纬度和经度值生成 Position 对象。

static function fromLatLng(lat: number, lng: number, elv?: number): Position

参数

lat

number

纬度值。

lng

number

经度值。

elv

number

以米为单位的提升值。

返回

Position

一个 Position 对象，该对象表示提供的 LatLng 信息。

fromLatLng(number[])

从格式为 的数组生成 Position 对象;[lat， lng] 或 [lat， lng， elv]

static function fromLatLng(latLng: number[]): Position

参数

latLng

number[]

包含格式的纬度/经度信息的数组;[lat， lng] 或 [lat， lng， elv]

返回

Position

一个 Position 对象，该对象表示提供的 LatLng 信息。

fromLatLng(object)

从包含坐标信息的 对象生成 Position 对象。 使用不区分大小写的测试扫描对象以查找以下属性。 经度：液化天然气、经度、龙、x 纬度：纬度、y 海拔：elv、高程、alt、海拔、z

static function fromLatLng(latLng: object): Position

参数

latLng

object

要从中提取坐标信息的对象。

返回

Position

一个 Position 对象，该对象表示提供的 LatLng 信息。

fromLatLngs(Array<object | number[]>)

将包含坐标信息的 对象的数组转换为 Positions 数组。 无法转换的对象将被丢弃。 每个对象都是 格式的数组;[lat， lng] 或 [lat， lng， elv]，或具有以下属性的任意组合的对象：经度： lng， longitude， lon， x Latitude： lat， latitude， y Elevation： elv， elevation， alt， altitude， z

static function fromLatLngs(latLngs: Array<object | number[]>): Position[]

参数

latLngs

Array<object | number[]>

包含坐标信息的对象。

返回

Position[]

Position 对象的数组，其中包含提供的所有坐标信息。

fromPosition(Position)

克隆位置。

static function fromPosition(position: Position): Position

参数

position

Position

要克隆的位置。

返回

Position

继承的方法详细信息

concat((T | ConcatArray<T>)[])

合并两个或多个数组。

function concat(items: (T | ConcatArray<T>)[]): number[]

参数

items

(T | ConcatArray<T>)[]

要添加到 array1 末尾的其他项。

返回

number[]

继承自 Array.concat

concat(ConcatArray<number>[])

合并两个或多个数组。

function concat(items: ConcatArray<number>[]): number[]

参数

items

ConcatArray<number>[]

要添加到 array1 末尾的其他项。

返回

number[]

继承自 Array.concat

every((value: number, index: number, array: number[]) => unknown, any)

确定数组的所有成员是否都满足指定的测试。

function every(callbackfn: (value: number, index: number, array: number[]) => unknown, thisArg?: any): boolean

参数

callbackfn

(value: number, index: number, array: number[]) => unknown

最多可以接受三个参数的函数。 每个方法为数组中的每个元素调用 callbackfn 函数，直到 callbackfn 返回一个可强制转换为布尔值 false 的值，或直到数组的末尾。

thisArg

any

此关键字可以在 callbackfn 函数中引用的 对象。 如果省略 thisArg，则将 undefined 用作此值。

返回

boolean

继承自 Array.every

filter((value: number, index: number, array: number[]) => unknown, any)

返回数组中满足回调函数中指定的条件的元素。

function filter(callbackfn: (value: number, index: number, array: number[]) => unknown, thisArg?: any): number[]

参数

callbackfn

(value: number, index: number, array: number[]) => unknown

最多可以接受三个参数的函数。 filter 方法为数组中的每个元素调用一次 callbackfn 函数。

thisArg

any

此关键字可以在 callbackfn 函数中引用的 对象。 如果省略 thisArg，则将 undefined 用作此值。

返回

number[]

继承自 Array.filter

filter<S>((value: number, index: number, array: number[]) => value, any)

返回数组中满足回调函数中指定的条件的元素。

function filter<S>(callbackfn: (value: number, index: number, array: number[]) => value, thisArg?: any): S[]

参数

callbackfn

(value: number, index: number, array: number[]) => value

最多可以接受三个参数的函数。 filter 方法为数组中的每个元素调用一次 callbackfn 函数。

thisArg

any

此关键字可以在 callbackfn 函数中引用的 对象。 如果省略 thisArg，则将 undefined 用作此值。

返回

S[]

继承自 Array.filter

forEach((value: number, index: number, array: number[]) => void, any)

为数组中的每个元素执行指定操作。

function forEach(callbackfn: (value: number, index: number, array: number[]) => void, thisArg?: any)

参数

callbackfn

(value: number, index: number, array: number[]) => void

最多可以接受三个参数的函数。 forEach 为数组中的每个元素调用一次 callbackfn 函数。

thisArg

any

此关键字可以在 callbackfn 函数中引用的 对象。 如果省略 thisArg，则将 undefined 用作此值。

继承自 Array.forEach

indexOf(number, number)

返回某个值在数组中的第一个匹配项的索引。

function indexOf(searchElement: number, fromIndex?: number): number

参数

searchElement

number

要在数组中查找的值。

fromIndex

number

要开始搜索的数组索引。 如果省略 fromIndex，则搜索从索引 0 开始。

返回

number

继承自 Array.indexOf

join(string)

添加由指定分隔符字符串分隔的数组的所有元素。

function join(separator?: string): string

参数

separator

string

一个字符串，用于将数组的一个元素与生成的 String 中的下一个元素分开。 如果省略，则用逗号分隔数组元素。

返回

string

继承自 Array.join

lastIndexOf(number, number)

返回指定值在数组中的最后一个匹配项的索引。

function lastIndexOf(searchElement: number, fromIndex?: number): number

参数

searchElement

number

要在数组中查找的值。

fromIndex

number

要开始搜索的数组索引。 如果省略 fromIndex，则搜索从数组中的最后一个索引开始。

返回

number

继承自 Array.lastIndexOf

map<U>((value: number, index: number, array: number[]) => U, any)

对数组的每个元素调用定义的回调函数并返回包含结果的数组。

function map<U>(callbackfn: (value: number, index: number, array: number[]) => U, thisArg?: any): U[]

参数

callbackfn

(value: number, index: number, array: number[]) => U

最多可以接受三个参数的函数。 map 方法为数组中的每个元素调用一次 callbackfn 函数。

thisArg

any

此关键字可以在 callbackfn 函数中引用的 对象。 如果省略 thisArg，则将 undefined 用作此值。

返回

U[]

继承自 Array.map

pop()

从数组中移除最后一个元素并将该元素返回。

function pop(): number | undefined

返回

number | undefined

继承自 Array.pop

push(number[])

将新元素追加到一个数组中，并返回数组的新长度。

function push(items: number[]): number

参数

items

number[]

数组的新元素。

返回

number

继承自 Array.push

reduce((previousValue: number, currentValue: number, currentIndex: number, array: number[]) => number)

为数组中的所有元素调用指定的回调函数。 回调函数的返回值是累积的结果，并且作为对回调函数的下一个调用中的参数提供。

function reduce(callbackfn: (previousValue: number, currentValue: number, currentIndex: number, array: number[]) => number): number

参数

callbackfn

(previousValue: number, currentValue: number, currentIndex: number, array: number[]) => number

一个最多接受四个参数的函数。 reduce 方法为数组中的每个元素调用一次 callbackfn 函数。

返回

number

继承自 Array.reduce

reduce((previousValue: number, currentValue: number, currentIndex: number, array: number[]) => number, number)

function reduce(callbackfn: (previousValue: number, currentValue: number, currentIndex: number, array: number[]) => number, initialValue: number): number

参数

callbackfn

(previousValue: number, currentValue: number, currentIndex: number, array: number[]) => number

initialValue

number

返回

number

继承自 Array.reduce

reduce<U>((previousValue: U, currentValue: number, currentIndex: number, array: number[]) => U, U)

为数组中的所有元素调用指定的回调函数。 回调函数的返回值是累积的结果，并且作为对回调函数的下一个调用中的参数提供。

function reduce<U>(callbackfn: (previousValue: U, currentValue: number, currentIndex: number, array: number[]) => U, initialValue: U): U

参数

callbackfn

(previousValue: U, currentValue: number, currentIndex: number, array: number[]) => U

一个最多接受四个参数的函数。 reduce 方法为数组中的每个元素调用一次 callbackfn 函数。

initialValue

U

如果指定了 initialValue，则将其用作开始累积的初始值。 对 callbackfn 函数的第一次调用将此值作为参数提供，而不是数组值。

返回

U

继承自 Array.reduce

reduceRight((previousValue: number, currentValue: number, currentIndex: number, array: number[]) => number)

以降序为数组中的所有元素调用指定的回调函数。 回调函数的返回值是累积的结果，并且作为对回调函数的下一个调用中的参数提供。

function reduceRight(callbackfn: (previousValue: number, currentValue: number, currentIndex: number, array: number[]) => number): number

参数

callbackfn

(previousValue: number, currentValue: number, currentIndex: number, array: number[]) => number

一个最多接受四个参数的函数。 reduceRight 方法为数组中的每个元素调用回调fn 函数一次。

返回

number

继承自 Array.reduceRight

reduceRight((previousValue: number, currentValue: number, currentIndex: number, array: number[]) => number, number)

function reduceRight(callbackfn: (previousValue: number, currentValue: number, currentIndex: number, array: number[]) => number, initialValue: number): number

参数

callbackfn

(previousValue: number, currentValue: number, currentIndex: number, array: number[]) => number

initialValue

number

返回

number

继承自 Array.reduceRight

reduceRight<U>((previousValue: U, currentValue: number, currentIndex: number, array: number[]) => U, U)

以降序为数组中的所有元素调用指定的回调函数。 回调函数的返回值是累积的结果，并且作为对回调函数的下一个调用中的参数提供。

function reduceRight<U>(callbackfn: (previousValue: U, currentValue: number, currentIndex: number, array: number[]) => U, initialValue: U): U

参数

callbackfn

(previousValue: U, currentValue: number, currentIndex: number, array: number[]) => U

一个最多接受四个参数的函数。 reduceRight 方法为数组中的每个元素调用回调fn 函数一次。

initialValue

U

如果指定了 initialValue，则将其用作开始累积的初始值。 对 callbackfn 函数的第一次调用将此值作为参数提供，而不是数组值。

返回

U

继承自 Array.reduceRight

reverse()

反转 Array 中的元素。

function reverse(): number[]

返回

number[]

继承自 Array.reverse

shift()

从数组中移除第一个元素并将返回该元素。

function shift(): number | undefined

返回

number | undefined

继承自 Array.shift

slice(number, number)

返回一个数组中的一部分。

function slice(start?: number, end?: number): number[]

参数

start

number

数组的指定部分的开头。

end

number

数组的指定部分的末尾。 这不包括索引“end”处的 元素。

返回

number[]

继承自 Array.slice

some((value: number, index: number, array: number[]) => unknown, any)

确定指定的回调函数是否为数组的任何元素返回 true。

function some(callbackfn: (value: number, index: number, array: number[]) => unknown, thisArg?: any): boolean

参数

callbackfn

(value: number, index: number, array: number[]) => unknown

最多可以接受三个参数的函数。 一些 方法为数组中的每个元素调用 callbackfn 函数，直到 callbackfn 返回一个可强制转换为布尔值 true 的值，或直到数组的末尾。

thisArg

any

此关键字可以在 callbackfn 函数中引用的 对象。 如果省略 thisArg，则将 undefined 用作此值。

返回

boolean

继承自 Array.some

sort((a: number, b: number) => number)

对数组进行排序。

function sort(compareFn?: (a: number, b: number) => number): this

参数

compareFn

(a: number, b: number) => number

用于确定元素顺序的函数。 如果第一个参数小于第二个参数，则应返回负值;如果它们相等，则返回零值;否则返回正值。 如果省略，则元素按升序 ASCII 字符顺序排序。

[11,2,22,1].sort((a, b) => a - b)

返回

this

继承自 Array.sort

splice(number, number)

从一个数组中移除元素，如有必要，在所移除元素的位置上插入新元素，并返回所移除的元素。

function splice(start: number, deleteCount?: number): number[]

参数

start

number

数组中从零开始删除元素的位置。

deleteCount

number

要移除的元素数。

返回

number[]

继承自 Array.splice

splice(number, number, number[])

从一个数组中移除元素，如有必要，在所移除元素的位置上插入新元素，并返回所移除的元素。

function splice(start: number, deleteCount: number, items: number[]): number[]

参数

start

number

数组中从零开始的位置，从该位置开始删除元素。

deleteCount

number

要移除的元素数。

items

number[]

要插入到数组中以代替已删除元素的元素。

返回

number[]

继承自 Array.splice

toLocaleString()

返回数组的字符串表示形式。 元素使用其 toLocalString 方法转换为字符串。

function toLocaleString(): string

返回

string

继承自 Array.toLocaleString

toString()

返回数组的字符串表示形式。

function toString(): string

返回

string

继承自 Array.toString

unshift(number[])

在数组的开头插入新元素。

function unshift(items: number[]): number

参数

items

number[]

要插入到 Array 开头的元素。

返回

number

继承自 Array.unshift