YMaps.Placemark

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

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

См.: Метка

Конструктор

Имя Описание
YMaps.Placemark(coordPoint, options)

Создает метку в точке с заданными географическими координатами.

Поля

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

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

Из YMaps.IGeoObject:
description, id, metaDataProperty, name

События

Имя Описание
AddToMap

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

BalloonClose

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

BalloonOpen

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

Click

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

DblClick

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

Drag

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

DragEnd

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

DragStart

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

MouseEnter

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

MouseLeave

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

MouseMove

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

PositionChange

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

RemoveFromMap

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

Методы

Имя Возвращает Описание
getContentLayout() YMaps.ILayout Возвращает макет содержимого значка метки.
getCoordPoint() YMaps.ICoordPoint Возвращает точку координатной системы, к которой привязана метка.
getGeoPoint() YMaps.ICoordPoint То же, что и YMaps.Placemark.getCoordPoint
getIconContent() String|HTMLElement|YMaps.ILayout Возвращает содержимое значка метки, установленное с помощью метода YMaps.Placemark.setIconContent.
getIconLayout() YMaps.IPlacemarkLayout Возвращает макет значка метки.
getIconShadowLayout() YMaps.IPlacemarkLayout Возвращает макет тени значка метки.
getMap() YMaps.Map Возвращает указатель на карту, в которую добавлена метка.
getOptions() YMaps.PlacemarkOptions Возвращает опции метки.
getParentContainer() HTMLElement Возвращает указатель на родительский контейнер.
setCoordPoint(coordPoint) Устанавливает точку координатной системы, к которой привязана метка.
setGeoPoint(coordPoint) То же, что и YMaps.Placemark.setCoordPoint.
setIconContent(content)

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

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

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

Из 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');

Возвращает:

Тип Описание
YMaps.ILayout Макет содержимого значка метки.

getCoordPoint

{YMaps.ICoordPoint} getCoordPoint()

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

Возвращает:

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

getGeoPoint

{YMaps.ICoordPoint} getGeoPoint()

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

Возвращает:

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

getIconContent

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

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

Возвращает:

Тип Описание
String|HTMLElement|YMaps.ILayout Содержимое значка метки.

getIconLayout

{YMaps.IPlacemarkLayout} getIconLayout()

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

Пример:

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

Возвращает:

Тип Описание
YMaps.IPlacemarkLayout Макет значка метки.

getIconShadowLayout

{YMaps.IPlacemarkLayout} getIconShadowLayout()

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

Пример:

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

Возвращает:

Тип Описание
YMaps.IPlacemarkLayout Макет тени значка метки.

getMap

{YMaps.Map} getMap()

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

Возвращает:

Тип Описание
YMaps.Map Указатель на карту, в которую добавлена метка.

getOptions

{YMaps.PlacemarkOptions} getOptions()

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

Возвращает:

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

getParentContainer

{HTMLElement} getParentContainer()

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

Возвращает:

Тип Описание
HTMLElement Указатель на родительский контейнер.

setCoordPoint

setCoordPoint(coordPoint)

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

Параметры:

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

setGeoPoint

setGeoPoint(coordPoint)

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

Параметры:

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

setIconContent

setIconContent(content)

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

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

Внимание. Метки с содержимым отображаются медленнее пустых.

Параметры:

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

setOptions

setOptions(options, restoreDefault)

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

Параметры:

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