YMapPopupMarker

Класс YMapPopupMarker — всплывающее окно (pop-up) на карте с пользовательским контентом, может отображать текстовую или графическую информацию. Окно может располагаться в другом месте относительно точки, на которую указывает.

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

Примечание

Данный класс является компонентом пакета @yandex/ymaps3-default-ui-theme и предоставляет дополнительную функциональность в JS API, которая не входит в основное API.

Для подключения пакета воспользуйтесь инструкцией.

Пример использования

const markerElement = document.createElement('div');
markerElement.className = 'marker-class';
markerElement.innerText = "I'm marker!";

const marker = new YMapPopupMarker(
  {
    source: 'markerSource',
    coordinates: [37.588144, 55.733842],
    draggable: true,
    mapFollowsOnDrag: true
  },
  markerElement
);

map.addChild(marker);

Подробный пример

Конструктор

new YMapPopupMarker(props)

Параметры конструктора

Параметр

Тип

props

YMapPopupMarker

Переопределяет

YMapComplexEntity.constructor

Props

Класс YMapPopupMarker имеет все параметры базового класса YMapMarker, а также дополнительные параметры:

Название props

Описание

content

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

position

Положение всплывающего окна по отношению к точке, на которую оно указывает.

offset

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

show

Скрыть или показать всплывающее окно на карте.

onClose

Обратный вызов закрытия всплывающего окна.

onOpen

Обратный вызов открытия всплывающего окна.

Методы

update

update(changedProps): void

Параметры

Параметр

Тип

Описание

changedProps

Partial<YMapPopupMarkerProps>

Новые значения props.

Возвращается

void

Унаследовано от

YMapComplexEntity.update

Предыдущая
Следующая