control.MiniMap

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

Элемент управления "обзорная карта".

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

Конструктор

control.MiniMap([state[, options]])

Параметры:

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

Тип: Object

Состояние обзорной карты.

state.expanded true

Тип: Boolean

true - обзорная карта развернута, false - свернута.

state.type 'yandex#map'

Тип: String|MapType

Тип карты. Список доступных типов карты:
  • 'yandex#map' - тип карты "схема";
  • 'yandex#satellite' - тип карты "спутник";
  • 'yandex#hybrid' - тип карты "гибрид".
options

Тип: Object

Опции обзорной карты.

options.layout

Тип: Function|String

Макет элемента управления. В конструктор макета передается объект, содержащий поля:
  • control - ссылка на элемент управления;
  • options - менеджер опций элемента управления control.MiniMap.options;
  • data - менеджер данных элемента управления control.MiniMap.data;
  • state - менеджер состояния элемента управления control.MiniMap.state.
Макет меняет свой внешний вид на основе данных, состояния и опций элемента управления. Элемент управления, в свою очередь, реагирует на интерфейсные события макета и меняет значения полей control.MiniMap.state в зависимости от полученных команд. (Тип: конструктор объекта с интерфейсом IExpandableControlLayout или ключ макета).
options.position { left: 5, bottom: 5 }

Тип: Object

Положение обзорной карты относительно контейнера основной карты.

options.size [128, 90]

Тип: Integer[]

Размеры обзорной карты.

options.visible true

Тип: Boolean

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

options.zoomOffset 5

Тип: Number

Разность уровней масштабирования обзорной карты и основной карты.

Пример:

// Добавление мини-карты со спутниковой подложкой, размером 90x90.
map.controls.add(new ymaps.control.MiniMap(
    { type: 'yandex#satellite' },
    { size: [90, 90] }
));

Поля

Имя Тип Описание
data data.Manager

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

events IEventManager

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

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

options IOptionManager

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

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

state data.Manager
Состояние мини-карты. Имена полей, доступных через метод data.Manager.get:
  • type - тип мини-карты;
  • expanded - признак, развернута ли панель.

События

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

Мини-карта свернута. Экземпляр класса Event.

expand

Мини-карта развернута. Экземпляр класса Event.

mapchange
Сменилась карта. Поля данных:
  • oldMap - старая карта;
  • newMap - новая карта.

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

optionschange

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

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

parentchange

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

Поля данных:

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

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

typechange

Изменился тип мини-карты. Экземпляр класса Event.

Методы

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

control.MiniMap

Сворачивает обзорную карту.

expand()

control.MiniMap

Разворачивает обзорную карту.

getParent()

IParentOnMap

Returns ссылку на родительский объект.

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

getType()

String|MapType

Returns текущий тип карты.

isExpanded()

Boolean

Returns true - обзорная карта развернута, false - свёрнута.

setParent(parent)

IChildOnMap

Устанавливает родительский объект.

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

setType(newType)

Задаёт новый тип карты.

Описание полей

data

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

state

{data.Manager} state
Состояние мини-карты. Имена полей, доступных через метод data.Manager.get:
  • type - тип мини-карты;
  • expanded - признак, развернута ли панель.

Пример:

myMap.get('miniMap').state.set('yandex#satellite');

Описание событий

collapse

Мини-карта свернута. Экземпляр класса Event.

expand

Мини-карта развернута. Экземпляр класса Event.

typechange

Изменился тип мини-карты. Экземпляр класса Event.

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

collapse

{control.MiniMap} collapse()

Сворачивает обзорную карту.

Returns ссылку на себя.

expand

{control.MiniMap} expand()

Разворачивает обзорную карту.

Returns ссылку на себя.

getType

{String|MapType} getType()

Returns текущий тип карты.

isExpanded

{Boolean} isExpanded()

Returns true - обзорная карта развернута, false - свёрнута.

setType

{} setType(newType)

Задаёт новый тип карты.

Параметры:

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

Тип: String|MapType

Новый тип карты.

* Обязательный параметр/опция.