מחלקה: בונה

gapi.cloudsearch.widget.searchbox.Builder

class   static

בונה תיבת חיפוש. שימוש ב-builder בלי להתקשר ישירות את constructor של תיבת החיפוש.

יצרן

בנאי

חדשה 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(מתאם) מחזיר Builder

נדרש. בעזרת המתאם הזה אפשר להתאים אישית את חוויית החיפוש של המשתמש.

פרמטר
מתאם	SearchBoxAdapter אפשר לשנות חלק מהשיטות. הערך לא יכול להיות null.

החזרות

non-null Builder

דוגמה

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

builder.setAdapter(adapter).build();

setAnchor

setICON(עוגן) מחזיר Builder

נדרש. חייב להיות רכיב HTMLElement חוקי שיכול להכיל צאצא צמתים. עוגן של שכבת-העל של החיפוש. שכבת-העל נוספה בתור הצאצא האחרון בעוגן. המיקום של שכבת-העל הוא בחלק התחתון של העוגן.

פרמטר
עוגן	HTMLElement הערך לא יכול להיות null.

הוצא משימוש

במקום זאת, צריך להשתמש ב-'setOriginalElement'

החזרות

non-null Builder

setAnchorElement

setSlideElement(cpcElement) מחזיר 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) returns Builder

נדרש. רכיב HTMLElement שהמשתמשים מזינים את השאילתה. חייב להיות <input> או <textarea>

פרמטר
inputElement	HTMLElement הערך לא יכול להיות null.

החזרות

non-null Builder

setResultsContainer

set ResultsContainer(resultsContainer) מחזירה Builder

אופציונלי. מאגר להצגת תוצאות חיפוש. אם היא מוגדרת, התוצאות מעובדות במאגר של תוצאות החיפוש. אם היא לא מוגדרת, התוצאות יוצגו בכתובת cloudsearch.google.com.

פרמטר
resultsContainer	gapi.cloudsearch.widget.resultscontainer.ResultsContainer הערך לא יכול להיות null.

ראה גם

ResultsContainer

החזרות

non-null Builder

setSearchApplicationId

setSearchApplicationId(searchApplicationId) מחזיר Builder

אופציונלי. מגדיר את המזהה של אפליקציית החיפוש שישמש לבקשות. חובה יופיע התחילית 'searchapplications/'.

פרמטר
searchApplicationId	מחרוזת

החזרות

non-null Builder

setThrottleInterval

setThrottleInterval(throttleInterval) מחזיר Builder

אופציונלי. מרווח הווסת באלפיות השנייה בעת בקשת הפעלה. תיבת החיפוש שולחת פחות מבקשה אחת בכל throttleInterval אלפיות שנייה. אם throttle Internal קטן מ-200, תיבת החיפוש מתעלמת את הערך, ובמקום זאת משתמשת ב-200 כמרווח.

פרמטר
throttleInterval	number

החזרות

non-null Builder