gapi. cloudsearch. widget. searchbox. Builder
Trình tạo hộp tìm kiếm. Sử dụng trình tạo và không gọi trực tiếp hàm khởi tạo hộp tìm kiếm.
Hàm dựng
Trình tạo
hồ sơ thanh toán Builder()
Ví dụ:
// Builds a search box.
function onload() {
gapi.client.init({
'apiKey': '<your api key>',
'clientId': '<your client id>',
// Add additional scopes if needed
'scope': 'https://www.googleapis.com/auth/cloud_search.query',
'hosted_domain': '<your G Suite domain>',
});
const searchBox = new gapi.cloudsearch.widget.searchbox.Builder()
.setInput(document.getElementById('input'))
.setAnchor(document.getElementById('input').parentElement)
.build();
}
gapi.load('client:cloudsearch-widget', onload);
Phương thức
build
build() returns SearchBox
- Giá trị trả về
-
non-null SearchBox
setAdapter
setAdapter(bộ chuyển đổi) trả về Trình tạo
Bắt buộc. Tuỳ chỉnh trải nghiệm tìm kiếm của người dùng bằng bộ chuyển đổi này.
Thông số |
|
---|---|
bộ chuyển đổi |
Bạn có thể ghi đè một phần của phương thức. Giá trị không được để trống. |
- Giá trị trả về
-
non-null Builder
điều này
Ví dụ:
const adapter = {
interceptSuggestRequest: function(request) {
// Change the request
}
}
builder.setAdapter(adapter).build();
setAnchor
setAnchor(anchor) trả về Builder
Bắt buộc. Phải là một HTMLElement hợp lệ có thể chứa phần tử con nút. Neo của lớp phủ tìm kiếm. Đã thêm lớp phủ là phần tử con cuối cùng trong neo. Vị trí của lớp phủ là cuối quảng cáo cố định.
Thông số |
|
---|---|
liên kết |
HTMLElement Giá trị không được để trống. |
- Không được dùng nữa
- Thay vào đó, hãy sử dụng "setAnchorElement"
- Giá trị trả về
-
non-null Builder
điều này
setAnchorElement
setAnchorElement(anchorElement) trả về Builder
Bắt buộc. Phải là một HTMLElement hợp lệ có thể chứa phần tử con nút. Neo của lớp phủ tìm kiếm. Đã thêm lớp phủ là phần tử con cuối cùng trong neo. Vị trí của lớp phủ là cuối quảng cáo cố định.
Thông số |
|
---|---|
anchorElement |
HTMLElement Giá trị không được để trống. |
- Giá trị trả về
-
non-null Builder
điều này
setHints
setHints(hint) trả về Builder
Không bắt buộc. Gợi ý trên hộp tìm kiếm khi thông tin nhập bị trống. Khi thông tin đầu vào bị trống, một gợi ý ngẫu nhiên sẽ được chọn từ mảng.
Thông số |
|
---|---|
gợi ý |
Mảng chuỗi Giá trị không được để trống. |
- Giá trị trả về
-
non-null Builder
điều này
setInput
setInput(input) trả về Builder
Bắt buộc. Một phần tử HTMLElement mà người dùng nhập vào truy vấn. Phải là <input> hoặc <span>
Thông số |
|
---|---|
input |
HTMLElement Giá trị không được để trống. |
- Không được dùng nữa
- Thay vào đó, hãy sử dụng "setInputElement"
- Giá trị trả về
-
non-null Builder
điều này
setInputElement
setInputElement(inputElement) returns Builder
Bắt buộc. Một phần tử HTMLElement mà người dùng nhập vào truy vấn. Phải là <input> hoặc <span>
Thông số |
|
---|---|
inputElement |
HTMLElement Giá trị không được để trống. |
- Giá trị trả về
-
non-null Builder
điều này
setResultsContainer
setresultsContainer(resultsContainer) trả về Builder của Trình tạo
Không bắt buộc. Vùng chứa hiển thị kết quả tìm kiếm. Nếu bạn đặt chính sách này, kết quả sẽ hiển thị trong vùng chứa kết quả tìm kiếm. Nếu bạn không đặt chính sách này, các kết quả sẽ hiển thị trên Cloudsearch.google.com.
Thông số |
|
---|---|
resultsContainer |
gapi.cloudsearch.widget.resultscontainer.ResultsContainer Giá trị không được để trống. |
- Xem thêm
- ResultsContainer
- Giá trị trả về
-
non-null Builder
điều này
setSearchApplicationId
setSearchApplicationId(searchApplicationId) trả về Builder
Không bắt buộc. Đặt mã ứng dụng tìm kiếm để sử dụng cho yêu cầu. Phải có tiền tố là 'searchapplications/'.
Thông số |
|
---|---|
searchApplicationId |
string |
- Giá trị trả về
-
non-null Builder
điều này
setThrottleInterval
setThrottleInterval(throttleInterval) trả về Trình tạo
Không bắt buộc. Khoảng thời gian điều tiết tính bằng mili giây khi kích hoạt yêu cầu. Hộp tìm kiếm sẽ gửi ít hơn một yêu cầu mỗi throttleInterval mili giây. Nếu throttleinternal nhỏ hơn 200, hộp tìm kiếm sẽ bỏ qua giá trị và thay vào đó sử dụng 200 làm khoảng thời gian.
Thông số |
|
---|---|
throttleInterval |
số |
- Giá trị trả về
-
non-null Builder
điều này