---
metadata:
  - name: generator
    content: Diplodoc Platform v5.37.1
alternate:
  - https://yandex.ru/dev/jsapi-v1-1/doc/ru/ref/reference/minimap.md
---
> **Documentation Index:** Fetch the complete configuration index at https://yandex.ru/dev/jsapi-v1-1/doc/ru/llms.txt

# YMaps.MiniMap

Расширяет [YMaps.IControl](https://yandex.ru/dev/jsapi-v1-1/doc/ru/ref/reference/icontrol.md).

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

## Конструктор

Имя | Описание
----- | -----
[YMaps.MiniMap](minimap.md#constructor)(zoomOffset) | Создает обзорную карту (уменьшенную карту показываемой местности, коэффициент масштабирования которой на несколько пунктов меньше основной карты).


## Поля

Имя | Описание
----- | -----
[Events](minimap.md#Events) | Список событий элемента управления "Обзорная карта".

## События

Имя | Описание
----- | -----
[VisibilityChange](minimap.md#event-VisibilityChange) | Изменение статуса показа элемента управления.

## Методы

Имя | Возвращает | Описание
----- | ----- | -----
[getType](minimap.md#getType)() | [YMaps.MapType](maptype.md) | Возвращает текущий тип обзорной карты.
[getVisible](minimap.md#getVisible)() | Boolean | Проверяет текущий статус обзорной карты (видима/скрыта).
[setType](minimap.md#setType)(mapType) |  | Переключает тип обзорной карты.
[setVisible](minimap.md#setVisible)(visible) |  | Устанавливает статус показа обзорной карты (видима/скрыта).

## Наследуемые методы


Из [YMaps.IControl](https://yandex.ru/dev/jsapi-v1-1/doc/ru/ref/reference/icontrol.md): 
: [onAddToMap](https://yandex.ru/dev/jsapi-v1-1/doc/ru/ref/reference/icontrol.md#onAddToMap), [onRemoveFromMap](https://yandex.ru/dev/jsapi-v1-1/doc/ru/ref/reference/icontrol.md#onRemoveFromMap)

## Подробное описание конструктора {#constructor}

```javascript
YMaps.MiniMap(zoomOffset)
```

Создает обзорную карту (уменьшенную карту показываемой местности, коэффициент масштабирования которой на несколько пунктов меньше основной карты). Положение обзорной карты по умолчанию [YMaps.ControlPosition.BOTTOM_LEFT](https://yandex.ru/dev/jsapi-v1-1/doc/ru/ref/reference/controlposition.md#.BOTTOM_LEFT).

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

Имя | Тип | Необязательный | По умолчанию | Описание
----- | ----- | ----- | ----- | -----
`zoomOffset` | Integer | ![](../_images/check.png) | 5 | Смещение коэффициента масштабирования обзорной карты относительно коэффициента масштабирования основной.

## Подробное описание полей {#field_detail}

### Events {#Events}

```javascript
Object Events
```

Список событий элемента управления "Обзорная карта".

## Подробное описание событий {#event_detail}

### VisibilityChange {#VisibilityChange}

```javascript
VisibilityChange
```

Изменение статуса показа элемента управления. В callback-функцию передается указатель на элемент управления "Обзорная карта".
## Подробное описание методов {#method_detail}

## getType

```javascript
{YMaps.MapType} getType()
```

Возвращает текущий тип обзорной карты.

**Возвращает:**

Тип | Описание
----- | -----
[YMaps.MapType](maptype.md) | Текущий тип карты.

### getVisible {#getVisible}

```javascript
{Boolean} getVisible()
```

Проверяет текущий статус обзорной карты (видима/скрыта).

**Возвращает:**

Тип | Описание
----- | -----
Boolean | true - обзорная карта видима, false - скрыта.

### setType {#setType}

```javascript
setType(mapType)
```

Переключает тип обзорной карты.

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

Имя | Тип | Описание
----- | ----- | -----
`mapType` | [YMaps.MapType](maptype.md) | Тип обзорной карты.

### setVisible {#setVisible}

```javascript
setVisible(visible)
```

Устанавливает статус показа обзорной карты (видима/скрыта).

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

Имя | Тип | Описание
----- | ----- | -----
`visible` | Boolean | true - обзорная карта видима, false - скрыта.