atlas module

Pakiet:

azure-maps-control

Klasy

EventManager	Menedżer zdarzeń kontrolki mapy. Uwidocznione za pośrednictwem właściwości zdarzeń atlasu. Map, klasa. Nie można utworzyć wystąpienia przez użytkownika.
HtmlMarker	Ta klasa opakowuje element HTML, który można wyświetlić na mapie.
Map	Kontrolka wizualizacji i interaktywnej mapy internetowej.
Pixel	Reprezentują współrzędną lub przesunięcie pikseli. Rozszerza tablicę [x, y].
Popup	Okno informacji zakotwiczone na określonej pozycji na mapie.
PopupTemplate	Szablon układu dla wyskakującego okienka.
Shape	Klasa pomocnika, która opakowuje geometrię lub funkcję i ułatwia aktualizowanie i konserwację.

Interfejsy

AggregateExpression	Wyrażenie agregujące definiuje obliczenie przetwarzane przez zestaw danych. Schemat: [operator: string, initialValue?: wartość logiczna | liczba, operator mapExpression: Expression]: funkcja wyrażenia, która jest następnie stosowana do wszystkich wartości obliczonych przez mapExpression dla każdego punktu w klastrze. Obsługiwane operatory: o W przypadku liczb: +, *, max, min o Dla wartości logicznych: all, any initialValue: Opcjonalna, początkowa wartość, w której jest agregowana pierwsza obliczona wartość. mapExpression: wyrażenie stosowane względem każdego punktu w zestawie danych.
AnimationOptions	Opcje animowania zmian w aparacie kontrolki mapy.
AuthenticationManager	Menedżer uwierzytelniania kontrolki mapy. Uwidocznione za pośrednictwem właściwości uwierzytelniania atlasu. Map, klasa. Nie można utworzyć wystąpienia przez użytkownika.
AuthenticationOptions	Opcje określania sposobu uwierzytelniania kontrolki mapy za pomocą usług Azure Maps.
BubbleLayerOptions	Opcje używane podczas renderowania obiektów punktów w bańce.
CameraBoundsOptions	Opcje ustawiania granic aparatu kontrolki mapy.
CameraOptions	Opcje ustawiania aparatu kontrolki mapy.
ClusteredProperties	Właściwości, które będą istnieć dla właściwości ClusteredProperties
CompassControlOptions	Opcje obiektu CompassControl.
Control	Interfejs do definiowania kontrolki mapy.
ControlManager	Menedżer kontrolek mapy. Uwidocznione za pomocą właściwości kontrolek atlasu. Map, klasa. Nie można utworzyć wystąpienia przez użytkownika.
ControlOptions	Opcje dodawania kontrolki do mapy.
DataSourceOptions	Źródło danych do zarządzania danymi kształtu, które będą wyświetlane na mapie. Źródło danych należy dodać do warstwy, zanim będzie widoczne na mapie. Opcje DataSourceOptions.
ElevationTileSourceOptions
FullscreenControlOptions	Opcje obiektu FullscreenControl.
HeatMapLayerOptions	Opcje używane podczas renderowania obiektów punktów w heatMapLayer.
HtmlMarkerEvents
HtmlMarkerManager	Menedżer znaczników HTML kontrolki mapy. Uwidocznione za pomocą właściwości markerów atlasu. Map, klasa. Nie można utworzyć wystąpienia przez użytkownika.
HtmlMarkerOptions	Opcje renderowania obiektu HtmlMarker
HyperLinkFormatOptions	Opcja formatowania ciągów hiperłączy.
IconOptions	Opcje używane do dostosowywania ikon w elemecie SymbolLayer
ImageLayerOptions	Opcje używane podczas renderowania obiektów punktów w ramce obrazu.
ImageSpriteManager	Menedżer sprite obrazu kontrolki mapy. Uwidocznione za pomocą właściwości imageSprite atlasu. Map, klasa. Nie można utworzyć wystąpienia przez użytkownika.
LayerManager	Menedżer warstw kontrolki mapy. Uwidocznione za pośrednictwem właściwości warstw atlasu. Map, klasa. Nie można utworzyć wystąpienia przez użytkownika.
LayerOptions	Klasa bazowa, z której dziedziczą wszystkie inne opcje warstwy.
LightOptions	Opcje oświetlenia mapy.
LineLayerOptions	Opcje używane podczas renderowania obiektów SimpleLine, SimplePolygon, CirclePolygon, LineString, MultiLineString, Polygon i MultiPolygon w warstwie liniowej.
MapConfiguration	Reprezentuje zawartość konfiguracji mapy zawierającej listę dostępnych stylów.
MapConfigurationStyle	Reprezentuje informacje dotyczące pojedynczego stylu.
MapDataEvent	Obiekt zdarzenia zwracany przez mapy, gdy wystąpi zdarzenie danych.
MapErrorEvent	Obiekt zdarzenia zwracany przez mapy, gdy wystąpi zdarzenie błędu.
MapEvent	Obiekt zdarzenia zwracany przez mapy, gdy wystąpi podstawowe zdarzenie.
MapMouseEvent	Obiekt zdarzenia zwracany przez mapy, gdy wystąpi zdarzenie myszy.
MapMouseWheelEvent	Obiekt zdarzenia zwracany przez mapy, gdy wystąpi zdarzenie koła.
MapTouchEvent	Obiekt zdarzenia zwracany przez mapy w przypadku wystąpienia zdarzenia dotykowego.
MediaLayerOptions	Opcje używane podczas renderowania kanwy, obrazu, kafelka rastrowego i warstw wideo
Options
Padding	Przedstawia ilość wypełnienia w pikselach, które mają zostać dodane po stronie pola BoundingBox podczas ustawiania aparatu mapy.
PitchControlOptions	Opcje obiektu PitchControl.
PolygonExtrusionLayerOptions	Opcje używane podczas renderowania obiektów Polygon i MultiPolygon w PolygonExtrusionLayer.
PolygonLayerOptions	Opcje używane podczas renderowania obiektów Polygon i MultiPolygon w wielokącie.
PopupEvents
PopupManager	Menedżer wyskakujących okienek kontrolki mapy. Uwidocznione za pomocą właściwości popups klasy atlas.Map. Nie można utworzyć wystąpienia przez użytkownika.
PopupOptions	Opcje wyskakującego okienka.
Properties	Zestaw właściwości, których można używać z PopupTemplate
PropertyInfo	Szczegóły dotyczące sposobu wyświetlania właściwości.
RasterTileSourceOptions
RequestParameters	Jest to typ obiektu, który powinien zostać zwrócony przez wywołanie zwrotne transformRequest.
ScaleControlOptions	Opcje obiektu ScaleControl.
ServiceOptions	Właściwości globalne używane we wszystkich żądaniach obsługi atlasu.
ShapeEvents
SourceManager	Menedżer źródeł kontrolki mapy. Uwidocznione za pośrednictwem właściwości sources atlasu. Map, klasa. Nie można utworzyć wystąpienia przez użytkownika.
StyleChangedEvent	Obiekt zdarzenia zwrócony przez mapę po załadowaniu nowego stylu.
StyleControlOptions	Opcje obiektu StyleControl.
StyleOptions	Opcje stylu mapy.
SymbolLayerOptions	Opcje używane podczas renderowania geometrii w elemencie SymbolLayer.
TargetedEvent
TextOptions	Opcje używane do dostosowywania tekstu w elemecie SymbolLayer
Tile	Obiekt kafelka zwracany przez mapę, gdy wystąpi zdarzenie danych źródłowych.
TileId
TileLayerOptions	Opcje używane podczas renderowania obrazów rastrowych kafelków w kafelkuLayer.
TrafficControlOptions
TrafficOptions	Opcje ustawiania ruchu na mapie.
UserInteractionOptions	Opcje włączania/wyłączania interakcji użytkownika z mapą.
VectorTileSourceOptions	Źródło danych do zarządzania danymi kształtu, które będą wyświetlane na mapie. Źródło danych należy dodać do warstwy, zanim będzie widoczne na mapie. Opcje VectorTileSource.
WebGLLayerOptions	Opcje używane do renderowania grafiki w elemecie WebGLLayer.
WebGLRenderer	Interfejs renderowania grafiki WebGL w elemecie WebGLLayer.
ZoomControlOptions	Opcje obiektu ZoomControl.

Aliasy typu

Expression	Można określić jako wartość filtru lub niektórych opcji warstwy. Wyrażenie definiuje formułę do obliczania wartości właściwości. Wyrażenia są reprezentowane jako tablice JSON. Pierwszym elementem wyrażenia jest ciąg nazewnictwa operatora wyrażenia.
getAuthTokenCallback	Funkcja wywołania zwrotnego używana do uzyskiwania tokenu uwierzytelniania w trybie uwierzytelniania anonimowego. Rozwiąż problem z tokenem uwierzytelniania lub odrzuć z błędami.
ResourceType
StyleImageMetadata	Podpis parametru options przekazanego do ImageSpriteManager.add.

Wyliczenia

AuthenticationType	Wyliczenie używane do określania typu mechanizmu uwierzytelniania do użycia.
ControlPosition	Pozycje, w których można umieścić kontrolkę na mapie.
ControlStyle	Dostępne style dla kontrolki.

Funkcje

addImageTemplate(string, string, boolean)	Dodaje szablon obrazu do przestrzeni nazw atlasu.
addProtocol(string, (args: any[]) => Promise<any>)	Dodaje niestandardową funkcję zasobu ładowania, która będzie wywoływana podczas korzystania z adresu URL rozpoczynającego się od niestandardowego schematu adresu URL.
clearPrewarmedResources()	Czyści zasoby, które zostały wcześniej utworzone przez atlas.prewarm(). Należy pamiętać, że zwykle nie jest to konieczne. Tę funkcję należy wywołać tylko wtedy, gdy oczekujesz, że użytkownik aplikacji nie powróci do widoku mapy w żadnym momencie w aplikacji.
getAllImageTemplateNames()	Pobiera tablicę nazw dla wszystkich szablonów obrazów dostępnych w przestrzeni nazw atlasu.
getAuthenticationOptions()	Pobiera domyślne opcje uwierzytelniania, które zostały podane. Jeśli nie ustawiono wcześniej wszystkich właściwości, będą niezdefiniowane.
getDomain()	Pobiera udostępnioną domenę domyślną. Jeśli wartość domyślna nie zostanie wcześniej ustawiona "atlas.microsoft.com".
getImageTemplate(string, number)	Pobiera szablon SVG według nazwy.
getLanguage()	Pobiera podany język domyślny. Jeśli wartość domyślna nie zostanie wcześniej ustawiona "NGT".
getMaxParallelImageRequests()	Pobiera maksymalną liczbę obrazów (kafelki rastrowe, sprites, ikony) do równoległego ładowania
getSessionId()	Pobiera domyślny identyfikator sesji, który został podany. Jeśli wartość domyślna nie zostanie wcześniej ustawiona, jest losowym identyfikatorem UUID.
getSubscriptionKey()	Pobiera domyślny klucz subskrypcji usługi Azure Maps, który został podany.
getUserRegion()
getVersion()	Bieżący numer wersji interfejsu API na podstawie numeru kompilacji.
getView()	Pobiera domyślne ustawienie widoku kontrolki mapy. Jeśli wartość domyślna nie zostanie wcześniej ustawiona undefined.
getWorkerCount()	Pobiera liczbę procesów roboczych, która zostanie utworzona.
isSupported(boolean)	Sprawdza, czy przeglądarka użytkownika jest obsługiwana przez kontrolkę mapy.
prewarm()	Inicjuje zasoby, takie jak WebWorkers, które mogą być współużytkowane między mapami, aby zmniejszyć czas ładowania w niektórych sytuacjach. atlas.setWorkerCount, jeśli są używane, należy ustawić przed wywołaniem prewarm(), aby mieć efekt. Domyślnie cykl życia tych zasobów jest zarządzany automatycznie i są one leniwie inicjowane po pierwszym utworzeniu mapy. Wywołując prewarm(), te zasoby zostaną utworzone przed upływem czasu i nie zostaną wyczyszczone po usunięciu ostatniej mapy ze strony. Dzięki temu mogą być ponownie używane przez nowe wystąpienia map, które są tworzone później. Można je wyczyścić ręcznie, wywołując atlas.clearPrewarmedResources(). Jest to konieczne tylko wtedy, gdy strona internetowa pozostanie aktywna, ale całkowicie przestanie korzystać z map. Jest to przydatne przede wszystkim w przypadku używania map GL-JS w aplikacji jednostronicowej, w której użytkownik będzie przechodził między różnymi widokami, co może spowodować, że wystąpienia mapy będą stale tworzone i niszczone.
removeProtocol(string)	Usuwa wcześniej dodany protokół w wątku głównym.
setAuthenticationOptions(AuthenticationOptions)	Ustawia opcje uwierzytelniania jako opcje domyślne w przestrzeni nazw atlas, która jest używana przez kontrolkę mapy i wszystkie moduły, które wysyłają żądania do usług Azure Maps. Jeśli mapowanie zostało zainicjowane z jawnie zdefiniowanymi opcjami uwierzytelniania, a ustawienieAuthenticationOptions nie zostało wcześniej nazwane, zostanie automatycznie wywołane przez konstruktora mapy.
setDomain(string)	Ustawia domenę domyślną używaną przez moduły mapy i usługi, chyba że domena jest jawnie określona podczas korzystania z tych części interfejsu API. Jeśli mapa zostanie zainicjowana z jawnie zdefiniowaną domeną, a parametr setDomain nie został wcześniej nazwany, zostanie automatycznie wywołany przez konstruktora mapy. Jeśli protokół nie zostanie określony https zostanie przyjęty.
setLanguage(string)	Ustawia domyślny język używany przez moduły mapy i usługi, chyba że język jest jawnie określony podczas korzystania z tych części interfejsu API. Jeśli mapa zostanie zainicjowana z jawnie zdefiniowanym językiem, a właściwość setLanguage nie została wcześniej nazwana, zostanie automatycznie wywołana przez konstruktora mapy.
setMaxParallelImageRequests(number)	Ustawia maksymalną liczbę obrazów (kafelki rastrowe, sprites, ikony) do równoległego ładowania, co wpływa na wydajność map z dużymi rasterami. Domyślnie 16.
setSessionId(string)	Ustawia domyślny identyfikator sesji używany przez moduły mapy i usługi, chyba że identyfikator sesji jest jawnie określony podczas korzystania z tych części interfejsu API. Jeśli mapowanie jest inicjowane z jawnie zdefiniowanym identyfikatorem sesji, a identyfikator setSessionId nie został wcześniej wywołany, zostanie automatycznie wywołany przez konstruktora mapy.
setSubscriptionKey(string)	Ustawia klucz subskrypcji usługi Azure Maps jako domyślny klucz subskrypcji w przestrzeni nazw atlasu, która jest używana przez kontrolkę mapy i wszystkie moduły wysyłające żądania do usług Azure Maps. Jeśli mapa zostanie zainicjowana przy użyciu jawnie zdefiniowanego klucza subskrypcji, a właściwość setSubscriptionKey nie została wcześniej wywołana, zostanie automatycznie wywołana przez konstruktora mapy.
setUserRegion(string)
setView(string)	Określa, który zestaw geopolitycznie spornych obramowań i etykiet są wyświetlane na mapie. Parametr View (nazywany również "parametrem regionu użytkownika") to dwuliterowy kod kraju ISO-3166, który będzie wyświetlać poprawne mapy dla tego kraju/regionu. Kraj/regiony, które nie znajdują się na liście Widok lub jeśli nieokreślone zostaną domyślne dla widoku "Ujednolicony". Zobacz obsługiwane [widoki]{@link https://aka.ms/AzureMapsLocalizationViews }. Twoim zadaniem jest określenie lokalizacji użytkowników, a następnie poprawne ustawienie parametru Wyświetl dla tej lokalizacji. Parametr View w usłudze Azure Maps musi być używany zgodnie z obowiązującymi przepisami, w tym z przepisami dotyczącymi mapowania kraju/regionu, w którym udostępniane są mapy, obrazy i inne dane oraz zawartość innych firm, do których masz uprawnienia dostępu za pośrednictwem usługi Azure Maps.
setWorkerCount(number)	Ustawia liczbę procesów roboczych sieci Web, które są tworzone na stronie. Domyślnie jest ustawiona na połowę liczby rdzeni procesora CPU (ograniczona do 6).

Szczegóły funkcji

addImageTemplate(string, string, boolean)

Dodaje szablon obrazu do przestrzeni nazw atlasu.

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

Parametry

templateName

string

Nazwa szablonu.

template

string

Szablon SVG do dodania. Obsługuje {color}, {secondaryColor}, {scale}, {text}.

override

boolean

Określa, czy należy zastąpić istniejące szablony, jeśli jeden o tej samej nazwie już istnieje.

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

Dodaje niestandardową funkcję zasobu ładowania, która będzie wywoływana podczas korzystania z adresu URL rozpoczynającego się od niestandardowego schematu adresu URL.

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

Parametry

customProtocol

string

protokół zaczepienia, na przykład "niestandardowy"

loadFn

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

funkcja do użycia podczas próby pobrania kafelka określonego przez kolumnę customProtocol

clearPrewarmedResources()

Czyści zasoby, które zostały wcześniej utworzone przez atlas.prewarm(). Należy pamiętać, że zwykle nie jest to konieczne. Tę funkcję należy wywołać tylko wtedy, gdy oczekujesz, że użytkownik aplikacji nie powróci do widoku mapy w żadnym momencie w aplikacji.

function clearPrewarmedResources()

getAllImageTemplateNames()

Pobiera tablicę nazw dla wszystkich szablonów obrazów dostępnych w przestrzeni nazw atlasu.

function getAllImageTemplateNames(): string[]

Zwraca

string[]

getAuthenticationOptions()

Pobiera domyślne opcje uwierzytelniania, które zostały podane. Jeśli nie ustawiono wcześniej wszystkich właściwości, będą niezdefiniowane.

function getAuthenticationOptions(): AuthenticationOptions

Zwraca

AuthenticationOptions

getDomain()

Pobiera udostępnioną domenę domyślną. Jeśli wartość domyślna nie zostanie wcześniej ustawiona "atlas.microsoft.com".

function getDomain(): string

Zwraca

string

getImageTemplate(string, number)

Pobiera szablon SVG według nazwy.

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

Parametry

templateName

string

Nazwa szablonu do pobrania.

scale

number

Określa, ile ma być skalowany szablon. Aby uzyskać najlepsze wyniki, przeprowadź skalowanie ikony do maksymalnego rozmiaru, który chcesz wyświetlić na mapie, a następnie użyj opcji rozmiaru ikon symboli, aby skalować w dół w razie potrzeby. Spowoduje to zmniejszenie rozmycia ze względu na skalowanie. Ustawienie domyślne: 1

Zwraca

string

getLanguage()

Pobiera podany język domyślny. Jeśli wartość domyślna nie zostanie wcześniej ustawiona "NGT".

function getLanguage(): string

Zwraca

string

getMaxParallelImageRequests()

Pobiera maksymalną liczbę obrazów (kafelki rastrowe, sprites, ikony) do równoległego ładowania

function getMaxParallelImageRequests(): number

Zwraca

number

getSessionId()

Pobiera domyślny identyfikator sesji, który został podany. Jeśli wartość domyślna nie zostanie wcześniej ustawiona, jest losowym identyfikatorem UUID.

function getSessionId(): string

Zwraca

string

getSubscriptionKey()

Pobiera domyślny klucz subskrypcji usługi Azure Maps, który został podany.

function getSubscriptionKey(): string

Zwraca

string

getUserRegion()

Ostrzeżenie

Ten interfejs API jest już przestarzały.

use atlas.getView() instead

function getUserRegion(): string

Zwraca

string

getVersion()

Bieżący numer wersji interfejsu API na podstawie numeru kompilacji.

function getVersion(): string

Zwraca

string

getView()

Pobiera domyślne ustawienie widoku kontrolki mapy. Jeśli wartość domyślna nie zostanie wcześniej ustawiona undefined.

function getView(): string

Zwraca

string

getWorkerCount()

Pobiera liczbę procesów roboczych, która zostanie utworzona.

function getWorkerCount(): number

Zwraca

number

isSupported(boolean)

Sprawdza, czy przeglądarka użytkownika jest obsługiwana przez kontrolkę mapy.

function isSupported(failIfMajorPerformanceCaveat?: boolean): boolean

Parametry

failIfMajorPerformanceCaveat

boolean

Jeśli wartość true funkcja zwróci wartość false, jeśli wydajność kontrolki mapy będzie znacznie gorzej niż oczekiwano (np. programowy moduł renderowania WebGL będzie używany).

Zwraca

boolean

prewarm()

Inicjuje zasoby, takie jak WebWorkers, które mogą być współużytkowane między mapami, aby zmniejszyć czas ładowania w niektórych sytuacjach. atlas.setWorkerCount, jeśli są używane, należy ustawić przed wywołaniem prewarm(), aby mieć efekt. Domyślnie cykl życia tych zasobów jest zarządzany automatycznie i są one leniwie inicjowane po pierwszym utworzeniu mapy. Wywołując prewarm(), te zasoby zostaną utworzone przed upływem czasu i nie zostaną wyczyszczone po usunięciu ostatniej mapy ze strony. Dzięki temu mogą być ponownie używane przez nowe wystąpienia map, które są tworzone później. Można je wyczyścić ręcznie, wywołując atlas.clearPrewarmedResources(). Jest to konieczne tylko wtedy, gdy strona internetowa pozostanie aktywna, ale całkowicie przestanie korzystać z map.

Jest to przydatne przede wszystkim w przypadku używania map GL-JS w aplikacji jednostronicowej, w której użytkownik będzie przechodził między różnymi widokami, co może spowodować, że wystąpienia mapy będą stale tworzone i niszczone.

function prewarm()

removeProtocol(string)

Usuwa wcześniej dodany protokół w wątku głównym.

function removeProtocol(customProtocol: string)

Parametry

customProtocol

string

protokół niestandardowy do usunięcia rejestracji

setAuthenticationOptions(AuthenticationOptions)

Ustawia opcje uwierzytelniania jako opcje domyślne w przestrzeni nazw atlas, która jest używana przez kontrolkę mapy i wszystkie moduły, które wysyłają żądania do usług Azure Maps. Jeśli mapowanie zostało zainicjowane z jawnie zdefiniowanymi opcjami uwierzytelniania, a ustawienieAuthenticationOptions nie zostało wcześniej nazwane, zostanie automatycznie wywołane przez konstruktora mapy.

function setAuthenticationOptions(options: AuthenticationOptions)

Parametry

options

AuthenticationOptions

Nowe domyślne opcje uwierzytelniania.

setDomain(string)

Ustawia domenę domyślną używaną przez moduły mapy i usługi, chyba że domena jest jawnie określona podczas korzystania z tych części interfejsu API. Jeśli mapa zostanie zainicjowana z jawnie zdefiniowaną domeną, a parametr setDomain nie został wcześniej nazwany, zostanie automatycznie wywołany przez konstruktora mapy. Jeśli protokół nie zostanie określony https zostanie przyjęty.

function setDomain(domain: string)

Parametry

domain

string

Nowa domena domyślna.

setLanguage(string)

Ustawia domyślny język używany przez moduły mapy i usługi, chyba że język jest jawnie określony podczas korzystania z tych części interfejsu API. Jeśli mapa zostanie zainicjowana z jawnie zdefiniowanym językiem, a właściwość setLanguage nie została wcześniej nazwana, zostanie automatycznie wywołana przez konstruktora mapy.

function setLanguage(language: string)

Parametry

language

string

Nowy język domyślny.

setMaxParallelImageRequests(number)

Ustawia maksymalną liczbę obrazów (kafelki rastrowe, sprites, ikony) do równoległego ładowania, co wpływa na wydajność map z dużymi rasterami. Domyślnie 16.

function setMaxParallelImageRequests(maxParallelImageRequests: number)

Parametry

maxParallelImageRequests

number

Maksymalna liczba obrazów do załadowania równolegle.

setSessionId(string)

Ustawia domyślny identyfikator sesji używany przez moduły mapy i usługi, chyba że identyfikator sesji jest jawnie określony podczas korzystania z tych części interfejsu API. Jeśli mapowanie jest inicjowane z jawnie zdefiniowanym identyfikatorem sesji, a identyfikator setSessionId nie został wcześniej wywołany, zostanie automatycznie wywołany przez konstruktora mapy.

function setSessionId(id: string)

Parametry

id

string

Nowy identyfikator sesji domyślnej.

setSubscriptionKey(string)

Ustawia klucz subskrypcji usługi Azure Maps jako domyślny klucz subskrypcji w przestrzeni nazw atlasu, która jest używana przez kontrolkę mapy i wszystkie moduły wysyłające żądania do usług Azure Maps. Jeśli mapa zostanie zainicjowana przy użyciu jawnie zdefiniowanego klucza subskrypcji, a właściwość setSubscriptionKey nie została wcześniej wywołana, zostanie automatycznie wywołana przez konstruktora mapy.

function setSubscriptionKey(key: string)

Parametry

key

string

Nowy domyślny klucz subskrypcji.

setUserRegion(string)

Ostrzeżenie

Ten interfejs API jest już przestarzały.

use atlas.setView(view: string) instead.

function setUserRegion(userRegion: string)

Parametry

userRegion

string

setView(string)

Określa, który zestaw geopolitycznie spornych obramowań i etykiet są wyświetlane na mapie. Parametr View (nazywany również "parametrem regionu użytkownika") to dwuliterowy kod kraju ISO-3166, który będzie wyświetlać poprawne mapy dla tego kraju/regionu. Kraj/regiony, które nie znajdują się na liście Widok lub jeśli nieokreślone zostaną domyślne dla widoku "Ujednolicony". Zobacz obsługiwane [widoki]{@link https://aka.ms/AzureMapsLocalizationViews }. Twoim zadaniem jest określenie lokalizacji użytkowników, a następnie poprawne ustawienie parametru Wyświetl dla tej lokalizacji. Parametr View w usłudze Azure Maps musi być używany zgodnie z obowiązującymi przepisami, w tym z przepisami dotyczącymi mapowania kraju/regionu, w którym udostępniane są mapy, obrazy i inne dane oraz zawartość innych firm, do których masz uprawnienia dostępu za pośrednictwem usługi Azure Maps.

function setView(view: string)

Parametry

view

string

Nowy widok domyślny

setWorkerCount(number)

Ustawia liczbę procesów roboczych sieci Web, które są tworzone na stronie. Domyślnie jest ustawiona na połowę liczby rdzeni procesora CPU (ograniczona do 6).

function setWorkerCount(workerCount: number)

Parametry

workerCount

number

liczba procesów roboczych.