Yandex Maps Jsapi Reference

API Яндекс.КартСправочник по программному интерфейсу

11.08.2009

API Яндекс.Карт. Справочник по программному интерфейсу. Версия 1.1.3Дата сборки документа: 11.08.2009.Этот документ является составной частью технической документации Яндекса.Сайт справки к сервисам Яндекса: http://help.yandex.ru© 2008—2009 ООО «ЯНДЕКС». Все права защищены.СБ ОРФО © ООО Информатик, 1995-2007. Все права защищены.

Предупреждение об исключительных правахЯндексу (а также указанному им правообладателю) принадлежат исключительные права на все результаты интеллектуальной деятельности и приравненные к нимсредства индивидуализации, используемые при разработке, поддержке и эксплуатации сервиса API Яндекс.Карт. К таким результатам могут относиться, но неограничиваясь указанными, программы для ЭВМ, базы данных, изображения, тексты, другие произведения, а также изобретения, полезные модели, товарные знаки,знаки обслуживания, коммерческие обозначения и фирменные наименования. Эти права охраняются в соответствии с Гражданским кодексом РФ и международнымправом.Вы можете использовать сервис API Яндекс.Карт или его составные части только в рамках полномочий, предоставленных вам Пользовательским соглашениемсервиса API Яндекс.Карт или специального соглашения.Нарушение требований по защите исключительных прав правообладателя влечет за собой дисциплинарную, гражданско-правовую, административнуюили уголовную ответственность в соответствии с российским законодательством.

Контактная информацияООО «ЯНДЕКС»http://www.yandex.ruТел.: +7 495 739 7000Email: [email protected]Главный офис: 111033, г. Москва, ул. Самокатная, д. 1, стр. 21

http://help.yandex.ru

http://www.yandex.ru

СодержаниеО справочнике .................................................................................................................................................................................... 5YMaps .................................................................................................................................................................................................. 5YMaps.Balloon .................................................................................................................................................................................... 7YMaps.BalloonContentStyle ............................................................................................................................................................. 11YMaps.BalloonOptions ..................................................................................................................................................................... 12YMaps.BalloonStyle .......................................................................................................................................................................... 13YMaps.Bounds ................................................................................................................................................................................... 14YMaps.CartesianCoordSystem .......................................................................................................................................................... 14YMaps.CollectionBounds .................................................................................................................................................................. 16YMaps.ConnectedPlacemarks ........................................................................................................................................................... 17YMaps.ControlPosition ..................................................................................................................................................................... 19YMaps.Converter ............................................................................................................................................................................... 20YMaps.Cursor .................................................................................................................................................................................... 25YMaps.Events .................................................................................................................................................................................... 26YMaps.GeoBounds ............................................................................................................................................................................ 27YMaps.Geocoder ............................................................................................................................................................................... 29YMaps.GeocoderResult ..................................................................................................................................................................... 32YMaps.GeoCollectionBounds ........................................................................................................................................................... 35YMaps.GeoCoordSystem .................................................................................................................................................................. 36YMaps.GeoObjectCollection ............................................................................................................................................................. 39YMaps.GeoPoint ................................................................................................................................................................................ 40YMaps.GraphicsEditingMenuIDs ..................................................................................................................................................... 44YMaps.GraphicsEditingOptions ........................................................................................................................................................ 44YMaps.Group ..................................................................................................................................................................................... 47YMaps.Hint ........................................................................................................................................................................................ 51YMaps.HintContentStyle ................................................................................................................................................................... 54YMaps.HintOptions ........................................................................................................................................................................... 54YMaps.HintStyle ............................................................................................................................................................................... 55YMaps.IBalloonLayout ..................................................................................................................................................................... 56YMaps.IconContentStyle ................................................................................................................................................................... 58YMaps.IconShadowStyle ................................................................................................................................................................... 58YMaps.IconStyle ............................................................................................................................................................................... 59YMaps.IContentableLayout ............................................................................................................................................................... 61YMaps.IControl ................................................................................................................................................................................. 61YMaps.ICoordBounds ....................................................................................................................................................................... 62YMaps.ICoordPoint ........................................................................................................................................................................... 66YMaps.ICoordSystem ........................................................................................................................................................................ 70YMaps.IGeoObject ............................................................................................................................................................................ 74YMaps.IHintLayout ........................................................................................................................................................................... 77YMaps.IInteractiveGeoObject ........................................................................................................................................................... 78YMaps.ILayer .................................................................................................................................................................................... 83YMaps.ILayout .................................................................................................................................................................................. 85YMaps.ImageTile .............................................................................................................................................................................. 86YMaps.InteractiveGeoObjectOptions ................................................................................................................................................ 87YMaps.IObserver ............................................................................................................................................................................... 89YMaps.IOverlay ................................................................................................................................................................................. 90YMaps.IPlacemarkLayout ................................................................................................................................................................. 91YMaps.ITemplate .............................................................................................................................................................................. 91YMaps.ITile ....................................................................................................................................................................................... 92YMaps.IToolBarItem ......................................................................................................................................................................... 94YMaps.Layer ..................................................................................................................................................................................... 96YMaps.Layers .................................................................................................................................................................................... 98YMaps.LayoutTemplate .................................................................................................................................................................... 99YMaps.LineStyle ............................................................................................................................................................................. 100YMaps.ListBox ................................................................................................................................................................................ 100YMaps.ListBoxItem ......................................................................................................................................................................... 103YMaps.ListBoxToggleItem ............................................................................................................................................................. 104YMaps.Map ..................................................................................................................................................................................... 106YMaps.MapBalloonOptions ............................................................................................................................................................ 131YMaps.MapHintOptions .................................................................................................................................................................. 132YMaps.MapType ............................................................................................................................................................................. 132

API Яндекс.Карт Справочник по программному интерфейсу

Содержание

YMaps.MiniMap .............................................................................................................................................................................. 135YMaps.MouseEvent ......................................................................................................................................................................... 137YMaps.ObjectManager .................................................................................................................................................................... 139YMaps.OverlayGroup ...................................................................................................................................................................... 141YMaps.Placemark ............................................................................................................................................................................ 142YMaps.PlacemarkOptions ............................................................................................................................................................... 148YMaps.Point .................................................................................................................................................................................... 149YMaps.Polygon ............................................................................................................................................................................... 155YMaps.PolygonEditingOptions ....................................................................................................................................................... 163YMaps.PolygonStyle ....................................................................................................................................................................... 164YMaps.Polyline ............................................................................................................................................................................... 165YMaps.PolylineEditingOptions ....................................................................................................................................................... 173YMaps.Route ................................................................................................................................................................................... 174YMaps.Router .................................................................................................................................................................................. 176YMaps.RouteSegment ..................................................................................................................................................................... 181YMaps.ScaleLine ............................................................................................................................................................................. 184YMaps.SearchControl ...................................................................................................................................................................... 184YMaps.Size ...................................................................................................................................................................................... 186YMaps.SmallZoom .......................................................................................................................................................................... 187YMaps.State ..................................................................................................................................................................................... 187YMaps.Style ..................................................................................................................................................................................... 188YMaps.Styles ................................................................................................................................................................................... 190YMaps.Template .............................................................................................................................................................................. 192YMaps.Templates ............................................................................................................................................................................ 194YMaps.TileCoordinates ................................................................................................................................................................... 195YMaps.TileDataSource .................................................................................................................................................................... 197YMaps.ToolBar ............................................................................................................................................................................... 200YMaps.ToolBarButton ..................................................................................................................................................................... 202YMaps.ToolBarRadioButton ........................................................................................................................................................... 206YMaps.ToolBarSeparator ................................................................................................................................................................ 208YMaps.ToolBarToggleButton ......................................................................................................................................................... 209YMaps.TypeControl ........................................................................................................................................................................ 210YMaps.ViaPoint ............................................................................................................................................................................... 212YMaps.WayPoint ............................................................................................................................................................................. 213YMaps.YMapsML ........................................................................................................................................................................... 213YMaps.ZIndex ................................................................................................................................................................................. 216YMaps.Zoom ................................................................................................................................................................................... 217

Предметный указатель .................................................................................................................................................................. 219


4

Справочник по программному интерфейсу

О справочникеСправочник содержит описание программного интерфейса JavaScript (JavaScript API) к сервисуЯндекс.Карты.

Целевой аудиторией справочника являются разработчики сайтов, которые хотят использовать интерак-тивные Яндекс.Карты на своих веб-страницах.

Справочник содержит описания открытых классов и методов API и расчитан на разработчиков, знако-мых с JavaScript и сервисом Яндекс.Карты. Классы перечислены в алфавитном порядке.

О том, как использовать классы и методы JavaScript API, читайте в Руководстве разработчика.

Информация, представленная в справочнике, актуальна для текущей версии JavaScript API.

YMaps

ПоляИмя ОписаниеjQuery Фреймворк jQuery.

Используется версия 1.3.2.

TILE_SIZE Размер тайла (в пикселах).

МетодыИмя Возвращает ОписаниеhumanDistance(distance, roughly) String Приводит расстояние в метрах к уд-

обочитаемому строковому предста-влению.

humanDuration(duration) String Приводит время в секундах к удоб-очитаемому строковому представле-нию.

load(callback) Инициирует загрузку функционалаAPI Яндекс.Карт. Используется сов-местно с параметром loadByRequire.

Подробное описание полей

jQueryfunction jQuery

Фреймворк jQuery.

Используется версия 1.3.2.

TILE_SIZEInteger TILE_SIZE

Размер тайла (в пикселах).


5

http://maps.yandex.ru

http://api.yandex.ru/maps/jsapi/doc/../whatsnew.xml

http://jquery.com/

http://jquery.com/


Подробное описание методов

humanDistance{String} humanDistance(distance, roughly)

Приводит расстояние в метрах к удобочитаемому строковому представлению.

Если расстояние меньше 1000, то к выводу добавляется постфикс "м", иначе расстояние переводитсяв километры и выводится с постфиксом "км".

Обычное округление:

• distance < 2000 — округляется с точностью до одного метра;

• 2000 <= distance < 7000 — округляется с точностью до 10 метров;


• 50000 <= distance — округляется с точностью до одного километра.

Грубое округление (roughly равно true):

• distance < 1000 — округляется с точностью до 50 метров;


• 3000 <= distance — округляется с точностью до одного километра.

Пример:

// Округление расстояний с различной точностью. YMaps.humanDistance(158.5) // "159 м"YMaps.humanDistance(1158.5) // "1,159 км"YMaps.humanDistance(2158.5) // "2,16 км"YMaps.humanDistance(7158.5) // "7,2 км"YMaps.humanDistance(50158.5) // "50 км"YMaps.humanDistance(158.5, true) // "150 м"YMaps.humanDistance(1158.5, true) // "1,2 км"YMaps.humanDistance(2158.5, true) // "2,2 км"YMaps.humanDistance(7158.5, true) // "7 км"YMaps.humanDistance(50158.5, true) // "50 км"

Параметры:

Имя Тип Необязательный По умолчанию Описаниеdistance Number Расстояние в метрах.

roughly Boolean false true — использоватьгрубое округление,false —не использовать.

Возвращает:

Тип ОписаниеString Строковое представление расстояния.

humanDuration{String} humanDuration(duration)

Приводит время в секундах к удобочитаемому строковому представлению.

Если время меньше 20 минут, то округляется с точностью до секунд.

Если время меньше 20 часов, то округляется с точностью до минут.


6


Если время меньше 20 суток, то округляется с точностью до часов.

Если время более 20 суток, то округляется с точностью до суток.

Пример:

// Округление времени с различной точностью.YMaps.humanDuration(0.4) // "0 сек."YMaps.humanDuration(1199) // "19 мин. 59 сек."YMaps.humanDuration(1200) // "20 мин."YMaps.humanDuration(71969) // "19 час. 59 мин."YMaps.humanDuration(71970) // "20 час."YMaps.humanDuration(1726199) // "19 дн. 23 час."YMaps.humanDuration(1726200) // "20 дн."

Параметры:

Имя Тип Описаниеduration Number Время в секундах.


Тип ОписаниеString Строковое представление времени.

loadload(callback)

Инициирует загрузку функционала API Яндекс.Карт. Используется совместно с параметромloadByRequire.

Позволяет загружать API Яндекс.Карт по требованию, например, при возникновении какого-либо DOM-события или при вызове определенной пользовательской функции.

Если API подключено с параметром loadByRequire = 1, то API загружается при вызове этого метода.При обычном подключении API загрузка происходит одновременно с загрузкой страницы.

В качестве параметра метод может принимать обработчик, который будет вызван по окончании загрузки.

Вызывать YMaps.load можно несколько раз, при этом обработчики накапливаются в стеке. По окончаниизагрузки обработчики вызываются в порядке попадания в стек.

Если YMaps.load вызван после загрузки API или API подключен без параметра loadByRequire, то обра-ботчик выполняется сразу же.

См.: Загрузка карты по требованию

Параметры:

Имя Тип Необязательный По умолчанию Описаниеcallback Function Обработчик

окончания загрузкиAPI.

YMaps.BalloonРасширяет YMaps.IOverlay.

Балун.

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

Управление балуном осуществляется с помощью методов YMaps.Map.openBalloonи YMaps.Map.closeBalloon.


7

http://api.yandex.ru/maps/jsapi/doc/dg/concepts/map_load_byrequire.xml


См.: Балун

КонструкторИмя ОписаниеYMaps.Balloon(options) Создает балун (balloon) с текстом, картинкой или любым другим HTML-

содержимым.

ПоляИмя ОписаниеEvents Список обрабатываемых событий балуна.

СобытияИмя ОписаниеClose Закрытие балуна.

МетодыИмя Возвращает ОписаниеgetContent() String|HTMLElement|YMaps.ILayout Возвращает содержимое балуна,

установленное с помощью методаYMaps.Balloon.setContent.

getCoordPoint() YMaps.ICoordPoint Возвращает координаты балунана карте.

getGeoPoint() YMaps.ICoordPoint То же, чтои YMaps.Balloon.getCoordPoint.

getOptions() YMaps.BalloonOptions Возвращает опции балуна.

mapAutoPan(callback) Сдвигает карту таким образом,чтобы балун было видно целиком.C помощью опцииYMaps.BalloonOptions.margin,можно задать минимальный отступбалуна от края карты (в пикселах).

setContent(content) Устанавливает содержимое балуна.

setCoordPoint(coordPoint) Позиционирует балун в точкус заданными координатами.

setGeoPoint(coordPoint) То же, чтои YMaps.Balloon.setCoordPoint.

setOptions(options, restoreDefault) Устанавливает опции балуна.

update() Полностью перестраивает балун.

Наследуемые методыИз YMaps.IOverlay:

onAddToMap, onMapUpdate, onRemoveFromMap

Подробное описание конструктораYMaps.Balloon(options)

Создает балун (balloon) с текстом, картинкой или любым другим HTML-содержимым.

Балун состоит из области, в которой показывается HTML-содержимое и клиновидного "хвостика", ука-зывающего в определенную точку на карте. Балун, например, всплывает при щелчке мышью по метке.Балун является оверлеем.


8

http://api.yandex.ru/maps/jsapi/doc/dg/concepts/balloon.xml


См.: Балун

Параметры:

Имя Тип Необязательный По умолчанию Описаниеoptions YMaps.BalloonOptio

nsОпции балуна.


EventsObject Events

Список обрабатываемых событий балуна.

Подробное описание событий

CloseClose

Закрытие балуна. В callback-функцию передается указатель на балун.


getContent{String|HTMLElement|YMaps.ILayout} getContent()

Возвращает содержимое балуна, установленное с помощью метода YMaps.Balloon.setContent.


Тип ОписаниеString|HTMLElement|YMaps.ILayout Содержимое балуна.

getCoordPoint{YMaps.ICoordPoint} getCoordPoint()

Возвращает координаты балуна на карте.


Тип ОписаниеYMaps.ICoordPoint Координаты балуна.

getGeoPoint{YMaps.ICoordPoint} getGeoPoint()

То же, что и YMaps.Balloon.getCoordPoint.


Тип ОписаниеYMaps.ICoordPoint Координаты балуна.


9

http://api.yandex.ru/maps/jsapi/doc/dg/concepts/balloon.xml


getOptions{YMaps.BalloonOptions} getOptions()

Возвращает опции балуна.


Тип ОписаниеYMaps.BalloonOptions Объект опций.

mapAutoPanmapAutoPan(callback)

Сдвигает карту таким образом, чтобы балун было видно целиком. C помощью опцииYMaps.BalloonOptions.margin, можно задать минимальный отступ балуна от края карты (в пикселах).

Параметры:

Имя Тип Описаниеcallback Function Функция-обработчик для события

окончания сдвига карты.

setContentsetContent(content)

Устанавливает содержимое балуна. Если в параметре content передана строка, то контейнером для со-держимого балуна станет элемент div. Переданная строка станет значением свойства innerHTMLэлемента div.

Параметры:

Имя Тип Описаниеcontent String|HTMLElement|YMaps.ILayout Содержимое балуна (строка, DOM-

элемент или макет).

setCoordPointsetCoordPoint(coordPoint)

Позиционирует балун в точку с заданными координатами.

Параметры:

Имя Тип ОписаниеcoordPoint YMaps.ICoordPoint Координаты балуна на карте.

setGeoPointsetGeoPoint(coordPoint)

То же, что и YMaps.Balloon.setCoordPoint.

Параметры:

Имя Тип ОписаниеcoordPoint YMaps.ICoordPoint Координаты балуна на карте.


10


setOptionssetOptions(options, restoreDefault)

Устанавливает опции балуна.

Примеры:

1.

// Передает опции с помощью метода карты openBalloon() и открывает балун.map.openBalloon(new YMaps.GeoPoint(37, 55), 'Здесь был Я.', {hasCloseButton: false, mapAutoPan: 0});

2.

// Передает опции после открытия балуна, не задействуя метод openBalloon. map.getBalloon().setOptions({hasCloseButton: false, mapAutoPan: 0});

Параметры:

Имя Тип Необязательный По умолчанию Описаниеoptions YMaps.BalloonOptio

nsОбъект опций.

restoreDefault Boolean false Незаданные опцииустановитьв значенияпо умолчанию.

updateupdate()

Полностью перестраивает балун. Вызывается, если необходимо обновить балун.

YMaps.BalloonContentStyleСтиль содержимого балуна.

КонструкторИмя ОписаниеYMaps.BalloonContentStyle(template) Создает объект стиля содержимого балуна.

ПоляИмя Описаниеtemplate Шаблон или ключ шаблона.

Подробное описание конструктораYMaps.BalloonContentStyle(template)

Создает объект стиля содержимого балуна.

Параметры:

Имя Тип Необязательный По умолчанию Описаниеtemplate YMaps.Template|

String"default#balloonContent"

Шаблон или ключшаблона.


11



templatetemplate

Шаблон или ключ шаблона.

YMaps.BalloonOptionsКласс содержит опции объекта балуна.

Данный класс не имеет конструктора и создается как обычный объект JavaScript.

Пример:

// Открывает балун с помощью метода карты openBallon. Максимальная ширина балуна 50 пикселов, кнопки закрытия нет.map.openBalloon(new YMaps.GeoPoint(37.64, 55.76), 'Проверка', {hasCloseButton:false, maxWidth:50})

ПоляИмя ОписаниеhasCloseButton Флаг, указывающий, должна ли быть у балуна кнопка закрытия.

mapAutoPan Флаг, указывающий, что при открытии балуна требуется автоматическисдвигать карту так, чтобы балун был виден целиком.

margin Величина минимального отступа балуна от границ карты (в пикселах).

maxHeight Максимальная высота балуна (в пикселах).

maxWidth Максимальная ширина балуна (в пикселах).

style Объект стиля балуна.


hasCloseButtonBoolean hasCloseButton

Флаг, указывающий, должна ли быть у балуна кнопка закрытия. По умолчанию true. Опция влияет толькона отображение и общее поведение балуна не изменяет.

mapAutoPanBoolean mapAutoPan

Флаг, указывающий, что при открытии балуна требуется автоматически сдвигать карту так, чтобы балунбыл виден целиком. По умолчанию true.

marginNumber|Number[] margin

Величина минимального отступа балуна от границ карты (в пикселах).

Задается либо одним числом (одинаковый отступ от всех границ карты), либо массивом, который можетсодержать до 4-х элементов: (marginTop, marginRight, marginBottom, marginLeft).

По умолчанию имеет значение [33, 10, 20, 33].


12


Примеры:

1.

// Устанавливает одинаковый отступ 10 пикселов от всех границ карты. map.openBalloon(map.getBounds().getLeftTop(), text, {margin: 10});

2.

// Устанавливает вертикальные отступы 10, горизонтальные - 20 пикселов.map.openBalloon(map.getBounds().getLeftTop(), text, {margin: [10, 20]});// Устанавливает отступ от верхней границы карты 10, от левой и правой - по 20, от нижней - 30 пикселов.map.openBalloon(map.getBounds().getRightBottom(), text, {margin: [10, 20, 30]});// Устанавливает отступ от верхней границы карты 10, от правой - 20, от нижней - 30, от левой - 40 пикселов.map.openBalloon(map.getBounds().getRightBottom(), text, {margin: [10, 20, 30, 40]});

maxHeightNumber maxHeight

Максимальная высота балуна (в пикселах). Если 0 или null, то максимальную высоту определяет макет.Макет по умолчанию выставляет значение в зависимости от высоты карты, но не меньше 100px.

maxWidthNumber maxWidth

Максимальная ширина балуна (в пикселах). Если 0 или null, то максимальную ширину определяет макет.Макет по умолчанию выставляет значение в зависимости от ширины карты, но не меньше 520px.

styleYMaps.BalloonStyle style

Объект стиля балуна. По умолчанию используется стиль балуна из системного стиля по умолчаниюYMaps.Styles.DefaultStyleKey.

YMaps.BalloonStyleСтиль балуна.

КонструкторИмя ОписаниеYMaps.BalloonStyle(template) Создает объект стиля балуна.

ПоляИмя Описаниеtemplate Шаблон или ключ шаблона. Шаблон должен генерировать макет,

реализующий YMaps.IBalloonLayout.

Подробное описание конструктораYMaps.BalloonStyle(template)

Создает объект стиля балуна.


13


Параметры:


String"default#balloon" Шаблон или ключ

шаблона.


templatetemplate

Шаблон или ключ шаблона. Шаблон должен генерировать макет, реализующийYMaps.IBalloonLayout.

YMaps.BoundsРасширяет YMaps.ICoordBounds.

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

КонструкторИмя ОписаниеYMaps.Bounds(leftBottom, rightTop) Создает объект, представляющий собой прямоугольную область на карте,

заданную в пиксельных координатах.

Наследуемые методыИз YMaps.ICoordBounds:

contains, copy, equals, getBottom, getCenter, getLeft, getLeftBottom, getLeftTop, getMapZoom,getRight, getRightBottom, getRightTop, getSpan, getTop

Подробное описание конструктораYMaps.Bounds(leftBottom, rightTop)

Создает объект, представляющий собой прямоугольную область на карте, заданную в пиксельных коор-динатах.

Параметры:

Имя Тип ОписаниеleftBottom YMaps.Point Нижний левый угол области.

rightTop YMaps.Point Верхний правый угол области.

YMaps.CartesianCoordSystemРасширяет YMaps.ICoordSystem.

Класс "декартова система координат".Точка в декартовой системе представляется объектом YMaps.Point, а область — объектомYMaps.Bounds. Понятие ограниченности точек здесь неприменимо, область отображения объектов за-дается параметрами конструктора.


14


КонструкторИмя ОписаниеYMaps.CartesianCoordSystem(leftBottom, rightTop, scale, maxZoom)

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

Наследуемые методыИз YMaps.ICoordSystem:

distance, fromCoordPoint, getCoordBounds, getCoordPoint, getMaxZoom, getWorldSize, restrict,rulerDistance, toCoordPoint

Подробное описание конструктораYMaps.CartesianCoordSystem(leftBottom, rightTop, scale, maxZoom)

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

Пример:

// Реализует навигацию по плану местности. // Принимается, что:// - существует источник тайлов с коэффициентами масштабирования от 0 до 4,// - левый нижний угол плана местности имеет координаты (-1, -1) в географических координатах, а правый верхний - (1, 1),// - для приэкваториальных областей длина дуги в 1 градус равна 111,1 километра, кривизной земной поверхности можно пренебречь.var myCoordSystem = new YMaps.CartesianCoordSystem( new YMaps.Point(-1, -1), new YMaps.Point(1, 1), 111100, 4), map = new YMaps.Map(document.getElementById('YMapsID'), { coordSystem: myCoordSystem });

Параметры:

Имя Тип Необязательный По умолчанию ОписаниеleftBottom YMaps.Point Координаты левого

нижнего угла карты.

rightTop YMaps.Point Координаты правогонижнего угла карты.

scale Number|YMaps.Point 1 Количество метров,соответствующееединичному отрезкув данной системекоординат. Напри-мер, для географиче-ских карт соответ-ствует длине одногоградуса дуги; для из-ображений — разме-ру пиксела в метрах.

Может задаватьсякак одним числом,так и парой чисел —в случае, если мас-штабы вдоль коорди-натных осей различ-ны (например,


15


Имя Тип Необязательный По умолчанию Описаниедля планов местностина высоких широтах).

maxZoom Integer 23 Максимальныйкоэффициентмасштабированиякарты.

YMaps.CollectionBoundsРасширяет YMaps.Bounds.

Класс для создания прямоугольной области по набору точек.

КонструкторИмя ОписаниеYMaps.CollectionBounds(point) Создает объект YMaps.CollectionBounds.

МетодыИмя Описаниеadd(point) Добавляет точки в коллекцию YMaps.CollectionBounds.

clear() Сбрасывает параметры прямоугольной области.


contains, copy, equals, getBottom, getCenter, getLeft, getLeftBottom, getLeftTop, getMapZoom,getRight, getRightBottom, getRightTop, getSpan, getTop

Подробное описание конструктораYMaps.CollectionBounds(point)

Создает объект YMaps.CollectionBounds. Принимает массив точек и рассчитывает их область видимо-сти — прямоугольник, включающий в себя все точки массива.

Параметры:

Имя Тип Необязательный По умолчанию Описаниеpoint YMaps.Point|

YMaps.Point[]Точка или массивточек.


addadd(point)

Добавляет точки в коллекцию YMaps.CollectionBounds. Если точка находится за границами текущейпрямоугольной области, область расширяется так, чтобы включать новую точку.

Параметры:

Имя Тип Описаниеpoint YMaps.Point|YMaps.Point[] Точка или массив точек.


16


clearclear()

Сбрасывает параметры прямоугольной области. Координаты границ области обнуляются.

YMaps.ConnectedPlacemarksРасширяет YMaps.GeoObjectCollection.

Группа меток, соединенных линией.

КонструкторИмя ОписаниеYMaps.ConnectedPlacemarks(style) Создает группу меток, соединенных линией.

Наследуемые поляИз YMaps.Group:

EventsИз YMaps.IGeoObject:

description, id, metaDataProperty, name

Наследуемые событияИз YMaps.Group:

Add, Remove

МетодыИмя Возвращает ОписаниеgetLineVisible() Boolean Возвращает текущий статус

видимости соединяющих линий.

setLineVisible(visible) Устанавливает статус видимостисоединяющих линий.

setStyle(style) Устанавливает стиль группы меток.Стиль определяет вид как меток,так и соединяющих линий.

Наследуемые методыИз 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, update

Подробное описание конструктораYMaps.ConnectedPlacemarks(style)

Создает группу меток, соединенных линией. Может использоваться для отображения на карте путевыхточек маршрута.


17


Пример:

// Создает стиль для отображения путевых точек маршрута и соединительных линий, // затем с этим стилем отображает на карте простой маршрут.var style = YMaps.Style("default#greenPoint"),lineStyle = new YMaps.LineStyle();lineStyle.strokeColor = "00ff00";lineStyle.strokeWidth = 3;style.lineStyle = lineStyle;

var track = new YMaps.ConnectedPlacemarks(style);track.add([ new YMaps.Placemark(new YMaps.GeoPoint(0, 0)), new YMaps.Placemark(new YMaps.GeoPoint(20, 0))]);map.addOverlay(track);

Параметры:

Имя Тип Необязательный По умолчанию Описаниеstyle YMaps.Style|String Указатель на стиль

или ключ стиля.Стиль определяетвид как самих меток,так и соединяющихих линий.


getLineVisible{Boolean} getLineVisible()

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


Тип ОписаниеBoolean true — соединяющие линии видимы, false — соединяющие линии

не видимы.

setLineVisiblesetLineVisible(visible)

Устанавливает статус видимости соединяющих линий.

Параметры:

Имя Тип Описаниеvisible Boolean true — соединяющие линии видимы,

false — невидимы.

setStylesetStyle(style)

Устанавливает стиль группы меток. Стиль определяет вид как меток, так и соединяющих линий.

Параметры:

Имя Тип Описаниеstyle YMaps.Style|String Указатель на стиль или ключ стиля.


18


YMaps.ControlPositionОбъект задающий расположение элемента управления на карте.

Объект YMaps.ControlPosition может передаваться в качестве параметра в метод onAddToMap элементауправления.

КонструкторИмя ОписаниеYMaps.ControlPosition(anchor, offsets) Задает расположение элемента управления на карте.

ПоляИмя Статическо

еОписание

BOTTOM_LEFT Константа, задающая привязку к левому нижнему углу.

BOTTOM_RIGHT Константа, задающая привязку к правому нижнему углу.

TOP_LEFT Константа, задающая привязку к левому верхнему углу.

TOP_RIGHT Константа, задающая привязку к правому верхнемууглу.

МетодыИмя Описаниеapply(element) Помещает элемент управления в заданную позицию

на карте.

Подробное описание конструктораYMaps.ControlPosition(anchor, offsets)

Задает расположение элемента управления на карте.

Необходимо указать угол карты, в котором будет располагаться элемент управления, а также отступыот границ карты.

Пример:

// Помещает элемент управления в верхний левый угол карты. Отступ от левой границы карты 10, от верхней - 30 пикселов.map.addControl(control, new YMaps.ControlPosition(YMaps.ControlPosition.TOP_LEFT, new YMaps.Point(10, 30)));

Параметры:

Имя Тип Необязательный По умолчанию Описаниеanchor Const YMaps.ControlPositio

n.TOP_LEFTУгол карты,в котором будетрасполагатьсяэлемент.

offsets YMaps.Point new YMaps.Point(0, 0) Отступыотносительнозаданного угла карты(в пикселах).


19



BOTTOM_LEFTBOTTOM_LEFT

Константа, задающая привязку к левому нижнему углу.

BOTTOM_RIGHTBOTTOM_RIGHT

Константа, задающая привязку к правому нижнему углу.

TOP_LEFTTOP_LEFT

Константа, задающая привязку к левому верхнему углу.

TOP_RIGHTTOP_RIGHT

Константа, задающая привязку к правому верхнему углу.


applyapply(element)

Помещает элемент управления в заданную позицию на карте.

Параметры:

Имя Тип Описаниеelement HTMLElement Указатель на HTML-элемент.

YMaps.ConverterСодержит методы для преобразования координат одного типа в другой.

Данный класс не имеет конструктора.

Объект класса YMaps.Converter существует в единственном экземпляре для каждой карты и доступенв объекте карты как YMaps.Map.converter.

См.: Типы координат и их преобразование

Параметры:

Имя Тип Описаниеmap YMaps.Map Указатель на карту.


20

http://api.yandex.ru/maps/jsapi/doc/dg/concepts/coordinates_conversion.xml


МетодыИмя Возвращает ОписаниеclientPixelsToCoordinates(clientPixels, unbounded)

YMaps.ICoordPoint Преобразует точку, заданнуюпиксельными координатами окнабраузера, в точку координатнойсистемы.

clientPixelsToLocalPixels(clientPixels)

YMaps.Point Преобразует точку, заданнуюпиксельными координатами окнабраузера, в точку, заданнуюлокальными пиксельнымикоординатами.

coordinatesToClientPixels(coordPoint)

YMaps.Point Преобразует точку системыкоординат в точку, заданнуюпиксельными координатами окнабраузера.

coordinatesToLocalPixels(coordPoint)

YMaps.Point Преобразует точку координатнойсистемы в точку, заданнуюлокальными пиксельнымикоординатами.

coordinatesToMapPixels(coordPoint) YMaps.Point Преобразует точку координатнойсистемы в точку, заданнуюпиксельными координатами карты.Используется для расчетаместоположения оверлеев на карте.

localPixelsToClientPixels(localPixels) YMaps.Point Преобразует точку, заданнуюлокальными пиксельнымикоординатами в точку, заданнуюпиксельными координатами окнабраузера.

localPixelsToCoordinates(pixels,unbounded)

YMaps.ICoordPoint Преобразует точку, заданнуюлокальными пиксельнымикоординатами в точку координатнойсистемы.

localPixelsToMapPixels(localPixels) YMaps.Point Преобразует точку, заданнуюлокальными пиксельнымикоординатами, в точку, заданнуюпиксельными координатами карты.

mapPixelsToCoordinates(mapPixels,unbounded)

YMaps.ICoordPoint Преобразует точку, заданнуюпиксельными координатами карты,в точку координатной системы.

mapPixelsToLocalPixels(mapPixels) YMaps.Point Преобразует точку, заданнуюпиксельными координатами карты,в точку, заданную локальнымипиксельными координатами.


clientPixelsToCoordinates{YMaps.ICoordPoint} clientPixelsToCoordinates(clientPixels, unbounded)

Преобразует точку, заданную пиксельными координатами окна браузера, в точку координатной систе-мы.

Параметры:

Имя Тип Необязательный По умолчанию ОписаниеclientPixels YMaps.Point Точка, заданная

пиксельными


21


Имя Тип Необязательный По умолчанию Описаниекоординатами окнабраузера.

unbounded Boolean false Тип требуемойточки: false —ограниченная, true —неограниченная.


Тип ОписаниеYMaps.ICoordPoint Точку системы координат.

clientPixelsToLocalPixels{YMaps.Point} clientPixelsToLocalPixels(clientPixels)

Преобразует точку, заданную пиксельными координатами окна браузера, в точку, заданную локальнымипиксельными координатами.

Параметры:

Имя Тип ОписаниеclientPixels YMaps.Point Точка, заданная пиксельными

координатами окна браузера.


Тип ОписаниеYMaps.Point Точку, заданную локальными пиксельными координатами.

coordinatesToClientPixels{YMaps.Point} coordinatesToClientPixels(coordPoint)

Преобразует точку системы координат в точку, заданную пиксельными координатами окна браузера.

Параметры:

Имя Тип ОписаниеcoordPoint YMaps.ICoordPoint Точка координатной системы.


Тип ОписаниеYMaps.Point Точку, заданную пиксельными координатами окна браузера.

coordinatesToLocalPixels{YMaps.Point} coordinatesToLocalPixels(coordPoint)

Преобразует точку координатной системы в точку, заданную локальными пиксельными координатами.

Параметры:



22



Тип ОписаниеYMaps.Point Точку, заданную локальными пиксельными координатами,

соответствующую точке.

coordinatesToMapPixels{YMaps.Point} coordinatesToMapPixels(coordPoint)

Преобразует точку координатной системы в точку, заданную пиксельными координатами карты. Ис-пользуется для расчета местоположения оверлеев на карте.

Параметры:



Тип ОписаниеYMaps.Point Точку, заданную пиксельными координатами карты.

localPixelsToClientPixels{YMaps.Point} localPixelsToClientPixels(localPixels)

Преобразует точку, заданную локальными пиксельными координатами в точку, заданную пиксельнымикоординатами окна браузера.

Параметры:

Имя Тип ОписаниеlocalPixels YMaps.Point Точка, заданная локальными

пиксельными координатами.


Тип ОписаниеYMaps.Point Точку, заданную пиксельными координатами окна браузера.

localPixelsToCoordinates{YMaps.ICoordPoint} localPixelsToCoordinates(pixels, unbounded)

Преобразует точку, заданную локальными пиксельными координатами в точку координатной системы.

Параметры:

Имя Тип Необязательный По умолчанию Описаниеpixels YMaps.Point Точка, заданная

локальнымипиксельнымикоординатами.

unbounded Boolean false Тип требуемойточки: false —ограниченная, true —неограниченная.


23



Тип ОписаниеYMaps.ICoordPoint Точку, соответствующую точке, заданной локальными пиксельными

координатами.

localPixelsToMapPixels{YMaps.Point} localPixelsToMapPixels(localPixels)

Преобразует точку, заданную локальными пиксельными координатами, в точку, заданную пиксельнымикоординатами карты.

Параметры:

Имя Тип ОписаниеlocalPixels YMaps.Point Точка, заданная локальными

пиксельными координатами.


Тип ОписаниеYMaps.Point Точку, заданную пиксельными координатами карты.

mapPixelsToCoordinates{YMaps.ICoordPoint} mapPixelsToCoordinates(mapPixels, unbounded)

Преобразует точку, заданную пиксельными координатами карты, в точку координатной системы.

Параметры:

Имя Тип Необязательный По умолчанию ОписаниеmapPixels YMaps.Point Точка, заданная

пиксельнымикоординатами карты.

unbounded Boolean false Тип возвращаемойточки: false —ограниченная, true —неограниченная.


Тип ОписаниеYMaps.ICoordPoint Точку координатной системы, соответствующую точке в пиксельных

координатах карты.

mapPixelsToLocalPixels{YMaps.Point} mapPixelsToLocalPixels(mapPixels)

Преобразует точку, заданную пиксельными координатами карты, в точку, заданную локальными пик-сельными координатами.

Параметры:

Имя Тип ОписаниеmapPixels YMaps.Point Точка, заданная пиксельными

координатами карты.


24



Тип ОписаниеYMaps.Point Точку, заданную локальными пиксельными координатами.

YMaps.CursorСтатический объект.

Список курсоров, доступных для использования в API Яндекс.Карт.

См.: addCursor

ПоляИмя ОписаниеARROW Курсор-стрелка.

CROSSHAIR Курсор в виде перекрестия.

GRAB Курсор в виде руки.

GRABBING Курсор в виде руки со сжатыми пальцами.

HELP Курсор в виде стрелки с прикрепленным справа знаком вопроса.

INHERIT Унаследованный курсор.

MOVE Курсор в виде четырех стрелок.

POINTER Курсор в виде указательного пальца.

ZOOM Курсор в виде лупы.


ARROWString ARROW

Курсор-стрелка.

CROSSHAIRString CROSSHAIR

Курсор в виде перекрестия.

GRABString GRAB

Курсор в виде руки.

GRABBINGString GRABBING

Курсор в виде руки со сжатыми пальцами.

HELPString HELP

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


25


INHERITString INHERIT

Унаследованный курсор. Означает, что элемент использует тот же курсор, что и его родитель.

MOVEString MOVE

Курсор в виде четырех стрелок.

POINTERString POINTER

Курсор в виде указательного пальца.

ZOOMString ZOOM

Курсор в виде лупы.

YMaps.EventsСтатический объект.

Дает возможность добавлять обработчики событий к объектам JavaScript API.

Класс для работы с событиями карты.

См.: Обработка событий

МетодыИмя Возвращает Описаниеnotify(object, type, eventData) Инициирует событие.

observe(object, type, listener, context,enable)

YMaps.IObserver|YMaps.IObserver[] Создает обработчик события.


notifynotify(object, type, eventData)

Инициирует событие.

Параметры:

Имя Тип Необязательный По умолчанию Описаниеobject Object Объект, на котором

инициируетсясобытие.

type String Тип события.

eventData Object null Данные,передаваемыефункции


26

http://api.yandex.ru/maps/jsapi/doc/dg/concepts/map_events_listeners.xml


Имя Тип Необязательный По умолчанию Описаниеобработчикасобытия.

observe{YMaps.IObserver|YMaps.IObserver[]} observe(object, type, listener, context, enable)

Создает обработчик события.

Параметры:

Имя Тип Необязательный По умолчанию Описаниеobject Object Объект, на котором

возникает событие.

type String|String[] Тип события, котороенеобходимообрабатывать.

listener Function Callback-функциядля обработкисобытия.

context Object object Контекствыполнения сallback-функции listener(по умолчаниюсовпадаетс объектом,на котором возникаетсобытие).

enable Boolean true Начать обрабатыватьсобытие немедленно.


Тип ОписаниеYMaps.IObserver|YMaps.IObserver[] Обработчик события.

YMaps.GeoBoundsРасширяет YMaps.Bounds.

Класс для создания прямоугольной области на карте по географическим координатам двух диагональ-ных вершин.

См.: Географические координаты объектов карты

КонструкторИмя ОписаниеYMaps.GeoBounds(southWest,northEast)

Создает объект, представляющий собой прямоугольную область на карте,заданную в географических координатах.

МетодыИмя Статический Возвращает ОписаниеfromCenterAndSpan(center,span)

YMaps.GeoBounds Создает экземпляр объектаYMaps.GeoBounds по гео-графическим координатам


27

http://api.yandex.ru/maps/jsapi/doc/dg/concepts/coordinates_markers.xml


Имя Статический Возвращает Описаниецентра области и линейнымразмерам области (в граду-сах).

getLeftBottom() YMaps.GeoPoint Возвращает координатыюго-западного углапрямоугольной области.

getLeftTop() YMaps.GeoPoint Возвращает координатысеверо-западного углапрямоугольной области.

getRightBottom() YMaps.GeoPoint Возвращает координатыюго-восточного углапрямоугольной области.

getRightTop() YMaps.GeoPoint Возвращает координатысеверо-восточного углапрямоугольной области.


contains, copy, equals, getBottom, getCenter, getLeft, getMapZoom, getRight, getSpan, getTop

Подробное описание конструктораYMaps.GeoBounds(southWest, northEast)

Создает объект, представляющий собой прямоугольную область на карте, заданную в географическихкоординатах.

См.: Географические координаты объектов карты

Параметры:

Имя Тип ОписаниеsouthWest YMaps.GeoPoint Юго-западный угол области.

northEast YMaps.GeoPoint Северо-восточный угол области.


fromCenterAndSpan{YMaps.GeoBounds} fromCenterAndSpan(center, span)

Создает экземпляр объекта YMaps.GeoBounds по географическим координатам центра области и ли-нейным размерам области (в градусах).

Объект YMaps.GeoBounds описывает границы прямоугольной области на карте.

Примечание:Все геоточки, задающие область, должны быть ограниченными.

Пример:

// Создает квадратную область 1х1 градус с центром в Москве, а затем устанавливает ее в качестве границ карты. var bound = YMaps.GeoBounds.fromCenterAndSpan(new YMaps.GeoPoint(37.63, 55.75), new YMaps.Size(1, 1));map.setBounds(bound);


28

http://api.yandex.ru/maps/jsapi/doc/dg/concepts/coordinates_markers.xml


Параметры:

Имя Тип Описаниеcenter YMaps.GeoPoint Центр прямоугольной области.

span YMaps.Size Ширина и высота области(в градусах).


Тип ОписаниеYMaps.GeoBounds Прямоугольную область, заданную географическими координатами.

getLeftBottom{YMaps.GeoPoint} getLeftBottom()

Возвращает координаты юго-западного угла прямоугольной области.


Тип ОписаниеYMaps.GeoPoint Координаты юго-западного угла.

getLeftTop{YMaps.GeoPoint} getLeftTop()

Возвращает координаты северо-западного угла прямоугольной области.


Тип ОписаниеYMaps.GeoPoint Координаты северо-западного угла.

getRightBottom{YMaps.GeoPoint} getRightBottom()

Возвращает координаты юго-восточного угла прямоугольной области.


Тип ОписаниеYMaps.GeoPoint Координаты юго-восточного угла.

getRightTop{YMaps.GeoPoint} getRightTop()

Возвращает координаты северо-восточного угла прямоугольной области.


Тип ОписаниеYMaps.GeoPoint Координаты северо-восточного угла.

YMaps.GeocoderРасширяет YMaps.GeoObjectCollection.


29


Класс для выполнения запросов на геокодирование. Результаты процесса геокодирования возвращаютсяв виде группы объектов класса YMaps.GeocoderResult.См.: Объект YMaps.Geocoder

КонструкторИмя ОписаниеYMaps.Geocoder(request, options) Производит геокодирование указанного адреса.

ПоляИмя ОписаниеEvents Список событий класса.

found Количество найденных по запросу результатов.

request Текст запроса.

suggest Если адрес был скорректирован сервисом исправления опечаток, то дан-ное поле будет содержать исправленный вариант.

Наследуемые поляИз YMaps.IGeoObject:


СобытияИмя ОписаниеFault При выполнении геокодирования произошла ошибка.

Load Геокодирование закончено.


Add, Remove





getBounds, getComputedStyle, getParentGroup, getStyle, onAddToGroup, onRemoveFromGroup,setBounds, setStyle, update

Подробное описание конструктораYMaps.Geocoder(request, options)

Производит геокодирование указанного адреса.

Геокодирование производится асинхронно, поэтому для получения информации об окончании процессаи о его статусе используйте обработчики событий геокодера YMaps.Geocoder.Events.Loadи YMaps.Geocoder.Events.Fault.

См.: Объект YMaps.Geocoder


30

http://api.yandex.ru/maps/jsapi/doc/dg/concepts/geocoder_obj_overview.xml

http://api.yandex.ru/maps/jsapi/doc/dg/concepts/geocoder_obj_overview.xml


Пример:

// Осуществляет поиск одного объекта с именем "Москва", начиная с видимой области карты.// Полученный результат сразу отображается на карте.map.addOverlay(new YMaps.Geocoder("Москва", {results: 1, boundedBy: map.getBounds()}));

// искать все объекты с именем Москва, но вывести только первый var geocoder = new YMaps.Geocoder("Москва");YMaps.Events.observe(geocoder, geocoder.Events.Load, function () { if (this.length()) { alert("Найдено :" + this.length()); map.addOverlay(this.get(0)); map.panTo(this.get(0).getGeoPoint()) } else { alert("Ничего не найдено") }})YMaps.Events.observe(geocoder, geocoder.Events.Fault, function (geocoder, errorMessage) { alert("Произошла ошибка: " + errorMessage)});

Параметры:

Имя Тип Необязательный По умолчанию Описаниеrequest String Текст запроса,

который нужногеокодировать.

options Object Параметрыгеокодирования.

options.boundedBy

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

options.results Integer Количествовозвращаемыхрезультатов(не более).

options.skip Integer Пропустить первыеn результатов.


EventsObject Events

Список событий класса.

foundInteger found

Количество найденных по запросу результатов.

requestInteger request

Текст запроса.


31


suggestInteger suggest

Если адрес был скорректирован сервисом исправления опечаток, то данное поле будет содержать ис-правленный вариант.

Пример:

// Запрос с опечаткой и полученный от геокодера исправленный вариант.request: Сомакатнаяsuggest: С<fix>а</fix>м<fix>о</fix>катная


FaultFault

При выполнении геокодирования произошла ошибка.

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

• ссылка на себя;

• строка с описанием ошибки.

LoadLoad

Геокодирование закончено.

В callback-функцию передается ссылка на себя.

Пример:

// YMaps.Events.observe(geocoder, geocoder.Events.Load, function (param) { geocoder == param; // true }

YMaps.GeocoderResultРасширяет YMaps.Placemark.

Результат геокодирования (специальная метка с координатами ).

См.: Объект YMaps.GeocoderResult

КонструкторИмя ОписаниеYMaps.GeocoderResult(point, options) Создает результат геокодирования — одну метку с координатами

найденного по запросу топонима и его описания.

ПоляИмя ОписаниеAddressDetails Cтруктурированное представление адреса, согласно стандарту xAL.

kind Вид топонима.


32

http://api.yandex.ru/maps/jsapi/doc/dg/concepts/geocoderresult_obj_overview.xml


Имя Описаниеprecision Предполагаемая точность ответа.

text Адрес одной строкой.

Наследуемые поляИз YMaps.Placemark:



Наследуемые событияИз YMaps.Placemark:

BalloonClose, BalloonOpen, Click, DblClick, Drag, DragEnd, DragStart, MouseEnter, MouseLeave,MouseMove, PositionChange

Наследуемые методыИз YMaps.Placemark:

getCoordPoint, getGeoPoint, getIconContent, getMap, getOptions, getParentContainer, setCoordPoint,setGeoPoint, setIconContent, setOptions

Из YMaps.IOverlay:onAddToMap, onMapUpdate, onRemoveFromMap

Из YMaps.IInteractiveGeoObject:closeBalloon, getBalloon, getBalloonContent, getBalloonOptions, getHintContent, getHintOptions,openBalloon, setBalloonContent, setBalloonOptions, setHintContent, setHintOptions, update

Из YMaps.IGeoObject:getBounds, getComputedStyle, getParentGroup, getStyle, onAddToGroup, onRemoveFromGroup,setBounds, setStyle

Подробное описание конструктораYMaps.GeocoderResult(point, options)

Создает результат геокодирования — одну метку с координатами найденного по запросу топонима и егоописания. Класс построен на основе класса метки YMaps.Placemark и отличается только наличием до-полнительных полей. Можно сразу добавлять на карту.

См.: Объект YMaps.GeocoderResult

Параметры:

Имя Тип Необязательный По умолчанию Описаниеpoint YMaps.GeoPoint Геоточка,

определяющаяположение меткина карте.

options Object Опции метки.Подробнеесм. описаниеконструктораYMaps.Placemark.


AddressDetailsObject AddressDetails

Cтруктурированное представление адреса, согласно стандарту xAL.


33

http://api.yandex.ru/maps/jsapi/doc/dg/concepts/geocoderresult_obj_overview.xml


См.: Спецификация xAL

Пример:

// Структура, представляющая адрес Москва, Вавилова 40.AddressDetails = { Country: { CountryName: "Россия", Locality: LocalityName: "Москва", Thoroughfare: ThoroughfareName: "улица Вавилова", Premise: { PremiseNumber: "40: } } } }}

kindString kind

Вид топонима.

Список возможных значений:

• house — дом;

• street — улица;

• metro — метро;

• district — район;

• locality — населённый пункт;

• province — область;

• country — страна;

• hydro — река, озеро, ручей, водохранилище...;

• railway — ж.д. станция;

• route — линия метро / шоссе / ж.д. линия;

• vegetation — лес, парк...;

• cemetery — кладбище;

• bridge — мост;

• km — километр шоссе;

• other — разное.

precisionString precision

Предполагаемая точность ответа.


34

http://www.oasis-open.org/committees/ciq/ciq.html#6


Список возможных значений:

• exact — найден дом с точным совпадением номера (включая литеру, № корпуса, строения и т. д.);

• number — найден дом с тем же номером (например: 12A по 12K1);

• near — найден дом (на расстоянии не далее 10 номеров от запрошенного);

• street — найдена улица;

• other — найден некий топоним;

• suggestion — слабая уверенность, уровень предположений "Быть может, вы искали".

textString text

Адрес одной строкой.

YMaps.GeoCollectionBoundsРасширяет YMaps.GeoBounds.

Класс для расчета прямоугольной области, заданной набором геоточек.

КонструкторИмя ОписаниеYMaps.GeoCollectionBounds(geoPoint) Создает объект YMaps.GeoCollectionBounds.

МетодыИмя Описаниеadd(geoPoint) Добавляет точки в коллекцию

YMaps.GeoCollectionBounds.

clear() Сбрасывает установленные параметры прямоугольнойобласти.

Наследуемые методыИз YMaps.GeoBounds:

getLeftBottom, getLeftTop, getRightBottom, getRightTopИз YMaps.ICoordBounds:

contains, copy, equals, getBottom, getCenter, getLeft, getMapZoom, getRight, getSpan, getTop

Подробное описание конструктораYMaps.GeoCollectionBounds(geoPoint)

Создает объект YMaps.GeoCollectionBounds. Принимает множество геоточек и рассчитывает их областьвидимости. Считается, что все переданные геоточки ограниченные.

Параметры:

Имя Тип Необязательный По умолчанию ОписаниеgeoPoint YMaps.GeoPoint|

YMaps.GeoPoint[]Геоточка или массивгеоточек.


35



addadd(geoPoint)

Добавляет точки в коллекцию YMaps.GeoCollectionBounds. Если точка находится за границами текущейпрямоугольной области, то область увеличивается так, чтобы включить в себя новую точку.

Параметры:

Имя Тип ОписаниеgeoPoint YMaps.GeoPoint|YMaps.GeoPoint[] Геоточка или массив геоточек.

clearclear()

Сбрасывает установленные параметры прямоугольной области. Координаты границ области обнуляют-ся.

YMaps.GeoCoordSystemРасширяет YMaps.ICoordSystem.

Класс "географическая система координат".

КонструкторИмя ОписаниеYMaps.GeoCoordSystem(radius,maxZoom)

Создает объект, реализующий географическую систему координат.

МетодыИмя Возвращает Описаниеdistance(point1, point2) Number Возвращает расстояние между двумя

заданными точками (в метрах).

getCoordBounds(bottomLeft,topRight)

YMaps.GeoBounds Создает экземпляр объектаYMaps.GeoBounds по координатамдвух диагональных вершинпрямоугольной области.

getCoordPoint(x, y, unbounded) YMaps.GeoPoint Возвращает геоточку указанноготипа (ограниченная/неограниченная)с требуемыми координатами.

restrict(geoPoint) YMaps.GeoPoint Применяет к геоточке ограниченияпо широте.

rulerDistance(point1, point2) Number Возвращает расстояние между двумязаданными точками (в метрах), еслидвигаться вдоль прямойсоединяющей точки на карте.Используется для расчетарасстояний в элементе управления"Линейка".

toCoordPoint(pixelPoint, unbounded) YMaps.GeoPoint Преобразует координаты точки,заданные в пикселах,в географические координаты.


36


Наследуемые методыИз YMaps.ICoordSystem:

fromCoordPoint, getMaxZoom, getWorldSize

Подробное описание конструктораYMaps.GeoCoordSystem(radius, maxZoom)

Создает объект, реализующий географическую систему координат.

Параметры:

Имя Тип Необязательный По умолчанию Описаниеradius Number 6378137 Радиус сферы.

maxZoom Integer 23 Максимальныйкоэффициентмасштабированиякарты.


distance{Number} distance(point1, point2)

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

Параметры:

Имя Тип Описаниеpoint1 YMaps.GeoPoint Первая точка.

point2 YMaps.GeoPoint Вторая точка.


Тип ОписаниеNumber Pасстояние по геодезической прямой между двумя заданными точками.

getCoordBounds{YMaps.GeoBounds} getCoordBounds(bottomLeft, topRight)

Создает экземпляр объекта YMaps.GeoBounds по координатам двух диагональных вершин прямоуголь-ной области. Объект YMaps.GeoBounds описывает границы прямоугольной области на карте.

Параметры:

Имя Тип ОписаниеbottomLeft YMaps.GeoPoint Координаты левого нижнего угла

области.

topRight YMaps.GeoPoint Координаты правого верхнего углаобласти.


Тип ОписаниеYMaps.GeoBounds Объект YMaps.GeoBounds.


37


getCoordPoint{YMaps.GeoPoint} getCoordPoint(x, y, unbounded)

Возвращает геоточку указанного типа (ограниченная/неограниченная) с требуемыми координатами.

Параметры:

Имя Тип Необязательный По умолчанию Описаниеx Number Долгота точки.

y Number Широта точки.

unbounded Boolean false Тип возвращаемойточки: true —неограниченная,false —ограниченная.


Тип ОписаниеYMaps.GeoPoint Геоточку.

restrict{YMaps.GeoPoint} restrict(geoPoint)

Применяет к геоточке ограничения по широте. Предельная широта объектов, отображаемых в геогра-фической системе координат YMaps.GeoCoordSystem, составляет 89.3 градусов. Метод принудительноограничивает широту геоточки этим значением.

Параметры:

Имя Тип ОписаниеgeoPoint YMaps.GeoPoint Точка в координатной системе.


Тип ОписаниеYMaps.GeoPoint Точку в координатной системе с примененными ограничениями.

rulerDistance{Number} rulerDistance(point1, point2)

Возвращает расстояние между двумя заданными точками (в метрах), если двигаться вдоль прямой сое-диняющей точки на карте. Используется для расчета расстояний в элементе управления "Линейка".

Параметры:

Имя Тип Описаниеpoint1 YMaps.GeoPoint Первая точка.

point2 YMaps.GeoPoint Вторая точка.


Тип ОписаниеNumber Pасстояние "по линейке" между двумя заданными точками.


38


toCoordPoint{YMaps.GeoPoint} toCoordPoint(pixelPoint, unbounded)

Преобразует координаты точки, заданные в пикселах, в географические координаты. Пиксельные коор-динаты должны быть рассчитаны при максимальном масштабе карты.

Параметры:

Имя Тип Необязательный По умолчанию ОписаниеpixelPoint YMaps.Point Пиксельные

координаты точкипри максимальноммасштабе карты.

unbounded Boolean false Флаг, указывающийтип возвращаемойточки: false —ограниченная, true —неограниченная.



YMaps.GeoObjectCollectionРасширяет YMaps.IGeoObject, YMaps.OverlayGroup.

Класс для объединения объектов YMaps.IGeoObject в группы.

См.: Группировка оверлеев

КонструкторИмя ОписаниеYMaps.GeoObjectCollection(style) Объект для хранения групп меток карты или других объектов

GeoObjectCollection.





Add, Remove


39

http://api.yandex.ru/maps/jsapi/doc/dg/concepts/overlay_group.xml







Подробное описание конструктораYMaps.GeoObjectCollection(style)

Объект для хранения групп меток карты или других объектов GeoObjectCollection.

См.: Группировка оверлеев

Параметры:

Имя Тип Необязательный По умолчанию Описаниеstyle YMaps.Style|String Указатель или ключ

стиля группыобъектов.

YMaps.GeoPointРасширяет YMaps.ICoordPoint.

Класс для создания геоточки.

См.: Географические координаты (geo coordinates)

КонструкторИмя ОписаниеYMaps.GeoPoint(lng, lat, unbounded) Создает точку, заданную географическими координатами (геоточку).

МетодыИмя Статический Возвращает Описаниеdistance(point) Number Возвращает кратчайшее

расстояние между двумяточками земнойповерхности (в метрах).

equals(point) Boolean Сравнивает две точки:точку, переданнуюпараметром point и точку,для которой вызываетсяметод. Точки совпадают,если у них одинаковыезначения координатпо обеим осям с точностьюдо 8 знака после запятойи одинаковое значениефлага ограниченности.


40

http://api.yandex.ru/maps/jsapi/doc/dg/concepts/overlay_group.xml

http://api.yandex.ru/maps/jsapi/doc/dg/concepts/coordinates_conversion.xml#coordinates_conversion/geo_coordinates


Имя Статический Возвращает ОписаниеfromString(string) YMaps.GeoPoint Создает геоточку по ее

строковомупредставлению.

getLat() Number Широта геоточки.

getLng() Number Долгота геоточки.

isUnbounded() Boolean Возвращает true, еслигеоточка неограниченная,иначе — false.

setLat(lat) YMaps.GeoPoint Устанавливает широту.

setLng(lng) YMaps.GeoPoint Устанавливает долготу.

toString(precision) String Возвращает строковоепредставление геоточкив виде "долгота,широта".

Наследуемые методыИз YMaps.ICoordPoint:

copy, diff, getX, getY, moveBy, moveTo, setX, setY

Подробное описание конструктораYMaps.GeoPoint(lng, lat, unbounded)

Создает точку, заданную географическими координатами (геоточку). Позволяет создать как обычную(ограниченную) геоточку (с долготой в пределах от -180 до 180 градусов и широтой в пределах от -90до 90 градусов), так и неограниченную (с произвольными долготой и широтой).


Параметры:

Имя Тип Необязательный По умолчанию Описаниеlng Number 0 Долгота в градусах.

lat Number 0 Широта в градусах.

unbounded Boolean false Флаг, определяющийтип геоточки: true —неограниченная,false —ограниченная.


distance{Number} distance(point)

Возвращает кратчайшее расстояние между двумя точками земной поверхности (в метрах).

Параметры:

Имя Тип Описаниеpoint YMaps.GeoPoint Точка, расстояние до которой

требуется измерить


Тип ОписаниеNumber Расстояние в метрах


41



equals{Boolean} equals(point)

Сравнивает две точки: точку, переданную параметром point и точку, для которой вызывается метод.Точки совпадают, если у них одинаковые значения координат по обеим осям с точностью до 8 знакапосле запятой и одинаковое значение флага ограниченности.

Параметры:

Имя Тип Описаниеpoint YMaps.GeoPoint Точка.


Тип ОписаниеBoolean true — точки совпадают, false — не совпадают.

fromString{YMaps.GeoPoint} fromString(string)

Создает геоточку по ее строковому представлению. Формат строкового представления: "долгота,широ-та".

Параметры:

Имя Тип Описаниеstring String Строковое представление геоточки.



getLat{Number} getLat()

Широта геоточки.


Тип ОписаниеNumber Широту.

getLng{Number} getLng()

Долгота геоточки.


Тип ОписаниеNumber Долготу геоточки.

isUnbounded{Boolean} isUnbounded()


42


Возвращает true, если геоточка неограниченная, иначе — false.


Тип ОписаниеBoolean true — точка неограниченная; false — ограниченная.

setLat{YMaps.GeoPoint} setLat(lat)

Устанавливает широту.

Параметры:

Имя Тип Описаниеlat Number Широта.


Тип ОписаниеYMaps.GeoPoint Ссылку на себя.

setLng{YMaps.GeoPoint} setLng(lng)

Устанавливает долготу.

Параметры:

Имя Тип Описаниеlng Number Долгота.


Тип ОписаниеYMaps.GeoPoint Ссылку на себя.

toString{String} toString(precision)

Возвращает строковое представление геоточки в виде "долгота,широта".

Параметры:

Имя Тип Необязательный По умолчанию Описаниеprecision Integer 6 Точность, с которой

округляютсязначения долготыи широты.


Тип ОписаниеString Строковое представление геоточки.


43


YMaps.GraphicsEditingMenuIDsСтатический объект.

Список идентификаторов пунктов контекстного меню, которое открывается по щелчку мыши по вер-шине графической фигуры (в режиме редактирования).

ПоляИмя ОписаниеDelete Идентификатор пункта контекстного меню для удаления вершины

графической фигуры.

StartDrawing Идентификатор пункта контекстного меню для включения режимадобавления новых вершин в графическую фигуру.

StopDrawing Идентификатор пункта контекстного меню для выключения режимадобавления новых вершин в графическую фигуру.


DeleteString Delete

Идентификатор пункта контекстного меню для удаления вершины графической фигуры.

StartDrawingString StartDrawing

Идентификатор пункта контекстного меню для включения режима добавления новых вершин в графи-ческую фигуру.

StopDrawingString StopDrawing

Идентификатор пункта контекстного меню для выключения режима добавления новых вершин в гра-фическую фигуру.

YMaps.GraphicsEditingOptionsОпции режима редактирования графических объектов.


Пример:

// var options = { maxPoints: Infinity, menuManager: function (index, menuItems) { for (var i = 0; i < menuItems.length; i++) { if (menuItems[i].id == YMaps.GraphicsEditingMenuIDs.Delete) { menuItems.splice(i, 1); } } return menuItems; }, onDblClick: function (index) { // ... },


44


stopDrawingByDblClick: false, drawing: true};

ПоляИмя Описаниеdrawing Включает режим добавления новых вершин в графическую фигуру.

drawOver Разрешает ставить точки поверх объектов карты в режиме добавлениявершин геометрической фигуры.

maxPoints Максимально допустимое число вершин в многоугольнике.

menuManager Диспетчер контекстного меню, открывающегося при щелчке мышьюпо вершине графической фигуры (ломаной, многоугольника, и т.п.).

Принимает два аргумента: индекс вершины графической фигуры и массивобъектов, описывающих пункты контекстного меню для этой вершины.Диспетчер может изменять данные в переданном массиве.

Возвращает массив объектов, описывающих пункты контекстного меню.

onDblClick Обработчик двойного щелчка мышью по вершине графической фигуры(ломаной, многоугольника, и т.п.)

stopDrawingByDblClick Включает возможность выхода из режима добавления вершин по двой-ному щелчку мыши.


drawingBoolean drawing

Включает режим добавления новых вершин в графическую фигуру.

В этом режиме новые вершины добавляются по щелчку мышью по карте. Выход из режима осуществл-яется по двойному щелчку, см. YMaps.GraphicsEditingOptions.stopDrawingByDblClick.

По умолчанию режим отключен.

drawOverBoolean drawOver

Разрешает ставить точки поверх объектов карты в режиме добавления вершин геометрической фигуры.

По умолчанию опция отключена.

maxPointsInteger maxPoints

Максимально допустимое число вершин в многоугольнике.

Значение по умолчанию: Infinity.

menuManagerFunction menuManager

Диспетчер контекстного меню, открывающегося при щелчке мышью по вершине графической фигуры(ломаной, многоугольника, и т.п.).


45


Принимает два аргумента: индекс вершины графической фигуры и массив объектов, описывающихпункты контекстного меню для этой вершины. Диспетчер может изменять данные в переданном массиве.

Возвращает массив объектов, описывающих пункты контекстного меню.

Примечание:По умолчанию диспетчер контекстного меню не задан.

Примеры:

1.

// Объект, описывающий отдельный пункт контекстного меню.{ id: 'Идентификатор пункта меню', title: 'Отображаемое название пункта меню', // Обработчик щелчка мышью по пункту меню. // Метод принимает два аргумента: // ссылку на объект, представляющий графическую фигуру и индекс выбранной вершины. onClick: function (graphicsObject, pointIndex) { // Действия, выполняемые при щелчке мышью по пункту меню. }}

2.

// Диспетчер контекстного меню.this.polygonBlue.setEditingOptions({ menuManager: function (index, menuItems) { for (var i = 0; i < menuItems.length; i++) { if (menuItems[i].id == YMaps.GraphicsEditingMenuIDs.StartDrawing) { menuItems[i].title = '<span style="white-space:nowrap;">Добавить точки</span>'; } } menuItems.push({ id: "ShowIndex", title: '<span style="white-space:nowrap;">Показать индекс</span>', onClick: function (polygon, pointIndex) { alert(pointIndex); } }); return menuItems; }});

onDblClickFunction onDblClick

Обработчик двойного щелчка мышью по вершине графической фигуры (ломаной, многоугольника,и т.п.)

Принимает два аргумента: ссылку на графическую фигуру и индекс вершины.

По умолчанию, обработчик определен функцией, удаляющей соответствующую вершину.

stopDrawingByDblClickBoolean stopDrawingByDblClick

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


46


По умолчанию возможность включена.

YMaps.GroupКласс для создания набора объектов.

Позволяет объединять в группы объекты любого типа. Если требуется создать группу из объектов по-льзовательского класса, то класс YMaps.Group может быть расширен по примеру классаYMaps.OverlayGroup.

КонструкторИмя ОписаниеYMaps.Group() Создает набор объектов.

ПоляИмя ОписаниеEvents Список событий группы объектов.

СобытияИмя ОписаниеAdd Добавление объекта в группу.

Remove Удаление объекта из группы.

МетодыИмя Возвращает Описаниеadd(object, index) Добавляет объект в группу.

Генерирует событиеYMaps.Group.Add.

filter(callback, context, noRecursion) Object[] Отбирает объекты группы, удовле-творяющие условиям, заданнымв функции проверки. Возвращаетмассив отобранных объектов.

forEach(callback, context) Выполняет callback-функцию для ка-ждого объекта группы.

В функцию передаются следующиепараметры:

• указатель на объект;

• индекс объекта в группе;

• указатель на саму группу.

get(index) Object Возвращает объект по его индексув группе.

indexOf(object) Integer Ищет объект в группе и возвращаетего индекс.

length() Integer Возвращает количество объектовв группе.

remove(object) Удаляет объект или массив объектовиз группы. Генерирует событиеYMaps.Group.Remove.


47


Имя Возвращает ОписаниеremoveAll() Удаляет все объекты из группы.

splice(index, number) Object[] Удаляет объекты из группы. Еслинеобходимо, вставляет на их местодругие объекты.

Подробное описание конструктораYMaps.Group()

Создает набор объектов.


EventsObject Events

Список событий группы объектов.


AddAdd

Добавление объекта в группу.В callback-функцию передаются три аргумента:

• указатель на группу;

• указатель на добавленный объект;

• индекс добавленного объекта.

RemoveRemove

Удаление объекта из группы.В callback-функцию передаются три аргумента:

• указатель на группу;

• указатель на удаленный объект;

• индекс удаляемого объекта.


addadd(object, index)

Добавляет объект в группу. Генерирует событие YMaps.Group.Add.


48


Параметры:

Имя Тип Необязательный По умолчанию Описаниеobject Object|Object[] Добавляемый объект

или массив объектов.

index Integer Позиция, в которуюнужно добавитьobject.

filter{Object[]} filter(callback, context, noRecursion)

Отбирает объекты группы, удовлетворяющие условиям, заданным в функции проверки. Возвращаетмассив отобранных объектов.

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

Пример:

// Осуществляет рекурсивный отбор объектов с заданным значением свойстваvar filteredObj = group.filter(function (obj) { return obj.property == "filter";});

Параметры:

Имя Тип Необязательный По умолчанию Описаниеcallback Function Функция проверки.

context Object null Контекствыполненияфункции.

noRecursion Object false true — запретитьрекурсивный отборобъектов внутригруппы, false —разрешить.


Тип ОписаниеObject[] Массив отобранных, с помощью функции, объектов.

forEachforEach(callback, context)

Выполняет callback-функцию для каждого объекта группы.

В функцию передаются следующие параметры:

• указатель на объект;

• индекс объекта в группе;

• указатель на саму группу.


49


Параметры:

Имя Тип Необязательный По умолчанию Описаниеcallback Function Функция,

выполняемаядля каждого объекта.

context Object Контекствыполненияфункции.

get{Object} get(index)

Возвращает объект по его индексу в группе. Индекс может принимать отрицательные значения.

Пример:

group.get(0) // Берет первый объект в группе.group.get(5) // Берет пятый объект в группе.group.get(-1) // Берет последний объект в группе.group.get(-3) // Берет третий объект с конца.

Параметры:

Имя Тип Описаниеindex Integer Индекс.


Тип ОписаниеObject Требуемый объект.

indexOf{Integer} indexOf(object)

Ищет объект в группе и возвращает его индекс.

Параметры:

Имя Тип Описаниеobject Integer Объект.


Тип ОписаниеInteger Индекс объекта.

length{Integer} length()

Возвращает количество объектов в группе.


Тип ОписаниеInteger Количество объектов.


50


removeremove(object)

Удаляет объект или массив объектов из группы. Генерирует событие YMaps.Group.Remove.

Параметры:

Имя Тип Описаниеobject Object|Object[] Удаляемый объект или массив

объектов.

removeAllremoveAll()

Удаляет все объекты из группы.

splice{Object[]} splice(index, number)

Удаляет объекты из группы. Если необходимо, вставляет на их место другие объекты. Объекты, которыебудут вставлены вместо удаляемых, передаются как дополнительные параметры (после параметраnumber).

Пример:

// Удаляет второй объект.group.splice(1, 1);// Вставляет новый объект obj во вторую позицию.group.splice(1, 0, obj);// Заменяет второй объект на новый объект obj.group.splice(1, 1, obj);

Параметры:

Имя Тип Описаниеindex Integer Индекс объекта, с которого

начинается удаление.

number Integer Количество удаляемых объектов.


Тип ОписаниеObject[] Удаленные объекты.

YMaps.HintВсплывающая подсказка.

Данный класс не имеет конструктора.

Объект класса YMaps.Hint существует для каждой карты в единственном экземпляре и доступен в объ-екте карты как YMaps.Map.hint.

Параметры:



51


МетодыИмя Возвращает Описаниеhide(hideTimeout) Скрывает всплывающую подсказку.

isShown() Boolean Возвращает текущее состояниевсплывающей подсказки: true —подсказка показана на карте, false —подсказка скрыта.

moveTo(position) Перемещает всплывающуюподсказку в заданную позицию.

setContent(content) Устанавливает содержимоевсплывающей подсказки.

setOptions(options) Устанавливает опции всплывающейподсказки.

show(position, content, options) Показывает всплывающуюподсказку с заданными параметрами.


hidehide(hideTimeout)

Скрывает всплывающую подсказку.

Подсказка может быть скрыта либо немедленно, либо через заданный интервал времени (если указанпараметр hideTimeout).

Примечание:Всплывающая подсказка не будет скрыта, если курсор мыши находится над подсказкой и опцияholdOnMouseOver установлена в true.

Параметры:

Имя Тип Необязательный По умолчанию ОписаниеhideTimeout Number Интервал времени

(в милисекундах),через которыйвсплывающаяподсказка должнабыть скрыта.

isShown{Boolean} isShown()

Возвращает текущее состояние всплывающей подсказки: true — подсказка показана на карте, false —подсказка скрыта.


Тип ОписаниеBoolean true — всплывающая подсказка показана на карте; false — скрыта.


52


moveTomoveTo(position)

Перемещает всплывающую подсказку в заданную позицию.

Параметры:

Имя Тип Описаниеposition YMaps.Point Позиция, в которую требуется

переместить всплывающуюподсказку. Задается локальнымипиксельными координатами,см. Типы координат и ихпреобразование .


Устанавливает содержимое всплывающей подсказки. Если в параметре content передана строка, то кон-тейнером для содержимого подсказки станет элемент div. Переданная строка станет значением свой-ства innerHTML элемента div.

Параметры:

Имя Тип Описаниеcontent String|HTMLElement|YMaps.ILayout Содержимое всплывающей

подсказки (строка, DOM-элементили макет).

setOptionssetOptions(options)

Устанавливает опции всплывающей подсказки.

Параметры:

Имя Тип Описаниеoptions YMaps.MapHintOptions Опции всплывающей подсказки.

showshow(position, content, options)

Показывает всплывающую подсказку с заданными параметрами.

Пример:

// Показывает подсказку в центре карты.map.hint.show(map.converter.coordinatesToLocalPixels(map.getCenter()), 'Центр карты', {showTimeout: 500});

Параметры:

Имя Тип Описаниеposition YMaps.Point Позиция, в которой надо показать

всплывающую подсказку. Задаетсялокальными пиксельными


53




Имя Тип Описаниекоординатами, см. Типы координати их преобразование .

content String|HTMLElement|YMaps.ILayout Содержимое всплывающейподсказки.

options YMaps.MapHintOptions Опции всплывающей подсказки.

YMaps.HintContentStyleСтиль содержимого всплывающей подсказки.

КонструкторИмя ОписаниеYMaps.HintContentStyle(template) Создает объект стиля содержимого всплывающей подсказки.


Подробное описание конструктораYMaps.HintContentStyle(template)

Создает объект стиля содержимого всплывающей подсказки.

Параметры:


String"default#hintContent" Шаблон или ключ

шаблона.


templatetemplate


YMaps.HintOptionsОпции всплывающей подсказки.


Пример:

// Задает максимальную ширину подсказки в 100 пикселов, отступы подсказки относительно курсора - 5 пикселов.var hintOptions = { maxWidth: 100, offset: new YMaps.Point(5, 5)};


54




ПоляИмя ОписаниеholdOnMouseOver Флаг, указывающий, должна ли всплывающая подсказка оставаться

видимой, когда курсор мыши находится над ней.

maxHeight Максимально допустимая высота всплывающей подсказки (в пикселах).

maxWidth Максимально допустимая ширина всплывающей подсказки (в пикселах).

offset Сдвиг всплывающей подсказки относительно активной точки курсора(в пикселах).


holdOnMouseOverBoolean holdOnMouseOver

Флаг, указывающий, должна ли всплывающая подсказка оставаться видимой, когда курсор мыши на-ходится над ней. По умолчанию true.

maxHeightNumber maxHeight

Максимально допустимая высота всплывающей подсказки (в пикселах). Задается значением, большимнуля. Если значение равно нулю или null, то высота ограничивается высотой родительского элемента.По умолчанию 0.

maxWidthNumber maxWidth

Максимально допустимая ширина всплывающей подсказки (в пикселах). Задается значением, большимнуля. Если значение равно нулю или null, то ширина ограничивается шириной родительского элемента.По умолчанию 0.

offsetYMaps.Point offset

Сдвиг всплывающей подсказки относительно активной точки курсора (в пикселах). По умолчанию15 пикселов по обоим направлениям (вправо и вниз).

YMaps.HintStyleСтиль всплывающей подсказки.

КонструкторИмя ОписаниеYMaps.HintStyle(template) Создает объект стиля всплывающей подсказки.

ПоляИмя Описаниеtemplate Шаблон или ключ шаблона. Шаблон должен генерировать макет,

реализующий YMaps.IHintLayout.


55


Подробное описание конструктораYMaps.HintStyle(template)

Создает объект стиля всплывающей подсказки.

Параметры:


String"default#hint" Шаблон или ключ

шаблона.


templatetemplate

Шаблон или ключ шаблона. Шаблон должен генерировать макет, реализующий YMaps.IHintLayout.

YMaps.IBalloonLayoutРасширяет YMaps.IContentableLayout.

Интерфейс макета балуна.

КонструкторИмя ОписаниеYMaps.IBalloonLayout(context, map) Интерфейс макета балуна.

МетодыИмя Возвращает ОписаниеdisableClose() Выключает кнопку закрытия балуна.

enableClose(callback) Включает кнопку закрытия балуна.

getOffset() YMaps.Point Возвращает сдвиг макета балунаотносительно его точкипозиционирования (в пикселах).

getSize() YMaps.Size Возвращает фактический размербалуна (в пикселах).

moveTo(point) Позиционирует макет балуна.

setMaxSize(maxWidth, maxHeight) Устанавливает максимальнодопустимый размеры содержимогобалуна.

Наследуемые методыИз YMaps.IContentableLayout:

setContentИз YMaps.ILayout:

onAddToParent, onRemoveFromParent, update

Подробное описание конструктораYMaps.IBalloonLayout(context, map)


56


Интерфейс макета балуна. Должен реализовываться всеми макетами балуна. Шаблон, заданныйв YMaps.BalloonStyle, должен генерировать макет, реализующий данный интерфейс.

Параметры:

Имя Тип Описаниеcontext Object Контекст.

map YMaps.Map Карта.


disableClosedisableClose()

Выключает кнопку закрытия балуна.

enableCloseenableClose(callback)

Включает кнопку закрытия балуна.

Параметры:

Имя Тип Описаниеcallback Function Функция, вызываемая при щелчке

мышью по кнопке закрытия балуна.

getOffset{YMaps.Point} getOffset()

Возвращает сдвиг макета балуна относительно его точки позиционирования (в пикселах). Используетсядля визуального выравнивания.


Тип ОписаниеYMaps.Point Сдвиг макета балуна относительно его точки позиционирования

(в пикселах).

getSize{YMaps.Size} getSize()

Возвращает фактический размер балуна (в пикселах).


Тип ОписаниеYMaps.Size Фактический размер балуна (в пикселах).

moveTomoveTo(point)

Позиционирует макет балуна. Позиция задается в пиксельных координатах.


57


Параметры:

Имя Тип Описаниеpoint YMaps.Point Пиксельные координаты точки

позиционирования балуна.

setMaxSizesetMaxSize(maxWidth, maxHeight)

Устанавливает максимально допустимый размеры содержимого балуна. Если значение одного из пара-метров 0 или null, то максимальный размер определяет макет.

Параметры:

Имя Тип ОписаниеmaxWidth Number Максимальная ширина.

maxHeight Number Максимальная высота.

YMaps.IconContentStyleСтиль содержимого значка (пиктограммы).

КонструкторИмя ОписаниеYMaps.IconContentStyle(template) Создает объект стиля содержимого значка.


Подробное описание конструктораYMaps.IconContentStyle(template)

Создает объект стиля содержимого значка.

Параметры:


String"default#iconContent" Шаблон или ключ

шаблона.


templatetemplate


YMaps.IconShadowStyleСтиль тени значка.


58


КонструкторИмя ОписаниеYMaps.IconShadowStyle(template) Создает объект стиля тени значка.

ПоляИмя Описаниеhref URL графического файла значка тени.

offset Сдвиг значка тени в пикселах относительно точки его позиционирования.

size Размеры значка тени (в пикселах).

template Шаблон или ключ шаблона. Шаблон должен генерировать макет,реализующий YMaps.IPlacemarkLayout.

Подробное описание конструктораYMaps.IconShadowStyle(template)

Создает объект стиля тени значка.

Параметры:


String"default#iconShadow" Шаблон или ключ

шаблона.


hrefString href

URL графического файла значка тени.


Сдвиг значка тени в пикселах относительно точки его позиционирования. Используется для визуальноговыравнивания.

sizeYMaps.Size size

Размеры значка тени (в пикселах).

templatetemplate

Шаблон или ключ шаблона. Шаблон должен генерировать макет, реализующийYMaps.IPlacemarkLayout.

YMaps.IconStyleСтиль значка с тенью или без.


59


КонструкторИмя ОписаниеYMaps.IconStyle(template) Создает объект стиля значка с тенью или без.

ПоляИмя Описаниеhref URL графического файла значка.

offset Сдвиг значка в пикселах относительно точки его позиционирования.

shadow Стиль тени значка.

size Размеры значка (в пикселах).

template Шаблон или ключ шаблона. Шаблон должен генерировать макет,реализующий YMaps.IPlacemarkLayout.

Подробное описание конструктораYMaps.IconStyle(template)

Создает объект стиля значка с тенью или без.

Параметры:


String"default#icon" Шаблон или ключ

шаблона.


hrefString href

URL графического файла значка.


Сдвиг значка в пикселах относительно точки его позиционирования. Используется для визуального вы-равнивания.

shadowYMaps.IconShadowStyle shadow

Стиль тени значка. По умолчанию не определен.

sizeYMaps.Size size

Размеры значка (в пикселах).

templatetemplate


60


Шаблон или ключ шаблона. Шаблон должен генерировать макет, реализующийYMaps.IPlacemarkLayout.

YMaps.IContentableLayoutРасширяет YMaps.ILayout.

Интерфейс макета с содержимым.

КонструкторИмя ОписаниеYMaps.IContentableLayout(context,map)


МетодыИмя ОписаниеsetContent(content) Устанавливает содержимое макета.

Наследуемые методыИз YMaps.ILayout:


Подробное описание конструктораYMaps.IContentableLayout(context, map)


Параметры:





Устанавливает содержимое макета.

Параметры:

Имя Тип Описаниеcontent YMaps.ILayout Содержимое макета.

YMaps.IControlИнтерфейс элемента управления карты.

См.: Создание пользовательских элементов управления


61

http://api.yandex.ru/maps/jsapi/doc/dg/concepts/map_controls_custom.xml


КонструкторИмя ОписаниеYMaps.IControl() Интерфейс элемента управления карты.

МетодыИмя ОписаниеonAddToMap(map, controlPosition) Вызывается при добавлении элемента управления

на карту.

onRemoveFromMap() Вызывается при удалении элемента управления с карты.

Подробное описание конструктораYMaps.IControl()

Интерфейс элемента управления карты.

См.: Создание пользовательских элементов управления


onAddToMaponAddToMap(map, controlPosition)

Вызывается при добавлении элемента управления на карту.

Параметры:

Имя Тип Необязательный По умолчанию Описаниеmap YMaps.Map Указатель на карту.

controlPosition YMaps.ControlPosition

Определяетсясоздателем элементауправления

Положение элементауправления.

onRemoveFromMaponRemoveFromMap()

Вызывается при удалении элемента управления с карты.

YMaps.ICoordBoundsИнтерфейс объекта, представляющего собой прямоугольную область на карте. Этот интерфейс тре-буется реализовывать при создании пользовательской координатной системы. Примером такой реали-зации является YMaps.GeoBounds.

КонструкторИмя ОписаниеYMaps.ICoordBounds(leftBottom,rightTop)

Интерфейс объекта, представляющего собой прямоугольную областьна карте.


62

http://api.yandex.ru/maps/jsapi/doc/dg/concepts/map_controls_custom.xml


МетодыИмя Возвращает Описаниеcontains(coordPoint) Boolean Возвращает true, если переданная

точка попадает в область, false —если не попадает.

copy() YMaps.ICoordBounds Возвращает копию объекта.

equals(coordBounds) Boolean Сравнивает два объекта,представляющих области на карте.

getBottom() Number Возвращает нижнюю границуобласти.

getCenter() YMaps.ICoordPoint Возвращает центр области в видеточки координатной системы.

getLeft() Number Возвращает левую границу области.

getLeftBottom() YMaps.ICoordPoint Возвращает левый нижний уголобласти в виде точки координатнойсистемы.

getLeftTop() YMaps.ICoordPoint Возвращает левый верхний уголобласти в виде точки координатнойсистемы.

getMapZoom(map) Number Возвращает коэффициентмасштабирования, при которомданная прямоугольная область будетвидна на карте целиком.

getRight() Number Возвращает правую границуобласти.

getRightBottom() YMaps.ICoordPoint Возвращает правый нижний уголобласти в виде точки координатнойсистемы.

getRightTop() YMaps.ICoordPoint Возвращает правый верхний уголобласти в виде точки координатнойсистемы.

getSpan() YMaps.Size Возвращает линейные размерыобласти в виде объекта YMaps.Size.

getTop() Number Возвращает верхнюю границуобласти.

Подробное описание конструктораYMaps.ICoordBounds(leftBottom, rightTop)

Интерфейс объекта, представляющего собой прямоугольную область на карте.

Параметры:

Имя Тип ОписаниеleftBottom YMaps.ICoordPoint Левый нижний угол области в виде

точки координатной системы.

rightTop YMaps.ICoordPoint Правый верхний угол области в видеточки координатной системы.


contains{Boolean} contains(coordPoint)

Возвращает true, если переданная точка попадает в область, false — если не попадает.


63


Параметры:

Имя Тип ОписаниеcoordPoint YMaps.ICoordPoint Точка в координатной системе.


Тип ОписаниеBoolean true — попадает в область, false — не попадает.

copy{YMaps.ICoordBounds} copy()

Возвращает копию объекта.


Тип ОписаниеYMaps.ICoordBounds Копию объекта.

equals{Boolean} equals(coordBounds)

Сравнивает два объекта, представляющих области на карте. Сравнивается текущая область и областьзаданная параметром coordBounds. Функция возвращает true, если объекты представляют идентичныеобласти.

Параметры:

Имя Тип ОписаниеcoordBounds YMaps.ICoordBounds Область на карте.


Тип ОписаниеBoolean true — области совпадают, false — области не совпадают.

getBottom{Number} getBottom()

Возвращает нижнюю границу области.


Тип ОписаниеNumber Нижнюю границу области.

getCenter{YMaps.ICoordPoint} getCenter()

Возвращает центр области в виде точки координатной системы.


Тип ОписаниеYMaps.ICoordPoint Центр области.


64


getLeft{Number} getLeft()

Возвращает левую границу области.


Тип ОписаниеNumber Левую границу области.

getLeftBottom{YMaps.ICoordPoint} getLeftBottom()

Возвращает левый нижний угол области в виде точки координатной системы.


Тип ОписаниеYMaps.ICoordPoint Левый нижний угол области.

getLeftTop{YMaps.ICoordPoint} getLeftTop()

Возвращает левый верхний угол области в виде точки координатной системы.


Тип ОписаниеYMaps.ICoordPoint Левый верхний угол области.

getMapZoom{Number} getMapZoom(map)

Возвращает коэффициент масштабирования, при котором данная прямоугольная область будет виднана карте целиком.

Параметры:

Имя Тип Описаниеmap YMaps.Map Карта, для которой требуется

вычислить коэффициентмасштабирования.


Тип ОписаниеNumber Коэффициент масштабирования.

getRight{Number} getRight()

Возвращает правую границу области.


65



Тип ОписаниеNumber Правую границу области.

getRightBottom{YMaps.ICoordPoint} getRightBottom()

Возвращает правый нижний угол области в виде точки координатной системы.


Тип ОписаниеYMaps.ICoordPoint Правый нижний угол области.

getRightTop{YMaps.ICoordPoint} getRightTop()

Возвращает правый верхний угол области в виде точки координатной системы.


Тип ОписаниеYMaps.ICoordPoint Правый верхний угол области.

getSpan{YMaps.Size} getSpan()

Возвращает линейные размеры области в виде объекта YMaps.Size.


Тип ОписаниеYMaps.Size Размеры области.

getTop{Number} getTop()

Возвращает верхнюю границу области.


Тип ОписаниеNumber Верхнюю границу области.

YMaps.ICoordPointИнтерфейс точки в системе координат. Точка задается парой координат. Этот интерфейс требуется реа-лизовывать при создании пользовательской координатной системы. Примером такой реализации явл-яется YMaps.GeoPoint.


66


КонструкторИмя ОписаниеYMaps.ICoordPoint(x, y) Интерфейс точки в системе координат. Точка задается парой координат.

МетодыИмя Возвращает Описаниеcopy() YMaps.ICoordPoint Возвращает копию точки

координатной системы.

diff(coordPoint) YMaps.Point Возвращает разность между двумяточками координатной системы(вектор).

equals(point) Boolean Сравнивает две точки: точку,заданную параметром point и точку,для которой вызывается метод.

getX() Number Возвращает первую координатуточки координатной системы.

getY() Number Возвращает вторую координатуточки координатной системы.

moveBy(vector) YMaps.ICoordPoint Смещает точку координатнойсистемы на заданный вектор.

moveTo(coordPoint) YMaps.ICoordPoint Устанавливает новые значениякоординат для точки координатнойсистемы.

setX(x) YMaps.ICoordPoint Задает первую координату точкикоординатной системы.

setY(y) YMaps.ICoordPoint Задает вторую координату точкикоординатной системы.

Подробное описание конструктораYMaps.ICoordPoint(x, y)

Интерфейс точки в системе координат. Точка задается парой координат.

Параметры:

Имя Тип Описаниеx Number Первая координата.

y Number Вторая координата.


copy{YMaps.ICoordPoint} copy()

Возвращает копию точки координатной системы.


Тип ОписаниеYMaps.ICoordPoint Копию точки.


67


diff{YMaps.Point} diff(coordPoint)

Возвращает разность между двумя точками координатной системы (вектор). Разность вычисляется меж-ду точкой, заданной параметром coordPoint (конец вектора) и точкой, для которой вызывается метод.

Параметры:

Имя Тип ОписаниеcoordPoint YMaps.ICoordPoint Точка — конец вектора.


Тип ОписаниеYMaps.Point Разность между координатами двух точек в виде вектора.


Сравнивает две точки: точку, заданную параметром point и точку, для которой вызывается метод. Точкисовпадают, если они имеют одинаковые значения координат по обеим осям.

Параметры:

Имя Тип Описаниеpoint YMaps.ICoordPoint Точка.



getX{Number} getX()

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


Тип ОписаниеNumber Первую координату точки.

getY{Number} getY()

Возвращает вторую координату точки координатной системы.


Тип ОписаниеNumber Вторую координату точки.

moveBy{YMaps.ICoordPoint} moveBy(vector)


68


Смещает точку координатной системы на заданный вектор.

Параметры:

Имя Тип Описаниеvector YMaps.Point Координаты вектора (разность

соответствующих координатконечной и начальной точкивектора).


Тип ОписаниеYMaps.ICoordPoint Ссылку на себя.

moveTo{YMaps.ICoordPoint} moveTo(coordPoint)

Устанавливает новые значения координат для точки координатной системы. В качестве аргумента при-нимает другую точку координатной системы, из которой берутся новые координаты.

Параметры:

Имя Тип ОписаниеcoordPoint YMaps.ICoordPoint Точка.



setX{YMaps.ICoordPoint} setX(x)

Задает первую координату точки координатной системы.

Параметры:

Имя Тип Описаниеx Number Значение первой координаты.



setY{YMaps.ICoordPoint} setY(y)

Задает вторую координату точки координатной системы.

Параметры:

Имя Тип Описаниеy Number Значение второй координаты.


69




YMaps.ICoordSystemИнтерфейс системы координат. Этот интерфейс требуется реализовывать при создании пользователь-ской координатной системы.

КонструкторИмя ОписаниеYMaps.ICoordSystem() Интерфейс системы координат.

МетодыИмя Возвращает Описаниеdistance(coordPoint1, coordPoint2) Number Возвращает кратчайшее расстояние

(по геодезической) между двумяточками координатной системы.

fromCoordPoint(point, anchor) YMaps.Point Преобразует координаты точки,заданные в пользовательскойкоординатной системе в пиксельныекоординаты.

getCoordBounds(leftBottom,rightTop)

YMaps.ICoordBounds Возвращает объект,соответствующий области на карте,заданной двумя точками системыкоординат.

getCoordPoint(x, y, unbounded) YMaps.ICoordPoint Возвращает объект,соответствующий точке {x,y}в координатной системе.

getMaxZoom() Integer Возвращает максимальныйкоэффициент масштабирования.

getWorldSize() YMaps.Size Возвращает размеры мира в пикселахпри максимальном масштабе в видеобъекта YMaps.Size.

restrict(coordPoint) YMaps.ICoordPoint Позволяет ограничить областьотображения географическихобъектов на карте. Например,не отображать околополярные(с широтой выше 89.3 градусов)области в проекции Меркатора.

rulerDistance(coordPoint1,coordPoint2)

Number Возвращает расстояние "по линейке"между двумя точками координатнойсистемы.

toCoordPoint(pixelPoint, unbounded) YMaps.ICoordPoint Преобразует пиксельныекоординаты точки в координаты,заданные в пользовательскойкоординатной системе.

Подробное описание конструктораYMaps.ICoordSystem()

Интерфейс системы координат.


70



distance{Number} distance(coordPoint1, coordPoint2)

Возвращает кратчайшее расстояние (по геодезической) между двумя точками координатной системы.

Параметры:

Имя Тип ОписаниеcoordPoint1 YMaps.ICoordPoint Первая точка.

coordPoint2 YMaps.ICoordPoint Вторая точка.


Тип ОписаниеNumber Расстояние по геодезической прямой.

fromCoordPoint{YMaps.Point} fromCoordPoint(point, anchor)

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

Параметры:

Имя Тип Необязательный По умолчанию Описаниеpoint YMaps.ICoordPoint Точка

в координатнойсистеме.

anchor YMaps.ICoordPoint Точка-якорь.


Тип ОписаниеYMaps.Point Точку в пиксельных координатах.

getCoordBounds{YMaps.ICoordBounds} getCoordBounds(leftBottom, rightTop)

Возвращает объект, соответствующий области на карте, заданной двумя точками системы координат.

Параметры:

Имя Тип ОписаниеleftBottom YMaps.ICoordPoint Левый нижний угол области.

rightTop YMaps.ICoordPoint Правый верхний угол области.


Тип ОписаниеYMaps.ICoordBounds Объект-область.


71


getCoordPoint{YMaps.ICoordPoint} getCoordPoint(x, y, unbounded)

Возвращает объект, соответствующий точке {x,y} в координатной системе.


Параметры:

Имя Тип Необязательный По умолчанию Описаниеx Number Первая координата.

y Number Вторая координата.

unbounded Boolean false Флаг, указывающийтип возвращаемойточки. Требуетсядля координатныхсистем, в которыхточка может изме-нять свое положениена карте в зависимо-сти от положенияобозревателя (напри-мер, в системах,"склеенных" в кольцопо одной из коорди-нат).

Для геоточек в гео-графической системекоординат true обо-значает неограничен-ную точку, false —ограниченную.


Тип ОписаниеYMaps.ICoordPoint Объект-точку.

getMaxZoom{Integer} getMaxZoom()

Возвращает максимальный коэффициент масштабирования.


Тип ОписаниеInteger Максимальный коэффициент масштабирования.

getWorldSize{YMaps.Size} getWorldSize()

Возвращает размеры мира в пикселах при максимальном масштабе в виде объекта YMaps.Size.


Тип ОписаниеYMaps.Size Размеры мира (в пикселах).


72



restrict{YMaps.ICoordPoint} restrict(coordPoint)

Позволяет ограничить область отображения географических объектов на карте. Например, не отобра-жать околополярные (с широтой выше 89.3 градусов) области в проекции Меркатора. Если точкапопадает в неотображаемую область карты, то метод вернет координаты ближайшей точки, которуювозможно отобразить.

Параметры:

Имя Тип ОписаниеcoordPoint YMaps.ICoordPoint Точка в координатной системе.


Тип ОписаниеYMaps.ICoordPoint Точку в координатной системе с примененными ограничениями.

rulerDistance{Number} rulerDistance(coordPoint1, coordPoint2)

Возвращает расстояние "по линейке" между двумя точками координатной системы.

Параметры:

Имя Тип ОписаниеcoordPoint1 YMaps.ICoordPoint Первая точка.

coordPoint2 YMaps.ICoordPoint Вторая точка.


Тип ОписаниеNumber Расстояние "по линейке".

toCoordPoint{YMaps.ICoordPoint} toCoordPoint(pixelPoint, unbounded)

Преобразует пиксельные координаты точки в координаты, заданные в пользовательской координатнойсистеме. Пиксельные координаты должны быть рассчитаны при максимальном масштабе карты.


Параметры:

Имя Тип Необязательный По умолчанию ОписаниеpixelPoint YMaps.Point Пиксельные

координаты точкипри максимальноммасштабе карты.

unbounded Boolean false Флаг, указывающийтип возвращаемойточки. Требуетсядля координатныхсистем, в которыхточка может изме-нять свое положениена карте в зависимо-сти от положения


73



Имя Тип Необязательный По умолчанию Описаниеобозревателя (напри-мер, в системах,"склеенных" в кольцопо одной из коорди-нат).

Для геоточек в гео-графической системекоординат true обо-значает неограничен-ную точку, false —ограниченную.


Тип ОписаниеYMaps.ICoordPoint Точку в координатной системе.

YMaps.IGeoObjectИнтерфейс геообъекта.

КонструкторИмя ОписаниеYMaps.IGeoObject() Интерфейс геообъекта.

ПоляИмя Описаниеdescription Описание объекта.

id ID объекта.

metaDataProperty Объект-контейнер для указания дополнительных свойств объекта.

name Имя объекта.

МетодыИмя Возвращает ОписаниеgetBounds() YMaps.ICoordBounds Возвращает область, занимаемую

объектом.

getComputedStyle() YMaps.Style Возвращает вычисленный стиль объ-екта.

getParentGroup() YMaps.IGeoObject Возвращает указательна родительскую группу.

getStyle() YMaps.Style|String Возвращает текущий стиль объекта.

onAddToGroup(parentGroup) Вызывается при добавлении объектав родительскую группу.

onRemoveFromGroup() Вызывается при удалении объектаиз родительской группы.

setBounds(bounds) Устанавливает область, занимаемуюобъектом.

setStyle(style) Устанавливает стиль объекта.

update() Полностью обновляет объект.


74


Имя Возвращает ОписаниеМетод вызывается при изменениистиля объекта и при добавлении объ-екта в родительскую группу. При из-менении стиля родительской группыметод update вызывается у всех чле-нов данной группы автоматически.

Также метод может вызыватьсядля перерисовки объекта при изме-нении его данных.

Подробное описание конструктораYMaps.IGeoObject()

Интерфейс геообъекта.


descriptionString description

Описание объекта.

idString id

ID объекта.

metaDataPropertyObject metaDataProperty

Объект-контейнер для указания дополнительных свойств объекта. Внутренняя структураmetaDataProperty определяется пользователем.

nameString name

Имя объекта.


getBounds{YMaps.ICoordBounds} getBounds()

Возвращает область, занимаемую объектом.

Если значение не было установлено методом setBounds, возвращает null.


Тип ОписаниеYMaps.ICoordBounds Область, занимаемую объектом.


75


getComputedStyle{YMaps.Style} getComputedStyle()

Возвращает вычисленный стиль объекта.

Если собственный стиль объекта не задан, то применяется стиль родителя, если стиль родителя не задан,то применяется стиль родителя родителя, и т. д.


Тип ОписаниеYMaps.Style Указатель на вычисленный стиль.

getParentGroup{YMaps.IGeoObject} getParentGroup()

Возвращает указатель на родительскую группу.


Тип ОписаниеYMaps.IGeoObject Указатель на родительскую группу.

getStyle{YMaps.Style|String} getStyle()

Возвращает текущий стиль объекта.


Тип ОписаниеYMaps.Style|String Указатель или ключ стиля.

onAddToGrouponAddToGroup(parentGroup)

Вызывается при добавлении объекта в родительскую группу.

Параметры:

Имя Тип ОписаниеparentGroup YMaps.IGeoObject Указатель на родительскую группу.

onRemoveFromGrouponRemoveFromGroup()

Вызывается при удалении объекта из родительской группы.

setBoundssetBounds(bounds)

Устанавливает область, занимаемую объектом.


76


Параметры:

Имя Тип Описаниеbounds YMaps.ICoordBounds Область, занимаемая объектом.

setStylesetStyle(style)

Устанавливает стиль объекта.

Параметры:

Имя Тип Описаниеstyle YMaps.Style|String Указатель или ключ стиля.

updateupdate()

Полностью обновляет объект.

Метод вызывается при изменении стиля объекта и при добавлении объекта в родительскую группу.При изменении стиля родительской группы метод update вызывается у всех членов данной группы ав-томатически.

Также метод может вызываться для перерисовки объекта при изменении его данных.

YMaps.IHintLayoutРасширяет YMaps.IContentableLayout.

Интерфейс макета всплывающей подсказки. Должен реализовываться всеми макетами всплывающихподсказок. Шаблон, заданный в YMaps.HintStyle, должен генерировать макет, реализующий данныйинтерфейс.

КонструкторИмя ОписаниеYMaps.IHintLayout(context, map)

МетодыИмя Возвращает ОписаниеgetSize() YMaps.Size Возвращает фактический размер

подсказки (в пикселах).

moveTo(position) Позиционирует макет всплывающейподсказки.

setMaxSize(maxWidth, maxHeight) Устанавливает максимальныеразмеры макета всплывающейподсказки.





77


Подробное описание конструктораYMaps.IHintLayout(context, map)

Параметры:




getSize{YMaps.Size} getSize()

Возвращает фактический размер подсказки (в пикселах).


Тип ОписаниеYMaps.Size Размер подсказки (в пикселах).

moveTomoveTo(position)

Позиционирует макет всплывающей подсказки.

Параметры:

Имя Тип Описаниеposition YMaps.Point Позиция (в пикселах).

setMaxSizesetMaxSize(maxWidth, maxHeight)

Устанавливает максимальные размеры макета всплывающей подсказки.

Параметры:

Имя Тип ОписаниеmaxWidth Number Максимальная ширина.

maxHeight Number Максимальная высота.

YMaps.IInteractiveGeoObjectРасширяет YMaps.IGeoObject.

Интерфейс интерактивного геообъекта.

КонструкторИмя ОписаниеYMaps.IInteractiveGeoObject(options) Интерфейс интерактивного геообъекта.


78




МетодыИмя Возвращает ОписаниеcloseBalloon() Закрывает балун, если он был

открыт.

getBalloon() YMaps.Balloon Возвращает балун метки или null,если он не открыт.

getBalloonContent() YMaps.ILayout Возвращает содержимое балуна,установленное черезsetBalloonContent.

getBalloonOptions() YMaps.MapBalloonOptions Возвращает опции балуна.

getHintContent() YMaps.ILayout Возвращает содержимоевсплывающей подсказки,установленное с помощью методаYMaps.IInteractiveGeoObject.setHintContent.

getHintOptions() YMaps.HintOptions Возвращает опции всплывающейподсказки.

getOptions() YMaps.InteractiveGeoObjectOptions Возвращает опции геообъекта.

openBalloon(content, options) Открывает балун для заданногообъекта карты.

setBalloonContent(content) Устанавливает содержимое балуна.

setBalloonOptions(options,restoreDefault)


setHintContent(content) Устанавливает содержимоевсплывающей подсказки.

setHintOptions(options,restoreDefault)

Устанавливает опции всплывающейподсказки.

setOptions(options, restoreDefault) Устанавливает опции геообъекта.

update() Полностью обновляет объект, вклю-чая всплывающую подсказку, содер-жимое балуна и сам балун.

Наследуемые методыИз YMaps.IGeoObject:

getBounds, getComputedStyle, getParentGroup, getStyle, onAddToGroup, onRemoveFromGroup,setBounds, setStyle

Подробное описание конструктораYMaps.IInteractiveGeoObject(options)

Интерфейс интерактивного геообъекта.

Параметры:

Имя Тип Необязательный По умолчанию Описаниеoptions YMaps.InteractiveGe

oObjectOptionsОпции геообъекта.


79



closeBallooncloseBalloon()

Закрывает балун, если он был открыт.

getBalloon{YMaps.Balloon} getBalloon()

Возвращает балун метки или null, если он не открыт.


Тип ОписаниеYMaps.Balloon Балун для данной метки.

getBalloonContent{YMaps.ILayout} getBalloonContent()

Возвращает содержимое балуна, установленное через setBalloonContent.


Тип ОписаниеYMaps.ILayout Содержимое балуна.

getBalloonOptions{YMaps.MapBalloonOptions} getBalloonOptions()

Возвращает опции балуна.


Тип ОписаниеYMaps.MapBalloonOptions Опции балуна.

getHintContent{YMaps.ILayout} getHintContent()

Возвращает содержимое всплывающей подсказки, установленное с помощью методаYMaps.IInteractiveGeoObject.setHintContent.


Тип ОписаниеYMaps.ILayout Содержимое всплывающей подсказки.

getHintOptions{YMaps.HintOptions} getHintOptions()

Возвращает опции всплывающей подсказки.


80



Тип ОписаниеYMaps.HintOptions Опции всплывающей подсказки.

getOptions{YMaps.InteractiveGeoObjectOptions} getOptions()

Возвращает опции геообъекта.


Тип ОписаниеYMaps.InteractiveGeoObjectOptions Опции геообъекта.

openBalloonopenBalloon(content, options)

Открывает балун для заданного объекта карты.

Примеры:

1.

// Открывает балун и отображает его содержимое с помощью заданного стиля.interactiveObject.openBalloon();

2.

// Перекрывает содержимое балуна, заданное с помощью стиля, и ограничивает максимальную ширину балуна 100 пикселами.interactiveObject.setBalloonContent("test");interactiveObject.setBalloonOptions({maxWidth: 100});interactiveObject.openBalloon();// ЭквивалентноinteractiveObject.openBalloon("test", {maxWidth: 100});

Параметры:

Имя Тип Необязательный По умолчанию Описаниеcontent String|HTMLElement|

YMaps.ILayoutСодержимое балуна.

options YMaps.MapBalloonOptions

Опции балуна.

setBalloonContentsetBalloonContent(content)

Устанавливает содержимое балуна. Содержимое, установленное таким образом, приоритетнее содер-жимого, созданного с применением текущего стиля содержимого балуна.

Параметры:

Имя Тип Описаниеcontent String|HTMLElement|YMaps.ILayout Содержимое балуна.

setBalloonOptionssetBalloonOptions(options, restoreDefault)



81


Параметры:

Имя Тип Необязательный По умолчанию Описаниеoptions YMaps.MapBalloonO

ptionsОпции балуна.


setHintContentsetHintContent(content)

Устанавливает содержимое всплывающей подсказки. Содержимое, установленное таким образом, при-оритетнее содержимого, созданного при помощи текущего стиля содержимого подсказки.

Параметры:

Имя Тип Описаниеcontent String|HTMLElement|YMaps.ILayout Содержимое всплывающей

подсказки.

setHintOptionssetHintOptions(options, restoreDefault)

Устанавливает опции всплывающей подсказки.

Параметры:

Имя Тип Необязательный По умолчанию Описаниеoptions YMaps.HintOptions Опции.



Устанавливает опции геообъекта.

Параметры:

Имя Тип Необязательный По умолчанию Описаниеoptions YMaps.InteractiveGe

oObjectOptionsОпции геообъекта.


updateupdate()

Полностью обновляет объект, включая всплывающую подсказку, содержимое балуна и сам балун.


82


Метод вызывается при изменении стиля объекта и при добавлении объекта в родительскую группу.При изменении стиля родительской группы метод update вызывается у всех членов группы автомати-чески.

Также метод может вызываться для перерисовки объекта при изменении его данных.

YMaps.ILayerИнтерфейс слоя карты.

См.: Слои

КонструкторИмя ОписаниеYMaps.ILayer() Интерфейс слоя карты.

МетодыИмя Возвращает ОписаниеgetCopyright(bounds, zoom) String Возвращает строку с сообщением

об авторском праве для заданнойвидимой области слоя и призаданном коэффициентемасштабирования.

getZoomRange(bounds) Object Возвращает минимальныйи максимальный коэффициентымасштабирования для заданнойвидимой области слоя карты, либоnull, если в заданной области слойне виден.

onAddToMap(map, parentContainer) Вызывается при добавлении слояна карту.

onMapUpdate() Обновление слоя, вызываемоепри обновлении карты.

onMove(position, offset) Обработка смещения карты. Методавтоматически вызываетсяпри каждом сдвиге карты.

onRemoveFromMap() Вызывается при удалении слояс карты.

onSmoothZoomEnd() Вызывается в конце плавногомасштабирования.

onSmoothZoomStart() Вызывается в начале плавногомасштабирования.

onSmoothZoomTick(params) Вызывается при выполнении шагаплавного масштабирования.

Подробное описание конструктораYMaps.ILayer()

Интерфейс слоя карты.

См.: Слои


83

http://api.yandex.ru/maps/jsapi/doc/dg/concepts/layers.xml




getCopyright{String} getCopyright(bounds, zoom)

Возвращает строку с сообщением об авторском праве для заданной видимой области слоя и при заданномкоэффициенте масштабирования.

Параметры:

Имя Тип Описаниеbounds YMaps.ICoordBounds Видимая область слоя.

zoom Integer Коэффициент масштабирования.


Тип ОписаниеString Строку копирайта.

getZoomRange{Object} getZoomRange(bounds)

Возвращает минимальный и максимальный коэффициенты масштабирования для заданной видимойобласти слоя карты, либо null, если в заданной области слой не виден. Уровни масштабирования воз-вращаются в виде объекта с полями min и max.

Пример:

layer.getZoomRange(map.getBounds()) -> {min: 1, max: 15}

Параметры:

Имя Тип Описаниеbounds YMaps.ICoordBounds Видимая область слоя.


Тип ОписаниеObject Объект с полями min и max, указывающими минимальный

и максимальный коэффициенты масштабирования для видимой областислоя.

onAddToMaponAddToMap(map, parentContainer)

Вызывается при добавлении слоя на карту.

Параметры:


parentContainer HTMLElement Указатель на родительский HTML-элемент.

onMapUpdateonMapUpdate()


84


Обновление слоя, вызываемое при обновлении карты.

onMoveonMove(position, offset)

Обработка смещения карты. Метод автоматически вызывается при каждом сдвиге карты.

Параметры:

Имя Тип Описаниеposition YMaps.Point Новая позиция (в пикселах).

offset YMaps.Point Смещение относительнопредыдущей позиции (в пикселах).


Вызывается при удалении слоя с карты.

onSmoothZoomEndonSmoothZoomEnd()

Вызывается в конце плавного масштабирования.

onSmoothZoomStartonSmoothZoomStart()

Вызывается в начале плавного масштабирования.

onSmoothZoomTickonSmoothZoomTick(params)

Вызывается при выполнении шага плавного масштабирования.

Параметры:

Имя Тип Описаниеparams Object Параметры шага.

params.saveThisPosition YMaps.ICoordPoint Точка координатной системы,относительно которой производитсямасштабирование.

params.scaleCoefficient Number Коэффициент изменения размераотносительно начального.

params.sizeCoefficientDiff Number Линейное изменение scaleCoefficientотносительно предыдущего шага.

YMaps.ILayoutИнтерфейс макета.


85


КонструкторИмя ОписаниеYMaps.ILayout(context, map) Интерфейс макета.

МетодыИмя ОписаниеonAddToParent(parentNode) Добавляет макет в определенный элемент.

onRemoveFromParent() Удаляет макет из родительского элемента.

update() Обновляет макет.

Подробное описание конструктораYMaps.ILayout(context, map)

Интерфейс макета. Должен реализовываться всеми макетами.

Параметры:




onAddToParentonAddToParent(parentNode)

Добавляет макет в определенный элемент.

Параметры:

Имя Тип ОписаниеparentNode HTMLElement Родительский элемент.

onRemoveFromParentonRemoveFromParent()

Удаляет макет из родительского элемента.

updateupdate()

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

YMaps.ImageTileРасширяет YMaps.ITile.

Класс тайла с изображением фрагмента карты.

См.: Адресация тайлов


86

http://api.yandex.ru/maps/jsapi/doc/dg/concepts/coordinates_systems.xml#coordinates_systems/tiles-addressing


КонструкторИмя ОписаниеYMaps.ImageTile(dataSource) Создает объект тайла для слоя карты.

МетодыИмя Возвращает ОписаниеgetState() YMaps.State Возвращает текущее состояние

тайла.

Наследуемые методыИз YMaps.ITile:

abort, error, getPosition, load, onAddToMap, onRemoveFromMap, scale, setPosition

Подробное описание конструктораYMaps.ImageTile(dataSource)

Создает объект тайла для слоя карты.

См.: Адресация тайлов

Параметры:

Имя Тип ОписаниеdataSource YMaps.TileDataSource Источник данных для тайлов

определенного типа.


getState{YMaps.State} getState()

Возвращает текущее состояние тайла.

См.: YMaps.State


Тип ОписаниеYMaps.State Состояние.

YMaps.InteractiveGeoObjectOptionsОпции интерактивного геообъекта.


Пример:

// Задает опции геообъекта.var geoObjectOptions = { hasBalloon: false, hasHint: true, style: 'myCustomStyle', hintOptions: { offset: new YMaps.Point(5, 5)


87

http://api.yandex.ru/maps/jsapi/doc/dg/concepts/coordinates_systems.xml#coordinates_systems/tiles-addressing


}}

ПоляИмя ОписаниеballoonOptions Опции балуна.

hasBalloon Возможность открытия балуна объекта по щелчку мыши.

hasHint Возможность отображения всплывающей подсказки при наведениикурсора мыши на геообъект.

hintOptions Опции всплывающей подсказки.

interactive Включает/выключает обработку событий мыши: true — объект принимаетсобытия мыши (по умолчанию), false — нет.

style Указатель или ключ стиля объекта.


balloonOptionsYMaps.MapBalloonOptions balloonOptions


hasBalloonBoolean hasBalloon

Возможность открытия балуна объекта по щелчку мыши. Программная возможность открытия балунаимеется всегда, см. YMaps.IInteractiveGeoObject.openBalloon. Если поле не задано, то используется со-ответствующее поле из стиля геообъекта.

hasHintBoolean hasHint

Возможность отображения всплывающей подсказки при наведении курсора мыши на геообъект. Еслине задано, используется соответствующее поле из стиля.

hintOptionsYMaps.HintOptions hintOptions

Опции всплывающей подсказки.

interactiveBoolean interactive

Включает/выключает обработку событий мыши: true — объект принимает события мыши (по умолча-нию), false — нет.

styleYMaps.Style|String style

Указатель или ключ стиля объекта. Если не задан, используется стиль родительской группы. Еслинет родительской группы, то используется стиль по умолчанию YMaps.Styles.DefaultStyleKey.


88


YMaps.IObserverИнтерфейс обработчика события.

КонструкторИмя ОписаниеYMaps.IObserver() Обработчик события. Осуществляет вызов функции по событию.

МетодыИмя Описаниеcleanup() Уничтожает объект-обработчик события.

disable() Выключает (деактивирует) объект-обработчик события.

enable() Включает (активирует) объект-обработчик события.

Подробное описание конструктораYMaps.IObserver()

Обработчик события. Осуществляет вызов функции по событию.

Пример:

// Создает обработчик события eventName и немедленно приступает к "прослушиванию" события.var observer = YMaps.Events.observe(object, "eventName", listener);...// Отключает обработчик.observer.disable();...// Снова включает обработчик.observer.enable();...// Удаляет обработчик.observer.cleanup();


cleanupcleanup()

Уничтожает объект-обработчик события. Удаляет ссылку на объект, на котором возникает событиеи ссылку на callback-функцию.

disabledisable()

Выключает (деактивирует) объект-обработчик события.

enableenable()

Включает (активирует) объект-обработчик события.


89


YMaps.IOverlayИнтерфейс оверлея.

См.: Оверлеи

КонструкторИмя ОписаниеYMaps.IOverlay() Интерфейс оверлея.

МетодыИмя ОписаниеonAddToMap(map, parentContainer) Реализует добавление оверлея на карту.

onMapUpdate() Вызывается при обновлении карты.

onRemoveFromMap() Вызывается при удаление оверлея с карты.

Подробное описание конструктораYMaps.IOverlay()

Интерфейс оверлея.

См.: Оверлеи



Реализует добавление оверлея на карту. Вызывается объектом карты и не предназначен для прямоговызова.

Параметры:


parentContainer HTMLElement Указатель на родительский HTML-элемент

onMapUpdateonMapUpdate()

Вызывается при обновлении карты. Вызывается объектом карты и не предназначен для прямого вызова.


Вызывается при удаление оверлея с карты. Вызывается объектом карты и не предназначен для прямоговызова.


90

http://api.yandex.ru/maps/jsapi/doc/dg/concepts/overlay.xml

http://api.yandex.ru/maps/jsapi/doc/dg/concepts/overlay.xml


YMaps.IPlacemarkLayoutРасширяет YMaps.IContentableLayout.

Интерфейс макета метки.

КонструкторИмя ОписаниеYMaps.IPlacemarkLayout(context,map)

Интерфейс макета метки.

МетодыИмя Возвращает ОписаниеgetOffset() YMaps.Point Возвращает сдвиг значка метки

относительно его точкипозиционирования (в пикселах).




Подробное описание конструктораYMaps.IPlacemarkLayout(context, map)

Интерфейс макета метки. Должен реализовываться всеми макетами метки. Шаблон, заданныйв YMaps.IconStyle, должен генерировать макет, реализующий данный интерфейс.

Параметры:




getOffset{YMaps.Point} getOffset()

Возвращает сдвиг значка метки относительно его точки позиционирования (в пикселах). Используетсядля визуального выравнивания. Если метод не реализован, то данные берутся из стиля.


Тип ОписаниеYMaps.Point Сдвиг значка метки относительно его точки позиционирования


YMaps.ITemplateШаблон для построения макетов.


91


КонструкторИмя ОписаниеYMaps.ITemplate(text)

МетодыИмя Возвращает Описаниеbuild(context, map) YMaps.ILayout Возвращает макет, созданный

по указанному шаблону.

Подробное описание конструктораYMaps.ITemplate(text)

Параметры:

Имя Тип Описаниеtext String HTML-код шаблона.


build{YMaps.ILayout} build(context, map)

Возвращает макет, созданный по указанному шаблону.

Параметры:

Имя Тип Описаниеcontext Object Контекст для шаблона — объект,

из которого берутся данныедля подстановки в шаблон.



Тип ОписаниеYMaps.ILayout Макет, созданный по указанному шаблону.

YMaps.ITileИнтерфейс тайла.

КонструкторИмя ОписаниеYMaps.ITile(tileDataSource) Интерфейс тайла.


92


МетодыИмя Возвращает Описаниеabort() Останавливает загрузку. Если тайл

не загрузился, отображает тайлошибки.

error() Отображает тайл ошибки.

getPosition() YMaps.Point Возвращает текущую позицию тайла(в пикселах).

load(tileNumber, zoom) Загружает тайл с заданным номеромпри заданном коэффициентемасштабирования.

onAddToMap(map, parentContainer) Вызывается при добавлении тайлана карту.

onRemoveFromMap() Вызывается при удалении тайлас карты.

scale(coefficient) Масштабирует тайл.

setPosition(position) Устанавливает тайл в заданнуюпозицию.

Подробное описание конструктораYMaps.ITile(tileDataSource)

Интерфейс тайла.

Параметры:

Имя Тип ОписаниеtileDataSource YMaps.TileDataSource Источник данных для тайлов

конкретного типа.


abortabort()

Останавливает загрузку. Если тайл не загрузился, отображает тайл ошибки.

errorerror()

Отображает тайл ошибки.

getPosition{YMaps.Point} getPosition()

Возвращает текущую позицию тайла (в пикселах).


Тип ОписаниеYMaps.Point Позицию тайла (в пикселах).


93


loadload(tileNumber, zoom)

Загружает тайл с заданным номером при заданном коэффициенте масштабирования.

Параметры:

Имя Тип ОписаниеtileNumber YMaps.Point Номер тайла.

zoom Number Коэффициент масштабирования.


Вызывается при добавлении тайла на карту.

Параметры:


parentContainer HTMLElement Указатель на родительский HTML-элемент.


Вызывается при удалении тайла с карты.

scalescale(coefficient)

Масштабирует тайл.

Параметры:

Имя Тип Описаниеcoefficient Number Коэффициент масштабирования.

Во сколько раз требуемый размеротличается от стандартного.

setPositionsetPosition(position)

Устанавливает тайл в заданную позицию.

Параметры:

Имя Тип Описаниеposition YMaps.Point Позиция тайла (в пикселах).

YMaps.IToolBarItemИнтерфейс элемента управления, добавляемого на тулбар.


94


КонструкторИмя ОписаниеYMaps.IToolBarItem() Интерфейс элемента управления, добавляемого на тулбар.

МетодыИмя ОписаниеonAddToToolBar(toolBar, parentContainer, group) Вызывается при добавлении элемента управления

на тулбар.

onRemoveFromToolBar() Вызывается при удалении элемента управленияс тулбара.

Подробное описание конструктораYMaps.IToolBarItem()

Интерфейс элемента управления, добавляемого на тулбар.

Пример:

// Создает пользовательскую кнопку тулбара в виде раскрывающегося списка городов.// При выборе города из списка центр карты перемещается в соответствующую точку.var MyButton = function () { var element = document.createElement('select'), toolBar;

var option1 = document.createElement('option'); option1.value = '37.511553,55.749288'; option1.selected = 'selected'; option1.innerHTML = 'Москва'; element.appendChild(option1);

var option2 = document.createElement('option'); option2.value = '30.260577,59.888582'; option2.innerHTML = 'Санкт-Петербург'; element.appendChild(option2);

function showSelection () { toolBar.getMap().setCenter(YMaps.GeoPoint.fromString(element.options[element.selectedIndex].value)); }

this.onAddToToolBar = function (oToolBar, parentContainer) { toolBar = oToolBar; parentContainer.appendChild(element); element.onchange = showSelection; }

this.onRemoveFromToolBar = function () { element.onchange = null; element.parentNode.removeChild(element); }}

var map = new YMaps.Map(document.getElementById('YMapsID')), toolbar = new YMaps.ToolBar(new MyButton());map.setCenter(new YMaps.GeoPoint(37.632404, 55.749288), 9);map.addControl(toolbar);


95



onAddToToolBaronAddToToolBar(toolBar, parentContainer, group)

Вызывается при добавлении элемента управления на тулбар.

Параметры:

Имя Тип ОписаниеtoolBar YMaps.ToolBar Указатель на тулбар.

parentContainer HTMLElement Родительский элемент для элементауправления.

group YMaps.Group Группа-контейнер элементовтулбара, в которую добавлен элементуправления. Если элементдобавляется в раскрывающийсясписок, то параметр group будетсодержать ссылку на объектYMaps.ListBox, в остальныхслучаях — ссылку на тулбар.

onRemoveFromToolBaronRemoveFromToolBar()

Вызывается при удалении элемента управления с тулбара.

YMaps.LayerРасширяет YMaps.ILayer.

Класс слоя с картой.

Внимание!Плавное масштабирование не производится в браузере Opera версий ниже 9.5. Для остальных браузероввозможность плавного масштабирования определяется значением параметра smoothZoomEnabledв конструкторе источника данных YMaps.TileDataSource для отдельного слоя карты.

См.: Слои

КонструкторИмя ОписаниеYMaps.Layer(tileDataSource) Создает слой с картой.


96



МетодыИмя Возвращает ОписаниеgetContainer() HTMLElement Возвращает указатель на контейнер

слоя.

getMap() YMaps.Map Возвращает указатель на карту,в которую добавлен слой.

getTileInPosition(pos) YMaps.ITile Возвращает тайл, содержащийуказанную точку.

Наследуемые методыИз YMaps.ILayer:

getCopyright, getZoomRange, onAddToMap, onMapUpdate, onMove, onRemoveFromMap,onSmoothZoomEnd, onSmoothZoomStart, onSmoothZoomTick

Подробное описание конструктораYMaps.Layer(tileDataSource)

Создает слой с картой.

См.: Слои

Параметры:

Имя Тип ОписаниеtileDataSource YMaps.TileDataSource Источник данных для тайлов слоя.


getContainer{HTMLElement} getContainer()

Возвращает указатель на контейнер слоя.


Тип ОписаниеHTMLElement Указатель на HTML-контейнер слоя.

getMap{YMaps.Map} getMap()

Возвращает указатель на карту, в которую добавлен слой.


Тип ОписаниеYMaps.Map Указатель на карту, в которую добавлен слой.

getTileInPosition{YMaps.ITile} getTileInPosition(pos)

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


97



Параметры:

Имя Тип Описаниеpos YMaps.Point Точка в локальных пикселах.


Тип ОписаниеYMaps.ITile Тайл.

YMaps.LayersСтатический объект.

Объект для хранения слоев.

МетодыИмя Возвращает Описаниеadd(layerKey, layer) Добавляет класс или экземпляр слоя

в хранилище.

get(layerKey) YMaps.ILayer Возвращает экземпляр слояпо указанному ключу.

remove(layerKey) Function | YMaps.ILayer Удаляет слой из хранилища.


addadd(layerKey, layer)

Добавляет класс или экземпляр слоя в хранилище.

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

Совет:Для обеспечения уникальности ключа рекомендуется добавлять в него имя проекта. Например,"maps.yandex.ru#customLayer"

Если в хранилище добавляется класс, то при каждом извлечении будет возвращаться новый экземплярданного класса. Если же добавляется экземпляр, то при извлечении будет возвращаться указатель на этотэкземпляр.

Параметры:

Имя Тип ОписаниеlayerKey String Ключ слоя.

layer Function | YMaps.ILayer Конструктор или экземпляр слоя.

get{YMaps.ILayer} get(layerKey)

Возвращает экземпляр слоя по указанному ключу.


98


Параметры:



Тип ОписаниеYMaps.ILayer Экземпляр слоя.

remove{Function | YMaps.ILayer} remove(layerKey)

Удаляет слой из хранилища.

Параметры:



Тип ОписаниеFunction | YMaps.ILayer Конструктор или экземпляр слоя.

YMaps.LayoutTemplateШаблон для построения определенных макетов.

КонструкторИмя ОписаниеYMaps.LayoutTemplate(layoutClass) Создает шаблон — фабрику для создания указанных макетов.


по данному шаблону.

Подробное описание конструктораYMaps.LayoutTemplate(layoutClass)

Создает шаблон — фабрику для создания указанных макетов.

Параметры:

Имя Тип ОписаниеlayoutClass Function Класс макета.




99


Возвращает макет, созданный по данному шаблону.

Параметры:

Имя Тип Описаниеcontext Object Контекст для шаблона — объект,

из которого берутся данныепри построении макета.



Тип ОписаниеYMaps.ILayout Результирующий макет.

YMaps.LineStyleСтиль линии или ломаной.

КонструкторИмя ОписаниеYMaps.LineStyle() Создает объект стиля линии или ломаной.

ПоляИмя ОписаниеstrokeColor Цвет линии в формате RGBA.

strokeWidth Толщина линии (в пикселах).

Подробное описание конструктораYMaps.LineStyle()

Создает объект стиля линии или ломаной.


strokeColorString strokeColor

Цвет линии в формате RGBA. Значение по умолчанию "ff0000ff" (красный). Последние два разрядаопределяют альфа-канал (00 — полностью прозрачный, ff — непрозрачный). По умолчанию последниедва разряда имеют значение ff.

strokeWidthNumber strokeWidth

Толщина линии (в пикселах). По умолчанию 1px.

YMaps.ListBoxРасширяет YMaps.Group, YMaps.IToolBarItem.


100


Класс для создания элемента тулбара в виде раскрывающегося списка.

Элемент тулбара в виде раскрывающегося списка, предлагающего на выбор несколько взаимоисклю-чающих вариантов. Чтобы открыть список, пользователю требуется нажать на стрелку справа от него.

Список может иметь заголовок, который показывается на тулбаре. В список можно добавлять и удалятьэлементы. Элементы списка могут быть как экземплярами стандартных классов YMaps.ToolBarItemи YMaps.ToolBarToggleItem, так и пользовательскими объектами, реализующими интерфейсYMaps.IToolBarItem.

КонструкторИмя ОписаниеYMaps.ListBox(options) Создает элемент тулбара в виде раскрывающегося списка.


Events


Add, Remove

МетодыИмя Возвращает Описаниеcollapse() Скрывает список.

expand() Раскрывает список.

getCaption() String Возвращает текущий заголовокраскрывающегося списка.

getToolBar() YMaps.ToolBar Возвращает тулбар, на которыйдобавлен раскрывающийся список.

isExpanded() Boolean Возвращает состояниераскрывающегося списка (раскрыт/скрыт).

setCaption(caption) Задает новый заголовокраскрывающегося списка.

Наследуемые методыИз YMaps.IToolBarItem:

onAddToToolBar, onRemoveFromToolBarИз YMaps.Group:

add, filter, forEach, get, indexOf, length, remove, removeAll, splice

Подробное описание конструктораYMaps.ListBox(options)

Создает элемент тулбара в виде раскрывающегося списка.


101


Параметры:

Имя Тип Необязательный По умолчанию Описаниеoptions Object Опции

раскрывающегосясписка.

options.width Integer 140 Ширина списка(в пикселах).

options.caption String '' Заголовок списка.


collapsecollapse()

Скрывает список.

expandexpand()

Раскрывает список.

getCaption{String} getCaption()

Возвращает текущий заголовок раскрывающегося списка.


Тип ОписаниеString Заголовок списка.

getToolBar{YMaps.ToolBar} getToolBar()

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


Тип ОписаниеYMaps.ToolBar Тулбар, на который добавлен раскрывающийся список.

isExpanded{Boolean} isExpanded()

Возвращает состояние раскрывающегося списка (раскрыт/скрыт).


Тип ОписаниеBoolean true — раскрыт, false — скрыт.

setCaptionsetCaption(caption)


102


Задает новый заголовок раскрывающегося списка.

Параметры:

Имя Тип Описаниеcaption String Новый заголовок списка.

YMaps.ListBoxItemРасширяет YMaps.IToolBarItem.

Стандартная кнопка раскрывающегося списка YMaps.ListBox.

КонструкторИмя ОписаниеYMaps.ListBoxItem(caption) Создает стандартную кнопку раскрывающегося списка YMaps.ListBox.

ПоляИмя ОписаниеEvents Список событий кнопки.

СобытияИмя ОписаниеClick Событие щелчка мышью по кнопке. При обработке события в callback-

функцию передается ссылка на кнопку, для которой был вызванобработчик.

МетодыИмя Возвращает ОписаниеgetCaption() String Возвращает текущий текст надписи

на кнопке.

getListBox() YMaps.ListBox Возвращает объект YMaps.ListBox,в который добавлена кнопка.

setCaption(caption) Устанавливает новый текст кнопки.


onAddToToolBar, onRemoveFromToolBar

Подробное описание конструктораYMaps.ListBoxItem(caption)

Создает стандартную кнопку раскрывающегося списка YMaps.ListBox.

Параметры:

Имя Тип Описаниеcaption String Заголовок кнопки.


103



EventsObject Events

Список событий кнопки.


ClickClick

Событие щелчка мышью по кнопке. При обработке события в callback-функцию передается ссылкана кнопку, для которой был вызван обработчик.


getCaption{String} getCaption()

Возвращает текущий текст надписи на кнопке.


Тип ОписаниеString Текущий текст кнопки.

getListBox{YMaps.ListBox} getListBox()

Возвращает объект YMaps.ListBox, в который добавлена кнопка.


Тип ОписаниеYMaps.ListBox Родительский элемент. тулбара.

setCaptionsetCaption(caption)

Устанавливает новый текст кнопки.

Параметры:

Имя Тип Описаниеcaption String Новый текст кнопки.

YMaps.ListBoxToggleItemРасширяет YMaps.ListBoxItem.

Элемент раскрывающегося списка с флажком.


104


КонструкторИмя ОписаниеYMaps.ListBoxToggleItem(caption,selected)

Создает элемент раскрывающегося списка YMaps.ListBox с флажком.

Наследуемые поляИз YMaps.ListBoxItem:

Events

СобытияИмя ОписаниеDeselect Событие отмены выбора кнопки. При обработке события в callback-

функцию передается ссылка на кнопку, для которой был вызванобработчик.

Select Событие выбора кнопки. При обработке события в callback-функциюпередается ссылка на кнопку, для которой был вызван обработчик.

Наследуемые событияИз YMaps.ListBoxItem:

Click

МетодыИмя Возвращает Описаниеdeselect() Устанавливает кнопку в состояние

"не выбрано".

isSelected() Boolean Возвращает состояние кнопки"выбрано"/"не выбрано".

select() Устанавливает кнопку в состояние"выбрано".

Наследуемые методыИз YMaps.ListBoxItem:

getCaption, getListBox, setCaptionИз YMaps.IToolBarItem:


Подробное описание конструктораYMaps.ListBoxToggleItem(caption, selected)

Создает элемент раскрывающегося списка YMaps.ListBox с флажком.

Параметры:

Имя Тип Необязательный По умолчанию Описаниеcaption String Надпись на кнопке.

selected Boolean false Начальное состояниеэлемента списка:true — выбран,false — не выбран.


105



DeselectDeselect

Событие отмены выбора кнопки. При обработке события в callback-функцию передается ссылка на кноп-ку, для которой был вызван обработчик.

SelectSelect

Событие выбора кнопки. При обработке события в callback-функцию передается ссылка на кнопку,для которой был вызван обработчик.


deselectdeselect()

Устанавливает кнопку в состояние "не выбрано".

isSelected{Boolean} isSelected()

Возвращает состояние кнопки "выбрано"/"не выбрано".


Тип ОписаниеBoolean true — кнопка выбрана, false — кнопка не выбрана.

selectselect()

Устанавливает кнопку в состояние "выбрано".

YMaps.MapКласс для создания и управления картой.

КонструкторИмя ОписаниеYMaps.Map(element, options) Создает карту в указанном HTML-контейнере.

ПоляИмя Описаниеconverter Преобразователь координат, см. YMaps.Converter.

coordSystem Система координат YMaps.ICoordSystem.

Events Список обрабатываемых событий карты.


106


Имя Описаниеhint Всплывающая подсказка, см. YMaps.Hint.

tileCoordinates Преобразователь пиксельных координат (рассчитаных при максимальноммасштабе карты) в тайловые, см. YMaps.TileCoordinates.

СобытияИмя ОписаниеAddLayer Добавление слоя на карту.

BeforeClick Пред-событие, возникает непосредственно перед обработкой картой со-бытия щелчка мышью по карте.

BeforeContextMenu Пред-событие, возникает непосредственно перед обработкой картой со-бытия щелчка правой кнопкой мыши по карте.

BeforeDblClick Пред-событие, возникает непосредственно перед обработкой картой со-бытия двойного щелчка мышью по карте.

BeforeDOMMouseScroll Пред-событие, возникает непосредственно перед обработкой картой со-бытия прокрутки колесом мыши.

BeforeMouseDown Пред-событие, возникает непосредственно перед обработкой картой со-бытия нажатия кнопки мыши.

BeforeMouseMove Пред-событие, возникает непосредственно перед обработкой картой со-бытия движения мышью.

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

BoundsChange Изменение границ видимой области карты.

Click Щелчок мышью по карте.

ContextMenu Щелчок правой кнопкой мыши по карте.

DblClick Двойной щелчок мышью по карте.

Destruct Карта удалена.

DOMMouseScroll Прокрутка колесом мыши.

MouseDown Нажатие кнопки мыши.

MouseMove Движение мышью.

MouseUp Нажатая кнопка мыши отпущена.

Move Перетаскивание карты продолжается.

MoveEnd Перетаскивание карты завершено.

MoveStart Начало перетаскивания карты.

Redraw Произошла перерисовка карты, вследствие изменения размеров картыили ее положения на странице.

RemoveLayer Удаление слоя с карты.

SmoothZoomEnd Окончание плавного масштабирования карты.

SmoothZoomStart Начало плавного масштабирования карты.

TypeChange Смена типа карты.

Update Перерисовка (обновление) карты (при изменении центраили коэффициента масштабирования).


107


МетодыИмя Возвращает ОписаниеaddControl(control, controlPosition) Добавляет указанный элемент

управления на карту.

addCopyright(copyright) Добавляет на карту строкус сообщением об авторском праве.

addCursor(cursor) Добавляет на карту новый курсор.

addLayer(layer) Добавляет слой на карту.

addOverlay(overlay) Добавляет оверлей на карту.

closeBalloon() Boolean Закрывает балун, показываемыйв данный момент на карте.

dblClickZoomEnabled() Boolean Проверяет, включенали возможность изменениякоэффициента масштабированияпо двойному щелчку кнопкой мыши.

destructor() Удаляет карту и выбрасываетсобытие Destruct.

disableDblClickZoom() Выключает возможность изменениякоэффициента масштабированияс помощью двойного щелчка мышью(по умолчанию включена).

disableDragging() Выключает возможностьперетаскивания карты с помощьюмыши (по умолчанию включена).

disableHotKeys() Выключает горячие клавишидля функций масштабированияи сдвига карты (по умолчаниювыключены).

disableMagnifier() Выключает возможность изменениякоэффициента масштабированиякарты посредством выделенияобласти на карте левой кнопкоймыши (по умолчанию выключена).

disableRightButtonMagnifier() Выключает возможность выделенияобласти карты правой кнопкой(по умолчанию выключена).

disableRuler() Выключает инструмент "Линейка"на карте (по умолчанию выключен).

disableScrollZoom() Выключает возможность плавнойпрокрутки карты колесом мыши(по умолчанию выключена).

draggingEnabled() Boolean Проверяет, включенали возможность перетаскиваниякарты с помощью мыши.

enableDblClickZoom(options) Включает возможность изменениякоэффициента масштабированияс помощью двойного щелчка мышью(по умолчанию включена).

enableDragging() Включает возможностьперетаскивания карты с помощьюмыши (по умолчанию включена).

enableHotKeys(options) Включает горячие клавишидля функций масштабированияи сдвига карты (по умолчаниювыключены).


108


Имя Возвращает ОписаниеenableMagnifier(options) Включает возможность изменения

коэффициента масштабированиякарты посредством выделенияобласти на карте левой кнопкоймыши (по умолчанию выключена).

enableRightButtonMagnifier(options) Включает возможность выделенияобласти карты правой кнопкой(по умолчанию выключена).

enableRuler() Включает инструмент "Линейка"на карте (по умолчанию выключена).

enableScrollZoom(options) Включает возможность плавногомасштабирования карты колесоммыши (по умолчанию выключена).

getBalloon() YMaps.Balloon Возвращает указатель на открытыйбалун.

getBounds(unbounded) YMaps.ICoordBounds Возвращает текущие границывидимой области карты (viewport).

getCenter(unbounded) YMaps.ICoordPoint Возвращает текущие координатыцентра карты.

getContainer() HTMLElement Возвращает указатель на HTML-элемент, служащий контейнеромдля карты.

getContainerSize() YMaps.Size Возвращает размер HTML-контейнера, в котором размещенакарта.

getMaxZoom(bounds, layersOnly) Integer Возвращает максимальный коэффи-циент масштабирования карты, до-ступный для заданной области.

getMinZoom(bounds, layersOnly) Integer Возвращает минимальный коэффи-циент масштабирования карты, до-ступный для заданной области.

getRulerState() String Возвращает строковое представле-ние состояния инструмента "Линей-ка".

Если инструментом не было проста-влено ни одной метки на карте, то ме-тод вернет пустую строку. Если мет-ки были проставлены, то в строкебудут перечислены координаты про-ставленных меток, причем, для пер-вой метки географические координа-ты будут указаны целиком, а для всехостальных — заданы в виде смеще-ния относительно первой метки.В качестве разделителя меток ис-пользуется тильда (~).

getType() YMaps.MapType Возвращает текущий тип карты.

getZoom() Integer Возвращает текущий коэффициентмасштабирования карты.

hotKeysEnabled() Boolean Проверяет, включены ли горячиеклавиши для функциймасштабирования и сдвига карты.

magnifierEnabled() Boolean Проверяет, включенали возможность изменения масштабакарты посредством выделенияобласти левой кнопкой мыши.

moveBy(pixelsOffset, smooth, options) Смещает центр карты на заданное ко-личество пикселов.


109


Имя Возвращает ОписаниеopenBalloon(point, content, options) Показывает балун на карте.

panTo(toPoint, options) Плавно перемещает центр картыв заданную географическую точку.

redraw(smoothCentering) Перерисовывает карту.

removeAllOverlays() Удаляет все оверлеи с карты.

removeControl(control) Удаляет указанный элементуправления с карты.

removeCopyright(copyright) Удаляет строку с сообщениемоб авторском праве.

removeCursor(cursor) Удаляет с карты один из ранее добав-ленных курсоров.

removeLayer(layer) Удаляет слой с карты.

removeOverlay(overlay) Удаляет указанный оверлей с карты.

rightButtonMagnifierEnabled() Boolean Проверяет, включена ли функциявыделения области карты правойкнопкой.

rulerEnabled() Boolean Проверяет, включен ли инструмент"Линейка" на карте.

scrollZoomEnabled() Boolean Проверяет, включена ли функцияплавной прокрутки карты колесоммыши.

setBounds(geoBounds) Устанавливает центр картыи коэффициент масштабированиятак, чтобы заданная с помощьюобъекта YMaps.ICoordBoundsпрямоугольная область, была виднав окне карты максимально крупно.

setCenter(center, zoom, mapType) Устанавливает центр карты.

setMaxZoom(maxZoom) Устанавливает максимальныйкоэффициент масштабированиякарты.

setMinZoom(minZoom) Устанавливает минимальныйкоэффициент масштабированиякарты.

setRulerState(rulerState) Устанавливает состояниеинструмента "Линейка".

setType(mapType) Переключает карту на указанныйтип.

setZoom(zoom, options) Устанавливает коэффициентмасштабирования.

startMove(direction, options) Начинает плавный сдвиг карты в за-данном направлении и с заданной"скоростью".

stopMove() Останавливает плавный сдвиг карты.

update() Обновляет содержимое карты.

zoomBy(zoomDiff, options) Изменяет коэффициентмасштабирования картына определенную величину.

Подробное описание конструктораYMaps.Map(element, options)

Создает карту в указанном HTML-контейнере.


110


Параметры:

Имя Тип Необязательный По умолчанию Описаниеelement HTMLElement Указатель на DOM-

элемент, которыйпослужитконтейнеромдля карты.

options Object Опции карты.

options.ignoreResize

Boolean false true — игнорироватьсобытия, связанныес изменениемразмеров страницы,false —обрабатывать.

options.coordSystem

YMaps.ICoordSystem YMaps.GeoCoordSystem

Координатнаясистема карты.По умолчаниюпринята стандартнаягеографическаясистема координат.


converterYMaps.Converter converter

Преобразователь координат, см. YMaps.Converter.

coordSystemYMaps.ICoordSystem coordSystem

Система координат YMaps.ICoordSystem.

EventsObject Events

Список обрабатываемых событий карты.

hintYMaps.Hint hint

Всплывающая подсказка, см. YMaps.Hint.

tileCoordinatesYMaps.TileCoordinates tileCoordinates

Преобразователь пиксельных координат (рассчитаных при максимальном масштабе карты) в тайловые,см. YMaps.TileCoordinates.


AddLayerAddLayer

Добавление слоя на карту.


111



• указатель на карту;

• указатель на добавленный слой.

BeforeClickBeforeClick

Пред-событие, возникает непосредственно перед обработкой картой события щелчка мышью по карте.



• объект YMaps.MouseEvent.

BeforeContextMenuBeforeContextMenu

Пред-событие, возникает непосредственно перед обработкой картой события щелчка правой кнопкоймыши по карте.




BeforeDblClickBeforeDblClick

Пред-событие, возникает непосредственно перед обработкой картой события двойного щелчка мышьюпо карте.




BeforeDOMMouseScrollBeforeDOMMouseScroll

Пред-событие, возникает непосредственно перед обработкой картой события прокрутки колесом мыши.




BeforeMouseDownBeforeMouseDown

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





112


BeforeMouseMoveBeforeMouseMove

Пред-событие, возникает непосредственно перед обработкой картой события движения мышью.




BeforeMouseUpBeforeMouseUp

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




BoundsChangeBoundsChange

Изменение границ видимой области карты. В callback-функцию передается указатель на карту.

ClickClick

Щелчок мышью по карте.




ContextMenuContextMenu

Щелчок правой кнопкой мыши по карте.




DblClickDblClick

Двойной щелчок мышью по карте.





113


DestructDestruct

Карта удалена. В callback-функцию передается указатель на карту.

DOMMouseScrollDOMMouseScroll

Прокрутка колесом мыши.




MouseDownMouseDown

Нажатие кнопки мыши.




MouseMoveMouseMove

Движение мышью.




MouseUpMouseUp

Нажатая кнопка мыши отпущена.




MoveMove

Перетаскивание карты продолжается.В callback-функцию передаются два аргумента:


• объект YMaps.Point со значением смещения центра карты в пикселах относительно его предыдущегоположения.


114


MoveEndMoveEnd

Перетаскивание карты завершено. В callback-функцию передается указатель на карту.

MoveStartMoveStart

Начало перетаскивания карты. В callback-функцию передается указатель на карту.

RedrawRedraw

Произошла перерисовка карты, вследствие изменения размеров карты или ее положения на странице.В callback-функцию передается указатель на карту.

RemoveLayerRemoveLayer

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


• указатель на удаленный слой.

SmoothZoomEndSmoothZoomEnd

Окончание плавного масштабирования карты. В callback-функцию передается указатель на карту.

SmoothZoomStartSmoothZoomStart

Начало плавного масштабирования карты. В callback-функцию передается указатель на карту.

TypeChangeTypeChange

Смена типа карты. В callback-функцию передается указатель на карту.

UpdateUpdate

Перерисовка (обновление) карты (при изменении центра или коэффициента масштабирования).В callback-функцию передается указатель на карту.


addControladdControl(control, controlPosition)


115


Добавляет указанный элемент управления на карту.

Параметры:

Имя Тип Необязательный По умолчанию Описаниеcontrol YMaps.IControl Указатель

на добавляемыйэлемент управления.

controlPosition YMaps.ControlPosition

Расположениеэлемента управления.

addCopyrightaddCopyright(copyright)

Добавляет на карту строку с сообщением об авторском праве.

Параметры:

Имя Тип Описаниеcopyright String Строка с текстом сообщения

об авторском праве.

addCursoraddCursor(cursor)

Добавляет на карту новый курсор.

Разрешается добавлять на карту произвольное количество курсоров, но применяется только один (тот,который был добавлен последним). Список доступных курсоров приводится в описании объектаYMaps.Cursor.

Удалить курсор можно с помощью метода YMaps.Map.removeCursor.

Пример:

// Добавляет на тулбар кнопку "Помощь", при нажатии на которую курсор будет меняться на значок вопроса ("help").var toolBar = new YMaps.ToolBar(), helpButton = new YMaps.ToolBarToggleButton({ caption: 'Помощь' });toolBar.add(helpButton);YMaps.Events.observe(helpButton, helpButton.Events.Select, function () { map.addCursor(YMaps.Cursor.HELP);});YMaps.Events.observe(helpButton, helpButton.Events.Deselect, function () { map.removeCursor(YMaps.Cursor.HELP);});map.addControl(toolBar);

Параметры:

Имя Тип Описаниеcursor YMaps.Cursor Курсор.

addLayeraddLayer(layer)

Добавляет слой на карту.


116


Параметры:

Имя Тип Описаниеlayer YMaps.ILayer|String Слой, который нужно добавить

на карту. Слой может быть заданкак ключом, так и указателемна экземпляр.

addOverlayaddOverlay(overlay)

Добавляет оверлей на карту.

Параметры:

Имя Тип Описаниеoverlay YMaps.IOverlay Указатель на оверлей.

closeBalloon{Boolean} closeBalloon()

Закрывает балун, показываемый в данный момент на карте.


Тип ОписаниеBoolean true — балун закрыт.

dblClickZoomEnabled{Boolean} dblClickZoomEnabled()

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


Тип ОписаниеBoolean true — включена, false — выключена.

destructordestructor()

Удаляет карту и выбрасывает событие Destruct.

disableDblClickZoomdisableDblClickZoom()

Выключает возможность изменения коэффициента масштабирования с помощью двойного щелчкамышью (по умолчанию включена).

Двойной щелчок левой кнопкой — увеличить коэффициент масштабирования (+), правой кнопкой —уменьшить коэффициент масштабирования (-).

disableDraggingdisableDragging()


117


Выключает возможность перетаскивания карты с помощью мыши (по умолчанию включена).

disableHotKeysdisableHotKeys()

Выключает горячие клавиши для функций масштабирования и сдвига карты (по умолчанию выключе-ны).

disableMagnifierdisableMagnifier()

Выключает возможность изменения коэффициента масштабирования карты посредством выделенияобласти на карте левой кнопкой мыши (по умолчанию выключена).

disableRightButtonMagnifierdisableRightButtonMagnifier()

Выключает возможность выделения области карты правой кнопкой (по умолчанию выключена).

disableRulerdisableRuler()

Выключает инструмент "Линейка" на карте (по умолчанию выключен).

disableScrollZoomdisableScrollZoom()

Выключает возможность плавной прокрутки карты колесом мыши (по умолчанию выключена).

draggingEnabled{Boolean} draggingEnabled()

Проверяет, включена ли возможность перетаскивания карты с помощью мыши.



enableDblClickZoomenableDblClickZoom(options)

Включает возможность изменения коэффициента масштабирования с помощью двойного щелчкамышью (по умолчанию включена).

Двойной щелчок левой кнопкой — увеличить коэффициент масштабирования (+), правой кнопкой —уменьшить коэффициент масштабирования (-).

Параметры:

Имя Тип Необязательный По умолчанию Описаниеoptions Object Опции.

options.smooth Boolean true Плавноемасштабирование.


118


enableDraggingenableDragging()

Включает возможность перетаскивания карты с помощью мыши (по умолчанию включена).

enableHotKeysenableHotKeys(options)

Включает горячие клавиши для функций масштабирования и сдвига карты (по умолчанию выключены).

См.: "Горячие клавиши" (HotKeys)

Параметры:


options.smooth Boolean false Плавноемасштабирование.

enableMagnifierenableMagnifier(options)

Включает возможность изменения коэффициента масштабирования карты посредством выделения об-ласти на карте левой кнопкой мыши (по умолчанию выключена).

Параметры:



enableRightButtonMagnifierenableRightButtonMagnifier(options)

Включает возможность выделения области карты правой кнопкой (по умолчанию выключена).

Параметры:



enableRulerenableRuler()

Включает инструмент "Линейка" на карте (по умолчанию выключена).

enableScrollZoomenableScrollZoom(options)

Включает возможность плавного масштабирования карты колесом мыши (по умолчанию выключена).


119

http://api.yandex.ru/maps/jsapi/doc/dg/concepts/map_inner_controls.xml#map_inner_controls/hotkeys


Параметры:


options.smooth Boolean true true — применятьплавноемасштабированиекарты, false — нет.

getBalloon{YMaps.Balloon} getBalloon()

Возвращает указатель на открытый балун.


Тип ОписаниеYMaps.Balloon Указатель на открытый балун.

getBounds{YMaps.ICoordBounds} getBounds(unbounded)

Возвращает текущие границы видимой области карты (viewport).


Параметры:

Имя Тип Необязательный По умолчанию Описаниеunbounded Boolean false true — границы карты

заданынеограниченнымиточками, false —ограниченными.


Тип ОписаниеYMaps.ICoordBounds Границы видимой области карты.

getCenter{YMaps.ICoordPoint} getCenter(unbounded)

Возвращает текущие координаты центра карты.


Параметры:

Имя Тип Необязательный По умолчанию Описаниеunbounded Boolean false true — центр карты

заданнеограниченнойточкой, false —ограниченной.


120





Тип ОписаниеYMaps.ICoordPoint Координаты центра карты.

getContainer{HTMLElement} getContainer()

Возвращает указатель на HTML-элемент, служащий контейнером для карты.


Тип ОписаниеHTMLElement Указатель на HTML-элемент, служащий контейнером для карты.

getContainerSize{YMaps.Size} getContainerSize()

Возвращает размер HTML-контейнера, в котором размещена карта.


Тип ОписаниеYMaps.Size Размер HTML-контейнера, в котором размещена карта.

getMaxZoom{Integer} getMaxZoom(bounds, layersOnly)

Возвращает максимальный коэффициент масштабирования карты, доступный для заданной области.

Если не задан параметр layersOnly, то максимальный коэффициент масштабирования рассчитываетсяследующим образом: берется максимальный из всех текущих коэффициентов масштабирования слоевкарты, затем расширяется значением maxZoom из YMaps.MapType, а затем ограничивается значением,заданным в YMaps.Map.setMaxZoom и максимальным масштабом текущей координатной системы.

Параметры:

Имя Тип Необязательный По умолчанию Описаниеbounds YMaps.ICoordBound

sОбласть, для которойтребуется расчитатьмаксимальныймасштаб.По умолчаниюберется текущаявидимая область.

layersOnly Boolean false Использовать толькоданные по слоям,игнорируядополненияи ограничения.


Тип ОписаниеInteger Коэффициент масштабирования карты или null, если установлен флаг

layersOnly и данные по слоям не были найдены.


121


getMinZoom{Integer} getMinZoom(bounds, layersOnly)

Возвращает минимальный коэффициент масштабирования карты, доступный для заданной области.

Если не задан параметр layersOnly, то минимальный коэффициент масштабирования рассчитываетсяследующим образом: берется минимальный из всех текущих коэффициентов масштабирования слоевкарты, затем расширяется значением minZoom из YMaps.MapType, а затем ограничивается значением,заданным в YMaps.Map.setMinZoom и 0.

Параметры:

Имя Тип Необязательный По умолчанию Описаниеbounds YMaps.ICoordBound

sОбласть, для которойтребуется расчитатьминимальныймасштаб.По умолчаниюберется текущаявидимая область.

layersOnly Boolean false Использовать толькоданные по слоям,игнорируядополненияи ограничения.


Тип ОписаниеInteger Коэффициент масштабирования карты или null, если установлен флаг

layersOnly и данные по слоям не были найдены.

getRulerState{String} getRulerState()

Возвращает строковое представление состояния инструмента "Линейка".

Если инструментом не было проставлено ни одной метки на карте, то метод вернет пустую строку. Еслиметки были проставлены, то в строке будут перечислены координаты проставленных меток, причем,для первой метки географические координаты будут указаны целиком, а для всех остальных — заданыв виде смещения относительно первой метки. В качестве разделителя меток используется тильда (~).


Тип ОписаниеString Состояние инструмента "Линейка".

getType{YMaps.MapType} getType()

Возвращает текущий тип карты.


Тип ОписаниеYMaps.MapType Текущий тип карты.


122


getZoom{Integer} getZoom()

Возвращает текущий коэффициент масштабирования карты.


Тип ОписаниеInteger Коэффициент масштабирования карты.

hotKeysEnabled{Boolean} hotKeysEnabled()

Проверяет, включены ли горячие клавиши для функций масштабирования и сдвига карты.


Тип ОписаниеBoolean true — включены, false — выключены.

magnifierEnabled{Boolean} magnifierEnabled()

Проверяет, включена ли возможность изменения масштаба карты посредством выделения области левойкнопкой мыши.


Тип ОписаниеBoolean true — включена, false — нет.

moveBymoveBy(pixelsOffset, smooth, options)

Смещает центр карты на заданное количество пикселов.

В зависимости от параметров вызова смещение может происходить плавно или за один шаг. Скорость —это дистанция в пикселах, которую преодолевает карта на каждом шаге плавного движения.

Примечание:Следует инициализировать карту перед использованием данного метода.

Пример:

// Смещает центр карты на северо-северо-запад, по окончании смещения открывает балун.map.moveBy(new YMaps.Point(1000,-2000), true, { speed: 20, startSpeed: 10, speedUpTime: 200, callback: function (state) { if (state == YMaps.State.SUCCESS) { map.openBalloon(map.getCenter(), 'Приехали!'); } }});


123


Параметры:

Имя Тип Необязательный По умолчанию ОписаниеpixelsOffset YMaps.Point Величина сдвига


smooth Boolean false true — смещениепроисходит плавно,false — за один шаг.

options Object Параметрысмещения.

options.speed Number 37 Итоговая скорость.

options.startSpeed

Number 5 Начальная скорость.

options.speedUpTime

Number 120 Время разгона(в миллисекундах).

options.callback

Function Функция-обработчикдля событияокончания смещениякарты. Параметромпередается результат,если успешноYMaps.State.SUCCESS, если нет —YMaps.State.FAILURE.

openBalloonopenBalloon(point, content, options)

Показывает балун на карте.

Пример:

// Показывает балун в центре Москвы.map.openBalloon(new YMaps.GeoPoint(37.616485,55.751635), 'Москва', {hasCloseButton: false, mapAutoPan: 0});

Параметры:

Имя Тип Необязательный По умолчанию Описаниеpoint YMaps.ICoordPoint Координаты

"хвостика" балунана карте.

content HTMLElement | String Содержимое балуна(может бытькак текстом, так иуказателем на HTML-элемент).

options YMaps.MapBalloonOptions


panTopanTo(toPoint, options)

Плавно перемещает центр карты в заданную географическую точку. Если расстояние между текущимцентром и заданной точкой в три раза больше размера карты, то функция работает как setCenter, либоимитирует полет из одной точки в другую (если flying = true).


124


Параметры:

Имя Тип Необязательный По умолчанию ОписаниеtoPoint YMaps.ICoordPoint|

YMaps.ICoordPoint[]Координаты точки,в которую долженпереместиться центр.карты. Если переданмассив точек,то центр карты будетперемещаться в нихпоследовательно.

options Object Параметрыперемещения.

options.flying Boolean false Использоватьимитацию полета,если расстояниемежду центром картыи заданной точкойпревышает размеркарты более чем втри раза.

options.callback

Function Обработчик событияокончанияперемещения.Параметромпередается результат,если успешноYMaps.State.SUCCESS, если нет —YMaps.State.FAILURE.

redrawredraw(smoothCentering)

Перерисовывает карту.

Необходимо вызывать каждый раз при программном изменении размера карты или ее положенияна странице. Самостоятельно отслеживает случаи изменения размеров самой страницы с картой (этавозможность отключается опцией карты ignoreResize).

Параметры:

Имя Тип Необязательный По умолчанию ОписаниеsmoothCentering Boolean true true — плавно

сдвигать карту так,чтобыгеографическиекоординатыее центра послеизменения размеровоставалисьпрежними. false —не сдвигать карту.

removeAllOverlaysremoveAllOverlays()

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


125


removeControlremoveControl(control)

Удаляет указанный элемент управления с карты.

Параметры:

Имя Тип Описаниеcontrol YMaps.IControl Указатель на удаляемый элемент

управления.

removeCopyrightremoveCopyright(copyright)

Удаляет строку с сообщением об авторском праве.

Параметры:

Имя Тип Описаниеcopyright String Строка с текстом сообщения

об авторском праве.

removeCursorremoveCursor(cursor)

Удаляет с карты один из ранее добавленных курсоров.

Если удаляемый курсор является активным, то активным становится предыдущий добавленный (и неудаленный) курсор. Если было добавлено несколько курсоров с одним именем, то удаляется тот, которыйбыл добавлен позже других.

Параметры:

Имя Тип Описаниеcursor YMaps.Cursor Курсор.

removeLayerremoveLayer(layer)

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

Параметры:

Имя Тип Описаниеlayer YMaps.ILayer|String Слой карты, который нужно удалить.

Слой может быть задан как ключом,так и указателем на экземпляр.

removeOverlayremoveOverlay(overlay)

Удаляет указанный оверлей с карты.


126


Параметры:

Имя Тип Описаниеoverlay YMaps.IOverlay Указатель на оверлей.

rightButtonMagnifierEnabled{Boolean} rightButtonMagnifierEnabled()

Проверяет, включена ли функция выделения области карты правой кнопкой.



rulerEnabled{Boolean} rulerEnabled()

Проверяет, включен ли инструмент "Линейка" на карте.


Тип ОписаниеBoolean true — включен, false — выключен.

scrollZoomEnabled{Boolean} scrollZoomEnabled()

Проверяет, включена ли функция плавной прокрутки карты колесом мыши.



setBoundssetBounds(geoBounds)

Устанавливает центр карты и коэффициент масштабирования так, чтобы заданная с помощью объектаYMaps.ICoordBounds прямоугольная область, была видна в окне карты максимально крупно.

Параметры:

Имя Тип ОписаниеgeoBounds YMaps.ICoordBounds Границы, которые необходимо

установить карте.

setCentersetCenter(center, zoom, mapType)

Устанавливает центр карты.


127


Параметры:

Имя Тип Необязательный По умолчанию Описаниеcenter YMaps.ICoordPoint Координаты центра

карты.

zoom Integer Коэффициентмасштабирования.

mapType YMaps.MapType Тип карты.

setMaxZoomsetMaxZoom(maxZoom)

Устанавливает максимальный коэффициент масштабирования карты.

Параметры:

Имя Тип ОписаниеmaxZoom Integer Максимальный коэффициент

масштабирования.

setMinZoomsetMinZoom(minZoom)

Устанавливает минимальный коэффициент масштабирования карты.

Параметры:

Имя Тип ОписаниеminZoom Integer Минимальный коэффициент


setRulerStatesetRulerState(rulerState)

Устанавливает состояние инструмента "Линейка".

Параметры:

Имя Тип ОписаниеrulerState String Строковое представление состояния

инструмента "Линейка".

setTypesetType(mapType)

Переключает карту на указанный тип.

Параметры:

Имя Тип ОписаниеmapType YMaps.MapType Тип карты.

setZoomsetZoom(zoom, options)

Устанавливает коэффициент масштабирования.


128


Параметры:

Имя Тип Необязательный По умолчанию Описаниеzoom Integer Коэффициент


options Object Опции.

options.smooth Boolean false Флаг, указывающий,что масштабирование должнопроисходить плавно.

options.position

YMaps.ICoordPoint Позиция,сохраняемаяпри плавнойустановкекоэффициентамасштабирования.

options.centering

Boolean false Флаг, указывающий,что по окончаниюплавногомасштабирования,позиция заданнаяв options.positionдолжна совпадатьс центром карты.

options.callback

Function Обработчикокончания изменениякоэффициентамасштабирования.Параметромпередается результат,если успешноYMaps.State.SUCCESS, если нет —YMaps.State.FAILURE.

startMovestartMove(direction, options)

Начинает плавный сдвиг карты в заданном направлении и с заданной "скоростью".

Скорость движения карты — это дистанция в пикселах, которую преодолевает карта за каждый шаг плав-ного сдвига.

Внимание!Перед использованием данного метода следует инициализировать карту.

Пример:

// Плавно сдвигает центр карты по направлению на юго-юго-запад, по окончании сдвига открывает балун.map.startMove(new YMaps.Point(1,2), { speed: 20, startSpeed: 10, speedUpTime: 200, callback: function() { if (state == YMaps.State.SUCCESS) { map.openBalloon(map.getCenter(), 'Приехали!'); } }});


129


// Остановка через 3 секунды.window.setTimeout(function(){ map.stopMove(); }, 3000);

Параметры:

Имя Тип Необязательный По умолчанию Описаниеdirection YMaps.Point Вектор направления

сдвига.

options Object Параметрыдвижения.

options.speed Number 37 Конечная скоростьразгона.

options.startSpeed

Number 5 Начальная скоростьразгона.

options.speedUpTime

Number 120 Время разгона картыдо конечной скорости(в миллисекундах).

options.callback

Function Обработчик событияокончания сдвигакарты. Параметромпередается результат,если успешноYMaps.State.SUCCESS, если нет —YMaps.State.FAILURE.

stopMovestopMove()

Останавливает плавный сдвиг карты. Перед использованием данного метода следует инициализироватькарту.

updateupdate()

Обновляет содержимое карты.

zoomByzoomBy(zoomDiff, options)

Изменяет коэффициент масштабирования карты на определенную величину.

Параметры:

Имя Тип Необязательный По умолчанию ОписаниеzoomDiff Integer Величина,

на которуюизменяетсякоэффициентмасштабирования.


options.smooth Boolean false Флаг, указывающий,что масштабирование должнопроисходить плавно.

options.position

YMaps.ICoordPoint Позиция,сохраняемаяпри плавной


130


Имя Тип Необязательный По умолчанию Описаниеустановкекоэффициентамасштабирования.

options.centering

Boolean false Флаг, указывающий,что по окончаниюплавногомасштабирования,позиция заданнаяв options.positionдолжна совпадатьс центром карты.

options.callback

Function Обработчикокончания изменениякоэффициентамасштабирования.Параметромпередается результат,если успешноYMaps.State.SUCCESS, если нет —YMaps.State.FAILURE.

YMaps.MapBalloonOptionsРасширяет YMaps.BalloonOptions.

Класс содержит опции, используемые при открытии балуна с помощью методаYMaps.Map.openBalloon.


ПоляИмя ОписаниеlayoutContext Контекст для построения макета балуна.

onClose Пользовательский обработчик закрытия балуна.

Наследуемые поляИз YMaps.BalloonOptions:

hasCloseButton, mapAutoPan, margin, maxHeight, maxWidth, style


layoutContextObject layoutContext

Контекст для построения макета балуна.

onCloseFunction onClose

Пользовательский обработчик закрытия балуна. По умолчанию отсутствует.


131


YMaps.MapHintOptionsРасширяет YMaps.HintOptions.

Класс содержит опции, которые используются при управлении всплывающей подсказкой с помощьюметодов класса YMaps.Hint.


ПоляИмя ОписаниеlayoutContext Задает контекст для построения макета всплывающей подсказки.

onHide Задает пользовательский обработчик, вызываемый по событию закрытиявсплывающей подсказки.

Наследуемые поляИз YMaps.HintOptions:

holdOnMouseOver, maxHeight, maxWidth, offset


layoutContextObject layoutContext

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

onHideFunction onHide

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

YMaps.MapTypeКласс для создания типа карты.

КонструкторИмя ОписаниеYMaps.MapType(layers, name, options) Создает тип карты.


еОписание

HYBRID Тип карты — "Гибрид".

MAP Тип карты — "Схема".

SATELLITE Тип карты — "Спутник".


132


МетодыИмя Возвращает ОписаниеgetLayers() String[]|YMaps.ILayer[] Возвращает список слоев, входящих

в тип карты.

getMaxZoom() Integer Возвращает максимальное значениекоэффициента масштабирования.

getMinZoom() Integer Возвращает минимальное значениекоэффициента масштабирования.

getName() String Возвращает имя типа карты,отображаемое в переключателетипов YMaps.TypeControl.

getTextColor() String Возвращает цвет текста. Этот цветбудет применен к копирайтам.

Подробное описание конструктораYMaps.MapType(layers, name, options)

Создает тип карты.

Параметры:

Имя Тип Необязательный По умолчанию Описаниеlayers String[]|

YMaps.ILayer[]Список слоев,входящих в типкарты. Слой можетбыть заданкак ключом, так иуказателемна экземпляр слоя.Если какой-тотип планируетсяиспользоватьв нескольких картаходновременно, то длякаждого слоя картытакого типанеобходимо создатьотдельный класс,поместить его вхранилищеYMaps.Layers, а впараметре layersуказать ключ,под которым классслоя был помещенв хранилище.

name String Имя типа карты.Отображаетсяв переключателетиповYMaps.TypeControl.

options Object

options.textColor

String #000000 Цвет текстав шестизначномили трехзначномшестнадцатеричномRGB-формате('#rrggbb' или '#rgb').Этот же цветприменяется к тексту


133


Имя Тип Необязательный По умолчанию Описаниестроки об авторскомправе.

options.minZoom Integer null Минимальноезначениекоэффициентамасштабирования.Если null,то параметрне учитывается.

options.maxZoom Integer null Максимальноезначениекоэффициентамасштабирования.Если null,то параметрне учитывается.


HYBRIDHYBRID

Тип карты — "Гибрид".

MAPMAP

Тип карты — "Схема".

SATELLITESATELLITE

Тип карты — "Спутник".


getLayers{String[]|YMaps.ILayer[]} getLayers()

Возвращает список слоев, входящих в тип карты.


Тип ОписаниеString[]|YMaps.ILayer[] Список слоев, входящих в тип карты.

getMaxZoom{Integer} getMaxZoom()

Возвращает максимальное значение коэффициента масштабирования.


Тип ОписаниеInteger Максимальное коэффициента масштабирования.


134


getMinZoom{Integer} getMinZoom()

Возвращает минимальное значение коэффициента масштабирования.


Тип ОписаниеInteger Минимальное значение коэффициента масштабирования.

getName{String} getName()

Возвращает имя типа карты, отображаемое в переключателе типов YMaps.TypeControl.


Тип ОписаниеString Имя типа карты.

getTextColor{String} getTextColor()

Возвращает цвет текста. Этот цвет будет применен к копирайтам.


Тип ОписаниеString Цвет текста.

YMaps.MiniMapРасширяет YMaps.IControl.

Элемент управления "Обзорная карта".

КонструкторИмя ОписаниеYMaps.MiniMap(zoomOffset) Создает обзорную карту (уменьшенную карту показываемой местности,

коэффициент масштабирования которой на несколько пунктов меньшеосновной карты).

МетодыИмя Возвращает ОписаниеgetType() YMaps.MapType Возвращает текущий тип обзорной

карты.

getVisible() Boolean Проверяет текущий статус обзорнойкарты (видима/скрыта).

setType(mapType) Переключает тип обзорной карты.

setVisible(visible) Устанавливает статус показаобзорной карты (видима/скрыта).


135


Наследуемые методыИз YMaps.IControl:

onAddToMap, onRemoveFromMap

Подробное описание конструктораYMaps.MiniMap(zoomOffset)

Создает обзорную карту (уменьшенную карту показываемой местности, коэффициент масштабированиякоторой на несколько пунктов меньше основной карты). Положение обзорной карты по умолчаниюYMaps.ControlPosition.BOTTOM_LEFT.

Параметры:

Имя Тип Необязательный По умолчанию ОписаниеzoomOffset Integer 5 Смещение

коэффициентамасштабированияобзорной картыотносительнокоэффициентамасштабированияосновной.


getType{YMaps.MapType} getType()

Возвращает текущий тип обзорной карты.


Тип ОписаниеYMaps.MapType Текущий тип карты.

getVisible{Boolean} getVisible()

Проверяет текущий статус обзорной карты (видима/скрыта).


Тип ОписаниеBoolean true — обзорная карта видима, false — скрыта.

setTypesetType(mapType)

Переключает тип обзорной карты.

Параметры:

Имя Тип ОписаниеmapType YMaps.MapType Тип обзорной карты.


136


setVisiblesetVisible(visible)

Устанавливает статус показа обзорной карты (видима/скрыта).

Параметры:

Имя Тип Описаниеvisible Boolean true — обзорная карта видима,

false — скрыта.

YMaps.MouseEventСобытие мыши на карте. Объект передается в обработчики событий мыши на карте.

КонструкторИмя ОписаниеYMaps.MouseEvent(e, map) Создает объект события мыши на карте.

МетодыИмя Возвращает ОписаниеgetCoordPoint(unbounded) YMaps.ICoordPoint Возвращает географические

координаты места события на карте.

getEvent() DOMEvent Возвращает указательна произошедшее DOM-событие.

getGeoPoint(unbounded) YMaps.ICoordPoint То же, чтои YMaps.MouseEvent.getCoordPoint.

getLocalPixels() YMaps.Point Возвращает локальные пиксельныекоординаты события на карте.

isMapEventPrevented() Boolean Возвращает true, если для текущегособытия мыши действие картыпо умолчанию подавлено с помощьюметодаYMaps.MouseEvent.preventMapEvent, в противном случае — false.

preventMapEvent() Подавляет генерацию события картыпо умолчанию для указанногособытия мыши, при этомсоответствующее пред-событиене подавляется. Вызов методаприводит к отмене действия картыпо умолчанию для указанногособытия.

Подробное описание конструктораYMaps.MouseEvent(e, map)

Создает объект события мыши на карте.


137


Параметры:

Имя Тип Описаниеe DOMEvent|Object Указатель на событие мыши. Может

быть как DOM-событием, так иобъектом-событием jQuery.

map YMaps.Map Карта, на которой произошлособытие.


getCoordPoint{YMaps.ICoordPoint} getCoordPoint(unbounded)

Возвращает географические координаты места события на карте.

Параметры:

Имя Тип Необязательный По умолчанию Описаниеunbounded Boolean false Флаг, указывающий

тип возвращаемойточки: ограниченнаяили нет.


Тип ОписаниеYMaps.ICoordPoint Географические координаты места события на карте.

getEvent{DOMEvent} getEvent()

Возвращает указатель на произошедшее DOM-событие.


Тип ОписаниеDOMEvent Указатель на DOM-событие.

getGeoPoint{YMaps.ICoordPoint} getGeoPoint(unbounded)

То же, что и YMaps.MouseEvent.getCoordPoint.

Параметры:

Имя Тип Необязательный По умолчанию Описаниеunbounded Boolean false Флаг, указывающий

тип возвращаемойточки: ограниченнаяили нет.


Тип ОписаниеYMaps.ICoordPoint Координаты точки места события.


138


getLocalPixels{YMaps.Point} getLocalPixels()

Возвращает локальные пиксельные координаты события на карте.


Тип ОписаниеYMaps.Point Локальные пиксельные координаты события на карте.

isMapEventPrevented{Boolean} isMapEventPrevented()

Возвращает true, если для текущего события мыши действие карты по умолчанию подавлено с помощьюметода YMaps.MouseEvent.preventMapEvent, в противном случае — false.

См.: YMaps.MouseEvent.preventMapEvent


Тип ОписаниеBoolean true — генерация события карты по умолчанию отменена, false —

не отменена.

preventMapEventpreventMapEvent()

Подавляет генерацию события карты по умолчанию для указанного события мыши, при этом соответ-ствующее пред-событие не подавляется. Вызов метода приводит к отмене действия карты по умолчаниюдля указанного события.

Пример:

// Подавление события мыши click.// По умолчанию событию мыши click соответствует событие карты YMaps.Map.Events.Click. // После вызова метода preventMapEvent для события click будет подавляться// генерация события YMaps.Map.Events.Click и карта перестанет отвечать на щелчки мышью.// При этом, по каждому щелчку мыши по-прежнему будет генерироваться пред-событие YMaps.Map.Events.BeforeClick.

YMaps.ObjectManagerРасширяет YMaps.IOverlay.

Диспетчер объектов, предназначенный для управления видимостью меток на карте.Объект YMaps.ObjectManager позволяет скрывать и показывать метки на карте, в зависимости от теку-щего коэффициента масштабирования и видимой области карты. Диспетчер позволяет одновременноуправлять большим количеством объектов, обеспечивая приемлемую производительность.

Принцип работы диспетчера:

Карта мира покрывается виртуальной сеткой с квадратными ячейками заданного размера. Объекты, ко-торыми управляет YMaps.ObjectManager, помещаются в ячейки, соответствующие их положениюна карте. При перетаскивании карты и/или смене масштаба отображаются объекты только из тех ячеек,которые оказываются в пределах текущей видимой области карты. Объекты из остальных ячеек скры-ваются.


139


Для кэширования объектов, находящихся вблизи границ видимой области, но за ее пределами, можнорасширить границы области управления диспетчера на необходимое расстояние.

См.: Диспетчер объектов

КонструкторИмя ОписаниеYMaps.ObjectManager(options) Создает диспетчер для управления видимостью меток на карте.

МетодыИмя Описаниеadd(object, minZoom, maxZoom) Добавляет метку или массив меток в диспетчер.

remove(object) Удаляет метку из диспетчера объектов.

removeAll() Удаляет все метки и сбрасывает состояние.



Подробное описание конструктораYMaps.ObjectManager(options)

Создает диспетчер для управления видимостью меток на карте.

См.: Диспетчер объектов

Параметры:

Имя Тип Необязательный По умолчанию Описаниеoptions Object Опции диспетчера

объектов.

options.cellSize

Number 256 Размер ячейкивиртуальной сетки(в пикселах).

options.padding Number 100 Расстояниеот видимых границкарты (в пикселах),на которое требуетсяотодвинуть границыобласти управлениядиспетчера.

options.trackObjects

Boolean true true — обрабатыватьизменение координатобъектов на картеи пересчитыватьусловияих видимости,false — нет.


addadd(object, minZoom, maxZoom)


140

http://api.yandex.ru/maps/jsapi/doc/dg/concepts/objects_manager.xml

http://api.yandex.ru/maps/jsapi/doc/dg/concepts/objects_manager.xml


Добавляет метку или массив меток в диспетчер. Если в момент вызова метода ячейка сетки, в которуюпопала добавляемая метка, отображается на карте, то и метка будет отображаться.

Параметры:

Имя Тип Необязательный По умолчанию Описаниеobject YMaps.Placemark|

YMaps.Placemark[]Добавляемая меткаили массив меток.

minZoom Number 0 Минимальноезначениекоэффициентамасштабирования,при котором меткабудет видна.

maxZoom Number Infinity Максимальноезначениекоэффициентамасштабирования,при котором меткабудет видна.

removeremove(object)

Удаляет метку из диспетчера объектов. Метка будет удалена, если в момент вызова метода ячейка сетки,в которой находится удаляемая метка отображается на карте,

Параметры:

Имя Тип Описаниеobject YMaps.Placemark|

YMaps.Placemark[]Ссылка на удаляемую метку.

removeAllremoveAll()

Удаляет все метки и сбрасывает состояние.

YMaps.OverlayGroupРасширяет YMaps.Group, YMaps.IOverlay.

Класс для создания группы объектов, привязанных к карте.

КонструкторИмя ОписаниеYMaps.OverlayGroup() Конструктор группы объектов оверлея.


Events


Add, Remove


141


МетодыИмя Возвращает ОписаниеgetMap() YMaps.Map Возвращает указатель на карту,

в которую добавлена группа.

getParentContainer() HTMLElement Возвращает указательна родительский контейнер.

Наследуемые методыИз YMaps.Group:



Подробное описание конструктораYMaps.OverlayGroup()

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



Возвращает указатель на карту, в которую добавлена группа.


Тип ОписаниеYMaps.Map Указатель на карту, в которую добавлена группа.

getParentContainer{HTMLElement} getParentContainer()

Возвращает указатель на родительский контейнер.


Тип ОписаниеHTMLElement Указатель на родительский контейнер.

YMaps.PlacemarkРасширяет YMaps.IInteractiveGeoObject, YMaps.IOverlay.

Метка на карте.См.: Метки

КонструкторИмя ОписаниеYMaps.Placemark(coordPoint, options) Создает метку в точке с заданными географическими координатами.


142

http://api.yandex.ru/maps/jsapi/doc/dg/concepts/markers.xml


ПоляИмя ОписаниеEvents Список обрабатываемых событий метки.



СобытияИмя ОписаниеBalloonClose Закрытие балуна метки.

BalloonOpen Открытие балуна метки.

Click Щелчок мышью по метке.

DblClick Двойной щелчок мышью по метке.

Drag Продолжается перетаскивание метки.

DragEnd Закончено перетаскивание метки.

DragStart Началось перетаскивание метки (если разрешено).

MouseEnter Курсор наведен на значок метки.

MouseLeave Курсор убран со значка метки.

MouseMove Движение курсора мышкой в пределах значка метки.

PositionChange Изменено местоположение метки (например, с помощью функцииYMaps.Placemark.setGeoPoint).

МетодыИмя Возвращает ОписаниеgetCoordPoint() YMaps.ICoordPoint Возвращает точку координатной

системы, к которой привязана метка.

getGeoPoint() YMaps.ICoordPoint То же, чтои YMaps.Placemark.getCoordPoint

getIconContent() String|HTMLElement|YMaps.ILayout Возвращает содержимое значкаметки, установленное с помощьюметодаYMaps.Placemark.setIconContent.

getMap() YMaps.Map Возвращает указатель на карту,в которую добавлена метка.

getOptions() YMaps.PlacemarkOptions Возвращает опции метки.

getParentContainer() HTMLElement Возвращает указательна родительский контейнер.

setCoordPoint(coordPoint) Устанавливает точку координатнойсистемы, к которой привязана метка.

setGeoPoint(coordPoint) То же, чтои YMaps.Placemark.setCoordPoint.


143


Имя Возвращает ОписаниеsetIconContent(content) Устанавливает содержимое значка

метки.

setOptions(options, restoreDefault) Устанавливает опции метки.


onAddToMap, onMapUpdate, onRemoveFromMapИз YMaps.IInteractiveGeoObject:

closeBalloon, getBalloon, getBalloonContent, getBalloonOptions, getHintContent, getHintOptions,openBalloon, setBalloonContent, setBalloonOptions, setHintContent, setHintOptions, update


Подробное описание конструктораYMaps.Placemark(coordPoint, options)

Создает метку в точке с заданными географическими координатами.

См.: Метки

Пример:

// Задает опции метки и отображает метку на карте.var placemark = new YMaps.Placemark(new YMaps.GeoPoint(37, 55), {draggable: 1, hintOptions: { maxWidth: 100, showTimeout: 200, offset: new YMaps.Point(5, 5) }, balloonOptions: { maxWidth: 70, hasCloseButton: false, mapAutoPan: 0 }});placemark.name = "Название";placemark.description = "Описание";map.addOverlay(placemark);

Параметры:

Имя Тип Необязательный По умолчанию ОписаниеcoordPoint YMaps.ICoordPoint Географические

координаты метки.

options YMaps.PlacemarkOptions

Опции метки.


EventsObject Events

Список обрабатываемых событий метки.


144

http://api.yandex.ru/maps/jsapi/doc/dg/concepts/markers.xml



BalloonCloseBalloonClose

Закрытие балуна метки.

В callback-функцию передается указатель на метку, для которой был вызван обработчик.

BalloonOpenBalloonOpen

Открытие балуна метки.


ClickClick

Щелчок мышью по метке.


• указатель на метку, для которой был вызван обработчик;

• указатель на объект события мыши YMaps.MouseEvent.

DblClickDblClick

Двойной щелчок мышью по метке.




DragDrag

Продолжается перетаскивание метки.


DragEndDragEnd

Закончено перетаскивание метки.


DragStartDragStart

Началось перетаскивание метки (если разрешено).



145


MouseEnterMouseEnter

Курсор наведен на значок метки.




MouseLeaveMouseLeave

Курсор убран со значка метки.




MouseMoveMouseMove

Движение курсора мышкой в пределах значка метки.




PositionChangePositionChange

Изменено местоположение метки (например, с помощью функции YMaps.Placemark.setGeoPoint).



• объект с полями:

• oldPoint — старая географическая позиция,

• newPoint — новая географическая позиция.


getCoordPoint{YMaps.ICoordPoint} getCoordPoint()

Возвращает точку координатной системы, к которой привязана метка.


Тип ОписаниеYMaps.ICoordPoint Точку координатной системы, к которой привязана метка.


146


getGeoPoint{YMaps.ICoordPoint} getGeoPoint()

То же, что и YMaps.Placemark.getCoordPoint


Тип ОписаниеYMaps.ICoordPoint Точку координатной системы, к которой привязана метка.

getIconContent{String|HTMLElement|YMaps.ILayout} getIconContent()

Возвращает содержимое значка метки, установленное с помощью методаYMaps.Placemark.setIconContent.


Тип ОписаниеString|HTMLElement|YMaps.ILayout Содержимое значка метки.


Возвращает указатель на карту, в которую добавлена метка.


Тип ОписаниеYMaps.Map Указатель на карту, в которую добавлена метка.

getOptions{YMaps.PlacemarkOptions} getOptions()

Возвращает опции метки.


Тип ОписаниеYMaps.PlacemarkOptions Объект опций.

getParentContainer{HTMLElement} getParentContainer()

Возвращает указатель на родительский контейнер.


Тип ОписаниеHTMLElement Указатель на родительский контейнер.

setCoordPointsetCoordPoint(coordPoint)

Устанавливает точку координатной системы, к которой привязана метка.


147


Параметры:

Имя Тип ОписаниеcoordPoint YMaps.ICoordPoint Новая точка координатной системы,

к которой привязана метка.

setGeoPointsetGeoPoint(coordPoint)

То же, что и YMaps.Placemark.setCoordPoint.

Параметры:

Имя Тип ОписаниеcoordPoint YMaps.ICoordPoint Новая точка координатной системы,

к которой привязана метка.

setIconContentsetIconContent(content)

Устанавливает содержимое значка метки.

Содержимое значка, установленное с помощью этого метода, имеет приоритет перед содержимым, соз-данным с использованием текущего стиля.

Примечание:Метки с содержимым отображаются медленнее пустых.

Параметры:

Имя Тип Описаниеcontent String|HTMLElement|YMaps.ILayout Содержимое значка метки (строка,

DOM-элемент или макет).


Устанавливает опции метки.

Параметры:

Имя Тип Необязательный По умолчанию Описаниеoptions YMaps.PlacemarkOpt

ionsОбъект опций.


YMaps.PlacemarkOptionsРасширяет YMaps.InteractiveGeoObjectOptions.



148



Пример:

// Задает опции метки и отображает метку на карте.var options = { draggable: true, hasBalloon: false, hintOptions: { maxWidth: 100, offset: new YMaps.Point(5, 5) }};var placemark = new YMaps.Placemark(new YMaps.GeoPoint(37, 55), options);map.addOverlay(placemark);

ПоляИмя Описаниеdraggable Разрешает/запрещает перетаскивание метки: true — разрешено, false —

запрещено (по умолчанию).

hideIcon Разрешает/запрещает автоматически скрывать значок меткипри открытии ее балуна: true — скрывать значок (по умолчанию), false —не скрывать.

Наследуемые поляИз YMaps.InteractiveGeoObjectOptions:

balloonOptions, hasBalloon, hasHint, hintOptions, interactive, style


draggableBoolean draggable

Разрешает/запрещает перетаскивание метки: true — разрешено, false — запрещено (по умолчанию).

hideIconBoolean hideIcon

Разрешает/запрещает автоматически скрывать значок метки при открытии ее балуна: true — скрыватьзначок (по умолчанию), false — не скрывать.

YMaps.PointРасширяет YMaps.ICoordPoint.

Класс точки в двумерном эвклидовом пространстве. Используется для представления пиксельных коор-динат.

КонструкторИмя ОписаниеYMaps.Point(x, y) Создает объект точки в двумерном эвклидовом пространстве.


149


ПоляИмя Описаниеx Координата точки по оси x.

y Координата точки по оси y.

МетодыИмя Статический Возвращает Описаниеapply(func) YMaps.Point Последовательно

применяет к значениямкоординат точкиуказанную функцию.

applyX(func) YMaps.Point Применяет к значениюкоординаты x переданнуюфункцию.

applyY(func) YMaps.Point Применяет к значениюкоординаты y переданнуюфункцию.

equals(point) Boolean Сравнивает две точки:точку, заданнуюпараметром point и точку,для которой вызываетсяметод.

fromString(string) YMaps.Point Создает точку по еестроковомупредставлению.

moveByX(dx) YMaps.Point Сдвигает точку по оси x.

moveByY(dy) YMaps.Point Сдвигает точку по оси y.

moveToX(x) YMaps.Point Устанавливает значениекоординаты x.

moveToY(y) YMaps.Point Устанавливает значениекоординаты y.

neg() YMaps.Point Инвертирует знаку значений координат.

scale(scaleCoef) YMaps.Point Масштабирует значениякоординат точки по обеимосям.

scaleX(scaleCoef) YMaps.Point Масштабирует значениекоординаты x.

scaleY(scaleCoef) YMaps.Point Масштабирует значениекоординаты y.

toString(precision) String Возвращает строковоепредставление точкив виде "x,y".

Наследуемые методыИз YMaps.ICoordPoint:

copy, diff, getX, getY, moveBy, moveTo, setX, setY

Подробное описание конструктораYMaps.Point(x, y)

Создает объект точки в двумерном эвклидовом пространстве.


150


Параметры:

Имя Тип Необязательный По умолчанию Описаниеx Number Координата по оси x.

y Number значение параметра x Координата по оси y.


xNumber x

Координата точки по оси x.

yNumber y

Координата точки по оси y.


apply{YMaps.Point} apply(func)

Последовательно применяет к значениям координат точки указанную функцию. Результат вызова функ-ции становится новым значением координаты.

Пример:

// Уменьшает значение координаты в два раза, если оно больше единицы.var point = new YMaps.Point(1, 2);point.apply(function (coord) { return coord > 1 : coord / 2 : coord;});point.toString() // 1,1

Параметры:

Имя Тип Описаниеfunc Function Функция, применяемая

к координатам точки.


Тип ОписаниеYMaps.Point Ссылку на себя.

applyX{YMaps.Point} applyX(func)

Применяет к значению координаты x переданную функцию.

Параметры:

Имя Тип Описаниеfunc Function Функция, применяемая к значению

координаты x.


151




applyY{YMaps.Point} applyY(func)

Применяет к значению координаты y переданную функцию.

Параметры:

Имя Тип Описаниеfunc Function Функция, применяемая к значению

координаты y.




Сравнивает две точки: точку, заданную параметром point и точку, для которой вызывается метод. Точкисовпадают, если они имеют одинаковые значения координат по обеим осям.

Пример:

var point = new YMaps.Point(37, 55);var point2 = new YMaps.Point(37, 55);alert(point.equals(point2)); // Точки совпадают.

Параметры:

Имя Тип Описаниеpoint YMaps.Point Точка.



fromString{YMaps.Point} fromString(string)

Создает точку по ее строковому представлению. Формат строкового представления: "x,y".

Параметры:

Имя Тип Описаниеstring String Строковое представление точки.


Тип ОписаниеYMaps.Point Точку.


152


moveByX{YMaps.Point} moveByX(dx)

Сдвигает точку по оси x.

Параметры:

Имя Тип Описаниеdx Number Сдвиг по оси x.



moveByY{YMaps.Point} moveByY(dy)

Сдвигает точку по оси y.

Параметры:

Имя Тип Описаниеdy Number Сдвиг по оси y.



moveToX{YMaps.Point} moveToX(x)

Устанавливает значение координаты x.

Параметры:

Имя Тип Описаниеx Number Координата по оси x.



moveToY{YMaps.Point} moveToY(y)

Устанавливает значение координаты y.

Параметры:

Имя Тип Описаниеy Number Координата по оси y.


153




neg{YMaps.Point} neg()

Инвертирует знак у значений координат.


Тип ОписаниеYMaps.Point Точку с координатами, инвертированными по знаку.

scale{YMaps.Point} scale(scaleCoef)

Масштабирует значения координат точки по обеим осям.

Параметры:

Имя Тип ОписаниеscaleCoef Number|YMaps.Point Коэффициент масштабирования.



scaleX{YMaps.Point} scaleX(scaleCoef)

Масштабирует значение координаты x.

Параметры:

Имя Тип ОписаниеscaleCoef Number Коэффициент масштабирования.



scaleY{YMaps.Point} scaleY(scaleCoef)

Масштабирует значение координаты y.

Параметры:

Имя Тип ОписаниеscaleCoef Number Коэффициент масштабирования.


154




toString{String} toString(precision)

Возвращает строковое представление точки в виде "x,y".

Параметры:

Имя Тип Необязательный По умолчанию Описаниеprecision Integer Точность, с которой

округляютсязначения.По умолчаниюне округляются.


Тип ОписаниеString Строковое представление точки.

YMaps.PolygonРасширяет YMaps.IInteractiveGeoObject, YMaps.IOverlay.

Класс для создания оверлеев-многоугольников на карте.

КонструкторИмя ОписаниеYMaps.Polygon(points, options) Строит многоугольник из массива его вершин.

ПоляИмя ОписаниеEvents Список обрабатываемых событий.



СобытияИмя ОписаниеBalloonClose Закрытие балуна многоугольника.

В callback-функцию передается указатель на многоугольник, для которогобыл вызван обработчик.

BalloonOpen Открытие балуна многоугольника.


Click Щелчок мышью.


155


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

• указатель на многоугольник, для которого был вызван обработчик;


DblClick Двойной щелчок мышью.

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



MouseEnter Курсор наведен на многоугольник.




MouseLeave Курсор убран с многоугольника.




MouseMove Движение курсора в пределах многоугольника.




PositionChange Изменение координат многоугольника (например, с помощью методаYMaps.Polygon.addPoint).


StartDrawing Включение режима добавления вершин многоугольника.


StartEditing Включение режима редактирования многоугольника.


StopDrawing Отключение режима добавления вершин многоугольника.


StopEditing Отключение режима редактирования многоугольника.


МетодыИмя Статический Возвращает ОписаниеaddPoint(point, index) Добавляет вершину

в многоугольник.

fromEncodedPoints(encodedPoints, levels, options,coordSystem)

YMaps.Polygon Строит многоугольникиз закодированныхв Base64 координат


156


Имя Статический Возвращает Описаниеего вершин с учетомуказанного для каждойвершины уровнявидимости.

getMap() YMaps.Map Возвращает указательна карту, в которуюдобавлен многоугольник.

getNumPoints() Integer Возвращает количествовершин многоугольника.

getPoint(index) YMaps.ICoordPoint Возвращает вершинумногоугольникас заданным индексом.

getPoints() YMaps.ICoordPoint[] Возвращает координатывершин многоугольника.

removePoint(index) YMaps.ICoordPoint Удаляетиз многоугольникавершину с заданныминдексом.

setEditingOptions(options) Устанавливает опциирежима редактированиямногоугольника.

setPoints(points) Устанавливает координатывершин многоугольника.

splicePoints(index, number) YMaps.ICoordPoint[] Удаляет заданныевершины многоугольника.Если требуется, вставляетна место удаленных другиевершины, которыепередаются в методдополнительнымипараметрами (послепараметра number).

startEditing() Включает режимредактированиямногоугольника. Долженвызываться последобавлениямногоугольника на карту.

stopEditing() Отключает режимредактированиямногоугольника.



closeBalloon, getBalloon, getBalloonContent, getBalloonOptions, getHintContent, getHintOptions,getOptions, openBalloon, setBalloonContent, setBalloonOptions, setHintContent, setHintOptions,setOptions, update


Подробное описание конструктораYMaps.Polygon(points, options)

Строит многоугольник из массива его вершин.


157


Пример:

// var style = new YMaps.Style("default#greenPoint");style.polygonStyle = new YMaps.PolygonStyle();style.polygonStyle.fill = 1;style.polygonStyle.outline = 1;style.polygonStyle.strokeWidth = 10;style.polygonStyle.strokeColor = "ffff0088";style.polygonStyle.fillColor = "ff000055";YMaps.Styles.add("polygon#Example", style);

var polygon = new YMaps.Polygon([ new YMaps.GeoPoint(37.59507,55.576559), new YMaps.GeoPoint(37.493452,55.613885), new YMaps.GeoPoint(37.369853,55.767479), new YMaps.GeoPoint(37.405561,55.871082), new YMaps.GeoPoint(37.553873,55.911209), new YMaps.GeoPoint(37.707682,55.898866), new YMaps.GeoPoint(37.83677,55.821634), new YMaps.GeoPoint(37.834021,55.689979), new YMaps.GeoPoint(37.83677,55.646518), new YMaps.GeoPoint(37.669234,55.576559)], { style: "polygon#Example", hasHint: 1, hasBalloon: 1});

polygon.name = "Москва";polygon.description = "Столица России";

map.addOverlay(polygon);

Параметры:

Имя Тип Необязательный По умолчанию Описаниеpoints YMaps.ICoordPoint[] Массив вершин

многоугольника.

options YMaps.InteractiveGeoObjectOptions

Опциимногоугольника.


EventsObject Events

Список обрабатываемых событий.



Закрытие балуна многоугольника.

В callback-функцию передается указатель на многоугольник, для которого был вызван обработчик.


Открытие балуна многоугольника.


158



ClickClick

Щелчок мышью.




DblClickDblClick

Двойной щелчок мышью.





Курсор наведен на многоугольник.





Курсор убран с многоугольника.




MouseMoveMouseMove

Движение курсора в пределах многоугольника.





Изменение координат многоугольника (например, с помощью метода YMaps.Polygon.addPoint).


159



StartDrawingStartDrawing

Включение режима добавления вершин многоугольника.


StartEditingStartEditing

Включение режима редактирования многоугольника.


StopDrawingStopDrawing

Отключение режима добавления вершин многоугольника.


StopEditingStopEditing

Отключение режима редактирования многоугольника.



addPointaddPoint(point, index)

Добавляет вершину в многоугольник.

Параметры:

Имя Тип Необязательный По умолчанию Описаниеpoint YMaps.ICoordPoint|

YMaps.ICoordPoint[]Координата вершиныили массивкоординат.

index Integer Позиция, в которуюнужно добавитьвершину.

fromEncodedPoints{YMaps.Polygon} fromEncodedPoints(encodedPoints, levels, options, coordSystem)

Строит многоугольник из закодированных в Base64 координат его вершин с учетом указанного для ка-ждой вершины уровня видимости.

См.: Описание ломаной

Пример:

// map.setCenter(new YMaps.GeoPoint(37.619, 55.753), 1);


160

http://api.yandex.ru/maps/jsapi/doc/dg/concepts/polylines.xml#polylines/coord_string


var polygon = YMaps.Polygon.fromEncodedPoints( "hPD6AgItMQGAaWf_QEtMAAAAAAA8S0wAgGln_0JLTACAlpgAO0tMAAAAAABDS0wAgJaYAEFLTAB3lpgAv7Sz_wAAAAC9tLP_gJaYAMW0s_-AaWf_vrSz_wAAAADEtLP_iWln_8C0s_8=", "BCCBCCBCCBCC");map.addOverlay(polygon);

Параметры:

Имя Тип Необязательный По умолчанию ОписаниеencodedPoints String Закодированный

в Base64 массиввершинмногоугольника.

levels String Строка кодовуровней. Для каждойвершинымногоугольникауказывается значениекоэффициентамасштабирования,начиная с котороговершина становитсяне видна.


Опциимногоугольника.

coordSystem YMaps.ICoordSystem YMaps.GeoCoordSystem

Ссылкана координатнуюсистему.


Тип ОписаниеYMaps.Polygon Многоугольник.


Возвращает указатель на карту, в которую добавлен многоугольник.


Тип ОписаниеYMaps.Map Указатель на карту, в которую добавлен многоугольник.

getNumPoints{Integer} getNumPoints()

Возвращает количество вершин многоугольника.


Тип ОписаниеInteger Количество вершин многоугольника.

getPoint{YMaps.ICoordPoint} getPoint(index)

Возвращает вершину многоугольника с заданным индексом.


161


Параметры:



Тип ОписаниеYMaps.ICoordPoint Вершину с заданным индексом.

getPoints{YMaps.ICoordPoint[]} getPoints()

Возвращает координаты вершин многоугольника.


Тип ОписаниеYMaps.ICoordPoint[] Координаты вершин многоугольника.

removePoint{YMaps.ICoordPoint} removePoint(index)

Удаляет из многоугольника вершину с заданным индексом.

Параметры:

Имя Тип Описаниеindex Integer Индекс удаляемой вершины.


Тип ОписаниеYMaps.ICoordPoint Координаты удаленной вершины.

setEditingOptionssetEditingOptions(options)

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

Параметры:

Имя Тип Описаниеoptions YMaps.PolygonEditingOptions Опции режима редактирования.

setPointssetPoints(points)

Устанавливает координаты вершин многоугольника.

Параметры:

Имя Тип Описаниеpoints YMaps.ICoordPoint[] Координаты вершин

многоугольника.


162


splicePoints{YMaps.ICoordPoint[]} splicePoints(index, number)

Удаляет заданные вершины многоугольника. Если требуется, вставляет на место удаленных другие вер-шины, которые передаются в метод дополнительными параметрами (после параметра number).

Примеры:

1.

// Удаляет вторую вершину многоугольника.polygon.splicePoints(1, 1);

2.

// Вставляет новую вершину на вторую позицию.polygon.splicePoints(1, 0, new YMaps.GeoPoint(37.63, 55.75));

3.

// Заменяет вторую вершину на новую.polygon.splicePoints(1, 1, new YMaps.GeoPoint(37.63, 55.75));

Параметры:

Имя Тип Описаниеindex Integer Индекс первой удаляемой вершины.

number Integer Количество удаляемых вершин.


Тип ОписаниеYMaps.ICoordPoint[] Координаты удаленных вершин.

startEditingstartEditing()

Включает режим редактирования многоугольника. Должен вызываться после добавления многоуголь-ника на карту.

stopEditingstopEditing()

Отключает режим редактирования многоугольника.

YMaps.PolygonEditingOptionsРасширяет YMaps.GraphicsEditingOptions.

Опции режима редактирования многоугольника.

См.: YMaps.GraphicsEditingOptions



163


ПоляИмя ОписаниеfromIndex Индекс вершины многоугольника, после которой будут добавляться но-

вые вершины (в режиме добавления).

Наследуемые поляИз YMaps.GraphicsEditingOptions:

drawing, drawOver, maxPoints, menuManager, onDblClick, stopDrawingByDblClick


fromIndexInteger fromIndex

Индекс вершины многоугольника, после которой будут добавляться новые вершины (в режиме доба-вления).

По умолчанию берется вершина с наибольшим индексом.

YMaps.PolygonStyleРасширяет YMaps.LineStyle.

Стиль многоугольника.

КонструкторИмя ОписаниеYMaps.PolygonStyle() Поля унаследованные от YMaps.LineStyle определяют параметры линии

обводки многоугольника.

ПоляИмя Описаниеfill Флаг, определяющий наличие заливки у многоугольника.

fillColor Цвет заливки в формате RGBA. Значение по умолчанию "ff0000ff".

outline Флаг, определяющий наличие обводки у многоугольника.

Наследуемые поляИз YMaps.LineStyle:

strokeColor, strokeWidth

Подробное описание конструктораYMaps.PolygonStyle()

Поля унаследованные от YMaps.LineStyle определяют параметры линии обводки многоугольника.


164



fillBoolean fill

Флаг, определяющий наличие заливки у многоугольника.

fillColorString fillColor

Цвет заливки в формате RGBA. Значение по умолчанию "ff0000ff". Последние два разряда определяютуровень прозрачности (альфа-канал): 00 — полностью прозрачный, ff — непрозрачный.

outlineBoolean outline

Флаг, определяющий наличие обводки у многоугольника.

YMaps.PolylineРасширяет YMaps.IInteractiveGeoObject, YMaps.IOverlay.

Ломаная линия.

См.: Рисование ломаных

КонструкторИмя ОписаниеYMaps.Polyline(points, options) Создает ломаную линию.

ПоляИмя ОписаниеEvents Список обрабатываемых событий ломаной линии.



СобытияИмя ОписаниеBalloonClose Закрытие балуна, открытого над ломаной линией.

В callback-функцию передается указатель на линию, для которой был вы-зван обработчик.

BalloonOpen Открытие балуна ломаной линии.


Click Щелчок мышью по ломаной линии.


165

http://api.yandex.ru/maps/jsapi/doc/dg/concepts/polylines.xml#polylines/drawing_polylines


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

• указатель на линию, для которой был вызван обработчик;


DblClick Двойной щелчок мышью по ломаной линии.




MouseEnter Курсор наведен на ломаную линию.




MouseLeave Курсор убран с ломаной линии.




MouseMove Движение курсора мышкой в пределах ломаной линии.




PositionChange Изменение координат линии (например, с помощью методаYMaps.Polyline.addPoint).


StartDrawing Включение режима добавления вершин в линию.


StartEditing Включение режима редактирования линии.


StopDrawing Отключение режима добавления вершин в линию.


StopEditing Отключение режима редактирования линии.



166


МетодыИмя Статический Возвращает ОписаниеaddPoint(point, index) Добавляет одну

или несколько вершинв конец линии.

fromEncodedPoints(encodedPoints, levels, options,coordSystem)

YMaps.Polyline Создает ломаную линиюиз массива ее вершин,закодированных в Base64.

getMap() YMaps.Map Возвращает указательна карту, в которуюдобавлена ломаная линия.

getNumPoints() Integer Возвращает количествовершин в ломаной линии.

getPoint(index) YMaps.ICoordPoint Возвращает координатывершины по ее индексу.

getPoints() YMaps.ICoordPoint[] Возвращает координатывершин линии.

removePoint(index) YMaps.ICoordPoint Удаляет из линии вершинус заданным индексом.

setEditingOptions(options) Устанавливает опциирежима редактированияломаной линии.

setPoints(points) Устанавливает координатывершин линии.

splicePoints(index, number) YMaps.ICoordPoint[] Удаляет вершиныиз ломаной линии. Еслинеобходимо, вставляетна их место другиевершины. Координатывершин, которые будутвставлены вместоудаленных, передаютсякак дополнительныепараметры послепараметра number.

startEditing() Включает режимредактирования ломанойлинии. Должен вызыватьсяпосле добавления ломанойна карту.

stopEditing() Отключает режимредактирования ломанойлинии.



closeBalloon, getBalloon, getBalloonContent, getBalloonOptions, getHintContent, getHintOptions,getOptions, openBalloon, setBalloonContent, setBalloonOptions, setHintContent, setHintOptions,setOptions, update



167


Подробное описание конструктораYMaps.Polyline(points, options)

Создает ломаную линию.

См.: Рисование ломаных

Пример:

// var line = new YMaps.Polyline([ new YMaps.GeoPoint(37.77751,55.76578), new YMaps.GeoPoint(37.67751,55.86578), new YMaps.GeoPoint(37.41321,55.92685)]);map.addOverlay(line);

Параметры:

Имя Тип Необязательный По умолчанию Описаниеpoints YMaps.ICoordPoint[] Координаты вершин

ломаной линии.


Опции ломанойлинии.


EventsObject Events

Список обрабатываемых событий ломаной линии.



Закрытие балуна, открытого над ломаной линией.

В callback-функцию передается указатель на линию, для которой был вызван обработчик.


Открытие балуна ломаной линии.


ClickClick

Щелчок мышью по ломаной линии.





168

http://api.yandex.ru/maps/jsapi/doc/dg/concepts/polylines.xml#polylines/drawing_polylines


DblClickDblClick

Двойной щелчок мышью по ломаной линии.





Курсор наведен на ломаную линию.





Курсор убран с ломаной линии.




MouseMoveMouseMove

Движение курсора мышкой в пределах ломаной линии.





Изменение координат линии (например, с помощью метода YMaps.Polyline.addPoint).


StartDrawingStartDrawing

Включение режима добавления вершин в линию.



169


StartEditingStartEditing

Включение режима редактирования линии.


StopDrawingStopDrawing

Отключение режима добавления вершин в линию.


StopEditingStopEditing

Отключение режима редактирования линии.



addPointaddPoint(point, index)

Добавляет одну или несколько вершин в конец линии.

Параметры:

Имя Тип Необязательный По умолчанию Описаниеpoint YMaps.ICoordPoint|

YMaps.ICoordPoint[]Добавляемаявершина или массиввершин.

index Integer Индекс первойдобавляемойвершины.

fromEncodedPoints{YMaps.Polyline} fromEncodedPoints(encodedPoints, levels, options, coordSystem)

Создает ломаную линию из массива ее вершин, закодированных в Base64.

См.: Описание ломаной

Пример:

// map.setCenter(new YMaps.GeoPoint(37.619, 55.753), 1);var polyline = YMaps.Polyline.fromEncodedPoints( "-4aTAwItMQEI087-vuHkAICWmAA7S0wA_9LO_kNLTAABLTEBQUtMAIBpZ_8_S0wA-CwxAUBLTAAI087-PUtMAICWmABBS0wA_9LO_j5LTAA=", "BCCBCCBCCB");map.addOverlay(polyline);


170

http://api.yandex.ru/maps/jsapi/doc/dg/concepts/polylines.xml#polylines/coord_string


Параметры:

Имя Тип Необязательный По умолчанию ОписаниеencodedPoints String Закодированные

координаты вершинлинии.

levels String Строка кодовуровней. Для каждойвершины ломанойуказываетсямасштаб, начинаяс которого вершинастановится не видна.


Опции ломанойлинии.

coordSystem YMaps.ICoordSystem YMaps.GeoCoordSystem

Ссылкана координатнуюсистему.


Тип ОписаниеYMaps.Polyline Ломаную линию.


Возвращает указатель на карту, в которую добавлена ломаная линия.


Тип ОписаниеYMaps.Map Указатель на карту, в которую добавлена ломаная линия.

getNumPoints{Integer} getNumPoints()

Возвращает количество вершин в ломаной линии.


Тип ОписаниеInteger Количество вершин в ломаной линии.

getPoint{YMaps.ICoordPoint} getPoint(index)

Возвращает координаты вершины по ее индексу.

Параметры:



Тип ОписаниеYMaps.ICoordPoint Координаты требуемой вершины.


171


getPoints{YMaps.ICoordPoint[]} getPoints()

Возвращает координаты вершин линии.


Тип ОписаниеYMaps.ICoordPoint[] Координаты вершин линии.

removePoint{YMaps.ICoordPoint} removePoint(index)

Удаляет из линии вершину с заданным индексом.

Параметры:

Имя Тип Описаниеindex Integer Индекс удаляемой вершины.


Тип ОписаниеYMaps.ICoordPoint Координаты удаленной вершины.

setEditingOptionssetEditingOptions(options)

Устанавливает опции режима редактирования ломаной линии.

Параметры:

Имя Тип Описаниеoptions YMaps.PolylineEditingOptions Опции режима редактирования.

setPointssetPoints(points)

Устанавливает координаты вершин линии.

Параметры:

Имя Тип Описаниеpoints YMaps.ICoordPoint[] Координаты вершин линии.

splicePoints{YMaps.ICoordPoint[]} splicePoints(index, number)

Удаляет вершины из ломаной линии. Если необходимо, вставляет на их место другие вершины.Координаты вершин, которые будут вставлены вместо удаленных, передаются как дополнительныепараметры после параметра number.Примеры:


172


1.

// Удаляет вторую вершину ломаной.polyline.splicePoints(1, 1);

2.

// Вставляет новую вершину во вторую позицию.polyline.splicePoints(1, 0, new YMaps.GeoPoint(37.63, 55.75));

3.

// Заменяет вторую вершину ломаной на новую.polyline.splicePoints(1, 1, new YMaps.GeoPoint(37.63, 55.75));

Параметры:

Имя Тип Описаниеindex Integer Индекс первой удаляемой вершины.

number Integer Количество удаляемых вершин.


Тип ОписаниеYMaps.ICoordPoint[] Координаты удаленных вершин.

startEditingstartEditing()

Включает режим редактирования ломаной линии. Должен вызываться после добавления ломаной на кар-ту.

stopEditingstopEditing()

Отключает режим редактирования ломаной линии.

YMaps.PolylineEditingOptionsРасширяет YMaps.GraphicsEditingOptions.

Опции режима редактирования ломаной линии.

См.: YMaps.GraphicsEditingOptions


ПоляИмя ОписаниеfromStart Указывает, куда добавлять новые точки в режиме добавления точек: в на-

чало или в конец ломаной. За начало ломаной принимается вершинас наименьшим индексом.

Наследуемые поляИз YMaps.GraphicsEditingOptions:

drawing, drawOver, maxPoints, menuManager, onDblClick, stopDrawingByDblClick


173



fromStartBoolean fromStart

Указывает, куда добавлять новые точки в режиме добавления точек: в начало или в конец ломаной.За начало ломаной принимается вершина с наименьшим индексом.

По умолчанию точки добавляются в конец ломаной (fromStart = false).

YMaps.RouteРасширяет YMaps.Polyline.

Класс "Маршрут".

КонструкторИмя ОписаниеYMaps.Route(encodedPoints, levels,boundedBy, routeSegments, distance,duration, viaPoints)

Конструктор маршрута.

Наследуемые поляИз YMaps.Polyline:



Наследуемые событияИз YMaps.Polyline:

BalloonClose, BalloonOpen, Click, DblClick, MouseEnter, MouseLeave, MouseMove, PositionChange,StartDrawing, StartEditing, StopDrawing, StopEditing

МетодыИмя Возвращает ОписаниеgetDistance() Number Возвращает длину маршрута

(в метрах).

getDuration() Number Возвращает расчетное времядвижения по маршруту (в секундах).

getNumRouteSegments() Integer Возвращает количество сегментовмаршрута.

getNumViaPoints() Integer Возвращает количество транзитныхточек на маршруте.

getRouteSegment(index) YMaps.RouteSegment Возвращает сегмент маршрута по егоиндексу.

getViaPoint(index) YMaps.ViaPoint Возвращает транзитную точкуна маршруте по ее индексу.


174


Наследуемые методыИз YMaps.Polyline:

addPoint, getMap, getNumPoints, getPoint, getPoints, removePoint, setEditingOptions, setPoints,splicePoints, startEditing, stopEditing


Из YMaps.IInteractiveGeoObject:closeBalloon, getBalloon, getBalloonContent, getBalloonOptions, getHintContent, getHintOptions,getOptions, openBalloon, setBalloonContent, setBalloonOptions, setHintContent, setHintOptions,setOptions, update


Подробное описание конструктораYMaps.Route(encodedPoints, levels, boundedBy, routeSegments, distance, duration, viaPoints)

Конструктор маршрута.

Параметры:

Имя Тип ОписаниеencodedPoints String Закодированные в Base64 точки.

levels String[] Уровни точек.

boundedBy YMaps.GeoBounds Прямоугольная область на карте,полностью охватывающая маршрут.

routeSegments YMaps.RouteSegment[] Массив сегментов маршрута.

distance Number Длина маршрута (в метрах).

duration Number Расчетное время проезда маршрута(в секундах).

viaPoints YMaps.ViaPoint[] Массив транзитных точекна маршруте.


getDistance{Number} getDistance()

Возвращает длину маршрута (в метрах).


Тип ОписаниеNumber Длина маршрута.

getDuration{Number} getDuration()

Возвращает расчетное время движения по маршруту (в секундах).


Тип ОписаниеNumber Расчетное время движения по маршруту (в секундах).


175


getNumRouteSegments{Integer} getNumRouteSegments()

Возвращает количество сегментов маршрута.


Тип ОписаниеInteger Количество сегментов.

getNumViaPoints{Integer} getNumViaPoints()

Возвращает количество транзитных точек на маршруте.


Тип ОписаниеInteger Количество транзитных точек на маршруте.

getRouteSegment{YMaps.RouteSegment} getRouteSegment(index)

Возвращает сегмент маршрута по его индексу.

Параметры:

Имя Тип Описаниеindex Integer Индекс сегмента в маршруте.


Тип ОписаниеYMaps.RouteSegment Сегмент маршрута.

getViaPoint{YMaps.ViaPoint} getViaPoint(index)

Возвращает транзитную точку на маршруте по ее индексу.

Параметры:

Имя Тип Описаниеindex Integer Индекс точки.


Тип ОписаниеYMaps.ViaPoint Транзитную точку.

YMaps.RouterРасширяет YMaps.GeoObjectCollection.

Класс для прокладывания маршрутов на карте.


176


КонструкторИмя ОписаниеYMaps.Router(wayPoints, viaPoints,options)

Прокладывает маршрут через заданные точки.

ПоляИмя ОписаниеEvents Список событий маршрутизатора.



СобытияИмя ОписаниеFault Событие неудачной загрузки ответа с сервера маршрутизации.

GeocodeError Событие неудачного построения маршрута, вследствие ошибкигеокодирования.

Load Событие успешного получения ответа от сервиса маршрутизации.

RouteError Событие неудачного построения маршрута, вследствие невозможностипроложить путь к точке.

Success Событие успешного построения маршрута.


Add, Remove

МетодыИмя Возвращает ОписаниеapplyView() Применяет к карте границы области

отображения маршрута.

getDistance() Number Возвращает длину маршрута(в метрах).

getDuration() Number Возвращает расчетное время в пути(в секундах).

getNumRoutes() Integer Возвращает количествопостроенных маршрутов.

getNumWayPoints() Integer Возвращает количество точекостановки.

getRoute(index) YMaps.Route Возвращает маршрут по его индексу.

getWayPoint(index) YMaps.WayPoint Возвращает точку остановки(специальную меткуYMaps.WayPoint) по индексу точки.


177







Подробное описание конструктораYMaps.Router(wayPoints, viaPoints, options)

Прокладывает маршрут через заданные точки.

Примеры:

1.

// Добавляет на карту схему проезда от станции метро "Курская" до станции метро "Парк Культуры".map.addOverlay(new YMaps.Router(['Курская', 'Парк культуры']));

2.

// Добавляет на карту схему проезда от станции метро "Курская" до станции метро "Парк Культуры".// При построении маршрута учитываются следующие требования: маршрут должен обязательно пройти через точку (37.583032, 55.745873),// его начальная и конечная точки должны быть подписаны, соединительные линии должны быть заданного цвета, толщины и прозрачности,// а центр и масштаб карты должны быть подобраны автоматически так, чтобы полностью вместить маршрут.var router = new YMaps.Router( ['Курская', new YMaps.GeoPoint(37.583032, 55.745873), 'Парк культуры'], // Список точек [1], // Здесь задаем индексы транзитных точек (точек, через которые мы хотим проехать без остановки) в массиве points { viewAutoApply: true } // Эта опция позволяет автоматически выставлять центр и коэффициент масштабирования карты ), style = new YMaps.Style(); // Стиль для меток и линий маршрутизатора

style.lineStyle = new YMaps.LineStyle(); // Задаем стиль линииstyle.lineStyle.strokeWidth = 5; // Ширина линииstyle.lineStyle.strokeColor = '30405080'; // Цвет линии в формате RGBA

router.setStyle(style); // Применяем стиль к маршрутуmap.addOverlay(router); // Добавляем маршрут на карту// По событию успешного построения маршрута зададим подписи точкам маршрутаYMaps.Events.observe(router, router.Events.Success, function () { // Задаем содержание меток для начальной и конечной точек. // Транзитные точки на карте не отмечаются и не возвращаются методом getWayPoint router.getWayPoint(0).setIconContent('Точка отправления'); router.getWayPoint(1).setIconContent('Точка прибытия');});


178


Параметры:

Имя Тип Необязательный По умолчанию ОписаниеwayPoints (String|

YMaps.GeoPoint[])Набор точек, черезкоторые долженпроходить маршрут.

viaPoints Number[] Индексы транзитныхточек, т.е. точек,через которые нужнопроехатьбез остановки.Отсчет индексовначинается с 0.

options Object Опции построениямаршрута.

options.viewAutoApply

Boolean false Флаг, позволяющийавтоматическиустановить центри коэффициентмасштабированиякарты так, чтобыпостроенныймаршрут был виденцеликом.


EventsObject Events

Список событий маршрутизатора.


FaultFault

Событие неудачной загрузки ответа с сервера маршрутизации.В callback-функцию передаются два аргумента:

• ссылка на объект, для которого был вызван обработчик;


GeocodeErrorGeocodeError

Событие неудачного построения маршрута, вследствие ошибки геокодирования.В callback-функцию передаются два аргумента:


• индекс точки, при геокодировании которой произошла ошибка.

LoadLoad

Событие успешного получения ответа от сервиса маршрутизации. В callback-функцию передается ссыл-ка на объект, для которого был вызван обработчик.


179


RouteErrorRouteError

Событие неудачного построения маршрута, вследствие невозможности проложить путь к точке.В callback-функцию передаются два аргумента:


• индекс точки, путь до которой нельзя построить.

SuccessSuccess

Событие успешного построения маршрута. В callback-функцию передается ссылка на объект, для кото-рого был вызван обработчик.


applyViewapplyView()

Применяет к карте границы области отображения маршрута.


Возвращает длину маршрута (в метрах).


Тип ОписаниеNumber Длину маршрута (в метрах).


Возвращает расчетное время в пути (в секундах).


Тип ОписаниеNumber Расчетное время в пути (в секундах).

getNumRoutes{Integer} getNumRoutes()

Возвращает количество построенных маршрутов. Маршрутизатор строит несколько маршрутов, еслизадано несколько точек остановки. Метод getNumRoutes возвращает число успешно построенных мар-шрутов, которое (если не было ошибок) должно быть на единицу меньше числа точек остановки.


Тип ОписаниеInteger Количество маршрутов.


180


getNumWayPoints{Integer} getNumWayPoints()

Возвращает количество точек остановки.


Тип ОписаниеInteger Количество точек остановки.

getRoute{YMaps.Route} getRoute(index)

Возвращает маршрут по его индексу.

Параметры:

Имя Тип Описаниеindex Integer Индекс маршрута.


Тип ОписаниеYMaps.Route Маршрут.

getWayPoint{YMaps.WayPoint} getWayPoint(index)

Возвращает точку остановки (специальную метку YMaps.WayPoint) по индексу точки.

Параметры:

Имя Тип Описаниеindex Integer Индекс точки.


Тип ОписаниеYMaps.WayPoint Точку остановки (специальную метку).

YMaps.RouteSegmentКласс для описания отрезка маршрута.

КонструкторИмя ОписаниеYMaps.RouteSegment(indexInPolyline,distance, duration, action, angle, street)

Описывает отрезок, соединяющий две последовательные точкипостроенного маршрута.


181


МетодыИмя Возвращает ОписаниеgetAction() String Возвращает направление поворота

маршрута в конце отрезка.

getAngle() String Возвращает угол поворота(в градусах).

getDistance() Number Возвращает длину отрезка(в метрах).

getDuration() Number Возвращает время проезда отрезка(в секундах).

getPolylineIndex() Integer Возвращает индекс первой точкиотрезка в ломаной маршрута.

getStreet() String Возвращает название улицы,по которой проходит данный отрезокмаршрута.

Подробное описание конструктораYMaps.RouteSegment(indexInPolyline, distance, duration, action, angle, street)

Описывает отрезок, соединяющий две последовательные точки построенного маршрута.

Параметры:

Имя Тип ОписаниеindexInPolyline Integer Индекс первой точки отрезка

в массиве точек ломаной маршрута.

distance Number Длина отрезка (в метрах).

duration Number Расчетное время проезда отрезка(в секундах).

action String Направление поворота маршрутав конце отрезка:

• back — назад;

• left — налево;

• right — направо;

• none — прямо.

angle Number Угол поворота (в градусах).

street String Улица.


getAction{String} getAction()

Возвращает направление поворота маршрута в конце отрезка.


182



Тип ОписаниеString Направление поворота маршрута в конце отрезка:

• back — назад;

• left — налево;

• right — направо;

• none — прямо.

getAngle{String} getAngle()

Возвращает угол поворота (в градусах).


Тип ОписаниеString Угол поворота (в градусах).


Возвращает длину отрезка (в метрах).


Тип ОписаниеNumber Длину отрезка.


Возвращает время проезда отрезка (в секундах).


Тип ОписаниеNumber Время проезда.

getPolylineIndex{Integer} getPolylineIndex()

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


Тип ОписаниеInteger Индекс первой точки отрезка в ломаной маршрута.

getStreet{String} getStreet()

Возвращает название улицы, по которой проходит данный отрезок маршрута.


183



Тип ОписаниеString Название улицы.

YMaps.ScaleLineРасширяет YMaps.IControl.

Класс для создания элемента управления "Линейный масштаб".См.: Элементы управления

КонструкторИмя ОписаниеYMaps.ScaleLine() Создает элемент управления "Линейный масштаб" (scale line), позволяю-

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



Подробное описание конструктораYMaps.ScaleLine()

Создает элемент управления "Линейный масштаб" (scale line), позволяющий, не прибегая к вычисле-ниям, измерять расстояние между объектами.

Положение элемента по умолчанию: YMaps.ControlPosition.BOTTOM_RIGHT, отступ справа —5 пикселов, снизу — 37 пикселов.

См.: Элементы управления

YMaps.SearchControlРасширяет YMaps.IControl.

Класс для создания элемента управления "Поиск по карте".

КонструкторИмя ОписаниеYMaps.SearchControl(options) Создает элемент управления "Поиск по карте".

ПоляИмя ОписаниеEvents Список обрабатываемых событий элемента управления "Поиск по карте".

СобытияИмя ОписаниеSelect Выбран один из результатов поиска.


184

http://api.yandex.ru/maps/jsapi/doc/dg/concepts/map_controls.xml

http://api.yandex.ru/maps/jsapi/doc/dg/concepts/map_controls.xml


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

• указатель на объект YMaps.SearchControl;

• указатель на выбранный объект YMaps.GeocoderResult.



Подробное описание конструктораYMaps.SearchControl(options)

Создает элемент управления "Поиск по карте".

Параметры:


options.width Integer 240 Ширина элемента(в пикселах).Минимальноезначение — 200.

options.resultsPerPage

Integer 3 Количестворезультатов поискана странице.Максимальноезначение — 20.

options.useMapBounds

Integer true true — учитыватьпри поиске границывидимой областикарты (объекты,найденные внутривидимой областибудут показаныв начале списка),false — не учитывать.

options.noCentering

Boolean false false —автоматическирасполагать центркарты так, чтобыобъект был виденцеликом. true —не изменять центркарты при показенайденного объекта.

options.noPlacemark

Boolean false false —автоматическидобавлять в центрнайденного объектаметку с открытымбалуном, true —не добавлять. Еслиуказать noCentering= true и noPlacemark= true, то при щелчкемышьюпо результату поисканикаких видимыхизменений на картене произойдет.


185



EventsObject Events

Список обрабатываемых событий элемента управления "Поиск по карте".


SelectSelect

Выбран один из результатов поиска.В callback-функцию передаются два аргумента:

• указатель на объект YMaps.SearchControl;

• указатель на выбранный объект YMaps.GeocoderResult.

YMaps.SizeРасширяет YMaps.Point.

Класс для описания линейных размеров объектов (длины и ширины). Ширина хранится в поле x, а высотав поле y.

КонструкторИмя ОписаниеYMaps.Size() Создает объект, описывающий линейные размеры объектов на карте.

Наследуемые поляИз YMaps.Point:

x, y

Наследуемые методыИз YMaps.Point:

apply, applyX, applyY, equals, moveByX, moveByY, moveToX, moveToY, neg, scale, scaleX, scaleY,toString

Из YMaps.ICoordPoint:copy, diff, getX, getY, moveBy, moveTo, setX, setY

Подробное описание конструктораYMaps.Size()

Создает объект, описывающий линейные размеры объектов на карте.

Пример:

new YMaps.Size(10, 10);


186


YMaps.SmallZoomРасширяет YMaps.IControl.

Класс для создания элемента управления "Простой ползунок масштаба".

КонструкторИмя ОписаниеYMaps.SmallZoom(options) Создает элемент управления "Простой ползунок масштаба", который со-

держит только кнопки увеличения и уменьшения коэффициента масшта-бирования.



Подробное описание конструктораYMaps.SmallZoom(options)

Создает элемент управления "Простой ползунок масштаба", который содержит только кнопки увели-чения и уменьшения коэффициента масштабирования.

Положение элемента по умолчанию: YMaps.ControlPosition.TOP_LEFT, отступ сверху — 75, от-ступ слева — 5 пикселов.

Параметры:

Имя Тип Необязательный По умолчанию Описаниеoptions Object Опции элемента


options.smooth Boolean true Включает/выключаетвозможностьплавногомасштабированиякарты нажатиемклавиш "+" и "-":true — возможностьвключена, false —выключена.

YMaps.StateСтатический объект.

Набор универсальных констант для обозначения состояний объектов.

ПоляИмя ОписаниеEMPTY Объект-контейнер пуст.

FAILURE Во время выполнения операции произошла ошибка.

LOADING Производится загрузка.

SUCCESS Операция выполнена успешно.


187



EMPTYString EMPTY

Объект-контейнер пуст.

FAILUREString FAILURE

Во время выполнения операции произошла ошибка.

LOADINGString LOADING

Производится загрузка.

SUCCESSString SUCCESS

Операция выполнена успешно.

YMaps.StyleСодержит набор данных, определяющий внешний вид объектов, помещаемых на карту.

КонструкторИмя ОписаниеYMaps.Style(parentStyle) Создает стиль объекта.

ПоляИмя ОписаниеballoonContentStyle Стиль содержимого балуна.

balloonStyle Стиль балуна.

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

hasHint Флаг, определяющий наличие у объекта всплывающей подсказки.

hintContentStyle Стиль содержимого всплывающей подсказки.

hintStyle Стиль всплывающей подсказки.

iconContentStyle Стиль содержимого значка.

iconStyle Стиль значка (пиктограммы).

lineStyle Стиль линии.

parentStyle Родительский стиль.

polygonStyle Стиль многоугольника.


188


МетодыИмя Статический Возвращает Описаниеcopy(style) YMaps.Style Делает копию стиля.

Подробное описание конструктораYMaps.Style(parentStyle)

Создает стиль объекта.

Экземпляр YMaps.Style может иметь стиль, являющийся для него родительским. В этом случае неопре-деленные поля данных будут унаследованы от родителя.

Параметры:

Имя Тип ОписаниеparentStyle YMaps.Style|String Родительский стиль.


balloonContentStyleYMaps.BalloonContentStyle balloonContentStyle

Стиль содержимого балуна. Если не определен, то наследуется от родителя.

balloonStyleYMaps.BalloonStyle balloonStyle

Стиль балуна. Если не определен, то наследуется от родителя.

hasBalloonBoolean hasBalloon

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

hasHintBoolean hasHint

Флаг, определяющий наличие у объекта всплывающей подсказки. Если не определен, то наследуетсяот родителя.

hintContentStyleYMaps.HintContentStyle hintContentStyle

Стиль содержимого всплывающей подсказки. Если не определен, то наследуется от родителя.

hintStyleYMaps.HintStyle hintStyle

Стиль всплывающей подсказки. Если не определен, то наследуется от родителя.


189


iconContentStyleYMaps.IconContentStyle iconContentStyle

Стиль содержимого значка. Если не определен, то наследуется от родителя.

iconStyleYMaps.IconStyle iconStyle

Стиль значка (пиктограммы). Если не определен, то наследуется от родителя.

lineStyleYMaps.LineStyle lineStyle

Стиль линии. Если не определен, то наследуется от родителя.

parentStyleparentStyle

Родительский стиль. Неопределенные поля данных будут унаследованы от родителя.

polygonStyleYMaps.PolygonStyle polygonStyle

Стиль многоугольника. Если не определен, то наследуется от родителя.


copy{YMaps.Style} copy(style)

Делает копию стиля.

Параметры:

Имя Тип Описаниеstyle YMaps.Style Стиль, который нужно скопировать.


Тип ОписаниеYMaps.Style Копия стиля.

YMaps.StylesСтатический объект.

Объект для хранения стилей географических объектов (см. YMaps.Style и YMaps.IGeoObject).

API включает в себя набор предустановленных стилей, описывающих встроенные значки меток раз-личных цветов и размеров.


190


Стили для значков стандартного размера:

• "default#whitePoint";

• "default#greenPoint";

• "default#redPoint";

• "default#yellowPoint";

• "default#darkbluePoint";

• "default#nightPoint";

• "default#greyPoint";

• "default#bluePoint";

• "default#orangePoint";

• "default#darkorangePoint";

• "default#pinkPoint";

• "default#violetPoint".

Стили для значков маленького размера:

• "default#whiteSmallPoint";

• "default#greenSmallPoint";

• "default#redSmallPoint";

• "default#yellowSmallPoint";

• "default#darkblueSmallPoint";

• "default#nightSmallPoint";

• "default#greySmallPoint";

• "default#blueSmallPoint";

• "default#orangeSmallPoint";

• "default#darkorangeSmallPoint";

• "default#pinkSmallPoint";

• "default#violetSmallPoint".

ПоляИмя ОписаниеDefaultStyleKey Ключ стиля по умолчанию. Имеет значение "default#style". Доступен

только для чтения.

МетодыИмя Возвращает Описаниеadd(styleKey, style) Добавляет стиль в хранилище.

get(styleKey) YMaps.Style Возвращает объект стиляпо указанному ключу.

remove(styleKey) YMaps.Style Удаляет стиль из хранилищапо указанному ключу.


DefaultStyleKeyString DefaultStyleKey


191


Ключ стиля по умолчанию. Имеет значение "default#style". Доступен только для чтения.


addadd(styleKey, style)

Добавляет стиль в хранилище.

Параметры:

Имя Тип ОписаниеstyleKey String Ключ стиля.

style YMaps.Style Объект стиля.

get{YMaps.Style} get(styleKey)

Возвращает объект стиля по указанному ключу.

Параметры:



Тип ОписаниеYMaps.Style Объект стиля.

remove{YMaps.Style} remove(styleKey)

Удаляет стиль из хранилища по указанному ключу.

Параметры:



Тип ОписаниеYMaps.Style Объект стиля.

YMaps.TemplateШаблон для построения макетов на основе текста.Строка HTML-кода может содержать элементы вида $[имя_поля|значение_по_умолчанию].При разборе шаблона такие элементы заменяются данными из объекта-контекста, который передаетсяв метод build в качестве аргумента.

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


192


В Internet Explorer 6 все картинки заменяются на элементы div с фильтром для поддержки полупрозрач-ности png-изображений.

См.: Пользовательские значки для меток

КонструкторИмя ОписаниеYMaps.Template(text) Создает шаблон — заготовку для создания макетов на основе текста.


по заданному шаблону.

Подробное описание конструктораYMaps.Template(text)

Создает шаблон — заготовку для создания макетов на основе текста.См.: Пользовательские значки для меток

Пример:

// Создает HTML-элемент DIV, содержащий текст "пробный текст".template = new YMaps.Template("<div>$[customText|текст по умолчанию]</div>");YMaps.Templates.add("example#template", template);var layout = template.build({customText: "пробный текст"});layout.onAddToParent(document.body);

Параметры:

Имя Тип Описаниеtext String HTML-код шаблона. Помимо

HTML-разметки код шаблонасодержит специальные переменные,которые при разборе шаблонаподменяются указанными данными.



Возвращает макет, созданный по заданному шаблону.

Параметры:

Имя Тип Описаниеcontext Object Контекст — это объект, из которого

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



Тип ОписаниеYMaps.ILayout Результирующий макет.


193

http://api.yandex.ru/maps/jsapi/doc/dg/concepts/markers_icon_custom.xml

http://api.yandex.ru/maps/jsapi/doc/dg/concepts/markers_icon_custom.xml


YMaps.TemplatesСтатический объект.

Объект для хранения и разбора шаблонов.

Работа с хранилищем шаблонов осуществляется с использованием ключей. Каждый шаблон помещаетсяв хранилище под уникальным ключом. Чтобы получить шаблон обратно, необходимо использоватьключ, полученный при помещении шаблона в хранилище.

МетодыИмя Возвращает Описаниеadd(templateKey, template) Добавляет шаблон в хранилище.

get(templateKey) YMaps.ITemplate Возвращает объект шаблонапо указанному ключу.

remove(templateKey) YMaps.ITemplate Удаляет шаблон из хранилища.


addadd(templateKey, template)

Добавляет шаблон в хранилище.

Параметры:

Имя Тип ОписаниеtemplateKey String Ключ шаблона, под которым шаблон

будет сохранен.

template YMaps.ITemplate Шаблон, помещаемый в хранилище.

get{YMaps.ITemplate} get(templateKey)

Возвращает объект шаблона по указанному ключу.

Параметры:

Имя Тип ОписаниеtemplateKey String Ключ шаблона.


Тип ОписаниеYMaps.ITemplate Шаблон.

remove{YMaps.ITemplate} remove(templateKey)

Удаляет шаблон из хранилища.

Параметры:

Имя Тип ОписаниеtemplateKey String Ключ шаблона.


194



Тип ОписаниеYMaps.ITemplate Удаленный шаблон.

YMaps.TileCoordinatesСодержит методы преобразования пиксельных координат в тайловые и обратно.

Внимание!Пиксельные координаты рассчитываются при максимальном масштабе карты.

Объект класса YMaps.TileCoordinates существует в единственном экземпляре для каждой карты и до-ступен в объекте карты как YMaps.Map.tileCoordinates.

См.: Типы координат и их преобразование

Параметры:

Имя Тип Описаниеmap YMaps.Map Карта.

МетодыИмя Возвращает ОписаниеfromPixels(pixelPoint, zoom) Object Преобразует пиксельные координа-

ты точки в тайловые.

scale(point, toZoom, fromZoom) YMaps.Point Выполняет преобразование пиксель-ных координат при переходе от од-ного масштаба к другому.

toPixels(number, offset, zoom) YMaps.Point Преобразует тайловые координатыточки в пиксельные.


fromPixels{Object} fromPixels(pixelPoint, zoom)

Преобразует пиксельные координаты точки в тайловые.

Тайловые координаты возвращаются в виде объекта с двумя полями, задающими номер тайла(number) и смещение в пикселах внутри тайла (offset), соответственно.

В случае, если указанным пиксельным координатам соответствует тайл, лежащий вне области карты(несуществующий тайл), значение поля number будет равно null.

Параметры:

Имя Тип ОписаниеpixelPoint YMaps.Point Пиксельные координаты точки,

рассчитанные при максимальноммасштабе карты.

zoom Integer Текущий коэффициентмасштабирования карты.


195




Тип ОписаниеObject Объект с полями number (номер тайла) и offset (смещение точки

в пикселах внутри тайла).

scale{YMaps.Point} scale(point, toZoom, fromZoom)

Выполняет преобразование пиксельных координат при переходе от одного масштаба к другому.

Параметры:

Имя Тип Необязательный По умолчанию Описаниеpoint YMaps.Point Точка в пиксельных

координатах.

toZoom Integer Требуемыйкоэффициентмасштабирования.По умолчанию равенмаксимальномукоэффициентумасштабированиякоординатнойсистемы.

fromZoom Integer Исходныйкоэффициентмасштабирования.По умолчанию равентекущемукоэффициентумасштабированиякарты.


Тип ОписаниеYMaps.Point Пиксельные координаты точки на требуемом масштабе.

toPixels{YMaps.Point} toPixels(number, offset, zoom)

Преобразует тайловые координаты точки в пиксельные.

Тайловые координаты точки задаются номером тайла и пиксельным смещением точки внутри тайла.Также указывается текущий коэффициент масштабирования карты.

Параметры:

Имя Тип Описаниеnumber YMaps.Point Номер тайла.

offset YMaps.Point Смещение точки в пикселах внутритайла.

zoom Integer Текущий коэффициентмасштабирования карты.


196



Тип ОписаниеYMaps.Point Пиксельные координаты точки, рассчитанные при максимальном

коэффициенте масштабирования.

YMaps.TileDataSourceКласс для создания источника данных для тайлов определенного типа.

Примечание:Если требуется особое поведение какого-либо метода класса, то этот метод следует переопределить.

Для задания URL тайла используется шаблон, в котором можно использовать следующие специальныеконструкции:

• %d — заменяется на число от 1 до 4, в зависимости от номера тайла. Используется для распределениянагрузки между несколькими доменами.

• %c — заменяется на x&y&z, где x — номер тайла по горизонтали, y — номер тайла по вертикали,z — коэффициент масштабирования.

КонструкторИмя ОписаниеYMaps.TileDataSource(tileUrlTemplate, isTransparent, smoothZoomEnabled)

Создает источник данных для тайлов определенного типа.


еОписание

ERROR_TILE_URL URL изображения-заглушки для непрозрачных тайлов.Используется в качестве errorTileUrl.

TRANPARENT_TILE_URL URL полностью прозрачного тайла. Используется в ка-честве errorTileUrl.

В отличие от непрозрачных тайлов, где при ошибке по-казывается изображение-заглушка, для прозрачных тай-лов, в случае ошибки, показывается полностью прозрач-ное изображение.

МетодыИмя Возвращает ОписаниеgetErrorTileUrl() String Возвращает URL картинки для несу-

ществующих или незагрузившихсятайлов.

getTile() YMaps.ITile Создает и возвращает экземпляртайла.

getTileUrl(tile, zoom) String Возвращает URL изображения тайлапо заданному номеру тайла и коэф-фициенту масштабирования.

getTileUrlTemplate() String Возвращает текущий шаблонURL тайла.


197


Имя Возвращает ОписаниеisTransparent() Boolean Возвращает состояние прозрачности

тайлов: true — загружаемыеизображения тайлов прозрачны,false — нет (по умолчанию).

setTileUrlTemplate(template) Устанавливает новый шаблонURL тайла.

smoothZoomEnabled() Boolean Возвращает состояние возможностиплавного масштабирования для тай-лов: true — тайлы поддерживаютплавное масштабирование (по умол-чанию), false — нет.

Подробное описание конструктораYMaps.TileDataSource(tileUrlTemplate, isTransparent, smoothZoomEnabled)

Создает источник данных для тайлов определенного типа.Параметры:

Имя Тип Необязательный По умолчанию ОписаниеtileUrlTemplate String Шаблон, по которому

строится URL тайла.

isTransparent Boolean false true — загружаемыетайлы прозрачны,false — непрозрачны.

smoothZoomEnabled

Boolean true true — загружаемыетайлы поддерживаютплавноемасштабирование,false — нет.


ERROR_TILE_URLERROR_TILE_URL

URL изображения-заглушки для непрозрачных тайлов. Используется в качестве errorTileUrl. Еслидля какого-либо участка местности отсутствует непрозрачный тайл, по умолчанию показывается изоб-ражение-заглушка "Для данного участка местности нет данных".

TRANPARENT_TILE_URLTRANPARENT_TILE_URL

URL полностью прозрачного тайла. Используется в качестве errorTileUrl.

В отличие от непрозрачных тайлов, где при ошибке показывается изображение-заглушка, для прозрач-ных тайлов, в случае ошибки, показывается полностью прозрачное изображение.


getErrorTileUrl{String} getErrorTileUrl()

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


198



Тип ОписаниеString URL картинки для несуществующих или незагрузившихся тайлов.

getTile{YMaps.ITile} getTile()

Создает и возвращает экземпляр тайла.


Тип ОписаниеYMaps.ITile Экземпляр тайла.

getTileUrl{String} getTileUrl(tile, zoom)

Возвращает URL изображения тайла по заданному номеру тайла и коэффициенту масштабирования.

URL тайла формируется, используя шаблон, установленный в конструкторе или через методsetTileUrlTemplate.

Параметры:

Имя Тип Описаниеtile YMaps.Point Номер тайла.

zoom String Текущий коэффициентмасштабирования.


Тип ОписаниеString URL изображения тайла.

getTileUrlTemplate{String} getTileUrlTemplate()

Возвращает текущий шаблон URL тайла.


Тип ОписаниеString Шаблон URL тайла.

isTransparent{Boolean} isTransparent()

Возвращает состояние прозрачности тайлов: true — загружаемые изображения тайлов прозрачны,false — нет (по умолчанию).


Тип ОписаниеBoolean true — загружаемые изображения тайлов прозрачны, false — нет (по

умолчанию).


199


setTileUrlTemplatesetTileUrlTemplate(template)

Устанавливает новый шаблон URL тайла.

Параметры:

Имя Тип Описаниеtemplate String Шаблон URL тайла.

smoothZoomEnabled{Boolean} smoothZoomEnabled()

Возвращает состояние возможности плавного масштабирования для тайлов: true — тайлы поддержи-вают плавное масштабирование (по умолчанию), false — нет.

Если тайлы не умеют растягиваться (false), то соответствующий слой будет скрыт на время плавногомасштабирования.


Тип ОписаниеBoolean true — тайлы поддерживают плавное масштабирование (по умолчанию),

false — нет.

YMaps.ToolBarРасширяет YMaps.Group, YMaps.IControl.

Класс для создания тулбара.

КонструкторИмя ОписаниеYMaps.ToolBar(buttons) Создает элемент управления "Тулбар".


еОписание

DEFAULT_GROUP Группа для стандартных кнопок.

MagnifierButton Конструктор стандартной кнопки "Выделение".

MoveButton Конструктор стандартной кнопки "Навигация".

RulerButton Конструктор стандартной кнопки "Линейка".


Events


Add, Remove


200


МетодыИмя Возвращает ОписаниеgetByGroupId(groupId) YMaps.ToolBarRadioButton[] Возвращает список кнопок

указанной группы.

getMap() YMaps.Map Возвращает карту, на которуюдобавлен тулбар.

Наследуемые методыИз YMaps.Group:

add, filter, forEach, get, indexOf, length, remove, removeAll, spliceИз YMaps.IControl:


Подробное описание конструктораYMaps.ToolBar(buttons)

Создает элемент управления "Тулбар".

Положение элемента по умолчанию: YMaps.ControlPosition.TOP_LEFT, отступ от краев кар-ты — 5 пикселов.

Параметры:

Имя Тип Необязательный По умолчанию Описаниеbuttons YMaps.IToolBarItem|

YMaps.IToolBarItem[]

[newYMaps.ToolBar.MoveButton(),new YMaps.ToolBar.MagnifierButton(),new YMaps.ToolBar.RulerButton()]

Кнопки в тулбаре.


DEFAULT_GROUPDEFAULT_GROUP

Группа для стандартных кнопок.

MagnifierButtonMagnifierButton

Конструктор стандартной кнопки "Выделение".

Для создания экземпляра кнопки выполните команду newYMaps.ToolBar.MagnifierButton().

MoveButtonMoveButton

Конструктор стандартной кнопки "Навигация".

Для создания экземпляра кнопки выполните команду new YMaps.ToolBar.MoveButton().


201


RulerButtonRulerButton

Конструктор стандартной кнопки "Линейка".

Для создания экземпляра кнопки выполните команду new YMaps.ToolBar.RulerButton().


getByGroupId{YMaps.ToolBarRadioButton[]} getByGroupId(groupId)

Возвращает список кнопок указанной группы.

Параметры:

Имя Тип ОписаниеgroupId String Идентификатор группы.


Тип ОписаниеYMaps.ToolBarRadioButton[] Массив указателей на кнопку.


Возвращает карту, на которую добавлен тулбар.


Тип ОписаниеYMaps.Map Указатель на карту, в которую добавлен тулбар.

YMaps.ToolBarButtonРасширяет YMaps.IToolBarItem.

Класс кнопки тулбара.

КонструкторИмя ОписаниеYMaps.ToolBarButton(content, options) Создает кнопку тулбара.

ПоляИмя ОписаниеEvents Список событий кнопки.


202


СобытияИмя ОписаниеClick Событие щелчка мышью по кнопке.

МетодыИмя Возвращает Описаниеdeselect() Устанавливает кнопку в состояние

"не нажата".

disable() Устанавливает кнопку в состояние"недоступно".

enable() Устанавливает кнопку в состояние"доступно".

getContent() Object Возвращает содержимое кнопки.

getToolBar() YMaps.ToolBar Возвращает тулбар, на которыйдобавлена кнопка.

hide() Скрывает кнопку.

isEnabled() Boolean Возвращает состояние кнопки"доступна"/"недоступна".

isSelected() Boolean Возвращает состояние кнопки"нажата"/"не нажата".

isShown() Boolean Возвращает состояние видимостикнопки.

select() Переводит кнопку в состояние"нажата".

setContent(content) Устанавливает содержимое кнопки.

show() Показывает кнопку.



Подробное описание конструктораYMaps.ToolBarButton(content, options)

Создает кнопку тулбара. Обычная кнопка тулбара имеет три состояния: кнопка нажата, кнопка не на-жата, кнопка недоступна.

Пример:

// Создает и добавляет на тулбар кнопку, которая включает инструмент "Линейка".var btn = new YMaps.ToolBarButton({ icon: "http://some.url/path/img.gif", caption: "Линейка", hint: "Линейка для измерения расстояний между точками"});YMaps.Events.observe(btn, btn.Events.Click, function () { this.getMap().enableRuler();}, toolbar);toolbar.add(btn);

Параметры:

Имя Тип Необязательный По умолчанию Описаниеcontent Object Содержимое кнопки.

content.icon String URL значка кнопки.

content.caption String Текст кнопки.


203


Имя Тип Необязательный По умолчанию Описаниеcontent.hint String Подсказка

для кнопки.

content.width Integer Ширинасодержимого кнопки(в пикселах).

options Object Настройки кнопки.

options.selected

Boolean false Исходное состояниекнопки: true —нажата, false —не нажата.

options.enabled Boolean true true — кнопкадоступна, false —кнопка недоступна.


EventsObject Events

Список событий кнопки.


ClickClick

Событие щелчка мышью по кнопке. В callback-функцию передается ссылка на кнопку, для которойбыл вызван обработчик.


deselectdeselect()

Устанавливает кнопку в состояние "не нажата".

disabledisable()

Устанавливает кнопку в состояние "недоступно". Не применяется к нажатым кнопкам.

enableenable()

Устанавливает кнопку в состояние "доступно".

getContent{Object} getContent()

Возвращает содержимое кнопки.


204



Тип ОписаниеObject

getToolBar{YMaps.ToolBar} getToolBar()

Возвращает тулбар, на который добавлена кнопка.


Тип ОписаниеYMaps.ToolBar Тулбар.

hidehide()

Скрывает кнопку.

isEnabled{Boolean} isEnabled()

Возвращает состояние кнопки "доступна"/"недоступна".


Тип ОписаниеBoolean true — кнопка доступна, false — кнопка недоступна.

isSelected{Boolean} isSelected()

Возвращает состояние кнопки "нажата"/"не нажата".


Тип ОписаниеBoolean true — кнопка нажата, false — кнопка не нажата.

isShown{Boolean} isShown()

Возвращает состояние видимости кнопки.


Тип ОписаниеBoolean true — кнопка видна, false — не видна.

selectselect()

Переводит кнопку в состояние "нажата". Операция не применяется к недоступным кнопкам.


205



Устанавливает содержимое кнопки.

Параметры:

Имя Тип Описаниеcontent Object Содержимое кнопки.

showshow()

Показывает кнопку.

YMaps.ToolBarRadioButtonРасширяет YMaps.ToolBarToggleButton.

Класс для создания кнопки-переключателя на тулбаре.

КонструкторИмя ОписаниеYMaps.ToolBarRadioButton(groupId,content, options)

Создает кнопку-переключатель на тулбаре.

Наследуемые поляИз YMaps.ToolBarButton:

Events

СобытияИмя ОписаниеSelect Событие выбора кнопки.

Наследуемые событияИз YMaps.ToolBarToggleButton:

DeselectИз YMaps.ToolBarButton:

Click

МетодыИмя Возвращает ОписаниеgetGroupId() String Возвращает имя группы, которой

принадлежит кнопка.


206


Наследуемые методыИз YMaps.ToolBarButton:

deselect, disable, enable, getContent, getToolBar, hide, isEnabled, isSelected, isShown, select,setContent, show

Из YMaps.IToolBarItem:onAddToToolBar, onRemoveFromToolBar

Подробное описание конструктораYMaps.ToolBarRadioButton(groupId, content, options)


Пример:

// Создает и добавляет на тулбар две кнопки-переключателя, которые включают/выключают элементы управления // "Линейка" и "Увеличение", соответственно.var btn1 = new YMaps.ToolBarRadioButton('my-group', { icon: "http://some.url/path/img.gif", caption: "Линейка"});var btn2 = new YMaps.ToolBarRadioButton('my-group', { icon: "http://some.url/path/img.gif", caption: "Увеличить"});YMaps.Events.observe(btn1, btn1.Events.Select, function () { this.getMap().enableRuler();}, toolbar);YMaps.Events.observe(btn1, btn1.Events.Deselect, function () { this.getMap().disableRuler();}, toolbar);YMaps.Events.observe(btn2, btn2.Events.Select, function () { this.getMap().enableMagnifier();}, toolbar);YMaps.Events.observe(btn2, btn2.Events.Deselect, function () { this.getMap().disableMagnifier();}, toolbar);toolbar.add(btn1);toolbar.add(btn2);

Параметры:

Имя Тип Необязательный По умолчанию ОписаниеgroupId String Группа, к которой

принадлежит кнопка.

content Object Содержимое кнопки.



content.hint String Подсказкадля кнопки.


options Object Опции кнопки.

options.selected




207



SelectSelect

Событие выбора кнопки.


• ссылка на кнопку;

• ссылка на предыдущую выделенную кнопку в группе.


getGroupId{String} getGroupId()

Возвращает имя группы, которой принадлежит кнопка.


Тип ОписаниеString

YMaps.ToolBarSeparatorРасширяет YMaps.IToolBarItem.

Класс для создания разделителя на тулбаре.

КонструкторИмя ОписаниеYMaps.ToolBarSeparator(width) Создает разделитель на тулбаре



Подробное описание конструктораYMaps.ToolBarSeparator(width)

Создает разделитель на тулбаре

Пример:

// Создает разделитель тулбара шириной 30 пикселов.toolBar.add(new YMaps.ToolBarSeparator(30));


208


Параметры:

Имя Тип Необязательный По умолчанию Описаниеwidth Integer 20 Ширина разделителя

в пикселах(по умолчанию 20).

YMaps.ToolBarToggleButtonРасширяет YMaps.ToolBarButton.

Класс для создания кнопки-переключателя на тулбаре.

КонструкторИмя ОписаниеYMaps.ToolBarToggleButton(content,options)


Наследуемые поляИз YMaps.ToolBarButton:

Events

СобытияИмя ОписаниеDeselect Событие отмены выбора кнопки.

Select Событие выбора кнопки.

Наследуемые событияИз YMaps.ToolBarButton:

Click

Наследуемые методыИз YMaps.ToolBarButton:

deselect, disable, enable, getContent, getToolBar, hide, isEnabled, isSelected, isShown, select,setContent, show

Из YMaps.IToolBarItem:onAddToToolBar, onRemoveFromToolBar

Подробное описание конструктораYMaps.ToolBarToggleButton(content, options)


Пример:

// Создает и добавляет на тулбар кнопку-переключатель, которая включает инструмент "Линейка".var btn = new YMaps.ToolBarToggleButton({ icon: "http://some.url/path/img.gif", caption: "Линейка", hint: "Линейка для измерения расстояний между точками"});YMaps.Events.observe(btn, btn.Events.Select, function () { this.getMap().enableRuler();}, toolbar);YMaps.Events.observe(btn, btn.Events.Deselect, function () { this.getMap().disableRuler();


209


}, toolbar);toolbar.add(btn);

Параметры:

Имя Тип Необязательный По умолчанию Описаниеcontent Object Содержимое кнопки.



content.hint String Подсказкадля кнопки.


options Object Опции кнопки.

options.selected




DeselectDeselect

Событие отмены выбора кнопки. В callback-функцию передается ссылка на кнопку, для которой был вы-зван обработчик.

SelectSelect

Событие выбора кнопки. В callback-функцию передается ссылка на кнопку, для которой был вызванобработчик.

YMaps.TypeControlРасширяет YMaps.IControl.

Класс для создания элемента управления "Тип карты".

КонструкторИмя ОписаниеYMaps.TypeControl(types,listTypeIndexes)

Создает элемент управления "Типы карты".


210


МетодыИмя Возвращает ОписаниеaddType(mapType, isListItem) Добавляет тип карты.

getTypes() YMaps.MapType[] Возвращает список всех типов карт.

removeType(mapType) Удаляет тип карты.



Подробное описание конструктораYMaps.TypeControl(types, listTypeIndexes)

Создает элемент управления "Типы карты".Положение элемента по умолчанию: YMaps.ControlPosition.TOP_RIGHT, отступ от краев кар-ты — 5 пикселов.

Параметры:

Имя Тип Необязательный По умолчанию Описаниеtypes YMaps.MapType[] [YMaps.MapType.M

AP,YMaps.MapType.SATELLITE,YMaps.MapType.HYBRID]

Список типов карты.

listTypeIndexes Integer[] [] Список индексовтипов карты, которыебудут скрытыв раскрывающемсясписке "Еще".


addTypeaddType(mapType, isListItem)

Добавляет тип карты.

Параметры:

Имя Тип ОписаниеmapType YMaps.MapType Тип карты, который нужно добавить.

isListItem Boolean true, если тип карты будет спрятанпод кнопкой "Еще", falseв противном случае

getTypes{YMaps.MapType[]} getTypes()

Возвращает список всех типов карт.


211



Тип ОписаниеYMaps.MapType[] Список всех типов.

removeTyperemoveType(mapType)

Удаляет тип карты.

Параметры:

Имя Тип ОписаниеmapType YMaps.MapType Тип карты, который нужно удалить.

YMaps.ViaPointКласс для создания транзитной точки маршрута.

КонструкторИмя ОписаниеYMaps.ViaPoint(indexInPolyline) Создает транзитную точку маршрута.

МетодыИмя Возвращает ОписаниеgetPolylineIndex() Integer Возвращает индекс точки в массиве

точек маршрута.

Подробное описание конструктораYMaps.ViaPoint(indexInPolyline)

Создает транзитную точку маршрута.

Параметры:

Имя Тип ОписаниеindexInPolyline Integer Индекс точки в массиве точек

ломаной маршрута.


getPolylineIndex{Integer} getPolylineIndex()

Возвращает индекс точки в массиве точек маршрута.


Тип ОписаниеInteger Индекс точки в массиве точек маршрута.


212


YMaps.WayPointРасширяет YMaps.GeocoderResult.

Класс для создания точки остановки на маршруте.

КонструкторИмя ОписаниеYMaps.WayPoint(geoPoint, options) Создает метку с заданными координатами для обозначения точки

остановки на маршруте.

Наследуемые поляИз YMaps.GeocoderResult:

AddressDetails, kind, precision, textИз YMaps.Placemark:



Наследуемые событияИз YMaps.Placemark:

BalloonClose, BalloonOpen, Click, DblClick, Drag, DragEnd, DragStart, MouseEnter, MouseLeave,MouseMove, PositionChange

Наследуемые методыИз YMaps.Placemark:

getCoordPoint, getGeoPoint, getIconContent, getMap, getOptions, getParentContainer, setCoordPoint,setGeoPoint, setIconContent, setOptions


Из YMaps.IInteractiveGeoObject:closeBalloon, getBalloon, getBalloonContent, getBalloonOptions, getHintContent, getHintOptions,openBalloon, setBalloonContent, setBalloonOptions, setHintContent, setHintOptions, update


Подробное описание конструктораYMaps.WayPoint(geoPoint, options)

Создает метку с заданными координатами для обозначения точки остановки на маршруте.

Параметры:

Имя Тип Необязательный По умолчанию ОписаниеgeoPoint YMaps.GeoPoint Географические

координаты метки.

options YMaps.PlacemarkOptions


YMaps.YMapsMLРасширяет YMaps.GeoObjectCollection.


213


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

См.: API Яндекс.Карт. Справочник по языку YMapsML

КонструкторИмя ОписаниеYMaps.YMapsML(url, options) Создает объект для работы с YMapsML-документами.

ПоляИмя ОписаниеEvents Список событий, возможных в YMaps.YMapsML.

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

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

• mapType {String} — ключ типа карты;

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



СобытияИмя ОписаниеFault Ошибка при загрузке объекта YMapsML.

Load Успешная загрузка документа YMapsML.


Add, Remove

МетодыИмя ОписаниеapplyView() Применяет описанные в YMapsML-документе

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







214


Подробное описание конструктораYMaps.YMapsML(url, options)

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

См.: API Яндекс.Карт. Справочник по языку YMapsML

Параметры:

Имя Тип Необязательный По умолчанию Описаниеurl String URL YMapsML-

документа.


options.viewAutoApply

Boolean true Автоматическиприменять настройкиотображения,указанныев YMapsML-документе.


EventsObject Events

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

viewObject view

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

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

• mapType {String} — ключ типа карты;

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


FaultFault

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


• указатель на ymapsml документ;


LoadLoad

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


215



applyViewapplyView()

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

YMaps.ZIndexСтатический объект.

Список возможных значений, задающих порядок взаимного наложения элементов карты (слоев, эле-ментов управления, меток, всплывающих подсказок, и пр.) друг на друга. Чем больше значение,тем "выше" будет отображен элемент на карте и тем лучше он будет виден.

Если в одной точке карты находится несколько элементов, то выше всех будет отображен элементс максимальным значением zIndex

ПоляИмя ОписаниеCONTROL Элемент управления карты.

MAP_LAYER Слой с картой.

OVERLAY Метка на карте.

OVERLAY_ACTIVE Активная метка на карте.

OVERLAY_DRAG Метка на карте при перетаскивании.

OVERLAY_HOVER Метка на карте при наведении на нее курсора мыши.

POPUP Всплывающий элемент (например, всплывающая подсказка).


CONTROLNumber CONTROL

Элемент управления карты.

MAP_LAYERNumber MAP_LAYER

Слой с картой.

OVERLAYNumber OVERLAY

Метка на карте.

OVERLAY_ACTIVENumber OVERLAY_ACTIVE

Активная метка на карте.


216


OVERLAY_DRAGNumber OVERLAY_DRAG

Метка на карте при перетаскивании.

OVERLAY_HOVERNumber OVERLAY_HOVER

Метка на карте при наведении на нее курсора мыши.

POPUPNumber POPUP

Всплывающий элемент (например, всплывающая подсказка).

YMaps.ZoomРасширяет YMaps.IControl.

Класс для создания элемента управления "Ползунок масштаба".

КонструкторИмя ОписаниеYMaps.Zoom(options) Создает элемент управления "Ползунок масштаба".



Подробное описание конструктораYMaps.Zoom(options)

Создает элемент управления "Ползунок масштаба".

Положение элемента по умолчанию: YMaps.ControlPosition.TOP_LEFT, отступ сверху — 75, от-ступ слева — 5 пикселов.

Пример:

// Создает объект YMaps.Zoom с пользовательскими подсказками и добавляет его на карту.// Коэффициенту масштабирования 1 соответствует подсказка "Мелко",// коэффициенту масштабирования 9 - "Средне",// коэффициенту масштабирования 16 - "Крупно".var zoom = new YMaps.Zoom({ customTips: [ { index: 1, value: "Мелко" }, { index: 9, value: "Средне" }, { index: 16, value: "Крупно" } ]});//Добавление элемента управления на картуmap.addControl(zoom);


217


Параметры:

Имя Тип Необязательный По умолчанию Описаниеoptions Object Опции элемента


options.smooth Boolean true Включает/выключаетвозможностьплавногомасштабированиякарты нажатиемклавиш "+" и "-":true — возможностьвключена, false —выключена.

options.noTips Boolean false Включает/выклю-чает показ всплываю-щих подсказок:true — подсказки вы-ключены, false —включены.

Подсказки показы-ваются справаот шкалы масштабапри наведении на неекурсора мыши.

options.customTips

Object[] Массив описанийподсказок. Каждоеописание — это объ-ект с двумя полями:

• index{Integer} —коэффициентмасштабирования, которомусоответствуетподсказка;

• value{String} — текстподсказки.


218

Предметный указатель

Aabort 87, 93action 182add 16, 17, 30, 35, 39, 40, 47, 98, 101, 140–142, 177, 178, 191,194, 200, 201, 214addControl 108addCopyright 108addCursor 108AddLayer 107, 108addOverlay 108addPoint 156, 167, 175AddressDetails 32, 213addType 211anchor 19, 71angle 182apply 19, 150, 186applyView 177, 214applyX 150, 186applyY 150, 186ARROW 25

BBalloonClose 33, 143, 155, 165, 174, 213balloonContentStyle 188BalloonOpen 33, 143, 155, 165, 174, 213balloonOptions 88, 149balloonStyle 188BeforeClick 107BeforeContextMenu 107BeforeDblClick 107BeforeDOMMouseScroll 107BeforeMouseDown 107BeforeMouseMove 107BeforeMouseUp 107BOTTOM_LEFT 19BOTTOM_RIGHT 19bottomLeft 37boundedBy 175bounds 77, 84, 121, 122BoundsChange 107build 92, 99, 193buttons 201

Ccallback 7, 10, 49, 50, 57caption 103–105center 29, 128cleanup 89clear 16, 35Click 33, 103, 105, 107, 143, 155, 165, 174, 203, 206, 209, 213clientPixels 21, 22clientPixelsToCoordinates 21clientPixelsToLocalPixels 21Close 8closeBalloon 33, 79, 108, 144, 157, 167, 175, 213coefficient 94collapse 101contains 14, 16, 28, 35, 63

content 10, 53, 54, 61, 81, 82, 124, 148, 203, 206, 207, 210content.caption 203, 207, 210content.hint 204, 207, 210content.icon 203, 207, 210content.width 204, 207, 210context 27, 49, 50, 57, 61, 78, 86, 91, 92, 100, 193ContextMenu 107control 116, 126, 216controlPosition 62, 116converter 106coordBounds 64coordinatesToClientPixels 21coordinatesToLocalPixels 21coordinatesToMapPixels 21coordPoint 10, 22, 23, 64, 68, 69, 73, 144, 148coordPoint1 71, 73coordPoint2 71, 73coordSystem 106, 161, 171copy 14, 16, 28, 35, 41, 63, 67, 150, 186, 189copyright 116, 126CROSSHAIR 25cursor 116, 126

DdataSource 87DblClick 33, 107, 143, 156, 166, 174, 213dblClickZoomEnabled 108DEFAULT_GROUP 200DefaultStyleKey 191Delete 44description 17, 30, 33, 39, 74, 79, 143, 155, 165, 174, 177, 213,214Deselect 105, 203, 206, 207, 209Destruct 107destructor 108diff 41, 67, 150, 186direction 130disable 89, 203, 207, 209disableClose 56disableDblClickZoom 108disableDragging 108disableHotKeys 108disableMagnifier 108disableRightButtonMagnifier 108disableRuler 108disableScrollZoom 108distance 6, 15, 36, 40, 70, 175, 182DOMMouseScroll 107Drag 33, 143, 213DragEnd 33, 143, 213draggable 149draggingEnabled 108DragStart 33, 143, 213drawing 45, 164, 173drawOver 45, 164, 173duration 7, 175, 182dx 153



dy 153

Ee 138element 20, 111EMPTY 187enable 27, 89, 203, 207, 209enableClose 56enableDblClickZoom 108enableDragging 108enableHotKeys 108enableMagnifier 109enableRightButtonMagnifier 109enableRuler 109enableScrollZoom 109encodedPoints 161, 171, 175equals 14, 16, 28, 35, 40, 63, 67, 150, 186error 87, 93ERROR_TILE_URL 197eventData 26Events 8, 17, 30, 33, 39, 47, 101, 103, 105, 106, 141, 143, 155,165, 174, 177, 184, 200, 202, 206, 209, 213, 214expand 101

FFAILURE 187Fault 30, 177, 214fill 164fillColor 164filter 17, 30, 40, 47, 101, 142, 178, 201, 214forEach 17, 30, 40, 47, 101, 142, 178, 201, 214found 30fromCenterAndSpan 27fromCoordPoint 15, 37, 70fromEncodedPoints 156, 167fromIndex 164fromPixels 195fromStart 173fromString 41, 150fromZoom 196func 151, 152

GgeoBounds 127GeocodeError 177geoPoint 35, 36, 38, 213get 17, 30, 40, 47, 98, 101, 142, 178, 191, 194, 201, 214getAction 182getAngle 182getBalloon 33, 79, 109, 144, 157, 167, 175, 213getBalloonContent 33, 79, 144, 157, 167, 175, 213getBalloonOptions 33, 79, 144, 157, 167, 175, 213getBottom 14, 16, 28, 35, 63getBounds 17, 30, 33, 40, 74, 79, 109, 144, 157, 167, 175, 178,213, 214getByGroupId 201getCaption 101, 103, 105getCenter 14, 16, 28, 35, 63, 109getComputedStyle 17, 30, 33, 40, 74, 79, 144, 157, 167, 175,178, 213, 214getContainer 97, 109getContainerSize 109

getContent 8, 203, 207, 209getCoordBounds 15, 36, 70getCoordPoint 8, 15, 33, 36, 70, 137, 143, 213getCopyright 83, 97getDistance 174, 177, 182getDuration 174, 177, 182getErrorTileUrl 197getEvent 137getGeoPoint 8, 33, 137, 143, 213getGroupId 206getHintContent 33, 79, 144, 157, 167, 175, 213getHintOptions 33, 79, 144, 157, 167, 175, 213getIconContent 33, 143, 213getLat 41getLayers 133getLeft 14, 16, 28, 35, 63getLeftBottom 14, 16, 28, 35, 63getLeftTop 14, 16, 28, 35, 63getLineVisible 17getListBox 103, 105getLng 41getLocalPixels 137getMap 17, 30, 33, 40, 97, 142, 143, 157, 167, 175, 178, 201,213, 214getMapZoom 14, 16, 28, 35, 63getMaxZoom 15, 37, 70, 109, 133getMinZoom 109, 133getName 133getNumPoints 157, 167, 175getNumRoutes 177getNumRouteSegments 174getNumViaPoints 174getNumWayPoints 177getOffset 56, 91getOptions 8, 33, 79, 143, 157, 167, 175, 213getParentContainer 17, 30, 33, 40, 142, 143, 178, 213, 214getParentGroup 17, 30, 33, 40, 74, 79, 144, 157, 167, 175, 178,213, 214getPoint 157, 167, 175getPolylineIndex 182, 212getPosition 87, 93getRight 14, 16, 28, 35, 63getRightBottom 14, 16, 28, 35, 63getRightTop 14, 16, 28, 35, 63getRoute 177getRouteSegment 174getRulerState 109getSize 56, 77getSpan 14, 16, 28, 35, 63getState 87getStreet 182getStyle 17, 30, 33, 40, 74, 79, 144, 157, 167, 175, 178, 213,214getTextColor 133getTile 197getTileInPosition 97getTileUrl 197getTileUrlTemplate 197getToolBar 101, 203, 207, 209getTop 14, 16, 28, 35, 63getType 109, 135, 211getViaPoint 174getVisible 135


220


getWayPoint 177getWorldSize 15, 37, 70getX 41, 67, 150, 186getY 41, 67, 150, 186getZoom 109getZoomRange 83, 97GRAB 25group 96groupId 202, 207

HhasBalloon 88, 149, 188hasCloseButton 12, 131hasHint 88, 149, 188HELP 25hide 52, 203, 207, 209hideIcon 149hideTimeout 52hint 107hintContentStyle 188hintOptions 88, 149hintStyle 188holdOnMouseOver 55, 132hotKeysEnabled 109href 59, 60humanDistance 5humanDuration 5HYBRID 132

IiconContentStyle 188iconStyle 188id 17, 30, 33, 39, 74, 79, 143, 155, 165, 174, 177, 213, 214index 49–51, 160, 162, 163, 170–173, 176, 181, 218indexInPolyline 182, 212indexOf 17, 30, 40, 47, 101, 142, 178, 201, 214INHERIT 25interactive 88, 149isEnabled 203, 207, 209isExpanded 101isListItem 211isMapEventPrevented 137isSelected 105, 203, 207, 209isShown 52, 203, 207, 209isTransparent 198isUnbounded 41

JJavaScript API 5jQuery 5

Kkind 32, 213

Llat 41, 43layer 98, 117, 126, 133layerKey 98, 99layersOnly 121, 122layoutClass 99layoutContext 131, 132leftBottom 14, 15, 63, 71

length 17, 30, 40, 47, 101, 142, 178, 201, 214levels 161, 171, 175lineStyle 188listener 27listTypeIndexes 211lng 41, 43load 5, 30, 87, 93, 177, 187, 214localPixels 23, 24localPixelsToClientPixels 21localPixelsToCoordinates 21localPixelsToMapPixels 21

MMagnifierButton 200magnifierEnabled 109map 57, 61, 62, 65, 78, 84, 86, 90–92, 94, 100, 132, 138, 193MAP_LAYER 216mapAutoPan 8, 12, 131mapPixels 24mapPixelsToCoordinates 21mapPixelsToLocalPixels 21mapType 128, 136, 211, 212margin 12, 131maxHeight 12, 55, 58, 78, 131, 132maxPoints 45, 164, 173maxWidth 12, 55, 58, 78, 131, 132maxZoom 16, 37, 128, 141menuManager 45, 164, 173metaDataProperty 17, 30, 33, 39, 74, 79, 143, 155, 165, 174,177, 213, 214minZoom 128, 141MouseDown 107MouseEnter 33, 143, 156, 166, 174, 213MouseLeave 33, 143, 156, 166, 174, 213MouseMove 33, 107, 143, 156, 166, 174, 213MouseUp 107MOVE 25, 107MoveButton 200moveBy 41, 67, 109, 150, 186moveByX 150, 186moveByY 150, 186MoveEnd 107MoveStart 107moveTo 41, 52, 56, 67, 77, 150, 186moveToX 150, 186moveToY 150, 186

Nname 17, 30, 33, 39, 74, 79, 133, 143, 155, 165, 174, 177, 213,214neg 150, 186noRecursion 49northEast 28notify 26number 51, 163, 167, 172, 173, 195, 196

Oobject 26, 27, 49–51, 141observe 26offsets 19, 55, 59, 60, 85, 132, 195, 196onAddToGroup 17, 30, 33, 40, 74, 79, 144, 157, 167, 175, 178,213, 214


221


onAddToMap 8, 17, 30, 33, 40, 62, 83, 87, 90, 93, 97, 136,140, 142, 144, 157, 167, 175, 178, 184, 185, 187, 201, 211,213, 214, 217onAddToParent 56, 61, 77, 86, 91onAddToToolBar 95, 101, 103, 105, 203, 207–209onClose 131onDblClick 45, 164, 173onHide 132onMapUpdate 8, 17, 30, 33, 40, 83, 90, 97, 140, 142, 144, 157,167, 175, 178, 213, 214onMove 83, 97onRemoveFromGroup 17, 30, 33, 40, 74, 79, 144, 157, 167,175, 178, 213, 214onRemoveFromMap 8, 17, 30, 33, 40, 62, 83, 87, 90, 93, 97,136, 140, 142, 144, 157, 167, 175, 178, 184, 185, 187, 201,211, 213, 214, 217onRemoveFromParent 56, 61, 77, 86, 91onRemoveFromToolBar 95, 101, 103, 105, 203, 207–209onSmoothZoomEnd 83, 97onSmoothZoomStart 83, 97onSmoothZoomTick 83, 97openBalloon 33, 79, 110, 144, 157, 167, 175, 213options 9, 11, 31, 33, 53, 54, 79, 81, 82, 102, 111, 118–120,124, 125, 129, 130, 133, 140, 144, 148, 158, 161, 162, 168,171, 172, 179, 185, 187, 204, 207, 210, 213, 215, 218options.boundedBy 31options.callback 124, 125, 129–131options.caption 102options.cellSize 140options.centering 129, 131options.coordSystem 111options.customTips 218options.enabled 204, 207, 210options.flying 125options.ignoreResize 111options.maxZoom 134options.minZoom 134options.noCentering 185options.noPlacemark 185options.noTips 218options.padding 140options.position 129, 130options.results 31options.resultsPerPage 185options.selected 204, 207, 210options.skip 31options.smooth 118–120, 129, 130, 187, 218options.speed 124, 130options.speedUpTime 124, 130options.startSpeed 124, 130options.textColor 133options.trackObjects 140options.useMapBounds 185options.viewAutoApply 179, 215options.width 102, 185outline 164overlay 117, 127, 216OVERLAY_ACTIVE 216OVERLAY_DRAG 216

OVERLAY_HOVER 216

PpanTo 110params 85params.saveThisPosition 85params.scaleCoefficient 85params.sizeCoefficientDiff 85parentContainer 84, 90, 94, 96parentGroup 76parentNode 86parentStyle 188, 189pixelPoint 39, 73, 195pixels 23pixelsOffset 124point 16, 33, 41, 42, 58, 68, 71, 124, 152, 158, 160, 162, 168,170, 172, 196point1 37, 38point2 37, 38POINTER 25polygonStyle 188POPUP 216pos 98position 53, 78, 85, 94PositionChange 33, 143, 156, 166, 174, 213precision 33, 43, 155, 213preventMapEvent 137

Rradius 37Redraw 107, 110Remove 17, 30, 39, 40, 47, 98, 101, 140–142, 177, 178, 191,194, 200, 201, 214removeAll 17, 30, 40, 48, 101, 140, 142, 178, 201, 214removeAllOverlays 110removeControl 110removeCopyright 110removeCursor 110RemoveLayer 107, 110removeOverlay 110removePoint 157, 167, 175removeType 211request 30, 31restoreDefault 11, 82, 148restrict 15, 36, 70rightButtonMagnifierEnabled 110rightTop 14, 15, 63, 71roughly 6RouteError 177routeSegments 175RulerButton 200rulerDistance 15, 36, 70rulerEnabled 110rulerState 128

SSATELLITE 132scale 15, 87, 93, 150, 186, 195scaleCoef 154scaleX 150, 186scaleY 150, 186scrollZoomEnabled 110


222


Select 105, 184, 203, 206, 207, 209setBalloonContent 33, 79, 144, 157, 167, 175, 213setBalloonOptions 33, 79, 144, 157, 167, 175, 213setBounds 17, 30, 33, 40, 74, 79, 110, 144, 157, 167, 175, 178,213, 214setCaption 101, 103, 105setCenter 110setContent 8, 52, 56, 61, 77, 91, 203, 207, 209setCoordPoint 8, 33, 143, 213setEditingOptions 157, 167, 175setGeoPoint 8, 33, 143, 213setHintContent 33, 79, 144, 157, 167, 175, 213setHintOptions 33, 79, 144, 157, 167, 175, 213setIconContent 33, 144, 213setLat 41setLineVisible 17setLng 41setMaxSize 56, 77setMaxZoom 110setMinZoom 110setOptions 8, 33, 52, 79, 144, 157, 167, 175, 213setPoints 157, 167, 175setPosition 87, 93setRulerState 110setStyle 17, 30, 33, 40, 74, 79, 144, 157, 167, 175, 178, 213,214setTileUrlTemplate 198setType 110, 135setVisible 135setX 41, 67, 150, 186setY 41, 67, 150, 186setZoom 110shadow 60show 52, 203, 207, 209size 59, 60smooth 124smoothCentering 125smoothZoomEnabled 198SmoothZoomEnd 107SmoothZoomStart 107southWest 28span 29splice 17, 30, 40, 48, 101, 142, 178, 201, 214splicePoints 157, 167, 175StartDrawing 44, 156, 166, 174StartEditing 156, 157, 166, 167, 174, 175startMove 110StopDrawing 44, 156, 166, 174stopDrawingByDblClick 45, 164, 173StopEditing 156, 157, 166, 167, 174, 175stopMove 110street 182string 42, 152strokeColor 100, 164strokeWidth 100, 164style 12, 18, 40, 77, 88, 131, 149, 190, 192styleKey 192Success 177, 187suggest 30

Ttemplate 11, 13, 14, 54–56, 58–60, 194, 200

templateKey 194text 33, 92, 193, 213tile 199TILE_SIZE 5tileCoordinates 107tileDataSource 93, 97tileNumber 94tileUrlTemplate 198toCoordPoint 15, 36, 70toolBar 96TOP_LEFT 19TOP_RIGHT 19toPixels 195toPoint 125topRight 37toString 41, 150, 186toZoom 196TRANPARENT_TILE_URL 197type 26, 27, 211TypeChange 107

Uunbounded 22–24, 38, 39, 41, 72, 73, 120, 138update 8, 17, 30, 33, 40, 56, 61, 74, 77, 79, 86, 91, 107, 110,144, 157, 167, 175, 178, 213, 214url 215

Vvalue 218vector 69viaPoints 175, 179view 214visible 18, 137

WwayPoints 179width 209

Xx 38, 67, 69, 72, 150, 151, 153, 186

Yy 38, 67, 69, 72, 150, 151, 153, 186YMaps.Balloon 8, 79, 80, 109, 120YMaps.Balloon.getCoordPoint 8, 9YMaps.Balloon.setContent 8, 9YMaps.Balloon.setCoordPoint 8, 10YMaps.BalloonContentStyle 11, 189YMaps.BalloonOptions 8–11, 131YMaps.BalloonOptions.margin 8, 10YMaps.BalloonStyle 13, 57, 189YMaps.Bounds 14, 16, 27YMaps.CartesianCoordSystem 15YMaps.CollectionBounds 16YMaps.ConnectedPlacemarks 17YMaps.ControlPosition 19, 62, 116YMaps.ControlPosition.BOTTOM_LEFT 136YMaps.Converter 106, 111YMaps.Cursor 116, 126YMaps.GeoBounds 27–29, 31, 35–37, 62, 175YMaps.Geocoder 30YMaps.GeocoderResult 32, 185, 186, 213


223


YMaps.GeoCollectionBounds 35, 36YMaps.GeoCoordSystem 36, 38YMaps.GeoObjectCollection 17, 29, 39, 176, 213YMaps.GeoPoint 28, 29, 33, 35–43, 66, 179, 213YMaps.GraphicsEditingOptions 163, 164, 173YMaps.GraphicsEditingOptions.stopDrawingByDblClick 45YMaps.Group 17, 30, 39, 40, 47, 96, 100, 101, 141, 142, 177,178, 200, 201, 214YMaps.Hint 107, 111, 132YMaps.HintContentStyle 54, 189YMaps.HintOptions 79–82, 88, 132YMaps.HintStyle 55, 77, 189YMaps.IBalloonLayout 13, 14, 56YMaps.IconContentStyle 58, 190YMaps.IconShadowStyle 59, 60YMaps.IconStyle 60, 91, 190YMaps.IContentableLayout 56, 61, 77, 91YMaps.IControl 62, 116, 126, 135, 136, 184, 185, 187, 200,201, 210, 211, 217YMaps.ICoordBounds 14, 16, 28, 35, 62–64, 70, 71, 74, 75,77, 84, 109, 110, 120–122, 127YMaps.ICoordPoint 8–10, 21–24, 40, 41, 63–74, 85, 109, 120,121, 124, 125, 128–130, 137, 138, 143, 144, 146–150, 157,158, 160–163, 167, 168, 170–173, 186YMaps.ICoordSystem 14, 15, 36, 37, 70, 106, 111, 161, 171YMaps.IGeoObject 17, 30, 33, 39, 40, 74, 76, 78, 79, 143, 144,155, 157, 165, 167, 174, 175, 177, 178, 190, 213, 214YMaps.IHintLayout 55, 56, 77YMaps.IInteractiveGeoObject 33, 78, 142, 144, 155, 157, 165,167, 175, 213YMaps.IInteractiveGeoObject.openBalloon 88YMaps.IInteractiveGeoObject.setHintContent 79, 80YMaps.ILayer 83, 96–99, 117, 126YMaps.ILayout 8–10, 53, 54, 56, 61, 77, 79–82, 86, 91, 92, 99,100, 143, 147, 148, 193YMaps.ImageTile 87YMaps.InteractiveGeoObjectOptions 79, 81, 82, 148, 149, 158,161, 168, 171YMaps.IObserver 26, 27, 89YMaps.IOverlay 7, 8, 17, 30, 33, 40, 90, 117, 127, 139–142,144, 155, 157, 165, 167, 175, 178, 213, 214YMaps.IPlacemarkLayout 59–61, 91YMaps.ITemplate 92, 194, 195YMaps.ITile 86, 87, 92, 97, 98, 197, 199YMaps.IToolBarItem 95, 100, 101, 103, 105, 201–203,207–209YMaps.Layer 96, 133YMaps.LayoutTemplate 99YMaps.LineStyle 100, 164, 190YMaps.ListBox 96, 101, 103–105YMaps.ListBoxItem 103–105YMaps.ListBoxToggleItem 105YMaps.load 7YMaps.Map 20, 51, 57, 61, 62, 65, 78, 84, 86, 90–92, 94, 97,100, 106, 138, 142, 143, 147, 157, 161, 167, 171, 193, 195, 201,202YMaps.Map.closeBalloon 7YMaps.Map.converter 20YMaps.Map.hint 51YMaps.Map.openBalloon 7, 131YMaps.Map.removeCursor 116YMaps.Map.setMaxZoom 121YMaps.Map.setMinZoom 122

YMaps.Map.tileCoordinates 195YMaps.MapBalloonOptions 79–82, 88, 124YMaps.MapHintOptions 53, 54YMaps.MapType 109, 121, 122, 128, 132, 135, 136, 211, 212YMaps.MiniMap 135YMaps.MouseEvent 112–114, 137, 145, 146, 156, 159, 166, 168,169YMaps.MouseEvent.getCoordPoint 137, 138YMaps.MouseEvent.preventMapEvent 137, 139YMaps.ObjectManager 140YMaps.OverlayGroup 17, 30, 39, 40, 47, 141, 178, 214YMaps.Placemark 32, 33, 141, 142, 213YMaps.Placemark.getCoordPoint 143, 147YMaps.Placemark.setCoordPoint 143, 148YMaps.Placemark.setGeoPoint 143, 146YMaps.Placemark.setIconContent 143, 147YMaps.PlacemarkOptions 143, 144, 147, 148, 213YMaps.Point 14–16, 19, 21–25, 39, 53, 55–60, 67–71, 73, 78,85, 91, 93, 94, 98, 114, 124, 130, 137, 139, 149–155, 186,195–197, 199YMaps.Polygon 155, 156, 160, 161YMaps.Polygon.addPoint 156, 159YMaps.PolygonEditingOptions 162YMaps.PolygonStyle 164, 190YMaps.Polyline 165, 167, 170, 171, 174, 175YMaps.Polyline.addPoint 166, 169YMaps.PolylineEditingOptions 172YMaps.Route 174, 177, 181YMaps.Router 177YMaps.RouteSegment 174–176, 181YMaps.ScaleLine 184YMaps.SearchControl 184YMaps.Size 29, 56, 57, 59, 60, 63, 66, 70, 72, 77, 78, 109, 121,186YMaps.SmallZoom 187YMaps.State 87YMaps.State.FAILURE 124, 125, 129–131YMaps.State.SUCCESS 124, 125, 129–131YMaps.Style 18, 40, 74, 76, 77, 88, 188–192YMaps.Styles.DefaultStyleKey 13, 88YMaps.Template 11, 14, 54, 56, 58–60, 193YMaps.TileCoordinates 107, 111YMaps.TileDataSource 87, 93, 96, 97, 197YMaps.ToolBar 96, 101, 102, 200, 203, 205YMaps.ToolBarButton 202, 206, 207, 209YMaps.ToolBarRadioButton 201, 202, 206YMaps.ToolBarSeparator 208YMaps.ToolBarToggleButton 206, 209YMaps.TypeControl 133, 135, 210YMaps.ViaPoint 174–176, 212YMaps.WayPoint 177, 181, 213YMaps.YMapsML 214YMaps.Zoom 217

ZZOOM 25, 84, 94, 128, 129, 195, 196, 199zoomBy 110zoomDiff 130zoomOffset 136


224

API Яндекс.КартСправочник по программному интерфейсу

11.08.2009

Business

Yandex Maps Jsapi Reference