Places Widgets

Класс PlaceAutocompleteElement

google.maps.places . PlaceAutocompleteElement Класс google.maps.places . PlaceAutocompleteElement

  • PlaceAutocompleteElement — это подкласс HTMLElement , который предоставляет компонент пользовательского интерфейса для API автозаполнения мест. После загрузки библиотеки places в HTML можно создать ввод с функцией автозаполнения. Например: 
    <gmp-placeautocomplete ></gmp-placeautocomplete>

Пользовательский элемент:
<gmp-placeautocomplete name="string" requested-language="string" requested-region="string" types="type1 type2 type3..."></gmp-placeautocomplete>

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

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

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

PlaceAutocompleteElement
PlaceAutocompleteElement(options)
Параметры:
componentRestrictions
Тип: ComponentRestrictions optional
Ограничения компонента. Ограничения компонентов используются для ограничения прогнозов только теми, которые находятся в родительском компоненте. Например, страна.
locationBias
Тип: LocationBias optional
Мягкая граница или подсказка, которую можно использовать при поиске мест.
locationRestriction
Тип: LocationRestriction optional
Границы для ограничения результатов поиска.
name
Тип: string optional
Имя, которое будет использоваться для элемента ввода. Подробности см. на https://developer.mozilla.org/en-US/docs/Web/HTML/Element/input#name . Следует тому же поведению, что и атрибут имени для входных данных. Обратите внимание, что это имя будет использоваться при отправке формы. Подробности см. на https://developer.mozilla.org/en-US/docs/Web/HTML/Element/form .
HTML-атрибут:
  • <gmp-placeautocomplete name="string"></gmp-placeautocomplete>
requestedLanguage
Тип: string optional
Идентификатор языка, на котором должны быть возвращены результаты, если это возможно. Результаты на выбранном языке могут получить более высокий рейтинг, но предложения не ограничиваются этим языком. См. список поддерживаемых языков .
HTML-атрибут:
  • <gmp-placeautocomplete requested-language="string"></gmp-placeautocomplete>
requestedRegion
Тип: string optional
Код региона, который используется для форматирования и фильтрации результатов. Это не ограничивает предложения этой страной. Код региона принимает двухсимвольное значение ccTLD («домен верхнего уровня») . Большинство кодов ccTLD идентичны кодам ISO 3166-1, за некоторыми заметными исключениями. Например, нДВУ Соединенного Королевства — «uk» ( .co.uk ), а его код ISO 3166-1 — «gb» (технически для организации «Соединенное Королевство Великобритании и Северной Ирландии»).
HTML-атрибут:
  • <gmp-placeautocomplete requested-region="string"></gmp-placeautocomplete>
types
Тип: Array <string> optional
Типы прогнозов, которые будут возвращены. Поддерживаемые типы см. в руководстве разработчика . Если типы не указаны, будут возвращены все типы.
HTML-атрибут:
  • <gmp-placeautocomplete types="type1 type2 type3..."></gmp-placeautocomplete>
prediction-item
Элемент в раскрывающемся списке прогнозов, представляющий один прогноз.
prediction-item-icon
Значок отображается слева от каждого элемента в списке прогнозов.
prediction-item-main-text
Часть элемента прогноза, которая является основным текстом прогноза. Для географических местоположений оно содержит название места, например «Сидней», или название и номер улицы, например «10 King Street». По умолчанию основной текст прогнозируемого элемента окрашен в черный цвет. Если в элементе предсказания есть какой-либо дополнительный текст, он находится за пределами основного текста предсказания и наследует свой стиль от элемента предсказания. По умолчанию он окрашен в серый цвет. Дополнительный текст обычно представляет собой адрес.
prediction-item-match
Часть возвращенного прогноза, соответствующая вводу пользователя. По умолчанию этот совпавший текст выделяется жирным шрифтом. Обратите внимание, что совпадающий текст может находиться где угодно в элементе предсказания. Это не обязательно часть основного текста прогнозируемого элемента.
prediction-item-selected
Элемент, когда пользователь переходит к нему с помощью клавиатуры. Примечание. На выбранные элементы будут влиять как стили этой детали, так и стили детали прогнозируемого элемента.
prediction-list
Визуальный элемент, содержащий список подсказок, возвращаемых службой автозаполнения мест. Этот список отображается в виде раскрывающегося списка под PlaceAutocompleteElement.
Beta addEventListener
addEventListener(type, listener[, options])
Параметры:
  • type : string с учетом регистра, представляющая тип события, которое необходимо прослушивать.
  • listener : EventListener | EventListenerObject Объект, который получает уведомление. Это должна быть функция или объект с методом handleEvent.
  • options : boolean| AddEventListenerOptions optional См. параметры . Пользовательские события поддерживают только capture и passive .
Возвращаемое значение: void
Устанавливает функцию, которая будет вызываться всякий раз, когда указанное событие доставляется в цель. См. addEventListener .
Beta removeEventListener
removeEventListener(type, listener[, options])
Параметры:
  • type : string Строка, определяющая тип события, для которого необходимо удалить прослушиватель событий.
  • listener : EventListener | EventListenerObject Прослушиватель событий обработчика событий, который необходимо удалить из целевого объекта события.
  • options : boolean| EventListenerOptions optional См. параметры.
Возвращаемое значение: void
Удаляет из цели прослушиватель событий, ранее зарегистрированный с помощью addEventListener. См. RemoveEventListener .

Интерфейс PlaceAutocompleteElementOptions

google.maps.places . PlaceAutocompleteElementOptions Интерфейс google.maps.places . PlaceAutocompleteElementOptions

Параметры создания PlaceAutocompleteElement.

componentRestrictions optional
Тип: ComponentRestrictions optional
См. PlaceAutocompleteElement.componentRestrictions .
locationBias optional
Тип: LocationBias optional
См. PlaceAutocompleteElement.locationBias .
locationRestriction optional
Тип: LocationRestriction optional
См. PlaceAutocompleteElement.locationRestriction .
requestedLanguage optional
Тип: string optional
См. PlaceAutocompleteElement.requestedLanguage .
requestedRegion optional
Тип: string optional
См. PlaceAutocompleteElement.requestedRegion .
types optional
Тип: Array <string> optional
См. PlaceAutocompleteElement.types .

Класс PlaceAutocompletePlaceSelectEvent

google.maps.places . PlaceAutocompletePlaceSelectEvent Класс google.maps.places . PlaceAutocompletePlaceSelectEvent

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

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

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

Beta place
Тип: Place

Класс PlaceAutocompleteRequestErrorEvent

google.maps.places . PlaceAutocompleteRequestErrorEvent Класс google.maps.places . PlaceAutocompleteRequestErrorEvent

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

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

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

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

google.maps.places . Autocomplete Класс 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
Возвращает поля, которые будут включены в ответ «Поместить в сведения» после успешного получения сведений. Список полей см. в PlaceResult .
getPlace
getPlace()
Параметры: Нет
Возвращаемое значение: PlaceResult Место, выбранное пользователем.
Возвращает сведения о месте, выбранном пользователем, если данные были успешно получены. В противном случае возвращается объект-заглушка Place со свойством name , равным текущему значению поля ввода.
setBounds
setBounds(bounds)
Параметры:
Возвращаемое значение: Нет
Устанавливает предпочтительную область, в которой возвращаются результаты размещения. Результаты смещены в сторону этой области, но не ограничиваются ею.
setComponentRestrictions
setComponentRestrictions(restrictions)
Параметры:
Возвращаемое значение: Нет
Устанавливает ограничения компонента. Ограничения компонентов используются для ограничения прогнозов только теми, которые находятся в родительском компоненте. Например, страна.
setFields
setFields(fields)
Параметры:
  • fields : Array <string> optional
Возвращаемое значение: Нет
Задает поля, которые будут включены в ответ «Поместить в подробные сведения» при успешном получении сведений. Список полей см. в 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 без определения других свойств.

Интерфейс автозаполнения опций

google.maps.places . AutocompleteOptions Интерфейс google.maps.places . AutocompleteOptions

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

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

google.maps.places . SearchBox Класс 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 Интерфейс google.maps.places . SearchBoxOptions

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

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