atlas module
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 |
Reprezentuje 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 w zestawie danych.
Schemat: [operator: string, initialValue?: boolean | number, mapExpression: Expression] operator: Funkcja wyrażenia, która jest następnie stosowana do wszystkich wartości obliczonych przez |
AnimationOptions |
Opcje animowania zmieniają się 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 bąbelkowej. |
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 dla . |
ElevationTileSourceOptions | |
HeatMapLayerOptions |
Opcje używane podczas renderowania obiektów punktów w ramce 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 atlas. 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 dla 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 po wystąpieniu zdarzenia 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 |
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 |
PopupOptions |
Opcje wyskakującego okienka. |
Properties |
Zestaw właściwości, które mogą być używane z |
PropertyInfo |
Szczegóły gatunku dotyczące sposobu wyświetlania właściwości. |
RasterTileSourceOptions | |
RequestParameters |
Jest to typ obiektu, który ma zostać zwrócony przez wywołanie zwrotne transformRequest. |
ScaleControlOptions |
Opcje obiektu ScaleControl. |
ServiceOptions |
Globalne właściwości 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 rastrowych obrazów 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 dla . |
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 przekazanego |
Wyliczenia
AuthenticationType |
Wyliczenie używane do określania typu mechanizmu uwierzytelniania do użycia. |
ControlPosition |
Pozycje, w których kontrolkę można umieścić na mapie. |
ControlStyle |
Dostępne style dla kontrolki. |
Funkcje
add |
Dodaje szablon obrazu do przestrzeni nazw atlasu. |
clear |
Czyści zasoby, które zostały wcześniej utworzone przez |
get |
Pobiera tablicę nazw dla wszystkich szablonów obrazów dostępnych w przestrzeni nazw atlasu. |
get |
Pobiera domyślne opcje uwierzytelniania, które zostały podane. Jeśli nie ustawiono wcześniej wszystkich właściwości, nie zostaną zdefiniowane. |
get |
Pobiera udostępnioną domenę domyślną.
Jeśli nie ustawiono wcześniej wartości domyślnej to |
get |
Pobiera szablon SVG według nazwy. |
get |
Pobiera podany język domyślny.
Jeśli nie ustawiono wcześniej wartości domyślnej to |
get |
Pobiera maksymalną liczbę obrazów (kafelki rastrowe, sprites, ikony) do równoległego ładowania |
get |
Pobiera domyślny identyfikator sesji, który został podany. Jeśli nie ustawiono wcześniej wartości domyślnej jest losowym identyfikatorem UUID. |
get |
Pobiera domyślny klucz subskrypcji Azure Maps, który został podany. |
get |
|
get |
Bieżący numer wersji interfejsu API na podstawie numeru kompilacji. |
get |
Pobiera domyślne ustawienie widoku kontrolki mapy.
Jeśli nie ustawiono wcześniej wartości domyślnej to |
get |
Pobiera liczbę procesów roboczych, która zostanie utworzona. |
is |
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 przez mapy, aby zmniejszyć czas ładowania w niektórych sytuacjach. Jest to przydatne przede wszystkim w przypadku korzystania z map GL-JS w aplikacji jednostronicowej, w której użytkownik będzie przechodził między różnymi widokami, które mogą powodować ciągłe tworzenie i niszczenie wystąpień mapy. |
set |
Ustawia opcje uwierzytelniania jako domyślne opcje w przestrzeni nazw atlas, która jest używana przez kontrolkę mapy i wszystkie moduły wysyłające żądania do usług Azure Maps. Jeśli mapa jest inicjowana z jawnie zdefiniowanymi opcjami uwierzytelniania i zestawAuthenticationOptions nie został wcześniej wywołany, zostanie automatycznie wywołany przez konstruktora mapy. |
set |
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 wywołany, zostanie automatycznie wywołany przez konstruktora mapy.
Jeśli nie określono |
set |
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 jest inicjowana z jawnie zdefiniowanym językiem i zestawLanguage nie została wcześniej wywołana, zostanie automatycznie wywołana przez konstruktora mapy. |
set |
Ustawia maksymalną liczbę obrazów (kafelki rastrowe, sprites, ikony) do równoległego ładowania, co wpływa na wydajność map rastrowych. Domyślnie 16. |
set |
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 mapa zostanie zainicjowana z jawnie zdefiniowanym identyfikatorem sesji, a element setSessionId nie został wcześniej wywołany, zostanie automatycznie wywołany przez konstruktora mapy. |
set |
Ustawia klucz subskrypcji Azure Maps jako domyślny klucz subskrypcji w przestrzeni nazw atlas, która jest używana przez kontrolkę mapy i wszystkie moduły wysyłające żądania do usług Azure Maps. Jeśli mapa została zainicjowana z jawnie zdefiniowanym kluczem subskrypcji i element setSubscriptionKey nie został wcześniej wywołany, zostanie automatycznie wywołany przez konstruktora mapy. |
set |
|
set |
Określa, który zestaw spornych geopolitycznie granic 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 wartości domyślne to "Ujednolicony" Widok. 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 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 Azure Maps. |
set |
Ustawia liczbę procesów roboczych sieci Web, których wystąpienie jest tworzone na stronie. Domyślnie jest ustawiona na połowę liczbę 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 powinien zastąpić istniejące szablony, jeśli jeden o tej samej nazwie już istnieje.
clearPrewarmedResources()
Czyści zasoby, które zostały wcześniej utworzone przez atlas.prewarm()
program .
Należy pamiętać, że zazwyczaj 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, nie zostaną zdefiniowane.
function getAuthenticationOptions(): AuthenticationOptions
Zwraca
getDomain()
Pobiera udostępnioną domenę domyślną.
Jeśli nie ustawiono wcześniej wartości domyślnej to "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 należy skalować szablonu. Aby uzyskać najlepsze wyniki, przeprowadź skalowanie ikony do maksymalnego rozmiaru, który chcesz wyświetlić na mapie, a następnie użyj opcji rozmiaru ikony warstw symboli, aby w razie potrzeby skalować w dół. Spowoduje to zmniejszenie rozmycia ze względu na skalowanie. Ustawienie domyślne: 1
Zwraca
string
getLanguage()
Pobiera podany język domyślny.
Jeśli nie ustawiono wcześniej wartości domyślnej to "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 nie ustawiono wcześniej wartości domyślnej jest losowym identyfikatorem UUID.
function getSessionId(): string
Zwraca
string
getSubscriptionKey()
Pobiera domyślny klucz subskrypcji 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 nie ustawiono wcześniej wartości domyślnej to 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 gorsza niż oczekiwano (np. zostanie użyty programowy moduł renderowania WebGL).
Zwraca
boolean
prewarm()
Inicjuje zasoby, takie jak WebWorkers, które mogą być współużytkowane przez mapy, aby zmniejszyć czas ładowania w niektórych sytuacjach. atlas.setWorkerCount
, jeśli jest używany, należy ustawić przed prewarm()
wywołaniem , aby mieć efekt.
Domyślnie cykl życia tych zasobów jest zarządzany automatycznie i są one automatycznie inicjowane podczas tworzenia mapy. prewarm()
Wywołując polecenie , te zasoby zostaną utworzone z wyprzedzeniem 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 polecenie atlas.clearPrewarmedResources()
. Jest to konieczne tylko wtedy, gdy strona internetowa pozostaje aktywna, ale całkowicie przestaje korzystać z map.
Jest to przydatne przede wszystkim w przypadku korzystania z map GL-JS w aplikacji jednostronicowej, w której użytkownik będzie przechodził między różnymi widokami, które mogą powodować ciągłe tworzenie i niszczenie wystąpień mapy.
function prewarm()
setAuthenticationOptions(AuthenticationOptions)
Ustawia opcje uwierzytelniania jako domyślne opcje w przestrzeni nazw atlas, która jest używana przez kontrolkę mapy i wszystkie moduły wysyłające żądania do usług Azure Maps. Jeśli mapa jest inicjowana z jawnie zdefiniowanymi opcjami uwierzytelniania i zestawAuthenticationOptions nie został wcześniej wywołany, zostanie automatycznie wywołany 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 wywołany, zostanie automatycznie wywołany przez konstruktora mapy.
Jeśli nie określono https
protokołu, przyjmuje się, że.
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 jest inicjowana z jawnie zdefiniowanym językiem i zestawLanguage nie została wcześniej wywołana, 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 rastrowych. Domyślnie 16.
function setMaxParallelImageRequests(maxParallelImageRequests: number)
Parametry
- maxParallelImageRequests
-
number
Maksymalna liczba obrazów do równoległego ładowania.
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 mapa zostanie zainicjowana z jawnie zdefiniowanym identyfikatorem sesji, a element 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 Azure Maps jako domyślny klucz subskrypcji w przestrzeni nazw atlas, która jest używana przez kontrolkę mapy i wszystkie moduły wysyłające żądania do usług Azure Maps. Jeśli mapa została zainicjowana z jawnie zdefiniowanym kluczem subskrypcji i element setSubscriptionKey nie został wcześniej wywołany, zostanie automatycznie wywołany 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 spornych geopolitycznie granic 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 wartości domyślne to "Ujednolicony" Widok. 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 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 Azure Maps.
function setView(view: string)
Parametry
- view
-
string
Nowy widok domyślny
setWorkerCount(number)
Ustawia liczbę procesów roboczych sieci Web, których wystąpienie jest tworzone na stronie. Domyślnie jest ustawiona na połowę liczbę rdzeni procesora CPU (ograniczona do 6).
function setWorkerCount(workerCount: number)
Parametry
- workerCount
-
number
liczba procesów roboczych.