Marker (legacy)

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

google.maps . Marker Класс 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)
Аргументы:
Это событие запускается, когда событие контекстного меню DOM запускается на Marker
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()
Аргументы: Нет
Это событие вызывается при изменении свойства Marker zIndex.
rightclick
function(event)
Аргументы:
Это событие вызывается при щелчке правой кнопкой мыши по 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 , маркер получает события мыши и касания.
Beta collisionBehavior optional
Тип: 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 Интерфейс 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
Размер отображения спрайта или изображения. При использовании спрайтов необходимо указать размер спрайта. Если размер не указан, он будет установлен при загрузке изображения.

Интерфейс маркерлейбл

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-размера шрифта).
fontWeight optional
Тип: string optional
Вес шрифта текста метки (эквивалент свойства CSS-веса шрифта).

Интерфейс МаркерШейп

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 : координаты — это [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 интерфейс

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

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 символа.
Толщина штриха символа.

Константы СимволПат

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 в Marker или параметр MarkerOptions.animation для воспроизведения анимации.

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

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