Autocomplete クラス
google.maps.places.Autocomplete
クラス
ユーザーのテキスト入力に基づいて場所の予測を提供するウィジェット。text
型の入力要素にアタッチされ、そのフィールドのテキスト入力をリッスンします。予測のリストはプルダウン リストとして表示され、テキストを入力すると更新されます。
このクラスは MVCObject
を拡張します。
&libraries=places
URL パラメータを使用して読み込みます。詳しくは、Maps JavaScript API のライブラリをご覧ください。
v=beta
を使用している場合は、const {Autocomplete} = await google.map.importLibrary("places")
を呼び出してアクセスできます。詳しくは、Maps JavaScript API のライブラリをご覧ください。
コンストラクタ | |
---|---|
Autocomplete |
Autocomplete(inputField[, opts]) パラメータ:
指定されたオプションを使用して、指定された入力テキスト フィールドにアタッチする Autocomplete の新しいインスタンスを作成します。 |
Methods | |
---|---|
getBounds |
getBounds() パラメータ: なし
戻り値:
LatLngBounds|undefined バイアス境界。予測にバイアスをかけた境界を返します。 |
getFields |
getFields() パラメータ: なし
戻り値:
Array<string>|undefined 詳細の取得が成功した場合に、詳細レスポンスに含まれる場所のフィールドを返します。フィールドの一覧については、 PlaceResult をご覧ください。 |
getPlace |
getPlace() パラメータ: なし
戻り値:
PlaceResult ユーザーが選択した場所。ユーザーが選択した Place Details を取得する(詳細を取得できた場合)。それ以外の場合は、 name プロパティが入力フィールドの現在の値に設定されたスタブの Place オブジェクトを返します。 |
setBounds |
setBounds(bounds) パラメータ:
戻り値: None
Place の結果を返す優先領域を設定します。この地域が優先されますが、これに限定されません。 |
setComponentRestrictions |
setComponentRestrictions(restrictions) パラメータ:
戻り値: None
コンポーネントの制限を設定します。コンポーネントの制限は、予測を親コンポーネント内のもののみに制限するために使用されます。国などを入力します。 |
setFields |
setFields(fields) パラメータ:
戻り値: None
詳細の取得が成功した場合に、詳細レスポンスに含まれる場所のフィールドを設定します。フィールドの一覧については、 PlaceResult をご覧ください。 |
setOptions |
setOptions(options) パラメータ:
戻り値: None
|
setTypes |
setTypes(types) パラメータ:
戻り値: None
返される予測のタイプを設定します。サポートされているタイプについては、デベロッパー ガイドをご覧ください。型を指定しない場合、すべての型が返されます。 |
継承:
addListener 、
bindTo 、
get 、
notify 、
set 、
setValues 、
unbind 、
unbindAll
|
イベント | |
---|---|
place_changed |
function() 引数: なし
ユーザーが選択したプレイスが PlaceResult で利用可能になると、このイベントは発生します。PlaceResult |
AutocompleteOptions インターフェース
google.maps.places.AutocompleteOptions
インターフェース
Autocomplete
オブジェクトに設定できるオプション。
&libraries=places
URL パラメータを使用して読み込みます。詳しくは、Maps JavaScript API のライブラリをご覧ください。
プロパティ | |
---|---|
bounds optional |
タイプ:
LatLngBounds|LatLngBoundsLiteral optional 場所を検索するエリアです。 |
componentRestrictions optional |
タイプ:
ComponentRestrictions optional コンポーネントの制限。コンポーネントの制限は、予測を親コンポーネント内のもののみに制限するために使用されます。国などを入力します。 |
fields optional |
タイプ:
Array<string> optional 詳細情報の取得が成功した場合に詳細レスポンスに含まれるプレイスのフィールド。課金対象。 ['ALL'] が渡されると、使用可能なすべてのフィールドが返され、課金されます(本番環境のデプロイでは推奨されません)。フィールドの一覧については、PlaceResult をご覧ください。ネストされたフィールドはドットパスで指定できます(例: "geometry.location" )。デフォルトは ['ALL'] です。 |
|
タイプ:
boolean optional プレイス ID のみを取得するかどうかを指定します。place_changed イベントが発生したときに利用できる PlaceResult は、place_id、type、name フィールドのみです。place_id、type、description は Autocomplete サービスによって返されます。デフォルトでは無効にされています。 |
strictBounds optional |
タイプ:
boolean optional クエリの送信時に、オートコンプリート ウィジェットがオートコンプリート ウィジェットの境界内にある場所のみを返すことを示すブール値。strictBounds を false (デフォルト)に設定すると、境界内にある場所が優先されますが、これに限定されません。 |
types optional |
タイプ:
Array<string> optional 返される予測のタイプ。サポートされているタイプについては、デベロッパー ガイドをご覧ください。型を指定しない場合、すべての型が返されます。 |
SearchBox クラス
google.maps.places.SearchBox
クラス
ユーザーのテキスト入力に基づいてクエリの予測を行うウィジェット。text
型の入力要素にアタッチされ、そのフィールドのテキスト入力をリッスンします。予測のリストはプルダウン リストとして表示され、テキストを入力すると更新されます。
このクラスは MVCObject
を拡張します。
&libraries=places
URL パラメータを使用して読み込みます。詳しくは、Maps JavaScript API のライブラリをご覧ください。
v=beta
を使用している場合は、const {SearchBox} = await google.map.importLibrary("places")
を呼び出してアクセスできます。詳しくは、Maps JavaScript API のライブラリをご覧ください。
コンストラクタ | |
---|---|
SearchBox |
SearchBox(inputField[, opts]) パラメータ:
指定されたオプションを使用して、指定された入力テキスト フィールドにアタッチする SearchBox の新しいインスタンスを作成します。 |
Methods | |
---|---|
getBounds |
getBounds() パラメータ: なし
戻り値:
LatLngBounds|undefined クエリ予測にバイアスをかけた境界を返します。 |
getPlaces |
getPlaces() パラメータ: なし
戻り値:
Array<PlaceResult>|undefined places_changed イベントで使用するために、ユーザーが選択したクエリを返します。 |
setBounds |
setBounds(bounds) パラメータ:
戻り値: None
クエリ予測のバイアスに使用するリージョンを設定します。検索結果は、この地域を優先して表示しています。ただし、その場所に限定されるわけではありません。 |
継承:
addListener 、
bindTo 、
get 、
notify 、
set 、
setValues 、
unbind 、
unbindAll
|
イベント | |
---|---|
places_changed |
function() 引数: なし
このイベントは、ユーザーがクエリを選択すると発生します。 getPlaces を使用して新しい場所を取得する必要があります。 |
SearchBoxOptions インターフェース
google.maps.places.SearchBoxOptions
インターフェース
SearchBox
オブジェクトに設定できるオプション。
&libraries=places
URL パラメータを使用して読み込みます。詳しくは、Maps JavaScript API のライブラリをご覧ください。
プロパティ | |
---|---|
bounds optional |
タイプ:
LatLngBounds|LatLngBoundsLiteral optional クエリ予測にバイアスをかける領域。予測は、これらの境界をターゲットとするクエリにバイアスがかかっていますが、これらに限定されません。 |