atlas module

Paket:

azure-maps-control

Kelas

EventManager	Manajer untuk peristiwa kontrol peta. Diekspos melalui properti peristiwa atlas. Kelas peta. Tidak dapat dibuat oleh pengguna.
HtmlMarker	Kelas ini membungkus elemen HTML yang dapat ditampilkan di peta.
Map	Kontrol untuk peta web visual dan interaktif.
Pixel	Mewakili koordinat atau offset piksel. Memperluas array [x, y].
Popup	Jendela informasi berlabuh pada posisi tertentu pada peta.
PopupTemplate	Templat tata letak untuk popup.
Shape	Kelas pembantu yang membungkus Geometri atau Fitur dan memudahkan untuk memperbarui dan memelihara.

Antarmuka

AggregateExpression	Ekspresi agregat menentukan perhitungan yang diproses melalui sekumpulan data. Skema: [operator: string, initialValue?: boolean | number, mapExpression: Expression] operator: Fungsi ekspresi yang kemudian diterapkan ke terhadap semua nilai yang dihitung oleh mapExpression untuk setiap titik dalam kluster. Operator yang didukung: o Untuk angka: +, , max*, min o Untuk Boolean: all, any initialValue: Opsional, nilai awal di mana nilai terhitung pertama diagregasi. mapExpression: Ekspresi yang diterapkan terhadap setiap titik dalam himpunan data.
AnimationOptions	Opsi untuk menanimasikan perubahan pada kamera kontrol peta.
AuthenticationManager	Manajer untuk autentikasi kontrol peta. Diekspos melalui properti autentikasi atlas. Kelas peta. Tidak dapat dibuat oleh pengguna.
AuthenticationOptions	Opsi untuk menentukan bagaimana kontrol peta harus mengautentikasi dengan layanan Azure Maps.
BubbleLayerOptions	Opsi yang digunakan saat merender objek Titik di BubbleLayer.
CameraBoundsOptions	Opsi untuk mengatur batas kamera kontrol peta.
CameraOptions	Opsi untuk mengatur kamera kontrol peta.
ClusteredProperties	Properti yang akan ada untuk ClusteredProperties
CompassControlOptions	Opsi untuk objek CompassControl.
Control	Antarmuka untuk menentukan kontrol peta.
ControlManager	Manajer untuk kontrol kontrol peta. Terekspos melalui properti kontrol atlas. Kelas peta. Tidak dapat dibuat oleh pengguna.
ControlOptions	Opsi untuk menambahkan kontrol ke peta.
DataSourceOptions	Sumber data untuk mengelola data bentuk yang akan ditampilkan di peta. Sumber data harus ditambahkan ke lapisan sebelum terlihat di peta. Opsi untuk DataSourceOptions.
ElevationTileSourceOptions
HeatMapLayerOptions	Opsi yang digunakan saat merender objek Titik di HeatMapLayer.
HtmlMarkerEvents
HtmlMarkerManager	Manajer untuk penanda HTML kontrol peta. Diekspos melalui properti penanda atlas. Kelas peta. Tidak dapat dibuat oleh pengguna.
HtmlMarkerOptions	Opsi untuk merender objek HtmlMarker
HyperLinkFormatOptions	Opsi format untuk string hyperlink.
IconOptions	Opsi yang digunakan untuk menyesuaikan ikon dalam SymbolLayer
ImageLayerOptions	Opsi yang digunakan saat merender objek Titik dalam ImageLayer.
ImageSpriteManager	Manajer untuk sprite gambar kontrol peta. Diekspos melalui properti imageSprite dari atlas. Kelas peta. Tidak dapat dibuat oleh pengguna.
LayerManager	Manajer untuk lapisan kontrol peta. Diekspos melalui properti lapisan atlas. Kelas peta. Tidak dapat dibuat oleh pengguna.
LayerOptions	Kelas dasar tempat semua opsi lapisan lainnya mewarisi.
LightOptions	Opsi untuk pencahayaan peta.
LineLayerOptions	Opsi yang digunakan saat merender objek SimpleLine, SimplePolygon, CirclePolygon, LineString, MultiLineString, Polygon, dan MultiPolygon dalam lapisan baris.
MapConfiguration	Mewakili konten konfigurasi peta yang menyimpan daftar gaya yang tersedia untuknya.
MapConfigurationStyle	Mewakili info untuk satu gaya.
MapDataEvent	Objek peristiwa yang dikembalikan oleh peta saat peristiwa data terjadi.
MapErrorEvent	Objek peristiwa yang dikembalikan oleh peta saat peristiwa kesalahan terjadi.
MapEvent	Objek peristiwa yang dikembalikan oleh peta saat peristiwa dasar terjadi.
MapMouseEvent	Objek peristiwa yang dikembalikan oleh peta saat peristiwa mouse terjadi.
MapMouseWheelEvent	Objek peristiwa yang dikembalikan oleh peta saat peristiwa roda terjadi.
MapTouchEvent	Objek peristiwa yang dikembalikan oleh peta saat peristiwa sentuhan terjadi.
MediaLayerOptions	Opsi yang digunakan saat merender kanvas, gambar, petak peta raster, dan lapisan video
Options
Padding	Mewakili jumlah padding dalam piksel untuk ditambahkan ke sisi BoundingBox saat mengatur kamera peta.
PitchControlOptions	Opsi untuk objek PitchControl.
PolygonExtrusionLayerOptions	Opsi yang digunakan saat merender Polygon dan MultiPolygon objek dalam PolygonExtrusionLayer.
PolygonLayerOptions	Opsi yang digunakan saat merender objek Poligon dan MultiPolygon di PolygonLayer.
PopupEvents
PopupManager	Manajer untuk popup kontrol peta. Diekspos melalui popups properti atlas.Map kelas . Tidak dapat dibuat oleh pengguna.
PopupOptions	Opsi untuk popup.
Properties	Sekumpulan properti yang dapat digunakan dengan PopupTemplate
PropertyInfo	Detail spesies tentang bagaimana properti akan ditampilkan.
RasterTileSourceOptions
RequestParameters	Ini adalah jenis objek yang diharapkan dikembalikan oleh panggilan balik transformRequest.
ScaleControlOptions	Opsi untuk objek ScaleControl.
ServiceOptions	Properti global yang digunakan dalam semua permintaan layanan atlas.
ShapeEvents
SourceManager	Manajer untuk sumber kontrol peta. Diekspos melalui properti sumber atlas. Kelas peta. Tidak dapat dibuat oleh pengguna.
StyleChangedEvent	Objek peristiwa yang dikembalikan oleh peta setelah memuat gaya baru.
StyleControlOptions	Opsi untuk objek StyleControl.
StyleOptions	Opsi untuk gaya peta.
SymbolLayerOptions	Opsi yang digunakan saat merender geometri dalam SymbolLayer.
TargetedEvent
TextOptions	Opsi yang digunakan untuk mengkustomisasi teks dalam SymbolLayer
Tile	Objek petak peta yang dikembalikan oleh peta saat peristiwa data sumber terjadi.
TileId
TileLayerOptions	Opsi yang digunakan saat merender gambar petak raster di TileLayer.
TrafficControlOptions
TrafficOptions	Opsi untuk mengatur lalu lintas di peta.
UserInteractionOptions	Opsi untuk mengaktifkan/menonaktifkan interaksi pengguna dengan peta.
VectorTileSourceOptions	Sumber data untuk mengelola data bentuk yang akan ditampilkan di peta. Sumber data harus ditambahkan ke lapisan sebelum terlihat di peta. Opsi untuk VectorTileSource.
WebGLLayerOptions	Opsi yang digunakan untuk merender grafik di WebGLLayer.
WebGLRenderer	Antarmuka untuk merender grafik WebGL di WebGLLayer.
ZoomControlOptions	Opsi untuk objek ZoomControl.

Alias Jenis

Expression	Dapat ditentukan sebagai nilai filter atau opsi lapisan tertentu. Ekspresi menentukan rumus untuk menghitung nilai properti. Ekspresi direpresentasikan sebagai array JSON. Elemen pertama dari ekspresi adalah string yang menamai operator ekspresi.
getAuthTokenCallback	Fungsi panggilan balik yang digunakan untuk memperoleh token autentikasi dalam mode autentikasi anonim. Atasi dengan token autentikasi atau tolak dengan kesalahan apa pun.
ResourceType
StyleImageMetadata	Tanda tangan untuk parameter yang diteruskan options ke ImageSpriteManager.add.

Enum

AuthenticationType	Enumerasi yang digunakan untuk menentukan jenis mekanisme autentikasi yang akan digunakan.
ControlPosition	Posisi di mana kontrol dapat ditempatkan di peta.
ControlStyle	Gaya yang tersedia untuk Kontrol.

Fungsi

addImageTemplate(string, string, boolean)	Menambahkan templat gambar ke namespace layanan atlas.
clearPrewarmedResources()	Menghapus sumber daya yang sebelumnya telah dibuat oleh atlas.prewarm(). Perhatikan bahwa ini biasanya tidak diperlukan. Anda seharusnya hanya memanggil fungsi ini jika Anda mengharapkan pengguna aplikasi Anda untuk tidak kembali ke tampilan Peta kapan saja di aplikasi Anda.
getAllImageTemplateNames()	Mengambil array nama untuk semua templat gambar yang tersedia di namespace layanan atlas.
getAuthenticationOptions()	Mendapatkan opsi autentikasi default yang disediakan. Jika sebelumnya tidak mengatur semua properti tidak akan ditentukan.
getDomain()	Mendapatkan domain default yang disediakan. Jika sebelumnya tidak mengatur nilai default adalah "atlas.microsoft.com".
getImageTemplate(string, number)	Mengambil templat SVG berdasarkan nama.
getLanguage()	Mendapatkan bahasa default yang disediakan. Jika sebelumnya tidak mengatur nilai default adalah "NGT".
getMaxParallelImageRequests()	Mendapatkan Jumlah maksimum gambar (petak peta raster, sprite, ikon) untuk dimuat secara paralel
getSessionId()	Mendapatkan id sesi default yang disediakan. Jika sebelumnya tidak mengatur nilai default adalah UUID acak.
getSubscriptionKey()	Mendapatkan kunci langganan Azure Maps default yang disediakan.
getUserRegion()
getVersion()	Nomor versi API saat ini berdasarkan nomor build.
getView()	Mendapatkan pengaturan tampilan default kontrol peta. Jika sebelumnya tidak mengatur nilai default adalah undefined.
getWorkerCount()	Mendapatkan jumlah pekerja yang akan dibuat.
isSupported(boolean)	Memeriksa untuk melihat apakah browser pengguna didukung oleh kontrol peta.
prewarm()	Menginisialisasi sumber daya seperti WebWorkers yang dapat dibagikan di seluruh peta untuk menurunkan waktu muat dalam beberapa situasi. atlas.setWorkerCount, jika digunakan, harus diatur sebelumnya prewarm() dipanggil untuk memiliki efek. Secara default, siklus hidup sumber daya ini dikelola secara otomatis, dan mereka diinisialisasi dengan malas saat Peta pertama kali dibuat. Dengan memanggil prewarm(), sumber daya ini akan dibuat sebelumnya, dan tidak akan dihapus ketika Peta terakhir dihapus dari halaman. Ini memungkinkan mereka untuk digunakan kembali oleh instans Peta baru yang dibuat nanti. Mereka dapat dibersihkan secara manual dengan memanggil atlas.clearPrewarmedResources(). Ini hanya diperlukan jika halaman web Anda tetap aktif tetapi berhenti menggunakan peta sama sekali. Ini terutama berguna saat menggunakan peta GL-JS dalam satu aplikasi halaman, di mana pengguna akan menavigasi antara berbagai tampilan yang dapat menyebabkan instans Peta terus dibuat dan dihancurkan.
setAuthenticationOptions(AuthenticationOptions)	Mengatur opsi autentikasi Anda sebagai opsi default di namespace layanan atlas yang digunakan oleh kontrol peta dan modul apa pun yang membuat permintaan ke layanan peta Azure. Jika Peta diinisialisasi dengan opsi autentikasi yang ditentukan secara eksplisit dan setAuthenticationOptions sebelumnya belum disebut akan secara otomatis dipanggil oleh konstruktor Peta.
setDomain(string)	Mengatur domain default yang digunakan oleh modul peta dan layanan kecuali domain ditentukan secara eksplisit saat menggunakan bagian API tersebut. Jika Peta diinisialisasi dengan domain yang ditentukan secara eksplisit dan setDomain sebelumnya belum disebut, peta akan secara otomatis dipanggil oleh konstruktor Peta. Jika protokol tidak ditentukan https diasumsikan.
setLanguage(string)	Mengatur bahasa default yang digunakan oleh modul peta dan layanan kecuali bahasa ditentukan secara eksplisit saat menggunakan bagian API tersebut. Jika Peta diinisialisasi dengan bahasa yang secara eksplisit ditentukan dan setLanguage sebelumnya belum dipanggil, peta akan secara otomatis dipanggil oleh konstruktor Peta.
setMaxParallelImageRequests(number)	Mengatur Jumlah gambar maksimum (petak peta raster, sprite, ikon) untuk dimuat secara paralel, yang memengaruhi performa dalam peta raster-berat. 16 secara default.
setSessionId(string)	Mengatur id sesi default yang digunakan oleh modul peta dan layanan kecuali id sesi ditentukan secara eksplisit saat menggunakan bagian API tersebut. Jika Peta diinisialisasi dengan ID sesi yang ditentukan secara eksplisit dan setSessionId sebelumnya belum dipanggil, peta akan secara otomatis dipanggil oleh konstruktor Peta.
setSubscriptionKey(string)	Mengatur kunci langganan Azure Maps Anda sebagai kunci langganan default di namespace layanan atlas yang digunakan oleh kontrol peta dan modul apa pun yang membuat permintaan ke layanan azure maps. Jika Peta diinisialisasi dengan kunci langganan yang ditentukan secara eksplisit dan setSubscriptionKey sebelumnya belum disebut akan secara otomatis dipanggil oleh konstruktor Peta.
setUserRegion(string)
setView(string)	Menentukan set batas dan label yang disengketakan secara geopolitik yang ditampilkan di peta. Parameter Tampilan (juga disebut sebagai "parameter wilayah pengguna") adalah Kode Negara ISO-3166 2 huruf yang akan menampilkan peta yang benar untuk negara/wilayah tersebut. Negara/Wilayah yang tidak ada dalam daftar Tampilan atau jika tidak ditentukan akan default ke Tampilan "Terpadu". Silakan lihat [Views]{@link https://aka.ms/AzureMapsLocalizationViews }yang didukung. Anda bertanggung jawab untuk menentukan lokasi pengguna Anda, lalu mengatur parameter Tampilan dengan benar untuk lokasi tersebut. Parameter Tampilan dalam Azure Maps harus digunakan sesuai dengan undang-undang yang berlaku, termasuk yang berkaitan dengan pemetaan, negara/wilayah tempat peta, gambar, dan data lain dan konten pihak ketiga yang Anda beri wewenang untuk diakses melalui Azure Maps tersedia.
setWorkerCount(number)	Mengatur jumlah pekerja web yang dibuat di halaman. Secara default, ini diatur ke setengah jumlah inti CPU (dibatasi pada 6).

Detail Fungsi

addImageTemplate(string, string, boolean)

Menambahkan templat gambar ke namespace layanan atlas.

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

Parameter

templateName

string

Nama templat.

template

string

Templat SVG yang akan ditambahkan. Mendukung {color}, {secondaryColor}, {scale}, {text}.

override

boolean

Menentukan apakah templat harus mengambil alih templat yang ada jika templat dengan nama yang sama sudah ada.

clearPrewarmedResources()

Menghapus sumber daya yang sebelumnya telah dibuat oleh atlas.prewarm(). Perhatikan bahwa ini biasanya tidak diperlukan. Anda seharusnya hanya memanggil fungsi ini jika Anda mengharapkan pengguna aplikasi Anda untuk tidak kembali ke tampilan Peta kapan saja di aplikasi Anda.

function clearPrewarmedResources()

getAllImageTemplateNames()

Mengambil array nama untuk semua templat gambar yang tersedia di namespace layanan atlas.

function getAllImageTemplateNames(): string[]

Mengembalikan

string[]

getAuthenticationOptions()

Mendapatkan opsi autentikasi default yang disediakan. Jika sebelumnya tidak mengatur semua properti tidak akan ditentukan.

function getAuthenticationOptions(): AuthenticationOptions

Mengembalikan

AuthenticationOptions

getDomain()

Mendapatkan domain default yang disediakan. Jika sebelumnya tidak mengatur nilai default adalah "atlas.microsoft.com".

function getDomain(): string

Mengembalikan

string

getImageTemplate(string, number)

Mengambil templat SVG berdasarkan nama.

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

Parameter

templateName

string

Nama templat yang akan diambil.

scale

number

Menentukan berapa banyak untuk menskalakan templat. Untuk hasil terbaik, skalakan ikon ke ukuran maksimum yang ingin Anda tampilkan di peta, lalu gunakan opsi ukuran ikon lapisan simbol untuk menurunkan skala jika diperlukan. Ini akan mengurangi kekaburan karena penskalaan. Default: 1

Mengembalikan

string

getLanguage()

Mendapatkan bahasa default yang disediakan. Jika sebelumnya tidak mengatur nilai default adalah "NGT".

function getLanguage(): string

Mengembalikan

string

getMaxParallelImageRequests()

Mendapatkan Jumlah maksimum gambar (petak peta raster, sprite, ikon) untuk dimuat secara paralel

function getMaxParallelImageRequests(): number

Mengembalikan

number

getSessionId()

Mendapatkan id sesi default yang disediakan. Jika sebelumnya tidak mengatur nilai default adalah UUID acak.

function getSessionId(): string

Mengembalikan

string

getSubscriptionKey()

Mendapatkan kunci langganan Azure Maps default yang disediakan.

function getSubscriptionKey(): string

Mengembalikan

string

getUserRegion()

Peringatan

API ini sudah tidak digunakan lagi.

use atlas.getView() instead

function getUserRegion(): string

Mengembalikan

string

getVersion()

Nomor versi API saat ini berdasarkan nomor build.

function getVersion(): string

Mengembalikan

string

getView()

Mendapatkan pengaturan tampilan default kontrol peta. Jika sebelumnya tidak mengatur nilai default adalah undefined.

function getView(): string

Mengembalikan

string

getWorkerCount()

Mendapatkan jumlah pekerja yang akan dibuat.

function getWorkerCount(): number

Mengembalikan

number

isSupported(boolean)

Memeriksa untuk melihat apakah browser pengguna didukung oleh kontrol peta.

function isSupported(failIfMajorPerformanceCaveat?: boolean): boolean

Parameter

failIfMajorPerformanceCaveat

boolean

Jika true, fungsi akan mengembalikan false jika performa kontrol peta akan secara dramatis lebih buruk dari yang diharapkan (misalnya perender WebGL perangkat lunak akan digunakan).

Mengembalikan

boolean

prewarm()

Menginisialisasi sumber daya seperti WebWorkers yang dapat dibagikan di seluruh peta untuk menurunkan waktu muat dalam beberapa situasi. atlas.setWorkerCount, jika digunakan, harus diatur sebelumnya prewarm() dipanggil untuk memiliki efek. Secara default, siklus hidup sumber daya ini dikelola secara otomatis, dan mereka diinisialisasi dengan malas saat Peta pertama kali dibuat. Dengan memanggil prewarm(), sumber daya ini akan dibuat sebelumnya, dan tidak akan dihapus ketika Peta terakhir dihapus dari halaman. Ini memungkinkan mereka untuk digunakan kembali oleh instans Peta baru yang dibuat nanti. Mereka dapat dibersihkan secara manual dengan memanggil atlas.clearPrewarmedResources(). Ini hanya diperlukan jika halaman web Anda tetap aktif tetapi berhenti menggunakan peta sama sekali.

Ini terutama berguna saat menggunakan peta GL-JS dalam satu aplikasi halaman, di mana pengguna akan menavigasi antara berbagai tampilan yang dapat menyebabkan instans Peta terus dibuat dan dihancurkan.

function prewarm()

setAuthenticationOptions(AuthenticationOptions)

Mengatur opsi autentikasi Anda sebagai opsi default di namespace layanan atlas yang digunakan oleh kontrol peta dan modul apa pun yang membuat permintaan ke layanan peta Azure. Jika Peta diinisialisasi dengan opsi autentikasi yang ditentukan secara eksplisit dan setAuthenticationOptions sebelumnya belum disebut akan secara otomatis dipanggil oleh konstruktor Peta.

function setAuthenticationOptions(options: AuthenticationOptions)

Parameter

options

AuthenticationOptions

Opsi autentikasi default baru.

setDomain(string)

Mengatur domain default yang digunakan oleh modul peta dan layanan kecuali domain ditentukan secara eksplisit saat menggunakan bagian API tersebut. Jika Peta diinisialisasi dengan domain yang ditentukan secara eksplisit dan setDomain sebelumnya belum disebut, peta akan secara otomatis dipanggil oleh konstruktor Peta. Jika protokol tidak ditentukan https diasumsikan.

function setDomain(domain: string)

Parameter

domain

string

Domain default baru.

setLanguage(string)

Mengatur bahasa default yang digunakan oleh modul peta dan layanan kecuali bahasa ditentukan secara eksplisit saat menggunakan bagian API tersebut. Jika Peta diinisialisasi dengan bahasa yang secara eksplisit ditentukan dan setLanguage sebelumnya belum dipanggil, peta akan secara otomatis dipanggil oleh konstruktor Peta.

function setLanguage(language: string)

Parameter

language

string

Bahasa default baru.

setMaxParallelImageRequests(number)

Mengatur Jumlah gambar maksimum (petak peta raster, sprite, ikon) untuk dimuat secara paralel, yang memengaruhi performa dalam peta raster-berat. 16 secara default.

function setMaxParallelImageRequests(maxParallelImageRequests: number)

Parameter

maxParallelImageRequests

number

Jumlah maksimum gambar yang akan dimuat secara paralel.

setSessionId(string)

Mengatur id sesi default yang digunakan oleh modul peta dan layanan kecuali id sesi ditentukan secara eksplisit saat menggunakan bagian API tersebut. Jika Peta diinisialisasi dengan ID sesi yang ditentukan secara eksplisit dan setSessionId sebelumnya belum dipanggil, peta akan secara otomatis dipanggil oleh konstruktor Peta.

function setSessionId(id: string)

Parameter

id

string

Id sesi default baru.

setSubscriptionKey(string)

Mengatur kunci langganan Azure Maps Anda sebagai kunci langganan default di namespace layanan atlas yang digunakan oleh kontrol peta dan modul apa pun yang membuat permintaan ke layanan azure maps. Jika Peta diinisialisasi dengan kunci langganan yang ditentukan secara eksplisit dan setSubscriptionKey sebelumnya belum disebut akan secara otomatis dipanggil oleh konstruktor Peta.

function setSubscriptionKey(key: string)

Parameter

key

string

Kunci langganan default baru.

setUserRegion(string)

Peringatan

API ini sudah tidak digunakan lagi.

use atlas.setView(view: string) instead.

function setUserRegion(userRegion: string)

Parameter

userRegion

string

setView(string)

Menentukan set batas dan label yang disengketakan secara geopolitik yang ditampilkan di peta. Parameter Tampilan (juga disebut sebagai "parameter wilayah pengguna") adalah Kode Negara ISO-3166 2 huruf yang akan menampilkan peta yang benar untuk negara/wilayah tersebut. Negara/Wilayah yang tidak ada dalam daftar Tampilan atau jika tidak ditentukan akan default ke Tampilan "Terpadu". Silakan lihat [Views]{@link https://aka.ms/AzureMapsLocalizationViews }yang didukung. Anda bertanggung jawab untuk menentukan lokasi pengguna Anda, lalu mengatur parameter Tampilan dengan benar untuk lokasi tersebut. Parameter Tampilan dalam Azure Maps harus digunakan sesuai dengan undang-undang yang berlaku, termasuk yang berkaitan dengan pemetaan, negara/wilayah tempat peta, gambar, dan data lain dan konten pihak ketiga yang Anda beri wewenang untuk diakses melalui Azure Maps tersedia.

function setView(view: string)

Parameter

view

string

Tampilan default baru

setWorkerCount(number)

Mengatur jumlah pekerja web yang dibuat di halaman. Secara default, ini diatur ke setengah jumlah inti CPU (dibatasi pada 6).

function setWorkerCount(workerCount: number)

Parameter

workerCount

number

jumlah pekerja.