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

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

EventsEvents

Object Events

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

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

AddToMapAddToMap

AddToMap

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

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

BalloonCloseBalloonClose

BalloonClose

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

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

BalloonOpenBalloonOpen

BalloonOpen

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

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

ClickClick

Click

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

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

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

DblClickDblClick

DblClick

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

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

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

DragDrag

Drag

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

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

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

DragEndDragEnd

DragEnd

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

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

DragStartDragStart

DragStart

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

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

MouseEnterMouseEnter

MouseEnter

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

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

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

MouseLeaveMouseLeave

MouseLeave

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

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

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

MouseMoveMouseMove

MouseMove

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

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

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

PositionChangePositionChange

PositionChange

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

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

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

RemoveFromMapRemoveFromMap

RemoveFromMap

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

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

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

getContentLayoutgetContentLayout

{YMaps.ILayout} getContentLayout()

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

Пример:

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

Возвращает:

getCoordPointgetCoordPoint

{YMaps.ICoordPoint} getCoordPoint()

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

Возвращает:

getGeoPointgetGeoPoint

{YMaps.ICoordPoint} getGeoPoint()

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

Возвращает:

getIconContentgetIconContent

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

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

Возвращает:

getIconLayoutgetIconLayout

{YMaps.IPlacemarkLayout} getIconLayout()

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

Пример:

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

Возвращает:

getIconShadowLayoutgetIconShadowLayout

{YMaps.IPlacemarkLayout} getIconShadowLayout()

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

Пример:

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

Возвращает:

getMapgetMap

{YMaps.Map} getMap()

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

Возвращает:

getOptionsgetOptions

{YMaps.PlacemarkOptions} getOptions()

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

Возвращает:

getParentContainergetParentContainer

{HTMLElement} getParentContainer()

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

Возвращает:

setCoordPointsetCoordPoint

setCoordPoint(coordPoint)

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

Параметры:

setGeoPointsetGeoPoint

setGeoPoint(coordPoint)

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

Параметры:

setIconContentsetIconContent

setIconContent(content)

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

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

Параметры:

setOptionssetOptions

setOptions(options, restoreDefault)

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

Параметры:

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