클래스: 빌더

생성자

빌더

새 빌더()

// 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)가 빌더를 반환함

Required. 이 어댑터로 사용자의 검색 환경을 맞춤설정합니다.

매개변수

어댑터

SearchBoxAdapter

메서드의 일부를 재정의할 수 있습니다.

값은 null일 수 없습니다.

반환

non-null Builder

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

builder.setAdapter(adapter).build();

set앵커

setanchor(anchor)는 Builder를 반환합니다.

Required. 하위 노드가 포함될 수 있는 유효한 HTMLElement여야 합니다. 검색 오버레이의 앵커입니다. 오버레이가 앵커의 마지막 하위 요소로 추가됩니다. 오버레이의 위치는 앵커의 하단입니다.

매개변수

앵커

HTMLElement

값은 null일 수 없습니다.

지원 중단됨
대신 `setanchorElement` 를 사용합니다.
반환

non-null Builder

set앵커 요소

setanchorElement(anchorElement)는 빌더를 반환합니다.

Required. 하위 노드가 포함될 수 있는 유효한 HTMLElement여야 합니다. 검색 오버레이의 앵커입니다. 오버레이가 앵커의 마지막 하위 요소로 추가됩니다. 오버레이의 위치는 앵커의 하단입니다.

매개변수

anchorElement

HTMLElement

값은 null일 수 없습니다.

반환

non-null Builder

setHints

setHints(hints)는 빌더를 반환함

Optional. 입력 내용이 비어 있을 때 검색창에 표시되는 힌트입니다. 입력이 비어 있으면 배열에서 임의의 힌트가 선택됩니다.

매개변수

힌트

문자열 배열

값은 null일 수 없습니다.

반환

non-null Builder

setInput

setInput(input)이 빌더를 반환함

Required. 사용자가 쿼리를 입력하는 HTMLElement입니다. <input> 또는 <textarea>여야 합니다.

매개변수

입력

HTMLElement

값은 null일 수 없습니다.

지원 중단됨
대신 `setInputElement` 사용
반환

non-null Builder

setInputElement

setInputElement(inputElement)는 빌더를 반환합니다.

Required. 사용자가 쿼리를 입력하는 HTMLElement입니다. <input> 또는 <textarea>여야 합니다.

매개변수

입력 요소

HTMLElement

값은 null일 수 없습니다.

반환

non-null Builder

setResultsContainer

setResultsContainer(resultsContainer)가 빌더를 반환함

Optional. 검색결과를 표시하기 위한 컨테이너 설정하면 결과가 검색결과 컨테이너에 렌더링됩니다. 설정하지 않으면 결과가 cloudsearch.google.com에 표시됩니다.

매개변수

resultsContainer

gapi.cloudsearch.widget.resultscontainer.ResultsContainer

값은 null일 수 없습니다.

참고 항목
ResultsContainer
반환

non-null Builder

setSearchApplicationId

setSearchApplicationId(searchApplicationId)가 빌더를 반환함

Optional. 요청에 사용할 검색 애플리케이션 ID를 설정합니다. 접두사는 'searchapplications/'로 시작해야 합니다.

매개변수

searchApplicationId

문자열

반환

non-null Builder

setThrottleInterval

setThrottleInterval(throttleInterval)은 빌더를 반환합니다.

Optional. 요청 실행 시 제한 간격(밀리초)입니다. 검색창에서는 throttleInterval 밀리초마다 1개 미만의 요청이 전송됩니다. throttleInternal가 200보다 작으면 검색창은 이 값을 무시하고 대신 200을 구간으로 사용합니다.

매개변수

스로틀 간격

숫자

반환

non-null Builder