クラス: Builder

gapi.cloudsearch.widget.searchbox.Builder

クラス   静的

検索ボックスのビルダー。ビルダーを使用し、検索ボックスのコンストラクタを直接呼び出さないでください。

コンストラクタ

Builder

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() returns SearchBox

戻り値

non-null SearchBox 

setAdapter

setAdapter(adapter) が Builder を返す

必須。このアダプタを使用して、ユーザーの検索エクスペリエンスをカスタマイズします。

パラメータ
アダプター	SearchBoxAdapter メソッドの一部をオーバーライドできます。 値を null にすることはできません。

戻り値

non-null Builder this

例

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

builder.setAdapter(adapter).build();

setAnchor

setAnchor(anchor) returns Builder

必須。子ノードを含めることができる有効な HTMLElement である必要があります。検索オーバーレイのアンカー。オーバーレイは、アンカーの最後の子として追加されます。オーバーレイの位置はアンカーの下部です。

パラメータ
アンカー	HTMLElement 値を null にすることはできません。

非推奨

代わりに「setAnchorElement」を使用してください

戻り値

non-null Builder this

setAnchorElement

setAnchorElement(anchorElement) returns Builder

必須。子ノードを含めることができる有効な HTMLElement である必要があります。検索オーバーレイのアンカー。オーバーレイは、アンカーの最後の子として追加されます。オーバーレイの位置はアンカーの下部です。

パラメータ
anchorElement	HTMLElement 値を null にすることはできません。

戻り値

non-null Builder this

setHints

setHints(hints) returns Builder

（省略可）入力が空のときに検索ボックスに表示されるヒント。 入力が空の場合、配列からランダムにヒントが選択されます。

パラメータ
ヒント	文字列の配列 値を null にすることはできません。

戻り値

non-null Builder this

setInput

setInput(input) returns Builder

必須。ユーザーがクエリを入力する HTMLElement。<input> または <textarea> である必要があります

パラメータ
入力	HTMLElement 値を null にすることはできません。

非推奨

代わりに「setInputElement」を使用してください

戻り値

non-null Builder this

setInputElement

setInputElement(inputElement) returns 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) returns Builder

（省略可）リクエストに使用する検索アプリ ID を設定します。先頭に「searchapplications/」を付ける必要があります。

パラメータ
searchApplicationId	文字列

戻り値

non-null Builder this

setThrottleInterval

setThrottleInterval(throttleInterval) returns Builder

（省略可）トリガー リクエストのスロットル間隔（ミリ秒単位）。検索ボックスは、throttleInterval ミリ秒ごとに 1 件未満のリクエストを送信します。throttleInternal が 200 未満の場合、検索ボックスはその値を無視し、代わりに 200 を間隔として使用します。

パラメータ
throttleInterval	数値

戻り値

non-null Builder this