YMapZoomControl

Класс YMapZoomControl — отображает элемент управления для изменения масштаба карты.

Примечание

Данный класс является компонентом пакета @yandex/ymaps3-default-ui-theme и предоставляет дополнительную функциональность в JS API, которая не входит в основное API.

Для подключения пакета воспользуйтесь инструкцией.

Для настройки масштаба карты используются следующие параметры:

  • easing. Возможные значения: linear, ease, ease-in, ease-out, ease-in-out.
  • zoomRange. Если текущий масштаб выходит за пределы этой настройки, то кнопки увеличения или уменьшения масштаба блокируются.

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

Пример 1

Использование параметра easing:

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

const controls = new YMapControls();
controls.addChild(
  new YMapZoomControl({
    easing: 'linear'
  })
);

map.addChild(controls);

Пример 2

Использование параметра easing и zoomRange:

const map = new YMap(element, {
  zoomRange: {min: 1, max: 5},
  location: {center: [37.588144, 55.733842], zoom: 4}
});

const controls = new YMapControls();
controls.addChild(
  new YMapZoomControl({
    easing: 'linear'
  })
);

map.addChild(controls);

Подробный пример.

Конструктор

new YMapZoomControl(props, options?)

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

Параметр

Тип

Описание

props

YMapZoomControlProps

Значение входных props.

options?

ComplexOptions<YMap>

Опциональные параметры объекта.

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

YMapComplexEntity.constructor

Props

export type YMapZoomControlProps = {
    /* Функция анимации изменения местоположения на карте. */
    easing?: EasingFunctionDescription;
    /* Продолжительность анимации местоположения на карте. */
    duration?: number;
};

Параметры

Параметр

Тип

Описание

duration?

number

Продолжительность анимации местоположения на карте.

easing?

EasingFunctionDescription

Функция анимации изменения местоположения на карте.

Методы

update

update(changedProps): void

Параметр

Тип

Описание

changedProps

Partial<YMapZoomControlProps>

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

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

void

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

YMapComplexEntity.update

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