control.MiniMap
Расширяет IChildOnMap, ICustomizable.
Элемент управления "обзорная карта".
Конструктор | Поля | События | Методы
Конструктор
Параметры:
Параметр | Значение по умолчанию | Описание |
---|---|---|
state | — | Тип: Object Состояние обзорной карты. |
state.expanded | true | Тип: Boolean true - обзорная карта развернута, false - свернута. |
state.type | 'yandex#map' | Тип: String|MapType Тип карты.
Список доступных типов карты:
|
options | — | Тип: Object Опции обзорной карты. |
options.layout | — | Тип: Function|String Макет элемента управления.
В конструктор макета передается объект, содержащий поля:
|
options.position | { left: 5, bottom: 5 } | Тип: Object Положение обзорной карты относительно контейнера основной карты. |
options.size | [128, 90] | Тип: Integer[] Размеры обзорной карты. |
options.visible | true | Тип: Boolean Признак того, что элемент управления отображается. |
options.zoomOffset | 5 | Тип: Number Разность уровней масштабирования обзорной карты и основной карты. |
Параметр | Значение по умолчанию | Описание |
---|---|---|
state | — | Тип: Object Состояние обзорной карты. |
state.expanded | true | Тип: Boolean true - обзорная карта развернута, false - свернута. |
state.type | 'yandex#map' | Тип: String|MapType Тип карты.
Список доступных типов карты:
|
options | — | Тип: Object Опции обзорной карты. |
options.layout | — | Тип: Function|String Макет элемента управления.
В конструктор макета передается объект, содержащий поля:
|
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:
|
Имя | Тип | Описание |
---|---|---|
data | data.Manager | Данные элемента управления. |
events | IEventManager | Менеджер событий. Унаследовано от IEventEmitter. |
options | IOptionManager | Менеджер опций. Унаследовано от ICustomizable. |
state | data.Manager | Состояние мини-карты.
Имена полей, доступных через метод data.Manager.get:
|
События
Имя | Описание |
---|---|
collapse | Мини-карта свернута. Экземпляр класса Event. |
expand | Мини-карта развернута. Экземпляр класса Event. |
mapchange | Сменилась карта.
Поля данных:
Унаследовано от IChildOnMap. |
optionschange | Изменение в опциях объекта. Унаследовано от ICustomizable. |
parentchange | Сменился родительский объект. Поля данных:
Унаследовано от IChild. |
typechange | Изменился тип мини-карты. Экземпляр класса Event. |
Имя | Описание |
---|---|
collapse | Мини-карта свернута. Экземпляр класса Event. |
expand | Мини-карта развернута. Экземпляр класса Event. |
mapchange | Сменилась карта.
Поля данных:
Унаследовано от IChildOnMap. |
optionschange | Изменение в опциях объекта. Унаследовано от ICustomizable. |
parentchange | Сменился родительский объект. Поля данных:
Унаследовано от IChild. |
typechange | Изменился тип мини-карты. Экземпляр класса Event. |
Методы
Имя | Возвращает | Описание |
---|---|---|
collapse() | Сворачивает обзорную карту. | |
expand() | Разворачивает обзорную карту. | |
getParent() | Returns ссылку на родительский объект. Унаследован от IChildOnMap. | |
getType() | String|MapType | Returns текущий тип карты. |
isExpanded() | Boolean | Returns true - обзорная карта развернута, false - свёрнута. |
setParent(parent) | Устанавливает родительский объект. Унаследован от IChildOnMap. | |
setType(newType) | Задаёт новый тип карты. |
Имя | Возвращает | Описание |
---|---|---|
collapse() | Сворачивает обзорную карту. | |
expand() | Разворачивает обзорную карту. | |
getParent() | Returns ссылку на родительский объект. Унаследован от IChildOnMap. | |
getType() | String|MapType | Returns текущий тип карты. |
isExpanded() | Boolean | Returns true - обзорная карта развернута, false - свёрнута. |
setParent(parent) | Устанавливает родительский объект. Унаследован от IChildOnMap. | |
setType(newType) | Задаёт новый тип карты. |
Описание полей
data
{data.Manager} data
Данные элемента управления.
state
{data.Manager} state
- type - тип мини-карты;
- expanded - признак, развернута ли панель.
Пример:
myMap.get('miniMap').state.set('yandex#satellite');
Описание событий
Описание методов
collapse
{control.MiniMap} collapse()
Сворачивает обзорную карту.
Returns ссылку на себя.
expand
{control.MiniMap} expand()
Разворачивает обзорную карту.
Returns ссылку на себя.
getType
{String|MapType} getType()
Returns текущий тип карты.
isExpanded
{Boolean} isExpanded()
Returns true - обзорная карта развернута, false - свёрнута.
setType
{} setType(newType)
Задаёт новый тип карты.
Параметры:
* Обязательный параметр/опция.