YMaps.YMapsML
Расширяет YMaps.GeoObjectCollection.
Класс для работы с YMapsML документами. Загружаемый документ должен находиться в открытом доступе по HTTP-протоколу.
См.: API Яндекс Карт. Справочник по языку YMapsML
Конструктор
| Имя | Описание |
|---|---|
| YMaps.YMapsML(url, options) | Создает объект для работы с YMapsML-документами. |
Поля
|
Имя |
Описание |
|
Список событий, возможных в YMaps.YMapsML. |
|
|
Настройки отображения. Представляют собой объект с двумя полями: mapType и boundedBy.
|
Наследуемые поля
События
| Имя | Описание |
|---|---|
| Fault | Ошибка при загрузке документа YMapsML. |
| Load | Успешная загрузка документа YMapsML. |
Наследуемые события
- Из YMaps.Group:
- Add, Remove
Методы
| Имя | Описание |
|---|---|
| applyView() | Применяет описанные в YMapsML-документе настройки отображения. |
Наследуемые методы
- Из YMaps.OverlayGroup:
- getMap, getParentContainer
- Из YMaps.Group:
- add, filter, forEach, get, indexOf, length, remove, removeAll, splice
- Из YMaps.IOverlay:
- onAddToMap, onMapUpdate, onRemoveFromMap
- Из YMaps.IGeoObject:
- getBounds, getComputedStyle, getParentGroup, getStyle, onAddToGroup, onRemoveFromGroup, setBounds, setStyle, update
Подробное описание конструктора
YMaps.YMapsML(url, options)
Создает объект для работы с YMapsML-документами.
См.: API Яндекс Карт. Справочник по языку YMapsML
Параметры:
| Имя | Тип | Необязательный | По умолчанию | Описание |
|---|---|---|---|---|
url |
String | URL YMapsML-документа. | ||
options |
Object |  |
Опции. | |
options.viewAutoApply |
Boolean | |
true | Автоматически применять настройки отображения, указанные в YMapsML-документе. |
Подробное описание полей
Events
Object Events
Список событий, возможных в YMaps.YMapsML.
view
Object view
Настройки отображения.
Представляют собой объект с двумя полями: mapType и boundedBy.
- mapType {String} - ключ типа карты;
- boundedBy {YMaps.GeoBounds} - область карты, в пределах которой нужно отобразить данный YMapsML-документ.
Подробное описание событий
Fault
Fault
Ошибка при загрузке документа YMapsML.
В callback-функцию передаются два аргумента:
- указатель на ymapsml документ;
- строка с описанием ошибки.
Load
Load
Успешная загрузка документа YMapsML. В callback-функцию передается ссылка на объект, для которого был вызван обработчик.
Подробное описание методов
applyView
applyView()
Применяет описанные в YMapsML-документе настройки отображения.