YMapOpenMapsButton

Класс YMapOpenMapsButton — кнопка открытия карты.

Примечание

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

Модули развивает и поддерживает команда Yandex Maps JS API, и они являются такой же частью JS API, как и основное API.

Для работы с модулем его необходимо загрузить.

ymaps3.import('@yandex/controls-extra').then(({YMapOpenMapsButton}) => {
  const map = new ymaps3.YMap(document.getElementById('app'), {
    location: LOCATION,
  });

  map.addChild(new YMapOpenMapsButton(...))
});

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

const controls = new YMapControls({position: 'bottom left'});
const {YMapOpenMapsButton} = await ymaps3.import('@yandex/ymaps3-controls-extra');
const openMapsButton = new YMapOpenMapsButton({});
controls.addChild(openMapsButton);
map.addChild(controls);

Конструктор

new YMapOpenMapsButton(props)

Параметры конструктора

Параметр

Тип

props

YMapOpenMapsButtonProps

Переопределяет

YMapGroupEntity.constructor

Props

YMapOpenMapsButtonProps: Object

Параметры

Параметр

Тип

Описание

title?

string

Название кнопки.

Методы

addChild

addChild(child, index?): YMapOpenMapsButton

Параметры

Параметр

Тип

child

YMapEntity<unknown, {}>

index?

number

Возвращается

YMapOpenMapsButton

Унаследовано от

YMapGroupEntity.addChild

removeChild

removeChild(child): YMapOpenMapsButton

Параметры

Параметр

Тип

child

YMapEntity<unknown, {}>

Возвращается

YMapOpenMapsButton

Унаследовано от

YMapGroupEntity.removeChild

update

update(changedProps): void

Параметры

Параметр

Тип

Описание

changedProps

Partial<YMapOpenMapsButtonProps>

Новые значения props.

Возвращается

void

Унаследовано от

YMapGroupEntity.update

Предыдущая
Следующая