Popup class

マップ上の指定した位置に固定された情報ウィンドウ。

Extends

コンストラクター

Popup(PopupOptions)

Popup オブジェクトを構築し、指定したオプションを使用して初期化します。

プロパティ

attach

非表示状態の HTML ドキュメントにポップアップを添付します。

close

マップ上のポップアップを閉じます。 ポップアップは HTML ドキュメントに添付されたままです。

isOpen

ポップアップが現在開いている場合は true、それ以外の場合は false を返します。

open

ポップアップを開きます。

remove

マップ上のポップアップを閉じ、HTML ドキュメントから削除します。

メソッド

getOptions()

ポップアップのオプションを返します。

getPopupContainer()

ポップアップ コンテナー要素を返します。

getPopupOptions()

ポップアップのオプションを返します。

setOptions(PopupOptions)

ポップアップのオプションを設定します。

setPopupOptions(PopupOptions)

ポップアップのオプションを設定します。

コンストラクターの詳細

Popup(PopupOptions)

Popup オブジェクトを構築し、指定したオプションを使用して初期化します。

new Popup(options?: PopupOptions)

パラメーター

options
PopupOptions

ポップアップのオプション。

プロパティの詳細

attach

非表示状態の HTML ドキュメントにポップアップを添付します。

attach: (map: Map) => void

プロパティ値

(map: Map) => void

close

マップ上のポップアップを閉じます。 ポップアップは HTML ドキュメントに添付されたままです。

close: () => void

プロパティ値

() => void

isOpen

ポップアップが現在開いている場合は true、それ以外の場合は false を返します。

isOpen: () => boolean

プロパティ値

() => boolean

open

ポップアップを開きます。

open: (map?: Map) => void

プロパティ値

(map?: Map) => void

remove

マップ上のポップアップを閉じ、HTML ドキュメントから削除します。

remove: () => void

プロパティ値

() => void

メソッドの詳細

getOptions()

ポップアップのオプションを返します。

function getOptions(): PopupOptions

戻り値

getPopupContainer()

ポップアップ コンテナー要素を返します。

function getPopupContainer(): HTMLElement

戻り値

HTMLElement

getPopupOptions()

警告

この API は非推奨になりました。

Use getOptions() instead.

ポップアップのオプションを返します。

function getPopupOptions(): PopupOptions

戻り値

setOptions(PopupOptions)

ポップアップのオプションを設定します。

function setOptions(options?: PopupOptions)

パラメーター

options
PopupOptions

ポップアップのオプション。

setPopupOptions(PopupOptions)

警告

この API は非推奨になりました。

Use setOptions(...) instead.

ポップアップのオプションを設定します。

function setPopupOptions(options?: PopupOptions)

パラメーター

options
PopupOptions

ポップアップのオプション。