Places Widgets

Класс PlaceAutocompleteElement

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

Реализация AutocompleteView for Places API

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

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

PlaceAutocompleteElement
PlaceAutocompleteElement(options)
Параметры:
element optional
Тип: HTMLElement | SVGElement optional
Это поле доступно только для чтения. Элемент DOM, поддерживающий представление.
inputElement
Элемент ввода, для которого отображаются автозаполнения.
Унаследовано: componentRestrictions , locationBias , locationRestriction , requestedLanguage , requestedRegion , types
addListener
addListener(eventName, handler)
Параметры:
Возвращаемое значение: MapsEventListener
Добавляет данную функцию слушателя к данному имени события.
gmp-placeselect
function(place)
Аргументы:
Это событие запускается, когда пользователь выбирает прогноз места. Возвращает объект места.
gmp-requesterror
function()
Аргументы: Нет
Это событие запускается, когда запрос к серверной части был отклонен (например, неверный ключ API). Это событие не всплывает.

Интерфейс PlaceAutocompleteElementOptions

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

Варианты построения PlaceAutocompleteElement.

inputElement
Элемент ввода, для которого отображаются автозаполнения.
componentRestrictions optional
Тип: ComponentRestrictions optional
Ограничения компонента. Ограничения компонентов используются для ограничения прогнозов только теми, которые находятся внутри родительского компонента. Например, страна.
element optional
Тип: HTMLElement | SVGElement optional
Это поле доступно только для чтения. Элемент DOM, поддерживающий представление.
locationBias optional
Тип: LocationBias optional
Мягкая граница или подсказка для использования при поиске мест.
locationRestriction optional
Тип: LocationRestriction optional
Границы для ограничения результатов поиска.
requestedLanguage optional
Тип: string optional
Идентификатор языка для языка, на котором должны быть возвращены результаты, если это возможно. Результаты на выбранном языке могут получить более высокий рейтинг, но предложения не ограничиваются этим языком. См. список поддерживаемых языков .
requestedRegion optional
Тип: string optional
Код региона, который используется для форматирования и фильтрации результатов. Это не ограничивает предложения этой страной. Код региона принимает двухсимвольное значение ccTLD («домен верхнего уровня») . Большинство кодов ccTLD идентичны кодам ISO 3166-1, за некоторыми заметными исключениями. Например, ccTLD Соединенного Королевства — «uk» ( .co.uk ), а его код ISO 3166-1 — «gb» (технически для субъекта «Соединенное Королевство Великобритании и Северной Ирландии»).
types optional
Тип: Array <string> optional
Типы прогнозов, которые должны быть возвращены. Поддерживаемые типы см. в руководстве разработчика . Если типы не указаны, будут возвращены все типы.

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

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
Возвращает поля, которые должны быть включены в ответ Place in the details после успешного получения сведений. Список полей см. в PlaceResult .
getPlace
getPlace()
Параметры: Нет
Возвращаемое значение: PlaceResult Место, выбранное пользователем.
Возвращает сведения о месте, выбранном пользователем, если данные были успешно получены. В противном случае возвращает объект-заглушку Place со свойством name , установленным в текущее значение поля ввода.
setBounds
setBounds(bounds)
Параметры:
Возвращаемое значение: нет
Устанавливает предпочтительную область, в пределах которой возвращаются результаты Place. Результаты смещены в сторону этой области, но не ограничиваются ею.
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 без каких-либо других определенных свойств.

Интерфейс AutocompleteOptions

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 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 Класс 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
Область, в сторону которой следует смещать прогнозы запросов. Прогнозы предвзято относятся к запросам, ориентированным на эти границы, но не ограничиваются ими.