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

# YMaps.YMapsML

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

Класс для работы с YMapsML документами. Загружаемый документ должен находиться на вашем сервере в открытом доступе по HTTP-протоколу.

**См.:** [API Яндекс Карт. Справочник по языку YMapsML](../../../../../../ymapsml/doc/1.x/ref/yandex-maps-ymapsml-reference-1.x.ditamap)

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

Имя | Описание
----- | -----
[YMaps.YMapsML](ymapsml.md#constructor)(url, options) | Создает объект для работы с YMapsML-документами.


## Поля

#|
|| **Имя** | **Описание** ||
|| [Events](https://yandex.ru/dev/jsapi-v1-1/doc/ru/ref/reference/ymapsml.md#Events) | Список событий, возможных в YMaps.YMapsML. ||
|| [view](https://yandex.ru/dev/jsapi-v1-1/doc/ru/ref/reference/ymapsml.md#view) | Настройки отображения.

Представляют собой объект с двумя полями: mapType и boundedBy.

- mapType {String} - ключ типа карты;
- boundedBy {YMaps.GeoBounds} - область карты, в пределах которой нужно отобразить данный YMapsML-документ.||
|#

## Наследуемые поля


Из [YMaps.IGeoObject](https://yandex.ru/dev/jsapi-v1-1/doc/ru/ref/reference/igeoobject.md): 
: [description](https://yandex.ru/dev/jsapi-v1-1/doc/ru/ref/reference/igeoobject.md#description), [id](https://yandex.ru/dev/jsapi-v1-1/doc/ru/ref/reference/igeoobject.md#id), [metaDataProperty](https://yandex.ru/dev/jsapi-v1-1/doc/ru/ref/reference/igeoobject.md#metaDataProperty), [name](https://yandex.ru/dev/jsapi-v1-1/doc/ru/ref/reference/igeoobject.md#name)

## События

Имя | Описание
----- | -----
[Fault](ymapsml.md#event-Fault) | Ошибка при загрузке документа YMapsML.
[Load](ymapsml.md#event-Load) | Успешная загрузка документа YMapsML.

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


Из [YMaps.Group](https://yandex.ru/dev/jsapi-v1-1/doc/ru/ref/reference/group.md): 
: [Add](https://yandex.ru/dev/jsapi-v1-1/doc/ru/ref/reference/group.md#event-Add), [Remove](https://yandex.ru/dev/jsapi-v1-1/doc/ru/ref/reference/group.md#event-Remove)

## Методы

Имя | Описание
----- | -----
[applyView](ymapsml.md#applyView)() | Применяет описанные в YMapsML-документе настройки отображения.

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


Из [YMaps.OverlayGroup](https://yandex.ru/dev/jsapi-v1-1/doc/ru/ref/reference/overlaygroup.md): 
: [getMap](https://yandex.ru/dev/jsapi-v1-1/doc/ru/ref/reference/overlaygroup.md#getMap), [getParentContainer](https://yandex.ru/dev/jsapi-v1-1/doc/ru/ref/reference/overlaygroup.md#getParentContainer)

Из [YMaps.Group](https://yandex.ru/dev/jsapi-v1-1/doc/ru/ref/reference/group.md): 
: [add](https://yandex.ru/dev/jsapi-v1-1/doc/ru/ref/reference/group.md#add), [filter](https://yandex.ru/dev/jsapi-v1-1/doc/ru/ref/reference/group.md#filter), [forEach](https://yandex.ru/dev/jsapi-v1-1/doc/ru/ref/reference/group.md#forEach), [get](https://yandex.ru/dev/jsapi-v1-1/doc/ru/ref/reference/group.md#get), [indexOf](https://yandex.ru/dev/jsapi-v1-1/doc/ru/ref/reference/group.md#indexOf), [length](https://yandex.ru/dev/jsapi-v1-1/doc/ru/ref/reference/group.md#length), [remove](https://yandex.ru/dev/jsapi-v1-1/doc/ru/ref/reference/group.md#remove), [removeAll](https://yandex.ru/dev/jsapi-v1-1/doc/ru/ref/reference/group.md#removeAll), [splice](https://yandex.ru/dev/jsapi-v1-1/doc/ru/ref/reference/group.md#splice)

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

Из [YMaps.IGeoObject](https://yandex.ru/dev/jsapi-v1-1/doc/ru/ref/reference/igeoobject.md): 
: [getBounds](https://yandex.ru/dev/jsapi-v1-1/doc/ru/ref/reference/igeoobject.md#getBounds), [getComputedStyle](https://yandex.ru/dev/jsapi-v1-1/doc/ru/ref/reference/igeoobject.md#getComputedStyle), [getParentGroup](https://yandex.ru/dev/jsapi-v1-1/doc/ru/ref/reference/igeoobject.md#getParentGroup), [getStyle](https://yandex.ru/dev/jsapi-v1-1/doc/ru/ref/reference/igeoobject.md#getStyle), [onAddToGroup](https://yandex.ru/dev/jsapi-v1-1/doc/ru/ref/reference/igeoobject.md#onAddToGroup), [onRemoveFromGroup](https://yandex.ru/dev/jsapi-v1-1/doc/ru/ref/reference/igeoobject.md#onRemoveFromGroup), [setBounds](https://yandex.ru/dev/jsapi-v1-1/doc/ru/ref/reference/igeoobject.md#setBounds), [setStyle](https://yandex.ru/dev/jsapi-v1-1/doc/ru/ref/reference/igeoobject.md#setStyle), [update](https://yandex.ru/dev/jsapi-v1-1/doc/ru/ref/reference/igeoobject.md#update)

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

```javascript
YMaps.YMapsML(url, options)
```

Создает объект для работы с YMapsML-документами.

**См.:** [API Яндекс Карт. Справочник по языку YMapsML](../../../../../../ymapsml/doc/1.x/ref/yandex-maps-ymapsml-reference-1.x.ditamap)

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

Имя | Тип | Необязательный | По умолчанию | Описание
----- | ----- | ----- | ----- | -----
`url` | String |  |  | URL YMapsML-документа.
`options` | Object | ![](../_images/check.png) |  | Опции.
`options.viewAutoApply` | Boolean | ![](../_images/check.png) | true | Автоматически применять настройки отображения, указанные в YMapsML-документе.

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

### Events {#Events}

```javascript
Object Events
```

Список событий, возможных в YMaps.YMapsML.
### view {#view}

```javascript
Object view
```

Настройки отображения.

Представляют собой объект с двумя полями: mapType и boundedBy.

- mapType {String} - ключ типа карты;
- boundedBy {YMaps.GeoBounds} - область карты, в пределах которой нужно отобразить данный YMapsML-документ.

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

### Fault {#Fault}

```javascript
Fault
```

Ошибка при загрузке документа YMapsML.

В callback-функцию передаются два аргумента:

- указатель на ymapsml документ;
- строка с описанием ошибки.
### Load {#Load}

```javascript
Load
```

Успешная загрузка документа YMapsML. В callback-функцию передается ссылка на объект, для которого был вызван обработчик.
## Подробное описание методов {#method_detail}

### applyView {#applyView}

```javascript
applyView()
```

Применяет описанные в YMapsML-документе настройки отображения.