atlas module

Paket:

azure-maps-control

Klasser

EventManager	En chef för kartkontrollens händelser. Exponeras via händelseegenskapen för atlasen. Mappningsklass. Det går inte att instansiera 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örankrat på 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 mapExpression för varje punkt i klustret. Operatorer som stöds: o För tal: +, *, max, min o För booleska värden: all, any initialValue: Optional, ett initialt värde där det första beräknade värdet aggregeras mot. mapExpression: Ett uttryck som tillämpas mot varje punkt i datauppsättningen.
AnimationOptions	Alternativen för att animera ändringar i kartkontrollens kamera.
AuthenticationManager	En chef för kartkontrollens autentisering. Exponeras via autentiseringsegenskapen för atlasen. Mappningsklass. Det går inte att instansiera 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 av kartan.
ControlManager	En chef för kartkontrollens kontroller. Exponeras via kontrollegenskapen för atlasen. Mappningsklass. Det går inte att instansiera 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 DataSourceOptions.
ElevationTileSourceOptions
FullscreenControlOptions	Alternativen för ett FullscreenControl-objekt.
HeatMapLayerOptions	Alternativ som används vid återgivning av punktobjekt i en HeatMapLayer.
HtmlMarkerEvents
HtmlMarkerManager	En chef för kartkontrollens HTML-markörer. Exponeras genom atlasens egenskap markörer. Mappningsklass. Det går inte att instansiera 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 en ImageLayer.
ImageSpriteManager	En chef för kartkontrollens bildsprit. Exponeras via egenskapen imageSprite för atlasen. Mappningsklass. Det går inte att instansiera användaren.
LayerManager	En chef för kartkontrollens lager. Exponeras genom lageregenskapen för atlasen. Mappningsklass. Det går inte att instansiera 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 tillgängliga formatmallar.
MapConfigurationStyle	Representerar informationen för ett enskilt format.
MapDataEvent	Händelseobjekt som returneras av kartorna när en datahändelse inträffar.
MapErrorEvent	Händelseobjekt som returneras av kartorna 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 arbetsytor, bild, rasterpanel och videolager
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 av Polygon- och MultiPolygon-objekt i en PolygonExtrusionLayer.
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 egenskapen popups för klassen atlas.Map. Det går inte att instansiera användaren.
PopupOptions	Alternativen för ett popup-fönster.
Properties	En uppsättning egenskaper som kan användas med en PopupTemplate
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. Mappningsklass. Det går inte att instansiera användaren.
StyleChangedEvent	Händelseobjekt som returneras av kartan när ett nytt format har lästs in.
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 ska visas på kartan. En datakälla måste läggas till i ett lager innan den visas på kartan. Alternativ för en VectorTileSource.
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 options som skickas till ImageSpriteManager.add.

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

addImageTemplate(string, string, boolean)	Lägger till en avbildningsmall i atlasnamnområdet.
addProtocol(string, (args: any[]) => Promise<any>)	Lägger till en anpassad belastningsresursfunktion som anropas när du använder en URL som börjar med ett anpassat URL-schema.
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 appen inte ska återgå till en kartvy någon gång i programmet.
getAllImageTemplateNames()	Hämtar en matris med namn för alla bildmallar som är tillgängliga i atlasnamnområdet.
getAuthenticationOptions()	Hämtar de standardautentiseringsalternativ som angavs. Om inte tidigare angetts kommer alla egenskaper att vara odefinierade.
getDomain()	Hämtar standarddomänen som angavs. Om inte tidigare har angetts är standardvärdet "atlas.microsoft.com".
getImageTemplate(string, number)	Hämtar en SVG-mall efter namn.
getLanguage()	Hämtar standardspråket som angavs. Om inte tidigare har angetts är standardvärdet "NGT".
getMaxParallelImageRequests()	Hämtar maximalt antal bilder (rasterpaneler, sprites, ikoner) som ska läsas in parallellt
getSessionId()	Hämtar standardsessions-ID:t som angavs. Om det inte tidigare har angetts är standardvärdet ett slumpmässigt UUID.
getSubscriptionKey()	Hämtar standardprenumerationsnyckeln för Azure Maps som angavs.
getUserRegion()
getVersion()	Aktuellt API-versionsnummer baserat på versionsnummer.
getView()	Hämtar standardinställningen för kartkontrollen. Om inte tidigare har angetts är standardvärdet undefined.
getWorkerCount()	Hämtar det antal arbetare som skapas.
isSupported(boolean)	Kontrollerar om användarens webbläsare stöds av kartkontrollen.
prewarm()	Initierar resurser som WebWorkers som kan delas mellan kartor för att minska belastningstiderna 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 latt när en karta först skapas. Genom att anropa prewarm()skapas dessa resurser i förväg och rensas inte när den sista kartan tas bort från sidan. Detta gör att de kan återanvändas av nya kartinstanser som skapas senare. De kan rensas manuellt genom att anropa atlas.clearPrewarmedResources(). Detta är bara 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.
removeProtocol(string)	Tar bort ett tidigare tillagt protokoll i huvudtråden.
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 mapkonstruktorn.
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 kartkonstruktorn. Om protokollet inte anges https antas.
setLanguage(string)	Anger standardspråket som används av map- och tjänstmodulerna om 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 kartkonstruktorn.
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.
setSessionId(string)	Anger standardsessions-ID:t som används av map- och tjänstmodulerna om inte sessions-ID:t uttryckligen anges när du använder dessa delar av API:et. Om en karta initieras med sessions-ID:t explicit definierat och setSessionId inte tidigare har anropats anropas den automatiskt av kartkonstruktorn.
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 mapkonstruktorn.
setUserRegion(string)
setView(string)	Anger vilken uppsättning geopolitiskt omtvistade kantlinjer och etiketter som visas på kartan. Parametern Visa (kallas även "parameter för användarregion") är en ISO-3166-landskod med två bokstäver som visar rätt kartor för landet/regionen. Land/regioner som inte finns med i visningslistan eller om de är ospecificerade kommer som standard att vara "Enhetlig" vy. Se [Views]{@link https://aka.ms/AzureMapsLocalizationViews }. Det är ditt ansvar att fastställa platsen för dina användare och ange sedan view-parametern korrekt för den platsen. Parametern Visa i Azure Maps måste användas i enlighet med tillämpliga lagar, inklusive de som gäller mappning, för det land/den region där kartor, bilder och annat data och innehåll från tredje part som du har behörighet att komma åt via Azure Maps görs tillgängligt.
setWorkerCount(number)	Anger antalet webbarbetare som instansieras på en sida. Som standard är den inställd på hälften av antalet CPU-kärnor (begränsas till 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 en med samma namn redan finns.

addProtocol(string, (args: any[]) => Promise<any>)

Lägger till en anpassad belastningsresursfunktion som anropas när du använder en URL som börjar med ett anpassat URL-schema.

function addProtocol(customProtocol: string, loadFn: (args: any[]) => Promise<any>)

Parametrar

customProtocol

string

protokollet för att koppla, till exempel "anpassad"

loadFn

(args: any[]) => Promise<any>

funktionen som ska användas när du försöker hämta en panel som anges av customProtocol

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 appen inte ska återgå till en kartvy någon gång i programmet.

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 de standardautentiseringsalternativ som angavs. Om inte tidigare angetts kommer alla egenskaper att vara odefinierade.

function getAuthenticationOptions(): AuthenticationOptions

Returer

AuthenticationOptions

getDomain()

Hämtar standarddomänen som angavs. Om inte tidigare har angetts är standardvärdet "atlas.microsoft.com".

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 standardvärdet "NGT".

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 för 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 standardinställningen för kartkontrollen. Om inte tidigare har angetts är standardvärdet undefined.

function getView(): string

Returer

string

getWorkerCount()

Hämtar det antal 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 false 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 belastningstiderna 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 latt när en karta först skapas. Genom att anropa prewarm()skapas dessa resurser i förväg och rensas inte när den sista kartan tas bort från sidan. Detta gör att de kan återanvändas av nya kartinstanser som skapas senare. De kan rensas manuellt genom att anropa atlas.clearPrewarmedResources(). Detta är bara 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()

removeProtocol(string)

Tar bort ett tidigare tillagt protokoll i huvudtråden.

function removeProtocol(customProtocol: string)

Parametrar

customProtocol

string

det anpassade protokollet för att ta bort registreringen för

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 mapkonstruktorn.

function setAuthenticationOptions(options: AuthenticationOptions)

Parametrar

options

AuthenticationOptions

De nya standardautentiseringsalternativen.

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 kartkonstruktorn. 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 om 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 kartkonstruktorn.

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 om inte sessions-ID:t uttryckligen anges när du använder dessa delar av API:et. Om en karta initieras med sessions-ID:t explicit definierat och setSessionId inte tidigare har anropats anropas den automatiskt av kartkonstruktorn.

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 mapkonstruktorn.

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 Visa (kallas även "parameter för användarregion") är en ISO-3166-landskod med två bokstäver som visar rätt kartor för landet/regionen. Land/regioner som inte finns med i visningslistan eller om de är ospecificerade kommer som standard att vara "Enhetlig" vy. Se [Views]{@link https://aka.ms/AzureMapsLocalizationViews }. Det är ditt ansvar att fastställa platsen för dina användare och ange sedan view-parametern korrekt för den platsen. Parametern Visa i Azure Maps måste användas i enlighet med tillämpliga lagar, inklusive de som gäller mappning, för det land/den region där kartor, bilder och annat 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 den inställd på hälften av antalet CPU-kärnor (begränsas till 6).

function setWorkerCount(workerCount: number)

Parametrar

workerCount

number

antal arbetare.