Визиком Карты - подробная карта Киева, Донецка, Львова, Харькова, Одессы, Минска, Гомеля и других городов Украины и Белоруссии

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 2010-09-09. The original page over time could change.

Українська | Русский | English

visicom.ua | радиопланирование | наборы геоданных и гис-решения | gps-навигация | карты для полиграфии

Visicom Maps API 2.0.0
- Пошаговая установка
- Карта
- Маркеры
- Графика
- События
- Справочник API
- Пользовательские тайлы
Сервисы
- Справочник API
- Маршруты
- Адрес
- Поисковая форма
Переход с версии 1.0.0.

Visicom XML API 1.0.2
- getDatabases
- getMapDBVersion
- getLayers
- getMBR
- getNearest
- getPointer
- IdentifyObject
- getAddress
- getMapData
- getPOI
- getRoute
- getObjectGeometry
- getSystemIcons

Справочник API

Ядро

VMapObject VMap VLayer

VMarker VInfoWindow VMarkerIcon

VLabel VLine VMultiLine

VArea VRect

Класс VMapObject

Данный класс является базовым классом для всех объектов, размещаемых на карте.

JSON

{
    coords: [],
    type : "marker | line | area | label | layer",
    options: { },
    style: { }
}

coords - координаты объекта, задаются в массивом [{lng: ..., lat: ...}, {...}].
type - указывает на тип объекта. Типы для каждого из элементов указаны в их описании.
style - стиль отображения элемента.

Объектное представление:

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

Конструктор

VMapObject()

Методы

Название метода Возвращаемое значение Описание

visible(<Boolean> bool) Устанавливает флаг видимости объекта.

visible() <Boolean> Возвращает значение флага видимости объекта.

coords([{lng, lat}] coords) Устанавливает координаты объекта.

coords() [{lng, lat}] Возвращает координаты объекта.

move(<int> x, <int> y) Сдвиг объекта на определенное количество пикселях в экранных координатах.

bounds() <VRect> Возвращает границы объекта.

к оглавлению

Класс VRect

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

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

Конструктор

VRect([{lng, lat}, ...])

Методы

Название метода Возвращаемое значение Описание

leftBottom() <{lng, lat}> Возвращает левую нижнюю точку области.

rightTop() <{lng, lat}> Возвращает правую верхнюю точку области.

к оглавлению

Класс VInfoWindow

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

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

Конструктор

VInfoWindow(<String> header, <String> text, <object> options)

VInfoWindow(<String> html, <object> options)

Методы

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

scrollOnOpen(<Boolean> scrool_on_open) Устанавливает флаг прокрутки карты при открытии информационного окна.

size(<int> width, <int> height) Устанавливает размеры информационного окна в пикселях. Максимальные размеры окна 800x600 пикселей.

Методы наследуемые от VMapObject

Опции информационного окна

Идентификатор Описание

alwaysOpen информационное окно всегда будет открыто на экране.

canClose указывает можно ли пользователю закрыть информационное окно.

к оглавлению

Класс VLayer

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

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

Конструктор

VLayer()

Методы

Название метода Возвращаемое значение Описание

add(<VMapObject> object) Добавляет дочерний объект.

remove(<VMapObject> object) Удаляет дочерний объект.

visible(<Boolean> bool) Устанавливает флаг видимости объекта.

visible() <Boolean> Возвращает значение флага видимости объекта.

childs() <VMapObject[]> Возвращает перечень дочерних элементов.

к оглавлению

Класс VMap

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

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

Конструктор

VMap(<HTMLElement> viewport)

Методы

Название метода Возвращаемое значение Описание

сenter() <{lng, lat}> Возвращает координаты текущего центра карты.

сenter(<{lng, lat}>coords) Устанавливает координаты текущего центра карты.

сenter(<{lng, lat}>coords, <int> zoom) Устанавливает координаты текущего центра карты и уровень масштаба.

сenter(<VRect> rect) Устанавливает координаты текущего центра карты и уровень масштаба наиболее оптимальные для заданной области.

zoom() <int> Возвращает текущий уровень масштаба.

zoom(<int> index) Устанавливает текущий уровень масштаба (0..18).

repaint() Перерисовка карты.

add(<VMapObject> object) Добавляет дочерний объект.

remove(<VMapObject> object) Удаляет дочерний объект.

language() <String> Возвращает текущий язык карты (поддерживаемые языки: "ru", "ua", "en").

language(<String>lang) Устанавливает текущий язык карты (поддерживаемые языки: "ru", "ua", "en").

clientRect() <VRect> Возвращает координаты текущую видимую область пользователем.

События

Событие Возвращаемое значение Описание

mouseclick(<function> callback) {lng, lat} coords Клик мышью.

mousedown(<function> callback) {lng, lat} coords Нажатие клавиши мыши.

mouseup(<function> callback) {lng, lat} coords Отпускание клавиши мыши.

mousedblclick(<function> callback) {lng, lat} coords Двойной клик мышью.

Событие Описание

startdrag(<function> callback) Старт перетаскивания.

dragging(<function> callback) Перетаскивание.

enddrag(<function> callback) окончание перетаскивания.

Событие Описание

beforezoomchange(<function> callback) Событие происходит до смены масштаба. В случае, если функция callback возвращает false переключение масштаба блокируется.

onzoomchange(<function> callback) Событие происходит после смены масштаба.

к оглавлению

Класс VLabel

Текстовая метка.

JSON:

{
    coords: [],
    type : "label",
    html: "",
    childs: []
}

html - HTML-текст метки.

Объектное представление:

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

Конструктор

VLabel(<String> html)

Методы

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

html(<String> html) Устанавливает HTML-текст метки.

Методы наследуемые от VMapObject

к оглавлению

Класс VMarker

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

JSON

{
    coords: [{lng: 30.5214, lat: 50.4650}],
    type : "marker",
    options:
    {
        draggable: true
    }
}

coords - координаты объекта, задаются в свойстве coords массивом [{lng: ..., lat: ...}, {...}].
type - указывает на тип объекта. В случае VMapObject это "mapobject".Типы для каждого из элементов указаны в их описании.
childs - дочерние элементы.
style - стиль элемента. В случае, если у элемента нет стилей отображения, они берутся из элемента родителя.

Объектное представление:

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

Конструктор

VMarker(<{lng, lat}> object, <VMarkerIcon> [icon])

Методы

Название метода Возвращаемое значение Описание

info() Возвращает ссылку на текущее информационное окно маркера.

info(<VInfoWindow> info_window) VInfoWindow Устанавливает информационное окно для маркера.

info(<String> html, [options]) Устанавливает информационное окно с заданным HTML текстом.

info(<String> header, <String> text, [options]) Устанавливает информационное окно с заданным заголовком и HTML текстом.

draggable(<Boolean> draggable) <Boolean> Устанавливает флаг возможности перетаскивания маркера пользователем.

hint(<String> html) Устанавливает всплывающую подсказку. Задается HTML-текстом.

icon(<VMarkerIcon> icon) Устанавливает иконку для маркера.

Методы наследуемые от VMapObject

События

к оглавлению

Класс VMarkerIcon

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

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

Конструктор

VMarkerIcon(<int> width, <int> height, <String> image_src)

Методы

Название метода Возвращаемое значение Описание

height() <int> Возвращает размер изображения по вертикале.

source() <String> Возвращает путь к изображению.

width() <int> Возвращает размер изображения по горизонтале.

к оглавлению

Класс VLine

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

JSON:

{
    coords: [{lng: 30.5214, lat: 50.4650}, {lng: 30.5114, lat: 50.4550}],
    type : "line",
    style:
    {
        color: "#ff0000",
        lineWidth: 7,
        opacity: 0.4
    }
}

coords - перечень точек в линии.
style:
- color - цвет линии.
- lineWidth - ширина линии.
- opacity - прозрачность. Задается дробным значением в диапазоне 0..1.

Объектное представление:

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

Конструктор
VLine[{lng, lat}]

Методы

Название метода Возвращаемое значение Описание

color(<String> color) Устанавливает цвет линии (Примеры: "#ff00ff", "red", "white").

lineWidth(<int> lineWidth) Устанавливает ширину линии в пикселях.

opacity(<float> opacity) Устанавливает степень прозрачности для линии в диапазоне 0..1 (Примеры: 0.7, 1.0, 0.0).

distance() <int> Возвращает дистанцию в метрах.

Методы наследуемые от VMapObject

к оглавлению

Класс VMultiLine

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

JSON:

{
    coords: [ [{lng: 30.5214, lat: 50.4650}, {lng: 30.5114, lat: 50.4550}, ...],[...] ],
    type : "line",
    style:
    {
        color: "#ff0000",
        lineWidth: 7,
        opacity: 0.4
    }
}

coords - перечень точек в линии.
style:
- color - цвет линии.
- lineWidth - ширина линии.
- opacity - прозрачность. Задается дробным значением в диапазоне 0..1.

Объектное представление:

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

Конструктор
VMultiLine[ [{lng, lat}, ...], [...] ]

Методы

Методы наследуемые от VMapObject

Название метода Возвращаемое значение Описание

visible(<Boolean> bool) Устанавливает флаг видимости объекта.

visible() <Boolean> Возвращает значение флага видимости объекта.

coords([ [{lng, lat}, ...], [...] ] coords) Устанавливает координаты объекта.

coords() [ [{lng, lat}, ...], [...] ] Возвращает координаты объекта.

move(<int> x, <int> y) Сдвиг объекта на определенное количество пикселях в экранных координатах.

bounds() <VRect> Возвращает границы объекта.

к оглавлению

Класс VArea

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

JSON:

{
    coords: [{lng: 30.5214, lat: 50.4650},
        {lng: 30.5114, lat: 50.4550},
        {lng: 30.5614, lat: 50.4550}],
    type: "area",
    style:
    {
        color: "#ff0000",
        opacity: 0.4
    }
}

coords - массив точек в полигоне.
style:
- color - цвет заливки.
- opacity - прозрачность. Задается дробным значением в диапазоне 0..1.

Объектное представление:

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

Конструктор

VArea([{lng, lat}] coords)

Методы

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

color(<String> color) Устанавливает цвет полигона (примеры: "#ff00ff", "red", "white").

opacity(<float> opacity) Возвращает/устанавливает степень прозрачности. Для полигона это значение по-умолчанию равняется 0,35.

Методы наследуемые от VMapObject

к оглавлению