ServiceOptions interface
Globale eigenschappen die worden gebruikt in alle atlas-serviceaanvragen.
- Extends
Eigenschappen
auth |
De verificatieopties die worden gebruikt om aan te passen hoe het kaartbeheer wordt geverifieerd met Azure Maps-services. Als deze verificatieopties zijn opgegeven, mag ServiceOptions.subscriptionKey dat niet zijn. U wordt aangeraden in plaats daarvan de functie atlas.setAuthenticationOptions te gebruiken. |
disable |
Telemetrieverzameling uitschakelen Deze optie kan alleen worden ingesteld bij het initialiseren van de kaart. standaard: false (waar voor de Azure Government cloud) |
domain | Het domein dat moet worden gebruikt bij het aanvragen van kaarttegels en andere Azure Maps-services.
Als het protocol niet is opgegeven |
enable |
Schakel de toegankelijkheidsfunctie in om ondersteuning voor schermlezers te bieden voor gebruikers die problemen hebben met het visualiseren van de webtoepassing. Deze eigenschap is standaard ingesteld op true. |
enable |
Schakel de terugval naar de REST API-geocoder in voor het detecteren van locatietoegankelijkheid als het extraheren van locatie uit vectorgegevens mislukt. Als u deze optie uitschakelt, wordt het genereren van API-aanvragen voor geocode voorkomen, maar kan dit leiden tot een gebrek aan locatie-informatie voor schermlezers. standaardinstelling: true |
fade |
Hiermee bepaalt u de duur van de fade-in/fade-out-animatie voor labelconflicten, in milliseconden. Deze instelling is van invloed op alle symboollagen. Deze instelling heeft geen invloed op de duur van overgangen van runtimestijlen of kruisvervaging van rastertegels. |
local |
Definieert een CSS-lettertypefamilie voor het lokaal overschrijven van het genereren van glyphs in de bereiken 'CJK Unified Ideographs', 'Hiragana', 'Katakana' en 'Hangul Lettergrepen'. In deze bereiken worden lettertype-instellingen van de stijl van de kaart genegeerd, met uitzondering van trefwoorden met een lettertypegewicht (licht/normaal/gemiddeld/vet). Ingesteld op onwaar om lettertype-instellingen uit de stijl van de kaart in te schakelen voor deze glyph-bereiken. Het doel van deze optie is om bandbreedte-intensieve glyph-serveraanvragen te voorkomen. |
map |
De kaartconfiguratie definieert de set stijlen die beschikbaar zijn voor de kaart. |
max |
Maximum aantal afbeeldingen (rastertegels, sprites, pictogrammen) dat parallel moet worden geladen, wat van invloed is op de prestaties van kaarten met veel rasters. Standaard 16. |
refresh |
Een booleaanse waarde die aangeeft of vector- en rastertegels opnieuw moeten worden geladen wanneer ze verlopen (op basis van verlopen-header). Dit is handig voor gegevenssets die regelmatig worden bijgewerkt. Als deze optie is ingesteld op onwaar, wordt elke tegel eenmaal geladen wanneer dat nodig is en niet opnieuw geladen wanneer ze verlopen. standaardinstelling: true |
session |
De sessie-id die moet worden doorgegeven aan aanvragen. In plaats daarvan wordt aangeraden atlas.setSessionId te gebruiken. |
style |
De stijl-API-versie die wordt gebruikt bij het aanvragen van stijlen en stijlenets |
style |
De versie van de stijldefinities die moet worden aangevraagd bij het aanvragen van stijlen uit styleDefinitionsPath. |
subscription |
De abonnementssleutel van de klant die wordt gebruikt om aanvragen te autoriseren. Deze optie kan alleen worden ingesteld bij het initialiseren van de kaart. U kunt het beste in plaats daarvan de functie atlas.setSubscriptionKey gebruiken |
transform |
Indien gedefinieerd, wordt transformRequest aangeroepen om aangepaste aanvraagparameters op te geven voor het laden van een tegel. |
validate |
Waar om stijlen te valideren voordat deze worden toegepast. Validatie kost veel (enkele honderden ms) tijd om stijlen te verwerken tijdens de initiële belasting. |
worker |
Aantal webwerknemers dat is geïnstantieerd op een pagina. Standaard is dit ingesteld op de helft van het aantal CPU-kernen (beperkt tot 6). |
Eigenschapdetails
authOptions
De verificatieopties die worden gebruikt om aan te passen hoe het kaartbeheer wordt geverifieerd met Azure Maps-services. Als deze verificatieopties zijn opgegeven, mag ServiceOptions.subscriptionKey dat niet zijn. U wordt aangeraden in plaats daarvan de functie atlas.setAuthenticationOptions te gebruiken.
authOptions?: AuthenticationOptions
Waarde van eigenschap
disableTelemetry
Telemetrieverzameling uitschakelen Deze optie kan alleen worden ingesteld bij het initialiseren van de kaart. standaard: false (waar voor de Azure Government cloud)
disableTelemetry?: boolean
Waarde van eigenschap
boolean
domain
Het domein dat moet worden gebruikt bij het aanvragen van kaarttegels en andere Azure Maps-services.
Als het protocol niet is opgegeven https
, wordt ervan uitgegaan.
U wordt aangeraden in plaats daarvan de functie atlas.setDomain te gebruiken.
domain?: string
Waarde van eigenschap
string
enableAccessibility
Schakel de toegankelijkheidsfunctie in om ondersteuning voor schermlezers te bieden voor gebruikers die problemen hebben met het visualiseren van de webtoepassing. Deze eigenschap is standaard ingesteld op true.
enableAccessibility?: boolean
Waarde van eigenschap
boolean
enableAccessibilityLocationFallback
Schakel de terugval naar de REST API-geocoder in voor het detecteren van locatietoegankelijkheid als het extraheren van locatie uit vectorgegevens mislukt. Als u deze optie uitschakelt, wordt het genereren van API-aanvragen voor geocode voorkomen, maar kan dit leiden tot een gebrek aan locatie-informatie voor schermlezers. standaardinstelling: true
enableAccessibilityLocationFallback?: boolean
Waarde van eigenschap
boolean
fadeDuration
Hiermee bepaalt u de duur van de fade-in/fade-out-animatie voor labelconflicten, in milliseconden. Deze instelling is van invloed op alle symboollagen. Deze instelling heeft geen invloed op de duur van overgangen van runtimestijlen of kruisvervaging van rastertegels.
fadeDuration?: number
Waarde van eigenschap
number
localIdeographFontFamily
Definieert een CSS-lettertypefamilie voor het lokaal overschrijven van het genereren van glyphs in de bereiken 'CJK Unified Ideographs', 'Hiragana', 'Katakana' en 'Hangul Lettergrepen'. In deze bereiken worden lettertype-instellingen van de stijl van de kaart genegeerd, met uitzondering van trefwoorden met een lettertypegewicht (licht/normaal/gemiddeld/vet). Ingesteld op onwaar om lettertype-instellingen uit de stijl van de kaart in te schakelen voor deze glyph-bereiken. Het doel van deze optie is om bandbreedte-intensieve glyph-serveraanvragen te voorkomen.
localIdeographFontFamily?: string
Waarde van eigenschap
string
mapConfiguration
De kaartconfiguratie definieert de set stijlen die beschikbaar zijn voor de kaart.
mapConfiguration?: string | MapConfiguration
Waarde van eigenschap
string | MapConfiguration
maxParallelImageRequests
Maximum aantal afbeeldingen (rastertegels, sprites, pictogrammen) dat parallel moet worden geladen, wat van invloed is op de prestaties van kaarten met veel rasters. Standaard 16.
maxParallelImageRequests?: number
Waarde van eigenschap
number
refreshExpiredTiles
Een booleaanse waarde die aangeeft of vector- en rastertegels opnieuw moeten worden geladen wanneer ze verlopen (op basis van verlopen-header). Dit is handig voor gegevenssets die regelmatig worden bijgewerkt. Als deze optie is ingesteld op onwaar, wordt elke tegel eenmaal geladen wanneer dat nodig is en niet opnieuw geladen wanneer ze verlopen. standaardinstelling: true
refreshExpiredTiles?: boolean
Waarde van eigenschap
boolean
sessionId
De sessie-id die moet worden doorgegeven aan aanvragen. In plaats daarvan wordt aangeraden atlas.setSessionId te gebruiken.
sessionId?: string
Waarde van eigenschap
string
styleAPIVersion
De stijl-API-versie die wordt gebruikt bij het aanvragen van stijlen en stijlenets
styleAPIVersion?: string
Waarde van eigenschap
string
styleDefinitionsVersion
De versie van de stijldefinities die moet worden aangevraagd bij het aanvragen van stijlen uit styleDefinitionsPath.
styleDefinitionsVersion?: string
Waarde van eigenschap
string
subscriptionKey
De abonnementssleutel van de klant die wordt gebruikt om aanvragen te autoriseren. Deze optie kan alleen worden ingesteld bij het initialiseren van de kaart. U kunt het beste in plaats daarvan de functie atlas.setSubscriptionKey gebruiken
subscriptionKey?: string
Waarde van eigenschap
string
transformRequest
Indien gedefinieerd, wordt transformRequest aangeroepen om aangepaste aanvraagparameters op te geven voor het laden van een tegel.
transformRequest?: (url: string, resourceType: ResourceType) => RequestParameters
Waarde van eigenschap
(url: string, resourceType: ResourceType) => RequestParameters
validateStyle
Waar om stijlen te valideren voordat deze worden toegepast. Validatie kost veel (enkele honderden ms) tijd om stijlen te verwerken tijdens de initiële belasting.
validateStyle?: boolean
Waarde van eigenschap
boolean
workerCount
Aantal webwerknemers dat is geïnstantieerd op een pagina. Standaard is dit ingesteld op de helft van het aantal CPU-kernen (beperkt tot 6).
workerCount?: number
Waarde van eigenschap
number