クラス: Builder

gapi.cloudsearch.widget.searchbox.Builder

class static

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

コンストラクタ

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

Methods

構築する

build() が SearchBox を返す

戻り値

non-null SearchBox 

setAdapter

setAdapter(adapter) が Builder を返す

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

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

戻り値

non-null Builder 件

例

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

builder.setAdapter(adapter).build();

setAnchor

setAnchor(anchor) が Builder を返す

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

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

非推奨

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

戻り値

non-null Builder 件

setAnchorElement

setAnchorElement(anchorElement) が Builder を返す

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

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

戻り値

non-null Builder 件

setHints

setHints(Hints) は Builder を返します

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

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

戻り値

non-null Builder 件

setInput

setInput(input) が Builder を返す

必須。ユーザーがクエリを入力する HTMLElement。 <input> または <textarea> でなければなりません

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

非推奨

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

戻り値

non-null Builder 件

setInputElement

setInputElement(inputElement) で Builder が返される

必須。ユーザーがクエリを入力する HTMLElement。 <input> または <textarea> でなければなりません

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

戻り値

non-null Builder 件

setResultsContainer

setResultsContainer(resultsContainer) は Builder を返す

省略可。検索結果を表示するためのコンテナ。 設定すると、結果は検索結果コンテナにレンダリングされます。設定しない場合、cloudsearch.google.com に結果が表示されます。

パラメータ
resultsContainer	gapi.cloudsearch.widget.resultscontainer.ResultsContainer 値を null にすることはできません。

関連ドキュメント

ResultsContainer

戻り値

non-null Builder 件

setSearchApplicationId

setSearchApplicationId(searchApplicationId) が Builder を返す

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

パラメータ
searchApplicationId	string

戻り値

non-null Builder 件

setThrottleInterval

setThrottleInterval(throttleInterval) が Builder を返す

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

パラメータ
throttleInterval	数値

戻り値

non-null Builder 件