Модули JS API
Модули JS API это отдельные классы компонентов, которые не грузятся в основном API, но могут быть использованы для специфических задач.
Модули развивает и поддерживает команда Yandex Maps JS API, и они являются такой же частью JS API, как и основное апи.
В общем случае, для работы с модулем его необходимо загрузить.
ymaps3.import('@yandex/controls-extra').then(({YMapOpenMapsButton}) => {
const map = new ymaps3.YMap(document.getElementById('app'), {
location: LOCATION,
});
map.addChild(new YMapOpenMapsButton(...))
});
Внимание.
Модули не версионируются. То есть всегда загружается самая свежая версия модуля (как и для основного JS API).
TypeScript
Типы модулей будут автоматически выведены при вызове ymaps3.import
, но если вам необходим тип из модуля где-то вне импорта, то его можно подключить напрямую.
import type {Cartesian} from '@yandex/ymaps3-types/modules/cartesian-projection';
Внимание.
Пакет @yandex/ymaps3-types
предоставляет только типы, без runtime модулей.
Доступные модули
@yandex/ymaps3-controls-extra
- Additional controls module@yandex/ymaps3-ruler
- Ruler module@yandex/ymaps3-vuefy
- Vuefy module