atlas module
Osztályok
EventManager |
A térképvezérlő eseményeinek kezelője. Az atlasz eseménytulajdonságán keresztül érhető el. Térképosztály. A felhasználó nem tudja példányosítani. |
HtmlMarker |
Ez az osztály körbefuttat egy HTML-elemet, amely megjeleníthető a térképen. |
Map |
A vizuális és interaktív webes térkép vezérlője. |
Pixel |
Képpontkoordinátát vagy eltolást jelöl. [x, y] tömb kiterjesztése. |
Popup |
Egy térképen megadott helyen rögzített információs ablak. |
PopupTemplate |
Előugró ablak elrendezéssablonja. |
Shape |
Egy segédosztály, amely egy geometriát vagy funkciót burkol, és megkönnyíti a frissítését és karbantartását. |
Interfészek
AggregateExpression |
Az aggregátumkifejezések olyan számításokat határoznak meg, amelyek egy adatkészleten keresztül lesznek feldolgozva.
Séma: [operátor: sztring, initialValue?: logikai | szám, mapExpression: Kifejezés] operátor: Egy kifejezésfüggvény, amely a fürt minden pontja által |
AnimationOptions |
A térképvezérlő kamerájának módosításainak animálási lehetőségei. |
AuthenticationManager |
A térképvezérlő hitelesítésének kezelője. Az atlasz hitelesítési tulajdonsága teszi elérhetővé. Térképosztály. A felhasználó nem tudja példányosítani. |
AuthenticationOptions |
A térképvezérlőnek a Azure Maps szolgáltatásokkal való hitelesítésének megadására szolgáló beállítások. |
BubbleLayerOptions |
A BubbleLayer pontobjektumainak renderelésekor használt beállítások. |
CameraBoundsOptions |
A térképvezérlő kamerájának határainak beállítási lehetőségei. |
CameraOptions |
A térképvezérlő kamerájának beállítási lehetőségei. |
ClusteredProperties |
A ClusteredProperties tulajdonsághoz tartozó tulajdonságok |
CompassControlOptions |
A CompassControl-objektumok beállításai. |
Control |
A térkép vezérlőjének meghatározására szolgáló felület. |
ControlManager |
A térképvezérlő vezérlőinek kezelője. Az atlasz vezérlőtulajdonságán keresztül elérhetővé téve. Térképosztály. A felhasználó nem tudja példányosítani. |
ControlOptions |
A vezérlőelem térképhez való hozzáadásának lehetőségei. |
DataSourceOptions |
A térképen megjelenő alakzatadatok kezelésére szolgáló adatforrás.
Egy adatforrást hozzá kell adni egy réteghez, mielőtt az látható lenne a térképen.
A (z) |
ElevationTileSourceOptions | |
HeatMapLayerOptions |
A HeatMapLayer pontobjektumainak renderelésekor használt beállítások. |
HtmlMarkerEvents | |
HtmlMarkerManager |
A térképvezérlő HTML-jelölőinek kezelője. Az atlasz jelölőtulajdonságán keresztül elérhetővé téve. Térképosztály. A felhasználó nem tudja példányosítani. |
HtmlMarkerOptions |
HtmlMarker-objektum renderelési lehetőségei |
HyperLinkFormatOptions |
Hivatkozási sztringek formátumbeállítása. |
IconOptions |
A SymbolLayer ikonjainak testreszabására szolgáló beállítások |
ImageLayerOptions |
Az ImageLayer pontobjektumainak renderelésekor használt beállítások. |
ImageSpriteManager |
A térképvezérlő kép sprite-jának kezelője. Az atlasz ImageSprite tulajdonságán keresztül érhető el. Térképosztály. A felhasználó nem tudja példányosítani. |
LayerManager |
A térképvezérlő rétegeinek kezelője. Az atlasz rétegtulajdonságán keresztül elérhetővé téve. Térképosztály. A felhasználó nem tudja példányosítani. |
LayerOptions |
Egy alaposztály, amelyből minden más rétegbeállítás öröklődik. |
LightOptions |
A térkép megvilágításának lehetőségei. |
LineLayerOptions |
A SimpleLine, a SimplePolygon, a CirclePolygon, a LineString, a MultiLineString, a Polygon és a MultiPolygon objektumok vonalrétegben való megjelenítéséhez használt beállítások. |
MapConfiguration |
A térképkonfiguráció tartalmát jelöli, amely a számukra elérhető stílusok listáját tartalmazza. |
MapConfigurationStyle |
Egyetlen stílus adatait jelöli. |
MapDataEvent |
Adatesemény bekövetkezésekor a térképek által visszaadott eseményobjektum. |
MapErrorEvent |
Hibaesemény esetén a térképek által visszaadott eseményobjektum. |
MapEvent |
A térképek által visszaadott eseményobjektum alapszintű esemény bekövetkezésekor. |
MapMouseEvent |
A térképek által visszaadott eseményobjektum egéresemény esetén. |
MapMouseWheelEvent |
A térképek által a kerékesemény bekövetkezésekor visszaadott eseményobjektum. |
MapTouchEvent |
A térképek által visszaadott eseményobjektum érintéses esemény bekövetkezésekor. |
MediaLayerOptions |
Vászon, kép, raszter csempe és videorétegek renderelésekor használt beállítások |
Options | |
Padding |
A határolókeret oldalához a térkép kamerájának beállításakor képpontban hozzáadandó kitöltés mennyiségét jelöli. |
PitchControlOptions |
A PitchControl-objektumok beállításai. |
PolygonExtrusionLayerOptions |
A rendereléskor |
PolygonLayerOptions |
A Sokszög és a Többpolygon objektum megjelenítéséhez használt beállítások a PolygonLayerben. |
PopupEvents | |
PopupManager |
A térképvezérlő előugró ablakainak kezelője.
Az osztály tulajdonságán |
PopupOptions |
Az előugró ablakok beállításai. |
Properties |
Olyan tulajdonságok halmaza, amelyek a |
PropertyInfo |
A tulajdonságok megjelenítésének fajadatai. |
RasterTileSourceOptions | |
RequestParameters |
Ez az az objektumtípus, amelyet a transformRequest visszahívás várhatóan visszaad. |
ScaleControlOptions |
A ScaleControl-objektumok beállításai. |
ServiceOptions |
Az összes Atlas-szolgáltatáskéréshez használt globális tulajdonságok. |
ShapeEvents | |
SourceManager |
A térképvezérlő forrásainak kezelője. Az atlasz forrástulajdonságán keresztül elérhetővé téve. Térképosztály. A felhasználó nem tudja példányosítani. |
StyleChangedEvent |
A térkép által visszaadott eseményobjektum egy új stílus betöltése után. |
StyleControlOptions |
A StyleControl-objektumok beállításai. |
StyleOptions |
A térkép stílusának beállításai. |
SymbolLayerOptions |
A SymbolLayer geometriáinak renderelésekor használt beállítások. |
TargetedEvent | |
TextOptions |
A szimbólumréteg szövegének testreszabására szolgáló beállítások |
Tile |
A térkép által a forrásadat-esemény bekövetkezésekor visszaadott csempeobjektum. |
TileId | |
TileLayerOptions |
Raster csempézett képek csempeképek csemperétegben való megjelenítéséhez használt beállítások. |
TrafficControlOptions | |
TrafficOptions |
A térképen a forgalom beállításának lehetőségei. |
UserInteractionOptions |
A felhasználó térképpel való interakciójának engedélyezésére/letiltására vonatkozó lehetőségek. |
VectorTileSourceOptions |
A térképen megjelenő alakzatadatok kezelésére szolgáló adatforrás.
Egy adatforrást hozzá kell adni egy réteghez, mielőtt az látható lenne a térképen.
A (z) |
WebGLLayerOptions |
A WebGLLayerben lévő ábrák rendereléséhez használt beállítások. |
WebGLRenderer |
WebesGL-ábrák webGLLayerben való renderelését szolgáló felület. |
ZoomControlOptions |
A ZoomControl-objektumok beállításai. |
Típusaliasok
Expression |
Megadható a szűrő vagy bizonyos rétegbeállítások értékeként. A kifejezések a tulajdonság értékének kiszámítására szolgáló képletet határoznak meg. A kifejezések JSON-tömbökként jelennek meg. A kifejezés első eleme egy karakterlánc, amely a kifejezés operátorát nevezi el. |
getAuthTokenCallback |
A visszahívási függvény, amellyel hitelesítési jogkivonatot szerezhet be névtelen hitelesítési módban. Hárítsa el a hitelesítési jogkivonattal, vagy elutasítsa az esetleges hibákat. |
ResourceType | |
StyleImageMetadata |
A paraméter aláírása, amely a |
Enumerációk
AuthenticationType |
A használni kívánt hitelesítési mechanizmus típusának megadására szolgáló enumerálás. |
ControlPosition |
Olyan pozíciók, ahol a vezérlő elhelyezhető a térképen. |
ControlStyle |
Vezérlőkhöz elérhető stílusok. |
Függvények
add |
Képsablont ad hozzá az atlasz névteréhez. |
clear |
Törli a korábban a által |
get |
Lekéri az atlasz névterében elérhető összes képsablon nevét tartalmazó tömböt. |
get |
Lekéri a megadott alapértelmezett hitelesítési beállításokat. Ha korábban nem állította be az összes tulajdonságot, a program nem definiálja az összes tulajdonságot. |
get |
Lekéri a megadott alapértelmezett tartományt.
Ha korábban nem állította be az alapértelmezett értéket, akkor a következő: |
get |
Egy SVG-sablont kér le név szerint. |
get |
Lekéri a megadott alapértelmezett nyelvet.
Ha korábban nem állította be az alapértelmezett értéket, akkor a következő: |
get |
Lekéri a maximálisan betöltendő képek számát (rasztercsempék, spritesek, ikonok) |
get |
Lekéri a megadott alapértelmezett munkamenet-azonosítót. Ha korábban nem állította be, az alapértelmezett érték egy véletlenszerű UUID. |
get |
Lekéri a megadott alapértelmezett Azure Maps előfizetési kulcsot. |
get |
|
get |
Az API aktuális verziószáma a buildszám alapján. |
get |
Lekéri a térképvezérlő alapértelmezett nézetbeállítását.
Ha korábban nem állította be az alapértelmezett értéket, akkor a következő: |
get |
Lekéri a létrehozott feldolgozók számát. |
is |
Ellenőrzi, hogy a térképvezérlő támogatja-e a felhasználó böngészőjét. |
prewarm() | Inicializálja az olyan erőforrásokat, mint a WebWorkers, amelyek megoszthatók a térképek között bizonyos helyzetekben a terhelési idők csökkentése érdekében. Ez elsősorban akkor hasznos, ha a GL-JS-térképeket egyoldalas alkalmazásban használja, ahol a felhasználó különböző nézetek között navigálhat, amelyek miatt a Map-példányok folyamatosan létrejönnek és megsemmisülnek. |
set |
Beállítja a hitelesítési beállításokat alapértelmezett beállításként az atlasz névterében, amelyet a térképvezérlő és az Azure Maps-szolgáltatásoknak kérést küldő modulok használnak. Ha egy térkép inicializálva van a explicit módon megadott hitelesítési beállításokkal, és a setAuthenticationOptions korábban nem lett meghívva, a térképkonstruktor automatikusan meghívja. |
set |
Beállítja a térkép- és szolgáltatásmodulok által használt alapértelmezett tartományt, kivéve, ha a tartomány kifejezetten meg van adva az API ezen részeinek használatakor.
Ha a térkép inicializálva van a tartomány explicit definiálásával, és a setDomain korábban nem lett meghívva, akkor a Térképkonstruktor automatikusan meghívja.
Ha a protokoll nincs megadva |
set |
Beállítja a térkép- és szolgáltatásmodulok által használt alapértelmezett nyelvet, kivéve, ha a nyelv kifejezetten meg van adva az API ezen részeinek használatakor. Ha a térkép inicializálva van az explicit módon definiált nyelvvel, és a setLanguage még nem lett meghívva, a térképkonstruktor automatikusan meghívja. |
set |
A képek maximális számát (rasztercsempék, spritesek, ikonok) állítja be párhuzamosan, ami hatással van a raszteres térképek teljesítményére. Alapértelmezés szerint 16. |
set |
Beállítja a térkép- és szolgáltatásmodulok által használt alapértelmezett munkamenet-azonosítót, kivéve, ha a munkamenet-azonosító explicit módon van megadva az API ezen részeinek használatakor. Ha egy térképet explicit módon definiált munkamenet-azonosítóval inicializálnak, és a setSessionId még nem lett meghívva, a térképkonstruktor automatikusan meghívja. |
set |
Beállítja az Azure Maps előfizetési kulcsot alapértelmezett előfizetési kulcsként az atlasz névterében, amelyet a térképvezérlő és az Azure Maps-szolgáltatásoknak kérést küldő modulok használnak. Ha a térkép inicializálva van az előfizetési kulccsal, és a setSubscriptionKey még nem lett meghívva, akkor a térképkonstruktor automatikusan meghívja. |
set |
|
set |
Meghatározza, hogy mely geopolitikailag vitatott szegélyek és címkék jelenjenek meg a térképen. A View paraméter (más néven "felhasználói régió paraméter") egy kétbetűs ISO-3166 országkód, amely az adott ország/régió megfelelő térképét jeleníti meg. Azok az országok/régiók, amelyek nem szerepelnek a Nézet listában, vagy ha nincs megadva, alapértelmezés szerint az "Egyesített" nézet lesz. Tekintse meg a támogatott [Nézetek]{@link https://aka.ms/AzureMapsLocalizationViews }. Az Ön felelőssége meghatározni a felhasználók helyét, majd helyesen beállítani a View paramétert az adott helyhez. A View paramétert Azure Maps a vonatkozó jogszabályoknak megfelelően kell használni, beleértve a térképekkel kapcsolatos jogszabályokat is, azon ország/régió vonatkozásában, ahol a térképeket, képeket és egyéb adatokat, valamint a Azure Maps keresztüli hozzáférésre jogosult harmadik féltől származó tartalmakat elérhetővé teszik. |
set |
Beállítja a lapon példányosított webmunkások számát. Alapértelmezés szerint a processzormagok számának fele (6-nál van leképezve). |
Függvény adatai
addImageTemplate(string, string, boolean)
Képsablont ad hozzá az atlasz névteréhez.
function addImageTemplate(templateName: string, template: string, override: boolean)
Paraméterek
- templateName
-
string
A sablon neve.
- template
-
string
A hozzáadni kívánt SVG-sablon. Támogatja a következőt: {color}, {secondaryColor}, {scale}, {text}.
- override
-
boolean
Megadja, hogy felül kell-e bírálnia a meglévő sablonokat, ha már létezik ilyen nevű sablon.
clearPrewarmedResources()
Törli a korábban a által atlas.prewarm()
létrehozott erőforrásokat.
Vegye figyelembe, hogy ez általában nem szükséges. Csak akkor hívja meg ezt a függvényt, ha azt várja, hogy az alkalmazás felhasználója ne térjen vissza a Térkép nézetre az alkalmazás bármely pontján.
function clearPrewarmedResources()
getAllImageTemplateNames()
Lekéri az atlasz névterében elérhető összes képsablon nevét tartalmazó tömböt.
function getAllImageTemplateNames(): string[]
Válaszok
string[]
getAuthenticationOptions()
Lekéri a megadott alapértelmezett hitelesítési beállításokat. Ha korábban nem állította be az összes tulajdonságot, a program nem definiálja az összes tulajdonságot.
function getAuthenticationOptions(): AuthenticationOptions
Válaszok
getDomain()
Lekéri a megadott alapértelmezett tartományt.
Ha korábban nem állította be az alapértelmezett értéket, akkor a következő: "atlas.microsoft.com"
.
function getDomain(): string
Válaszok
string
getImageTemplate(string, number)
Egy SVG-sablont kér le név szerint.
function getImageTemplate(templateName: string, scale?: number): string
Paraméterek
- templateName
-
string
A lekérendő sablon neve.
- scale
-
number
Megadja, hogy mennyi legyen a sablon skálázása. A legjobb eredmény érdekében skálázza az ikont a térképen megjeleníteni kívánt maximális méretre, majd a szimbólumrétegek ikonméret beállításával igény szerint leskálázhatja a skálázást. Ez csökkenti a skálázás miatti homályosságot. Alapértelmezett: 1
Válaszok
string
getLanguage()
Lekéri a megadott alapértelmezett nyelvet.
Ha korábban nem állította be az alapértelmezett értéket, akkor a következő: "NGT"
.
function getLanguage(): string
Válaszok
string
getMaxParallelImageRequests()
Lekéri a maximálisan betöltendő képek számát (rasztercsempék, spritesek, ikonok)
function getMaxParallelImageRequests(): number
Válaszok
number
getSessionId()
Lekéri a megadott alapértelmezett munkamenet-azonosítót. Ha korábban nem állította be, az alapértelmezett érték egy véletlenszerű UUID.
function getSessionId(): string
Válaszok
string
getSubscriptionKey()
Lekéri a megadott alapértelmezett Azure Maps előfizetési kulcsot.
function getSubscriptionKey(): string
Válaszok
string
getUserRegion()
Figyelmeztetés
Ez az API már elavult.
use atlas.getView() instead
function getUserRegion(): string
Válaszok
string
getVersion()
Az API aktuális verziószáma a buildszám alapján.
function getVersion(): string
Válaszok
string
getView()
Lekéri a térképvezérlő alapértelmezett nézetbeállítását.
Ha korábban nem állította be az alapértelmezett értéket, akkor a következő: undefined
.
function getView(): string
Válaszok
string
getWorkerCount()
Lekéri a létrehozott feldolgozók számát.
function getWorkerCount(): number
Válaszok
number
isSupported(boolean)
Ellenőrzi, hogy a térképvezérlő támogatja-e a felhasználó böngészőjét.
function isSupported(failIfMajorPerformanceCaveat?: boolean): boolean
Paraméterek
- failIfMajorPerformanceCaveat
-
boolean
Ha igaz, a függvény hamis eredményt ad vissza, ha a térképvezérlő teljesítménye a vártnál jelentősen rosszabb lenne (például egy szoftveres WebGL-megjelenítőt használna).
Válaszok
boolean
prewarm()
Inicializálja az olyan erőforrásokat, mint a WebWorkers, amelyek megoszthatók a térképek között bizonyos helyzetekben a terhelési idők csökkentése érdekében. atlas.setWorkerCount
, ha használják, be kell állítani, mielőtt prewarm()
meghívják, hogy a hatás.
Alapértelmezés szerint ezeknek az erőforrásoknak az életciklusát a rendszer automatikusan kezeli, és a térkép első létrehozásakor lazán inicializálja őket. A meghívással prewarm()
ezek az erőforrások előre létrejönnek, és nem törlődnek, amikor az utolsó térkép el lesz távolítva a lapról. Ez lehetővé teszi, hogy a később létrehozott új Map-példányok újra felhasználják őket. A hívással atlas.clearPrewarmedResources()
manuálisan törölhetők. Erre csak akkor van szükség, ha a weblap aktív marad, de teljesen leállítja a térképek használatát.
Ez elsősorban akkor hasznos, ha a GL-JS-térképeket egyoldalas alkalmazásban használja, ahol a felhasználó különböző nézetek között navigálhat, amelyek miatt a Map-példányok folyamatosan létrejönnek és megsemmisülnek.
function prewarm()
setAuthenticationOptions(AuthenticationOptions)
Beállítja a hitelesítési beállításokat alapértelmezett beállításként az atlasz névterében, amelyet a térképvezérlő és az Azure Maps-szolgáltatásoknak kérést küldő modulok használnak. Ha egy térkép inicializálva van a explicit módon megadott hitelesítési beállításokkal, és a setAuthenticationOptions korábban nem lett meghívva, a térképkonstruktor automatikusan meghívja.
function setAuthenticationOptions(options: AuthenticationOptions)
Paraméterek
- options
- AuthenticationOptions
Az új alapértelmezett hitelesítési beállítások.
setDomain(string)
Beállítja a térkép- és szolgáltatásmodulok által használt alapértelmezett tartományt, kivéve, ha a tartomány kifejezetten meg van adva az API ezen részeinek használatakor.
Ha a térkép inicializálva van a tartomány explicit definiálásával, és a setDomain korábban nem lett meghívva, akkor a Térképkonstruktor automatikusan meghívja.
Ha a protokoll nincs megadva https
, a rendszer feltételezi.
function setDomain(domain: string)
Paraméterek
- domain
-
string
Az új alapértelmezett tartomány.
setLanguage(string)
Beállítja a térkép- és szolgáltatásmodulok által használt alapértelmezett nyelvet, kivéve, ha a nyelv kifejezetten meg van adva az API ezen részeinek használatakor. Ha a térkép inicializálva van az explicit módon definiált nyelvvel, és a setLanguage még nem lett meghívva, a térképkonstruktor automatikusan meghívja.
function setLanguage(language: string)
Paraméterek
- language
-
string
Az új alapértelmezett nyelv.
setMaxParallelImageRequests(number)
A képek maximális számát (rasztercsempék, spritesek, ikonok) állítja be párhuzamosan, ami hatással van a raszteres térképek teljesítményére. Alapértelmezés szerint 16.
function setMaxParallelImageRequests(maxParallelImageRequests: number)
Paraméterek
- maxParallelImageRequests
-
number
A párhuzamosan betöltendő képek maximális száma.
setSessionId(string)
Beállítja a térkép- és szolgáltatásmodulok által használt alapértelmezett munkamenet-azonosítót, kivéve, ha a munkamenet-azonosító explicit módon van megadva az API ezen részeinek használatakor. Ha egy térképet explicit módon definiált munkamenet-azonosítóval inicializálnak, és a setSessionId még nem lett meghívva, a térképkonstruktor automatikusan meghívja.
function setSessionId(id: string)
Paraméterek
- id
-
string
Az új alapértelmezett munkamenet-azonosító.
setSubscriptionKey(string)
Beállítja az Azure Maps előfizetési kulcsot alapértelmezett előfizetési kulcsként az atlasz névterében, amelyet a térképvezérlő és az Azure Maps-szolgáltatásoknak kérést küldő modulok használnak. Ha a térkép inicializálva van az előfizetési kulccsal, és a setSubscriptionKey még nem lett meghívva, akkor a térképkonstruktor automatikusan meghívja.
function setSubscriptionKey(key: string)
Paraméterek
- key
-
string
Az új alapértelmezett előfizetési kulcs.
setUserRegion(string)
Figyelmeztetés
Ez az API már elavult.
use atlas.setView(view: string) instead.
function setUserRegion(userRegion: string)
Paraméterek
- userRegion
-
string
setView(string)
Meghatározza, hogy mely geopolitikailag vitatott szegélyek és címkék jelenjenek meg a térképen. A View paraméter (más néven "felhasználói régió paraméter") egy kétbetűs ISO-3166 országkód, amely az adott ország/régió megfelelő térképét jeleníti meg. Azok az országok/régiók, amelyek nem szerepelnek a Nézet listában, vagy ha nincs megadva, alapértelmezés szerint az "Egyesített" nézet lesz. Tekintse meg a támogatott [Nézetek]{@link https://aka.ms/AzureMapsLocalizationViews }. Az Ön felelőssége meghatározni a felhasználók helyét, majd helyesen beállítani a View paramétert az adott helyhez. A View paramétert Azure Maps a vonatkozó jogszabályoknak megfelelően kell használni, beleértve a térképekkel kapcsolatos jogszabályokat is, azon ország/régió vonatkozásában, ahol a térképeket, képeket és egyéb adatokat, valamint a Azure Maps keresztüli hozzáférésre jogosult harmadik féltől származó tartalmakat elérhetővé teszik.
function setView(view: string)
Paraméterek
- view
-
string
Az új alapértelmezett nézet
setWorkerCount(number)
Beállítja a lapon példányosított webmunkások számát. Alapértelmezés szerint a processzormagok számának fele (6-nál van leképezve).
function setWorkerCount(workerCount: number)
Paraméterek
- workerCount
-
number
feldolgozók száma.