API ymaps3

Примечание

Учтите: данный раздел является альтернативой практически отсутствующей у Яндекса документацией и может не содержать на 100% актуальных данных.

Актуальные данные от самого Яндекса находятся @yandex/ymaps3-types. Данный раздел будет поддерживаться настолько актуальным, насколько возможно.

geolocation.getPosition

Параметры

Всё то же, что и navigator.geolocation.getCurrentPosition

Возвращает

Promise, в случае успеха, содержащим объект с полями:

• coords: координаты в Яндексовом порядке (lon, потом lat). Возвращается всегда
• accuracy: точность местоположения. Возвращается только в том случае, если пользователь разрешил определять геолокацию

Пример использования

const position = await ymaps3.geolocation.getPosition();

ready

Promise. Выполняется после успешной инициализации скрипта Карт.

Пример использования

await ymaps3.ready;

//Карты готовы

Альтернативно, можно использовать:

import { VueYandexMaps } from 'vue-yandex-maps';

//VueYandexMaps.isLoaded - реактивный ref
watch(VueYandexMaps.isLoaded, () => {
});
const isLoaded = computed(() => VueYandexMaps.isLoaded.value);

search

Осуществляет поиск по заданному запросу.

Параметры

SearchOptions. Среди них вы обязаны передать text.

Возвращает

Promise, в случае успеха: массив Feature.

Данные сильно урезаны по сравнению с отдельным API поиска по организациям.

Пример использования

• Поиск и Геосаджест

suggest

Это аналог геосаджеста.

Для работы этой функции необходимо указать suggest в servicesApikeys в настройках инициализации vue-yandex-maps. Ключ можно создать в вашем Кабинете разработчика.

Параметры

SuggestOptions. Среди них вы обязаны передать text и, по хорошему, types.

Возвращает

Promise, в случае успеха: массив SuggestResponseItem.

Пример использования

• Поиск и Геосаджест

route

Это аналог построения маршрута.

Для работы этой функции необходимо указать router в servicesApikeys в настройках инициализации vue-yandex-maps. Ключ можно создать в вашем Кабинете разработчика.

Параметры

RouteOptions. Среди них обязательные: points и type

Возвращает

Массив BaseRouteResponse, содержащий единственную функцию toRoute, которая в свою очередь возвращает RouteFeature.

По сути, с помощью этого вы можете использовать <yandex-map-feature> для построения линии маршрута.

Пример использования

• Построение маршрута между двумя точками