Marker (legacy)

Маркерный класс

google.maps . Marker

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

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

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
Получите карту или панораму, на которой отображен 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])
Параметры:
Возвращаемое значение: нет
Установите значок для Marker . См. MarkerOptions.icon .
setLabel
setLabel([label])
Параметры:
  • label : string| MarkerLabel optional Метка может быть либо строкой символов, либо объектом MarkerLabel .
Возвращаемое значение: нет
Задайте метку для Marker . См. MarkerOptions.label .
setMap
setMap(map)
Параметры:
Возвращаемое значение: нет
Отображает Marker на указанной карте или панораме. Если значение карты равно null , маркер будет удалён.
setOpacity
setOpacity([opacity])
Параметры:
  • opacity : number optional Число от 0,0 (прозрачный) до 1,0 (непрозрачный).
Возвращаемое значение: нет
Установите непрозрачность Marker .
setOptions
setOptions(options)
Параметры:
Возвращаемое значение: нет
Установите параметры для Marker .
setPosition
setPosition([latlng])
Параметры:
Возвращаемое значение: нет
Установите положение Marker .
setShape
setShape([shape])
Параметры:
Возвращаемое значение: нет
Задайте форму 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)
Аргументы:
Это событие вызывается при щелчке по значку Marker .
clickable_changed
function()
Аргументы: нет
Это событие вызывается при изменении свойства кликабельности Marker .
contextmenu
function(event)
Аргументы:
Это событие срабатывает, когда на Marker срабатывает событие контекстного меню DOM.
cursor_changed
function()
Аргументы: нет
Это событие возникает при изменении свойства курсора Marker .
dblclick
function(event)
Аргументы:
Это событие вызывается при двойном щелчке по значку Marker .
drag
function(event)
Аргументы:
Это событие многократно запускается, пока пользователь перетаскивает Marker .
dragend
function(event)
Аргументы:
Это событие срабатывает, когда пользователь прекращает перетаскивание Marker .
draggable_changed
function()
Аргументы: нет
Это событие вызывается при изменении свойства перетаскивания Marker .
dragstart
function(event)
Аргументы:
Это событие вызывается, когда пользователь начинает перетаскивать Marker .
flat_changed
function()
Аргументы: нет
Это событие возникает при изменении свойства плоскости Marker .
icon_changed
function()
Аргументы: нет
Это событие возникает при изменении свойства значка Marker .
mousedown
function(event)
Аргументы:
Это событие запускается при нажатии кнопки мыши на Marker .
mouseout
function(event)
Аргументы:
Это событие срабатывает, когда мышь покидает область значка Marker .
mouseover
function(event)
Аргументы:
Это событие срабатывает, когда мышь попадает в область значка Marker .
mouseup
function(event)
Аргументы:
Это событие запускается при наведении курсора мыши на Marker .
position_changed
function()
Аргументы: нет
Это событие срабатывает при изменении свойства положения Marker .
shape_changed
function()
Аргументы: нет
Это событие возникает при изменении свойства формы Marker .
title_changed
function()
Аргументы: нет
Это событие вызывается при изменении свойства заголовка Marker .
visible_changed
function()
Аргументы: нет
Это событие вызывается при изменении свойства видимости Marker .
zindex_changed
function()
Аргументы: нет
Это событие возникает при изменении свойства zIndex Marker .
rightclick
function(event)
Аргументы:
Это событие запускается при щелчке правой кнопкой мыши по Marker .

Интерфейс MarkerOptions

google.maps . MarkerOptions

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

anchorPoint optional
Тип: Point optional
Смещение от позиции маркера до кончика информационного окна InfoWindow, открытого с маркером в качестве якоря.
animation optional
Тип: Animation optional
По умолчанию: null
Какую анимацию воспроизводить при добавлении маркера на карту.
clickable optional
Тип: boolean optional
По умолчанию: true
Если true , маркер получает события мыши и касания.
Beta collisionBehavior optional
Тип: string| CollisionBehavior optional
По умолчанию: null
Установите поведение столкновений для маркеров на векторных картах.
crossOnDrag optional
Тип: boolean optional
По умолчанию: true
Если false , отключает крестик, появляющийся под маркером при перетаскивании.
cursor optional
Тип: string optional
По умолчанию: pointer
Тип курсора мыши, отображаемый при наведении.
draggable optional
Тип: boolean optional
По умолчанию: false
Если true , маркер можно перетаскивать. Примечание: если установлено значение true маркер станет интерактивным, даже если clickable равно false .
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

Доступ осуществляется путем вызова 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

Эти параметры определяют внешний вид метки маркера. Метка маркера — это строка (часто состоящая из одного символа), которая будет отображаться внутри маркера. При использовании с пользовательским маркером вы можете изменить её положение с помощью свойства 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

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

type
Тип: string
Описывает тип фигуры и может быть circle , poly или rect .
coords optional
Тип: Array <number> optional
Формат этого атрибута зависит от значения 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 : coords is [x1,y1,x2,y2] , где x1,y1 — координаты верхнего левого угла прямоугольника, а x2,y2 — координаты нижнего правого угла прямоугольника.

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

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

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

Доступ осуществляется путем вызова 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

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

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

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