This version of the page http://maps.visicom.ua/api-docs/vmapi/api-reference (0.0.0.0) stored by archive.org.ua. It represents a snapshot of the page as of 2009-09-19. The original page over time could change.
Справочник API функций - Visicom Maps API
GPS-навигаторы | Карты для полиграфии | Радиопланирование

Справочник API 

VBounds VEdge VGeoPoint
VInfoWindow VLayer VMapEngine
VMarker VMarkerIcon VPoint
VRoute VRouteService VEvents
VPolyline VPolygone


Класс VBounds

Прямоугольная область на карте. Задается 2-мя точками в локальных координатах системы.

Конструкторы

Конструктор
VBounds(<VPoint> pointMin, <VPoint> pointMax)

Методы

Название метода Возвращаемое значение Описание
getMaxPoint() <VPoint>  Возвращает конечную точку области.
getMinPoint() <VPoint>  Возвращает начальную точку области.

к оглавлению




Класс VEdge

Участок маршрута.

Конструкторы

Конструктор
VEdge(<VPoint[]> points, <VRoute> route)

Методы

Название метода Возвращаемое значение Описание
getPoints() <VPoint[]>  Возвращает массив точек.
getPolyline() <VPolyline>  Возвращает кривую.
hide() Скрытие участка.
show() Отображение участка.

к оглавлению




Пространство имен VEvents

В данном пространстве имен находятся функции для работы с событиями.

Функции

Название Описание
addListener([object], event_name, handler) Добавляет обработчик события.

[object] - объект, события которого будут прослушиваться,
event_name - названия события,
handler - обработчик события.

Если параметр object не задан, будут прослушиваться события карты.
removeListener([object], handler) Удаляет обработчик события.

[object] - объект, обработчик события которого удаляется,
handler - обработчик события.

Если параметр object не задан, удаляется событие карты.

к оглавлению




Класс VGeoPoint

Географическая точка на карте.

Конструкторы

Конструктор
VGeoPoint(<float> longitude, <float> latitude)

Методы

Название метода Возвращаемое значение Описание
convertToLocalPoint() <VPoint>  Конвертирует координаты точки в "локальные" координаты.
getLatitude() float Возвращает широту.
getLongitude() float Возвращает долготу.

к оглавлению




Класс VInfoWindow

Информационное окно маркера используется для создания комментария, описания к данной точке.
Позволяет задать HTML текст для заголовка и описания. По умолчанию информационное окно открывается при клике на маркере.

Конструкторы

Конструктор
VInfoWindow(<String> header, <String> html, <int> [width], <int> [height])
VInfoWindow(<String> header, <String> html, <object> [size])

Методы

Название метода Возвращаемое значение Описание
hide() Скрывает инофрмационное окно.
isAlwaysOpen() Boolean Возвращает значение флага always_open.
isVisible() Boolean Возвращает флаг видимости.
setAlwaysOpen(<Boolean> always_open) По-умолчанию информационное окно закрывается при клике на области карты либо вызове каких-либо других действий. Установка флага always_open в true закрепит данное окно на экране.
setScrollOnOpen(<Boolean> scrool_on_open) Устанавливает флаг прокрутки карты при открытии информационного окна.
setSize(<object> size) Устанавливает размер информационного окна одним из предопределенных размеров: VInfoWindow.SMALL, VInfoWindow.MEDIUM, VInfoWindow.LARGE.
setSize(<int> width, <int> height) Устанавливает размеры информационного окна в пикселях. Максимальные размеры окна 800x600 пикселей.
show(<VGeoPoint> point) Отображает инофрмационное окно в заданной точке.
show(<VPoint> point) Отображает инофрмационное окно в заданной точке.

События

Название события Аргументы Описание
open   Открытие информационного окна.
close   Закрытие информационного окна.

к оглавлению




Класс VLayer

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

Конструкторы

Конструктор
VLayer()

Методы

Название метода Возвращаемое значение Описание
addMarker(<VMarker> marker) Добавляет маркер на слой.
addPolygone(<VPolygone> polygone) Добавляет полигон на слой.
addPolyline(<VPolyline> polyline) Добавляет линию на слой.
addRoute(<VRoute> route) Добавляет маршрут на слой.
getMarkers() <VMarker[]>  Возвращает массив маркеров.
getPolygones() <VPolygone[]>  Возвращает массив полигонов.
getPolylines() <VPolyline[]>  Возвращает массив линий.
getRoutes() <VRoute[]>  Возвращает массив маршрутов.
hide() Скрывает слой.
removeMarker(<VMarker> marker) Удаляет маркер со слоя.
removePolygone(<VPolygone> polygone) Удаляет полигон со слоя.
removePolyline(<VPolyline> polyline) Удаляет линию со слоя.
removeRoute(<VRoute> route) Удаляет маршрут со слоя.
show() Отображает слой.

к оглавлению




Класс VMapEngine

VMapEngine является основным классом "движка" интернет-карты.

Конструкторы

Конструктор
VMapEngine(<HTMLElement> viewport)

Методы

Название метода Возвращаемое значение Описание
addLayer(<VLayer> layer) Добавляет слой.
addMarker(<VMarker> marker) Добавляет маркер на карту.
addPolygone(<VPolygone> polygone) Добавляет полигон на карту.
addPolyline(<VPolyline> polyline) Добавляет кривую на карту.
addRoute(<VRoute> route) Добавляет маршрут на карту.
createBounds(<VPoint[]> points) Создает область по перечню точек.
getCenter() <VPoint>  Возвращает координаты текущего центра карты.
getClientRect() <VBounds>  Возвращает видимую пользователем область на карте.
getZoomIndex() int Возвращает текущий индекс масштаба.
panTo(<VGeoPoint> point) Плавное перемещение к указанной точке.
panTo(<VPoint> point) Плавное перемещение к указанной точке.
removeLayer(<VLayer> layer) Удаляет слой.
removeMarker(<VMarker> marker) Удаляет маркер с карты.
removePolygone(<VPolygone> polygone) Удаляет полигон с карты.
removePolyline(<VPolyline> polyline) Удаляет кривую с карты.
removeRoute(<VRoute> route) Удаляет маршрут с карты.
repaintMap() Перерисовка карты.
resizeViewport() Данный метод необходимо вызывать в случае изменения размеров области карты.
setCenter(<VPoint> point, <int> [zoom_index]) Установка центра карты и масштаба.
setCenter(<VBounds> bounds) Установка центра карты и масштаба, на котором заданная область будет видна.
setZoomIndex(<int> zoom_index) Устанавливает текущий индекс масштаба.
showMap() Отображение карты.
switchMap(<String> mapName, <String> language, <function> callback) Меняет карту и/или язык. Доступные значения базы "ukraine". Языки: "ua", "ru", "en". Пример переключения карты на украинский язык: map.switchMap("ukraine", "ua"); Функция callback задается пользователем и вызывается, когда смена карты происходит.
zoomIn() Увеличивает масштаб на единицу.
zoomOut() Уменьшает масштаб на единицу.

События

Название события Аргументы Описание
События карты
zoomchange <Integer> old_index, <Integer> new_index Смена индекса масштаба.
startdrag <VPoint> point Начало перемещения карты.
dragging <VPoint> point Перемещение карты.
enddrag <VPoint> point Окончание перемещения карты.
События мыши
mouseclick <VPoint> point Клик.
mousedown <VPoint> point Нажатие клавиши мыши.
mousemove <VPoint> point Движение мышью.
mousedblclick <VPoint> point Двойной клик.
mouseup <VPoint> point Отпускание клавиши мыши.

к оглавлению




Класс VMarker

Маркер применяется для отметки определенной точки на карте.
Для маркера можно задавать собственное изображение и информационное окно, описывающее данную точку. Инициализировать можно как географическими координатами так и локальными.

Конструкторы

Конструктор
VMarker(<VPoint> point, <VMarkerIcon> [icon])
VMarker(<VGeoPoint> point, <VMarkerIcon> [icon])

Методы

Название метода Возвращаемое значение Описание
bindInfoWindow(<VInfoWindow> info_window) Устанавливает информационное окно маркера.
closeInfoWindow() Закрывает информационное окно маркера.
getPoint() <VPoint>  Возвращает точку, к которой привязан маркер.
hide() Скрытие маркера.
isDraggable() Boolean Возвращает значение флага, указывающего на возможность перетаскивания пользователем.
isVisible() Boolean Возвращает значение флага видимости маркера.
openInfoWindow() Открывает информационное окно маркера.
setDraggable(<Boolean> draggable) Устанавливает флаг возможности перетаскивания пользователем.
setHint(<String> text) Устанавливает всплывающую подсказку.
setIcon(<VMarkerIcon> icon) Устанавливает изображение для маркера.
setPoint(<VPoint> point) Привязывает маркер к точке на карте.
show() Отображение маркера.

События

Название события Аргументы Описание
События карты
startdrag <VPoint> point Начало перетаскивания маркера.
dragging <VPoint> point Перетаскивание маркера.
enddrag <VPoint> point Окончание перетаскивания маркера.
События мыши
mouseclick <VPoint> point Клик мышью.
mousedown <VPoint> point Нажатие клавиши мыши.
mousemove <VPoint> point Движение мышью.
mousedblclick <VPoint> point Двойной клик мышью.
mouseup <VPoint> point Отпускание клавиши мыши.

к оглавлению




Класс VMarkerIcon

VMarkerIcon позволяет задать для маркера определенное изображение.

Конструкторы

Конструктор
VMarkerIcon(<int> width, <int> height, <String> image_src, <Boolean> [alpha_enable])

Методы

Название метода Возвращаемое значение Описание
getHeight() Возвращает ширину.
getImageSource() Возвращает путь к изображению.
getWidth() Возвращает длинну.
isAlphaEnabled() Возвращает флаг альфа прозрачности для PNG изображений.
setAlphaEnable(<Boolean> enable) Устанавливает альфа прозрачность для PNG изображений.

к оглавлению




Класс VPoint

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

Конструкторы

Конструктор
VPoint(<int> x, <int> y)

Методы

Название метода Возвращаемое значение Описание
convertToGeoPoint() <VGeoPoint>  Перевод в географическую проекцию.
getX() int Возвращает локальную координату по оси X.
getY() int Возвращает локальную координату по оси Y.
setX(<int> x) Устанавливает координату по оси X.
setY(<int> y) Устанавливает координату по оси Y.
distanceTo(<VPoint> point) int Возвращает расстояние между точками в метрах.

к оглавлению




Класс VRoute

Маршрут.

Конструкторы

Конструктор
VRoute(<VEdge[]> edges)

Методы

Название метода Возвращаемое значение Описание
addEdge(<Edge> edge) Добавление участка.
getDistance() float Возвращает дистанцию по маршруту.
getEdges() <VEdge[]>  Возвращает массив участков.
hide() Скрытие маршрута.
setDistance(<float> distance) Устанавливает дистанцию по маршруту.
show() Отображение маршрута.

к оглавлению




Класс VRouteService

Сервис для расчета маршрутов на ГИС-сервере Визикома.

Конструкторы

Конструктор
VRouteService()

Методы

Название метода Возвращаемое значение Описание
calculateRoute(<VGeoPoint> pointFrom, <VGeoPoint> pointTo, <function> callback) Расчет маршрута. В функцию callback передается параметр route, являющийся оптимальным автомобильным маршрутом с точки зрения ГИС-сервера.
calculateRoute(<VPoint> pointFrom, <VPoint> pointTo, <function> callback) Расчет маршрута. В функцию callback передается параметр route, являющийся оптимальным автомобильным маршрутом с точки зрения ГИС-сервера.

к оглавлению




Класс VPolyline

Ломаная линия. Применяется для отрисовки маршрутов, треков и т.п.

Конструкторы

Конструктор
VPolyline(<VPoint[]> array_of_points)

Методы

Название метода Возвращаемое значение Описание
hide() Скрытие объекта.
isVisible() Boolean Возвращает флаг видимости.
setColor(<int> color) Устанавливает цвет линии.
setLineWidth(<int> lineWidth) Устанавливает цвет линии.
setOpacity(<float> opacity) Устанавливает степень прозрачности.
show() Отображение линии.

к оглавлению




Класс VPolygone

Полигон. Применяется для отметки площадных объектов.

Конструкторы

Конструктор
VPolygone(<VPoint[]> array_of_points)

Методы

Название метода Возвращаемое значение Описание
hide() Скрытие объекта.
isVisible() Boolean Возвращает флаг видимости.
setColor(<int> color) Устанавливает цвет полигона.
setLineWidth(<int> lineWidth) Устанавливает цвет линии.
setOpacity(<float> opacity) Устанавливает степень прозрачности. Для полигона это значение по-умолчанию равняется 0,35.
show() Отображение полигона.

к оглавлению