Map class

視覺效果和互動式 Web 地圖的控制項。

屬性

authentication
controls
events
imageSprite
isDisposed

如果已處置地圖,則傳回 true。

layers
markers
popups
sources

方法

areTilesLoaded()

傳回布林值,指出所有來源目前檢視區中的所有磚是否已載入。

clear()

從地圖中移除所有來源、圖層、標記和快顯視窗。 使用者新增的影像會保留下來。

disableElevation()

停用 3D 地形網格。

dispose()

清除地圖的資源。 呼叫此方法之後,Map 將無法正常運作。

enableElevation(string | ElevationTileSource, number)

根據「點陣-dem」來源載入 3D 地形網格。

getCamera()

傳回相機的目前屬性。

getCanvas()

傳回繪製地圖的 HTMLCanvasElement。

getCanvasContainer()

傳回包含地圖 HTMLCanvasElement 的 HTMLElement。 地圖的事件 (例如移動流覽和縮放) 附加至這個專案。

getMapContainer()

傳回包含地圖的 HTMLElement。

getServiceOptions()

傳回對應控制項初始化的服務選項。

getStyle()

傳回地圖控制項目前的樣式設定。

getTraffic()

傳回地圖控制項目前的流量設定。

getUserInteraction()

傳回地圖控制項目前的使用者互動處理常式設定。

pixelsToPositions(Pixel[])

將 Pixel 物件的陣列轉換成地圖上的地理 Positions 物件陣列。

positionsToPixels(Position[])

將 Positions 物件的陣列轉換為相對於地圖容器的 Pixel 物件陣列。

resize(any)

根據其容器元素的維度調整地圖大小。

resize(number | string, number | string, any)

調整地圖的容器元素大小,然後調整地圖本身的大小。

setCamera((CameraOptions | (CameraBoundsOptions & { bearing?: number, pitch?: number })) & AnimationOptions)

使用動畫轉換設定地圖控制項的相機。 未指定的任何選項都會預設為其目前的值。

setServiceOptions(ServiceOptions)

設定服務選項。

setStyle(StyleOptions, boolean)

設定地圖控制項的樣式選項。 未指定的任何選項都會預設為其目前的值。

setTraffic(TrafficOptions)

設定地圖的流量選項。 未指定的任何選項都會預設為其目前的值。

setUserInteraction(UserInteractionOptions)

設定地圖控制項的使用者互動處理常式。 未指定的任何選項都會預設為其目前的值。

stop()

停止目前正在進行的任何動畫轉換。

triggerRepaint()

觸發單一畫面格的轉譯。 當圖層的屬性或與圖層來源相關聯的屬性變更時,請使用此方法搭配 WebGL 圖層重新繪製地圖。 在轉譯下一個畫面格之前多次呼叫這個 ,仍會導致只轉譯單一畫面格。

建構函式詳細資料

Map(string | HTMLElement, ServiceOptions & StyleOptions & UserInteractionOptions & (CameraOptions | CameraBoundsOptions))

在指定的容器中顯示地圖。

new Map(container: string | HTMLElement, options: ServiceOptions & StyleOptions & UserInteractionOptions & (CameraOptions | CameraBoundsOptions))

參數

container

string | HTMLElement

應該顯示地圖之專案的識別碼。

options

ServiceOptions & StyleOptions & UserInteractionOptions & (CameraOptions | CameraBoundsOptions)

初始顯示與地圖互動的選項。

屬性詳細資料

authentication

authentication: AuthenticationManager

屬性值

controls

controls: ControlManager

屬性值

events

events: EventManager

屬性值

imageSprite

imageSprite: ImageSpriteManager

屬性值

isDisposed

如果已處置地圖,則傳回 true。

boolean isDisposed

屬性值

boolean

layers

layers: LayerManager

屬性值

markers

markers: HtmlMarkerManager

屬性值

popups

popups: PopupManager

屬性值

sources

sources: SourceManager

屬性值

方法詳細資料

areTilesLoaded()

傳回布林值,指出所有來源目前檢視區中的所有磚是否已載入。

function areTilesLoaded(): boolean

傳回

boolean

clear()

從地圖中移除所有來源、圖層、標記和快顯視窗。 使用者新增的影像會保留下來。

function clear()

disableElevation()

停用 3D 地形網格。

function disableElevation()

dispose()

清除地圖的資源。 呼叫此方法之後,Map 將無法正常運作。

function dispose()

enableElevation(string | ElevationTileSource, number)

根據「點陣-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()

傳回對應控制項初始化的服務選項。

function getServiceOptions(): ServiceOptions

傳回

getStyle()

傳回地圖控制項目前的樣式設定。

function getStyle(): StyleOptions

傳回

getTraffic()

傳回地圖控制項目前的流量設定。

function getTraffic(): TrafficOptions

傳回

getUserInteraction()

傳回地圖控制項目前的使用者互動處理常式設定。

function getUserInteraction(): UserInteractionOptions

傳回

pixelsToPositions(Pixel[])

將 Pixel 物件的陣列轉換成地圖上的地理 Positions 物件陣列。

function pixelsToPositions(pixels: Pixel[]): Position[]

參數

pixels

Pixel[]

要轉換的圖元。

傳回

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)

設定服務選項。

function setServiceOptions(options: ServiceOptions)

參數

options
ServiceOptions

setStyle(StyleOptions, boolean)

設定地圖控制項的樣式選項。 未指定的任何選項都會預設為其目前的值。

function setStyle(options?: StyleOptions, diff?: boolean)

參數

options
StyleOptions

設定地圖控制項樣式的選項。

diff

boolean

如果為 false,則會強制「完整」樣式更新,移除目前的樣式,並建置指定的樣式,而不是嘗試以差異為基礎的更新。 預設為 true。

setTraffic(TrafficOptions)

設定地圖的流量選項。 未指定的任何選項都會預設為其目前的值。

function setTraffic(options?: TrafficOptions)

參數

options
TrafficOptions

定義地圖流量顯示的選項。

setUserInteraction(UserInteractionOptions)

設定地圖控制項的使用者互動處理常式。 未指定的任何選項都會預設為其目前的值。

function setUserInteraction(options?: UserInteractionOptions)

參數

options
UserInteractionOptions

啟用/停用使用者互動處理常式的選項。

stop()

停止目前正在進行的任何動畫轉換。

function stop()

triggerRepaint()

觸發單一畫面格的轉譯。 當圖層的屬性或與圖層來源相關聯的屬性變更時,請使用此方法搭配 WebGL 圖層重新繪製地圖。 在轉譯下一個畫面格之前多次呼叫這個 ,仍會導致只轉譯單一畫面格。

function triggerRepaint()