کلاس: سازنده

گپی جستجوی ابری ویجت جعبه جستجو سازنده

کلاس ایستا

سازنده جعبه جستجو از سازنده استفاده کنید و مستقیماً با سازنده جعبه جستجو تماس نگیرید.

سازنده

سازنده

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

مواد و روش ها

ساختن

build() SearchBox را برمی گرداند

برمی گرداند

non-null SearchBox

تنظیم آداپتور

setAdapter(adapter) Builder را برمی گرداند

ضروری . تجربه جستجوی کاربر را با این آداپتور سفارشی کنید.

پارامتر
آداپتور	SearchBoxAdapter می توانید بخشی از روش ها را لغو کنید. مقدار نباید صفر باشد.

برمی گرداند

این non-null Builder

مثال

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

builder.setAdapter(adapter).build();

setAnchor

setAnchor(anchor) Builder را برمی گرداند

ضروری . باید یک HTMLElement معتبر باشد که می تواند شامل گره های فرزند باشد. لنگر پوشش جستجو. روکش به عنوان آخرین فرزند در لنگر اضافه می شود. موقعیت روکش پایین لنگر است.

پارامتر
لنگر	HTMLElement مقدار نباید صفر باشد.

منسوخ

به جای آن از «setAnchorElement» استفاده کنید

برمی گرداند

این non-null Builder

setAnchorElement

setAnchorElement(anchorElement) Builder را برمی گرداند

ضروری . باید یک HTMLElement معتبر باشد که می تواند شامل گره های فرزند باشد. لنگر پوشش جستجو. روکش به عنوان آخرین فرزند در لنگر اضافه می شود. موقعیت روکش پایین لنگر است.

پارامتر
AnchorElement	HTMLElement مقدار نباید صفر باشد.

برمی گرداند

این non-null Builder

setHints

setHints(hints) Builder را برمی گرداند

اختیاری . هنگام خالی بودن ورودی، نکات مربوط به کادر جستجو. هنگامی که ورودی خالی است، یک اشاره تصادفی از آرایه انتخاب می شود.

پارامتر
نکات	آرایه رشته مقدار نباید صفر باشد.

برمی گرداند

این non-null Builder

setInput

setInput(input) Builder را برمی گرداند

ضروری . یک HTMLElement که کاربر پرس و جو را وارد می کند. باید <input> یا <textarea> باشد

پارامتر
ورودی	HTMLElement مقدار نباید صفر باشد.

منسوخ

به جای آن از «setInputElement» استفاده کنید

برمی گرداند

این non-null Builder

setInputElement

setInputElement(inputElement) Builder را برمی گرداند

ضروری . یک HTMLElement که کاربر پرس و جو را وارد می کند. باید <input> یا <textarea> باشد

پارامتر
عنصر ورودی	HTMLElement مقدار نباید صفر باشد.

برمی گرداند

این non-null Builder

setResultsContainer

setResultsContainer(resultsContainer) Builder را برمی گرداند

اختیاری . ظرفی برای نمایش نتایج جستجو در صورت تنظیم، نتایج در ظرف نتایج جستجو ارائه می شود. اگر تنظیم نشود، نتایج در cloudsearch.google.com نشان داده می شود.

پارامتر
کانتینر نتایج	gapi.cloudsearch.widget.resultscontainer.ResultsContainer مقدار نباید صفر باشد.

همچنین ببینید

کانتینر نتایج

برمی گرداند

این non-null Builder

setSearchApplicationId

setSearchApplicationId(searchApplicationId) Builder را برمی گرداند

اختیاری . شناسه برنامه جستجو را برای استفاده برای درخواست ها تنظیم می کند. باید با پیشوند "جستجو برنامه ها/" باشد.

پارامتر
SearchApplicationId	رشته

برمی گرداند

این non-null Builder

setThrottleInterval

setThrottleInterval(throttleInterval) Builder را برمی گرداند

اختیاری . فاصله دریچه گاز بر حسب میلی ثانیه در درخواست شلیک. کادر جستجو در هر throttleInterval میلی ثانیه کمتر از یک درخواست ارسال می کند. اگر throttleInternal کمتر از 200 باشد، کادر جستجو مقدار را نادیده می گیرد و به جای آن از 200 به عنوان فاصله استفاده می کند.

پارامتر
throttleInterval	عدد

برمی گرداند

این non-null Builder