gapi.cloudsearch.widget.searchbox.Builder
Pembuat kotak penelusuran. Gunakan builder dan jangan langsung memanggil konstruktor kotak penelusuran.
Konstruktor
Builder
new Builder()
Contoh
// 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);
Metode
build
build() menampilkan SearchBox
- Hasil
-
non-null SearchBox
setAdapter
setAdapter(adapter) menampilkan Builder
Wajib diisi. Sesuaikan pengalaman penelusuran pengguna dengan adaptor ini.
Parameter |
|
---|---|
adapter |
Anda dapat mengganti sebagian metode. Nilai tidak boleh null. |
- Hasil
-
non-null Builder
ini
Contoh
const adapter = {
interceptSuggestRequest: function(request) {
// Change the request
}
}
builder.setAdapter(adapter).build();
setAnchor
setAnchor(anchor) menampilkan Builder
Wajib diisi. Harus berupa HTMLElement yang valid dan dapat berisi node turunan. Anchor overlay penelusuran. Overlay ditambahkan sebagai turunan terakhir di anchor. Posisi overlay adalah bagian bawah anchor.
Parameter |
|
---|---|
anchor |
HTMLElement Nilai tidak boleh null. |
- Tidak digunakan lagi
- Gunakan `setAnchorElement` sebagai gantinya
- Hasil
-
non-null Builder
ini
setAnchorElement
setAnchorElement(anchorElement) menampilkan Builder
Wajib diisi. Harus berupa HTMLElement yang valid dan dapat berisi node turunan. Anchor overlay penelusuran. Overlay ditambahkan sebagai turunan terakhir di anchor. Posisi overlay adalah bagian bawah anchor.
Parameter |
|
---|---|
anchorElement |
HTMLElement Nilai tidak boleh null. |
- Hasil
-
non-null Builder
ini
setHints
setHints(hints) menampilkan Builder
Opsional. Petunjuk di kotak penelusuran saat input kosong. Jika input kosong, petunjuk acak akan dipilih dari array.
Parameter |
|
---|---|
petunjuk |
Array string Nilai tidak boleh null. |
- Hasil
-
non-null Builder
ini
setInput
setInput(input) menampilkan Builder
Wajib diisi. HTMLElement yang digunakan pengguna untuk memasukkan kueri. Harus berupa <input> atau <textarea>
Parameter |
|
---|---|
input |
HTMLElement Nilai tidak boleh null. |
- Tidak digunakan lagi
- Gunakan `setInputElement` sebagai gantinya
- Hasil
-
non-null Builder
ini
setInputElement
setInputElement(inputElement) menampilkan Builder
Wajib diisi. HTMLElement yang digunakan pengguna untuk memasukkan kueri. Harus berupa <input> atau <textarea>
Parameter |
|
---|---|
inputElement |
HTMLElement Nilai tidak boleh null. |
- Hasil
-
non-null Builder
ini
setResultsContainer
setResultsContainer(resultsContainer) menampilkan Builder
Opsional. Penampung untuk menampilkan hasil penelusuran. Jika ditetapkan, hasilnya akan dirender di penampung hasil penelusuran. Jika tidak ditetapkan, hasilnya akan ditampilkan di cloudsearch.google.com.
Parameter |
|
---|---|
resultsContainer |
gapi.cloudsearch.widget.resultscontainer.ResultsContainer Nilai tidak boleh null. |
- Lihat juga
- ResultsContainer
- Hasil
-
non-null Builder
ini
setSearchApplicationId
setSearchApplicationId(searchApplicationId) menampilkan Builder
Opsional. Menetapkan ID aplikasi penelusuran yang akan digunakan untuk permintaan. Harus diawali dengan 'searchapplications/'.
Parameter |
|
---|---|
searchApplicationId |
string |
- Hasil
-
non-null Builder
ini
setThrottleInterval
setThrottleInterval(throttleInterval) menampilkan Builder
Opsional. Interval throttle dalam md saat permintaan diaktifkan. Kotak penelusuran mengirim kurang dari satu permintaan setiap milidetik throttleInterval. Jika throttleInternal kurang dari 200, kotak penelusuran akan mengabaikan nilai tersebut dan menggunakan 200 sebagai interval.
Parameter |
|
---|---|
throttleInterval |
angka |
- Hasil
-
non-null Builder
ini