atlas module
Classi
EventManager |
Gestore per gli eventi del controllo mappa. Esposto tramite la proprietà events dell'atlas. Classe Map. Non è possibile creare un'istanza dall'utente. |
HtmlMarker |
Questa classe esegue il wrapping di un elemento HTML che può essere visualizzato sulla mappa. |
Map |
Controllo per una mappa Web visiva e interattiva. |
Pixel |
Rappresenta una coordinata o un offset pixel. Estende una matrice di [x, y]. |
Popup |
Finestra informativa ancorata in corrispondenza di una posizione specificata su una mappa. |
PopupTemplate |
Modello di layout per un popup. |
Shape |
Classe helper che esegue il wrapping di una geometria o di una caratteristica e semplifica l'aggiornamento e la manutenzione. |
Interfacce
AggregateExpression |
Un'espressione di aggregazione definisce un calcolo elaborato su un set di dati.
Schema: [operator: string, initialValue?: boolean | number, mapExpression: Expression] operator: Funzione di espressione che viene quindi applicata a su tutti i valori calcolati dal |
AnimationOptions |
Le opzioni per animare le modifiche apportate alla fotocamera del controllo mappa. |
AuthenticationManager |
Gestore per l'autenticazione del controllo mappa. Esposto tramite la proprietà di autenticazione dell'atlas. Classe Map. Non è possibile creare un'istanza dall'utente. |
AuthenticationOptions |
Opzioni per specificare il modo in cui il controllo mappa deve eseguire l'autenticazione con i servizi mappe di Azure. |
BubbleLayerOptions |
Opzioni utilizzate per il rendering di oggetti Point in un oggetto BubbleLayer. |
CameraBoundsOptions |
Opzioni per impostare i limiti della fotocamera del controllo mappa. |
CameraOptions |
Opzioni per impostare la fotocamera del controllo mappa. |
ClusteredProperties |
Proprietà che saranno presenti per ClusteredProperties |
CompassControlOptions |
Opzioni per un oggetto CompassControl. |
Control |
Interfaccia per la definizione di un controllo della mappa. |
ControlManager |
Gestore per i controlli del controllo mappa. Esposto tramite la proprietà controls dell'atlas. Classe Map. Non è possibile creare un'istanza dall'utente. |
ControlOptions |
Opzioni per l'aggiunta di un controllo alla mappa. |
DataSourceOptions |
Origine dati per la gestione dei dati delle forme che verranno visualizzati sulla mappa.
È necessario aggiungere un'origine dati a un livello prima che sia visibile sulla mappa.
Opzioni per un |
ElevationTileSourceOptions | |
FullscreenControlOptions |
Opzioni per un oggetto FullscreenControl. |
HeatMapLayerOptions |
Opzioni utilizzate per il rendering di oggetti Point in un HeatMapLayer. |
HtmlMarkerEvents | |
HtmlMarkerManager |
Gestore per i marcatori HTML del controllo mappa. Esposto tramite la proprietà markers dell'atlas. Classe Map. Non è possibile creare un'istanza dall'utente. |
HtmlMarkerOptions |
Opzioni per il rendering di un oggetto HtmlMarker |
HyperLinkFormatOptions |
Opzione di formato per le stringhe di collegamento ipertestuale. |
IconOptions |
Opzioni usate per personalizzare le icone in un SymbolLayer |
ImageLayerOptions |
Opzioni utilizzate per il rendering di oggetti Point in un oggetto ImageLayer. |
ImageSpriteManager |
Un gestore per lo sprite dell'immagine del controllo mappa. Esposto tramite la proprietà imageSprite dell'atlas. Classe Map. Non è possibile creare un'istanza dall'utente. |
LayerManager |
Gestore per i livelli del controllo mappa. Esposto tramite la proprietà layer dell'atlas. Classe Map. Non è possibile creare un'istanza dall'utente. |
LayerOptions |
Classe di base da cui ereditano tutte le altre opzioni del livello. |
LightOptions |
Opzioni per l'illuminazione della mappa. |
LineLayerOptions |
Opzioni utilizzate per il rendering di oggetti SimpleLine, SimplePolygon, CirclePolygon, LineString, MultiLineString, Polygon e MultiPolygon in un livello linea. |
MapConfiguration |
Rappresenta il contenuto della configurazione della mappa contenente un elenco di stili disponibili. |
MapConfigurationStyle |
Rappresenta le informazioni per un singolo stile. |
MapDataEvent |
Oggetto evento restituito dalle mappe quando si verifica un evento di dati. |
MapErrorEvent |
Oggetto evento restituito dalle mappe quando si verifica un evento di errore. |
MapEvent |
Oggetto evento restituito dalle mappe quando si verifica un evento di base. |
MapMouseEvent |
Oggetto evento restituito dalle mappe quando si verifica un evento del mouse. |
MapMouseWheelEvent |
Oggetto evento restituito dalle mappe quando si verifica un evento wheel. |
MapTouchEvent |
Oggetto evento restituito dalle mappe quando si verifica un evento di tocco. |
MediaLayerOptions |
Opzioni usate per il rendering di canvas, immagine, riquadro raster e livelli video |
Options | |
Padding |
Rappresenta la quantità di spaziatura interna in pixel da aggiungere al lato di un BoundingBox quando si imposta la fotocamera di una mappa. |
PitchControlOptions |
Opzioni per un oggetto PitchControl. |
PolygonExtrusionLayerOptions |
Opzioni utilizzate per il rendering di oggetti |
PolygonLayerOptions |
Opzioni usate per il rendering di oggetti Polygon e MultiPolygon in polygonLayer. |
PopupEvents | |
PopupManager |
Gestore per i popup del controllo mappa.
Esposto tramite la proprietà |
PopupOptions |
Opzioni per un popup. |
Properties |
Set di proprietà che possono essere usate con un |
PropertyInfo |
Dettagli sulle specie di visualizzazione di una proprietà. |
RasterTileSourceOptions | |
RequestParameters |
Si tratta del tipo di oggetto che dovrebbe essere restituito dal callback transformRequest. |
ScaleControlOptions |
Opzioni per un oggetto ScaleControl. |
ServiceOptions |
Proprietà globali usate in tutte le richieste del servizio Atlas. |
ShapeEvents | |
SourceManager |
Gestore per le origini del controllo mappa. Esposto tramite la proprietà sources dell'atlas. Classe Map. Non è possibile creare un'istanza dall'utente. |
StyleChangedEvent |
Oggetto evento restituito dalla mappa dopo il caricamento di un nuovo stile. |
StyleControlOptions |
Opzioni per un oggetto StyleControl. |
StyleOptions |
Opzioni per lo stile della mappa. |
SymbolLayerOptions |
Opzioni utilizzate per il rendering delle geometrie in un SymbolLayer. |
TargetedEvent | |
TextOptions |
Opzioni usate per personalizzare il testo in un SymbolLayer |
Tile |
Oggetto Tile restituito dalla mappa quando si verifica un evento di dati di origine. |
TileId | |
TileLayerOptions |
Opzioni usate per il rendering di immagini affiancate raster in un TileLayer. |
TrafficControlOptions | |
TrafficOptions |
Opzioni per impostare il traffico sulla mappa. |
UserInteractionOptions |
Opzioni per abilitare o disabilitare l'interazione dell'utente con la mappa. |
VectorTileSourceOptions |
Origine dati per la gestione dei dati delle forme che verranno visualizzati sulla mappa.
È necessario aggiungere un'origine dati a un livello prima che sia visibile sulla mappa.
Opzioni per un |
WebGLLayerOptions |
Opzioni usate per eseguire il rendering della grafica in un WebGLLayer. |
WebGLRenderer |
Interfaccia per il rendering della grafica WebGL in un WebGLLayer. |
ZoomControlOptions |
Opzioni per un oggetto ZoomControl. |
Alias tipo
Expression |
Può essere specificato come valore di filtro o di determinate opzioni di livello. Un'espressione definisce una formula per calcolare il valore della proprietà. Le espressioni sono rappresentate come matrici JSON. Il primo elemento di un'espressione è una stringa che denomina l'operatore di espressione. |
getAuthTokenCallback |
Funzione di callback usata per acquisire un token di autenticazione in modalità di autenticazione anonima. Risolvere con il token di autenticazione o rifiutare con eventuali errori. |
ResourceType | |
StyleImageMetadata |
Firma per il parametro |
Enumerazioni
AuthenticationType |
Enumerazione utilizzata per specificare il tipo di meccanismo di autenticazione da usare. |
ControlPosition |
Posizioni in cui il controllo può essere posizionato sulla mappa. |
ControlStyle |
Stili disponibili per un controllo. |
Funzioni
add |
Aggiunge un modello di immagine allo spazio dei nomi atlas. |
add |
Aggiunge una funzione di risorsa di caricamento personalizzata che verrà chiamata quando si usa un URL che inizia con uno schema url personalizzato. |
clear |
Cancella le risorse create in precedenza da |
get |
Recupera una matrice di nomi per tutti i modelli di immagine disponibili nello spazio dei nomi atlas. |
get |
Ottiene le opzioni di autenticazione predefinite specificate. Se non è stato impostato in precedenza, tutte le proprietà non saranno predefinite. |
get |
Ottiene il dominio predefinito fornito.
Se non è stato impostato in precedenza, il valore predefinito è |
get |
Recupera un modello SVG in base al nome. |
get |
Ottiene la lingua predefinita specificata.
Se non è stato impostato in precedenza, il valore predefinito è |
get |
Ottiene il numero massimo di immagini (riquadri raster, sprite, icone) da caricare in parallelo |
get |
Ottiene l'ID sessione predefinito specificato. Se non è stato impostato in precedenza il valore predefinito è un UUID casuale. |
get |
Ottiene la chiave di sottoscrizione predefinita di Mappe di Azure specificata. |
get |
|
get |
Numero di versione dell'API corrente in base al numero di build. |
get |
Ottiene l'impostazione di visualizzazione predefinita del controllo mappa.
Se non è stato impostato in precedenza, il valore predefinito è |
get |
Ottiene il numero di ruoli di lavoro che verranno creati. |
is |
Verifica se il browser dell'utente è supportato dal controllo mappa. |
prewarm() | Inizializza risorse come WebWorkers che possono essere condivise tra le mappe per ridurre i tempi di caricamento in alcune situazioni.
Ciò è particolarmente utile quando si usano GL-JS mappe in un'app a pagina singola, in cui un utente può spostarsi tra diverse visualizzazioni che possono causare la creazione e l'eliminazione permanente delle istanze di Map. |
remove |
Rimuove un protocollo aggiunto in precedenza nel thread principale. |
set |
Imposta le opzioni di autenticazione come opzioni predefinite nello spazio dei nomi atlas che viene usato dal controllo mappa e dai moduli che effettuano richieste ai servizi mappe di Azure. Se una mappa viene inizializzata con le opzioni di autenticazione definite in modo esplicito e setAuthenticationOptions non è stato chiamato in precedenza, verrà chiamato automaticamente dal costruttore Map. |
set |
Imposta il dominio predefinito usato dai moduli map e service, a meno che il dominio non venga specificato in modo esplicito quando si usano tali parti dell'API.
Se un oggetto Map viene inizializzato con il dominio definito in modo esplicito e setDomain non è stato chiamato in precedenza, verrà chiamato automaticamente dal costruttore Map.
Se il protocollo non viene specificato |
set |
Imposta la lingua predefinita usata dai moduli map e service, a meno che la lingua non venga specificata in modo esplicito quando si usano tali parti dell'API. Se una mappa viene inizializzata con la lingua definita in modo esplicito e setLanguage non è stata chiamata in precedenza, verrà chiamata automaticamente dal costruttore Map. |
set |
Imposta numero massimo di immagini (riquadri raster, sprite, icone) da caricare in parallelo, che influisce sulle prestazioni nelle mappe raster-heavy. 16 per impostazione predefinita. |
set |
Imposta l'ID sessione predefinito usato dai moduli map e service, a meno che l'ID sessione non venga specificato in modo esplicito quando si usano tali parti dell'API. Se un oggetto Map viene inizializzato con l'ID sessione definito in modo esplicito e setSessionId non è stato chiamato in precedenza, verrà chiamato automaticamente dal costruttore Map. |
set |
Imposta la chiave di sottoscrizione di Mappe di Azure come chiave di sottoscrizione predefinita nello spazio dei nomi atlas usata dal controllo mappa e da tutti i moduli che effettuano richieste ai servizi mappe di Azure. Se una mappa viene inizializzata con la chiave di sottoscrizione definita in modo esplicito e setSubscriptionKey non è stata chiamata in precedenza, verrà chiamata automaticamente dal costruttore Map. |
set |
|
set |
Specifica quale set di bordi e etichette geopoliticamente contestati vengono visualizzati sulla mappa. Il parametro View (detto anche "parametro dell'area utente") è un codice paese ISO-3166 di 2 lettere che mostrerà le mappe corrette per il paese o l'area geografica. Paese/aree geografiche che non sono presenti nell'elenco Visualizza o se per impostazione predefinita non è specificata la visualizzazione "Unificata". Vedere le [Visualizzazioni]{@link https://aka.ms/AzureMapsLocalizationViews }. È responsabilità dell'utente determinare la posizione degli utenti e quindi impostare correttamente il parametro View per tale posizione. Il parametro View in Mappe di Azure deve essere usato in conformità alle leggi applicabili, incluse quelle relative al mapping, del paese/area geografica in cui sono disponibili mappe, immagini e altri dati e contenuto di terze parti a cui si è autorizzati ad accedere tramite Mappe di Azure. |
set |
Imposta il numero di web worker di cui è stata creata un'istanza in una pagina. Per impostazione predefinita, è impostato su metà del numero di core CPU (con un massimo di 6). |
Dettagli funzione
addImageTemplate(string, string, boolean)
Aggiunge un modello di immagine allo spazio dei nomi atlas.
function addImageTemplate(templateName: string, template: string, override: boolean)
Parametri
- templateName
-
string
Nome del modello.
- template
-
string
Modello SVG da aggiungere. Supporta {color}, {secondaryColor}, {scale}, {text}.
- override
-
boolean
Specifica se deve eseguire l'override dei modelli esistenti se ne esiste già uno con lo stesso nome.
addProtocol(string, (args: any[]) => Promise<any>)
Aggiunge una funzione di risorsa di caricamento personalizzata che verrà chiamata quando si usa un URL che inizia con uno schema url personalizzato.
function addProtocol(customProtocol: string, loadFn: (args: any[]) => Promise<any>)
Parametri
- customProtocol
-
string
protocollo da associare, ad esempio 'custom'
- loadFn
-
(args: any[]) => Promise<any>
funzione da usare quando si tenta di recuperare un riquadro specificato da customProtocol
clearPrewarmedResources()
Cancella le risorse create in precedenza da atlas.prewarm()
.
Si noti che questo non è in genere necessario. È consigliabile chiamare questa funzione solo se si prevede che l'utente dell'app non torni a una visualizzazione Mappa in alcun punto dell'applicazione.
function clearPrewarmedResources()
getAllImageTemplateNames()
Recupera una matrice di nomi per tutti i modelli di immagine disponibili nello spazio dei nomi atlas.
function getAllImageTemplateNames(): string[]
Restituisce
string[]
getAuthenticationOptions()
Ottiene le opzioni di autenticazione predefinite specificate. Se non è stato impostato in precedenza, tutte le proprietà non saranno predefinite.
function getAuthenticationOptions(): AuthenticationOptions
Restituisce
getDomain()
Ottiene il dominio predefinito fornito.
Se non è stato impostato in precedenza, il valore predefinito è "atlas.microsoft.com"
.
function getDomain(): string
Restituisce
string
getImageTemplate(string, number)
Recupera un modello SVG in base al nome.
function getImageTemplate(templateName: string, scale?: number): string
Parametri
- templateName
-
string
Nome del modello da recuperare.
- scale
-
number
Specifica quanto ridimensionare il modello. Per ottenere risultati ottimali, ridimensionare l'icona alla dimensione massima che si desidera visualizzare sulla mappa, quindi usare l'opzione dimensioni icona livelli simbolo per ridurre le dimensioni, se necessario. Ciò ridurrà la sfocatura a causa del ridimensionamento. Impostazione predefinita: 1
Restituisce
string
getLanguage()
Ottiene la lingua predefinita specificata.
Se non è stato impostato in precedenza, il valore predefinito è "NGT"
.
function getLanguage(): string
Restituisce
string
getMaxParallelImageRequests()
Ottiene il numero massimo di immagini (riquadri raster, sprite, icone) da caricare in parallelo
function getMaxParallelImageRequests(): number
Restituisce
number
getSessionId()
Ottiene l'ID sessione predefinito specificato. Se non è stato impostato in precedenza il valore predefinito è un UUID casuale.
function getSessionId(): string
Restituisce
string
getSubscriptionKey()
Ottiene la chiave di sottoscrizione predefinita di Mappe di Azure specificata.
function getSubscriptionKey(): string
Restituisce
string
getUserRegion()
Avviso
Questa API è ora deprecata.
use atlas.getView() instead
function getUserRegion(): string
Restituisce
string
getVersion()
Numero di versione dell'API corrente in base al numero di build.
function getVersion(): string
Restituisce
string
getView()
Ottiene l'impostazione di visualizzazione predefinita del controllo mappa.
Se non è stato impostato in precedenza, il valore predefinito è undefined
.
function getView(): string
Restituisce
string
getWorkerCount()
Ottiene il numero di ruoli di lavoro che verranno creati.
function getWorkerCount(): number
Restituisce
number
isSupported(boolean)
Verifica se il browser dell'utente è supportato dal controllo mappa.
function isSupported(failIfMajorPerformanceCaveat?: boolean): boolean
Parametri
- failIfMajorPerformanceCaveat
-
boolean
Se true, la funzione restituirà false se le prestazioni del controllo mappa sarebbero notevolmente peggiori del previsto (ad esempio, verrà usato un renderer WebGL software).
Restituisce
boolean
prewarm()
Inizializza risorse come WebWorkers che possono essere condivise tra le mappe per ridurre i tempi di caricamento in alcune situazioni.
atlas.setWorkerCount
, se in uso, deve essere impostato prima che venga chiamato prewarm()
per avere un effetto.
Per impostazione predefinita, il ciclo di vita di queste risorse viene gestito automaticamente e vengono inizializzati in modo differito al momento della creazione di una mappa. Richiamando prewarm()
, queste risorse verranno create in anticipo e non verranno cancellate quando l'ultima mappa viene rimossa dalla pagina. In questo modo è possibile riusata dalle nuove istanze della mappa create in un secondo momento. Possono essere cancellati manualmente chiamando atlas.clearPrewarmedResources()
. Questa operazione è necessaria solo se la pagina Web rimane attiva, ma interrompe completamente l'uso delle mappe.
Ciò è particolarmente utile quando si usano GL-JS mappe in un'app a pagina singola, in cui un utente può spostarsi tra diverse visualizzazioni che possono causare la creazione e l'eliminazione permanente delle istanze di Map.
function prewarm()
removeProtocol(string)
Rimuove un protocollo aggiunto in precedenza nel thread principale.
function removeProtocol(customProtocol: string)
Parametri
- customProtocol
-
string
protocollo personalizzato per cui rimuovere la registrazione
setAuthenticationOptions(AuthenticationOptions)
Imposta le opzioni di autenticazione come opzioni predefinite nello spazio dei nomi atlas che viene usato dal controllo mappa e dai moduli che effettuano richieste ai servizi mappe di Azure. Se una mappa viene inizializzata con le opzioni di autenticazione definite in modo esplicito e setAuthenticationOptions non è stato chiamato in precedenza, verrà chiamato automaticamente dal costruttore Map.
function setAuthenticationOptions(options: AuthenticationOptions)
Parametri
- options
- AuthenticationOptions
Nuove opzioni di autenticazione predefinite.
setDomain(string)
Imposta il dominio predefinito usato dai moduli map e service, a meno che il dominio non venga specificato in modo esplicito quando si usano tali parti dell'API.
Se un oggetto Map viene inizializzato con il dominio definito in modo esplicito e setDomain non è stato chiamato in precedenza, verrà chiamato automaticamente dal costruttore Map.
Se il protocollo non viene specificato https
viene utilizzato.
function setDomain(domain: string)
Parametri
- domain
-
string
Nuovo dominio predefinito.
setLanguage(string)
Imposta la lingua predefinita usata dai moduli map e service, a meno che la lingua non venga specificata in modo esplicito quando si usano tali parti dell'API. Se una mappa viene inizializzata con la lingua definita in modo esplicito e setLanguage non è stata chiamata in precedenza, verrà chiamata automaticamente dal costruttore Map.
function setLanguage(language: string)
Parametri
- language
-
string
Nuova lingua predefinita.
setMaxParallelImageRequests(number)
Imposta numero massimo di immagini (riquadri raster, sprite, icone) da caricare in parallelo, che influisce sulle prestazioni nelle mappe raster-heavy. 16 per impostazione predefinita.
function setMaxParallelImageRequests(maxParallelImageRequests: number)
Parametri
- maxParallelImageRequests
-
number
Numero massimo di immagini da caricare in parallelo.
setSessionId(string)
Imposta l'ID sessione predefinito usato dai moduli map e service, a meno che l'ID sessione non venga specificato in modo esplicito quando si usano tali parti dell'API. Se un oggetto Map viene inizializzato con l'ID sessione definito in modo esplicito e setSessionId non è stato chiamato in precedenza, verrà chiamato automaticamente dal costruttore Map.
function setSessionId(id: string)
Parametri
- id
-
string
Nuovo ID sessione predefinito.
setSubscriptionKey(string)
Imposta la chiave di sottoscrizione di Mappe di Azure come chiave di sottoscrizione predefinita nello spazio dei nomi atlas usata dal controllo mappa e da tutti i moduli che effettuano richieste ai servizi mappe di Azure. Se una mappa viene inizializzata con la chiave di sottoscrizione definita in modo esplicito e setSubscriptionKey non è stata chiamata in precedenza, verrà chiamata automaticamente dal costruttore Map.
function setSubscriptionKey(key: string)
Parametri
- key
-
string
Nuova chiave di sottoscrizione predefinita.
setUserRegion(string)
Avviso
Questa API è ora deprecata.
use atlas.setView(view: string) instead.
function setUserRegion(userRegion: string)
Parametri
- userRegion
-
string
setView(string)
Specifica quale set di bordi e etichette geopoliticamente contestati vengono visualizzati sulla mappa. Il parametro View (detto anche "parametro dell'area utente") è un codice paese ISO-3166 di 2 lettere che mostrerà le mappe corrette per il paese o l'area geografica. Paese/aree geografiche che non sono presenti nell'elenco Visualizza o se per impostazione predefinita non è specificata la visualizzazione "Unificata". Vedere le [Visualizzazioni]{@link https://aka.ms/AzureMapsLocalizationViews }. È responsabilità dell'utente determinare la posizione degli utenti e quindi impostare correttamente il parametro View per tale posizione. Il parametro View in Mappe di Azure deve essere usato in conformità alle leggi applicabili, incluse quelle relative al mapping, del paese/area geografica in cui sono disponibili mappe, immagini e altri dati e contenuto di terze parti a cui si è autorizzati ad accedere tramite Mappe di Azure.
function setView(view: string)
Parametri
- view
-
string
Nuova visualizzazione predefinita
setWorkerCount(number)
Imposta il numero di web worker di cui è stata creata un'istanza in una pagina. Per impostazione predefinita, è impostato su metà del numero di core CPU (con un massimo di 6).
function setWorkerCount(workerCount: number)
Parametri
- workerCount
-
number
conteggio dei lavoratori.