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

# util.cursor.Accessor

Объект, предоставляющий доступ к добавленному на карту курсору.

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

```javascript
util.cursor.Accessor(key)
```

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

#|
|| **Параметр** | **Значение по умолчанию** | **Описание** ||
|| `key`[*](*parametr) | — | Тип: String

Ключ, под которым хранится курсор в хранилище курсоров. ||
|#

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

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

#|
|| **Имя** | **Возвращает** | **Описание** ||
|| [getKey](https://yandex.ru/dev/maps/archive/doc/jsapi/2-0/ru/ref/reference/util.cursor.Accessor.md#getKey)() | String | Возвращает текущий ключ для доступа к курсору в хранилище курсоров. ||
|| [remove](https://yandex.ru/dev/maps/archive/doc/jsapi/2-0/ru/ref/reference/util.cursor.Accessor.md#remove)() |  | Удаляет курсор с карты. ||
|| [setKey](https://yandex.ru/dev/maps/archive/doc/jsapi/2-0/ru/ref/reference/util.cursor.Accessor.md#setKey)() |  | Задает новый ключ для доступа к курсору. По этому ключу должен находиться соответствующий курсор в хранилище курсоров. В случае, если данный курсор активен, то он сразу сменится. ||
|#

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

### getKey

```javascript
{String} getKey()
```

Возвращает текущий ключ для доступа к курсору в хранилище курсоров.

### remove

```javascript
{} remove()
```

Удаляет курсор с карты.

### setKey

```javascript
{} setKey()
```

Задает новый ключ для доступа к курсору. По этому ключу должен находиться соответствующий курсор в хранилище курсоров. В случае, если данный курсор активен, то он сразу сменится.

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

#|
|| **Параметр** | **Значение по умолчанию** | **Описание** ||
|| `key`[*](*parametr) | — | Тип: String ||
|#


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

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