Loại: Trình tạo

gapi.cloudsearch.widget.searchbox.Builder

lớp   tĩnh

Trình tạo hộp tìm kiếm. Hãy 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

Builder() mới

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

Trả bóng

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 bộ chuyển đổi này.

Thông số
bộ chuyển đổi	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.

Trả bóng

non-null Builder nội dung này

Ví dụ:

const adapter = {
 interceptSuggestRequest: function(request) {
    // Change the request
  }
}

builder.setAdapter(adapter).build();

setAnchor

setAnchor(anchor) trả về Trình tạo

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

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

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

Thay vào đó, hãy sử dụng "setanchorElement"

Trả bóng

non-null Builder nội dung này

setAnchorElement

setAnchorElement(anchorElement) trả về Trình tạo

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

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

Trả bóng

non-null Builder nội dung này

setHints

setHints(gợi ý) trả về Trình tạo

Optional . Các gợi ý trên hộp tìm kiếm khi bạn nhập 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.

Trả bóng

non-null Builder nội dung này

setInput

setInput(input) trả về Builder

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

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

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

Thay vào đó, hãy sử dụng "setInputElement"

Trả bóng

non-null Builder nội dung này

setInputElement

setInputElement(inputElement) trả về Trình tạo

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

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

Trả bóng

non-null Builder nội dung này

setResultsContainer

setResultsContainer(resultsContainer) sẽ trả về Trình tạo

Optional . Vùng chứa để hiển thị kết quả tìm kiếm. Nếu được đặt, 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, kết quả sẽ xuất hiện trên cloudsearch.google.com.

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

Xem thêm

ResultsContainer

Trả bóng

non-null Builder nội dung này

setSearchApplicationId

setSearchApplicationId(searchApplicationId) trả về Builder

Optional . Đặ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	string

Trả bóng

non-null Builder nội dung này

setThrottleInterval

setThrottleInterval(throttleInterval) trả về trình tạo

Optional . Khoảng thời gian điều tiết tính bằng mili giây khi yêu cầu kích hoạt. Hộp tìm kiếm gửi chưa đến 1 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ị này và sử dụng 200 làm khoảng thời gian thay thế.

Thông số
throttleInterval	number

Trả bóng

non-null Builder nội dung này