ServiceOptions interface
Proprietà globali usate in tutte le richieste di servizio atlas.
- Extends
Proprietà
auth |
Le opzioni di autenticazione usate per personalizzare il modo in cui il controllo mappa esegue l'autenticazione con i servizi di Mappe di Azure. Se queste opzioni di autenticazione vengono specificate, ServiceOptions.subscriptionKey non deve essere. È consigliabile usare invece la funzione atlas.setAuthenticationOptions. |
disable |
Disabilitare la raccolta di telemetria Questa opzione può essere impostata solo quando si inizializza la mappa. default: false (true per il cloud Azure per enti pubblici) |
domain | Dominio da usare quando si richiedono riquadri mappa e altri servizi di Mappe di Azure.
Se il protocollo non viene specificato |
enable |
Abilitare la funzionalità di accessibilità per fornire supporto per la lettura dello schermo per gli utenti che hanno difficoltà a visualizzare l'applicazione Web. Questa proprietà è impostata su true per impostazione predefinita. |
enable |
Abilitare il fallback nel geocoder dell'API REST per rilevare l'accessibilità della posizione se l'estrazione della posizione dai dati vettoriali ha esito negativo. La disabilitazione di questa opzione impedirà la generazione di richieste API geocode, ma potrebbe causare una mancanza di informazioni sulla posizione per le utilità di lettura dello schermo. impostazione predefinita: true |
fade |
Controlla la durata dell'animazione fade-in/fade-out per le collisioni di etichette, in millisecondi. Questa impostazione influisce su tutti i livelli dei simboli. Questa impostazione non influisce sulla durata delle transizioni di stile di runtime o sul riquadro raster incrociato. |
local |
Definisce una famiglia di caratteri CSS per la generazione locale di glifi negli intervalli 'CJK Unified Ideographs', 'Hiragana', 'Katakana' e 'Hangul Syllables'. In questi intervalli le impostazioni del tipo di carattere dello stile della mappa verranno ignorate, ad eccezione delle parole chiave di peso del carattere (light/regular/medium/grassetto). Impostare su false, per abilitare le impostazioni del tipo di carattere dallo stile della mappa per questi intervalli di glifi. Lo scopo di questa opzione consiste nell'evitare richieste del server glifi a elevato utilizzo della larghezza di banda. |
map |
La configurazione della mappa definisce il set di stili disponibili per la mappa. |
max |
Numero massimo di immagini (riquadri raster, sprite, icone) da caricare in parallelo, che influisce sulle prestazioni nelle mappe raster-heavy. 16 per impostazione predefinita. |
refresh |
Valore booleano che specifica se i riquadri vettoriali e raster devono essere ricaricati alla scadenza (in base alla scadenza dell'intestazione). Ciò è utile per i set di dati che aggiornano frequentemente. Se impostato su false, ogni riquadro verrà caricato una volta, quando necessario e non ricaricato alla scadenza. impostazione predefinita: true |
session |
ID sessione da passare con le richieste. È consigliabile usare invece atlas.setSessionId. |
style |
Versione dell'API di stile usata durante la richiesta di stili e set di stili |
style |
Versione delle definizioni di stile da richiedere quando si richiedono stili da styleDefinitionsPath. |
subscription |
Chiave di sottoscrizione del cliente usata per autorizzare le richieste. Questa opzione può essere impostata solo quando si inizializza la mappa. Consiglia di usare invece la funzione atlas.setSubscriptionKey |
transform |
Se la trasformazione definitaRequest verrà chiamata per fornire parametri di richiesta personalizzati per il caricamento di un riquadro. |
validate |
True per convalidare gli stili prima di essere applicati. La convalida richiede un tempo significativo (poche centinaia di ms) per elaborare gli stili durante il caricamento iniziale. |
worker |
Numero di lavoratori Web che hanno creato un'istanza in una pagina. Per impostazione predefinita, è impostato su metà del numero di core CPU (con un valore limitato a 6). |
Dettagli proprietà
authOptions
Le opzioni di autenticazione usate per personalizzare il modo in cui il controllo mappa esegue l'autenticazione con i servizi di Mappe di Azure. Se queste opzioni di autenticazione vengono specificate, ServiceOptions.subscriptionKey non deve essere. È consigliabile usare invece la funzione atlas.setAuthenticationOptions.
authOptions?: AuthenticationOptions
Valore della proprietà
disableTelemetry
Disabilitare la raccolta di telemetria Questa opzione può essere impostata solo quando si inizializza la mappa. default: false (true per il cloud Azure per enti pubblici)
disableTelemetry?: boolean
Valore della proprietà
boolean
domain
Dominio da usare quando si richiedono riquadri mappa e altri servizi di Mappe di Azure.
Se il protocollo non viene specificato https
.
È consigliabile usare invece la funzione atlas.setDomain.
domain?: string
Valore della proprietà
string
enableAccessibility
Abilitare la funzionalità di accessibilità per fornire supporto per la lettura dello schermo per gli utenti che hanno difficoltà a visualizzare l'applicazione Web. Questa proprietà è impostata su true per impostazione predefinita.
enableAccessibility?: boolean
Valore della proprietà
boolean
enableAccessibilityLocationFallback
Abilitare il fallback nel geocoder dell'API REST per rilevare l'accessibilità della posizione se l'estrazione della posizione dai dati vettoriali ha esito negativo. La disabilitazione di questa opzione impedirà la generazione di richieste API geocode, ma potrebbe causare una mancanza di informazioni sulla posizione per le utilità di lettura dello schermo. impostazione predefinita: true
enableAccessibilityLocationFallback?: boolean
Valore della proprietà
boolean
fadeDuration
Controlla la durata dell'animazione fade-in/fade-out per le collisioni di etichette, in millisecondi. Questa impostazione influisce su tutti i livelli dei simboli. Questa impostazione non influisce sulla durata delle transizioni di stile di runtime o sul riquadro raster incrociato.
fadeDuration?: number
Valore della proprietà
number
localIdeographFontFamily
Definisce una famiglia di caratteri CSS per la generazione locale di glifi negli intervalli 'CJK Unified Ideographs', 'Hiragana', 'Katakana' e 'Hangul Syllables'. In questi intervalli le impostazioni del tipo di carattere dello stile della mappa verranno ignorate, ad eccezione delle parole chiave di peso del carattere (light/regular/medium/grassetto). Impostare su false, per abilitare le impostazioni del tipo di carattere dallo stile della mappa per questi intervalli di glifi. Lo scopo di questa opzione consiste nell'evitare richieste del server glifi a elevato utilizzo della larghezza di banda.
localIdeographFontFamily?: string
Valore della proprietà
string
mapConfiguration
La configurazione della mappa definisce il set di stili disponibili per la mappa.
mapConfiguration?: string | MapConfiguration
Valore della proprietà
string | MapConfiguration
maxParallelImageRequests
Numero massimo di immagini (riquadri raster, sprite, icone) da caricare in parallelo, che influisce sulle prestazioni nelle mappe raster-heavy. 16 per impostazione predefinita.
maxParallelImageRequests?: number
Valore della proprietà
number
refreshExpiredTiles
Valore booleano che specifica se i riquadri vettoriali e raster devono essere ricaricati alla scadenza (in base alla scadenza dell'intestazione). Ciò è utile per i set di dati che aggiornano frequentemente. Se impostato su false, ogni riquadro verrà caricato una volta, quando necessario e non ricaricato alla scadenza. impostazione predefinita: true
refreshExpiredTiles?: boolean
Valore della proprietà
boolean
sessionId
ID sessione da passare con le richieste. È consigliabile usare invece atlas.setSessionId.
sessionId?: string
Valore della proprietà
string
styleAPIVersion
Versione dell'API di stile usata durante la richiesta di stili e set di stili
styleAPIVersion?: string
Valore della proprietà
string
styleDefinitionsVersion
Versione delle definizioni di stile da richiedere quando si richiedono stili da styleDefinitionsPath.
styleDefinitionsVersion?: string
Valore della proprietà
string
subscriptionKey
Chiave di sottoscrizione del cliente usata per autorizzare le richieste. Questa opzione può essere impostata solo quando si inizializza la mappa. Consiglia di usare invece la funzione atlas.setSubscriptionKey
subscriptionKey?: string
Valore della proprietà
string
transformRequest
Se la trasformazione definitaRequest verrà chiamata per fornire parametri di richiesta personalizzati per il caricamento di un riquadro.
transformRequest?: (url: string, resourceType: ResourceType) => RequestParameters
Valore della proprietà
(url: string, resourceType: ResourceType) => RequestParameters
validateStyle
True per convalidare gli stili prima di essere applicati. La convalida richiede un tempo significativo (poche centinaia di ms) per elaborare gli stili durante il caricamento iniziale.
validateStyle?: boolean
Valore della proprietà
boolean
workerCount
Numero di lavoratori Web che hanno creato un'istanza in una pagina. Per impostazione predefinita, è impostato su metà del numero di core CPU (con un valore limitato a 6).
workerCount?: number
Valore della proprietà
number