ชั้นเรียน: ช่างก่อสร้าง

gapi.cloudsearch.widget.searchbox.Builder

class   static

ตัวสร้างช่องค้นหา ใช้ตัวสร้างและอย่าเรียกคอนสตรัคเตอร์ของ searchbox โดยตรง

ผู้ผลิต

ช่างก่อสร้าง

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

setAdapter(adapter) แสดงผล Builder

ต้องระบุ ปรับแต่งประสบการณ์การค้นหาของผู้ใช้ด้วยอะแดปเตอร์นี้

พารามิเตอร์
adapter	SearchBoxAdapter คุณสามารถลบล้างวิธีการบางส่วนได้ ค่าต้องไม่เท่ากับ Null

การคืนสินค้า

non-null Builder this

ตัวอย่าง

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

builder.setAdapter(adapter).build();

setAnchor

setAnchor(anchor) แสดงผล Builder

ต้องระบุ ต้องเป็น HTMLElement ที่ถูกต้องซึ่งมีโหนดย่อยได้ ตำแหน่งของข้อความซ้อนทับการค้นหา ระบบจะเพิ่มการวางซ้อนเป็นองค์ประกอบย่อยสุดท้ายในองค์ประกอบหลัก ตำแหน่งของการวางซ้อนคือด้านล่างของโฆษณา Anchor

พารามิเตอร์
แท็ก Anchor	HTMLElement ค่าต้องไม่เท่ากับ Null

เลิกใช้

ใช้ `setAnchorElement` แทน

การคืนสินค้า

non-null Builder this

setAnchorElement

setAnchorElement(anchorElement) แสดงผล Builder

ต้องระบุ ต้องเป็น HTMLElement ที่ถูกต้องซึ่งมีโหนดย่อยได้ ตำแหน่งของข้อความซ้อนทับการค้นหา ระบบจะเพิ่มการวางซ้อนเป็นองค์ประกอบย่อยสุดท้ายในองค์ประกอบหลัก ตำแหน่งของการวางซ้อนคือด้านล่างของโฆษณา Anchor

พารามิเตอร์
anchorElement	HTMLElement ค่าต้องไม่เท่ากับ Null

การคืนสินค้า

non-null Builder this

setHints

setHints(hints) แสดงผล Builder

ไม่บังคับ คำแนะนำในช่องค้นหาเมื่อป้อนข้อมูลว่าง เมื่ออินพุตว่างเปล่า ระบบจะสุ่มเลือกคำแนะนำจากอาร์เรย์

พารามิเตอร์
คำแนะนำ	อาร์เรย์สตริง ค่าต้องไม่เท่ากับ Null

การคืนสินค้า

non-null Builder this

setInput

setInput(input) แสดงผล Builder

ต้องระบุ HTMLElement ที่ผู้ใช้ป้อนข้อความค้นหา ต้องเป็น <input> หรือ <textarea>

พารามิเตอร์
อินพุต	HTMLElement ค่าต้องไม่เท่ากับ Null

เลิกใช้

ใช้ `setInputElement` แทน

การคืนสินค้า

non-null Builder this

setInputElement

setInputElement(inputElement) แสดงผล Builder

ต้องระบุ HTMLElement ที่ผู้ใช้ป้อนข้อความค้นหา ต้องเป็น <input> หรือ <textarea>

พารามิเตอร์
inputElement	HTMLElement ค่าต้องไม่เท่ากับ Null

การคืนสินค้า

non-null Builder this

setResultsContainer

setResultsContainer(resultsContainer) แสดงผล Builder

ไม่บังคับ คอนเทนเนอร์สําหรับแสดงผลการค้นหา หากตั้งค่าไว้ ระบบจะแสดงผลลัพธ์ในคอนเทนเนอร์ผลการค้นหา หากไม่ได้ตั้งค่าไว้ ผลการค้นหาจะแสดงใน cloudsearch.google.com

พารามิเตอร์
resultsContainer	gapi.cloudsearch.widget.resultscontainer.ResultsContainer ค่าต้องไม่เท่ากับ Null

ดูเพิ่มเติม

ResultsContainer

การคืนสินค้า

non-null Builder this

setSearchApplicationId

setSearchApplicationId(searchApplicationId) แสดงผล Builder

ไม่บังคับ ตั้งค่ารหัสแอปพลิเคชันการค้นหาที่จะใช้สำหรับคำขอ ต้องขึ้นต้นด้วย "searchapplications/"

พารามิเตอร์
searchApplicationId	สตริง

การคืนสินค้า

non-null Builder this

setThrottleInterval

setThrottleInterval(throttleInterval) แสดงผล Builder

ไม่บังคับ ช่วงเวลาการจำกัดความเร็วในหน่วยมิลลิวินาทีเมื่อส่งคำขอ กล่องค้นหาจะส่งคําขอน้อยกว่า 1 รายการทุกๆ throttleInterval มิลลิวินาที หาก throttleInternal น้อยกว่า 200 ช่องค้นหาจะไม่สนใจค่าดังกล่าว และใช้ 200 เป็นช่วงเวลาแทน

พารามิเตอร์
throttleInterval	ตัวเลข

การคืนสินค้า

non-null Builder this