atlas module

Paket:

azure-maps-control

Klassen

EventManager	Ein Manager für die Ereignisse des Kartensteuerelements. Durch die Ereigniseigenschaft des Atlas verfügbar gemacht. Kartenklasse. Der Benutzer kann nicht instanziiert werden.
HtmlMarker	Diese Klasse umschließt ein HTML-Element, das auf der Karte angezeigt werden kann.
Map	Das Steuerelement für eine visuelle und interaktive Webkarte.
Pixel	Stellt eine Pixelkoordinate oder einen Offset dar. Erweitert ein Array von [x, y].
Popup	Ein Informationsfenster, das an einer bestimmten Position auf einer Karte verankert ist.
PopupTemplate	Eine Layoutvorlage für ein Popup.
Shape	Eine Hilfsklasse, die eine Geometrie oder ein Feature umschließt und das Aktualisieren und Warten erleichtert.

Schnittstellen

AggregateExpression	Ein Aggregatausdruck definiert eine Berechnung, die über eine Datenmenge verarbeitet wird. Schema: [operator: string, initialValue?: boolean | number, mapExpression: Expression] operator: An expression function that is then applied to against all values calculated by the mapExpression for each point in the cluster. Unterstützte Operatoren: o Für Zahlen: +, *, max, min o For Booleans: all, any initialValue: Optional, ein Anfangswert, in dem der erste berechnete Wert aggregiert wird. mapExpression: Ein Ausdruck, der für jeden Punkt im Dataset angewendet wird.
AnimationOptions	Die Optionen zum Animieren von Änderungen an der Kamera des Kartensteuerelements.
AuthenticationManager	Ein Manager für die Authentifizierung des Kartensteuerelements. Durch die Authentifizierungseigenschaft des Atlas verfügbar gemacht. Kartenklasse. Der Benutzer kann nicht instanziiert werden.
AuthenticationOptions	Optionen zum Angeben der Authentifizierung des Kartensteuerelements bei den Azure Maps-Diensten.
BubbleLayerOptions	Optionen, die beim Rendern von Point-Objekten in einem BubbleLayer verwendet werden.
CameraBoundsOptions	Die Optionen zum Festlegen der Grenzen der Kamera des Kartensteuerelements.
CameraOptions	Die Optionen zum Festlegen der Kamera des Kartensteuerelements.
ClusteredProperties	Die Eigenschaften, die für ClusteredProperties vorhanden sind
CompassControlOptions	Die Optionen für ein CompassControl-Objekt.
Control	Eine Schnittstelle zum Definieren eines Steuerelements der Karte.
ControlManager	Ein Manager für die Steuerelemente des Kartensteuerelements. Durch die Steuerelementeigenschaft des Atlas verfügbar gemacht. Kartenklasse. Der Benutzer kann nicht instanziiert werden.
ControlOptions	Die Optionen zum Hinzufügen eines Steuerelements zur Karte.
DataSourceOptions	Eine Datenquelle zum Verwalten von Shape-Daten, die auf der Karte angezeigt werden. Eine Datenquelle muss einer Ebene hinzugefügt werden, bevor sie auf der Karte sichtbar ist. Optionen für eine DataSourceOptions.
ElevationTileSourceOptions
FullscreenControlOptions	Die Optionen für ein FullscreenControl-Objekt.
HeatMapLayerOptions	Optionen, die beim Rendern von Point-Objekten in einer HeatMapLayer verwendet werden.
HtmlMarkerEvents
HtmlMarkerManager	Ein Manager für die HTML-Markierungen des Kartensteuerelements. Durch die Markereigenschaft des Atlas verfügbar gemacht. Kartenklasse. Der Benutzer kann nicht instanziiert werden.
HtmlMarkerOptions	Optionen zum Rendern eines HtmlMarker-Objekts
HyperLinkFormatOptions	Option "Formatieren" für Hyperlinkzeichenfolgen.
IconOptions	Optionen zum Anpassen der Symbole in einem SymbolLayer
ImageLayerOptions	Optionen, die beim Rendern von Point-Objekten in einem ImageLayer verwendet werden.
ImageSpriteManager	Ein Manager für das Image sprite des Kartensteuerelements. Durch die imageSprite-Eigenschaft des Atlas verfügbar gemacht. Kartenklasse. Der Benutzer kann nicht instanziiert werden.
LayerManager	Ein Manager für die Ebenen des Kartensteuerelements. Durch die Schichteneigenschaft des Atlas ausgesetzt. Kartenklasse. Der Benutzer kann nicht instanziiert werden.
LayerOptions	Eine Basisklasse, von der alle anderen Layeroptionen erben.
LightOptions	Die Optionen für die Beleuchtung der Karte.
LineLayerOptions	Optionen, die beim Rendern von SimpleLine-, SimplePolygon-, CirclePolygon-, LineString-, MultiLineString-, Polygon- und MultiPolygon-Objekten in einer Linienebene verwendet werden.
MapConfiguration	Stellt den Inhalt der Kartenkonfiguration dar, der eine Liste der verfügbaren Formatvorlagen enthält.
MapConfigurationStyle	Stellt die Informationen für eine einzelne Formatvorlage dar.
MapDataEvent	Ereignisobjekt, das von den Zuordnungen zurückgegeben wird, wenn ein Datenereignis auftritt.
MapErrorEvent	Ereignisobjekt, das von den Zuordnungen zurückgegeben wird, wenn ein Fehlerereignis auftritt.
MapEvent	Ereignisobjekt, das von den Zuordnungen zurückgegeben wird, wenn ein grundlegendes Ereignis auftritt.
MapMouseEvent	Ereignisobjekt, das von den Zuordnungen zurückgegeben wird, wenn ein Mausereignis auftritt.
MapMouseWheelEvent	Ereignisobjekt, das von den Zuordnungen zurückgegeben wird, wenn ein Radereignis auftritt.
MapTouchEvent	Ereignisobjekt, das von den Zuordnungen zurückgegeben wird, wenn ein Touchereignis auftritt.
MediaLayerOptions	Optionen, die beim Rendern von Canvas-, Bild-, Rasterkachel- und Videoebenen verwendet werden
Options
Padding	Stellt den Abstand in Pixel dar, der zur Seite eines BoundingBox-Steuerelements hinzugefügt werden soll, wenn die Kamera einer Karte festgelegt wird.
PitchControlOptions	Die Optionen für ein PitchControl-Objekt.
PolygonExtrusionLayerOptions	Optionen, die beim Rendern von Polygon und MultiPolygon Objekten in einem PolygonExtrusionLayerverwendet werden.
PolygonLayerOptions	Optionen, die beim Rendern von Polygon- und MultiPolygon-Objekten in einem PolygonLayer verwendet werden.
PopupEvents
PopupManager	Ein Manager für die Popups des Kartensteuerelements. Wird über die popups-Eigenschaft der atlas.Map Klasse verfügbar gemacht. Der Benutzer kann nicht instanziiert werden.
PopupOptions	Die Optionen für ein Popup.
Properties	Eine Reihe von Eigenschaften, die mit einem PopupTemplate verwendet werden können
PropertyInfo	Artendetails, wie eine Eigenschaft angezeigt werden soll.
RasterTileSourceOptions
RequestParameters	Dies ist der Objekttyp, der vom transformRequest-Rückruf zurückgegeben werden soll.
ScaleControlOptions	Die Optionen für ein ScaleControl-Objekt.
ServiceOptions	Globale Eigenschaften, die in allen Atlas-Serviceanfragen verwendet werden.
ShapeEvents
SourceManager	Ein Manager für die Quellen des Kartensteuerelements. Durch die Quelleneigenschaft des Atlas verfügbar gemacht. Kartenklasse. Der Benutzer kann nicht instanziiert werden.
StyleChangedEvent	Ereignisobjekt, das von der Karte zurückgegeben wird, nachdem eine neue Formatvorlage geladen wurde.
StyleControlOptions	Die Optionen für ein StyleControl-Objekt.
StyleOptions	Die Optionen für den Kartenstil.
SymbolLayerOptions	Optionen, die beim Rendern von Geometrien in einem SymbolLayer verwendet werden.
TargetedEvent
TextOptions	Optionen zum Anpassen des Texts in einem SymbolLayer
Tile	Kachelobjekt, das von der Zuordnung zurückgegeben wird, wenn ein Quelldatenereignis auftritt.
TileId
TileLayerOptions	Optionen, die beim Rendern von rastergekachelten Bildern in einem TileLayer verwendet werden.
TrafficControlOptions
TrafficOptions	Die Optionen zum Festlegen des Datenverkehrs auf der Karte.
UserInteractionOptions	Die Optionen zum Aktivieren/Deaktivieren der Benutzerinteraktion mit der Karte.
VectorTileSourceOptions	Eine Datenquelle zum Verwalten von Shape-Daten, die auf der Karte angezeigt werden. Eine Datenquelle muss einer Ebene hinzugefügt werden, bevor sie auf der Karte sichtbar ist. Optionen für eine VectorTileSource.
WebGLLayerOptions	Optionen zum Rendern von Grafiken in einem WebGLLayer.
WebGLRenderer	Schnittstelle zum Rendern von WebGL-Grafiken in einem WebGLLayer.
ZoomControlOptions	Die Optionen für ein ZoomControl-Objekt.

Typaliase

Expression	Kann als Wert des Filters oder bestimmter Layeroptionen angegeben werden. Ein Ausdruck definiert eine Formel zum Berechnen des Werts der Eigenschaft. Ausdrücke werden als JSON-Arrays dargestellt. Das erste Element eines Ausdrucks ist eine Zeichenfolge, die den Ausdrucksoperator benennt.
getAuthTokenCallback	Die Rückruffunktion, die zum Abrufen eines Authentifizierungstokens im Modus für die anonyme Authentifizierung verwendet wird. Beheben Sie das Authentifizierungstoken, oder lehnen Sie alle Fehler ab.
ResourceType
StyleImageMetadata	Signatur für den options Parameter, der an ImageSpriteManager.addübergeben wird.

Enumerationen

AuthenticationType	Eine Aufzählung, die zum Angeben des zu verwendenden Authentifizierungsmechanismus verwendet wird.
ControlPosition	Positionen, an denen das Steuerelement auf der Karte platziert werden kann.
ControlStyle	Verfügbare Formatvorlagen für ein Steuerelement.

Functions

addImageTemplate(string, string, boolean)	Fügt dem Atlas-Namespace eine Bildvorlage hinzu.
addProtocol(string, (args: any[]) => Promise<any>)	Fügt eine benutzerdefinierte Load-Ressourcenfunktion hinzu, die aufgerufen wird, wenn eine URL verwendet wird, die mit einem benutzerdefinierten URL-Schema beginnt.
clearPrewarmedResources()	Löscht Ressourcen, die zuvor von atlas.prewarm()erstellt wurden. Beachten Sie, dass dies in der Regel nicht erforderlich ist. Sie sollten diese Funktion nur aufrufen, wenn der Benutzer Ihrer App zu einem beliebigen Zeitpunkt in Ihrer Anwendung nicht zu einer Kartenansicht zurückkehrt.
getAllImageTemplateNames()	Ruft ein Array von Namen für alle Bildvorlagen ab, die im Atlas-Namespace verfügbar sind.
getAuthenticationOptions()	Ruft die Standardauthentifizierungsoptionen ab, die bereitgestellt wurden. Wenn noch nicht alle Eigenschaften festgelegt wurden, werden nicht definiert.
getDomain()	Ruft die Standarddomäne ab, die bereitgestellt wurde. Wenn der Standardwert nicht zuvor festgelegt wurde, ist "atlas.microsoft.com".
getImageTemplate(string, number)	Ruft eine SVG-Vorlage anhand des Namens ab.
getLanguage()	Ruft die Standardsprache ab, die bereitgestellt wurde. Wenn der Standardwert nicht zuvor festgelegt wurde, ist "NGT".
getMaxParallelImageRequests()	Ruft die maximale Anzahl von Bildern (Rasterkacheln, Sprites, Symbole) ab, die parallel geladen werden sollen.
getSessionId()	Ruft die Standardsitzungs-ID ab, die bereitgestellt wurde. Wenn der Standardwert nicht zuvor festgelegt wurde, handelt es sich um eine zufällige UUID.
getSubscriptionKey()	Ruft den standardmäßigen Azure Maps-Abonnementschlüssel ab, der bereitgestellt wurde.
getUserRegion()
getVersion()	Aktuelle API-Versionsnummer basierend auf der Buildnummer.
getView()	Ruft die Standardansichtseinstellung des Kartensteuerelements ab. Wenn der Standardwert nicht zuvor festgelegt wurde, ist undefined.
getWorkerCount()	Ruft die Arbeitsanzahl ab, die erstellt wird.
isSupported(boolean)	Überprüft, ob der Browser des Benutzers vom Kartensteuerelement unterstützt wird.
prewarm()	Initialisiert Ressourcen wie WebWorkers, die in einigen Situationen über Karten hinweg freigegeben werden können, um die Ladezeiten zu verringern. atlas.setWorkerCountmuss bei Verwendung festgelegt werden, bevor prewarm() aufgerufen wird, um einen Effekt zu haben. Standardmäßig wird der Lebenszyklus dieser Ressourcen automatisch verwaltet, und sie werden beim ersten Erstellen einer Karte lazily initialisiert. Durch Aufrufen von prewarm()werden diese Ressourcen vorab erstellt und nicht gelöscht, wenn die letzte Karte von der Seite entfernt wird. Auf diese Weise können sie von neuen Karteninstanzen wiederverwendet werden, die später erstellt werden. Sie können manuell gelöscht werden, indem sie atlas.clearPrewarmedResources()aufrufen. Dies ist nur erforderlich, wenn Ihre Webseite aktiv bleibt, aber die Verwendung von Karten insgesamt beendet. Dies ist in erster Linie nützlich, wenn GL-JS Karten in einer einzelnen Seiten-App verwendet werden, wobei ein Benutzer zwischen verschiedenen Ansichten navigiert, die dazu führen können, dass Karteninstanzen ständig erstellt und zerstört werden.
removeProtocol(string)	Entfernt ein zuvor hinzugefügtes Protokoll im Hauptthread.
setAuthenticationOptions(AuthenticationOptions)	Legt Ihre Authentifizierungsoptionen als Standardoptionen im Atlas-Namespace fest, der vom Kartensteuerelement und allen Modulen verwendet wird, die Anforderungen an die Azure-Kartendienste stellen. Wenn eine Karte mit den explizit definierten Authentifizierungsoptionen initialisiert wird und setAuthenticationOptions zuvor nicht aufgerufen wurde, wird sie automatisch vom Map-Konstruktor aufgerufen.
setDomain(string)	Legt die Standarddomäne fest, die von den Karten- und Dienstmodulen verwendet wird, es sei denn, die Domäne wird explizit angegeben, wenn diese Teile der API verwendet werden. Wenn eine Zuordnung mit der domäne explizit definiert wurde und setDomain noch nicht aufgerufen wurde, wird sie automatisch vom Map-Konstruktor aufgerufen. Wenn das Protokoll nicht angegeben wird, wird https angenommen.
setLanguage(string)	Legt die Standardsprache fest, die von den Karten- und Dienstmodulen verwendet wird, es sei denn, die Sprache wird explizit angegeben, wenn diese Teile der API verwendet werden. Wenn eine Karte mit der explizit definierten Sprache initialisiert wird und "setLanguage" zuvor noch nicht aufgerufen wurde, wird sie automatisch vom Map-Konstruktor aufgerufen.
setMaxParallelImageRequests(number)	Legt die maximale Anzahl von Bildern (Rasterkacheln, Sprites, Symbole) fest, die parallel geladen werden sollen, was sich auf die Leistung in rasterlastigen Karten auswirkt. 16 standardmäßig.
setSessionId(string)	Legt die standardsitzungs-ID fest, die von den Karten- und Dienstmodulen verwendet wird, es sei denn, die Sitzungs-ID wird explizit angegeben, wenn diese Teile der API verwendet werden. Wenn eine Karte mit der explizit definierten Sitzungs-ID initialisiert wird und setSessionId zuvor noch nicht aufgerufen wurde, wird sie automatisch vom Map-Konstruktor aufgerufen.
setSubscriptionKey(string)	Legt Ihren Azure Maps-Abonnementschlüssel als Standardabonnementschlüssel im Atlasnamespace fest, der vom Kartensteuerelement und allen Modulen verwendet wird, die Anforderungen an die Azure-Kartendienste stellen. Wenn eine Karte mit dem explizit definierten Abonnementschlüssel initialisiert wird und setSubscriptionKey zuvor nicht aufgerufen wurde, wird sie automatisch vom Map-Konstruktor aufgerufen.
setUserRegion(string)
setView(string)	Gibt an, welche Geopolitischen Grenzen und Bezeichnungen auf der Karte angezeigt werden. Der Parameter "View" (auch als "User Region Parameter" bezeichnet) ist ein 2-Buchstaben ISO-3166-Ländercode, der die richtigen Karten für dieses Land/diese Region anzeigt. Land/Regionen, die sich nicht in der Ansichtsliste befinden oder wenn nicht angegeben, wird standardmäßig die Ansicht "Unified" angezeigt. Siehe die unterstützten [Ansichten]{@link https://aka.ms/AzureMapsLocalizationViews }. Es liegt in Ihrer Verantwortung, den Standort Ihrer Benutzer zu bestimmen und dann den Parameter "View" für diesen Speicherort korrekt festzulegen. Der Parameter "View" in Azure Maps muss in Übereinstimmung mit den geltenden Gesetzen verwendet werden, einschließlich derjenigen bezüglich der Zuordnung des Landes/der Region, in dem Karten, Bilder und andere Daten und Inhalte von Drittanbietern, die Sie für den Zugriff über Azure Maps autorisiert sind, verfügbar gemacht werden.
setWorkerCount(number)	Legt die Anzahl von Web-Workern fest, die auf einer Seite instanziiert werden. Standardmäßig ist sie auf die Hälfte der Anzahl der CPU-Kerne festgelegt (mit 6 begrenzt).

Details zur Funktion

addImageTemplate(string, string, boolean)

Fügt dem Atlas-Namespace eine Bildvorlage hinzu.

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

Parameter

templateName

string

Der Name der Vorlage.

template

string

Die hinzuzufügende SVG-Vorlage. Unterstützt {color}, {secondaryColor}, {scale}, {text}.

override

boolean

Gibt an, ob vorhandene Vorlagen außer Kraft setzen sollen, wenn bereits ein Vorlagen mit demselben Namen vorhanden ist.

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

Fügt eine benutzerdefinierte Load-Ressourcenfunktion hinzu, die aufgerufen wird, wenn eine URL verwendet wird, die mit einem benutzerdefinierten URL-Schema beginnt.

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

Parameter

customProtocol

string

das Zu hook-Protokoll, z. B. "benutzerdefiniert".

loadFn

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

die Funktion, die beim Abrufen einer durch das customProtocol angegebenen Kachel verwendet werden soll

clearPrewarmedResources()

Löscht Ressourcen, die zuvor von atlas.prewarm()erstellt wurden. Beachten Sie, dass dies in der Regel nicht erforderlich ist. Sie sollten diese Funktion nur aufrufen, wenn der Benutzer Ihrer App zu einem beliebigen Zeitpunkt in Ihrer Anwendung nicht zu einer Kartenansicht zurückkehrt.

function clearPrewarmedResources()

getAllImageTemplateNames()

Ruft ein Array von Namen für alle Bildvorlagen ab, die im Atlas-Namespace verfügbar sind.

function getAllImageTemplateNames(): string[]

Gibt zurück

string[]

getAuthenticationOptions()

Ruft die Standardauthentifizierungsoptionen ab, die bereitgestellt wurden. Wenn noch nicht alle Eigenschaften festgelegt wurden, werden nicht definiert.

function getAuthenticationOptions(): AuthenticationOptions

Gibt zurück

AuthenticationOptions

getDomain()

Ruft die Standarddomäne ab, die bereitgestellt wurde. Wenn der Standardwert nicht zuvor festgelegt wurde, ist "atlas.microsoft.com".

function getDomain(): string

Gibt zurück

string

getImageTemplate(string, number)

Ruft eine SVG-Vorlage anhand des Namens ab.

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

Parameter

templateName

string

Der Name der abzurufenden Vorlage.

scale

number

Gibt an, wie viel die Vorlage skaliert werden soll. Um optimale Ergebnisse zu erzielen, skalieren Sie das Symbol auf die maximale Größe, die Sie auf der Karte anzeigen möchten, und verwenden Sie dann die Symbolebenen-Symbolgrößenoption, um bei Bedarf nach unten zu skalieren. Dadurch wird die Verschwommenheit aufgrund der Skalierung reduziert. Standard: 1

Gibt zurück

string

getLanguage()

Ruft die Standardsprache ab, die bereitgestellt wurde. Wenn der Standardwert nicht zuvor festgelegt wurde, ist "NGT".

function getLanguage(): string

Gibt zurück

string

getMaxParallelImageRequests()

Ruft die maximale Anzahl von Bildern (Rasterkacheln, Sprites, Symbole) ab, die parallel geladen werden sollen.

function getMaxParallelImageRequests(): number

Gibt zurück

number

getSessionId()

Ruft die Standardsitzungs-ID ab, die bereitgestellt wurde. Wenn der Standardwert nicht zuvor festgelegt wurde, handelt es sich um eine zufällige UUID.

function getSessionId(): string

Gibt zurück

string

getSubscriptionKey()

Ruft den standardmäßigen Azure Maps-Abonnementschlüssel ab, der bereitgestellt wurde.

function getSubscriptionKey(): string

Gibt zurück

string

getUserRegion()

Warnung

Diese API ist nun veraltet.

use atlas.getView() instead

function getUserRegion(): string

Gibt zurück

string

getVersion()

Aktuelle API-Versionsnummer basierend auf der Buildnummer.

function getVersion(): string

Gibt zurück

string

getView()

Ruft die Standardansichtseinstellung des Kartensteuerelements ab. Wenn der Standardwert nicht zuvor festgelegt wurde, ist undefined.

function getView(): string

Gibt zurück

string

getWorkerCount()

Ruft die Arbeitsanzahl ab, die erstellt wird.

function getWorkerCount(): number

Gibt zurück

number

isSupported(boolean)

Überprüft, ob der Browser des Benutzers vom Kartensteuerelement unterstützt wird.

function isSupported(failIfMajorPerformanceCaveat?: boolean): boolean

Parameter

failIfMajorPerformanceCaveat

boolean

Wenn "true" die Funktion "false" zurückgibt, wäre die Leistung des Kartensteuerelements erheblich schlechter als erwartet (z. B. wird ein WebGL-Renderer verwendet).

Gibt zurück

boolean

prewarm()

Initialisiert Ressourcen wie WebWorkers, die in einigen Situationen über Karten hinweg freigegeben werden können, um die Ladezeiten zu verringern. atlas.setWorkerCountmuss bei Verwendung festgelegt werden, bevor prewarm() aufgerufen wird, um einen Effekt zu haben. Standardmäßig wird der Lebenszyklus dieser Ressourcen automatisch verwaltet, und sie werden beim ersten Erstellen einer Karte lazily initialisiert. Durch Aufrufen von prewarm()werden diese Ressourcen vorab erstellt und nicht gelöscht, wenn die letzte Karte von der Seite entfernt wird. Auf diese Weise können sie von neuen Karteninstanzen wiederverwendet werden, die später erstellt werden. Sie können manuell gelöscht werden, indem sie atlas.clearPrewarmedResources()aufrufen. Dies ist nur erforderlich, wenn Ihre Webseite aktiv bleibt, aber die Verwendung von Karten insgesamt beendet.

Dies ist in erster Linie nützlich, wenn GL-JS Karten in einer einzelnen Seiten-App verwendet werden, wobei ein Benutzer zwischen verschiedenen Ansichten navigiert, die dazu führen können, dass Karteninstanzen ständig erstellt und zerstört werden.

function prewarm()

removeProtocol(string)

Entfernt ein zuvor hinzugefügtes Protokoll im Hauptthread.

function removeProtocol(customProtocol: string)

Parameter

customProtocol

string

das benutzerdefinierte Protokoll zum Entfernen der Registrierung für

setAuthenticationOptions(AuthenticationOptions)

Legt Ihre Authentifizierungsoptionen als Standardoptionen im Atlas-Namespace fest, der vom Kartensteuerelement und allen Modulen verwendet wird, die Anforderungen an die Azure-Kartendienste stellen. Wenn eine Karte mit den explizit definierten Authentifizierungsoptionen initialisiert wird und setAuthenticationOptions zuvor nicht aufgerufen wurde, wird sie automatisch vom Map-Konstruktor aufgerufen.

function setAuthenticationOptions(options: AuthenticationOptions)

Parameter

options

AuthenticationOptions

Die neuen Standardauthentifizierungsoptionen.

setDomain(string)

Legt die Standarddomäne fest, die von den Karten- und Dienstmodulen verwendet wird, es sei denn, die Domäne wird explizit angegeben, wenn diese Teile der API verwendet werden. Wenn eine Zuordnung mit der domäne explizit definiert wurde und setDomain noch nicht aufgerufen wurde, wird sie automatisch vom Map-Konstruktor aufgerufen. Wenn das Protokoll nicht angegeben wird, wird https angenommen.

function setDomain(domain: string)

Parameter

domain

string

Die neue Standarddomäne.

setLanguage(string)

Legt die Standardsprache fest, die von den Karten- und Dienstmodulen verwendet wird, es sei denn, die Sprache wird explizit angegeben, wenn diese Teile der API verwendet werden. Wenn eine Karte mit der explizit definierten Sprache initialisiert wird und "setLanguage" zuvor noch nicht aufgerufen wurde, wird sie automatisch vom Map-Konstruktor aufgerufen.

function setLanguage(language: string)

Parameter

language

string

Die neue Standardsprache.

setMaxParallelImageRequests(number)

Legt die maximale Anzahl von Bildern (Rasterkacheln, Sprites, Symbole) fest, die parallel geladen werden sollen, was sich auf die Leistung in rasterlastigen Karten auswirkt. 16 standardmäßig.

function setMaxParallelImageRequests(maxParallelImageRequests: number)

Parameter

maxParallelImageRequests

number

Maximale Anzahl von Bildern, die parallel geladen werden sollen.

setSessionId(string)

Legt die standardsitzungs-ID fest, die von den Karten- und Dienstmodulen verwendet wird, es sei denn, die Sitzungs-ID wird explizit angegeben, wenn diese Teile der API verwendet werden. Wenn eine Karte mit der explizit definierten Sitzungs-ID initialisiert wird und setSessionId zuvor noch nicht aufgerufen wurde, wird sie automatisch vom Map-Konstruktor aufgerufen.

function setSessionId(id: string)

Parameter

id

string

Die neue Standardsitzungs-ID.

setSubscriptionKey(string)

Legt Ihren Azure Maps-Abonnementschlüssel als Standardabonnementschlüssel im Atlasnamespace fest, der vom Kartensteuerelement und allen Modulen verwendet wird, die Anforderungen an die Azure-Kartendienste stellen. Wenn eine Karte mit dem explizit definierten Abonnementschlüssel initialisiert wird und setSubscriptionKey zuvor nicht aufgerufen wurde, wird sie automatisch vom Map-Konstruktor aufgerufen.

function setSubscriptionKey(key: string)

Parameter

key

string

Der neue Standardabonnementschlüssel.

setUserRegion(string)

Warnung

Diese API ist nun veraltet.

use atlas.setView(view: string) instead.

function setUserRegion(userRegion: string)

Parameter

userRegion

string

setView(string)

Gibt an, welche Geopolitischen Grenzen und Bezeichnungen auf der Karte angezeigt werden. Der Parameter "View" (auch als "User Region Parameter" bezeichnet) ist ein 2-Buchstaben ISO-3166-Ländercode, der die richtigen Karten für dieses Land/diese Region anzeigt. Land/Regionen, die sich nicht in der Ansichtsliste befinden oder wenn nicht angegeben, wird standardmäßig die Ansicht "Unified" angezeigt. Siehe die unterstützten [Ansichten]{@link https://aka.ms/AzureMapsLocalizationViews }. Es liegt in Ihrer Verantwortung, den Standort Ihrer Benutzer zu bestimmen und dann den Parameter "View" für diesen Speicherort korrekt festzulegen. Der Parameter "View" in Azure Maps muss in Übereinstimmung mit den geltenden Gesetzen verwendet werden, einschließlich derjenigen bezüglich der Zuordnung des Landes/der Region, in dem Karten, Bilder und andere Daten und Inhalte von Drittanbietern, die Sie für den Zugriff über Azure Maps autorisiert sind, verfügbar gemacht werden.

function setView(view: string)

Parameter

view

string

Die neue Standardansicht

setWorkerCount(number)

Legt die Anzahl von Web-Workern fest, die auf einer Seite instanziiert werden. Standardmäßig ist sie auf die Hälfte der Anzahl der CPU-Kerne festgelegt (mit 6 begrenzt).

function setWorkerCount(workerCount: number)

Parameter

workerCount

number

Arbeitskraftanzahl.