gapi. cloudsearch. הווידג'ט. searchbox. 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() מחזיר תיבת חיפוש
- החזרות
-
non-null SearchBox
setAdapter
setAdapter(adapter) returns Builder
נדרש. יש לך אפשרות להתאים אישית את חוויית החיפוש של המשתמש באמצעות המתאם הזה.
פרמטר |
|
---|---|
מתאם |
אפשר לשנות חלק מהשיטות. הערך לא יכול להיות ריק. |
- החזרות
-
non-null Builder
הזו
דוגמה
const adapter = {
interceptSuggestRequest: function(request) {
// Change the request
}
}
builder.setAdapter(adapter).build();
setAnchor
setanchor(anchor) returns Builder
נדרש. חייב להיות HTMLElement חוקי שיכול להכיל צומתי צאצא. עוגן של שכבת-על לחיפוש. שכבת-העל מתווספת כצאצא האחרון בעוגן. המיקום של שכבת-העל הוא החלק התחתון של העוגן.
פרמטר |
|
---|---|
עוגן |
HTMLElement הערך לא יכול להיות ריק. |
- הוצא משימוש
- שימוש ב-'setanchorElement' במקום
- החזרות
-
non-null Builder
הזו
setAnchorElement
setanchorElement(anchorElement) returns Builder
נדרש. חייב להיות HTMLElement חוקי שיכול להכיל צומתי צאצא. עוגן של שכבת-על לחיפוש. שכבת-העל מתווספת כצאצא האחרון בעוגן. המיקום של שכבת-העל הוא החלק התחתון של העוגן.
פרמטר |
|
---|---|
anchorElement |
HTMLElement הערך לא יכול להיות ריק. |
- החזרות
-
non-null Builder
הזו
setHints
setHints(hints) returns Builder
Optional. הרמזים בתיבת החיפוש כשהקלט ריק. כשהקלט ריק, נבחר רמז אקראי מהמערך.
פרמטר |
|
---|---|
רמזים |
מערך של מחרוזת הערך לא יכול להיות ריק. |
- החזרות
-
non-null Builder
הזו
setInput
setinput(input) החזרות Builder
נדרש. רכיב HTMLElement שהמשתמש מזין את השאילתה. חייב להיות <input> או <textarea>
פרמטר |
|
---|---|
קלט |
HTMLElement הערך לא יכול להיות ריק. |
- הוצא משימוש
- במקום זאת, צריך להשתמש ב-'setinputElement'
- החזרות
-
non-null Builder
הזו
setInputElement
setinputElement(inputElement) מחזיר Builder
נדרש. רכיב HTMLElement שהמשתמש מזין את השאילתה. חייב להיות <input> או <textarea>
פרמטר |
|
---|---|
inputElement |
HTMLElement הערך לא יכול להיות ריק. |
- החזרות
-
non-null Builder
הזו
setResultsContainer
setResultsContainer(resultsContainer) Builder)
Optional. מאגר להצגת תוצאות חיפוש. אם המדיניות מוגדרת, המערכת מעבדת את התוצאות במאגר של תוצאות החיפוש. אם המדיניות לא מוגדרת, התוצאות יוצגו בכתובת cloudsearch.google.com.
פרמטר |
|
---|---|
resultsContainer |
gapi.cloudsearch.widget.resultscontainer.ResultsContainer הערך לא יכול להיות ריק. |
- כדאי לעיין גם בפרטים הבאים
- ResultsContainer
- החזרות
-
non-null Builder
הזו
setSearchApplicationId
setSearchApplicationId(searchApplicationId) returns Builder
Optional. מגדיר את המזהה של אפליקציית החיפוש לשימוש בבקשות. התחילית חייבת להיות 'searchapplications/'.
פרמטר |
|
---|---|
searchApplicationId |
מחרוזת |
- החזרות
-
non-null Builder
הזו
setThrottleInterval
setThrottleInterval(throttleInterval) מחזירות Builder
Optional. מרווח הווסת באלפיות השנייה בבקשת ההפעלה. תיבת החיפוש שולחת פחות מבקשה אחת בכל throttleInterval באלפיות שנייה. אם הערך של throttleInternal קטן מ-200, תיבת החיפוש מתעלמת מהערך ומשתמשת במקום זאת ב-200 כמרווח.
פרמטר |
|
---|---|
throttleInterval |
מספר |
- החזרות
-
non-null Builder
הזו