atlas module

套件:

azure-maps-control

類別

EventManager	地圖控件事件的管理員。 透過atlas的事件屬性公開。Map 類別。 用戶無法具現化。
HtmlMarker	這個類別會包裝可在地圖上顯示的 HTML 專案。
Map	視覺效果和互動式 Web 地圖的控制件。
Pixel	表示圖元座標或位移。 擴充 [x， y] 的陣列。
Popup	錨定在地圖上指定位置的信息視窗。
PopupTemplate	彈出視窗的版面配置範本。
Shape	包裝 Geometry 或 Feature 的協助程式類別，可讓您輕鬆地更新和維護。

介面

AggregateExpression	匯總表達式會定義在一組數據上處理的計算。 架構：[operator： string， initialValue？： boolean | number， mapExpression： Expression] 運算符：然後針對叢集中每個點所計算之 mapExpression 計算的所有值套用的表達式函式。 支援的運算符：o for numbers： +、 *、 max、 min o For Booleans： all、 any initialValue： Optional， 這是匯總第一個計算值的初始值。 mapExpression：針對數據集中每個點套用的表達式。
AnimationOptions	地圖控件相機變更動畫的選項。
AuthenticationManager	對應控件驗證的管理員。 透過atlas的驗證屬性公開。Map 類別。 用戶無法具現化。
AuthenticationOptions	指定地圖控件應如何向 Azure 地圖服務進行驗證的選項。
BubbleLayerOptions	在 BubbleLayer 中轉譯 Point 物件時所使用的選項。
CameraBoundsOptions	設定地圖控件相機界限的選項。
CameraOptions	設定地圖控件相機的選項。
ClusteredProperties	ClusteredProperties 將存在的屬性
CompassControlOptions	CompassControl 物件的選項。
Control	用於定義地圖控件的介面。
ControlManager	地圖控件控制件的管理員。 透過atlas的controls屬性公開。Map 類別。 用戶無法具現化。
ControlOptions	將控件新增至地圖的選項。
DataSourceOptions	用於管理地圖上顯示之圖形數據的數據源。 數據源必須先新增至圖層，才能在地圖上顯示數據源。 DataSourceOptions的選項。
ElevationTileSourceOptions
FullscreenControlOptions	FullscreenControl 物件的選項。
HeatMapLayerOptions	在 HeatMapLayer 中轉譯 Point 物件時所使用的選項。
HtmlMarkerEvents
HtmlMarkerManager	地圖控件 HTML 標記的管理員。 透過atlas的 markers 屬性公開。Map 類別。 用戶無法具現化。
HtmlMarkerOptions	轉譯 HtmlMarker 物件的選項
HyperLinkFormatOptions	超連結字串的格式選項。
IconOptions	用來自定義 SymbolLayer 中圖標的選項
ImageLayerOptions	在 ImageLayer 中轉譯 Point 物件時所使用的選項。
ImageSpriteManager	地圖控件影像 Sprite 的管理員。 透過 atlas 的 imageSprite 屬性公開。Map 類別。 用戶無法具現化。
LayerManager	地圖控件圖層的管理員。 透過atlas的 layers 屬性公開。Map 類別。 用戶無法具現化。
LayerOptions	所有其他圖層選項繼承自的基類。
LightOptions	地圖光源的選項。
LineLayerOptions	在線條圖層中轉譯 SimpleLine、SimplePolygon、CirclePolygon、LineString、MultiLineString、Polygon 和 MultiPolygon 物件時所使用的選項。
MapConfiguration	代表地圖組態的內容，其中包含可供其使用的樣式清單。
MapConfigurationStyle	表示單一樣式的資訊。
MapDataEvent	當數據事件發生時，地圖所傳回的事件物件。
MapErrorEvent	發生錯誤事件時，對應所傳回的事件物件。
MapEvent	發生基本事件時，對應所傳回的事件物件。
MapMouseEvent	發生滑鼠事件時，地圖所傳回的事件物件。
MapMouseWheelEvent	當滾輪事件發生時，地圖所傳回的事件物件。
MapTouchEvent	發生觸控事件時，地圖所傳回的事件物件。
MediaLayerOptions	轉譯畫布、影像、點陣磚和視訊圖層時所使用的選項
Options
Padding	表示設定地圖相機時，要加入 BoundingBox 側邊的圖元填補量。
PitchControlOptions	PitchControl 物件的選項。
PolygonExtrusionLayerOptions	在 PolygonExtrusionLayer中轉譯 Polygon 和 MultiPolygon 物件時所使用的選項。
PolygonLayerOptions	在 PolygonLayer 中轉譯 Polygon 和 MultiPolygon 物件時所使用的選項。
PopupEvents
PopupManager	地圖控件彈出視窗的管理員。 透過 atlas.Map 類別的 popups 屬性公開。 用戶無法具現化。
PopupOptions	快顯的選項。
Properties	一組可與 PopupTemplate 搭配使用的屬性
PropertyInfo	如何顯示屬性的物種詳細數據。
RasterTileSourceOptions
RequestParameters	這是 transformRequest 回呼所預期傳回的物件類型。
ScaleControlOptions	ScaleControl 物件的選項。
ServiceOptions	所有 atlas 服務要求中使用的全域屬性。
ShapeEvents
SourceManager	地圖控件來源的管理員。 透過atlas的sources屬性公開。Map 類別。 用戶無法具現化。
StyleChangedEvent	載入新樣式之後，地圖所傳回的事件物件。
StyleControlOptions	StyleControl 物件的選項。
StyleOptions	地圖樣式的選項。
SymbolLayerOptions	在 SymbolLayer 中轉譯幾何時所使用的選項。
TargetedEvent
TextOptions	用來自定義 SymbolLayer 中文字的選項
Tile	發生源數據事件時，地圖所傳回的Tile物件。
TileId
TileLayerOptions	在 TileLayer 中轉譯點陣並排影像時所使用的選項。
TrafficControlOptions
TrafficOptions	在地圖上設定流量的選項。
UserInteractionOptions	啟用/停用使用者與地圖互動的選項。
VectorTileSourceOptions	用於管理地圖上顯示之圖形數據的數據源。 數據源必須先新增至圖層，才能在地圖上顯示數據源。 VectorTileSource的選項。
WebGLLayerOptions	用來在 WebGLLayer 中呈現圖形的選項。
WebGLRenderer	在 WebGLLayer 中轉譯 WebGL 圖形的介面。
ZoomControlOptions	ZoomControl 物件的選項。

類型別名

Expression	可以指定為篩選值或特定圖層選項。 表達式會定義計算 屬性值的公式。 表達式會表示為 JSON 陣列。 表達式的第一個專案是命名表達式運算元的字串。
getAuthTokenCallback	用來在匿名驗證模式中取得驗證令牌的回調函式。 使用驗證令牌解決，或拒絕任何錯誤。
ResourceType
StyleImageMetadata	傳遞至 ImageSpriteManager.add之 options 參數的簽章。

列舉

AuthenticationType	列舉，用來指定要使用的驗證機制類型。
ControlPosition	控制件可以放置在地圖上的位置。
ControlStyle	控制件的可用樣式。

函式

addImageTemplate(string, string, boolean)	將影像範本新增至 atlas 命名空間。
addProtocol(string, (args: any[]) => Promise<any>)	新增使用以自定義 URL 架構開頭的 URL 時所呼叫的自定義載入資源函式。
clearPrewarmedResources()	清除先前由 atlas.prewarm()建立的資源。 請注意，這通常並非必要。 如果您預期應用程式的任何時間點都不會返回地圖檢視檢視，您應該只呼叫此函式。
getAllImageTemplateNames()	擷取 atlas 命名空間中所有可用影像範本的名稱陣列。
getAuthenticationOptions()	取得提供的預設驗證選項。 如果先前未設定所有屬性，則不會定義。
getDomain()	取得提供的預設網域。 如果先前未設定預設值，則為 "atlas.microsoft.com"。
getImageTemplate(string, number)	依名稱擷取SVG範本。
getLanguage()	取得提供的預設語言。 如果先前未設定預設值，則為 "NGT"。
getMaxParallelImageRequests()	取得平行載入的影像數目上限（點陣磚、Sprite、圖示）
getSessionId()	取得提供的預設會話標識碼。 如果先前未設定預設值，則為隨機 UUID。
getSubscriptionKey()	取得提供的預設 Azure 地圖服務訂用帳戶密鑰。
getUserRegion()
getVersion()	以組建編號為基礎的目前 API 版本號碼。
getView()	取得地圖控件的預設檢視設定。 如果先前未設定預設值，則為 undefined。
getWorkerCount()	取得將建立的背景工作角色計數。
isSupported(boolean)	檢查地圖控件是否支援使用者的瀏覽器。
prewarm()	初始化 WebWorkers 等資源，這些資源在某些情況下可以跨對應共用，以降低負載時間。 atlas.setWorkerCount，如果使用，必須先設定 prewarm() 才能產生效果。 根據預設，這些資源的生命週期會自動管理，而且會在第一次建立地圖時延遲初始化。 藉由叫用 prewarm()，這些資源將會事先建立，而且不會在頁面移除最後一個地圖時清除。 這可讓稍後建立的新對應實例重複使用它們。 藉由呼叫 atlas.clearPrewarmedResources()，即可手動清除它們。 只有當網頁保持作用中，但完全停止使用地圖時，才需要這樣做。 這在單一頁面應用程式中使用 GL-JS 地圖時，主要很有用，其中使用者會在各種檢視之間巡覽，而這種檢視可能會導致 Map 實例不斷建立和終結。
removeProtocol(string)	拿掉先前在主線程中新增的通訊協定。
setAuthenticationOptions(AuthenticationOptions)	將您的驗證選項設定為地圖控件所使用的 atlas 命名空間中的預設選項，以及向 Azure 地圖服務提出要求的任何模組。 如果 Map 是以明確定義的驗證選項初始化，且 setAuthenticationOptions 先前尚未呼叫，則 Map 建構函式會自動呼叫它。
setDomain(string)	設定對應和服務模組所使用的預設網域，除非在使用 API 的那些部分時明確指定網域。 如果 Map 是以明確定義的網域初始化，且 setDomain 先前尚未呼叫，則 Map 建構函式會自動呼叫它。 如果未指定通訊協定，則會假設 https。
setLanguage(string)	設定對應和服務模組使用的預設語言，除非在使用 API 的那些部分時明確指定語言。 如果 Map 是以明確定義的語言初始化，且 setLanguage 先前尚未呼叫，則 Map 建構函式會自動呼叫它。
setMaxParallelImageRequests(number)	設定最大影像數目（點陣磚、Sprite、圖示）以平行載入，這會影響點陣重度地圖中的效能。 預設為 16。
setSessionId(string)	設定對應和服務模組所使用的預設會話標識碼，除非在使用 API 的那些部分時明確指定會話識別碼。 如果 Map 是以明確定義的會話標識元初始化，且 setSessionId 先前尚未呼叫，則 Map 建構函式會自動呼叫它。
setSubscriptionKey(string)	將 Azure 地圖服務訂用帳戶金鑰設定為地圖控件所使用的 atlas 命名空間中的預設訂用帳戶密鑰，以及向 Azure 地圖服務提出要求的任何模組。 如果 Map 是以明確定義的訂用帳戶金鑰初始化，且 setSubscriptionKey 先前尚未呼叫，則 Map 建構函式會自動呼叫它。
setUserRegion(string)
setView(string)	指定地圖上會顯示哪一組地緣政治爭議邊界和標籤。 View 參數（也稱為「用戶區域參數」）是 2 個字母的 ISO-3166 國家/地區代碼，會顯示該國家/地區的正確地圖。 不在 [檢視] 清單或未指定的國家/地區預設為「統一」檢視。 請參閱支援的 [Views]{@link https://aka.ms/AzureMapsLocalizationViews }。 您必須負責判斷使用者的位置，然後正確設定該位置的 View 參數。 Azure 地圖服務中的 View 參數必須符合相關法律，包括地圖、地圖、影像和其他數據和您獲授權透過 Azure 地圖服務存取的第三方內容的國家/地區相關法律。
setWorkerCount(number)	設定頁面上具現化的 Web 背景工作角色數目。 根據預設，它會設定為 CPU 核心數目的一半（上限為 6）。

函式詳細資料

addImageTemplate(string, string, boolean)

將影像範本新增至 atlas 命名空間。

function addImageTemplate(templateName: string, template: string, override: boolean)

參數

templateName

string

範本的名稱。

template

string

要新增的 SVG 範本。 支持 {color}、{secondaryColor}、{scale}、{text}。

override

boolean

指定如果已經有相同名稱的範本，它是否應該覆寫現有的範本。

addProtocol(string, (args: any[]) => Promise<any>)

新增使用以自定義 URL 架構開頭的 URL 時所呼叫的自定義載入資源函式。

function addProtocol(customProtocol: string, loadFn: (args: any[]) => Promise<any>)

參數

customProtocol

string

要攔截的通訊協定，例如 'custom'

loadFn

(args: any[]) => Promise<any>

嘗試擷取 customProtocol 所指定磚時要使用的函式

clearPrewarmedResources()

清除先前由 atlas.prewarm()建立的資源。 請注意，這通常並非必要。 如果您預期應用程式的任何時間點都不會返回地圖檢視檢視，您應該只呼叫此函式。

function clearPrewarmedResources()

getAllImageTemplateNames()

擷取 atlas 命名空間中所有可用影像範本的名稱陣列。

function getAllImageTemplateNames(): string[]

傳回

string[]

getAuthenticationOptions()

取得提供的預設驗證選項。 如果先前未設定所有屬性，則不會定義。

function getAuthenticationOptions(): AuthenticationOptions

傳回

AuthenticationOptions

getDomain()

取得提供的預設網域。 如果先前未設定預設值，則為 "atlas.microsoft.com"。

function getDomain(): string

傳回

string

getImageTemplate(string, number)

依名稱擷取SVG範本。

function getImageTemplate(templateName: string, scale?: number): string

參數

templateName

string

要擷取的範本名稱。

scale

number

指定調整範本的量。 為了獲得最佳結果，請將圖示縮放為您想要在地圖上顯示的大小上限，然後視需要使用符號圖層圖示大小選項來相應減少。 這可減少因縮放比例而模糊。 預設值：1

傳回

string

getLanguage()

取得提供的預設語言。 如果先前未設定預設值，則為 "NGT"。

function getLanguage(): string

傳回

string

getMaxParallelImageRequests()

取得平行載入的影像數目上限（點陣磚、Sprite、圖示）

function getMaxParallelImageRequests(): number

傳回

number

getSessionId()

取得提供的預設會話標識碼。 如果先前未設定預設值，則為隨機 UUID。

function getSessionId(): string

傳回

string

getSubscriptionKey()

取得提供的預設 Azure 地圖服務訂用帳戶密鑰。

function getSubscriptionKey(): string

傳回

string

getUserRegion()

警告

此 API 現已淘汰。

use atlas.getView() instead

function getUserRegion(): string

傳回

string

getVersion()

以組建編號為基礎的目前 API 版本號碼。

function getVersion(): string

傳回

string

getView()

取得地圖控件的預設檢視設定。 如果先前未設定預設值，則為 undefined。

function getView(): string

傳回

string

getWorkerCount()

取得將建立的背景工作角色計數。

function getWorkerCount(): number

傳回

number

isSupported(boolean)

檢查地圖控件是否支援使用者的瀏覽器。

function isSupported(failIfMajorPerformanceCaveat?: boolean): boolean

參數

failIfMajorPerformanceCaveat

boolean

如果為 true，如果地圖控件的效能會比預期差得多，則函式會傳回 false（例如會使用軟體 WebGL 轉譯器）。

傳回

boolean

prewarm()

初始化 WebWorkers 等資源，這些資源在某些情況下可以跨對應共用，以降低負載時間。 atlas.setWorkerCount，如果使用，必須先設定 prewarm() 才能產生效果。 根據預設，這些資源的生命週期會自動管理，而且會在第一次建立地圖時延遲初始化。 藉由叫用 prewarm()，這些資源將會事先建立，而且不會在頁面移除最後一個地圖時清除。 這可讓稍後建立的新對應實例重複使用它們。 藉由呼叫 atlas.clearPrewarmedResources()，即可手動清除它們。 只有當網頁保持作用中，但完全停止使用地圖時，才需要這樣做。

這在單一頁面應用程式中使用 GL-JS 地圖時，主要很有用，其中使用者會在各種檢視之間巡覽，而這種檢視可能會導致 Map 實例不斷建立和終結。

function prewarm()

removeProtocol(string)

拿掉先前在主線程中新增的通訊協定。

function removeProtocol(customProtocol: string)

參數

customProtocol

string

要移除註冊的自定義通訊協定

setAuthenticationOptions(AuthenticationOptions)

將您的驗證選項設定為地圖控件所使用的 atlas 命名空間中的預設選項，以及向 Azure 地圖服務提出要求的任何模組。 如果 Map 是以明確定義的驗證選項初始化，且 setAuthenticationOptions 先前尚未呼叫，則 Map 建構函式會自動呼叫它。

function setAuthenticationOptions(options: AuthenticationOptions)

參數

options

AuthenticationOptions

新的預設驗證選項。

setDomain(string)

設定對應和服務模組所使用的預設網域，除非在使用 API 的那些部分時明確指定網域。 如果 Map 是以明確定義的網域初始化，且 setDomain 先前尚未呼叫，則 Map 建構函式會自動呼叫它。 如果未指定通訊協定，則會假設 https。

function setDomain(domain: string)

參數

domain

string

新的預設網域。

setLanguage(string)

設定對應和服務模組使用的預設語言，除非在使用 API 的那些部分時明確指定語言。 如果 Map 是以明確定義的語言初始化，且 setLanguage 先前尚未呼叫，則 Map 建構函式會自動呼叫它。

function setLanguage(language: string)

參數

language

string

新的預設語言。

setMaxParallelImageRequests(number)

設定最大影像數目（點陣磚、Sprite、圖示）以平行載入，這會影響點陣重度地圖中的效能。 預設為 16。

function setMaxParallelImageRequests(maxParallelImageRequests: number)

參數

maxParallelImageRequests

number

要平行載入的影像數目上限。

setSessionId(string)

設定對應和服務模組所使用的預設會話標識碼，除非在使用 API 的那些部分時明確指定會話識別碼。 如果 Map 是以明確定義的會話標識元初始化，且 setSessionId 先前尚未呼叫，則 Map 建構函式會自動呼叫它。

function setSessionId(id: string)

參數

id

string

新的預設會話標識碼。

setSubscriptionKey(string)

將 Azure 地圖服務訂用帳戶金鑰設定為地圖控件所使用的 atlas 命名空間中的預設訂用帳戶密鑰，以及向 Azure 地圖服務提出要求的任何模組。 如果 Map 是以明確定義的訂用帳戶金鑰初始化，且 setSubscriptionKey 先前尚未呼叫，則 Map 建構函式會自動呼叫它。

function setSubscriptionKey(key: string)

參數

key

string

新的預設訂用帳戶金鑰。

setUserRegion(string)

警告

此 API 現已淘汰。

use atlas.setView(view: string) instead.

function setUserRegion(userRegion: string)

參數

userRegion

string

setView(string)

指定地圖上會顯示哪一組地緣政治爭議邊界和標籤。 View 參數（也稱為「用戶區域參數」）是 2 個字母的 ISO-3166 國家/地區代碼，會顯示該國家/地區的正確地圖。 不在 [檢視] 清單或未指定的國家/地區預設為「統一」檢視。 請參閱支援的 [Views]{@link https://aka.ms/AzureMapsLocalizationViews }。 您必須負責判斷使用者的位置，然後正確設定該位置的 View 參數。 Azure 地圖服務中的 View 參數必須符合相關法律，包括地圖、地圖、影像和其他數據和您獲授權透過 Azure 地圖服務存取的第三方內容的國家/地區相關法律。

function setView(view: string)

參數

view

string

新的預設檢視

setWorkerCount(number)

設定頁面上具現化的 Web 背景工作角色數目。 根據預設，它會設定為 CPU 核心數目的一半（上限為 6）。

function setWorkerCount(workerCount: number)

參數

workerCount

number

背景工作計數。