Базовые типы
LatLng
Представляет географическое местоположение через ширину и долготу
var latLng1 = new GeoPortal.LatLng(100, -200);
/*получим место с координатами (90, -180)*/
var latLng2 = new GeoPortal.LatLng(55.824872, 49.086084);
/*местоположение, соответствующее Казани на карте maps.google.com*/
Конструктор
new GeoPortal.LatLng(<Number> rawLat, <Number> rawLng, <Boolean> noWrap)
Параметры:
- <Number> rawLat — широта
- <Number> rawLng — долгота
- <Boolean> noWrap — флаг, указывающий, необходимо ли ограничивать значения rawLat и rawLng максимально и минимально доступными — [-90..90] и [-180..180], соответственно. Например, при new GeoPortal.LatLng(100, -200, true) будет создан объект с широтой 100 и долготой -200, а при GeoPortal.LatLng(100, -200, false) — с широтой 90 и долготой -180. Значение по умолчанию — false.
Константы
Константа | Описание |
---|---|
DEG_TO_RAD | коэффициент преобразования градусов в радианы |
RAD_TO_DEG | коэффициент преобразования радиан в градусы |
MAX_MARGIN | максимальная погрешность координат (10^(-9)) |
Свойства
Свойство | Тип | Описание |
---|---|---|
lat | Number | широта |
lng | Number | долгота |
Исключения
Invalid LatLng object: (<rawLat>, <rawLng>) — возникает при создании объекта в случае, если хотя бы один из параметров rawLat или rawLng отсутствует или не является числом, например new GeoPortal.LatLng(10) или new GeoPortal.LatLng(«dummy»)
Методы
Метод | Возвращает | Описание |
---|---|---|
equals (<GeoPortal.LatLng> latLng)
<GeoPortal.LatLng> latLng — объект координат для сравнения |
Boolean (true — если совпадают, и false — если не совпадают ) | Сравнивает значения имеющихся координат с передаваемыми. |
toString() | String | возвращает строку вида «LatLng(<lat>, <lng>)» |
distanceTo (<GeoPortal.LatLng> latLng)
<GeoPortal.LatLng> latLng — заданная точка |
Number | Возвращает расстояние до заданной точки от текущей точки |
LatLngBounds
Представляет область, определяемую заданными географическими границами
var latLng1 = new GeoPortal.LatLng(100, -200);
/*получим место с координатами (90, -180)*/
var latLng2 = new GeoPortal.LatLng(55.824872, 49.086084);
/*местоположение, соответствующее Казани на карте maps.google.com*/
var bounds = new GeoPortal.LatLngBounds(latLng1, latLng2);
/*границы, определяемые этими точками*/
map.fitBounds(bounds)
/*покажет область карты, заданную этими границами*/
Конструктор
new GeoPortal.LatLngBounds(<GeoPortal.LatLng> southWest, <GeoPortal.LatLng> northEast)
Параметры:
- <GeoPortal.LatLng> southWest — точка, описывающая южную и западную границы
- <GeoPortal.LatLng> northEast — точка, описывающая северную и восточную границы
new GeoPortal.LatLngBounds(<Array GeoPortal.LatLng> latLngs
Параметры:
- <Array GeoPortal.LatLng> latLngs — массив точек, формирующих границы
Константы
Константа | Описание |
---|---|
DEG_TO_RAD | коэффициент преобразования градусов в радианы |
RAD_TO_DEG | коэффициент преобразования радиан в градусы |
MAX_MARGIN | максимальная погрешность координат (10^(-9)) |
Методы
Метод | Возвращает | Описание |
---|---|---|
extend (<GeoPortal.LatLng> latLng)
<GeoPortal.LatLng> latLng — объект координат для сравнения |
void | При необходимости расширяет границы таким образом, чтобы в них входила точка с заданными координатами |
center() | GeoPortal.LatLng | Вычисляет и возвращает координаты центра области, заданной координатами границ |
southWest() | GeoPortal.LatLng | Возвращает координаты точки, описывающей южную и западную границы |
northEast() | GeoPortal.LatLng | Возвращает координаты точки, описывающей северную и восточную границы |
southEast() | GeoPortal.LatLng | Возвращает координаты точки, описывающей южную и восточную границы |
northWest() | GeoPortal.LatLng | Возвращает координаты точки, описывающей северную и западную границы |
contains (<GeoPortal.LatLng> latLng)
<GeoPortal.LatLng> latLng — точка |
Boolean | Проверяет, входит ли заданная точка в построенные границы |
contains (<GeoPortal.LatLngBounds> latLngBounds)
<GeoPortal.LatLngBounds> latLngBounds — область |
Boolean | Проверяет, входит ли заданная область в построенные границы |
intersects (<GeoPortal.LatLngBounds> latLngBounds)
<GeoPortal.LatLngBounds> latLngBounds — область |
Boolean | Проверяет, есть ли пересечение с заданной областью |
toBBoxString() | String | Возвращает координаты границ в строке вида «<west>,<south>,<east>,<north>» |
Point
Представляет расположение в двумерной системе координат, где x соответствует горизонтальной оси, а y — вертикальной.
var point1 = new GeoPortal.Point(55.824872, 49.086084);
/*получим точку с координатами (55.824872, 49.086084)*/
var point2 = new GeoPortal.Point(55.824872, 49.086084, true);
/*получим точку с координатами (55, 49)*/
Конструктор
new GeoPortal.Point(<Number> x, <Number> y, <Boolean> round)
Параметры:
- <Number> x — горизонтальная координата точки.
- <Number> y — вертикальная координата точки.
- <Boolean> round — флаг, указывающий, необходимо ли округлять значения x и y до целых чисел. Значение по умолчанию — false.
Свойства
Свойства | Описание |
---|---|
<Number> x | горизонтальная координата точки |
<Number> y | вертикальная координата точки |
Методы
Метод | Возвращает | Описание |
---|---|---|
add (<GeoPortal.Point> point)
<GeoPortal.Point> point — добавляемая точка |
GeoPortal.Point | Создает новую точку путем добавления координат заданной точки к координатам текущей точки |
subtract (<GeoPortal.Point> point)
<GeoPortal.Point> point — вычитаемая точка |
GeoPortal.Point | Создает новую точку путем вычитания координат заданной точки из координат текущей точки |
divideBy (<Number> num, <Boolean> round)
<Number> num — делитель <Boolean> round — флаг, определяющий, необходимо ли округлять результат до целого числа |
GeoPortal.Point | Создает новую точку путем деления координат текущей точки на заданный делитель |
multiplyBy (<Number> num)
<Number> num — множитель |
GeoPortal.Point | Создает новую точку путем умножения координат текущей точки на заданный множитель |
distanceTo (<GeoPortal.Point> point) <GeoPortal.Point> point — заданная точка |
Number | Возвращает расстояние до точки с заданными координатами от текущей точки |
round() | GeoPortal.Point | Создает новую точку путем округления координат текущей точки до целых чисел |
clone() | GeoPortal.Point | Создает копию текущей точки |
toString() | String | Возвращает строку вида «Point(<x>, <y>)», значения координат при этом округлены до пятого знака после запятой |
Icon
Иконка точечных географических объектов
var icon = new GeoPortal.Icon();
var marker = new GeoPortal.Marker(latLng, {icon: icon});
map.addLayer(pointMarker);
Конструктор
new GeoPortal.Icon(<String> iconUrl)
Параметры:
- iconUrl — url основной картинки
Свойства
Свойства | Описание |
---|---|
<String> iconUrl | url основной картинки. Значение по умолчанию — GeoPortal.basePath + «/public/images/mapsurfer/marker.png» |
<String> shadowUrl | url картинки тени. Значение по умолчанию — GeoPortal.basePath + «/public/images/mapsurfer/marker-shadow.png» |
<GeoPortal.Point> iconSize | размеры иконки. Значение по умолчанию — GeoPortal.Point(49, 52) |
<GeoPortal.Point> shadowSize | размеры тени. Значение по умолчанию — GeoPortal.Point(41, 41) |
<GeoPortal.Point> iconAnchor | смещение иконки относительно точки координат. Значение по умолчанию — GeoPortal.Point(13, 41) |
<GeoPortal.Point> popupAnchor | точка появления всплывающего окна. Значение по умолчанию — GeoPortal.Point(0, -33) |
Методы
Метод | Возвращает | Описание |
---|---|---|
createIcon() | HTMLImageElement или HTMLDivElement | Возвращает HTML-объект с иконкой |
createShadow() | HTMLImageElement или HTMLDivElement | Возвращает HTML-объект с тенью иконки |
FilterCQL
Фильтр отображения объектов слоя. Фильтрация производится по полям, доступным в атрибутике слоя. При создании фильтра необходимо указать список условий фильтрации. Условие фильтрации включает в себя название и тип поля (можно получить из атрибутики слоя) и значение для сравнения. Для числовых полей также необходимо указать условие сравнения
var filterCQL = new GeoPortal.Filter.CQL([
{
field: "nomerdoma",
compare: ">",
type: "integer",
value: "90"
},
{
field: "organization",
type: "string",
value: "ООО Дома"
}
]);
workingLayer.setFilter(filterCQL);
Конструктор
new GeoPortal.Filter.CQL (<Array> filters)
Параметры:
<Array> filters — массив объектов с полями:
- <String> field — название поля, по которому происходит фильтрация
- <String> compare — условие прохождения фильтрации («>», «<«, «=»). Необходимо только для численных полей
- <String> type — тип поля
- <String> value — значение, по которому происходит фильтрация
Исключения
Input parameters are not correct! — возникает при создании объекта без указания параметров, либо если параметр не является массивом, например new GeoPortal.Filter.CQL(null) или new GeoPortal.Filter.CQL(123)
Методы
Метод | Возвращает | Описание |
---|---|---|
filters() | Array | Возвращает массив фильтров, указанных при создании объекта (см. Конструктор) |
filterString() | String | Используется для получения сформированной строки CQL-запроса для заданного в объекте набора фильтров |