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 7000
Email: pr@yandex-team.ru
Главный офис: 111033, г. Москва, ул. Самокатная, д. 1, стр. 21

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

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

4

Содержание

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


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

О справочнике
Справочник содержит описание программного интерфейса 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.

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

jQuery
function jQuery

Фреймворк jQuery.
Используется версия 1.3.2.

TILE_SIZE
Integer TILE_SIZE

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



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

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(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 часов, то округляется с точностью до минут.



Если время меньше 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 Строковое представление времени.

load
load(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.



См.: Балун

Конструктор
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-содержимое и клиновидного "хвостика", ука-
зывающего в определенную точку на карте. Балун, например, всплывает при щелчке мышью по метке.
Балун является оверлеем.



См.: Балун
Параметры:

options YMaps.BalloonOptio Опции балуна.
ns


Events
Object Events

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

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

Close
Close

Закрытие балуна. В 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 Координаты балуна.



getOptions
{YMaps.BalloonOptions} getOptions()

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

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

mapAutoPan
mapAutoPan(callback)

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

callback Function Функция-обработчик для события
окончания сдвига карты.

setContent
setContent(content)

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

content String|HTMLElement|YMaps.ILayout Содержимое балуна (строка, DOM-
элемент или макет).

setCoordPoint
setCoordPoint(coordPoint)

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

coordPoint YMaps.ICoordPoint Координаты балуна на карте.

setGeoPoint
setGeoPoint(coordPoint)

То же, что и YMaps.Balloon.setCoordPoint.
Параметры:

coordPoint YMaps.ICoordPoint Координаты балуна на карте.



setOptions
setOptions(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 Незаданные опции
установить
в значения
по умолчанию.

update
update()

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

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

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

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

YMaps.BalloonContentStyle(template)

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

template YMaps.Template| "default#balloonConte Шаблон или ключ
String nt" шаблона.




template
template

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

YMaps.BalloonOptions
Класс содержит опции объекта балуна.
Данный класс не имеет конструктора и создается как обычный объект JavaScript.
Пример:

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

Поля
hasCloseButton Флаг, указывающий, должна ли быть у балуна кнопка закрытия.
mapAutoPan Флаг, указывающий, что при открытии балуна требуется автоматически
сдвигать карту так, чтобы балун был виден целиком.
margin Величина минимального отступа балуна от границ карты (в пикселах).

maxHeight Максимальная высота балуна (в пикселах).
maxWidth Максимальная ширина балуна (в пикселах).
style Объект стиля балуна.


hasCloseButton
Boolean hasCloseButton

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

mapAutoPan
Boolean mapAutoPan

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

margin
Number|Number[] margin

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



Примеры:
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]});

maxHeight
Number maxHeight

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

maxWidth
Number maxWidth

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

style
YMaps.BalloonStyle style

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

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

YMaps.BalloonStyle(template) Создает объект стиля балуна.

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

YMaps.BalloonStyle(template)

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



Параметры:

template YMaps.Template| "default#balloon" Шаблон или ключ
String шаблона.


template
template

Шаблон или ключ шаблона. Шаблон должен генерировать макет, реализующий
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. Понятие ограниченности точек здесь неприменимо, область отображения объектов за-
дается параметрами конструктора.



YMaps.CartesianCoordSystem(leftBotto Создает объект, реализующий декартову систему координат.
m, 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 Количество метров,
соответствующее
единичному отрезку
в данной системе
координат. Напри-
мер, для географиче-
ских карт соответ-
ствует длине одного
градуса дуги; для из-
ображений — разме-
ру пиксела в метрах.
Может задаваться
как одним числом,
так и парой чисел —
в случае, если мас-
штабы вдоль коорди-
натных осей различ-
ны (например,



для планов местности
на высоких широтах).

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

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

YMaps.CollectionBounds(point) Создает объект YMaps.CollectionBounds.

Методы
add(point) Добавляет точки в коллекцию YMaps.CollectionBounds.
clear() Сбрасывает параметры прямоугольной области.

Из YMaps.ICoordBounds:
contains, copy, equals, getBottom, getCenter, getLeft, getLeftBottom, getLeftTop, getMapZoom,
getRight, getRightBottom, getRightTop, getSpan, getTop

YMaps.CollectionBounds(point)

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

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


add
add(point)

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

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



clear
clear()

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

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)

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



Пример:

// Создает стиль для отображения путевых точек маршрута и соединительных линий,
// затем с этим стилем отображает на карте простой маршрут.
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 — соединяющие линии
не видимы.

setLineVisible
setLineVisible(visible)

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

visible Boolean true — соединяющие линии видимы,
false — невидимы.

setStyle
setStyle(style)

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

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



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) Отступы
относительно
заданного угла карты
(в пикселах).




BOTTOM_LEFT
BOTTOM_LEFT

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

BOTTOM_RIGHT
BOTTOM_RIGHT

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

TOP_LEFT
TOP_LEFT

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

TOP_RIGHT
TOP_RIGHT

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


apply
apply(element)

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

element HTMLElement Указатель на HTML-элемент.

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

map YMaps.Map Указатель на карту.



Методы
clientPixelsToCoordinates(clientPixel YMaps.ICoordPoint Преобразует точку, заданную
s, unbounded) пиксельными координатами окна
браузера, в точку координатной
системы.
clientPixelsToLocalPixels(clientPixels YMaps.Point Преобразует точку, заданную
) пиксельными координатами окна
браузера, в точку, заданную
локальными пиксельными
координатами.
coordinatesToClientPixels(coordPoint YMaps.Point Преобразует точку системы
) координат в точку, заданную
пиксельными координатами окна
браузера.
coordinatesToLocalPixels(coordPoint YMaps.Point Преобразует точку координатной
) системы в точку, заданную
coordinatesToMapPixels(coordPoint) YMaps.Point Преобразует точку координатной
системы в точку, заданную
пиксельными координатами карты.
Используется для расчета
местоположения оверлеев на карте.
localPixelsToClientPixels(localPixels) YMaps.Point Преобразует точку, заданную
координатами в точку, заданную
пиксельными координатами окна
браузера.
localPixelsToCoordinates(pixels, YMaps.ICoordPoint Преобразует точку, заданную
unbounded) локальными пиксельными
координатами в точку координатной
системы.
localPixelsToMapPixels(localPixels) YMaps.Point Преобразует точку, заданную
координатами, в точку, заданную
пиксельными координатами карты.
mapPixelsToCoordinates(mapPixels, YMaps.ICoordPoint Преобразует точку, заданную
unbounded) пиксельными координатами карты,
в точку координатной системы.
mapPixelsToLocalPixels(mapPixels) YMaps.Point Преобразует точку, заданную
пиксельными координатами карты,
в точку, заданную локальными
пиксельными координатами.


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

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

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



координатами окна
браузера.
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)

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





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 —
неограниченная.


Yandex Maps Jsapi Reference

Recomendados

Recomendados

Mais conteúdo relacionado

Semelhante a Yandex Maps Jsapi Reference

Semelhante a Yandex Maps Jsapi Reference (20)

Yandex Maps Jsapi Reference