Документация
Справочник JavaScript API
2.1.64 (текущая версия)
collection
interactivityModel
Интерфейсы

control.ZoomControl

Расширяет IControl, ICustomizable.

Элемент управления масштабом карты. Ключ элемента управления в хранилище control.storage — "zoomControl".

Конструктор | Поля | События | Методы

Конструктор

control.ZoomControl([parameters])

Параметры:

ПараметрЗначение по умолчаниюОписание
parameters

Тип: Object

Параметры элемента управления.

parameters.data

Тип: Object

Данные элемента управления.

parameters.options

Тип: Object

Опции элемента управления.

parameters.options.adjustMapMargin false

Тип: Boolean

Регистрирует ли элемент управления свои размеры в менеджере отступов карты map.margin.Manager.

parameters.options.layout

Тип: IZoomControlLayout|String

Конструктор макета элемента управления или его ключ в хранилище layout.storage. В конструктор макета передается объект, содержащий поля:

  • control - ссылка на элемент управления;
  • options - менеджер опций элемента управления control.ZoomControl.options;
  • data - менеджер данных элемента управления control.ZoomControl.data;
  • state - менеджер состояния элемента управления control.ZoomControl.state.

parameters.options.position

Тип: Object

Объект, описывающий позицию элемента управления.

parameters.options.position.bottom 'auto'

Тип: Number|String

Положение относительно нижнего края карты.

parameters.options.position.left 10

Тип: Number|String

Положение относительно левого края карты.

parameters.options.position.right 'auto'

Тип: Number|String

Положение относительно правого края карты.

parameters.options.position.top 108

Тип: Number|String

Положение относительно верхнего края карты.

parameters.options.size 'auto'

Тип: String

Параметр, отвечающий за внешний вид элемента управления. Может принимать значения:

  • 'small' — всегда показывать маленький элемент управления масштабом карты;
  • 'large' — всегда показывать большой элемент управления масштабом карты;
  • 'auto' — производить автоматический выбор размера элемента управления в зависимости от высоты контейнера карты.

parameters.options.visible true

Тип: Boolean

Признак того, что элемент управления отображается.

parameters.options.zoomDuration 200

Тип: Number

Время анимации при смене уровня масштабирования.

parameters.options.zoomStep 1

Тип: Number

Шаг изменения уровня масштабирования карты.

parameters.state

Тип: Object

Объект, описывающий состояние элемента управления.

Примеры:

1.

// Пример 1.
// Создание маленького элемента управления масштабом карты и добавление его на карту.
var zoomControl = new ymaps.control.ZoomControl({
    options: {
        size: "small"
    }
});
myMap.controls.add(zoomControl);

2.

// Пример 2.
// Добавление большого элемента управления масштабом карты по ключу из  control.storage.
myMap.controls.add('zoomControl', {
    size: "large"
});

Поля

ИмяТипОписание
events IEventManager

Менеджер событий.

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

options IOptionManager

Менеджер опций.

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

События

ИмяОписание
optionschange

Изменение в опциях объекта.

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

parentchange

Сменился родительский объект.

Поля данных:

  • oldParent - старый родитель;
  • newParent - новый родитель.

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

Методы

ИмяВозвращаетОписание
getMap()

Map

Возвращает ссылку на карту.

getParent()

IControlParent|null

Возвращает ссылку на родительский объект или null, если родительский элемент не был установлен.

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

setParent(parent)

IChildOnMap

Устанавливает родительский объект. Если передать значение null, то элемент управления будет только удален из текущего родительского объекта.

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

Описание методов

getMap

{Map} getMap()

Возвращает ссылку на карту.