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

# overlay.storage

Static object.

Instance of [util.AsyncStorage](https://yandex.com/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/util.AsyncStorage.md)

Storage for overlays. By default, the overlays have not been added to package.full (the standard set of modules). Overlays are loaded on demand when geo objects are added to the map. To get the overlay class, use the [require](https://yandex.com/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/util.AsyncStorage.md#require) method for this storage. By default, the storage declares the following keys for asynchronous access: 
- 'default#placemark' - Placemark image overlay [overlay.Placemark](https://yandex.com/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/overlay.Placemark.md).
- 'default#pin' - Overlay of the circle [overlay.Pin](https://yandex.com/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/overlay.Pin.md) placemark
- 'default#circle' - Circle overlay [overlay.Circle](https://yandex.com/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/overlay.Circle.md).
- 'default#rectangle' - Rectangle overlay [overlay.Rectangle](https://yandex.com/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/overlay.Rectangle.md).
- 'default#polyline' - Polyline overlay [overlay.Polyline](https://yandex.com/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/overlay.Polyline.md).
- 'default#polygon' - Polygon overlay [overlay.Polygon](https://yandex.com/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/overlay.Polygon.md).
- 'hotspot#placemark' - Hotspot placemark overlay [overlay.hotspot.Placemark](https://yandex.com/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/overlay.hotspot.Placemark.md).
- 'hotspot#circle' - Hotspot circle overlay [overlay.hotspot.Circle](https://yandex.com/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/overlay.hotspot.Circle.md).
- 'hotspot#rectangle' - Hotspot rectangle overlay [overlay.hotspot.Rectangle](https://yandex.com/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/overlay.hotspot.Rectangle.md).
- 'hotspot#polyline' - Hotspot polyline overlay [overlay.hotspot.Polyline](https://yandex.com/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/overlay.hotspot.Polyline.md).
- 'hotspot#polygon' - Hotspot polygon overlay [overlay.hotspot.Polygon](https://yandex.com/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/overlay.hotspot.Polygon.md).
- 'html#balloon' - HTML balloon overlay [overlay.html.Balloon](https://yandex.com/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/overlay.html.Balloon.md).
- 'html#hint' - Basic HTML overlay [overlay.html.Hint](https://yandex.com/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/overlay.html.Hint.md).
- 'html#placemark' - HTML placemark overlay [overlay.html.Placemark](https://yandex.com/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/overlay.html.Placemark.md).
- 'html#rectangle' - HTML rectangle overlay [overlay.html.Rectangle](https://yandex.com/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/overlay.html.Rectangle.md).

[Methods](#methods-summary)

**Example:**

```javascript
ymaps.overlay.storage.require(['hotspot#circle'], function (HotspotOverlayClass) {
    // Creating an instance of the received class.
    var overlay = new HotspotOverlayClass(
        new ymaps.geometry.Circle([30, 50], 10), {}, {}
    );
});
```

## Methods {#methods-summary}

#|
|| **Name** | **Returns** | **Description** ||
|| [add](https://yandex.com/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/util.Storage.md#add)([key](https://yandex.com/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/util.Storage.md#add-param-key), [object](https://yandex.com/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/util.Storage.md#add-param-object)) | [util.Storage](https://yandex.com/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/util.Storage.md) | Adds an object to storage. ||
|| [define](https://yandex.com/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/util.AsyncStorage.md#define)([key](https://yandex.com/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/util.AsyncStorage.md#define-param-key)[, [depends](https://yandex.com/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/util.AsyncStorage.md#define-param-depends), [resolveCallback](https://yandex.com/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/util.AsyncStorage.md#define-param-resolveCallback)[, [context](https://yandex.com/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/util.AsyncStorage.md#define-param-context)]]) | [util.AsyncStorage](https://yandex.com/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/util.AsyncStorage.md) | Defines an asynchronous value in storage. ||
|| [get](https://yandex.com/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/util.Storage.md#get)([key](https://yandex.com/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/util.Storage.md#get-param-key)) | Object | Returns object stored for the specified key, or the primary key, if this is not a string. ||
|| [isDefined](https://yandex.com/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/util.AsyncStorage.md#isDefined)([key](https://yandex.com/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/util.AsyncStorage.md#isDefined-param-key)) | Boolean | Checking if the key can be accessed in the storage. ||
|| [remove](https://yandex.com/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/util.Storage.md#remove)([key](https://yandex.com/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/util.Storage.md#remove-param-key)) | [util.Storage](https://yandex.com/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/util.Storage.md) | Deletes the "key: value" pair from storage. ||
|| [require](https://yandex.com/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/util.AsyncStorage.md#require)([keys](https://yandex.com/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/util.AsyncStorage.md#require-param-keys)[, [successCallback](https://yandex.com/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/util.AsyncStorage.md#require-param-successCallback)[, [errorCallback](https://yandex.com/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/util.AsyncStorage.md#require-param-errorCallback)[, [context](https://yandex.com/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/util.AsyncStorage.md#require-param-context)]]]) | [vow.Promise](https://yandex.com/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/vow.Promise.md) | Async request to get values from the storage. ||
|#


[*star]: Mandatory parameter/option.