---
metadata:
  - name: generator
    content: Diplodoc Platform v5.39.1
alternate:
  - https://yandex.ru/dev/maps/archive/doc/jsapi/2-0/ru/ref/reference/control.MiniMap.md
---
> **Documentation Index:** Fetch the complete configuration index at https://yandex.ru/dev/maps/archive/doc/jsapi/2-0/ru/llms.txt

# control.MiniMap

Расширяет [IChildOnMap](https://yandex.ru/dev/maps/archive/doc/jsapi/2-0/ru/ref/reference/IChildOnMap.md), [ICustomizable](https://yandex.ru/dev/maps/archive/doc/jsapi/2-0/ru/ref/reference/ICustomizable.md).

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

## Конструктор {#constructor}

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

**Параметры:**

#|
|| **Параметр** | **Значение по умолчанию** | **Описание** ||
|| `state` | — | Тип: Object

Состояние обзорной карты. ||
|| `state.expanded` | true | Тип: Boolean

true - обзорная карта развернута, false - свернута. ||
|| `state.type` | 'yandex#map'  | Тип: String\|[MapType](https://yandex.ru/dev/maps/archive/doc/jsapi/2-0/ru/ref/reference/MapType.md)

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

• 'yandex#satellite' - тип карты "спутник";

• 'yandex#hybrid' - тип карты "гибрид". ||
|| `options` | — | Тип: Object

Опции обзорной карты. ||
|| `options.layout` | — | Тип: Function\|String

Макет элемента управления. В конструктор макета передается объект, содержащий поля: 
• control - ссылка на элемент управления;

• options - менеджер опций элемента управления control.MiniMap.options;

• data - менеджер данных элемента управления [control.MiniMap.data](https://yandex.ru/dev/maps/archive/doc/jsapi/2-0/ru/ref/reference/control.MiniMap.md#data);

• state - менеджер состояния элемента управления [control.MiniMap.state](https://yandex.ru/dev/maps/archive/doc/jsapi/2-0/ru/ref/reference/control.MiniMap.md#state).

Макет меняет свой внешний вид на основе данных, состояния и опций элемента управления. Элемент управления, в свою очередь, реагирует на интерфейсные события макета и меняет значения полей [control.MiniMap.state](https://yandex.ru/dev/maps/archive/doc/jsapi/2-0/ru/ref/reference/control.MiniMap.md#state) в зависимости от полученных команд. (Тип: конструктор объекта с интерфейсом [IExpandableControlLayout](https://yandex.ru/dev/maps/archive/doc/jsapi/2-0/ru/ref/reference/IExpandableControlLayout.md) или ключ макета). ||
|| `options.position` | \{ left: 5, bottom: 5 \} | Тип: Object

Положение обзорной карты относительно контейнера основной карты. ||
|| `options.size` | [128, 90] | Тип: Integer[]

Размеры обзорной карты. ||
|| `options.visible` | true | Тип: Boolean

Признак того, что элемент управления отображается. ||
|| `options.zoomOffset` | 5 | Тип: Number

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

**Пример:**

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

## Поля {#fields}

#|
|| **Имя** | **Тип** | **Описание** ||
|| [data](https://yandex.ru/dev/maps/archive/doc/jsapi/2-0/ru/ref/reference/control.ListBoxItem.md#data) | [data.Manager](https://yandex.ru/dev/maps/archive/doc/jsapi/2-0/ru/ref/reference/data.Manager.md) | Данные тулбара. ||
|| [events](https://yandex.ru/dev/maps/archive/doc/jsapi/2-0/ru/ref/reference/IEventEmitter.md#events) | [IEventManager](https://yandex.ru/dev/maps/archive/doc/jsapi/2-0/ru/ref/reference/IEventManager.md) | Менеджер событий.

Унаследовано от [IEventEmitter](https://yandex.ru/dev/maps/archive/doc/jsapi/2-0/ru/ref/reference/IEventEmitter.md#events). ||
|| [options](https://yandex.ru/dev/maps/archive/doc/jsapi/2-0/ru/ref/reference/ICustomizable.md#options) | [IOptionManager](https://yandex.ru/dev/maps/archive/doc/jsapi/2-0/ru/ref/reference/IOptionManager.md) | Менеджер опций.

Унаследовано от [ICustomizable](https://yandex.ru/dev/maps/archive/doc/jsapi/2-0/ru/ref/reference/ICustomizable.md#options). ||
|| [state](https://yandex.ru/dev/maps/archive/doc/jsapi/2-0/ru/ref/reference/control.ListBoxItem.md#state) | [data.Manager](https://yandex.ru/dev/maps/archive/doc/jsapi/2-0/ru/ref/reference/data.Manager.md) | Состояние мини-карты. Имена полей, доступных через метод data.Manager.get:
• type - тип мини-карты;

• expanded - признак, развернута ли панель.

Унаследовано от [control.ToolBar](https://yandex.ru/dev/maps/archive/doc/jsapi/2-0/ru/ref/reference/control.ToolBar.md#state). ||
|#

## События {#events}

#|
|| **Имя** | **Описание** ||
||[collapse](https://yandex.ru/dev/maps/archive/doc/jsapi/2-0/ru/ref/reference/control.MiniMap.md#event-collapse) | Мини-карта свернута. Экземпляр класса [Event](https://yandex.ru/dev/maps/archive/doc/jsapi/2-0/ru/ref/reference/Event.md). ||
|| [expand](https://yandex.ru/dev/maps/archive/doc/jsapi/2-0/ru/ref/reference/control.MiniMap.md#event-expand) | Мини-карта развернута. Экземпляр класса [Event](https://yandex.ru/dev/maps/archive/doc/jsapi/2-0/ru/ref/reference/Event.md). ||
|| [mapchange](https://yandex.ru/dev/maps/archive/doc/jsapi/2-0/ru/ref/reference/IChildOnMap.md#event-mapchange) | Сменилась карта. Поля данных:

•  oldMap - старая карта;

• newMap - новая карта.

Унаследовано от [IChildOnMap](https://yandex.ru/dev/maps/archive/doc/jsapi/2-0/ru/ref/reference/IChildOnMap.md#event-mapchange). ||
|| [optionschange](https://yandex.ru/dev/maps/archive/doc/jsapi/2-0/ru/ref/reference/ICustomizable.md#event-optionschange) | Изменение в опциях объекта.

Унаследовано от [ICustomizable](https://yandex.ru/dev/maps/archive/doc/jsapi/2-0/ru/ref/reference/ICustomizable.md#event-optionschange). ||
||[parentchange](https://yandex.ru/dev/maps/archive/doc/jsapi/2-0/ru/ref/reference/IChild.md#event-parentchange) | Сменился родительский объект.

Поля данных:

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

- newParent - новый родитель.

Унаследовано от [IChild](https://yandex.ru/dev/maps/archive/doc/jsapi/2-0/ru/ref/reference/IChild.md#event-parentchange). ||
||[typechange](https://yandex.ru/dev/maps/archive/doc/jsapi/2-0/ru/ref/reference/control.MiniMap.md#event-typechange) | Изменился тип мини-карты. Экземпляр класса [Event](https://yandex.ru/dev/maps/archive/doc/jsapi/2-0/ru/ref/reference/Event.md). ||
|#

## Методы {#method}

#|
|| **Имя** | **Возвращает** | **Описание** ||
|| [collapse](https://yandex.ru/dev/maps/archive/doc/jsapi/2-0/ru/ref/reference/control.MiniMap.md#collapse)() | [control.MiniMap](https://yandex.ru/dev/maps/archive/doc/jsapi/2-0/ru/ref/reference/control.MiniMap.md) |Сворачивает обзорную карту. ||
|| [expand](https://yandex.ru/dev/maps/archive/doc/jsapi/2-0/ru/ref/reference/control.MiniMap.md#expand)() | [control.MiniMap](https://yandex.ru/dev/maps/archive/doc/jsapi/2-0/ru/ref/reference/control.MiniMap.md) | Разворачивает обзорную карту. ||
|| [getParent](https://yandex.ru/dev/maps/archive/doc/jsapi/2-0/ru/ref/reference/IChildOnMap.md#getParent)() | [IParentOnMap](https://yandex.ru/dev/maps/archive/doc/jsapi/2-0/ru/ref/reference/IParentOnMap.md) | Returns ссылку на родительский объект.

Унаследован от [IChildOnMap](https://yandex.ru/dev/maps/archive/doc/jsapi/2-0/ru/ref/reference/IChildOnMap.md#getParent). ||
|| [getType](https://yandex.ru/dev/maps/archive/doc/jsapi/2-0/ru/ref/reference/control.MiniMap.md#getType)() | String\|[MapType](https://yandex.ru/dev/maps/archive/doc/jsapi/2-0/ru/ref/reference/MapType.md) | Returns текущий тип карты. ||
||[isExpanded](https://yandex.ru/dev/maps/archive/doc/jsapi/2-0/ru/ref/reference/control.MiniMap.md#isExpanded)() | Boolean | Returns true - обзорная карта развернута, false - свёрнута. ||
|| [setParent](https://yandex.ru/dev/maps/archive/doc/jsapi/2-0/ru/ref/reference/IChildOnMap.md#setParent)([parent](https://yandex.ru/dev/maps/archive/doc/jsapi/2-0/ru/ref/reference/IChildOnMap.md#setParent-param-parent)) | [IChildOnMap](https://yandex.ru/dev/maps/archive/doc/jsapi/2-0/ru/ref/reference/IChildOnMap.md) | Устанавливает родительский объект.

Унаследован от [IChildOnMap](https://yandex.ru/dev/maps/archive/doc/jsapi/2-0/ru/ref/reference/IChildOnMap.md#setParent). ||
||[setType](https://yandex.ru/dev/maps/archive/doc/jsapi/2-0/ru/ref/reference/control.MiniMap.md#setType)([newType](https://yandex.ru/dev/maps/archive/doc/jsapi/2-0/ru/ref/reference/control.MiniMap.md#setType-param-newType)) | | Задаёт новый тип карты. ||
|# 

## Описание полей {#description-fields}

### data

```javascript
{data.Manager} data
```

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

### state

```javascript
{data.Manager} state
```

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

• type - тип мини-карты;

• expanded - признак, развернута ли панель.

**Пример:**

```javascript
myMap.get('miniMap').state.set('yandex#satellite');
```
## Описание событий {#description-events}

### collapse

Мини-карта свернута. Экземпляр класса [Event](https://yandex.ru/dev/maps/archive/doc/jsapi/2-0/ru/ref/reference/Event.md).

### expand

Мини-карта развернута. Экземпляр класса [Event](https://yandex.ru/dev/maps/archive/doc/jsapi/2-0/ru/ref/reference/Event.md).

### typechange

Изменился тип мини-карты. Экземпляр класса [Event](https://yandex.ru/dev/maps/archive/doc/jsapi/2-0/ru/ref/reference/Event.md).

## Описание методов {#description-methods}
### collapse

```javascript
{control.MiniMap} collapse()
```

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

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

### expand

```javascript
{control.MiniMap} expand()
```

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

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

### getType

```javascript
{String|MapType} getType()
```

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

### isExpanded

```javascript
{Boolean} isExpanded()
```

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


```javascript
{} setType(newType)
```

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

**Параметры:**

#|
|| **Параметр** | **Значение по умолчанию** | **Описание** ||
|| `newType`[*](*parametr) | — | Тип: String\|[MapType](https://yandex.ru/dev/maps/archive/doc/jsapi/2-0/ru/ref/reference/MapType.md)

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


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

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