YMapControls

Класс YMapControls — DOM-контейнер, который позволяет объединить элементы управления для их удобного расположения и организации на карте.

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

const map = new YMap(element, {
  location: {center: [37.588144, 55.733842], zoom: 14}
});
const controls = new YMapControls({position: 'top left', orientation: 'vertical'});
controls.addChild(new YMapGeolocationControlI({}));
controls.addChild(new YMapZoomControlI({}));
map.addChild(controls);

Создание собственного элемента

Вы можете создать собственные визуальные элементы.

Пример

Добавление кнопки, которая переставляет центр карты в Москву:

const map = new YMap(element, {
  location: {center: [37.588144, 55.733842], zoom: 14}
});

const controls = new YMapControls({position: 'top left'});
const button = new YMapControlButton({
  text: 'Москва',
  onClick: () => {
    map.setLocation({
      center: [37.588144, 55.733842],
      zoom: 5
    });
  }
});

controls.addChild(button);
map.addChild(controls);

Конструктор

new YMapControls(props, children?)

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

Параметр

Тип

props

YMapControlsProps

children?

YMapEntity<unknown, {}>[]

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

YMapGroupEntity.constructor

Props

YMapControlsProps: Object

Параметры

Параметр

Тип

Описание

orientation?

Orientation

Управляет ориентацией.

position

Position

Контролирует положение.

Методы

addChild

addChild(child, index?): YMapControls

Параметры

Параметр

Тип

child

YMapEntity><unknown, {}>

index?

number

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

YMapControls

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

YMapGroupEntity.addChild

removeChild

removeChild(child): YMapControls

Параметры

Параметр

Тип

child

YMapEntity<unknown, {}>

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

YMapControls

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

YMapGroupEntity.removeChild

update

update(changedProps): void

Параметры

Параметр

Тип

Описание

changedProps

Partial<YMapControlsProps>

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

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

void

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

YMapGroupEntity.update

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