Loại: Trình tạo

gapi.cloudsearch.widget.searchbox.Builder

lớp   static

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

new 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() trả về SearchBox

Giá trị trả về

non-null SearchBox 

setAdapter

setAdapter(adapter) trả về Builder

Bắt buộc. Tuỳ chỉnh trải nghiệm tìm kiếm của người dùng bằng trình chuyển đổi này.

Thông số
adapter	SearchBoxAdapter Bạn có thể ghi đè một phần của các phương thức. Giá trị không được rỗng.

Giá trị trả về

non-null Builder đâ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 các nút con. Mục cố định của lớp phủ tìm kiếm. Lớp phủ được thêm vào làm phần tử con cuối cùng trong neo. Vị trí của lớp phủ là phần dưới cùng của neo.

Thông số
liên kết	HTMLElement Giá trị không được rỗng.

Không được dùng nữa

Sử dụng `setAnchorElement` thay thế

Giá trị trả về

non-null Builder đây

setAnchorElement

setAnchorElement(anchorElement) trả về Builder

Bắt buộc. Phải là một HTMLElement hợp lệ có thể chứa các nút con. Mục cố định của lớp phủ tìm kiếm. Lớp phủ được thêm vào làm phần tử con cuối cùng trong neo. Vị trí của lớp phủ là phần dưới cùng của neo.

Thông số
anchorElement	HTMLElement Giá trị không được rỗng.

Giá trị trả về

non-null Builder đây

setHints

setHints(gợi ý) trả về Builder

Không bắt buộc. Gợi ý trên hộp tìm kiếm khi dữ liệu đầu vào trống. Khi dữ liệu đầu vào 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 rỗng.

Giá trị trả về

non-null Builder đây

setInput

setInput(input) trả về Builder

Bắt buộc. Một HTMLElement mà người dùng nhập truy vấn. Phải là <input> hoặc <textarea>

Thông số
input	HTMLElement Giá trị không được rỗng.

Không được dùng nữa

Sử dụng `setInputElement` thay thế

Giá trị trả về

non-null Builder đây

setInputElement

setInputElement(inputElement) trả về Builder

Bắt buộc. Một HTMLElement mà người dùng nhập truy vấn. Phải là <input> hoặc <textarea>

Thông số
inputElement	HTMLElement Giá trị không được rỗng.

Giá trị trả về

non-null Builder đây

setResultsContainer

setResultsContainer(resultsContainer) trả về Builder

Không bắt buộc. Vùng chứa để hiển thị kết quả tìm kiếm. Nếu được đặt, kết quả sẽ được hiển thị trong vùng chứa kết quả tìm kiếm. Nếu không được đặt, kết quả sẽ xuất hiện trong cloudsearch.google.com.

Thông số
resultsContainer	gapi.cloudsearch.widget.resultscontainer.ResultsContainer Giá trị không được rỗng.

Xem thêm

ResultsContainer

Giá trị trả về

non-null Builder đâ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 các yêu cầu. Phải có tiền tố là "searchapplications/".

Thông số
searchApplicationId	chuỗi

Giá trị trả về

non-null Builder đây

setThrottleInterval

setThrottleInterval(throttleInterval) trả về Builder

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 gửi ít hơn một yêu cầu mỗi 1000 mili giây throttleInterval. Nếu throttleInternal nhỏ hơn 200, hộp tìm kiếm sẽ bỏ qua giá trị này và sử dụng 200 làm khoảng thời gian.

Thông số
throttleInterval	số

Giá trị trả về

non-null Builder đây