|
|
|
Довідник API
Ядро
Клас VMapObject
Даний клас являється базовим класом для всіх об'єктів, розміщених на карті.
JSON
{
coords: [],
type : "marker | line | area | label | layer",
options: { },
style: { }
}
- coords - координати об'єкту, задаються масивом [{lng: ..., lat: ...}, {...}].
- type - вказує на тип об'єкту.
Типи для кожного з елементів вказані в їх описі.
- style - стиль відображення элемента.
Об'єктне представлення:
Конструктори
Методи
| Назва методу |
Значення, що повертається |
Опис |
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
| Назва методу |
Значення, що повертається |
Опис |
visible(<Boolean> bool) |
|
Встановлює флаг видимості об'єкту. |
visible() |
<Boolean> |
Повертає значення флагу видимості об'єкту. |
coords([{lng, lat}] coords) |
|
Встановлює координати об'єкту. |
coords() |
[{lng, lat}] |
Повертає координати об'єкту. |
move(<int> x, <int> y) |
|
Переміщає об'єкт на певну кількість пікселів в екранних координатах. |
bounds() |
<VRect> |
Повертає межі об'єкту. |
Опції інформаційного вікна
| Ідентифікатор |
Опис |
alwaysOpen |
Інформаційне вікно завжди буде відкрито на екрані. |
canClose |
Вказує чи можна користувачу закрити інформаційне вікно. |
до змісту
Клас 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: []
}
Об'єктне представлення:
Конструктори
| Конструктор |
VLabel(<String> html) |
Методи
| Назва методу |
Опис |
html(<String> html) |
Встановлює HTML-текст мітки. |
Методи, які наслідуються від VMapObject
| Назва методу |
Значення, що повертається |
Опис |
visible(<Boolean> bool) |
|
Встановлює флаг видимості об'єкту. |
visible() |
<Boolean> |
Повертає значення флагу видимості об'єкту. |
coords([{lng, lat}] coords) |
|
Встановлює координати об'єкту. |
coords() |
[{lng, lat}] |
Повертає координати об'єкту. |
move(<int> x, <int> y) |
|
Переміщає об'єкт на певну кількість пікселів в екранних координатах. |
bounds() |
<VRect> |
Повертає межі об'єкту. |
до змісту
Клас 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
| Назва методу |
Значення, що повертається |
Опис |
visible(<Boolean> bool) |
|
Встановлює флаг видимості об'єкту. |
visible() |
<Boolean> |
Повертає значення флагу видимості об'єкту. |
coords([{lng, lat}] coords) |
|
Встановлює координати об'єкту. |
coords() |
[{lng, lat}] |
Повертає координати об'єкту. |
move(<int> x, <int> y) |
|
Переміщає об'єкт на певну кількість пікселів в екранних координатах. |
bounds() |
<VRect> |
Повертає межі об'єкту. |
Події
| Подія |
Опис |
startdrag(<function> callback) |
Старт перетягування. |
dragging(<function> callback) |
Перетягування. |
enddrag(<function> callback) |
Закінчення перетягування. |
до змісту
Клас 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(<VPoint[]> array_of_points) |
Методи
| Назва методу |
Значення, що повертається |
Опис |
color(<String> color) |
|
Встановлює колір лінії (Приклади: "#ff00ff", "red", "white"). |
lineWidth(<int> lineWidth) |
|
Встановлює ширину лінії в пікселях. |
opacity(<float> opacity) |
|
Встановлює ступінь прозорості для лінії в діапазоні 0..1 (Приклади: 0.7, 1.0, 0.0). |
distance() |
<int> |
Повертає дистанцію в метрах. |
Методи, які наслідуються від VMapObject
| Назва методу |
Значення, що повертається |
Опис |
visible(<Boolean> bool) |
|
Встановлює флаг видимості об'єкту. |
visible() |
<Boolean> |
Повертає значення флагу видимості об'єкту. |
coords([{lng, lat}] coords) |
|
Встановлює координати об'єкту. |
coords() |
[{lng, lat}] |
Повертає координати об'єкту. |
move(<int> x, <int> y) |
|
Переміщає об'єкт на певну кількість пікселів в екранних координатах. |
bounds() |
<VRect> |
Повертає межі об'єкту. |
до змісту
Класс 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}, ...], [...] ] |
Методи
| Назва метода |
Значення, що повертається |
Опис |
color(<String> color) |
|
Встановлює колір лінії (Приклади: "#ff00ff", "red", "white"). |
lineWidth(<int> lineWidth) |
|
Встановлює ширину лінії в пікселях. |
opacity(<float> opacity) |
|
Встановлює ступінь прозорості для лінії в діапазоні 0..1 (Приклади: 0.7, 1.0, 0.0). |
distance() |
<int> |
Повертає дистанцію в метрах. |
Методи, що наслідуються від 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
| Назва методу |
Значення, що повертається |
Опис |
visible(<Boolean> bool) |
|
Встановлює флаг видимості об'єкту. |
visible() |
<Boolean> |
Повертає значення флагу видимості об'єкту. |
coords([{lng, lat}] coords) |
|
Встановлює координати об'єкту. |
coords() |
[{lng, lat}] |
Повертає координати об'єкту. |
move(<int> x, <int> y) |
|
Переміщає об'єкт на певну кількість пікселів в екранних координатах. |
bounds() |
<VRect> |
Повертає межі об'єкту. |
до змісту
|
