atlas module
Klasser
EventManager |
En chef för kartkontrollens händelser. Exponeras via händelseegenskapen för atlasen. Mappningsklass. Det går inte att instansieras av användaren. |
HtmlMarker |
Den här klassen omsluter ett HTML-element som kan visas på kartan. |
Map |
Kontrollen för en visuell och interaktiv webbkarta. |
Pixel |
Representerar en pixelkoordinat eller förskjutning. Utökar en matris med [x, y]. |
Popup |
Ett informationsfönster som är fäst vid en angiven position på en karta. |
PopupTemplate |
En layoutmall för ett popup-fönster. |
Shape |
En hjälpklass som omsluter en geometri eller funktion och gör det enkelt att uppdatera och underhålla. |
Gränssnitt
AggregateExpression |
Ett aggregeringsuttryck definierar en beräkning som bearbetas över en uppsättning data.
Schema: [operator: string, initialValue?: boolean | number, mapExpression: Expression] operator: En uttrycksfunktion som sedan tillämpas på mot alla värden som beräknas av |
AnimationOptions |
Alternativen för att animera ändringar i kartkontrollens kamera. |
AuthenticationManager |
En hanterare för kartkontrollens autentisering. Exponeras via autentiseringsegenskapen för atlasen. Mappningsklass. Det går inte att instansieras av användaren. |
AuthenticationOptions |
Alternativ för att ange hur kartkontrollen ska autentiseras med Azure Maps-tjänsterna. |
BubbleLayerOptions |
Alternativ som används vid återgivning av punktobjekt i en BubbleLayer. |
CameraBoundsOptions |
Alternativen för att ange gränserna för kartkontrollens kamera. |
CameraOptions |
Alternativen för att ställa in kartkontrollens kamera. |
ClusteredProperties |
De egenskaper som ska finnas för ClusteredProperties |
CompassControlOptions |
Alternativen för ett CompassControl-objekt. |
Control |
Ett gränssnitt för att definiera en kontroll över kartan. |
ControlManager |
En chef för kartkontrollens kontroller. Exponeras via kontrollegenskapen för atlasen. Mappningsklass. Det går inte att instansieras av användaren. |
ControlOptions |
Alternativen för att lägga till en kontroll på kartan. |
DataSourceOptions |
En datakälla för att hantera formdata som ska visas på kartan.
En datakälla måste läggas till i ett lager innan den visas på kartan.
Alternativ för en |
ElevationTileSourceOptions | |
HeatMapLayerOptions |
Alternativ som används vid återgivning av punktobjekt i en HeatMapLayer. |
HtmlMarkerEvents | |
HtmlMarkerManager |
En chef för kartkontrollens HTML-markörer. Exponeras via atlasens marköregenskap. Map-klass. Det går inte att instansieras av användaren. |
HtmlMarkerOptions |
Alternativ för att återge ett HtmlMarker-objekt |
HyperLinkFormatOptions |
Formatalternativ för hyperlänksträngar. |
IconOptions |
Alternativ som används för att anpassa ikonerna i en SymbolLayer |
ImageLayerOptions |
Alternativ som används vid återgivning av punktobjekt i ett ImageLayer. |
ImageSpriteManager |
En chef för kartkontrollens bildsprit. Exponeras via atlasens imageSprite-egenskap. Map-klass. Det går inte att instansieras av användaren. |
LayerManager |
En chef för kartkontrollens lager. Exponeras via lageregenskapen för atlasen. Map-klass. Det går inte att instansieras av användaren. |
LayerOptions |
En basklass som alla andra lageralternativ ärver från. |
LightOptions |
Alternativen för kartans belysning. |
LineLayerOptions |
Alternativ som används vid återgivning av SimpleLine-, SimplePolygon-, CirclePolygon-, LineString-, MultiLineString-, Polygon- och MultiPolygon-objekt i ett linjeskikt. |
MapConfiguration |
Representerar innehållet i kartkonfigurationen med en lista över formatmallar som är tillgängliga för dem. |
MapConfigurationStyle |
Representerar informationen för ett enskilt format. |
MapDataEvent |
Händelseobjekt som returneras av mapparna när en datahändelse inträffar. |
MapErrorEvent |
Händelseobjekt som returneras av mapparna när en felhändelse inträffar. |
MapEvent |
Händelseobjekt som returneras av kartorna när en grundläggande händelse inträffar. |
MapMouseEvent |
Händelseobjekt som returneras av kartorna när en mushändelse inträffar. |
MapMouseWheelEvent |
Händelseobjekt som returneras av kartorna när en hjulhändelse inträffar. |
MapTouchEvent |
Händelseobjekt som returneras av kartorna när en touch-händelse inträffar. |
MediaLayerOptions |
Alternativ som används vid återgivning av arbetsyta, bild, rasterpanel och videoskikt |
Options | |
Padding |
Representerar mängden utfyllnad i bildpunkter som ska läggas till på sidan av en avgränsningsruta när du ställer in kameran på en karta. |
PitchControlOptions |
Alternativen för ett PitchControl-objekt. |
PolygonExtrusionLayerOptions |
Alternativ som används vid återgivning |
PolygonLayerOptions |
Alternativ som används vid återgivning av Polygon- och MultiPolygon-objekt i en PolygonLayer. |
PopupEvents | |
PopupManager |
En chef för kartkontrollens popup-fönster.
Exponeras via |
PopupOptions |
Alternativen för ett popup-fönster. |
Properties |
En uppsättning egenskaper som kan användas med en |
PropertyInfo |
Artinformation om hur en egenskap ska visas. |
RasterTileSourceOptions | |
RequestParameters |
Det här är den objekttyp som förväntas returneras av transformRequest-återanropet. |
ScaleControlOptions |
Alternativen för ett ScaleControl-objekt. |
ServiceOptions |
Globala egenskaper som används i alla atlastjänstbegäranden. |
ShapeEvents | |
SourceManager |
En chef för kartkontrollens källor. Exponeras via källegenskapen för atlasen. Map-klass. Det går inte att instansieras av användaren. |
StyleChangedEvent |
Händelseobjekt som returneras av kartan efter inläsning av ett nytt format. |
StyleControlOptions |
Alternativen för ett StyleControl-objekt. |
StyleOptions |
Alternativen för kartans formatmall. |
SymbolLayerOptions |
Alternativ som används vid återgivning av geometrier i en SymbolLayer. |
TargetedEvent | |
TextOptions |
Alternativ som används för att anpassa texten i en SymbolLayer |
Tile |
Panelobjekt som returneras av kartan när en källdatahändelse inträffar. |
TileId | |
TileLayerOptions |
Alternativ som används vid återgivning av raster tillagda bilder i en TileLayer. |
TrafficControlOptions | |
TrafficOptions |
Alternativen för att ställa in trafik på kartan. |
UserInteractionOptions |
Alternativen för att aktivera/inaktivera användarinteraktion med kartan. |
VectorTileSourceOptions |
En datakälla för att hantera formdata som visas på kartan.
En datakälla måste läggas till i ett lager innan den visas på kartan.
Alternativ för en |
WebGLLayerOptions |
Alternativ som används för att återge grafik i en WebGLLayer. |
WebGLRenderer |
Gränssnitt för att återge WebGL-grafik i en WebGLLayer. |
ZoomControlOptions |
Alternativen för ett ZoomControl-objekt. |
Typalias
Expression |
Kan anges som värdet för filter eller vissa lageralternativ. Ett uttryck definierar en formel för att beräkna värdet för egenskapen. Uttryck representeras som JSON-matriser. Det första elementet i ett uttryck är en sträng som namnger uttrycksoperatorn. |
getAuthTokenCallback |
Återanropsfunktionen som används för att hämta en autentiseringstoken i anonymt autentiseringsläge. Lös med autentiseringstoken eller avvisa med eventuella fel. |
ResourceType | |
StyleImageMetadata |
Signatur för parametern |
Uppräkningar
AuthenticationType |
En uppräkning som används för att ange vilken typ av autentiseringsmekanism som ska användas. |
ControlPosition |
Positioner där kontrollen kan placeras på kartan. |
ControlStyle |
Tillgängliga format för en kontroll. |
Funktioner
add |
Lägger till en avbildningsmall i atlasnamnområdet. |
clear |
Rensar resurser som tidigare har skapats av |
get |
Hämtar en matris med namn för alla bildmallar som är tillgängliga i atlasnamnområdet. |
get |
Hämtar standardalternativen för autentisering som angavs. Om inte tidigare angetts kommer alla egenskaper att vara odefinierade. |
get |
Hämtar standarddomänen som angavs.
Om inte tidigare har angetts är |
get |
Hämtar en SVG-mall efter namn. |
get |
Hämtar standardspråket som angavs.
Om inte tidigare har angetts är |
get |
Hämtar maximalt antal bilder (rasterpaneler, sprites, ikoner) som ska läsas in parallellt |
get |
Hämtar standardsessions-ID:t som angavs. Om det inte tidigare har angetts är standardvärdet ett slumpmässigt UUID. |
get |
Hämtar standardprenumerationsnyckeln Azure Maps som angavs. |
get |
|
get |
Aktuellt API-versionsnummer baserat på versionsnummer. |
get |
Hämtar standardvyinställningen för kartkontrollen.
Om inte tidigare har angetts är |
get |
Hämtar antalet arbetare som skapas. |
is |
Kontrollerar om användarens webbläsare stöds av kartkontrollen. |
prewarm() | Initierar resurser som WebWorkers som kan delas mellan kartor för att minska inläsningstiderna i vissa situationer. Detta är främst användbart när du använder GL-JS-kartor i en ensidesapp, där en användare navigerar mellan olika vyer som kan orsaka att kartinstanser ständigt skapas och förstörs. |
set |
Anger dina autentiseringsalternativ som standardalternativ i atlasnamnområdet som används av kartkontrollen och alla moduler som gör begäranden till Azure Maps-tjänsterna. Om en karta initieras med autentiseringsalternativen explicit definierade och setAuthenticationOptions inte tidigare har anropats anropas den automatiskt av map-konstruktorn. |
set |
Anger standarddomänen som används av map- och tjänstmodulerna såvida inte domänen uttryckligen anges när du använder dessa delar av API:et.
Om en karta initieras med domänen explicit definierad och setDomain inte tidigare har anropats anropas den automatiskt av map-konstruktorn.
Om protokollet inte anges |
set |
Anger standardspråket som används av map- och tjänstmodulerna såvida inte språket uttryckligen anges när du använder dessa delar av API:et. Om en karta initieras med språket explicit definierat och setLanguage inte tidigare har anropats anropas den automatiskt av map-konstruktorn. |
set |
Anger Maximalt antal bilder (rasterpaneler, sprites, ikoner) som ska läsas in parallellt, vilket påverkar prestanda i rastertunga kartor. 16 som standard. |
set |
Anger standardsessions-ID:t som används av map- och tjänstmodulerna såvida inte sessions-ID:t uttryckligen anges när du använder dessa delar av API:et. Om en karta initieras med sessions-ID:t uttryckligen definierat och setSessionId inte tidigare har anropats anropas den automatiskt av map-konstruktorn. |
set |
Anger din Azure Maps prenumerationsnyckel som standardprenumerationsnyckel i atlasnamnområdet som används av kartkontrollen och alla moduler som gör begäranden till Azure Maps-tjänsterna. Om en karta initieras med prenumerationsnyckeln explicit definierad och setSubscriptionKey inte tidigare har anropats anropas den automatiskt av map-konstruktorn. |
set |
|
set |
Anger vilken uppsättning geopolitiskt omtvistade kantlinjer och etiketter som visas på kartan. Parametern View (kallas även "user region parameter") är en ISO-3166-landskod med två bokstäver som visar rätt kartor för det landet/regionen. Land/regioner som inte finns med i visningslistan eller som inte är angivet kommer som standard att använda enhetlig vy. Se [Vyer] som stöds{@link https://aka.ms/AzureMapsLocalizationViews }. Det är ditt ansvar att fastställa användarnas plats och sedan ange parametern Visa korrekt för den platsen. View-parametern i Azure Maps måste användas i enlighet med gällande lagar, inklusive de som gäller mappning, för det land/den region där kartor, bilder och andra data och innehåll från tredje part som du har behörighet att komma åt via Azure Maps görs tillgängligt. |
set |
Anger antalet webbarbetare som instansieras på en sida. Som standard är det inställt på hälften av antalet CPU-kärnor (högst 6). |
Funktionsinformation
addImageTemplate(string, string, boolean)
Lägger till en avbildningsmall i atlasnamnområdet.
function addImageTemplate(templateName: string, template: string, override: boolean)
Parametrar
- templateName
-
string
Namnet på mallen.
- template
-
string
SVG-mallen som ska läggas till. Stöder {color}, {secondaryColor}, {scale}, {text}.
- override
-
boolean
Anger om den ska åsidosätta befintliga mallar om det redan finns en med samma namn.
clearPrewarmedResources()
Rensar resurser som tidigare har skapats av atlas.prewarm()
.
Observera att detta vanligtvis inte är nödvändigt. Du bör bara anropa den här funktionen om du förväntar dig att användaren av din app inte ska återgå till en kartvy någon gång i ditt program.
function clearPrewarmedResources()
getAllImageTemplateNames()
Hämtar en matris med namn för alla bildmallar som är tillgängliga i atlasnamnområdet.
function getAllImageTemplateNames(): string[]
Returer
string[]
getAuthenticationOptions()
Hämtar standardalternativen för autentisering som angavs. Om inte tidigare angetts kommer alla egenskaper att vara odefinierade.
function getAuthenticationOptions(): AuthenticationOptions
Returer
getDomain()
Hämtar standarddomänen som angavs.
Om inte tidigare har angetts är "atlas.microsoft.com"
standardvärdet .
function getDomain(): string
Returer
string
getImageTemplate(string, number)
Hämtar en SVG-mall efter namn.
function getImageTemplate(templateName: string, scale?: number): string
Parametrar
- templateName
-
string
Namnet på mallen som ska hämtas.
- scale
-
number
Anger hur mycket mallen ska skalas. För bästa resultat skalar du ikonen till den maximala storlek som du vill visa den på kartan och använder sedan symbollagrens ikonstorleksalternativ för att skala ned om det behövs. Detta minskar suddigheten på grund av skalning. Standard: 1
Returer
string
getLanguage()
Hämtar standardspråket som angavs.
Om inte tidigare har angetts är "NGT"
standardvärdet .
function getLanguage(): string
Returer
string
getMaxParallelImageRequests()
Hämtar maximalt antal bilder (rasterpaneler, sprites, ikoner) som ska läsas in parallellt
function getMaxParallelImageRequests(): number
Returer
number
getSessionId()
Hämtar standardsessions-ID:t som angavs. Om det inte tidigare har angetts är standardvärdet ett slumpmässigt UUID.
function getSessionId(): string
Returer
string
getSubscriptionKey()
Hämtar standardprenumerationsnyckeln Azure Maps som angavs.
function getSubscriptionKey(): string
Returer
string
getUserRegion()
Varning
Det här API:et är nu inaktuellt.
use atlas.getView() instead
function getUserRegion(): string
Returer
string
getVersion()
Aktuellt API-versionsnummer baserat på versionsnummer.
function getVersion(): string
Returer
string
getView()
Hämtar standardvyinställningen för kartkontrollen.
Om inte tidigare har angetts är undefined
standardvärdet .
function getView(): string
Returer
string
getWorkerCount()
Hämtar antalet arbetare som skapas.
function getWorkerCount(): number
Returer
number
isSupported(boolean)
Kontrollerar om användarens webbläsare stöds av kartkontrollen.
function isSupported(failIfMajorPerformanceCaveat?: boolean): boolean
Parametrar
- failIfMajorPerformanceCaveat
-
boolean
Om sant returnerar funktionen falskt om kartkontrollens prestanda skulle vara betydligt sämre än förväntat (t.ex. en WebGL-renderare för programvara skulle användas).
Returer
boolean
prewarm()
Initierar resurser som WebWorkers som kan delas mellan kartor för att minska inläsningstiderna i vissa situationer. atlas.setWorkerCount
, om det används, måste anges innan prewarm()
anropas för att ha en effekt.
Som standard hanteras livscykeln för dessa resurser automatiskt och de initieras lazily när en karta först skapas. Genom att prewarm()
anropa skapas dessa resurser i förväg och rensas inte när den senaste kartan tas bort från sidan. På så sätt kan de återanvändas av nya Map-instanser som skapas senare. De kan rensas manuellt genom att anropa atlas.clearPrewarmedResources()
. Detta är endast nödvändigt om webbsidan förblir aktiv men slutar använda kartor helt och hållet.
Detta är främst användbart när du använder GL-JS-kartor i en ensidesapp, där en användare navigerar mellan olika vyer som kan orsaka att kartinstanser ständigt skapas och förstörs.
function prewarm()
setAuthenticationOptions(AuthenticationOptions)
Anger dina autentiseringsalternativ som standardalternativ i atlasnamnområdet som används av kartkontrollen och alla moduler som gör begäranden till Azure Maps-tjänsterna. Om en karta initieras med autentiseringsalternativen explicit definierade och setAuthenticationOptions inte tidigare har anropats anropas den automatiskt av map-konstruktorn.
function setAuthenticationOptions(options: AuthenticationOptions)
Parametrar
- options
- AuthenticationOptions
De nya standardalternativen för autentisering.
setDomain(string)
Anger standarddomänen som används av map- och tjänstmodulerna såvida inte domänen uttryckligen anges när du använder dessa delar av API:et.
Om en karta initieras med domänen explicit definierad och setDomain inte tidigare har anropats anropas den automatiskt av map-konstruktorn.
Om protokollet inte anges https
antas.
function setDomain(domain: string)
Parametrar
- domain
-
string
Den nya standarddomänen.
setLanguage(string)
Anger standardspråket som används av map- och tjänstmodulerna såvida inte språket uttryckligen anges när du använder dessa delar av API:et. Om en karta initieras med språket explicit definierat och setLanguage inte tidigare har anropats anropas den automatiskt av map-konstruktorn.
function setLanguage(language: string)
Parametrar
- language
-
string
Det nya standardspråket.
setMaxParallelImageRequests(number)
Anger Maximalt antal bilder (rasterpaneler, sprites, ikoner) som ska läsas in parallellt, vilket påverkar prestanda i rastertunga kartor. 16 som standard.
function setMaxParallelImageRequests(maxParallelImageRequests: number)
Parametrar
- maxParallelImageRequests
-
number
Maximalt antal bilder som ska läsas in parallellt.
setSessionId(string)
Anger standardsessions-ID:t som används av map- och tjänstmodulerna såvida inte sessions-ID:t uttryckligen anges när du använder dessa delar av API:et. Om en karta initieras med sessions-ID:t uttryckligen definierat och setSessionId inte tidigare har anropats anropas den automatiskt av map-konstruktorn.
function setSessionId(id: string)
Parametrar
- id
-
string
Det nya standardsessions-ID:t.
setSubscriptionKey(string)
Anger din Azure Maps prenumerationsnyckel som standardprenumerationsnyckel i atlasnamnområdet som används av kartkontrollen och alla moduler som gör begäranden till Azure Maps-tjänsterna. Om en karta initieras med prenumerationsnyckeln explicit definierad och setSubscriptionKey inte tidigare har anropats anropas den automatiskt av map-konstruktorn.
function setSubscriptionKey(key: string)
Parametrar
- key
-
string
Den nya standardprenumerationsnyckeln.
setUserRegion(string)
Varning
Det här API:et är nu inaktuellt.
use atlas.setView(view: string) instead.
function setUserRegion(userRegion: string)
Parametrar
- userRegion
-
string
setView(string)
Anger vilken uppsättning geopolitiskt omtvistade kantlinjer och etiketter som visas på kartan. Parametern View (kallas även "user region parameter") är en ISO-3166-landskod med två bokstäver som visar rätt kartor för det landet/regionen. Land/regioner som inte finns med i visningslistan eller som inte är angivet kommer som standard att använda enhetlig vy. Se [Vyer] som stöds{@link https://aka.ms/AzureMapsLocalizationViews }. Det är ditt ansvar att fastställa användarnas plats och sedan ange parametern Visa korrekt för den platsen. View-parametern i Azure Maps måste användas i enlighet med gällande lagar, inklusive de som gäller mappning, för det land/den region där kartor, bilder och andra data och innehåll från tredje part som du har behörighet att komma åt via Azure Maps görs tillgängligt.
function setView(view: string)
Parametrar
- view
-
string
Den nya standardvyn
setWorkerCount(number)
Anger antalet webbarbetare som instansieras på en sida. Som standard är det inställt på hälften av antalet CPU-kärnor (högst 6).
function setWorkerCount(workerCount: number)
Parametrar
- workerCount
-
number
antal arbetare.