ServiceOptions interface

Paket:

azure-maps-control

Globale Eigenschaften, die in allen Atlas-Dienstanforderungen verwendet werden.

Extends

Options

Eigenschaften

authOptions	Die Authentifizierungsoptionen, die zum Anpassen der Authentifizierung des Kartensteuerelements bei Azure Maps-Diensten verwendet werden. Wenn diese Authentifizierungsoptionen angegeben sind, sollte ServiceOptions.subscriptionKey nicht sein. Empfehlen Sie stattdessen die Verwendung der Atlas.setAuthenticationOptions-Funktion.
disableTelemetry	Telemetriesammlung deaktivieren Diese Option kann nur beim Initialisieren der Karte festgelegt werden. default: false (true für die Azure Government Cloud)
domain	Die Domäne, die beim Anfordern von Kartenkacheln und anderen Azure Maps-Diensten verwendet werden soll. Wenn das Protokoll nicht angegeben https ist, wird angenommen. Empfehlen Sie stattdessen die Verwendung der Atlas.setDomain-Funktion.
enableAccessibility	Aktivieren Sie die Barrierefreiheitsfunktion, um Benutzern, die Schwierigkeiten beim Visualisieren der Webanwendung haben, Unterstützung für die Sprachausgabe bereitzustellen. Diese Eigenschaft ist standardmäßig auf true festgelegt.
enableAccessibilityLocationFallback	Aktivieren Sie das Fallback auf den REST-API-Geocoder, um die Barrierefreiheit von Speicherorten zu erkennen, wenn beim Extrahieren des Speicherorts aus Vektordaten ein Fehler auftritt. Das Deaktivieren dieser Option verhindert die Generierung von Geocodierungs-API-Anforderungen, kann jedoch zu einem Mangel an Standortinformationen für Sprachsprachausgaben führen. default: true
fadeDuration	Steuert die Dauer der Ein-/Ausblendungsanimation für Bezeichnungskollisionen in Millisekunden. Diese Einstellung wirkt sich auf alle Symbolebenen aus. Diese Einstellung wirkt sich nicht auf die Dauer von Laufzeitformatierungsübergängen oder Rasterkachel-Crossfading aus.
localIdeographFontFamily	Definiert eine CSS-Schriftartfamilie für die lokale Überschreibung der Generierung von Glyphen in den Bereichen "CJK Unified Ideographs", "Hiragana", "Katakana" und "Hangul Syllables". In diesen Bereichen werden Die Schriftarteinstellungen aus dem Format der Karte ignoriert, mit Ausnahme von Schlüsselwörtern mit Schriftgewichtung (light/regular/medium/bold). Legen Sie auf false fest, um Schriftarteinstellungen aus dem Format der Karte für diese Glyphenbereiche zu aktivieren. Der Zweck dieser Option besteht darin, bandbreitenintensive Glyphenserveranforderungen zu vermeiden.
mapConfiguration	Die Kartenkonfiguration definiert die für die Karte verfügbaren Stile.
maxParallelImageRequests	Maximale Anzahl von Bildern (Rasterkacheln, Sprites, Symbole), die parallel geladen werden sollen, was sich auf die Leistung in rasterlastigen Karten auswirkt. Standardmäßig 16.
refreshExpiredTiles	Ein boolescher Wert, der angibt, ob Vektor- und Rasterkacheln neu geladen werden sollen, wenn sie ablaufen (basierend auf ablaufendem Header). Dies ist nützlich für Datasets, die häufig aktualisiert werden. Wenn diese Option auf false festgelegt ist, wird jede Kachel bei Bedarf einmal geladen und nicht erneut geladen, wenn sie ablaufen. standard: true
sessionId	Die Sitzungs-ID, die mit Anforderungen übergeben werden soll. Empfehlen Sie stattdessen die Verwendung von atlas.setSessionId.
styleAPIVersion	Die Formatvorlagen-API-Version, die beim Anfordern von Stilen und Stilets verwendet wird
styleDefinitionsVersion	Die Formatdefinitionsversion, die beim Anfordern von Formatvorlagen von styleDefinitionsPath angefordert werden soll.
subscriptionKey	Der Kundenabonnementschlüssel, der zum Autorisieren von Anforderungen verwendet wird. Diese Option kann nur beim Initialisieren der Karte festgelegt werden. Empfehlen, stattdessen die Atlas.setSubscriptionKey-Funktion zu verwenden
transformRequest	Wenn definiert wird, wird transformRequest aufgerufen, um benutzerdefinierte Anforderungsparameter zum Laden einer Kachel bereitzustellen.
validateStyle	True, um Stile zu überprüfen, bevor sie angewendet werden. Bei der Überprüfung dauert die Verarbeitung von Stilen während des anfänglichen Ladens erheblich (einige hundert ms).
workerCount	Anzahl der Web-Worker, die auf einer Seite instanziiert wurden. Standardmäßig ist er auf die Hälfte der Anzahl der CPU-Kerne festgelegt (begrenzt auf 6).

Details zur Eigenschaft

authOptions

Die Authentifizierungsoptionen, die zum Anpassen der Authentifizierung des Kartensteuerelements bei Azure Maps-Diensten verwendet werden. Wenn diese Authentifizierungsoptionen angegeben sind, sollte ServiceOptions.subscriptionKey nicht sein. Empfehlen Sie stattdessen die Verwendung der Atlas.setAuthenticationOptions-Funktion.

authOptions?: AuthenticationOptions

Eigenschaftswert

AuthenticationOptions

disableTelemetry

Telemetriesammlung deaktivieren Diese Option kann nur beim Initialisieren der Karte festgelegt werden. default: false (true für die Azure Government Cloud)

disableTelemetry?: boolean

Eigenschaftswert

boolean

domain

Die Domäne, die beim Anfordern von Kartenkacheln und anderen Azure Maps-Diensten verwendet werden soll. Wenn das Protokoll nicht angegeben https ist, wird angenommen. Empfehlen Sie stattdessen die Verwendung der Atlas.setDomain-Funktion.

domain?: string

Eigenschaftswert

string

enableAccessibility

Aktivieren Sie die Barrierefreiheitsfunktion, um Benutzern, die Schwierigkeiten beim Visualisieren der Webanwendung haben, Unterstützung für die Sprachausgabe bereitzustellen. Diese Eigenschaft ist standardmäßig auf true festgelegt.

enableAccessibility?: boolean

Eigenschaftswert

boolean

enableAccessibilityLocationFallback

Aktivieren Sie das Fallback auf den REST-API-Geocoder, um die Barrierefreiheit von Speicherorten zu erkennen, wenn beim Extrahieren des Speicherorts aus Vektordaten ein Fehler auftritt. Das Deaktivieren dieser Option verhindert die Generierung von Geocodierungs-API-Anforderungen, kann jedoch zu einem Mangel an Standortinformationen für Sprachsprachausgaben führen. default: true

enableAccessibilityLocationFallback?: boolean

Eigenschaftswert

boolean

fadeDuration

Steuert die Dauer der Ein-/Ausblendungsanimation für Bezeichnungskollisionen in Millisekunden. Diese Einstellung wirkt sich auf alle Symbolebenen aus. Diese Einstellung wirkt sich nicht auf die Dauer von Laufzeitformatierungsübergängen oder Rasterkachel-Crossfading aus.

fadeDuration?: number

Eigenschaftswert

number

localIdeographFontFamily

Definiert eine CSS-Schriftartfamilie für die lokale Überschreibung der Generierung von Glyphen in den Bereichen "CJK Unified Ideographs", "Hiragana", "Katakana" und "Hangul Syllables". In diesen Bereichen werden Die Schriftarteinstellungen aus dem Format der Karte ignoriert, mit Ausnahme von Schlüsselwörtern mit Schriftgewichtung (light/regular/medium/bold). Legen Sie auf false fest, um Schriftarteinstellungen aus dem Format der Karte für diese Glyphenbereiche zu aktivieren. Der Zweck dieser Option besteht darin, bandbreitenintensive Glyphenserveranforderungen zu vermeiden.

localIdeographFontFamily?: string

Eigenschaftswert

string

mapConfiguration

Die Kartenkonfiguration definiert die für die Karte verfügbaren Stile.

mapConfiguration?: string | MapConfiguration

Eigenschaftswert

string | MapConfiguration

maxParallelImageRequests

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

maxParallelImageRequests?: number

Eigenschaftswert

number

refreshExpiredTiles

Ein boolescher Wert, der angibt, ob Vektor- und Rasterkacheln neu geladen werden sollen, wenn sie ablaufen (basierend auf ablaufendem Header). Dies ist nützlich für Datasets, die häufig aktualisiert werden. Wenn diese Option auf false festgelegt ist, wird jede Kachel bei Bedarf einmal geladen und nicht erneut geladen, wenn sie ablaufen. standard: true

refreshExpiredTiles?: boolean

Eigenschaftswert

boolean

sessionId

Die Sitzungs-ID, die mit Anforderungen übergeben werden soll. Empfehlen Sie stattdessen die Verwendung von atlas.setSessionId.

sessionId?: string

Eigenschaftswert

string

styleAPIVersion

Die Formatvorlagen-API-Version, die beim Anfordern von Stilen und Stilets verwendet wird

styleAPIVersion?: string

Eigenschaftswert

string

styleDefinitionsVersion

Die Formatdefinitionsversion, die beim Anfordern von Formatvorlagen von styleDefinitionsPath angefordert werden soll.

styleDefinitionsVersion?: string

Eigenschaftswert

string

subscriptionKey

Der Kundenabonnementschlüssel, der zum Autorisieren von Anforderungen verwendet wird. Diese Option kann nur beim Initialisieren der Karte festgelegt werden. Empfehlen, stattdessen die Atlas.setSubscriptionKey-Funktion zu verwenden

subscriptionKey?: string

Eigenschaftswert

string

transformRequest

Wenn definiert wird, wird transformRequest aufgerufen, um benutzerdefinierte Anforderungsparameter zum Laden einer Kachel bereitzustellen.

transformRequest?: (url: string, resourceType: ResourceType) => RequestParameters

Eigenschaftswert

(url: string, resourceType: ResourceType) => RequestParameters

validateStyle

True, um Stile zu überprüfen, bevor sie angewendet werden. Bei der Überprüfung dauert die Verarbeitung von Stilen während des anfänglichen Ladens erheblich (einige hundert ms).

validateStyle?: boolean

Eigenschaftswert

boolean

workerCount

Anzahl der Web-Worker, die auf einer Seite instanziiert wurden. Standardmäßig ist er auf die Hälfte der Anzahl der CPU-Kerne festgelegt (begrenzt auf 6).

workerCount?: number

Eigenschaftswert

number