YMapMarker

Класс YMapMarker — компонент маркера на карте. Позволяет вставить собственную DOM реализацию маркера.

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

Реализация маркера по умолчанию представлена в пакете https://www.npmjs.com/package/@yandex/ymaps3-default-ui-theme.

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

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

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

map.addChild(marker);

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

Конструктор

new YMapMarker(props, element?)

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

Параметр

Тип

props

YMapMarkerProps

element?

HTMLElement

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

YMapGroupEntity.constructor

Props

YMapMarkerProps: {
	coordinates: <a href="ref/#LngLat">LngLat</a>;
	disableRoundCoordinates?: boolean;
	hideOutsideViewport?: <a href="ref/#HideOutsideRule">HideOutsideRule</a>;
	id?: string;
	properties?: <a href="ref/#recordkeys-type ">Record</a>&lt;string, unknown&gt;;
	source?: string;
	zIndex?: number
} &amp; <a href="ref/#interface-draggableprops">DraggableProps</a>&lt;<a href="YMapMarkerEventHandler">YMapMarkerEventHandler</a>&gt; &amp; <a href="ref/#interface-blockingprops">BlockingProps</a> &amp; <a href="ref/#interface-featureclickevents">FeatureClickEvents

Методы

_onAttach

_onAttach(): void

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

void

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

YMapGroupEntity._onAttach

_onDetach

_onDetach(): void

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

void

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

YMapGroupEntity._onDetach

addChild

addChild(child, index?): YMapMarker

Параметры

Параметр

Тип

child

YMapEntity<unknown, {}>

index?

number

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

YMapMarker

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

YMapGroupEntity.addChild

removeChild

removeChild(child): YMapMarker

Параметры

Параметр

Тип

child

YMapEntity<unknown, {}>

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

YMapMarker

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

YMapGroupEntity.removeChild

update

update(changedProps): void

Параметры

Параметр

Тип

Описание

changedProps

Partial<YMapMarkerProps>

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

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

void

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

YMapGroupEntity.update

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