gapi. cloudsearch. widget. searchbox。 Builder
搜尋框的建構工具。使用建構工具,且不要直接呼叫搜尋框建構函式。
建構函式
Builder
新 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) 傳回建構工具
必備。使用這個轉接程式,自訂使用者的搜尋體驗。
參數 |
|
---|---|
轉接器 |
您可以覆寫方法的一部分。 值不得為空值。 |
- 傳回
-
non-null Builder
這個
範例
const adapter = {
interceptSuggestRequest: function(request) {
// Change the request
}
}
builder.setAdapter(adapter).build();
setAnchor
setAnchor(anchor) 傳回建構工具
必備。必須是可包含子節點的有效 HTMLElement。 搜尋重疊的錨定標記。系統會將疊加層新增為錨點中的最後一個子項。疊加層的位置是錨定標記的底部。
參數 |
|
---|---|
anchor |
HTMLElement 值不得為空值。 |
- 已淘汰
- 請改用「setAnchorElement」
- 傳回
-
non-null Builder
這個
setAnchorElement
setAnchorElement(anchorElement) 傳回建構工具
必備。必須是可包含子節點的有效 HTMLElement。 搜尋重疊的錨定標記。系統會將疊加層新增為錨點中的最後一個子項。疊加層的位置是錨定標記的底部。
參數 |
|
---|---|
anchorElement |
HTMLElement 值不得為空值。 |
- 傳回
-
non-null Builder
這個
setHints
setHints(hints) 傳回建構工具
(選用) 在搜尋框空白處輸入提示。輸入內容空白時,系統會從陣列中隨機挑選提示。
參數 |
|
---|---|
提示 |
字串陣列 值不得為空值。 |
- 傳回
-
non-null Builder
這個
setInput
setInput(input) returns Builder
必備。使用者輸入查詢的 HTMLElement。必須為 <input> 或 <textarea>
參數 |
|
---|---|
輸入 |
HTMLElement 值不得為空值。 |
- 已淘汰
- 請改用「setInputElement」
- 傳回
-
non-null Builder
這個
setInputElement
setInputElement(inputElement) returns Builder
必備。使用者輸入查詢的 HTMLElement。必須為 <input> 或 <textarea>
參數 |
|
---|---|
inputElement |
HTMLElement 值不得為空值。 |
- 傳回
-
non-null Builder
這個
setResultsContainer
setResultsContainer(resultsContainer) 傳回建構工具
(選用) 用來顯示搜尋結果的容器。設定後,結果會顯示在搜尋結果容器中。 如未設定,搜尋結果會顯示在 cloudsearch.google.com 中。
參數 |
|
---|---|
resultsContainer |
gapi.cloudsearch.widget.resultscontainer.ResultsContainer 值不得為空值。 |
- 另請參閱
- ResultsContainer
- 傳回
-
non-null Builder
這個
setSearchApplicationId
setSearchApplicationId(searchApplicationId) 傳回建構工具
(選用) 設定要在要求中使用的搜尋應用程式 ID。開頭須為「searchapplications/」。
參數 |
|
---|---|
searchApplicationId |
字串 |
- 傳回
-
non-null Builder
這個
setThrottleInterval
setThrottleInterval(throttleInterval) 傳回建構工具
(選用) 觸發要求時的節流間隔 (以毫秒為單位)。 搜尋框每每 throttleInterval 毫秒會傳送不到一次要求。如果 throttleInternal 小於 200,搜尋框會忽略這個值,並改為使用 200 做為間隔。
參數 |
|
---|---|
throttleInterval |
號碼 |
- 傳回
-
non-null Builder
這個