Map class
ビジュアルおよび対話型 Web マップのコントロール。
コンストラクター
| Map(string | HTMLElement, Service |
指定したコンテナーにマップを表示します。 |
プロパティ
| authentication | |
| controls | |
| events | |
| image |
|
| is |
マップが破棄されている場合は true を返します。 |
| layers | |
| markers | |
| popups | |
| sources |
メソッド
| are |
すべてのソースの現在のビューポート内のすべてのタイルが読み込まれているかどうかを示すブール値を返します。 |
| clear() | マップからすべてのソース、レイヤー、マーカー、ポップアップを削除します。 ユーザーが追加したイメージは保持されます。 |
| disable |
3D 地形メッシュを無効にします。 |
| dispose() | マップのリソースをクリーンアップします。 このメソッドを呼び出した後、Map が正しく機能しません。 |
| enable |
"raster-dem" ソースに基づいて 3D 地形メッシュを読み込みます。 |
| get |
カメラの現在のプロパティを返します。 |
| get |
マップが描画される HTMLCanvasElement を返します。 |
| get |
マップの HTMLCanvasElement を含む HTMLElement を返します。 この要素には、マップのイベント (パンやズームなど) がアタッチされます。 |
| get |
マップを含む HTMLElement を返します。 |
| get |
マップ コントロールが初期化されたサービス オプションを返します。 |
| get |
マップ コントロールの現在のスタイル設定を返します。 |
| get |
マップ コントロールの現在のトラフィック設定を返します。 |
| get |
マップ コントロールの現在のユーザー操作ハンドラー設定を返します。 |
| pixels |
Pixel オブジェクトの配列を、マップ上の地理的な Positions オブジェクトの配列に変換します。 |
| positions |
Positions オブジェクトの配列を、マップ コンテナーを基準とした Pixel オブジェクトの配列に変換します。 |
| resize(any) | コンテナー要素のディメンションに従ってマップのサイズを変更します。 |
| resize(number | string, number | string, any) | マップのコンテナー要素のサイズを変更し、マップ自体のサイズを変更します。 |
| set |
アニメーション画面切り替えを使用して、マップ コントロールのカメラを設定します。 指定されていないオプションは、既定で現在の値になります。 |
| set |
サービス オプションを設定します。 |
| set |
マップ コントロールのスタイル オプションを設定します。 指定されていないオプションは、既定で現在の値になります。 |
| set |
マップのトラフィック オプションを設定します。 指定されていないオプションは、既定で現在の値になります。 |
| set |
マップ コントロールのユーザー操作ハンドラーを設定します。 指定されていないオプションは、既定で現在の値になります。 |
| stop() | 現在進行中のアニメーション切り替えを停止します。 |
| trigger |
1 つのフレームのレンダリングをトリガーします。 このメソッドを WebGL レイヤーと共に使用して、レイヤーのプロパティまたはレイヤーのソースに関連付けられているプロパティが変更されたときにマップを再描画します。 次のフレームがレンダリングされる前にこれを複数回呼び出しても、1 つのフレームのみがレンダリングされます。 |
コンストラクターの詳細
Map(string | HTMLElement, ServiceOptions & StyleOptions & UserInteractionOptions & (CameraOptions | CameraBoundsOptions))
指定したコンテナーにマップを表示します。
new Map(container: string | HTMLElement, options: ServiceOptions & StyleOptions & UserInteractionOptions & (CameraOptions | CameraBoundsOptions))パラメーター
- container
-
string | HTMLElement
マップを表示する要素の ID。
- options
-
ServiceOptions & StyleOptions & UserInteractionOptions & (CameraOptions | CameraBoundsOptions)
マップとの初期表示と対話性のオプション。
プロパティの詳細
authentication
controls
events
imageSprite
isDisposed
マップが破棄されている場合は true を返します。
boolean isDisposedプロパティ値
boolean
layers
markers
popups
sources
メソッドの詳細
areTilesLoaded()
すべてのソースの現在のビューポート内のすべてのタイルが読み込まれているかどうかを示すブール値を返します。
function areTilesLoaded(): boolean戻り値
boolean
clear()
マップからすべてのソース、レイヤー、マーカー、ポップアップを削除します。 ユーザーが追加したイメージは保持されます。
function clear()
disableElevation()
3D 地形メッシュを無効にします。
function disableElevation()dispose()
マップのリソースをクリーンアップします。 このメソッドを呼び出した後、Map が正しく機能しません。
function dispose()
enableElevation(string | ElevationTileSource, number)
"raster-dem" ソースに基づいて 3D 地形メッシュを読み込みます。
function enableElevation(elevationSource: string | ElevationTileSource, exaggeration?: number)パラメーター
- elevationSource
-
string | ElevationTileSource
昇格タイル ソース
- exaggeration
-
number
標高の誇張係数
getCamera()
カメラの現在のプロパティを返します。
function getCamera(): CameraOptions & CameraBoundsOptions戻り値
getCanvas()
マップが描画される HTMLCanvasElement を返します。
function getCanvas(): HTMLCanvasElement戻り値
HTMLCanvasElement
getCanvasContainer()
マップの HTMLCanvasElement を含む HTMLElement を返します。 この要素には、マップのイベント (パンやズームなど) がアタッチされます。
function getCanvasContainer(): HTMLElement戻り値
HTMLElement
getMapContainer()
マップを含む HTMLElement を返します。
function getMapContainer(): HTMLElement戻り値
HTMLElement
getServiceOptions()
getStyle()
getTraffic()
getUserInteraction()
マップ コントロールの現在のユーザー操作ハンドラー設定を返します。
function getUserInteraction(): UserInteractionOptions戻り値
pixelsToPositions(Pixel[])
Pixel オブジェクトの配列を、マップ上の地理的な Positions オブジェクトの配列に変換します。
function pixelsToPositions(pixels: Pixel[]): Position[]パラメーター
- pixels
-
Pixel[]
変換するピクセル。
戻り値
Position[]
positionsToPixels(Position[])
Positions オブジェクトの配列を、マップ コンテナーを基準とした Pixel オブジェクトの配列に変換します。
function positionsToPixels(positions: Position[]): Pixel[]パラメーター
- positions
-
Position[]
変換する位置。
戻り値
Pixel[]
resize(any)
コンテナー要素のディメンションに従ってマップのサイズを変更します。
function resize(eventData?: any)パラメーター
- eventData
-
any
このメソッドによってトリガーされるイベントのイベント オブジェクトに追加されるオプションの追加プロパティ。
resize(number | string, number | string, any)
マップのコンテナー要素のサイズを変更し、マップ自体のサイズを変更します。
function resize(height: number | string, width: number | string, eventData?: any)パラメーター
- height
-
number | string
マップとそのコンテナー要素の高さ。 数値入力はピクセル単位と見なされます。
- width
-
number | string
マップとそのコンテナー要素の幅。 数値入力はピクセル単位と見なされます。
- eventData
-
any
このメソッドによってトリガーされるイベントのイベント オブジェクトに追加されるオプションの追加プロパティ。
setCamera((CameraOptions | (CameraBoundsOptions & { bearing?: number, pitch?: number })) & AnimationOptions)
アニメーション画面切り替えを使用して、マップ コントロールのカメラを設定します。 指定されていないオプションは、既定で現在の値になります。
function setCamera(options?: (CameraOptions | (CameraBoundsOptions & { bearing?: number, pitch?: number })) & AnimationOptions)パラメーター
- options
-
(CameraOptions | (CameraBoundsOptions & { bearing?: number, pitch?: number })) & AnimationOptions
マップのカメラを設定したり、ビューの変更のアニメーションを設定したりするためのオプション。
setServiceOptions(ServiceOptions)
setStyle(StyleOptions, boolean)
マップ コントロールのスタイル オプションを設定します。 指定されていないオプションは、既定で現在の値になります。
function setStyle(options?: StyleOptions, diff?: boolean)パラメーター
- options
- StyleOptions
マップ コントロールのスタイルを設定するためのオプション。
- diff
-
boolean
false の場合は、'full' スタイルの更新を強制し、現在のスタイルを削除し、diffベースの更新を試行するのではなく、指定されたスタイルをビルドします。 既定値は true です。
setTraffic(TrafficOptions)
マップのトラフィック オプションを設定します。 指定されていないオプションは、既定で現在の値になります。
function setTraffic(options?: TrafficOptions)パラメーター
- options
- TrafficOptions
マップのトラフィック表示を定義するためのオプション。
setUserInteraction(UserInteractionOptions)
マップ コントロールのユーザー操作ハンドラーを設定します。 指定されていないオプションは、既定で現在の値になります。
function setUserInteraction(options?: UserInteractionOptions)パラメーター
- options
- UserInteractionOptions
ユーザー操作ハンドラーを有効または無効にするオプション。
stop()
現在進行中のアニメーション切り替えを停止します。
function stop()
triggerRepaint()
1 つのフレームのレンダリングをトリガーします。 このメソッドを WebGL レイヤーと共に使用して、レイヤーのプロパティまたはレイヤーのソースに関連付けられているプロパティが変更されたときにマップを再描画します。 次のフレームがレンダリングされる前にこれを複数回呼び出しても、1 つのフレームのみがレンダリングされます。
function triggerRepaint()