Marker (legacy)

Класс Marker

google.maps.Marker class
extends MVCObject
library "marker"

Поддержка прекращена. С 21 февраля 2024 г. поддержка google.maps.Marker прекращена. Используйте вместо них другие столбцы (AdvancedMarkerElement). В настоящее время прекращение поддержки google.maps.Marker не планируется, но мы рекомендуем использовать AdvancedMarkerElement вместо google.maps.Marker. Мы продолжим выпускать исправления ошибок для любых серьезных регрессий в google.maps.Marker, но не будем устранять существующие ошибки. Об их отключении мы предупредим за 12 месяцев. Дополнительную информацию можно найти на странице https://developers.google.com/maps/deprecations, а руководство по переносу – на странице https://developers.google.com/maps/documentation/javascript/advanced-markers/migration.

const {Marker} = await google.maps.importLibrary("marker");

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

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

Методы
getAnimation	getAnimation() Параметры: нет. Возвращаемое значение: Animation|null|undefined Получить текущую анимацию.
getClickable	getClickable() Параметры: нет. Возвращаемое значение: boolean True, если маркер кликабелен. Получить статус кликабельности для Marker.
getCursor	getCursor() Параметры: нет. Возвращаемое значение: string|null|undefined Получает тип курсора мыши, показываемый при наведении на объект.
getDraggable	getDraggable() Параметры: нет. Возвращаемое значение: boolean True, если маркер можно перетаскивать. Получить статус перетаскивания для Marker.
getIcon	getIcon() Параметры: нет. Возвращаемое значение: string|Icon|Symbol|null|undefined Получить значок Marker. Прочтите MarkerOptions.icon.
getLabel	getLabel() Параметры: нет. Возвращаемое значение: MarkerLabel|string|null|undefined Получить ярлык Marker. Прочтите MarkerOptions.label.
getMap	getMap() Параметры: нет. Возвращаемое значение: Map|StreetViewPanorama|null Получить карту или панораму, на которой отображается 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 True, если маркер виден. Получить видимость 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 optional. Возвращаемое значение: нет. Отрисовывает Marker на указанной карте или панораме. Если для карты задано значение null, маркер будет удален.
setOpacity	setOpacity([opacity]) Параметры: opacity: number optional – число от 0,0 (прозрачный) до 1,0 (непрозрачный). Возвращаемое значение: нет. Установите прозрачность Marker.
setOptions	setOptions(options) Параметры: options: MarkerOptions optional. Возвращаемое значение: нет. Задайте настройки для 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.

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

Интерфейс MarkerOptions

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

Поддержка прекращена. С 21 февраля 2024 г. поддержка google.maps.Marker прекращена. Вместо этого используйте google.maps.marker.AdvancedMarkerElement. Чтобы получить подробную информацию о прекращении поддержки, перейдите по ссылке https://developers.google.com/maps/deprecations. Руководство по переносу доступно на странице https://developers.google.com/maps/documentation/javascript/advanced-markers/migration.

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

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

Константы CollisionBehavior

google.maps.CollisionBehavior Библиотека констант
"marker"

Эти константы также можно использовать в качестве строк. В TypeScript строковые литералы определяются типом CollisionBehaviorString.

const {CollisionBehavior} = await google.maps.importLibrary("marker");

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

Интерфейс Icon

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

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

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

Интерфейс MarkerLabel

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

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

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

Интерфейс MarkerShape

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

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

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

Symbol interface

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

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

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

Константы SymbolPath

google.maps.SymbolPath Библиотека констант
"core"

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

const {SymbolPath} = await google.maps.importLibrary("core");

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

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

google.maps.Animation Библиотека констант
"marker"

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

const {Animation} = await google.maps.importLibrary("marker");

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