ServiceOptions interface

Pakiet:

azure-maps-control

Globalne właściwości używane we wszystkich żądaniach obsługi atlasu.

Extends

Options

Właściwości

authOptions	Opcje uwierzytelniania używane do dostosowywania sposobu uwierzytelniania kontrolki mapy za pomocą usług Azure Maps. Jeśli te opcje uwierzytelniania zostaną określone, nie należy używać parametru ServiceOptions.subscriptionKey. Zalecamy użycie funkcji atlas.setAuthenticationOptions.
disableTelemetry	Wyłącz kolekcję telemetrii Ta opcja może być ustawiana tylko podczas inicjowania mapy. wartość domyślna: false (prawda dla chmury Azure Government)
domain	Domena do użycia podczas żądania kafelków mapy i innych usług Azure Maps. Jeśli nie określono protokołu, przyjęto https założenie. Zamiast tego zaleca się używanie funkcji atlas.setDomain.
enableAccessibility	Włącz funkcję ułatwień dostępu, aby zapewnić obsługę czytnika zawartości ekranu dla użytkowników, którzy mają trudności z wizualizowanie aplikacji internetowej. Ta właściwość jest domyślnie ustawiona na wartość true.
enableAccessibilityLocationFallback	Włącz powrót do geokodera interfejsu API REST w celu wykrywania ułatwień dostępu do lokalizacji, jeśli wyodrębnianie lokalizacji z danych wektorowych kończy się niepowodzeniem. Wyłączenie tej opcji uniemożliwi generowanie żądań interfejsu API kodu geograficznego, ale może prowadzić do braku informacji o lokalizacji dla czytników zawartości ekranu. wartość domyślna: true
fadeDuration	Określa czas trwania animacji zanikania/zanikania w przypadku kolizji etykiet w milisekundach. To ustawienie ma wpływ na wszystkie warstwy symboli. To ustawienie nie ma wpływu na czas trwania przejścia stylów środowiska uruchomieniowego lub kafelka rasterowego międzyfałowego.
localIdeographFontFamily	Definiuje rodzinę czcionek CSS dla lokalnie zastępowania generowania glifów w zakresach "CJK Unified Ideographs", "Hiragana", "Katakana" i "Hangul Syllables". W tych zakresach ustawienia czcionek w stylu mapy zostaną zignorowane, z wyjątkiem słów kluczowych wagi czcionki (jasny/zwykły/średni/pogrubiony). Ustaw wartość false, aby włączyć ustawienia czcionki w stylu mapy dla tych zakresów glyph. Celem tej opcji jest uniknięcie żądań serwera o dużej przepustowości.
mapConfiguration	Konfiguracja mapy definiuje zestaw stylów dostępnych dla mapy.
maxParallelImageRequests	Maksymalna liczba obrazów (kafelki rastrowe, sprites, ikony) do równoległego ładowania, co wpływa na wydajność map rastrowych. Domyślnie 16.
refreshExpiredTiles	Wartość logiczna określająca, czy kafelki wektorów i rasterów powinny zostać ponownie załadowane po wygaśnięciu (na podstawie wygasa nagłówka). Jest to przydatne w przypadku często aktualizowanych zestawów danych. Po ustawieniu wartości false każdy kafelek zostanie załadowany raz, w razie potrzeby i nie zostanie załadowany ponownie po wygaśnięciu. wartość domyślna: true
sessionId	Identyfikator sesji do przekazania z żądaniami. Zamiast tego zaleca się używanie parametru atlas.setSessionId.
styleAPIVersion	Wersja interfejsu API stylu używana podczas żądania stylów i zestawów stylów
styleDefinitionsVersion	Wersja definicji stylów do żądania podczas żądania stylów z styleDefinitionsPath.
subscriptionKey	Klucz subskrypcji klienta używany do autoryzacji żądań. Tę opcję można ustawić tylko podczas inicjowania mapy. Zamiast tego zalecamy używanie funkcji atlas.setSubscriptionKey
transformRequest	Jeśli zdefiniowano element transformRequest zostanie wywołany w celu udostępnienia niestandardowych parametrów żądania do załadowania kafelka.
validateStyle	Wartość True w celu zweryfikowania stylów przed zastosowaniem. Walidacja trwa znacznie (kilkaset ms) w celu przetworzenia stylów podczas początkowego ładowania.
workerCount	Liczba wystąpień procesów roboczych sieci Web na stronie. Domyślnie jest ustawiona na połowę liczbę rdzeni procesora CPU (ograniczona do 6).

Szczegóły właściwości

authOptions

Opcje uwierzytelniania używane do dostosowywania sposobu uwierzytelniania kontrolki mapy za pomocą usług Azure Maps. Jeśli te opcje uwierzytelniania zostaną określone, nie należy używać parametru ServiceOptions.subscriptionKey. Zalecamy użycie funkcji atlas.setAuthenticationOptions.

authOptions?: AuthenticationOptions

Wartość właściwości

AuthenticationOptions

disableTelemetry

Wyłącz kolekcję telemetrii Ta opcja może być ustawiana tylko podczas inicjowania mapy. wartość domyślna: false (prawda dla chmury Azure Government)

disableTelemetry?: boolean

Wartość właściwości

boolean

domain

Domena do użycia podczas żądania kafelków mapy i innych usług Azure Maps. Jeśli nie określono protokołu, przyjęto https założenie. Zamiast tego zaleca się używanie funkcji atlas.setDomain.

domain?: string

Wartość właściwości

string

enableAccessibility

Włącz funkcję ułatwień dostępu, aby zapewnić obsługę czytnika zawartości ekranu dla użytkowników, którzy mają trudności z wizualizowanie aplikacji internetowej. Ta właściwość jest domyślnie ustawiona na wartość true.

enableAccessibility?: boolean

Wartość właściwości

boolean

enableAccessibilityLocationFallback

Włącz powrót do geokodera interfejsu API REST w celu wykrywania ułatwień dostępu do lokalizacji, jeśli wyodrębnianie lokalizacji z danych wektorowych kończy się niepowodzeniem. Wyłączenie tej opcji uniemożliwi generowanie żądań interfejsu API kodu geograficznego, ale może prowadzić do braku informacji o lokalizacji dla czytników zawartości ekranu. wartość domyślna: true

enableAccessibilityLocationFallback?: boolean

Wartość właściwości

boolean

fadeDuration

Określa czas trwania animacji zanikania/zanikania w przypadku kolizji etykiet w milisekundach. To ustawienie ma wpływ na wszystkie warstwy symboli. To ustawienie nie ma wpływu na czas trwania przejścia stylów środowiska uruchomieniowego lub kafelka rasterowego międzyfałowego.

fadeDuration?: number

Wartość właściwości

number

localIdeographFontFamily

Definiuje rodzinę czcionek CSS dla lokalnie zastępowania generowania glifów w zakresach "CJK Unified Ideographs", "Hiragana", "Katakana" i "Hangul Syllables". W tych zakresach ustawienia czcionek w stylu mapy zostaną zignorowane, z wyjątkiem słów kluczowych wagi czcionki (jasny/zwykły/średni/pogrubiony). Ustaw wartość false, aby włączyć ustawienia czcionki w stylu mapy dla tych zakresów glyph. Celem tej opcji jest uniknięcie żądań serwera o dużej przepustowości.

localIdeographFontFamily?: string

Wartość właściwości

string

mapConfiguration

Konfiguracja mapy definiuje zestaw stylów dostępnych dla mapy.

mapConfiguration?: string | MapConfiguration

Wartość właściwości

string | MapConfiguration

maxParallelImageRequests

Maksymalna liczba obrazów (kafelki rastrowe, sprites, ikony) do równoległego ładowania, co wpływa na wydajność map rastrowych. Domyślnie 16.

maxParallelImageRequests?: number

Wartość właściwości

number

refreshExpiredTiles

Wartość logiczna określająca, czy kafelki wektorów i rasterów powinny zostać ponownie załadowane po wygaśnięciu (na podstawie wygasa nagłówka). Jest to przydatne w przypadku często aktualizowanych zestawów danych. Po ustawieniu wartości false każdy kafelek zostanie załadowany raz, w razie potrzeby i nie zostanie załadowany ponownie po wygaśnięciu. wartość domyślna: true

refreshExpiredTiles?: boolean

Wartość właściwości

boolean

sessionId

Identyfikator sesji do przekazania z żądaniami. Zamiast tego zaleca się używanie parametru atlas.setSessionId.

sessionId?: string

Wartość właściwości

string

styleAPIVersion

Wersja interfejsu API stylu używana podczas żądania stylów i zestawów stylów

styleAPIVersion?: string

Wartość właściwości

string

styleDefinitionsVersion

Wersja definicji stylów do żądania podczas żądania stylów z styleDefinitionsPath.

styleDefinitionsVersion?: string

Wartość właściwości

string

subscriptionKey

Klucz subskrypcji klienta używany do autoryzacji żądań. Tę opcję można ustawić tylko podczas inicjowania mapy. Zamiast tego zalecamy używanie funkcji atlas.setSubscriptionKey

subscriptionKey?: string

Wartość właściwości

string

transformRequest

Jeśli zdefiniowano element transformRequest zostanie wywołany w celu udostępnienia niestandardowych parametrów żądania do załadowania kafelka.

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

Wartość właściwości

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

validateStyle

Wartość True w celu zweryfikowania stylów przed zastosowaniem. Walidacja trwa znacznie (kilkaset ms) w celu przetworzenia stylów podczas początkowego ładowania.

validateStyle?: boolean

Wartość właściwości

boolean

workerCount

Liczba wystąpień procesów roboczych sieci Web na stronie. Domyślnie jest ustawiona na połowę liczbę rdzeni procesora CPU (ograniczona do 6).

workerCount?: number

Wartość właściwości

number