Places Widgets

PlaceAutocompleteElement クラス

google.maps.places.PlaceAutocompleteElement クラス

  • PlaceAutocompleteElement は、Places Autocomplete API の UI コンポーネントを提供する HTMLElement サブクラスです。places ライブラリを読み込んだ後、オートコンプリート機能を持つ入力を HTML で作成できます。例: 
    <gmp-placeautocomplete ></gmp-placeautocomplete>

カスタム要素:
<gmp-placeautocomplete name="string" requested-language="string" requested-region="string" types="type1 type2 type3..."></gmp-placeautocomplete>

このクラスは HTMLElement を拡張します。

このクラスは PlaceAutocompleteElementOptions を実装します。

const {PlaceAutocompleteElement} = await google.maps.importLibrary("places") を呼び出してアクセスします。Maps JavaScript API のライブラリをご覧ください。
PlaceAutocompleteElement
PlaceAutocompleteElement(options)
パラメータ: 
componentRestrictions
タイプ:  ComponentRestrictions optional
コンポーネントの制限。コンポーネント制限は、予測を親コンポーネント内の予測のみに制限するために使用されます。（国など）。
locationBias
タイプ:  LocationBias optional
場所を検索するときに使用するソフト境界またはヒント。
locationRestriction
タイプ:  LocationRestriction optional
検索結果を制限する境界。
name
タイプ:  string optional
入力要素に使用する名前。詳しくは、https://developer.mozilla.org/en-US/docs/Web/HTML/Element/input#name をご覧ください。入力の name 属性と同じ動作に従います。これはフォームの送信時に使用される名前です。詳しくは、https://developer.mozilla.org/en-US/docs/Web/HTML/Element/form をご覧ください。
HTML 属性:
  • <gmp-placeautocomplete name="string"></gmp-placeautocomplete>
requestedLanguage
タイプ:  string optional
結果を返す言語の言語識別子（可能な場合）。選択した言語での検索結果は、より上位に表示される場合がありますが、候補はこの言語に限定されません。サポートされている言語の一覧をご覧ください。
HTML 属性:
  • <gmp-placeautocomplete requested-language="string"></gmp-placeautocomplete>
requestedRegion
タイプ:  string optional
結果の書式設定と結果のフィルタリングに使用される地域コード。候補をこの国に限定するものではありません。地域コードは ccTLD（「トップレベル ドメイン」）の 2 文字の値で指定します。ほとんどの ccTLD コードは ISO 3166-1 コードと同じですが、いくつか注意が必要な例外もあります。たとえば、英国の ccTLD は「uk」（.co.uk）ですが、ISO 3166-1 コードは「gb」（厳密には「グレート ブリテンおよび北アイルランド連合王国」のエンティティです）です。
HTML 属性:
  • <gmp-placeautocomplete requested-region="string"></gmp-placeautocomplete>
types
タイプ:  Array<string> optional
返される予測のタイプ。サポートされているタイプについては、 デベロッパー ガイドをご覧ください。タイプが指定されていない場合は、すべてのタイプが返されます。
HTML 属性:
  • <gmp-placeautocomplete types="type1 type2 type3..."></gmp-placeautocomplete>
prediction-item
予測のプルダウン内の項目で、単一の予測を表します。
prediction-item-icon
予測リスト内の各項目の左に表示されるアイコン。
prediction-item-main-text
予測のメインテキストである予測アイテムの一部。地理的位置の場合、ここには、「札幌」のような地名や「北十条 4 丁目」のような所番地が含まれます。デフォルトでは、予測アイテムのメインテキストの色は黒です。予測アイテムに追加のテキストがある場合、そのテキストは予測アイテムのメインテキストの範囲外にあり、予測アイテムからそのスタイルを継承します。デフォルトでは色はグレーになります。この追加のテキストは通常、住所です。
prediction-item-match
返される予測のうち、ユーザーの入力に一致する部分。デフォルトでは、この一致するテキストは太字でハイライト表示されます。一致するテキストは、prediction-item 内の任意の場所に存在します。予測アイテムのメインテキストに含まれるとは限りません。
prediction-item-selected
ユーザーがキーボードから移動したときの項目。注: 選択したアイテムは、このパーツスタイルと予測アイテムのパーツスタイルの両方の影響を受けます。
prediction-list
プレイスの Autocomplete サービスが返す予測のリストを含む視覚要素。このリストは、PlaceAutocompleteElement の下にプルダウン リストとして表示されます。
BetaaddEventListener
addEventListener(type, listener[, options])
パラメータ: 
  • type:  string リッスンするイベントタイプを表す文字列（大文字と小文字を区別）。
  • listener:  EventListener|EventListenerObject 通知を受け取るオブジェクト。これは、handleEvent メソッドを持つ関数またはオブジェクトである必要があります
  • options:  boolean|AddEventListenerOptions optional オプションをご覧ください。カスタム イベントでは、capture と passive のみがサポートされます。
戻り値:  void
指定されたイベントがターゲットに配信されるたびに呼び出される関数を設定します。addEventListener をご覧ください。
BetaremoveEventListener
removeEventListener(type, listener[, options])
パラメータ: 
戻り値:  void
以前に addEventListener で登録されたイベント リスナーをターゲットから削除します。removeEventListener をご覧ください。

PlaceAutocompleteElementOptions インターフェース

google.maps.places.PlaceAutocompleteElementOptions インターフェース

PlaceAutocompleteElement を作成するためのオプション。
componentRestrictions optional
タイプ:  ComponentRestrictions optional
PlaceAutocompleteElement.componentRestrictionsを見る
locationBias optional
タイプ:  LocationBias optional
PlaceAutocompleteElement.locationBiasを見る
locationRestriction optional
タイプ:  LocationRestriction optional
PlaceAutocompleteElement.locationRestrictionを見る
requestedLanguage optional
タイプ:  string optional
PlaceAutocompleteElement.requestedLanguageを見る
requestedRegion optional
タイプ:  string optional
PlaceAutocompleteElement.requestedRegionを見る
types optional
タイプ:  Array<string> optional
PlaceAutocompleteElement.typesを見る

PlaceAutocompletePlaceSelectEvent クラス

google.maps.places.PlaceAutocompletePlaceSelectEvent クラス

このイベントは、ユーザーが Place Autocomplete 要素で場所を選択した後に作成されます。選択内容には event.place でアクセスできます。

このクラスは Event を拡張します。

const {PlaceAutocompletePlaceSelectEvent} = await google.maps.importLibrary("places") を呼び出してアクセスします。Maps JavaScript API のライブラリをご覧ください。
Betaplace
タイプ:  Place

PlaceAutocompleteRequestErrorEvent クラス

google.maps.places.PlaceAutocompleteRequestErrorEvent クラス

このイベントは、ネットワーク リクエストに問題があるときに、PlaceAutocompleteElement によって生成されます。

このクラスは Event を拡張します。

const {PlaceAutocompleteRequestErrorEvent} = await google.maps.importLibrary("places") を呼び出してアクセスします。Maps JavaScript API のライブラリをご覧ください。

Autocomplete クラス

google.maps.places.Autocomplete クラス

ユーザーのテキスト入力に基づいてプレイスの予測を提供するウィジェット。これは text 型の入力要素にアタッチされ、そのフィールドへのテキスト入力をリッスンします。予測のリストはプルダウン リストとして表示され、テキストを入力すると更新されます。

このクラスは MVCObject を拡張します。

const {Autocomplete} = await google.maps.importLibrary("places") を呼び出してアクセスします。Maps JavaScript API のライブラリをご覧ください。
Autocomplete
Autocomplete(inputField[, opts])
パラメータ: 
指定されたオプションを使用して、指定された入力テキスト フィールドにアタッチされる Autocomplete の新しいインスタンスを作成します。
getBounds
getBounds()
パラメータ: なし
戻り値:  LatLngBounds|undefined バイアスの境界。
予測にバイアスがかかる境界を返します。
getFields
getFields()
パラメータ: なし
戻り値:  Array<string>|undefined
詳細が正常に取得されたときに、詳細レスポンスのプレイスに含めるフィールドを返します。フィールドの一覧については、PlaceResult をご覧ください。
getPlace
getPlace()
パラメータ: なし
戻り値:  PlaceResult ユーザーが選択した場所。
詳細が正常に取得された場合、ユーザーが選択したプレイスの詳細を返します。それ以外の場合は、name プロパティが入力フィールドの現在の値に設定されたスタブ Place オブジェクトを返します。
setBounds
setBounds(bounds)
パラメータ: 
戻り値: なし
プレイス結果を返す優先エリアを設定します。検索結果には、この地域が優先して表示されますが、これに限定されるものではありません。
setComponentRestrictions
setComponentRestrictions(restrictions)
パラメータ: 
戻り値: なし
コンポーネントの制限を設定します。コンポーネント制限は、予測を親コンポーネント内の予測のみに制限するために使用されます。（国など）。
setFields
setFields(fields)
パラメータ: 
  • fields:  Array<string> optional
戻り値: なし
詳細が正常に取得されたときに、プレイスの詳細レスポンスに含めるフィールドを設定します。フィールドの一覧については、PlaceResult をご覧ください。
setOptions
setOptions(options)
パラメータ: 
戻り値: なし
setTypes
setTypes(types)
パラメータ: 
  • types:  Array<string> optional 含める予測のタイプ。
戻り値: なし
返される予測のタイプを設定します。サポートされているタイプについては、 デベロッパー ガイドをご覧ください。タイプが指定されていない場合は、すべてのタイプが返されます。
継承: addListener、 bindTo、 get、 notify、 set、 setValues、 unbind、 unbindAll
place_changed
function()
引数: なし
このイベントは、ユーザーが選択した場所に対して PlaceResult が使用可能になると発生します。
ユーザーが、コントロールが提案していない場所の名前を入力して Enter キーを押した場合、または Place Details リクエストが失敗した場合、PlaceResult の name プロパティにユーザー入力が含まれますが、他のプロパティは定義されません。

AutocompleteOptions インターフェース

google.maps.places.AutocompleteOptions インターフェース

Autocomplete オブジェクトで設定できるオプション。
bounds optional
タイプ:  LatLngBounds|LatLngBoundsLiteral optional
場所を検索する領域。
componentRestrictions optional
タイプ:  ComponentRestrictions optional
コンポーネントの制限。コンポーネント制限は、予測を親コンポーネント内の予測のみに制限するために使用されます。（国など）。
fields optional
タイプ:  Array<string> optional
詳細が正常に取得されたときに、プレイスの詳細レスポンスに含まれるフィールド。課金対象です。['ALL'] が渡されると、使用可能なすべてのフィールドが返されて課金されます（これは本番環境のデプロイでは推奨されません）。フィールドの一覧については、PlaceResult をご覧ください。ネストされたフィールドはドットパスで指定できます（例: "geometry.location"）。デフォルトは ['ALL'] です。
placeIdOnly optional
タイプ:  boolean optional
プレイス ID のみを取得するかどうかを指定します。place_changed イベントの発生時に利用可能になる PlaceResult には、オートコンプリート サービスによって返される place_id、types、description を含む place_id、types、name フィールドのみが含まれます。デフォルトでは無効にされています。
strictBounds optional
タイプ:  boolean optional
クエリが送信された時点で Autocomplete ウィジェットの境界内にあるプレイスのみ Autocomplete ウィジェットが返すことを示すブール値です。strictBounds を false（デフォルト）に設定すると、境界内に含まれる場所が優先されますが、これに限定されません。
types optional
タイプ:  Array<string> optional
返される予測のタイプ。サポートされているタイプについては、 デベロッパー ガイドをご覧ください。タイプが指定されていない場合は、すべてのタイプが返されます。

google.maps.places.SearchBox クラス

ユーザーのテキスト入力に基づいてクエリの予測を行うウィジェット。これは text 型の入力要素にアタッチされ、そのフィールドへのテキスト入力をリッスンします。予測のリストはプルダウン リストとして表示され、テキストを入力すると更新されます。

このクラスは MVCObject を拡張します。

const {SearchBox} = await google.maps.importLibrary("places") を呼び出してアクセスします。Maps JavaScript API のライブラリをご覧ください。
SearchBox
SearchBox(inputField[, opts])
パラメータ: 
指定されたオプションを使用して、指定された入力テキスト フィールドにアタッチされる SearchBox の新しいインスタンスを作成します。
getBounds
getBounds()
パラメータ: なし
戻り値:  LatLngBounds|undefined
クエリ予測にバイアスがかかっている範囲を返します。
getPlaces
getPlaces()
パラメータ: なし
戻り値:  Array<PlaceResult>|undefined
places_changed イベントで使用するために、ユーザーが選択したクエリを返します。
setBounds
setBounds(bounds)
パラメータ: 
戻り値: なし
クエリ予測のバイアスに使用する地域を設定します。結果はこの範囲のみに偏り、完全に制限されることはありません。
継承: addListener、 bindTo、 get、 notify、 set、 setValues、 unbind、 unbindAll
places_changed
function()
引数: なし
このイベントは、ユーザーがクエリを選択すると発生します。新しい場所を取得するには、getPlaces を使用する必要があります。

SearchBoxOptions インターフェース

google.maps.places.SearchBoxOptions インターフェース

SearchBox オブジェクトで設定できるオプション。
bounds optional
タイプ:  LatLngBounds|LatLngBoundsLiteral optional
クエリ予測にバイアスをかける領域。予測では、この境界をターゲットとするクエリに対してバイアスがかかりますが、それに限定されません。