Places Widgets

Класс PlaceAutocompleteElement

google.maps.places . PlaceAutocompleteElement

PlaceAutocompleteElement — это подкласс HTMLElement , который предоставляет компонент пользовательского интерфейса для API автозаполнения Places.

Пользовательский элемент:
<gmp-place-autocomplete included-primary-types="type1 type2 type3..." included-region-codes="c1 c2 c3..." name="string" origin="lat,lng|lat,lng,altitude" requested-language="string" requested-region="string" unit-system="metric|imperial" types="type1 type2 type3..."></gmp-place-autocomplete>

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

Этот класс реализует PlaceAutocompleteElementOptions .

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

PlaceAutocompleteElement
PlaceAutocompleteElement(options)
Параметры:
Alpha includedPrimaryTypes
Тип: Array <string> optional
Включен основной тип места (например, «ресторан» или «заправочная станция»).

Место возвращается только в том случае, если его основной тип указан в этом списке. Можно указать до 5 значений. Если типы не указаны, возвращаются все типы мест.
HTML-атрибут:
  • <gmp-place-autocomplete included-primary-types="type1 type2 type3..."></gmp-place-autocomplete>
Alpha includedRegionCodes
Тип: Array <string> optional
Включать результаты только в указанных регионах, заданных как до 15 двухсимвольных кодов регионов CLDR. Пустой набор не ограничивает результаты. Если заданы оба locationRestriction и includedRegionCodes , результаты будут расположены в области пересечения.
HTML-атрибут:
  • <gmp-place-autocomplete included-region-codes="c1 c2 c3..."></gmp-place-autocomplete>
locationBias
Тип: LocationBias optional
Мягкая граница или подсказка, которую можно использовать при поиске мест.
locationRestriction
Тип: LocationRestriction optional
Границы для ограничения результатов поиска.
name
Тип: string optional
Имя, которое будет использоваться для элемента ввода. Подробнее см. https://developer.mozilla.org/en-US/docs/Web/HTML/Element/input#name . Действует так же, как атрибут name для элементов ввода. Обратите внимание, что это имя будет использоваться при отправке формы. Подробнее см. https://developer.mozilla.org/en-US/docs/Web/HTML/Element/form .
HTML-атрибут:
  • <gmp-place-autocomplete name="string"></gmp-place-autocomplete>
Alpha origin
Начальная точка, от которой рассчитывается расстояние. Если не указано, расстояние не рассчитывается. Высота, если указана, не используется в расчёте.
HTML-атрибут:
  • <gmp-place-autocomplete origin="lat,lng|lat,lng,altitude"></gmp-place-autocomplete>
requestedLanguage
Тип: string optional
Идентификатор языка, на котором должны быть возвращены результаты, если это возможно. Результаты на выбранном языке могут иметь более высокий рейтинг, но предложения не ограничиваются этим языком. См. список поддерживаемых языков .
HTML-атрибут:
  • <gmp-place-autocomplete requested-language="string"></gmp-place-autocomplete>
requestedRegion
Тип: string optional
Код региона, используемый для форматирования и фильтрации результатов. Он не ограничивает предложения данной страной. Код региона принимает двухсимвольное значение ccTLD («домен верхнего уровня») . Большинство кодов ccTLD идентичны кодам ISO 3166-1, за некоторыми заметными исключениями. Например, ccTLD Великобритании — «uk» ( .co.uk ), а код ISO 3166-1 — «gb» (технически обозначает «Соединённое Королевство Великобритании и Северной Ирландии»).
HTML-атрибут:
  • <gmp-place-autocomplete requested-region="string"></gmp-place-autocomplete>
Alpha unitSystem
Тип: UnitSystem optional
Система единиц измерения, используемая для отображения расстояний. Если не указано иное, система единиц определяется объектом requestedRegion.
HTML-атрибут:
  • <gmp-place-autocomplete unit-system="metric|imperial"></gmp-place-autocomplete>
Beta componentRestrictions
Тип: ComponentRestrictions optional
Ограничения компонентов. Они используются для ограничения прогнозов только теми, что находятся внутри родительского компонента. Например, для страны.
Beta types
Тип: Array <string> optional
Типы возвращаемых прогнозов. Поддерживаемые типы см. в руководстве разработчика . Если типы не указаны, будут возвращены все типы.
HTML-атрибут:
  • <gmp-place-autocomplete types="type1 type2 type3..."></gmp-place-autocomplete>
prediction-item
Элемент в раскрывающемся списке прогнозов, представляющий один прогноз.
prediction-item-icon
Значок, отображаемый слева от каждого элемента в списке прогнозов.
prediction-item-main-text
Часть элемента predict-item, представляющая собой основной текст прогноза. Для географических объектов содержит название места, например, «Сидней», или название улицы и номер дома, например, «10 King Street». По умолчанию элемент predict-item-main-text имеет черный цвет. Если в элементе predict-item есть какой-либо дополнительный текст, он находится за пределами элемента predict-item-main-text и наследует его стиль. По умолчанию он имеет серый цвет. Дополнительный текст обычно представляет собой адрес.
prediction-item-match
Часть возвращаемого прогноза, которая соответствует введенному пользователем тексту. По умолчанию этот совпавший текст выделяется жирным шрифтом. Обратите внимание, что совпавший текст может находиться в любом месте элемента predict-item. Он не обязательно является частью predict-item-main-text.
prediction-item-selected
Элемент, к которому пользователь переходит с помощью клавиатуры. Примечание: выбранные элементы будут подвержены влиянию как стилей этой части, так и стилей части элементов прогнозирования.
prediction-list
Визуальный элемент, содержащий список подсказок, возвращаемых службой Place Autocomplete. Этот список отображается в виде раскрывающегося списка под элементом PlaceAutocompleteElement.
Beta addEventListener
addEventListener(type, listener[, options])
Параметры:
  • type : string Чувствительная к регистру строка, представляющая тип события, которое нужно отслеживать.
  • listener : EventListener | EventListenerObject — объект, получающий уведомление. Это должна быть функция или объект с методом handleEvent.
  • options : boolean| AddEventListenerOptions optional См. options . Пользовательские события поддерживают только capture и passive .
Возвращаемое значение: void
Устанавливает функцию, которая будет вызываться при каждой доставке указанного события целевому объекту. См. addEventListener .
Beta removeEventListener
removeEventListener(type, listener[, options])
Параметры:
  • type : string Строка, указывающая тип события, для которого следует удалить прослушиватель событий.
  • listener : EventListener | EventListenerObject Прослушиватель событий обработчика событий, который необходимо удалить из цели события.
  • options : boolean| EventListenerOptions optional См. options .
Возвращаемое значение: void
Удаляет прослушиватель событий, ранее зарегистрированный с помощью addEventListener, из целевого объекта. См. removeEventListener .
gmp-error
function(errorEvent)
Аргументы:
Это событие срабатывает, когда запрос к бэкенду был отклонён (например, из-за неверного ключа API). Это событие не всплывает.
gmp-select
function(placePredictionSelectEvent)
Аргументы:
Это событие вызывается, когда пользователь выбирает прогнозируемое место. Содержит объект PlacePrediction, который можно преобразовать в объект Place.
gmp-placeselect
function(placeAutocompletePlaceSelectEvent)
Аргументы:
Это событие вызывается, когда пользователь выбирает прогнозируемое место. Содержит объект Place.

Интерфейс PlaceAutocompleteElementOptions

google.maps.places . PlaceAutocompleteElementOptions

Варианты создания PlaceAutocompleteElement. Описание каждого свойства см. в одноименном свойстве класса PlaceAutocompleteElement.

Beta componentRestrictions optional
Тип: ComponentRestrictions optional
Alpha includedPrimaryTypes optional
Тип: Array <string> optional
Alpha includedRegionCodes optional
Тип: Array <string> optional
locationBias optional
Тип: LocationBias optional
locationRestriction optional
Тип: LocationRestriction optional
name optional
Тип: string optional
Alpha origin optional
requestedLanguage optional
Тип: string optional
Beta types optional
Тип: Array <string> optional
Alpha unitSystem optional
Тип: UnitSystem optional

Класс PlaceAutocompletePlaceSelectEvent

google.maps.places . PlaceAutocompletePlaceSelectEvent

Это событие создаётся после того, как пользователь выбирает место с помощью элемента автозаполнения Place. Доступ к выбранному месту осуществляется с помощью event.place .

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

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

Beta place
Тип: Place

Класс PlacePredictionSelectEvent

google.maps.places . PlacePredictionSelectEvent

Это событие создаётся после того, как пользователь выбирает элемент прогнозирования с помощью PlaceAutocompleteElement. Доступ к выбранному элементу осуществляется с помощью event.placePrediction .

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

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

placePrediction
Тип: PlacePrediction

Класс PlaceAutocompleteRequestErrorEvent

google.maps.places . PlaceAutocompleteRequestErrorEvent

Это событие генерируется PlaceAutocompleteElement, когда возникает проблема с сетевым запросом.

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

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

Класс PlaceDetailsElement

google.maps.places . PlaceDetailsElement

HTML-элемент, отображающий информацию о месте. Используйте методы configureFromPlace() или configureFromLocation() чтобы указать отображаемый контент. Чтобы использовать элемент Place Details, включите API Places UI Kit для своего проекта в консоли Google Cloud.

Пользовательский элемент:
<gmp-place-details size="small"></gmp-place-details>

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

Этот класс реализует PlaceDetailsElementOptions .

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

PlaceDetailsElement
PlaceDetailsElement([options])
Параметры:
place
Тип: Place optional
Только для чтения. Объект Place , содержащий идентификатор, местоположение и область просмотра текущего отображаемого места.
size
Тип: PlaceDetailsSize optional
Вариант размера элемента PlaceDetailsElement. По умолчанию элемент будет иметь значение PlaceDetailsSize.X_LARGE .
HTML-атрибут:
  • <gmp-place-details size="small"></gmp-place-details>
  • <gmp-place-details size="medium"></gmp-place-details>
  • <gmp-place-details size="large"></gmp-place-details>
  • <gmp-place-details size="x-large"></gmp-place-details>
Beta addEventListener
addEventListener(type, listener[, options])
Параметры:
  • type : string Чувствительная к регистру строка, представляющая тип события, которое нужно отслеживать.
  • listener : EventListener | EventListenerObject — объект, получающий уведомление. Это должна быть функция или объект с методом handleEvent.
  • options : boolean| AddEventListenerOptions optional См. options . Пользовательские события поддерживают только capture и passive .
Возвращаемое значение: void
Устанавливает функцию, которая будет вызываться при каждой доставке указанного события целевому объекту. См. addEventListener .
configureFromLocation
configureFromLocation(location)
Параметры:
  • location : LatLng | LatLngLiteral Местоположение, для которого требуется отобразить сведения о месте.
Возвращаемое значение: Promise <void> Обещание, которое разрешается после загрузки и отображения данных о месте.
Настраивает виджет из LatLng с использованием обратного геокодирования.
configureFromPlace
configureFromPlace(place)
Параметры:
  • place : Place |{id:string} Место, для которого требуется отобразить сведения.
Возвращаемое значение: Promise <void> Обещание, которое разрешается после загрузки и отображения данных о месте.
Настраивает виджет на основе объекта Place или идентификатора Place.
Beta removeEventListener
removeEventListener(type, listener[, options])
Параметры:
  • type : string Строка, указывающая тип события, для которого следует удалить прослушиватель событий.
  • listener : EventListener | EventListenerObject Прослушиватель событий обработчика событий, который необходимо удалить из цели события.
  • options : boolean| EventListenerOptions optional См. options .
Возвращаемое значение: void
Удаляет прослушиватель событий, ранее зарегистрированный с помощью addEventListener, из целевого объекта. См. removeEventListener .
gmp-load
function(event)
Аргументы:
Это событие срабатывает при загрузке элемента и отображении его содержимого. Это событие не всплывает.
gmp-requesterror
function(event)
Аргументы:
Это событие срабатывает, когда запрос к бэкенду был отклонён (например, из-за неверного ключа API). Это событие не всплывает.

Интерфейс PlaceDetailsElementOptions

google.maps.places . PlaceDetailsElementOptions

Параметры PlaceDetailsElement .

size optional
Тип: PlaceDetailsSize optional
См. PlaceDetailsElement.size

Константы PlaceDetailsSize

google.maps.places . PlaceDetailsSize

Варианты размеров для PlaceDetailsElement .

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

LARGE Большой вариант, включающий крупное изображение, основную информацию и контактную информацию.
MEDIUM Средний вариант, включающий крупное изображение и основную информацию.
SMALL Маленький вариант, включающий небольшое изображение и основную информацию.
X_LARGE Очень большой вариант, включающий фотоколлаж, обзоры и подробную информацию о месте.

Класс PlaceListElement

google.maps.places . PlaceListElement

HTML-элемент, отображающий результаты поиска места в виде списка. Используйте методы configureFromSearchByTextRequest() или configureFromSearchNearbyRequest() чтобы указать запрос, для которого необходимо отобразить результаты. Чтобы использовать элемент списка мест, включите API Places UI Kit для своего проекта в консоли Google Cloud.

Пользовательский элемент:
<gmp-place-list selectable></gmp-place-list>

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

Этот класс реализует PlaceListElementOptions .

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

PlaceListElement
PlaceListElement([options])
Параметры:
places
Тип: Array < Place >
Только для чтения. Массив объектов Place , содержащий идентификаторы, местоположения и области просмотра отображаемых в данный момент мест.
selectable
Тип: boolean
Можно ли выбирать элементы списка? Если значение равно true, элементы списка будут кнопками, которые при нажатии вызывают событие gmp-placeselect . Также поддерживаются навигация и выбор с помощью доступной клавиатуры.
HTML-атрибут:
  • <gmp-place-list selectable></gmp-place-list>
Beta addEventListener
addEventListener(type, listener[, options])
Параметры:
  • type : string Чувствительная к регистру строка, представляющая тип события, которое нужно отслеживать.
  • listener : EventListener | EventListenerObject — объект, получающий уведомление. Это должна быть функция или объект с методом handleEvent.
  • options : boolean| AddEventListenerOptions optional См. options . Пользовательские события поддерживают только capture и passive .
Возвращаемое значение: void
Устанавливает функцию, которая будет вызываться при каждой доставке указанного события целевому объекту. См. addEventListener .
configureFromSearchByTextRequest
configureFromSearchByTextRequest(request)
Параметры:
  • request : SearchByTextRequest запрос на отображение результатов. Свойство fields для SearchByTextRequest не является обязательным.
Возвращаемое значение: Promise <void> Обещание, которое разрешается после загрузки и отображения данных о месте.
Настраивает виджет для отображения результатов поиска из запроса API текстового поиска Places.
configureFromSearchNearbyRequest
configureFromSearchNearbyRequest(request)
Параметры:
  • request : SearchNearbyRequest запрос на отображение результатов. Свойство fields для SearchNearbyRequest не является обязательным.
Возвращаемое значение: Promise <void> Обещание, которое разрешается после загрузки и отображения данных о месте.
Настраивает виджет для отображения результатов поиска из запроса API Places Nearby Search.
Beta removeEventListener
removeEventListener(type, listener[, options])
Параметры:
  • type : string Строка, указывающая тип события, для которого следует удалить прослушиватель событий.
  • listener : EventListener | EventListenerObject Прослушиватель событий обработчика событий, который необходимо удалить из цели события.
  • options : boolean| EventListenerOptions optional См. options .
Возвращаемое значение: void
Удаляет прослушиватель событий, ранее зарегистрированный с помощью addEventListener, из целевого объекта. См. removeEventListener .
gmp-load
function(event)
Аргументы:
Это событие срабатывает при загрузке элемента и отображении его содержимого. Это событие не всплывает.
gmp-placeselect
function(event)
Аргументы:
Это событие вызывается, когда пользователь выбирает место. Содержит объект Place и индекс выбранного места в списке.
gmp-requesterror
function(event)
Аргументы:
Это событие срабатывает, когда запрос к бэкенду был отклонён (например, из-за неверного ключа API). Это событие не всплывает.

Интерфейс PlaceListElementOptions

google.maps.places . PlaceListElementOptions

Параметры для PlaceListElement .

selectable optional
Тип: boolean optional
См. PlaceListElement.selectable

Класс PlaceListPlaceSelectEvent

google.maps.places . PlaceListPlaceSelectEvent

Это событие генерируется PlaceListElement , когда пользователь выбирает место.

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

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

index
Тип: number
Индекс списка выбранного места.
place
Тип: Place
Объект Place , содержащий идентификатор, местоположение и область просмотра выбранного места.

Класс автодополнения

google.maps.places . Autocomplete

Виджет, предоставляющий прогнозы мест на основе введенного пользователем текста. Он прикрепляется к элементу ввода типа text и отслеживает ввод текста в этом поле. Список прогнозов представлен в виде раскрывающегося списка и обновляется по мере ввода текста.

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

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

Autocomplete
Autocomplete(inputField[, opts])
Параметры:
  • inputField : HTMLInputElement Текстовое поле <input> , к которому следует прикрепить Autocomplete .
  • opts : AutocompleteOptions optional параметры.
Создает новый экземпляр Autocomplete , который прикрепляется к указанному полю ввода текста с заданными параметрами.
getBounds
getBounds()
Параметры: нет
Возвращаемое значение: LatLngBounds |undefined Границы смещения.
Возвращает границы, в которых прогнозы являются смещенными.
getFields
getFields()
Параметры: нет
Возвращаемое значение: Array <string>|undefined
Возвращает поля, которые будут включены в ответ Place in the details при успешном получении информации. Список полей см. PlaceResult .
getPlace
getPlace()
Параметры: нет
Возвращаемое значение: PlaceResult Место, выбранное пользователем.
Возвращает информацию о выбранном пользователем месте, если она была успешно получена. В противном случае возвращает объект-заглушку Place, свойство name которого равно текущему значению поля ввода.
setBounds
setBounds(bounds)
Параметры:
Возвращаемое значение: нет
Задаёт предпочтительную область, в пределах которой будут возвращаться результаты поиска по запросу «Место». Результаты смещены в сторону этой области, но не ограничиваются ею.
setComponentRestrictions
setComponentRestrictions(restrictions)
Параметры:
Возвращаемое значение: нет
Устанавливает ограничения компонента. Ограничения компонента используются для ограничения прогнозов только теми, которые находятся внутри родительского компонента. Например, для страны.
setFields
setFields(fields)
Параметры:
  • fields : Array <string> optional
Возвращаемое значение: нет
Задаёт поля, которые будут включены в ответ Place in the details при успешном получении информации. Список полей см. в PlaceResult .
setOptions
setOptions(options)
Параметры:
Возвращаемое значение: нет
setTypes
setTypes(types)
Параметры:
  • types : Array <string> optional Типы прогнозов, которые следует включить.
Возвращаемое значение: нет
Задаёт типы возвращаемых прогнозов. Информацию о поддерживаемых типах см. в руководстве разработчика . Если типы не указаны, будут возвращены все типы.
Унаследовано: addListener , bindTo , get , notify , set , setValues , unbind , unbindAll
place_changed
function()
Аргументы: нет
Это событие срабатывает, когда PlaceResult становится доступным для места, выбранного пользователем.
Если пользователь вводит название места, которое не было предложено элементом управления, и нажимает клавишу Enter, или если запрос сведений о месте не выполняется, PlaceResult содержит введенные пользователем данные в свойстве name , при этом другие свойства не определяются.

Интерфейс AutocompleteOptions

google.maps.places . AutocompleteOptions

Параметры, которые можно задать для объекта Autocomplete .

bounds optional
Тип: LatLngBounds | LatLngBoundsLiteral optional
Область, в которой следует искать места.
componentRestrictions optional
Тип: ComponentRestrictions optional
Ограничения компонентов. Они используются для ограничения прогнозов только теми, что находятся внутри родительского компонента. Например, для страны.
fields optional
Тип: Array <string> optional
Поля, которые необходимо включить в ответ Place in the details при успешном получении данных, за которые будет выставлен счёт . Если передано ['ALL'] , будут возвращены все доступные поля, за которые будет выставлен счёт (это не рекомендуется для производственных развёртываний). Список полей см. в PlaceResult . Вложенные поля можно указывать с помощью точечных путей (например, "geometry.location" ). Значение по умолчанию — ['ALL'] .
placeIdOnly optional
Тип: boolean optional
Извлекать ли только идентификаторы мест. PlaceResult, доступный при срабатывании события place_changed, будет содержать только поля place_id, types и name, а place_id, types и description будут возвращены службой автозаполнения. Отключено по умолчанию.
strictBounds optional
Тип: boolean optional
Логическое значение, указывающее, что виджет автозаполнения должен возвращать только те места, которые находятся внутри границ виджета автозаполнения на момент отправки запроса. Установка strictBounds в false (значение по умолчанию) сделает результаты смещенными в сторону мест, находящихся внутри границ, но не ограниченными ими.
types optional
Тип: Array <string> optional
Типы возвращаемых прогнозов. Поддерживаемые типы см. в руководстве разработчика . Если типы не указаны, будут возвращены все типы.

google.maps.places . SearchBox

Виджет, предоставляющий прогнозы запросов на основе введенного пользователем текста. Он прикрепляется к элементу ввода типа text и отслеживает ввод текста в этом поле. Список прогнозов представлен в виде раскрывающегося списка и обновляется по мере ввода текста.

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

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

SearchBox
SearchBox(inputField[, opts])
Параметры:
Создает новый экземпляр SearchBox , который прикрепляется к указанному полю ввода текста с заданными параметрами.
getBounds
getBounds()
Параметры: нет
Возвращаемое значение: LatLngBounds |undefined
Возвращает границы, в пределах которых смещены прогнозы запроса.
getPlaces
getPlaces()
Параметры: нет
Возвращаемое значение: Array < PlaceResult >|undefined
Возвращает запрос, выбранный пользователем для использования с событием places_changed .
setBounds
setBounds(bounds)
Параметры:
Возвращаемое значение: нет
Задаёт регион, который будет использоваться для смещенных прогнозов запроса. Результаты будут смещены только в сторону этой области, а не будут полностью ею ограничены.
Унаследовано: addListener , bindTo , get , notify , set , setValues , unbind , unbindAll
places_changed
function()
Аргументы: нет
Это событие вызывается, когда пользователь выбирает запрос, для получения новых мест следует использовать getPlaces .

Интерфейс SearchBoxOptions

google.maps.places . SearchBoxOptions

Параметры, которые можно задать для объекта SearchBox .

bounds optional
Тип: LatLngBounds | LatLngBoundsLiteral optional
Область, в сторону которой смещаются прогнозы запросов. Прогнозы смещаются в сторону запросов, ориентированных на эти границы, но не ограничиваются ими.