Tự động hoàn thành lớp
Lớp google.maps.places.AutocompleteService
Chứa các phương thức liên quan đến truy xuất truy vấn dự đoán Tự động điền.
Truy cập bằng cách gọi const {AutocompleteService} = await google.maps.importLibrary("places")
. Xem Thư viện trong API JavaScript của Maps.
Hàm dựng | |
---|---|
AutocompleteService |
AutocompleteService() Thông số: Không có
Tạo một thực thể mới của AutocompleteService . |
Phương thức | |
---|---|
getPlacePredictions |
getPlacePredictions(request[, callback]) Thông số:
Giá trị trả về:
Promise<AutocompleteResponse> Truy xuất các truy vấn dự đoán tự động hoàn thành địa điểm dựa trên yêu cầu tự động hoàn thành đã cung cấp. |
getQueryPredictions |
getQueryPredictions(request, callback) Thông số:
Giá trị trả lại: Không có
Truy xuất các truy vấn dự đoán tự động hoàn thành dựa trên yêu cầu tự động hoàn thành truy vấn đã cung cấp. |
Giao diện AutocompletionRequest
Giao diện google.maps.places.AutocompletionRequest
Yêu cầu Tự động hoàn thành sẽ được gửi đến AutocompleteService.getPlacePredictions
.
Thuộc tính | |
---|---|
input |
Loại:
string Người dùng đã nhập chuỗi đầu vào. |
|
Loại:
LatLngBounds|LatLngBoundsLiteral optional Giới hạn cho xu hướng dự đoán. Các dự đoán sẽ được thiên về, nhưng không giới hạn, bounds đã cho. Cả location và radius đều sẽ bị bỏ qua nếu bạn đặt bounds . |
componentRestrictions optional |
Loại:
ComponentRestrictions optional Các hạn chế về thành phần. Giới hạn thành phần chỉ giới hạn truy vấn dự đoán trong thành phần mẹ. Ví dụ: quốc gia. |
language optional |
Loại:
string optional Giá trị nhận dạng ngôn ngữ cho ngôn ngữ mà kết quả sẽ được trả về, nếu có thể. Kết quả bằng ngôn ngữ đã chọn có thể được xếp hạng cao hơn nhưng đề xuất không bị giới hạn ở ngôn ngữ này. Xem danh sách các ngôn ngữ được hỗ trợ. |
|
Loại:
LatLng optional Vị trí cho xu hướng dự đoán. Các dự đoán sẽ thiên về location và radius đã cho. Ngoài ra, bạn có thể sử dụng bounds . |
locationBias optional |
Loại:
LocationBias optional Ranh giới mềm hoặc gợi ý sử dụng khi tìm kiếm địa điểm. |
locationRestriction optional |
Loại:
LocationRestriction optional Các ràng buộc giới hạn kết quả tìm kiếm. |
offset optional |
Loại:
number optional Vị trí ký tự trong từ khoá mà dịch vụ sử dụng văn bản để dự đoán (vị trí của con trỏ trong trường nhập). |
origin optional |
Loại:
LatLng|LatLngLiteral optional Vị trí nơi tính AutocompletePrediction.distance_meters . |
|
Loại:
number optional Bán kính của vùng được sử dụng cho xu hướng dự đoán. radius được chỉ định theo mét và phải luôn đi kèm với một thuộc tính location . Ngoài ra, bạn có thể sử dụng bounds . |
region optional |
Loại:
string optional Mã vùng dùng để định dạng kết quả và lọc kết quả. Thông tin này không hạn chế các đề xuất đối với quốc gia này. Mã vùng chấp nhận giá trị hai ký tự ccTLD ("miền cấp cao nhất"). Hầu hết các mã ccTLD đều giống với mã ISO 3166-1, trừ một số trường hợp ngoại lệ đáng chú ý. Ví dụ: ccTLD của Vương quốc Anh là "uk" ( .co.uk ) trong khi mã ISO 3166-1 là "gb" (về mặt kỹ thuật là pháp nhân "Vương quốc Anh và Bắc Ireland"). |
sessionToken optional |
Loại:
AutocompleteSessionToken optional Tham chiếu duy nhất dùng để nhóm các yêu cầu riêng lẻ thành các phiên. |
types optional |
Loại:
Array<string> optional Loại dự đoán sẽ được trả về. Đối với các loại được hỗ trợ, hãy xem hướng dẫn dành cho nhà phát triển. Nếu không có loại nào được chỉ định, tất cả các loại sẽ được trả về. |
Giao diện người dùng Tự động hoàn thành
Giao diện google.maps.places.AutocompleteResponse
Phản hồi Tự động hoàn thành được lệnh gọi đến AutocompleteService.getPlacePredictions
trả về chứa danh sách AutocompletePrediction
.
Thuộc tính | |
---|---|
predictions |
Loại:
Array<AutocompletePrediction> Danh sách AutocompletePrediction . |
Giao diện QueryAutocompletionRequest
Giao diện google.maps.places.QueryAutocompletionRequest
Yêu cầu Tự động hoàn thành truy vấn sẽ được gửi đến QueryAutocompleteService
.
Thuộc tính | |
---|---|
input |
Loại:
string Người dùng đã nhập chuỗi đầu vào. |
bounds optional |
Loại:
LatLngBounds|LatLngBoundsLiteral optional Giới hạn cho xu hướng dự đoán. Các dự đoán sẽ được thiên về, nhưng không giới hạn, bounds đã cho. Cả location và radius đều sẽ bị bỏ qua nếu bạn đặt bounds . |
location optional |
Loại:
LatLng optional Vị trí cho xu hướng dự đoán. Các dự đoán sẽ thiên về location và radius đã cho. Ngoài ra, bạn có thể sử dụng bounds . |
offset optional |
Loại:
number optional Vị trí ký tự trong từ khoá mà dịch vụ sử dụng văn bản để dự đoán (vị trí của con trỏ trong trường nhập). |
radius optional |
Loại:
number optional Bán kính của vùng được sử dụng cho xu hướng dự đoán. radius được chỉ định theo mét và phải luôn đi kèm với một thuộc tính location . Ngoài ra, bạn có thể sử dụng bounds . |
autocompleteSessionToken
Lớp google.maps.places.AutocompleteSessionToken
Biểu thị mã thông báo phiên dùng để theo dõi phiên tự động hoàn thành, có thể là một chuỗi các lệnh gọi AutocompleteService.getPlacePredictions
theo sau là một lệnh gọi PlacesService.getDetails
.
Truy cập bằng cách gọi const {AutocompleteSessionToken} = await google.maps.importLibrary("places")
. Xem Thư viện trong API JavaScript của Maps.
Hàm dựng | |
---|---|
AutocompleteSessionToken |
AutocompleteSessionToken() Thông số: Không có
Tạo một thực thể mới của AutocompleteSessionToken . |
Component thì.
Giao diện google.maps.places.ComponentRestrictions
Xác định các giới hạn thành phần có thể sử dụng với dịch vụ tự động hoàn thành.
Thuộc tính | |
---|---|
country optional |
Loại:
string|Array<string> optional Hạn chế dự đoán ở quốc gia được chỉ định (mã quốc gia ISO 3166-1 Alpha-2, không phân biệt chữ hoa chữ thường). Ví dụ: 'us' , 'br' hoặc 'au' . Bạn có thể cung cấp một hoặc một mảng gồm tối đa năm chuỗi mã quốc gia. |
Giao diện Dự đoán tự động hoàn thành
Giao diện google.maps.places.AutocompletePrediction
Thể hiện một cụm từ gợi ý của tính năng tự động hoàn thành.
Thuộc tính | |
---|---|
description |
Loại:
string Đây là phiên bản chưa được định dạng của truy vấn do dịch vụ Địa điểm đề xuất. |
matched_substrings |
Loại:
Array<PredictionSubstring> Một tập hợp con trong mô tả của địa điểm khớp với các yếu tố trong thông tin đầu vào của người dùng, phù hợp để đánh dấu các chuỗi con đó. Mỗi chuỗi con được xác định theo độ lệch và độ dài, được biểu thị bằng ký tự unicode. |
place_id |
Loại:
string ID địa điểm có thể được sử dụng để truy lục chi tiết về địa điểm này bằng cách sử dụng dịch vụ chi tiết địa điểm (xem PlacesService.getDetails ). |
structured_formatting |
Loại:
StructuredFormatting Thông tin có cấu trúc về nội dung mô tả về địa điểm, được chia thành một văn bản chính và một văn bản phụ, bao gồm một dãy chuỗi con phù hợp từ dữ liệu nhập tự động hoàn thành, được xác định bằng độ lệch và độ dài, được biểu thị bằng ký tự unicode. |
terms |
Loại:
Array<PredictionTerm> Thông tin về các thuật ngữ riêng lẻ trong mô tả ở trên, từ hầu hết đến ít cụ thể nhất. Ví dụ: "Taco Bell", "Willitis" và "CA". |
types |
Loại:
Array<string> Một loạt các loại mà cụm từ gợi ý thuộc về, ví dụ: 'establishment' hoặc 'geocode' . |
distance_meters optional |
Loại:
number optional Khoảng cách tính bằng mét của địa điểm từ AutocompletionRequest.origin . |
Giao diện Truy vấn dự đoán tự động hoàn thành
Giao diện google.maps.places.QueryAutocompletePrediction
Đại diện cho một truy vấn dự đoán Tự động hoàn thành truy vấn.
Thuộc tính | |
---|---|
description |
Loại:
string Đây là phiên bản chưa được định dạng của truy vấn do dịch vụ Địa điểm đề xuất. |
matched_substrings |
Loại:
Array<PredictionSubstring> Một tập hợp con trong mô tả của địa điểm khớp với các yếu tố trong thông tin đầu vào của người dùng, phù hợp để đánh dấu các chuỗi con đó. Mỗi chuỗi con được xác định theo độ lệch và độ dài, được biểu thị bằng ký tự unicode. |
terms |
Loại:
Array<PredictionTerm> Thông tin về các thuật ngữ riêng lẻ trong phần mô tả ở trên. Các thuật ngữ thuộc tính xuất hiện trước (ví dụ: "nhà hàng"). Cụm từ địa chỉ xuất hiện từ hầu hết đến ít cụ thể nhất. Ví dụ: "San Francisco" và "CA". |
place_id optional |
Loại:
string optional Chỉ có sẵn nếu gợi ý là một địa điểm. ID địa điểm có thể được sử dụng để truy lục chi tiết về địa điểm này bằng cách sử dụng dịch vụ chi tiết địa điểm (xem PlacesService.getDetails ). |
Giao diện dự đoán PredictionTerm
Giao diện google.maps.places.PredictionTerm
Đại diện cho một cụm từ gợi ý.
Thuộc tính | |
---|---|
offset |
Loại:
number Phần bù trừ, bằng ký tự unicode, của phần đầu cụm từ này trong mô tả địa điểm. |
value |
Loại:
string Giá trị của cụm từ này, ví dụ: "Taco Bell". |
Giao diện dự đoán StringSubSub chéo
Giao diện google.maps.places.PredictionSubstring
Đại diện cho chuỗi con dự đoán.
Thuộc tính | |
---|---|
length |
Loại:
number Độ dài của chuỗi con. |
offset |
Loại:
number Độ lệch so với đầu chuỗi con trong chuỗi mô tả. |
Giao diện StructureFormat
Giao diện google.maps.places.StructuredFormatting
Chứa thông tin có cấu trúc về nội dung mô tả về địa điểm, chia thành văn bản chính và văn bản phụ, bao gồm một chuỗi chuỗi con phù hợp từ dữ liệu đầu vào tự động hoàn thành, được xác định bằng độ lệch và độ dài, được biểu thị bằng ký tự unicode.
Thuộc tính | |
---|---|
main_text |
Loại:
string Đây là phần văn bản chính của mô tả chưa được định dạng của địa điểm được dịch vụ Địa điểm đề xuất. Thường là tên của địa điểm. |
main_text_matched_substrings |
Loại:
Array<PredictionSubstring> Một tập hợp con của văn bản chính khớp với các phần tử trong dữ liệu nhập của người dùng, phù hợp để làm nổi bật các chuỗi con đó. Mỗi chuỗi con được xác định theo độ lệch và độ dài, được biểu thị bằng ký tự unicode. |
secondary_text |
Loại:
string Đây là phần văn bản phụ của mô tả chưa được định dạng của địa điểm được dịch vụ Địa điểm đề xuất. Thường là vị trí của địa điểm. |