YMaps.GeoPoint
Расширяет YMaps.ICoordPoint.
Класс для создания геоточки.
Конструктор
Имя | Описание |
---|---|
YMaps.GeoPoint(lng, lat, unbounded) | Создает точку, заданную географическими координатами (геоточку). |
Методы
Имя | Статический | Возвращает | Описание |
---|---|---|---|
distance(point) | Number | Возвращает кратчайшее расстояние между двумя точками земной поверхности (в метрах). | |
equals(point) | Boolean | Сравнивает две точки: точку, переданную параметром point и точку, для которой вызывается метод. Точки совпадают, если у них одинаковые значения координат по обеим осям с точностью до 8 знака после запятой и одинаковое значение флага ограниченности. | |
fromString(string) | YMaps.GeoPoint | Создает геоточку по ее строковому представлению. | |
getLat() | Number | Широта геоточки. | |
getLng() | Number | Долгота геоточки. | |
isUnbounded() | Boolean | Возвращает true, если геоточка неограниченная, иначе - false. | |
setLat(lat) | YMaps.GeoPoint | Устанавливает широту. | |
setLng(lng) | YMaps.GeoPoint | Устанавливает долготу. | |
toString(precision) | String | Возвращает строковое представление геоточки в виде "долгота,широта". |
Наследуемые методы
Подробное описание конструктора
YMaps.GeoPoint(lng, lat, unbounded)
Создает точку, заданную географическими координатами (геоточку). Позволяет создать как обычную (ограниченную) геоточку (с долготой в пределах от -180 до 180 градусов и широтой в пределах от -90 до 90 градусов), так и неограниченную (с произвольными долготой и широтой).
Параметры:
Имя | Тип | Необязательный | По умолчанию | Описание |
---|---|---|---|---|
lng |
Number | 0 | Долгота в градусах. | |
lat |
Number | 0 | Широта в градусах. | |
unbounded |
Boolean | false | Флаг, определяющий тип геоточки: true - неограниченная, false - ограниченная. |
Подробное описание методов
distance
{Number} distance(point)
Возвращает кратчайшее расстояние между двумя точками земной поверхности (в метрах).
Параметры:
Имя | Тип | Описание |
---|---|---|
point |
YMaps.GeoPoint | Точка, расстояние до которой требуется измерить |
Возвращает:
Тип | Описание |
---|---|
Number | Расстояние в метрах |
equals
{Boolean} equals(point)
Сравнивает две точки: точку, переданную параметром point и точку, для которой вызывается метод. Точки совпадают, если у них одинаковые значения координат по обеим осям с точностью до 8 знака после запятой и одинаковое значение флага ограниченности.
Параметры:
Имя | Тип | Описание |
---|---|---|
point |
YMaps.GeoPoint | Точка. |
Возвращает:
Тип | Описание |
---|---|
Boolean | true - точки совпадают, false - не совпадают. |
fromString
{YMaps.GeoPoint} fromString(string)
Создает геоточку по ее строковому представлению. Формат строкового представления: "долгота,широта".
Параметры:
Имя | Тип | Описание |
---|---|---|
string |
String | Строковое представление геоточки. |
Возвращает:
Тип | Описание |
---|---|
YMaps.GeoPoint | Геоточку. |
getLat
{Number} getLat()
Широта геоточки.
Возвращает:
Тип | Описание |
---|---|
Number | Широту. |
getLng
{Number} getLng()
Долгота геоточки.
Возвращает:
Тип | Описание |
---|---|
Number | Долготу геоточки. |
isUnbounded
{Boolean} isUnbounded()
Возвращает true, если геоточка неограниченная, иначе - false.
Возвращает:
Тип | Описание |
---|---|
Boolean | true - точка неограниченная; false - ограниченная. |
setLat
{YMaps.GeoPoint} setLat(lat)
Устанавливает широту.
Параметры:
Имя | Тип | Описание |
---|---|---|
lat |
Number | Широта. |
Возвращает:
Тип | Описание |
---|---|
YMaps.GeoPoint | Ссылку на себя. |
setLng
{YMaps.GeoPoint} setLng(lng)
Устанавливает долготу.
Параметры:
Имя | Тип | Описание |
---|---|---|
lng |
Number | Долгота. |
Возвращает:
Тип | Описание |
---|---|
YMaps.GeoPoint | Ссылку на себя. |
toString
{String} toString(precision)
Возвращает строковое представление геоточки в виде "долгота,широта".
Параметры:
Имя | Тип | Необязательный | По умолчанию | Описание |
---|---|---|---|---|
precision |
Integer | 6 | Точность, с которой округляются значения долготы и широты. |
Возвращает:
Тип | Описание |
---|---|
String | Строковое представление геоточки. |