YMaps.ICoordBounds

Интерфейс объекта, представляющего собой прямоугольную область на карте. Этот интерфейс требуется реализовывать при создании пользовательской координатной системы. Примером такой реализации является YMaps.GeoBounds.

Конструктор

Имя Описание
YMaps.ICoordBounds(leftBottom, rightTop) Интерфейс объекта, представляющего собой прямоугольную область на карте.

Методы

Имя Возвращает Описание
contains(coordPoint) Boolean Возвращает true, если переданная точка попадает в область, false - если не попадает.
copy() YMaps.ICoordBounds Возвращает копию объекта.
equals(coordBounds) Boolean Сравнивает два объекта, представляющих области на карте.
getBottom() Number Возвращает нижнюю границу области.
getCenter() YMaps.ICoordPoint Возвращает центр области в виде точки координатной системы.
getLeft() Number Возвращает левую границу области.
getLeftBottom() YMaps.ICoordPoint Возвращает левый нижний угол области в виде точки координатной системы.
getLeftTop() YMaps.ICoordPoint Возвращает левый верхний угол области в виде точки координатной системы.
getMapZoom(map) Number Возвращает коэффициент масштабирования, при котором данная прямоугольная область будет видна на карте целиком.
getRight() Number Возвращает правую границу области.
getRightBottom() YMaps.ICoordPoint Возвращает правый нижний угол области в виде точки координатной системы.
getRightTop() YMaps.ICoordPoint Возвращает правый верхний угол области в виде точки координатной системы.
getSpan() YMaps.Size Возвращает линейные размеры области в виде объекта YMaps.Size.
getTop() Number Возвращает верхнюю границу области.

Подробное описание конструктора

YMaps.ICoordBounds(leftBottom, rightTop)

Интерфейс объекта, представляющего собой прямоугольную область на карте.

Параметры:

Имя Тип Описание
leftBottom YMaps.ICoordPoint Левый нижний угол области в виде точки координатной системы.
rightTop YMaps.ICoordPoint Правый верхний угол области в виде точки координатной системы.

Подробное описание методов

contains

{Boolean} contains(coordPoint)

Возвращает true, если переданная точка попадает в область, false - если не попадает.

Параметры:

Имя Тип Описание
coordPoint YMaps.ICoordPoint Точка в координатной системе.

Возвращает:

Тип Описание
Boolean true - попадает в область, false - не попадает.

copy

Возвращает копию объекта.

Возвращает:

Тип Описание
YMaps.ICoordBounds Копию объекта.

equals

{Boolean} equals(coordBounds)

Сравнивает два объекта, представляющих области на карте. Сравнивается текущая область и область заданная параметром coordBounds. Функция возвращает true, если объекты представляют идентичные области.

Параметры:

Имя Тип Описание
coordBounds YMaps.ICoordBounds Область на карте.

Возвращает:

Тип Описание
Boolean true - области совпадают, false - области не совпадают.

getBottom

{Number} getBottom()

Возвращает нижнюю границу области.

Возвращает:

Тип Описание
Number Нижнюю границу области.

getCenter

{YMaps.ICoordPoint} getCenter()

Возвращает центр области в виде точки координатной системы.

Возвращает:

Тип Описание
YMaps.ICoordPoint Центр области.

getLeft

{Number} getLeft()

Возвращает левую границу области.

Возвращает:

Тип Описание
Number Левую границу области.

getLeftBottom

{YMaps.ICoordPoint} getLeftBottom()

Возвращает левый нижний угол области в виде точки координатной системы.

Возвращает:

Тип Описание
YMaps.ICoordPoint Левый нижний угол области.

getLeftTop

{YMaps.ICoordPoint} getLeftTop()

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

Возвращает:

Тип Описание
YMaps.ICoordPoint Левый верхний угол области.

getMapZoom

{Number} getMapZoom(map)

Возвращает коэффициент масштабирования, при котором данная прямоугольная область будет видна на карте целиком.

Параметры:

Имя Тип Описание
map YMaps.Map Карта, для которой требуется вычислить коэффициент масштабирования.

Возвращает:

Тип Описание
Number Коэффициент масштабирования.

getRight

{Number} getRight()

Возвращает правую границу области.

Возвращает:

Тип Описание
Number Правую границу области.

getRightBottom

{YMaps.ICoordPoint} getRightBottom()

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

Возвращает:

Тип Описание
YMaps.ICoordPoint Правый нижний угол области.

getRightTop

{YMaps.ICoordPoint} getRightTop()

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

Возвращает:

Тип Описание
YMaps.ICoordPoint Правый верхний угол области.

getSpan

{YMaps.Size} getSpan()

Возвращает линейные размеры области в виде объекта YMaps.Size.

Возвращает:

Тип Описание
YMaps.Size Размеры области.

getTop

{Number} getTop()

Возвращает верхнюю границу области.

Возвращает:

Тип Описание
Number Верхнюю границу области.