Marker

Класс маркера

google.maps . Marker Класс google.maps . Marker

Этот класс расширяет MVCObject .

Получите доступ, вызвав const {Marker} = await google.maps.importLibrary("marker") . См. Библиотеки в Maps JavaScript API .

Конструктор
Marker	Marker([opts]) Параметры: opts : MarkerOptions optional Именованные необязательные аргументы Создает маркер с указанными параметрами. Если указана карта, маркер добавляется на карту при построении. Обратите внимание, что позиция должна быть установлена ​​для отображения маркера.

Методы
getAnimation	getAnimation() Параметры: Нет Возвращаемое значение: Animation |null|undefined Получить текущую анимацию.
getClickable	getClickable() Параметры: Нет Возвращаемое значение: boolean Истинно, если маркер кликабельный. Получите кликабельный статус Marker .
getCursor	getCursor() Параметры: Нет Возвращаемое значение: string|null|undefined Получить тип курсора мыши, отображаемый при наведении.
getDraggable	getDraggable() Параметры: Нет Возвращаемое значение: boolean Истинно, если маркер можно перетаскивать. Получите перетаскиваемый статус Marker .
getIcon	getIcon() Параметры: Нет Возвращаемое значение: string| Icon | Symbol |null|undefined Получите значок Marker . См. MarkerOptions.icon .
getLabel	getLabel() Параметры: Нет Возвращаемое значение: MarkerLabel |string|null|undefined Получите метку Marker . См. MarkerOptions.label .
getMap	getMap() Параметры: Нет Возвращаемое значение: Map | StreetViewPanorama Получите карту или панораму, на которой отображается Marker .
getOpacity	getOpacity() Параметры: Нет Возвращаемое значение: number|null|undefined Число от 0,0 до 1,0. Получите непрозрачность Marker .
getPosition	getPosition() Параметры: Нет Возвращаемое значение: LatLng |null|undefined Получить положение Marker .
getShape	getShape() Параметры: Нет Возвращаемое значение: MarkerShape |null|undefined Получите форму Marker , используемого для взаимодействия. См. MarkerOptions.shape и MarkerShape .
getTitle	getTitle() Параметры: Нет Возвращаемое значение: string|null|undefined Получите название всплывающей подсказки Marker . См. MarkerOptions.title .
getVisible	getVisible() Параметры: Нет Возвращаемое значение: boolean Истинно, если маркер виден. Получите видимость Marker .
getZIndex	getZIndex() Параметры: Нет Возвращаемое значение: number|null|undefined zIndex маркера. Получите zIndex Marker . См. MarkerOptions.zIndex .
setAnimation	setAnimation([animation]) Параметры: animation : Animation optional Воспроизводимая анимация. Возвращаемое значение: нет Запустить анимацию. Любая текущая анимация будет отменена. В настоящее время поддерживаются следующие анимации: Animation.BOUNCE , Animation.DROP . Передача null значения приведет к остановке любой анимации.
setClickable	setClickable(flag) Параметры: flag : boolean Если true , маркер можно щелкнуть. Возвращаемое значение: нет Установите, можно ли щелкнуть Marker .
setCursor	setCursor([cursor]) Параметры: cursor : string optional Тип курсора мыши. Возвращаемое значение: нет Установите тип курсора мыши, отображаемый при наведении.
setDraggable	setDraggable(flag) Параметры: flag : boolean optional Если true , Маркер можно перетаскивать. Возвращаемое значение: нет Установите, можно ли перетаскивать Marker .
setIcon	setIcon([icon]) Параметры: icon : string| Icon | Symbol optional Возвращаемое значение: нет Установите значок Marker . См. MarkerOptions.icon .
setLabel	setLabel([label]) Параметры: label : string| MarkerLabel optional Метка может быть строкой символов или объектом MarkerLabel . Возвращаемое значение: нет Установите метку для Marker . См. MarkerOptions.label .
setMap	setMap(map) Параметры: map : Map | StreetViewPanorama Возвращаемое значение: нет Визуализирует Marker на указанной карте или панораме. Если для карты задано значение null , маркер будет удален.
setOpacity	setOpacity([opacity]) Параметры: opacity : number optional Число от 0.0, прозрачный, до 1.0, непрозрачный. Возвращаемое значение: нет Установите непрозрачность Marker .
setOptions	setOptions(options) Параметры: options : MarkerOptions Возвращаемое значение: нет Установите параметры Marker .
setPosition	setPosition([latlng]) Параметры: latlng : LatLng | LatLngLiteral optional Новая позиция. Возвращаемое значение: нет Установите положение Marker .
setShape	setShape([shape]) Параметры: shape : MarkerShape optional Возвращаемое значение: нет Установите форму Marker , используемого для взаимодействия. См. MarkerOptions.shape и MarkerShape .
setTitle	setTitle([title]) Параметры: title : string optional Возвращаемое значение: нет Задайте заголовок всплывающей подсказки Marker . См. MarkerOptions.title .
setVisible	setVisible(visible) Параметры: visible : boolean Если true , маркер виден Возвращаемое значение: нет Установите, если Marker виден.
setZIndex	setZIndex([zIndex]) Параметры: zIndex : number optional Возвращаемое значение: нет Установите zIndex Marker . См. MarkerOptions.zIndex .
Унаследовано: addListener , bindTo , get , notify , set , setValues , unbind , unbindAll

Константы
MAX_ZINDEX	Максимальный z-индекс по умолчанию, который API назначит маркеру. Вы можете установить более высокий z-индекс, чтобы вывести маркер на передний план.

События
animation_changed	function() Аргументы: Нет Это событие запускается при изменении свойства анимации Marker .
click	function(event) Аргументы: event : MapMouseEvent Это событие запускается при щелчке значка Marker .
clickable_changed	function() Аргументы: Нет Это событие запускается при изменении свойства Marker clickable.
contextmenu	function(event) Аргументы: event : MapMouseEvent Это событие запускается, когда событие контекстного меню DOM запускается для Marker
cursor_changed	function() Аргументы: Нет Это событие запускается при изменении свойства курсора Marker .
dblclick	function(event) Аргументы: event : MapMouseEvent Это событие запускается при двойном щелчке по значку Marker .
drag	function(event) Аргументы: event : MapMouseEvent Это событие повторно запускается, пока пользователь перетаскивает Marker .
dragend	function(event) Аргументы: event : MapMouseEvent Это событие запускается, когда пользователь перестает перетаскивать Marker .
draggable_changed	function() Аргументы: Нет Это событие запускается при изменении свойства перетаскивания Marker .
dragstart	function(event) Аргументы: event : MapMouseEvent Это событие запускается, когда пользователь начинает перетаскивать Marker .
flat_changed	function() Аргументы: Нет Это событие запускается при изменении свойства плоского Marker .
icon_changed	function() Аргументы: Нет Это событие запускается при изменении свойства значка Marker .
mousedown	function(event) Аргументы: event : MapMouseEvent Это событие срабатывает при наведении указателя мыши на Marker .
mouseout	function(event) Аргументы: event : MapMouseEvent Это событие запускается, когда мышь покидает область значка Marker .
mouseover	function(event) Аргументы: event : MapMouseEvent Это событие запускается, когда мышь входит в область значка Marker .
mouseup	function(event) Аргументы: event : MapMouseEvent Это событие запускается при наведении указателя мыши на Marker .
position_changed	function() Аргументы: Нет Это событие запускается при изменении свойства положения Marker .
shape_changed	function() Аргументы: Нет Это событие запускается при изменении свойства формы Marker .
title_changed	function() Аргументы: Нет Это событие запускается при изменении свойства заголовка Marker .
visible_changed	function() Аргументы: Нет Это событие запускается при изменении свойства видимости Marker .
zindex_changed	function() Аргументы: Нет Это событие запускается при изменении свойства Marker zIndex.
rightclick	Устарело: вместо этого используйте событие Marker.contextmenu , чтобы поддерживать шаблоны использования, такие как щелчок с нажатой клавишей Control в macOS. function(event) Аргументы: event : MapMouseEvent Это событие запускается при щелчке правой кнопкой мыши на Marker .

Интерфейс MarkerOptions

google.maps . MarkerOptions Интерфейс google.maps . MarkerOptions

Объект MarkerOptions, используемый для определения свойств, которые можно задать для маркера.

Характеристики
anchorPoint optional	Тип: Point optional Смещение от позиции маркера до конца InfoWindow, которое было открыто с маркером в качестве привязки.
animation optional	Тип: Animation optional По умолчанию: null Какую анимацию воспроизводить при добавлении маркера на карту.
clickable optional	Тип: boolean optional По умолчанию: true Если true , маркер получает события мыши и касания.
collisionBehavior optional	Устарело: с июля 2023 года collisionBehavior устарел. Вместо этого используйте AdvancedMarkerElement.collisionBehavior . Примечание. Доступно только в канале v=beta . Тип: string| CollisionBehavior optional По умолчанию: null Задайте поведение столкновений для маркеров на векторных картах.
crossOnDrag optional	Тип: boolean optional По умолчанию: true Если false , отключает крест, который появляется под маркером при перетаскивании.
cursor optional	Тип: string optional По умолчанию: pointer Тип курсора мыши для отображения при наведении.
draggable optional	Тип: boolean optional По умолчанию: false Если true , маркер можно перетаскивать.
icon optional	Тип: string| Icon | Symbol optional Значок для переднего плана. Если указана строка, она обрабатывается так, как если бы это была Icon со строкой в ​​качестве url .
label optional	Тип: string| MarkerLabel optional По умолчанию: null Добавляет метку к маркеру. Метка маркера — это буква или цифра, которая появляется внутри маркера. Метка может быть либо строкой, либо объектом MarkerLabel . Если указано, а MarkerOptions.title не указано, к маркеру будет добавлен текст доступности (например, для использования с программами чтения с экрана) с предоставленным текстом метки. Обратите внимание, что label в настоящее время используется только для текста доступности для неоптимизированных маркеров.
map optional	Тип: Map | StreetViewPanorama optional Карта, на которой должен отображаться маркер. Карта необходима для отображения маркера и может быть предоставлена ​​с помощью Marker.setMap , если она не указана при построении маркера.
opacity optional	Тип: number optional По умолчанию: 1,0 Число от 0,0 (прозрачный) до 1,0 (непрозрачный).
optimized optional	Тип: boolean optional Оптимизация повышает производительность, отображая множество маркеров как один статический элемент. Это полезно в тех случаях, когда требуется большое количество маркеров. Подробнее об оптимизации маркеров .
position optional	Тип: LatLng | LatLngLiteral optional Устанавливает позицию маркера. Маркер может быть создан, но не отображаться до тех пор, пока не будет предоставлено его положение, например, в результате действий или выбора пользователя. Позиция маркера может быть предоставлена ​​с помощью Marker.setPosition , если она не указана при построении маркера.
shape optional	Тип: MarkerShape optional Определение области карты изображения, используемое для перетаскивания/щелчка.
title optional	Тип: string optional По умолчанию: undefined Перевернутый текст. Если он предоставлен, текст доступности (например, для использования с программами чтения с экрана) будет добавлен к маркеру с предоставленным значением. Обратите внимание, что title в настоящее время используется только для текста доступности для неоптимизированных маркеров.
visible optional	Тип: boolean optional По умолчанию: true Если true , маркер виден.
zIndex optional	Тип: number optional Все маркеры отображаются на карте в порядке их zIndex, причем более высокие значения отображаются перед маркерами с более низкими значениями. По умолчанию маркеры отображаются в соответствии с их вертикальным положением на экране, при этом нижние маркеры появляются перед маркерами, расположенными выше по экрану.

Константы CollisionBehavior

google.maps . CollisionBehavior Константы google.maps . CollisionBehavior

Получите доступ, вызвав const {CollisionBehavior} = await google.maps.importLibrary("marker") . См. Библиотеки в Maps JavaScript API .

Константы
OPTIONAL_AND_HIDES_LOWER_PRIORITY	Отображать маркер, только если он не пересекается с другими маркерами. Если два маркера этого типа перекрываются, отображается тот, у которого zIndex выше. Если они имеют одинаковый zIndex, отображается тот, у которого вертикальная позиция экрана ниже.
REQUIRED	Всегда отображать маркер независимо от столкновения. Это поведение по умолчанию.
REQUIRED_AND_HIDES_OPTIONAL	Всегда отображать маркер независимо от столкновения и скрывать любые OPTIONAL_AND_HIDES_LOWER_PRIORITY маркеры или метки, которые перекрываются с маркером.

Значок интерфейса

google.maps . Icon интерфейса

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

Характеристики
url	Тип: string URL-адрес изображения или листа спрайтов.
anchor optional	Тип: Point optional Позиция, к которой привязывается изображение, в соответствии с положением маркера на карте. По умолчанию якорь располагается вдоль центральной точки нижней части изображения.
labelOrigin optional	Тип: Point optional Происхождение метки относительно верхнего левого угла изображения значка, если метка предоставляется маркером. По умолчанию начало координат находится в центральной точке изображения.
origin optional	Тип: Point optional Положение изображения внутри спрайта, если оно есть. По умолчанию начало координат находится в верхнем левом углу изображения (0, 0) .
scaledSize optional	Тип: Size optional Размер всего изображения после масштабирования, если оно есть. Используйте это свойство, чтобы растянуть/сжать изображение или спрайт.
size optional	Тип: Size optional Отображаемый размер спрайта или изображения. При использовании спрайтов необходимо указать размер спрайта. Если размер не указан, он будет установлен при загрузке изображения.

Интерфейс MarkerLabel

google.maps . MarkerLabel Интерфейс google.maps . MarkerLabel

Эти параметры определяют внешний вид метки маркера. Метка маркера представляет собой строку (часто из одного символа), которая будет отображаться внутри маркера. Если вы используете его с пользовательским маркером, вы можете изменить его положение с помощью свойства labelOrigin в классе Icon .

Характеристики
text	Тип: string Текст, который будет отображаться на этикетке.
className optional	Тип: string optional По умолчанию: '' (пустая строка) Свойство className элемента метки (эквивалентно атрибуту class элемента). Можно добавить несколько классов CSS, разделенных пробелами. Цвет, размер, вес и семейство шрифта можно задать только с помощью других свойств MarkerLabel . Классы CSS не следует использовать для изменения положения или ориентации метки (например, с помощью переводов и поворотов), если также используется управление коллизиями маркеров .
color optional	Тип: string optional По умолчанию: 'black' Цвет текста метки.
fontFamily optional	Тип: string optional Семейство шрифтов текста метки (эквивалент свойства CSS font-family).
fontSize optional	Тип: string optional По умолчанию: '14px' Размер шрифта текста метки (эквивалент свойства CSS font-size).
fontWeight optional	Тип: string optional Толщина шрифта текста метки (эквивалент свойства CSS font-weight).

Интерфейс MarkerShape

google.maps . MarkerShape Интерфейс google.maps . MarkerShape

Этот объект определяет кликабельную область изображения маркера. Форма состоит из двух свойств — type и coord — которые определяют непрозрачную область изображения.

Характеристики
coords	Тип: Array <number> Формат этого атрибута зависит от значения type и соответствует спецификации coords w3 AREA, которую можно найти по адресу http://www.w3.org/TR/REC-html40/struct/objects.html#adef-coords . Атрибут coords представляет собой массив целых чисел, указывающих положение фигуры в пикселях относительно верхнего левого угла целевого изображения. Координаты зависят от значения type следующим образом: - circle : координаты [x1,y1,r] , где x1,y2 — координаты центра круга, а r — радиус круга. - poly : coords равно [x1,y1,x2,y2...xn,yn] где каждая пара x,y содержит координаты одной вершины многоугольника. - rect : координаты равны [x1,y1,x2,y2] , где x1,y1 — координаты верхнего левого угла прямоугольника, а x2,y2 — координаты нижнего правого угла прямоугольника.
type	Тип: string Описывает тип фигуры и может быть circle , poly или rect .

Интерфейс символов

google.maps . Symbol Интерфейс google.maps . Symbol

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

Характеристики
path	Тип: SymbolPath |string Путь символа, который является встроенным путем символа или пользовательским путем, выраженным с помощью нотации пути SVG . Необходимый.
anchor optional	Тип: Point optional По умолчанию: google.maps.Point(0,0) Положение символа относительно маркера или полилинии. Координаты пути символа переводятся влево и вверх по координатам x и y привязки соответственно. Положение выражается в той же системе координат, что и путь символа.
fillColor optional	Тип: string optional Цвет заливки символа. Поддерживаются все цвета CSS3, кроме расширенных именованных цветов. Для маркеров символов по умолчанию используется значение «черный». Для символов на полилиниях по умолчанию используется цвет обводки соответствующей полилинии.
fillOpacity optional	Тип: number optional По умолчанию: 0 Непрозрачность заливки символа.
labelOrigin optional	Тип: Point optional По умолчанию: google.maps.Point(0,0) Происхождение метки относительно начала пути, если метка предоставляется маркером. Начало выражается в той же системе координат, что и путь символа. Это свойство не используется для символов на ломаных линиях.
rotation optional	Тип: number optional По умолчанию: 0 Угол поворота символа, выраженный по часовой стрелке в градусах. Символ в IconSequence , где fixedRotation имеет false , поворачивается относительно угла ребра, на котором он лежит.
scale optional	Тип: number optional Величина, на которую символ масштабируется в размере. Для маркеров символов это значение по умолчанию равно 1; после масштабирования символ может быть любого размера. Для символов на полилинии по умолчанию используется толщина штриха полилинии; после масштабирования символ должен лежать внутри квадрата размером 22 пикселя с центром в якоре символа.
strokeColor optional	Тип: string optional Цвет обводки символа. Поддерживаются все цвета CSS3, кроме расширенных именованных цветов. Для маркеров символов по умолчанию используется значение «черный». Для символов на полилинии по умолчанию используется цвет обводки полилинии.
strokeOpacity optional	Тип: number optional Непрозрачность штриха символа. Для маркеров символов это значение по умолчанию равно 1. Для символов на полилинии это значение по умолчанию равно прозрачности обводки полилинии.
strokeWeight optional	Тип: number optional По умолчанию: Symbol.scale символа. Толщина штриха символа.

Константы SymbolPath

google.maps . SymbolPath Константы google.maps . SymbolPath

Встроенные пути символов.

Получите доступ, вызвав const {SymbolPath} = await google.maps.importLibrary("core") . См. Библиотеки в Maps JavaScript API .

Константы
BACKWARD_CLOSED_ARROW	Замкнутая стрелка, указывающая назад.
BACKWARD_OPEN_ARROW	Направленная назад открытая стрелка.
CIRCLE	Круг.
FORWARD_CLOSED_ARROW	Замкнутая стрелка, направленная вперед.
FORWARD_OPEN_ARROW	Направленная вперед открытая стрелка.

Константы анимации

google.maps . Animation Константы google.maps . Animation

Анимации, которые можно воспроизвести на маркере. Используйте метод Marker.setAnimation для маркера или параметр MarkerOptions.animation для воспроизведения анимации.

Получите доступ, вызвав const {Animation} = await google.maps.importLibrary("marker") . См. Библиотеки в Maps JavaScript API .

Константы
BOUNCE	Маркер отскакивает до тех пор, пока анимация не будет остановлена ​​путем вызова Marker.setAnimation с null .
DROP	Маркер падает с верхней части карты на свое конечное место. Анимация прекратится, как только маркер остановится, и Marker.getAnimation вернет значение null . Этот тип анимации обычно задается при создании маркера.