util.bounds

Статический объект.

Набор статических методов для работы с прямоугольными областями, представленными в виде двух противоположных точек в координатной системе проекции.

Методы

Методы

Имя Возвращает Описание
areIntersecting (bounds1, bounds2[, projection])

Boolean

Определяет пересекаются ли две прямоугольные области.

containsBounds (outer, inner[, projection])

Boolean

Определяет содержат ли прямоугольная область другую прямоугольную область полностью.

containsPoint (bounds, point[, projection])

Boolean

Определяет содержат ли прямоугольная область точку.

fromBounds (sourceBounds[, projection])

Number[][]

Вычисляет прямоугольную область, в которую попадают все переданные.

fromGlobalPixelBounds (pixelBounds, zoom[, projection])

Number[][]

Производит перевод прямоугольной области из пиксельных координат в геокоординаты с учетом масштаба.

fromPoints (points[, projection])

Number[][]

Вычисляет минимальную прямоугольную область, в которую попадают все переданные точки.

getCenter (bounds[, projection])

Number[]

Вычисляет центр прямоугольникой области в координатной системе проекции.

getCenterAndZoom (bounds, containerSize[, projection[, params]])

Object

Вычисляет центр и уровень масштабирования, которые необходимо установить карте для того, чтобы полностью отобразить переданную область.

getIntersections (bounds1, bounds2[, projection])

Number[][][]

Возвращает все пересечения двух прямоугольных областей. В случае, если данные передаются в геокоординатах, то пересечений может быть больше одного. Если области не пересекаются, то возвращается пустой массив.

getSize (bounds[, projection])

Number[]

Вычисляет размеры прямоугольной области в координатной системе проекции.

toGlobalPixelBounds (geoBounds, zoom[, projection])

Number[][]

Производит перевод границ из геокоординат в глобальные пиксели с учетом масштаба.

Описание методов

areIntersecting

{Boolean} areIntersecting(bounds1, bounds2[, projection])

Определяет пересекаются ли две прямоугольные области.

Возвращает признак пересечения.

Параметры:

Параметр Значение по умолчанию Описание
bounds1 *

Тип: Number[][]

Первая область.

bounds2 *

Тип: Number[][]

Вторая область.

projection projection.wgs84Mercator

Тип: IProjection

Проекция.

* Обязательный параметр/опция.

containsBounds

{Boolean} containsBounds(outer, inner[, projection])

Определяет содержат ли прямоугольная область другую прямоугольную область полностью.

Возвращает признак попадания.

Параметры:

Параметр Значение по умолчанию Описание
outer *

Тип: Number[][]

Внешняя область

inner *

Тип: Number[][]

Проверяемая область.

projection projection.wgs84Mercator

Тип: IProjection

Проекция.

* Обязательный параметр/опция.

containsPoint

{Boolean} containsPoint(bounds, point[, projection])

Определяет содержат ли прямоугольная область точку.

Возвращает признак попадания.

Параметры:

Параметр Значение по умолчанию Описание
bounds *

Тип: Number[][]

Внешняя область

point *

Тип: Number[]

Проверяемая точка.

projection projection.wgs84Mercator

Тип: IProjection

Проекция.

* Обязательный параметр/опция.

fromBounds

{Number[][]} fromBounds(sourceBounds[, projection])

Вычисляет прямоугольную область, в которую попадают все переданные.

Возвращает вычисленная область.

Параметры:

Параметр Значение по умолчанию Описание
sourceBounds *

Тип: Number[][][]

Массив прямоугольных обласлей

projection projection.wgs84Mercator

Тип: IProjection

Проекция.

* Обязательный параметр/опция.

fromGlobalPixelBounds

{Number[][]} fromGlobalPixelBounds(pixelBounds, zoom[, projection])

Производит перевод прямоугольной области из пиксельных координат в геокоординаты с учетом масштаба.

Возвращает вычисленные границы в геокоординатах.

Параметры:

Параметр Значение по умолчанию Описание
pixelBounds *

Тип: Number[][]

Исходные границы.

zoom *

Тип: Number

Масштаб.

projection projection.wgs84Mercator

Тип: IProjection

Проекция, которая будет использоваться для вычисления геокоординат.

* Обязательный параметр/опция.

fromPoints

{Number[][]} fromPoints(points[, projection])

Вычисляет минимальную прямоугольную область, в которую попадают все переданные точки.

Возвращает вычисленная область.

Параметры:

Параметр Значение по умолчанию Описание
points *

Тип: Number[][]

Массив точек.

projection projection.wgs84Mercator

Тип: IProjection

Проекция.

* Обязательный параметр/опция.

getCenter

{Number[]} getCenter(bounds[, projection])

Вычисляет центр прямоугольникой области в координатной системе проекции.

Возвращает точку-центр в координатной системе входящих данных.

Параметры:

Параметр Значение по умолчанию Описание
bounds *

Тип: Number[][]

Область.

projection projection.wgs84Mercator

Тип: IProjection

Проекция.

* Обязательный параметр/опция.

getCenterAndZoom

{Object} getCenterAndZoom(bounds, containerSize[, projection[, params]])

Вычисляет центр и уровень масштабирования, которые необходимо установить карте для того, чтобы полностью отобразить переданную область.

Возвращает объект с полями center (Number[]) и zoom (Number).

Параметры:

Параметр Значение по умолчанию Описание
bounds *

Тип: Number[][]

Область, заданная в географических координатах. Первая точка содержит минимальные значения широты и долготы, вторая точка - максимальные.

containerSize *

Тип: Number[]

Размер контейнера карты.

projection projection.wgs84Mercator

Тип: IProjection

Проекция.

params

Тип: Boolean|Object

Параметры или значение опции preciseZoom.

params.inscribe true

Тип: Boolean

true - вписывать область в карту, false — вписывать карту в область.

params.margin 0

Тип: Number|Number[]

Отступы от границ видимой области карты. Если задано одно число - оно применяется ко всем сторонам. Если задано два - то это горизонтальные и вертикальные отступы соответственно. Если задан массив из 4х чисел, то это отступы top, right, bottom, left.

params.preciseZoom false

Тип: Boolean

При значении false уровень масштабирования будет округлен в меньшую сторону.

* Обязательный параметр/опция.

getIntersections

{Number[][][]} getIntersections(bounds1, bounds2[, projection])

Возвращает все пересечения двух прямоугольных областей. В случае, если данные передаются в геокоординатах, то пересечений может быть больше одного. Если области не пересекаются, то возвращается пустой массив.

Параметры:

Параметр Значение по умолчанию Описание
bounds1 *

Тип: Number[][]

Первая область.

bounds2 *

Тип: Number[][]

Вторая область.

projection projection.wgs84Mercator

Тип: IProjection

Проекция.

* Обязательный параметр/опция.

getSize

{Number[]} getSize(bounds[, projection])

Вычисляет размеры прямоугольной области в координатной системе проекции.

Возвращает размер области.

Параметры:

Параметр Значение по умолчанию Описание
bounds *

Тип: Number[][]

Область.

projection projection.wgs84Mercator

Тип: IProjection

Проекция.

* Обязательный параметр/опция.

toGlobalPixelBounds

{Number[][]} toGlobalPixelBounds(geoBounds, zoom[, projection])

Производит перевод границ из геокоординат в глобальные пиксели с учетом масштаба.

Возвращает вычисленные пиксельные границы.

Параметры:

Параметр Значение по умолчанию Описание
geoBounds *

Тип: Number[][]

Исходные границы.

zoom *

Тип: Number

Масштаб.

projection projection.wgs84Mercator

Тип: IProjection

Проекция, в координатной системе которой заданы геокоординаты.

* Обязательный параметр/опция.