gapi.cloudsearch.widget.searchbox.Builder
Kreator pola wyszukiwania. Użyj konstruktora i nie wywołuj bezpośrednio konstruktora searchbox.
Zespół
Monter
new Builder()
Przykład
// 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);
Metody
kompilacja
build() zwraca SearchBox
- Zwroty
-
non-null SearchBox
setAdapter
setAdapter(adapter) zwraca Builder
Wymagany. Dostosowywanie wyszukiwania przez użytkownika za pomocą tego adaptera.
Parametr |
|
---|---|
adapter |
Możesz zastąpić część metod. Wartość nie może być pusta. |
- Zwroty
-
non-null Builder
to
Przykład
const adapter = {
interceptSuggestRequest: function(request) {
// Change the request
}
}
builder.setAdapter(adapter).build();
setAnchor
setAnchor(anchor) zwraca Builder
Wymagany. Musi to być prawidłowy element HTMLElement, który może zawierać węzły podrzędne. Punkt zakotwiczenia nakładki wyszukiwania. Nakładka jest dodawana jako ostatni element w ankru. Pozycja nakładki to dół kotwicy.
Parametr |
|
---|---|
anchor |
HTMLElement Wartość nie może być pusta. |
- Wycofano
- Zamiast tego użyj metody setAnchorElement
- Zwroty
-
non-null Builder
to
setAnchorElement
setAnchorElement(anchorElement) zwraca Builder
Wymagany. Musi to być prawidłowy element HTMLElement, który może zawierać węzły podrzędne. Punkt zakotwiczenia nakładki wyszukiwania. Nakładka jest dodawana jako ostatni element w ankru. Pozycja nakładki to dół kotwicy.
Parametr |
|
---|---|
anchorElement |
HTMLElement Wartość nie może być pusta. |
- Zwroty
-
non-null Builder
to
setHints
setHints(hints) zwraca Builder
Opcjonalnie. Wskazówki w polu wyszukiwania, gdy dane są puste. Gdy dane wejściowe są puste, z tablicy wybierana jest losowa podpowiedź.
Parametr |
|
---|---|
wskazówki |
Tablica ciągów znaków Wartość nie może być pusta. |
- Zwroty
-
non-null Builder
to
setInput
setInput(input) zwraca Builder
Wymagany. Element HTMLElement, w którym użytkownik podaje zapytanie. Musi to być element <input> lub <textarea>.
Parametr |
|
---|---|
dane wejściowe |
HTMLElement Wartość nie może być pusta. |
- Wycofano
- Zamiast tego użyj metody setInputElement
- Zwroty
-
non-null Builder
to
setInputElement
setInputElement(inputElement) zwraca Builder
Wymagany. Element HTMLElement, w którym użytkownik podaje zapytanie. Musi to być element <input> lub <textarea>.
Parametr |
|
---|---|
inputElement |
HTMLElement Wartość nie może być pusta. |
- Zwroty
-
non-null Builder
to
setResultsContainer
setResultsContainer(resultsContainer) zwraca Builder
Opcjonalnie. Kontenery do wyświetlania wyników wyszukiwania. Jeśli jest ustawiony, wyniki są renderowane w kontenerze wyników wyszukiwania. Jeśli nie jest ustawione, wyniki są wyświetlane na stronie cloudsearch.google.com.
Parametr |
|
---|---|
resultsContainer |
gapi.cloudsearch.widget.resultscontainer.ResultsContainer Wartość nie może być pusta. |
- Zobacz też
- ResultsContainer
- Zwroty
-
non-null Builder
to
setSearchApplicationId
setSearchApplicationId(searchApplicationId) zwraca Builder
Opcjonalnie. Określa identyfikator aplikacji wyszukiwarki, który ma być używany do wysyłania żądań. Musi być poprzedzona ciągiem „searchapplications/”.
Parametr |
|
---|---|
searchApplicationId |
ciąg znaków |
- Zwroty
-
non-null Builder
to
setThrottleInterval
setThrottleInterval(throttleInterval) zwraca Builder
Opcjonalnie. Interwał ograniczania przepustowości w ms podczas wysyłania żądania. Pole wyszukiwania wysyła mniej niż 1 żądanie co throttleIntervalms. Jeśli parametr throttleInternal jest mniejszy niż 200, pole wyszukiwania zignoruje tę wartość i zamiast niej użyje wartości 200 jako interwału.
Parametr |
|
---|---|
throttleInterval |
liczba |
- Zwroty
-
non-null Builder
to