gapi. cloudsearch. widget. searchbox. 빌더
검색창의 빌더입니다. 빌더를 사용하고 검색창 생성자를 직접 호출하지 마세요.
생성자
Builder
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)가 빌더를 반환함
필수사항: 이 어댑터를 사용하여 사용자의 검색 환경을 맞춤설정하세요.
매개변수 |
|
---|---|
어댑터 |
메서드의 일부를 재정의할 수 있습니다. 값은 null이 아니어야 합니다. |
- 반환 값
-
non-null Builder
합니다.
예
const adapter = {
interceptSuggestRequest: function(request) {
// Change the request
}
}
builder.setAdapter(adapter).build();
setAnchor
setAnchor(anchor)가 빌더를 반환함
필수사항: 하위 노드를 포함할 수 있는 유효한 HTMLElement여야 합니다. 검색 오버레이의 앵커입니다. 오버레이는 앵커의 마지막 하위 요소로 추가됩니다. 오버레이의 위치는 앵커의 하단입니다.
매개변수 |
|
---|---|
앵커 |
HTMLElement 값은 null이 아니어야 합니다. |
- 지원 중단됨
- 대신 `setAnchorElement` 사용
- 반환 값
-
non-null Builder
합니다.
setAnchorElement
setAnchorElement(anchorElement)가 빌더를 반환함
필수사항: 하위 노드를 포함할 수 있는 유효한 HTMLElement여야 합니다. 검색 오버레이의 앵커입니다. 오버레이는 앵커의 마지막 하위 요소로 추가됩니다. 오버레이의 위치는 앵커의 하단입니다.
매개변수 |
|
---|---|
anchorElement |
HTMLElement 값은 null이 아니어야 합니다. |
- 반환 값
-
non-null Builder
합니다.
setHints
setHints(hints)가 빌더를 반환
선택사항. 입력이 비어 있는 경우 검색창에 표시되는 힌트 입력이 비어 있으면 배열에서 임의의 힌트가 선택됩니다.
매개변수 |
|
---|---|
힌트 |
문자열 배열 값은 null이 아니어야 합니다. |
- 반환 값
-
non-null Builder
합니다.
setInput
setInput(input)이 빌더를 반환함
필수사항: 사용자가 쿼리를 입력하는 HTMLElement <input> 또는 <textarea>여야 합니다.
매개변수 |
|
---|---|
입력 |
HTMLElement 값은 null이 아니어야 합니다. |
- 지원 중단됨
- 대신 `setInputElement` 사용
- 반환 값
-
non-null Builder
합니다.
setInputElement
setInputElement(inputElement)가 빌더를 반환함
필수사항: 사용자가 쿼리를 입력하는 HTMLElement <input> 또는 <textarea>여야 합니다.
매개변수 |
|
---|---|
inputElement |
HTMLElement 값은 null이 아니어야 합니다. |
- 반환 값
-
non-null Builder
합니다.
setResultsContainer
setResultsContainer(resultsContainer) 빌더 반환
선택사항. 검색결과를 표시하는 컨테이너입니다. 설정된 경우 결과가 검색 결과 컨테이너에 렌더링됩니다. 설정하지 않으면 결과가 cloudsearch.google.com에 표시됩니다.
매개변수 |
|
---|---|
resultsContainer |
gapi.cloudsearch.widget.resultscontainer.ResultsContainer 값은 null이 아니어야 합니다. |
- 참고 항목
- ResultsContainer
- 반환 값
-
non-null Builder
합니다.
setSearchApplicationId
setSearchApplicationId(searchApplicationId) 가 빌더를 반환함
선택사항. 요청에 사용할 검색 애플리케이션 ID를 설정합니다. 'searchapplications/'를 접두어로 사용해야 합니다.
매개변수 |
|
---|---|
searchApplicationId |
string |
- 반환 값
-
non-null Builder
합니다.
setThrottleInterval
setThrottleInterval(throttleInterval)이 빌더로 반환됨
선택사항. 요청 실행 시 제한 간격(밀리초)입니다. 검색창은 throttleInterval 밀리초마다 1개 미만의 요청을 보냅니다. throttleInternal가 200보다 작으면 검색창이 값을 무시하고 200을 간격으로 사용합니다.
매개변수 |
|
---|---|
throttleInterval |
숫자 |
- 반환 값
-
non-null Builder
합니다.