YMaps.Placemark

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

Метка на карте.

См.: Метка

Конструктор

Поля

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

Из YMaps.IGeoObject:

description, id, metaDataProperty, name

События

Методы

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

Из 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.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			Опции метки.

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

Events

Object Events

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

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

AddToMap

AddToMap

Добавление метки на карту.

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

BalloonClose

BalloonClose

Закрытие балуна метки.

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

BalloonOpen

BalloonOpen

Открытие балуна метки.

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

Click

Click

Щелчок мыши по метке.

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

• указатель на метку, для которой был вызван обработчик;
• указатель на объект события мыши YMaps.MouseEvent.

DblClick

DblClick

Двойной щелчок мыши по метке.

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

• указатель на метку, для которой был вызван обработчик;
• указатель на объект события мыши YMaps.MouseEvent.

Drag

Drag

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

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

• указатель на метку, для которой был вызван обработчик;
• объект YMaps.Point со значением смещения метки в пикселах относительно ее предыдущего положения.

DragEnd

DragEnd

Закончено перетаскивание метки.

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

DragStart

DragStart

Началось перетаскивание метки (если разрешено).

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

MouseEnter

MouseEnter

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

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

• указатель на метку, для которой был вызван обработчик;
• указатель на объект события мыши YMaps.MouseEvent.

MouseLeave

MouseLeave

Курсор убран со значка метки.

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

• указатель на метку, для которой был вызван обработчик;
• указатель на объект события мыши YMaps.MouseEvent.

MouseMove

MouseMove

Движение курсора мышкой в пределах значка метки.

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

• указатель на метку, для которой был вызван обработчик;
• указатель на объект события мыши YMaps.MouseEvent.

PositionChange

PositionChange

Изменено местоположение метки (например, с помощью функции YMaps.Placemark.setGeoPoint).

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

• указатель на метку, для которой был вызван обработчик;
• объект с полями:
  • oldPoint - старая географическая позиция,
  • newPoint - новая географическая позиция.

RemoveFromMap

RemoveFromMap

Удаление метки с карты.

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

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

getContentLayout

{YMaps.ILayout} getContentLayout()

Возвращает макет содержимого значка метки. Если метка не добавлена на карту, то возвращает null.

Пример:

var layout = placemark.getContentLayout();
layout.getRootNodes().css('color', 'red');

Возвращает:

getCoordPoint

{YMaps.ICoordPoint} getCoordPoint()

Возвращает точку координатной системы, к которой привязана метка.

Возвращает:

getGeoPoint

{YMaps.ICoordPoint} getGeoPoint()

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

Возвращает:

getIconContent

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

Возвращает содержимое значка метки, установленное с помощью метода YMaps.Placemark.setIconContent.

Возвращает:

getIconLayout

{YMaps.IPlacemarkLayout} getIconLayout()

Возвращает макет значка метки. Если метка не добавлена на карту, то возвращает null.

Пример:

var layout = placemark.getIconLayout();
layout.getRootNodes().addClass('my-class');

Возвращает:

getIconShadowLayout

{YMaps.IPlacemarkLayout} getIconShadowLayout()

Возвращает макет тени значка метки. Если метка не добавлена на карту, то возвращает null.

Пример:

var layout = placemark.getIconShadowLayout();
layout.getRootNodes().addClass('my-shadow-class');

Возвращает:

getMap

{YMaps.Map} getMap()

Возвращает указатель на карту, в которую добавлена метка.

Возвращает:

getOptions

{YMaps.PlacemarkOptions} getOptions()

Возвращает опции метки.

Возвращает:

getParentContainer

{HTMLElement} getParentContainer()

Возвращает указатель на родительский контейнер.

Возвращает:

setCoordPoint

setCoordPoint(coordPoint)

Устанавливает точку координатной системы, к которой привязана метка.

Параметры:

setGeoPoint

setGeoPoint(coordPoint)

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

Параметры:

setIconContent

setIconContent(content)

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

Содержимое значка, установленное с помощью этого метода, имеет приоритет перед содержимым, созданным с использованием текущего стиля.

Параметры:

setOptions

setOptions(options, restoreDefault)

Устанавливает опции метки.

Параметры:

Имя	Тип	Необязательный	По умолчанию	Описание
options	YMaps.PlacemarkOptions			Объект опций.
restoreDefault	Boolean		false	Незаданные опции установить в значения по умолчанию.