---
metadata:
  - name: generator
    content: Diplodoc Platform v5.39.1
alternate:
  - https://yandex.ru/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/map.margin.Accessor.md
  - https://yandex.ru/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/map.margin.Accessor.md
---
> **Documentation Index:** Fetch the complete configuration index at https://yandex.ru/dev/jsapi-v2-1/doc/ru/llms.txt

# map.margin.Accessor

Объект, который предоставляет доступ к прямоугольной области в менеджере отступов.

[Конструктор](#constructor-summary) | [Поля ](#properties-summary) | [События ](#events-summary) | [Методы ](#methods-summary)

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

```javascript
map.margin.Accessor(screenArea)
```

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

#|
|| **Параметр** | **Значение по умолчанию** | **Описание**  ||
|| [`screenArea`](#param-screenArea)[*](*star) | — | Тип: Object

Прямоугольная область, которая задана в экранных координатах. Область описывается в виде объекта, который содержит информацию о смещении от краев карты (left, top, right, bottom) и размеры области (width, height). Значения могут быть заданы в виде процентов от ширины/высоты контейнера карты.

Не инстанцируйте экземпляры этого класса без необходимости. ||
|#

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

## Поля {#properties-summary}

#|
|| **Имя** | **Тип** | **Описание** ||
|| [events](https://yandex.ru/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/map.margin.Accessor.md#events) | | Менеджер событий. ||
|#

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

#|
|| **Имя** | **Описание** ||
|| [change](https://yandex.ru/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/map.margin.Accessor.md#event-change) | Прямоугольная область была изменена. ||
|| [remove](https://yandex.ru/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/map.margin.Accessor.md#event-remove) | Аксесссор был удален из менеджера отступов. ||
|#


## Методы {#methods-summary}

#|
|| **Имя** | **Возвращает** | **Описание** ||
|| [getArea](https://yandex.ru/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/map.margin.Accessor.md#getArea)() | Object | Возвращает прямоугольная область. ||
|| [remove](https://yandex.ru/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/map.margin.Accessor.md#remove)() | [map.margin.Accessor](https://yandex.ru/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/map.margin.Accessor.md) | Удаление прямоугольной области из менеджера отступов. ||
|| [setArea](https://yandex.ru/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/map.margin.Accessor.md#setArea)([screenArea](https://yandex.ru/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/map.margin.Accessor.md#setArea-param-screenArea)) | [map.margin.Accessor](https://yandex.ru/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/map.margin.Accessor.md) | Возвращает ссылку на себя. ||
|#


## Описание полей {#field_detail}

### events {#events}

```javascript
events
```

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

## Описание событий {#event_detail}

### change {#change}

Прямоугольная область была изменена.

### remove  {#remove}

Аксесссор был удален из менеджера отступов.

## Описание методов {#method_detail}

### getArea {#getArea}

```javascript
{Object} getArea()
```

**Возвращает** прямоугольная область.

### remove  {#remove}

```javascript
{map.margin.Accessor} remove()
```

Удаление прямоугольной области из менеджера отступов.

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

### setArea {#setArea}

```javascript
{map.margin.Accessor} setArea(screenArea)
```

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

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

#|
|| **Параметр** | **Значение по умолчанию** | **Описание**  ||
|| [`screenArea`](#setArea-param-screenArea)[*](*star) | — | Тип: Object

Прямоугольная область, которая задана в экранных координатах. Область описывается в виде объекта, который содержит информацию о смещении от краев карты (left, top, right, bottom) и размеры области (width, height). Значения могут быть заданы в виде процентов от ширины/высоты контейнера карты. ||
|#

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

**Пример:**

```javascript
accessor.setArea({
    top: 50,
    left: 50,
    width: 100,
    height: 100
});
```

<!-- XLIFF_FARM_YjBkZjdi_CACHING -->

[*star]: Обязательный параметр.