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

BoundingBox class

包:

azure-maps-control

GeoJSON BoundingBox 对象 - 定义形状的数组，其边缘遵循经、纬度和高程常量线。 最西南点的所有轴后跟更东北点的所有轴。 BoundingBox 的轴顺序遵循几何图形的轴顺序。 RFC 7946 中详细介绍了完整说明。

Extends

Array<number>

构造函数

BoundingBox(number[])	构造 BoundingBox
BoundingBox(Position, Position)	构造 BoundingBox。

属性

Array

继承属性

length

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

方法

containsPosition(BoundingBox, Position)	确定某个位置是否在边界框中。
crossesAntimeridian(BoundingBox)	返回一个布尔值，指示边界框是否越过 antimeridian。
fromBoundingBox(BoundingBox)	克隆边界框。
fromData(FeatureCollection | Feature<Geometry, any> | Geometry | Shape | Array<FeatureCollection | Feature<Geometry, any> | Geometry | Shape>)	计算这些对象的 FeatureCollection、Feature、Geometry、Shape 或数组的边界框。
fromDimensions(Position, number, number)	从指定维度构造 BoundingBox。
fromEdges(number, number, number, number)	从指定的边缘构造 BoundingBox。
fromLatLngs(Array<object | number[]>)	从包含坐标信息的任何对象数组创建 BoundingBox。 每个对象都是 格式的数组;[lat， lng] 或 [lat， lng， elv] 或具有以下属性的任意组合的对象： 经度： lng， 经度， lon， x 纬度： lat， latitude， y Elevation： elv， elevation， alt， altitude， z
fromPositions(Position[])	创建包含所有提供的 Position 对象的 BoundingBox。
getCenter(BoundingBox)	计算边界框的中心。
getEast(BoundingBox)	返回边界框的东部位置值。
getHeight(BoundingBox)	获取边界框的高度（以度为单位）。
getNorth(BoundingBox)	返回边界框的北位置值。
getNorthEast(BoundingBox)	返回边界框的东北位置。
getNorthWest(BoundingBox)	返回边界框的西北位置。
getSouth(BoundingBox)	返回边界框的南位置值。
getSouthEast(BoundingBox)	返回边界框的东南位置。
getSouthWest(BoundingBox)	返回边界框的西南位置。
getWest(BoundingBox)	返回边界框的西部位置值。
getWidth(BoundingBox)	获取边界框的宽度（以度为单位）。
intersect(BoundingBox, BoundingBox)	确定是两个边界框相交的。
merge(BoundingBox, BoundingBox)	将两个边界框合并在一起。
splitOnAntimeridian(BoundingBox)	将跨越 Antimeridian 的 BoundingBox 拆分为两个 BoundingBox。 一个完全以西的安提默迪安，另一个完全在安提默迪安以东。

继承的方法

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[])	在数组的开头插入新元素。

构造函数详细信息

BoundingBox(number[])

构造 BoundingBox

new BoundingBox(positions: number[])

参数

positions

number[]

可以是 [west， south， east， north] 或 [west， south， elevation1， east， north， elevation2]

BoundingBox(Position, Position)

构造 BoundingBox。

new BoundingBox(southwestPosition: Position, northeastPosition: Position)

参数

southwestPosition

Position

边界框的西南最位置。

northeastPosition

Position

边界框的最东北位置。

属性详细信息

Array

static Array: ArrayConstructor

属性值

ArrayConstructor

继承属性详细信息

length

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

length: number

属性值

number

继承自 Array.length

方法详细信息

containsPosition(BoundingBox, Position)

确定某个位置是否在边界框中。

static function containsPosition(bounds: BoundingBox, position: Position): boolean

参数

bounds

BoundingBox

用于查看位置是否位于的边界框。

position

Position

用于查看它是否在边界框中的位置。

返回

boolean

如此 如果位置在边界框内。

crossesAntimeridian(BoundingBox)

返回一个布尔值，指示边界框是否越过 antimeridian。

static function crossesAntimeridian(bounds: BoundingBox): boolean

参数

bounds

BoundingBox

要检查的边界框。

返回

boolean

一个布尔值，指示边界框是否与时间线交叉。

fromBoundingBox(BoundingBox)

克隆边界框。

static function fromBoundingBox(boundingBox: BoundingBox): BoundingBox

参数

boundingBox

BoundingBox

要克隆的边界框。

返回

BoundingBox

fromData(FeatureCollection | Feature<Geometry, any> | Geometry | Shape | Array<FeatureCollection | Feature<Geometry, any> | Geometry | Shape>)

计算这些对象的 FeatureCollection、Feature、Geometry、Shape 或数组的边界框。

static function fromData(data: FeatureCollection | Feature<Geometry, any> | Geometry | Shape | Array<FeatureCollection | Feature<Geometry, any> | Geometry | Shape>): BoundingBox

参数

data

FeatureCollection | Feature<Geometry, any> | Geometry | Shape | Array<FeatureCollection | Feature<Geometry, any> | Geometry | Shape>

要计算其边界框的 FeatureCollection、Feature、Geometry、Shape 或数组。

返回

BoundingBox

格式为 [minLon， minLat， maxLon， maxLat] 的边界框。

fromDimensions(Position, number, number)

从指定维度构造 BoundingBox。

static function fromDimensions(center: Position, width: number, height: number): BoundingBox

参数

center

Position

边界框的中心位置。

width

number

边界框的宽度。

height

number

边界框的高度。

返回

BoundingBox

fromEdges(number, number, number, number)

从指定的边缘构造 BoundingBox。

static function fromEdges(west: number, south: number, east: number, north: number): BoundingBox

参数

west

number

边界框的西边缘。

south

number

边界框的南边缘。

east

number

边界框的东边缘。

north

number

边界框的北边缘。

返回

BoundingBox

fromLatLngs(Array<object | number[]>)

从包含坐标信息的任何对象数组创建 BoundingBox。 每个对象都是 格式的数组;[lat， lng] 或 [lat， lng， elv] 或具有以下属性的任意组合的对象： 经度： lng， 经度， lon， x 纬度： lat， latitude， y Elevation： elv， elevation， alt， altitude， z

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

参数

latLngs

Array<object | number[]>

包含坐标信息的对象。

返回

BoundingBox

包含提供的所有坐标信息的 BoundingBox。

fromPositions(Position[])

创建包含所有提供的 Position 对象的 BoundingBox。

static function fromPositions(positions: Position[]): BoundingBox

参数

positions

Position[]

用于生成边界框的位置数组。

返回

BoundingBox

包含所有给定位置的边界框。

getCenter(BoundingBox)

计算边界框的中心。

static function getCenter(bounds: BoundingBox): Position

参数

bounds

BoundingBox

用于计算 其中心的边界框。

返回

Position

一个表示边界框中心的位置。

getEast(BoundingBox)

返回边界框的东部位置值。

static function getEast(bounds: BoundingBox): number

参数

bounds

BoundingBox

要从中获取位置的边界框。

返回

number

边界框的向东位置值。

getHeight(BoundingBox)

获取边界框的高度（以度为单位）。

static function getHeight(bounds: BoundingBox): number

参数

bounds

BoundingBox

要检查的边界框。

返回

number

边界框的高度（以度为单位）。

getNorth(BoundingBox)

返回边界框的北位置值。

static function getNorth(bounds: BoundingBox): number

参数

bounds

BoundingBox

要从中获取位置的边界框。

返回

number

边界框的北边位置值。

getNorthEast(BoundingBox)

返回边界框的东北位置。

static function getNorthEast(bounds: BoundingBox): Position

参数

bounds

BoundingBox

要从中获取位置的边界框。

返回

Position

边界框的东北位置。

getNorthWest(BoundingBox)

返回边界框的西北位置。

static function getNorthWest(bounds: BoundingBox): Position

参数

bounds

BoundingBox

要从中获取位置的边界框。

返回

Position

边界框的西北位置。

getSouth(BoundingBox)

返回边界框的南位置值。

static function getSouth(bounds: BoundingBox): number

参数

bounds

BoundingBox

要从中获取位置的边界框。

返回

number

边界框的南位置值。

getSouthEast(BoundingBox)

返回边界框的东南位置。

static function getSouthEast(bounds: BoundingBox): Position

参数

bounds

BoundingBox

要从中获取位置的边界框。

返回

Position

边界框的东南位置。

getSouthWest(BoundingBox)

返回边界框的西南位置。

static function getSouthWest(bounds: BoundingBox): Position

参数

bounds

BoundingBox

要从中获取位置的边界框。

返回

Position

边界框的西南位置。

getWest(BoundingBox)

返回边界框的西部位置值。

static function getWest(bounds: BoundingBox): number

参数

bounds

BoundingBox

要从中获取位置的边界框。

返回

number

边界框的西部位置值。

getWidth(BoundingBox)

获取边界框的宽度（以度为单位）。

static function getWidth(bounds: BoundingBox): number

参数

bounds

BoundingBox

要检查的边界框。

返回

number

边界框的宽度（以度为单位）。

intersect(BoundingBox, BoundingBox)

确定是两个边界框相交的。

static function intersect(bounds1: BoundingBox, bounds2: BoundingBox): boolean

参数

bounds1

BoundingBox

要与之比较的第一个边界框。

bounds2

BoundingBox

要比较的第二个边界框。

返回

boolean

如果提供的边界框相交，则为 true。

merge(BoundingBox, BoundingBox)

将两个边界框合并在一起。

static function merge(bounds1: BoundingBox, bounds2: BoundingBox): BoundingBox

参数

bounds1

BoundingBox

要合并的第一个边界框。

bounds2

BoundingBox

要合并的第二个边界框。

返回

BoundingBox

格式为 [minLon， minLat， maxLon， maxLat] 的边界框。

splitOnAntimeridian(BoundingBox)

将跨越 Antimeridian 的 BoundingBox 拆分为两个 BoundingBox。 一个完全以西的安提默迪安，另一个完全在安提默迪安以东。

static function splitOnAntimeridian(bounds: BoundingBox): BoundingBox[]

参数

bounds

BoundingBox

返回

BoundingBox[]

继承的方法详细信息

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

最多可以接受三个参数的函数。 筛选器方法为数组中的每个元素调用一次 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

最多可以接受三个参数的函数。 筛选器方法为数组中的每个元素调用一次 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[]

要插入数组开头的元素。

返回

number

继承自 Array.unshift