Класс: UMap

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

Конструктор

new UMap(element: string | HTMLElement, options: { enableLinks?: boolean; enableShare?: boolean; mapName: string; origin?: string; viewControls?: boolean; viewLogo?: boolean; viewMenu?: boolean; viewNotification?: boolean; }): UMap

Параметры

Параметр	Type	Description
element	string | HTMLElement	Элемент или его селектор, в который будет встроена карта.
options	{ enableLinks?: boolean; enableShare?: boolean; mapName: string; origin?: string; viewControls?: boolean; viewLogo?: boolean; viewMenu?: boolean; viewNotification?: boolean; }	Опции инициализации.
options.enableLinks?	boolean	Разрешить переходы по ссылкам. Default true
options.enableShare?	boolean	Отображать кнопки "Поделиться". Default true
options.mapName	string	Идентификатор карты.
options.origin?	string	URL карты. Default https://in.umap.world
options.viewControls?	boolean	Отображать элементы управления. Default true
options.viewLogo?	boolean	Отображать логотип. Default true
options.viewMenu?	boolean	Отображать меню. Default true
options.viewNotification?	boolean	Отображать уведомления. Default true

Возвращает

UMap

Пример

import { UMap } from '@umap/sdk';

const map = new UMap('#map', {
  mapName: 'demo-map',
});

Методы

changeLanguage()

changeLanguage(args: { langId: string; }): TypedPromise<true, { code: "UNSUPPORTED_LANGUAGE"; }>

Смена языка карты

Параметры

Параметр	Type	Description
args	{ langId: string; }	-
args.langId	string	Код языка в ISO 639-1

Возвращает

TypedPromise<true, { code: "UNSUPPORTED_LANGUAGE"; }>

Пример

await map.changeLanguage({
  langId: 'en',
});

---

convertCoordinatesToPoint()

convertCoordinatesToPoint(args: { latitude: number; longitude: number; }): TypedPromise<{ x: number; y: number; }, never>

Преобразование координат в точку на экране

Параметры

Параметр	Type	Description
args	{ latitude: number; longitude: number; }	-
args.latitude	number	Широта
args.longitude	number	Долгота

Возвращает

TypedPromise<{ x: number; y: number; }, never>

Пример

const point = await map.convertCoordinatesToPoint({
  latitude: 55.751244,
  longitude: 37.618423,
});
console.log(point); // { x: 100, y: 200 }

---

convertPointToCoordinates()

convertPointToCoordinates(args: { x: number; y: number; }): TypedPromise<{ latitude: number; longitude: number; }, never>

Преобразование точки на экране в координаты

Параметры

Параметр	Type	Description
args	{ x: number; y: number; }	-
args.x	number	X в пикселях от левого края карты
args.y	number	Y в пикселях от верхнего края карты

Возвращает

TypedPromise<{ latitude: number; longitude: number; }, never>

Пример

const coords = await map.convertPointToCoordinates({
  x: 100,
  y: 200,
});
console.log(coords); // { latitude: 55.751244, longitude: 37.618423 }

---

destroy()

destroy(): void

Уничтожение экземпляра карты и освобождение ресурсов.

Возвращает

void

Пример

map.destroy();

---

getBuildings()

getBuildings(args?: { ids?: string[]; }): TypedPromise<{ buildings: { id: string; levelIds: string[]; name?: string; }[]; }, never>

Получение информации о зданиях на карте

Параметры

Параметр	Type	Description
args?	{ ids?: string[]; }	-
args.ids?	string[]	Идентификаторы зданий

Возвращает

TypedPromise<{ buildings: { id: string; levelIds: string[]; name?: string; }[]; }, never>

Пример

const result = await map.getBuildings({
  ids: ['406b8bcb-11a6-43f9-9c86-9a02b85fa5cb'],
});
console.log(result);
// {
//   buildings: [
//     {
//       id: '406b8bcb-11a6-43f9-9c86-9a02b85fa5cb',
//       name: 'Конгресс-центр',
//       levelIds: [
//         '7eed35d4-1e71-452f-97f4-151c4fbbe1db',
//         '9e6fa4ef-7c92-4fde-b87f-7ba856eac8ef',
//       ],
//     },
//   ],
// }

---

getLevelAt()

getLevelAt(args: { latitude: number; longitude: number; }): TypedPromise<{ buildingId?: string; levelId?: string; }, never>

Получение информации об этаже по координатам

Параметры

Параметр	Type	Description
args	{ latitude: number; longitude: number; }	-
args.latitude	number	Широта
args.longitude	number	Долгота

Возвращает

TypedPromise<{ buildingId?: string; levelId?: string; }, never>

Пример

const level = await map.getLevelAt({
  latitude: 55.751244,
  longitude: 37.618423,
});
console.log(level);
// {
//   levelId: '7eed35d4-1e71-452f-97f4-151c4fbbe1db',
//   buildingId: '406b8bcb-11a6-43f9-9c86-9a02b85fa5cb',
// }

---

getLevels()

getLevels(args?: { ids?: string[]; }): TypedPromise<{ levels: { buildingId: string; id: string; isVisible: boolean; name: string; }[]; }, never>

Получение информации об этажах

Параметры

Параметр	Type	Description
args?	{ ids?: string[]; }	-
args.ids?	string[]	Идентификаторы этажей

Возвращает

TypedPromise<{ levels: { buildingId: string; id: string; isVisible: boolean; name: string; }[]; }, never>

Пример

const result = await map.getLevels({
  ids: ['7eed35d4-1e71-452f-97f4-151c4fbbe1db'],
});
console.log(result);
// {
//   levels: [
//     {
//       id: '7eed35d4-1e71-452f-97f4-151c4fbbe1db',
//       buildingId: '406b8bcb-11a6-43f9-9c86-9a02b85fa5cb',
//       name: 'Этаж 1',
//       isVisible: true,
//     },
//   ],
// }

---

getObjectsInArea()

getObjectsInArea(args: { max: { latitude: number; longitude: number; }; min: { latitude: number; longitude: number; }; }): TypedPromise<{ objects: { id: string; type: "annotation" | "marker" | "pictureOverlay" | "route"; }[]; }, never>

Получение объектов в области

Параметры

Параметр	Type	Description
args	{ max: { latitude: number; longitude: number; }; min: { latitude: number; longitude: number; }; }	-
args.max	{ latitude: number; longitude: number; }	Правая верхняя точка области
args.max.latitude	number	Широта
args.max.longitude	number	Долгота
args.min	{ latitude: number; longitude: number; }	Левая нижняя точка области
args.min.latitude	number	Широта
args.min.longitude	number	Долгота

Возвращает

TypedPromise<{ objects: { id: string; type: "annotation" | "marker" | "pictureOverlay" | "route"; }[]; }, never>

Пример

const result = await map.getObjectsInArea({
  min: { latitude: 55.75, longitude: 37.61 },
  max: { latitude: 55.76, longitude: 37.63 },
});
console.log(result);
// {
//   objects: [
//     {
//       type: 'annotation',
//       id: '123e4567-e89b-12d3-a456-426614174000',
//     },
//     {
//       type: 'marker',
//       id: '123e4567-e89b-12d3-a456-426614174001',
//     },
//     {
//       type: 'pictureOverlay',
//       id: '123e4567-e89b-12d3-a456-426614174002',
//     },
//     {
//       type: 'route',
//       id: '123e4567-e89b-12d3-a456-426614174003',
//     },
//     ...
//   ],
// }

---

setUiConfig()

setUiConfig(args: { config: object; }): TypedPromise<true, { code: "INVALID_CONFIG"; }>

Установка UI-конфигурации

Параметры

Параметр	Type	Description
args	{ config: object; }	-
args.config	object	Новый объект

Возвращает

TypedPromise<true, { code: "INVALID_CONFIG"; }>

Пример

await map.setUiConfig({
  version: 4,
  ...
});

Аннотации

deleteAnnotations()

deleteAnnotations(args: { ids: string[]; }): TypedPromise<true, never>

Удаление аннотаций

Параметры

Параметр	Type	Description
args	{ ids: string[]; }	-
args.ids	string[]	Идентификаторы аннотаций

Возвращает

TypedPromise<true, never>

Пример

await map.deleteAnnotations({
  ids: ['123e4567-e89b-12d3-a456-426614174000'],
});

---

deselectAllAnnotations()

deselectAllAnnotations(): TypedPromise<true, never>

Снятие выделения со всех аннотаций

Возвращает

TypedPromise<true, never>

Пример

await map.deselectAllAnnotations();

---

deselectAnnotations()

deselectAnnotations(args: { animated?: boolean; ids: string[]; }): TypedPromise<true, never>

Снятие выделения с аннотаций

Параметры

Параметр	Type	Description
args	{ animated?: boolean; ids: string[]; }	-
args.animated?	boolean	Применить анимацию
args.ids	string[]	Идентификаторы аннотаций

Возвращает

TypedPromise<true, never>

Пример

await map.deselectAnnotations({
  ids: ['123e4567-e89b-12d3-a456-426614174000'],
  animated: true,
});

---

focusOnAnnotations()

focusOnAnnotations(args: { animated?: boolean; ids: string[]; offset?: { x?: number; y?: number; }; rotation?: number; zoom?: number; }): TypedPromise<true, never>

Фокус камеры на аннотации

Параметры

Параметр	Type	Description
args	{ animated?: boolean; ids: string[]; offset?: { x?: number; y?: number; }; rotation?: number; zoom?: number; }	-
args.animated?	boolean	Анимированный фокус
args.ids	string[]	Идентификаторы аннотаций
args.offset?	{ x?: number; y?: number; }	Смещение в экранных пикселях
args.offset.x?	number	По оси X
args.offset.y?	number	По оси Y
args.rotation?	number	Поворот карты
args.zoom?	number	Желаемый зум

Возвращает

TypedPromise<true, never>

Пример

await map.focusOnAnnotations({
  ids: ['123e4567-e89b-12d3-a456-426614174000'],
  animated: true,
  offset: { x: 0, y: -100 },
  rotation: 0,
  zoom: 19,
});

---

getAnnotations()

getAnnotations(args?: { externalKeys?: string[]; ids?: string[]; }): TypedPromise<{ annotations: { buildingId?: string; externalKeys: string[]; id: string; isPinned: boolean; isSelected: boolean; isVisible: boolean; latitude: number; levelId?: string; longitude: number; name: string; }[]; }, never>

Получение аннотаций

Параметры

Параметр	Type	Description
args?	{ externalKeys?: string[]; ids?: string[]; }	-
args.externalKeys?	string[]	Внешние ключи аннотаций
args.ids?	string[]	Идентификаторы аннотаций

Возвращает

TypedPromise<{ annotations: { buildingId?: string; externalKeys: string[]; id: string; isPinned: boolean; isSelected: boolean; isVisible: boolean; latitude: number; levelId?: string; longitude: number; name: string; }[]; }, never>

Пример

const result = await map.getAnnotations({
  ids: ['123e4567-e89b-12d3-a456-426614174000'],
});
console.log(result);
// {
//   annotations: [
//     {
//       id: '123e4567-e89b-12d3-a456-426614174000',
//       externalKeys: ['key1', 'key2'],
//       isSelected: false,
//       isPinned: false,
//       isVisible: true,
//       levelId: '7eed35d4-1e71-452f-97f4-151c4fbbe1db',
//       buildingId: '406b8bcb-11a6-43f9-9c86-9a02b85fa5cb',
//       latitude: 55.751244,
//       longitude: 37.618423,
//       name: 'Павильон',
//     },
//   ],
// }

---

pinAnnotations()

pinAnnotations(args: { ids: string[]; }): TypedPromise<true, never>

Закрепление аннотаций

Параметры

Параметр	Type	Description
args	{ ids: string[]; }	-
args.ids	string[]	Идентификаторы аннотаций

Возвращает

TypedPromise<true, never>

Пример

await map.pinAnnotations({
  ids: ['123e4567-e89b-12d3-a456-426614174000'],
});

---

selectAnnotations()

selectAnnotations(args: { animated?: boolean; ids: string[]; }): TypedPromise<true, never>

Выделение аннотаций

Параметры

Параметр	Type	Description
args	{ animated?: boolean; ids: string[]; }	-
args.animated?	boolean	Применить анимацию
args.ids	string[]	Идентификаторы аннотаций

Возвращает

TypedPromise<true, never>

Пример

await map.selectAnnotations({
  ids: ['123e4567-e89b-12d3-a456-426614174000'],
  animated: true,
});

---

unpinAllAnnotations()

unpinAllAnnotations(): TypedPromise<true, never>

Удаление закрепления со всех аннотаций

Возвращает

TypedPromise<true, never>

Пример

await map.unpinAllAnnotations();

---

unpinAnnotations()

unpinAnnotations(args: { ids: string[]; }): TypedPromise<true, never>

Удаление закрепления с аннотаций

Параметры

Параметр	Type	Description
args	{ ids: string[]; }	-
args.ids	string[]	Идентификаторы аннотаций

Возвращает

TypedPromise<true, never>

Пример

await map.unpinAnnotations({
  ids: ['123e4567-e89b-12d3-a456-426614174000'],
});

Изображения

createPictureOverlay()

createPictureOverlay(args: { framed?: boolean; icon: { size: number; url: string; }; label?: Record<string, string>; latitude: number; longitude: number; }): TypedPromise<{ id: string; }, never>

Создание изображения

Параметры

Параметр	Type	Description
args	{ framed?: boolean; icon: { size: number; url: string; }; label?: Record<string, string>; latitude: number; longitude: number; }	-
args.framed?	boolean	Имеет рамку
args.icon	{ size: number; url: string; }	Параметры изображения
args.icon.size	number	Размер изображения
args.icon.url	string	URL изображения
args.label?	Record<string, string>	Подпись
args.latitude	number	Широта
args.longitude	number	Долгота

Возвращает

TypedPromise<{ id: string; }, never>

Пример

const result = await map.createPictureOverlay({
  latitude: 55.751244,
  longitude: 37.618423,
  framed: true,
  icon: {
    url: 'https://example.com/image.png',
    size: 48,
  },
  label: {
    en: 'Picture overlay',
    ru: 'Изображение',
  },
});
console.log(result);
// {
//   id: '123e4567-e89b-12d3-a456-426614174002',
// }

---

deletePictureOverlays()

deletePictureOverlays(args: { ids: string[]; }): TypedPromise<true, never>

Удаление изображений

Параметры

Параметр	Type	Description
args	{ ids: string[]; }	-
args.ids	string[]	Идентификаторы изображений

Возвращает

TypedPromise<true, never>

Пример

await map.deletePictureOverlays({
  ids: ['123e4567-e89b-12d3-a456-426614174002'],
});

---

deselectAllPictureOverlays()

deselectAllPictureOverlays(): TypedPromise<true, never>

Снятие выделения со всех изображений

Возвращает

TypedPromise<true, never>

Пример

await map.deselectAllPictureOverlays();

---

deselectPictureOverlays()

deselectPictureOverlays(args: { animated?: boolean; ids: string[]; }): TypedPromise<true, never>

Снятие выделения с изображений

Параметры

Параметр	Type	Description
args	{ animated?: boolean; ids: string[]; }	-
args.animated?	boolean	Применить анимацию
args.ids	string[]	Идентификаторы изображений

Возвращает

TypedPromise<true, never>

Пример

await map.deselectPictureOverlays({
  ids: ['123e4567-e89b-12d3-a456-426614174002'],
  animated: true,
});

---

focusOnPictureOverlays()

focusOnPictureOverlays(args: { animated?: boolean; ids: string[]; offset?: { x?: number; y?: number; }; rotation?: number; zoom?: number; }): TypedPromise<true, never>

Фокус камеры на изображениях

Параметры

Параметр	Type	Description
args	{ animated?: boolean; ids: string[]; offset?: { x?: number; y?: number; }; rotation?: number; zoom?: number; }	-
args.animated?	boolean	Анимированный фокус
args.ids	string[]	Идентификаторы изображений
args.offset?	{ x?: number; y?: number; }	Смещение в экранных пикселях
args.offset.x?	number	По оси X
args.offset.y?	number	По оси Y
args.rotation?	number	Поворот карты
args.zoom?	number	Желаемый зум

Возвращает

TypedPromise<true, never>

Пример

await map.focusOnPictureOverlays({
  ids: ['123e4567-e89b-12d3-a456-426614174002'],
  animated: true,
  offset: { x: 0, y: -100 },
  rotation: 0,
  zoom: 19,
});

---

getPictureOverlays()

getPictureOverlays(args?: { ids?: string[]; }): TypedPromise<{ pictureOverlays: { id: string; isSelected: boolean; isVisible: boolean; latitude: number; longitude: number; }[]; }, never>

Получение изображений

Параметры

Параметр	Type	Description
args?	{ ids?: string[]; }	-
args.ids?	string[]	Идентификаторы изображений

Возвращает

TypedPromise<{ pictureOverlays: { id: string; isSelected: boolean; isVisible: boolean; latitude: number; longitude: number; }[]; }, never>

Пример

const result = await map.getPictureOverlays({
  ids: ['123e4567-e89b-12d3-a456-426614174002'],
});
console.log(result);
// {
//   pictureOverlays: [
//     {
//       id: '123e4567-e89b-12d3-a456-426614174002',
//       isSelected: false,
//       isVisible: true,
//       latitude: 55.751244,
//       longitude: 37.618423,
//     },
//   ],
// }

---

selectPictureOverlays()

selectPictureOverlays(args: { animated?: boolean; ids: string[]; }): TypedPromise<true, never>

Выделение изображений

Параметры

Параметр	Type	Description
args	{ animated?: boolean; ids: string[]; }	-
args.animated?	boolean	Применить анимацию
args.ids	string[]	Идентификаторы изображений

Возвращает

TypedPromise<true, never>

Пример

await map.selectPictureOverlays({
  ids: ['123e4567-e89b-12d3-a456-426614174002'],
  animated: true,
});

Маркеры

createMarker()

createMarker(args: { latitude: number; levelId?: string; longitude: number; }): TypedPromise<{ id: string; }, never>

Создание маркера

Параметры

Параметр	Type	Description
args	{ latitude: number; levelId?: string; longitude: number; }	-
args.latitude	number	Широта
args.levelId?	string	Идентификатор этажа
args.longitude	number	Долгота

Возвращает

TypedPromise<{ id: string; }, never>

Пример

const result = await map.createMarker({
  latitude: 55.751244,
  longitude: 37.618423,
  levelId: '7eed35d4-1e71-452f-97f4-151c4fbbe1db',
});
console.log(result);
// {
//   id: '123e4567-e89b-12d3-a456-426614174001',
// }

---

deleteMarkers()

deleteMarkers(args: { ids: string[]; }): TypedPromise<true, never>

Удаление маркеров

Параметры

Параметр	Type	Description
args	{ ids: string[]; }	-
args.ids	string[]	Идентификаторы маркеров

Возвращает

TypedPromise<true, never>

Пример

await map.deleteMarkers({
  ids: ['123e4567-e89b-12d3-a456-426614174001'],
});

---

deselectAllMarkers()

deselectAllMarkers(): TypedPromise<true, never>

Снятие выделения со всех маркеров

Возвращает

TypedPromise<true, never>

Пример

await map.deselectAllMarkers();

---

deselectMarkers()

deselectMarkers(args: { animated?: boolean; ids: string[]; }): TypedPromise<true, never>

Снятие выделения с маркеров

Параметры

Параметр	Type	Description
args	{ animated?: boolean; ids: string[]; }	-
args.animated?	boolean	Применить анимацию
args.ids	string[]	Идентификаторы маркеров

Возвращает

TypedPromise<true, never>

Пример

await map.deselectMarkers({
  ids: ['123e4567-e89b-12d3-a456-426614174001'],
  animated: true,
});

---

focusOnMarkers()

focusOnMarkers(args: { animated?: boolean; ids: string[]; offset?: { x?: number; y?: number; }; rotation?: number; zoom?: number; }): TypedPromise<true, never>

Фокус камеры на маркерах

Параметры

Параметр	Type	Description
args	{ animated?: boolean; ids: string[]; offset?: { x?: number; y?: number; }; rotation?: number; zoom?: number; }	-
args.animated?	boolean	Анимированный фокус
args.ids	string[]	Идентификаторы маркеров
args.offset?	{ x?: number; y?: number; }	Смещение в экранных пикселях
args.offset.x?	number	По оси X
args.offset.y?	number	По оси Y
args.rotation?	number	Поворот карты
args.zoom?	number	Желаемый зум

Возвращает

TypedPromise<true, never>

Пример

await map.focusOnMarkers({
  ids: ['123e4567-e89b-12d3-a456-426614174001'],
  animated: true,
  offset: { x: 0, y: -100 },
  rotation: 0,
  zoom: 19,
});

---

getMarkers()

getMarkers(args?: { ids?: string[]; }): TypedPromise<{ markers: { buildingId?: string; id: string; isSelected: boolean; isVisible: boolean; latitude: number; levelId?: string; longitude: number; nearestAnnotations: { distance: number; id: string; }[]; }[]; }, never>

Получение маркеров

Параметры

Параметр	Type	Description
args?	{ ids?: string[]; }	-
args.ids?	string[]	Идентификаторы маркеров

Возвращает

TypedPromise<{ markers: { buildingId?: string; id: string; isSelected: boolean; isVisible: boolean; latitude: number; levelId?: string; longitude: number; nearestAnnotations: { distance: number; id: string; }[]; }[]; }, never>

Пример

const result = await map.getMarkers({
  ids: ['123e4567-e89b-12d3-a456-426614174001'],
});
console.log(result);
// {
//   markers: [
//     {
//       id: '123e4567-e89b-12d3-a456-426614174001',
//       isSelected: false,
//       isVisible: true,
//       latitude: 55.751244,
//       longitude: 37.618423,
//       levelId: '7eed35d4-1e71-452f-97f4-151c4fbbe1db',
//       buildingId: '406b8bcb-11a6-43f9-9c86-9a02b85fa5cb',
//       nearestAnnotations: [
//         {
//           id: '123e4567-e89b-12d3-a456-426614174000',
//           distance: 12.34,
//         },
//         ...
//       ],
//     },
//   ],
// }

---

pinMarkers()

pinMarkers(args: { ids: string[]; }): TypedPromise<true, never>

Закрепление маркеров

Параметры

Параметр	Type	Description
args	{ ids: string[]; }	-
args.ids	string[]	Идентификаторы маркеров

Возвращает

TypedPromise<true, never>

Пример

await map.pinMarkers({
  ids: ['123e4567-e89b-12d3-a456-426614174001'],
});

---

selectMarkers()

selectMarkers(args: { animated?: boolean; ids: string[]; }): TypedPromise<true, never>

Выделение маркеров

Параметры

Параметр	Type	Description
args	{ animated?: boolean; ids: string[]; }	-
args.animated?	boolean	Применить анимацию
args.ids	string[]	Идентификаторы маркеров

Возвращает

TypedPromise<true, never>

Пример

await map.selectMarkers({
  ids: ['123e4567-e89b-12d3-a456-426614174001'],
  animated: true,
});

---

unpinAllMarkers()

unpinAllMarkers(): TypedPromise<true, never>

Удаление закрепления со всех маркеров

Возвращает

TypedPromise<true, never>

Пример

await map.unpinAllMarkers();

---

unpinMarkers()

unpinMarkers(args: { ids: string[]; }): TypedPromise<true, never>

Удаление закрепления с маркеров

Параметры

Параметр	Type	Description
args	{ ids: string[]; }	-
args.ids	string[]	Идентификаторы маркеров

Возвращает

TypedPromise<true, never>

Пример

await map.unpinMarkers({
  ids: ['123e4567-e89b-12d3-a456-426614174001'],
});

Маршруты

createRoute()

createRoute(args: { from: { id: string; type: "annotation" | "marker"; }; to: { id: string; type: "annotation" | "marker"; }; }): TypedPromise<{ id: string; }, { code: "TARGET_NOT_FOUND"; }>

Создание маршрута

Параметры

Параметр	Type	Description
args	{ from: { id: string; type: "annotation" | "marker"; }; to: { id: string; type: "annotation" | "marker"; }; }	-
args.from	{ id: string; type: "annotation" | "marker"; }	Откуда
args.from.id	string	Идентификатор объекта
args.from.type	"annotation" | "marker"	Тип объекта
args.to	{ id: string; type: "annotation" | "marker"; }	Куда
args.to.id	string	Идентификатор объекта
args.to.type	"annotation" | "marker"	Тип объекта

Возвращает

TypedPromise<{ id: string; }, { code: "TARGET_NOT_FOUND"; }>

Пример

const result = await map.createRoute({
  from: {
    type: 'annotation',
    id: '123e4567-e89b-12d3-a456-426614174000',
  },
  to: {
    type: 'marker',
    id: '123e4567-e89b-12d3-a456-426614174001',
  },
});
console.log(result);
// {
//   id: '123e4567-e89b-12d3-a456-426614174003',
// }

---

deleteRoutes()

deleteRoutes(args: { ids: string[]; }): TypedPromise<true, never>

Удаление маршрутов

Параметры

Параметр	Type	Description
args	{ ids: string[]; }	-
args.ids	string[]	Идентификаторы маршрутов

Возвращает

TypedPromise<true, never>

Пример

await map.deleteRoutes({
  ids: ['123e4567-e89b-12d3-a456-426614174003'],
});

---

deselectAllRoutes()

deselectAllRoutes(): TypedPromise<true, never>

Снятие выделения со всех маршрутов

Возвращает

TypedPromise<true, never>

Пример

await map.deselectAllRoutes();

---

deselectRoutes()

deselectRoutes(args: { ids: string[]; }): TypedPromise<true, never>

Снятие выделения с маршрутов

Параметры

Параметр	Type	Description
args	{ ids: string[]; }	-
args.ids	string[]	Идентификаторы маршрутов

Возвращает

TypedPromise<true, never>

Пример

await map.deselectRoutes({
  ids: ['123e4567-e89b-12d3-a456-426614174003'],
});

---

focusOnRoutes()

focusOnRoutes(args: { animated?: boolean; ids: string[]; offset?: { x?: number; y?: number; }; rotation?: number; target?: "START" | "CENTER" | "END"; zoom?: number; }): TypedPromise<true, never>

Фокус камеры на маршрутах

Параметры

Параметр	Type	Description
args	{ animated?: boolean; ids: string[]; offset?: { x?: number; y?: number; }; rotation?: number; target?: "START" | "CENTER" | "END"; zoom?: number; }	-
args.animated?	boolean	Анимированный фокус
args.ids	string[]	Идентификаторы маршрутов
args.offset?	{ x?: number; y?: number; }	Смещение в экранных пикселях
args.offset.x?	number	По оси X
args.offset.y?	number	По оси Y
args.rotation?	number	Поворот карты
args.target?	"START" | "CENTER" | "END"	Точка фокуса Default 'CENTER'
args.zoom?	number	Желаемый зум

Возвращает

TypedPromise<true, never>

Пример

await map.focusOnRoutes({
  ids: ['123e4567-e89b-12d3-a456-426614174003'],
  target: 'START',
  animated: true,
  offset: { x: 0, y: -100 },
  rotation: 0,
  zoom: 19,
});

---

getRoutes()

getRoutes(args?: { ids?: string[]; }): TypedPromise<{ routes: { id: string; isSelected: boolean; }[]; }, never>

Получение маршрутов

Параметры

Параметр	Type	Description
args?	{ ids?: string[]; }	-
args.ids?	string[]	Идентификаторы маршрутов

Возвращает

TypedPromise<{ routes: { id: string; isSelected: boolean; }[]; }, never>

Пример

const result = await map.getRoutes({
  ids: ['123e4567-e89b-12d3-a456-426614174003'],
});
console.log(result);
// {
//   routes: [
//     {
//       id: '123e4567-e89b-12d3-a456-426614174003',
//       isSelected: false,
//     },
//   ],
// }

---

selectRoutes()

selectRoutes(args: { ids: string[]; }): TypedPromise<true, never>

Выделение маршрутов

Параметры

Параметр	Type	Description
args	{ ids: string[]; }	-
args.ids	string[]	Идентификаторы маршрутов

Возвращает

TypedPromise<true, never>

Пример

await map.selectRoutes({
  ids: ['123e4567-e89b-12d3-a456-426614174003'],
});

События

off()

off<K>(eventName: K, listener: (...args: Events[K]) => void): void

Отписка от событий

Типы-параметры

Тип-параметр
K extends keyof Events

Параметры

Параметр	Type
eventName	K
listener	(...args: Events[K]) => void

Возвращает

void

---

on()

on<K>(eventName: K, listener: (...args: Events[K]) => void): void

Подписка на события

Типы-параметры

Тип-параметр
K extends keyof Events

Параметры

Параметр	Type
eventName	K
listener	(...args: Events[K]) => void

Возвращает

void

---

once()

once<K>(eventName: K, listener: (...args: Events[K]) => void): void

Одноразовая подписка на событие

Типы-параметры

Тип-параметр
K extends keyof Events

Параметры

Параметр	Type
eventName	K
listener	(...args: Events[K]) => void

Возвращает

void