类：Builder

gapi.cloudsearch.widget.searchbox.Builder

类   静态

搜索框的构建器。使用构建器，不要直接调用 searchbox 构造函数。

构造函数

构建器

new Builder()

示例

// 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);

方法

build

build() 会返回 SearchBox

返回

non-null SearchBox 

setAdapter

setAdapter(adapter) 会返回 Builder

必需。使用此适配器自定义用户的搜索体验。

参数
adapter	SearchBoxAdapter 您可以替换部分方法。 值不得为 null。

返回

non-null Builder this

示例

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

builder.setAdapter(adapter).build();

setAnchor

setAnchor(anchor) 会返回 Builder

必需。必须是可以包含子节点的有效 HTMLElement。 搜索叠加层的锚点。叠加层会作为锚点中的最后一个子级添加。叠加层的位置是锚点的底部。

参数
anchor	HTMLElement 值不得为 null。

已弃用

请改用 `setAnchorElement`

返回

non-null Builder this

setAnchorElement

setAnchorElement(anchorElement) 会返回 Builder

必需。必须是可以包含子节点的有效 HTMLElement。 搜索叠加层的锚点。叠加层会作为锚点中的最后一个子级添加。叠加层的位置是锚点的底部。

参数
anchorElement	HTMLElement 值不得为 null。

返回

non-null Builder this

setHints

setHints(hints) 返回 Builder

可选。输入内容为空时，搜索框中的提示。 如果输入为空，系统会从数组中随机选择一条提示。

参数
提示	字符串数组 值不得为 null。

返回

non-null Builder this

setInput

setInput(input) 会返回 Builder

必需。用户输入查询的 HTMLElement。 必须为 <input> 或 <textarea>

参数
输入	HTMLElement 值不得为 null。

已弃用

请改用 `setInputElement`

返回

non-null Builder this

setInputElement

setInputElement(inputElement) 会返回 Builder

必需。用户输入查询的 HTMLElement。 必须为 <input> 或 <textarea>

参数
inputElement	HTMLElement 值不得为 null。

返回

non-null Builder this

setResultsContainer

setResultsContainer(resultsContainer) 会返回 Builder

可选。用于显示搜索结果的容器。 如果设置，结果会在搜索结果容器中呈现。 如果未设置，结果会显示在 cloudsearch.google.com 中。

参数
resultsContainer	gapi.cloudsearch.widget.resultscontainer.ResultsContainer 值不得为 null。

另请参阅

ResultsContainer

返回

non-null Builder this

setSearchApplicationId

setSearchApplicationId(searchApplicationId) 会返回 Builder

可选。设置要用于请求的搜索应用 ID。必须带有“searchapplications/”前缀。

参数
searchApplicationId	字符串

返回

non-null Builder this

setThrottleInterval

setThrottleInterval(throttleInterval) 会返回 Builder

可选。触发请求时的节流间隔（以毫秒为单位）。 搜索框每隔 throttleInterval 毫秒发送的请求不超过 1 个。如果 throttleInternal 小于 200，搜索框会忽略该值，改用 200 作为间隔时间。

参数
throttleInterval	数值

返回

non-null Builder this