atlas module

Balíček:

azure-maps-control

Třídy

EventManager	Správce událostí ovládacího prvku mapy. Vystaveno prostřednictvím vlastnosti události atlasu. Mapovat třídu. Uživatel nemůže vytvořit instanci.
HtmlMarker	Tato třída zabalí element HTML, který lze zobrazit na mapě.
Map	Ovládací prvek pro vizuální a interaktivní webovou mapu
Pixel	Představuje souřadnici nebo posun pixelu. Rozšíří matici [x, y].
Popup	Informační okno ukotvené na zadané pozici na mapě.
PopupTemplate	Šablona rozložení pro místní okno
Shape	Pomocná třída, která zabalí geometrii nebo funkci a usnadňuje aktualizaci a údržbu.

Rozhraní

AggregateExpression	Agregační výraz definuje výpočet, který se zpracovává přes sadu dat. Schéma: [operator: string, initialValue?: boolean | number, mapExpression: Expression] – operátor: Funkce výrazu, která se pak použije na všechny hodnoty vypočítané mapExpression pro každý bod v clusteru. Podporované operátory: o Pro čísla: +, *, max, min o Pro logické hodnoty: all, any initialValue: Optional, počáteční hodnota, ve které je první počítaná hodnota agregovaná. mapExpression: Výraz použitý pro každý bod v sadě dat.
AnimationOptions	Možnosti animace změn v fotoaparátu ovládacího prvku mapy.
AuthenticationManager	Správce ověřování ovládacího prvku mapy. Vystaveno prostřednictvím ověřovací vlastnosti atlasu. Mapovat třídu. Uživatel nemůže vytvořit instanci.
AuthenticationOptions	Možnosti pro určení způsobu ověřování ovládacího prvku mapy ve službách Azure Maps
BubbleLayerOptions	Možnosti použité při vykreslování objektů point v BubbleLayer.
CameraBoundsOptions	Možnosti nastavení hranic kamery ovládacího prvku mapy.
CameraOptions	Možnosti pro nastavení kamery ovládacího prvku mapy.
ClusteredProperties	Vlastnosti, které budou existovat pro ClusteredProperties
CompassControlOptions	Možnosti objektu CompassControl.
Control	Rozhraní pro definování ovládacího prvku mapy.
ControlManager	A manager for the map control's controls. Vystaveno prostřednictvím ovládacích prvků atlasu. Mapovat třídu. Uživatel nemůže vytvořit instanci.
ControlOptions	Možnosti pro přidání ovládacího prvku do mapy
DataSourceOptions	Zdroj dat pro správu dat obrazce, který se zobrazí na mapě. Před zobrazením na mapě musí být zdroj dat přidán do vrstvy. Možnosti pro DataSourceOptions.
ElevationTileSourceOptions
FullscreenControlOptions	Možnosti pro objekt FullScreenControl.
HeatMapLayerOptions	Možnosti použité při vykreslování objektů point v HeatMapLayer.
HtmlMarkerEvents
HtmlMarkerManager	Správce značek HTML ovládacího prvku mapy. Vystaveno prostřednictvím vlastností značek atlasu. Mapovat třídu. Uživatel nemůže vytvořit instanci.
HtmlMarkerOptions	Možnosti pro vykreslení objektu HtmlMarker
HyperLinkFormatOptions	Možnost Formát pro řetězce hypertextových odkazů
IconOptions	Možnosti použité k přizpůsobení ikon v SymbolLayer
ImageLayerOptions	Možnosti používané při vykreslování objektů point v objektu ImageLayer.
ImageSpriteManager	Správce obrazového spritu ovládacího prvku mapy. Vystaveno prostřednictvím vlastnosti imageSprite atlasu. Mapovat třídu. Uživatel nemůže vytvořit instanci.
LayerManager	Správce vrstev ovládacího prvku mapy. Vystavený vlastností vrstev atlasu. Mapovat třídu. Uživatel nemůže vytvořit instanci.
LayerOptions	Základní třída, ze které dědí všechny ostatní možnosti vrstvy.
LightOptions	Možnosti osvětlení mapy.
LineLayerOptions	Možnosti použité při vykreslování SimpleLine, SimplePolygon, CirclePolygon, LineString, MultiLineString, Polygon a MultiPolygon objektů ve vrstvě čáry.
MapConfiguration	Představuje obsah konfigurace mapy, ve kterém je k dispozici seznam stylů.
MapConfigurationStyle	Představuje informace pro jeden styl.
MapDataEvent	Objekt události vrácený mapou, když dojde k datové události.
MapErrorEvent	Objekt události vrácený mapou, když dojde k chybě.
MapEvent	Objekt události vrácený mapou, když dojde k základní události.
MapMouseEvent	Objekt události vrácený mapou, když dojde k události myši.
MapMouseWheelEvent	Objekt události vrácený mapou, když dojde k události kolečka.
MapTouchEvent	Objekt události vrácený mapami, když dojde k dotykové události.
MediaLayerOptions	Možnosti používané při vykreslování plátna, obrázku, rastrové dlaždice a vrstvy videa
Options
Padding	Představuje velikost odsazení v pixelech, které se při nastavování kamery mapy přidají na stranu ohraničujícíhoboxu.
PitchControlOptions	Možnosti objektu PitchControl.
PolygonExtrusionLayerOptions	Možnosti používané při vykreslování Polygon a MultiPolygon objektů v PolygonExtrusionLayer.
PolygonLayerOptions	Možnosti používané při vykreslování objektů Polygon a MultiPolygon v PolygonLayer.
PopupEvents
PopupManager	Správce automaticky otevíraného okna ovládacího prvku mapy. Vystaveno prostřednictvím vlastnosti popups třídy atlas.Map. Uživatel nemůže vytvořit instanci.
PopupOptions	Možnosti automaticky otevírané nabídky
Properties	Sada vlastností, které lze použít s PopupTemplate
PropertyInfo	Podrobnosti o způsobu zobrazení vlastnosti
RasterTileSourceOptions
RequestParameters	Jedná se o typ objektu, který má vrátit zpět zpětné volání transformRequest.
ScaleControlOptions	Možnosti objektu ScaleControl.
ServiceOptions	Globální vlastnosti používané ve všech požadavcích na službu atlas.
ShapeEvents
SourceManager	Správce zdrojů ovládacího prvku mapy. Vystaveno prostřednictvím zdrojů vlastnosti atlasu. Mapovat třídu. Uživatel nemůže vytvořit instanci.
StyleChangedEvent	Objekt události vrácený mapou po načtení nového stylu
StyleControlOptions	Možnosti pro StyleControl objektu.
StyleOptions	Možnosti stylu mapy.
SymbolLayerOptions	Možnosti použité při vykreslování geometrií v symboluLayer
TargetedEvent
TextOptions	Možnosti použité k přizpůsobení textu v symboluLayer
Tile	Objekt dlaždice vrácený mapou, když dojde k události zdrojových dat.
TileId
TileLayerOptions	Možnosti používané při vykreslování rastrových dlaždicových obrázků v tileLayeru
TrafficControlOptions
TrafficOptions	Možnosti nastavení provozu na mapě
UserInteractionOptions	Možnosti povolení nebo zakázání interakce uživatelů s mapou
VectorTileSourceOptions	Zdroj dat pro správu dat obrazce, který se zobrazí na mapě. Před zobrazením na mapě musí být zdroj dat přidán do vrstvy. Možnosti pro VectorTileSource.
WebGLLayerOptions	Možnosti použité k vykreslení grafiky v nástroji WebGLLayer
WebGLRenderer	Rozhraní pro vykreslování grafiky WebGL v nástroji WebGLLayer
ZoomControlOptions	Možnosti objektu ZoomControl.

Aliasy typu

Expression	Lze zadat jako hodnotu filtru nebo určitých možností vrstvy. Výraz definuje vzorec pro výpočet hodnoty vlastnosti. Výrazy jsou reprezentovány jako pole JSON. Prvním prvkem výrazu je řetězec pojmenování operátoru výrazu.
getAuthTokenCallback	Funkce zpětného volání použitá k získání ověřovacího tokenu v režimu anonymního ověřování. Vyřešte problém s ověřovacím tokenem nebo zamítněte případné chyby.
ResourceType
StyleImageMetadata	Podpis parametru options předaného ImageSpriteManager.add.

Výčty

AuthenticationType	Výčet použitý k určení typu ověřovacího mechanismu, který se má použít.
ControlPosition	Pozice, kde lze ovládací prvek umístit na mapu.
ControlStyle	Dostupné styly ovládacího prvku

Funkce

addImageTemplate(string, string, boolean)	Přidá šablonu obrázku do oboru názvů atlas.
addProtocol(string, (args: any[]) => Promise<any>)	Přidá vlastní funkci prostředku načtení, která se bude volat při použití adresy URL, která začíná vlastním schématem adresy URL.
clearPrewarmedResources()	Vymaže prostředky, které byly dříve vytvořeny atlas.prewarm(). Všimněte si, že to obvykle není nutné. Tuto funkci byste měli volat pouze v případě, že očekáváte, že se uživatel vaší aplikace nebude v žádném okamžiku v aplikaci vracet do zobrazení mapy.
getAllImageTemplateNames()	Načte pole názvů pro všechny šablony obrázků, které jsou k dispozici v oboru názvů atlas.
getAuthenticationOptions()	Získá výchozí možnosti ověřování, které byly poskytnuty. Pokud dříve nebyly nastaveny všechny vlastnosti, nebudou definovány.
getDomain()	Získá výchozí doménu, kterou jste zadali. Pokud není dříve nastavena výchozí hodnota je "atlas.microsoft.com".
getImageTemplate(string, number)	Načte šablonu SVG podle názvu.
getLanguage()	Získá výchozí jazyk, který byl poskytnut. Pokud není dříve nastavena výchozí hodnota je "NGT".
getMaxParallelImageRequests()	Získá maximální počet obrázků (rastrové dlaždice, sprity, ikony) pro paralelní načtení.
getSessionId()	Získá výchozí ID relace, které bylo poskytnuto. Pokud jste předtím nenastavili výchozí hodnotu, je náhodné UUID.
getSubscriptionKey()	Získá výchozí klíč předplatného Azure Maps, který byl poskytnut.
getUserRegion()
getVersion()	Aktuální číslo verze rozhraní API na základě čísla buildu
getView()	Získá výchozí zobrazení nastavení mapového ovládacího prvku. Pokud není dříve nastavena výchozí hodnota je undefined.
getWorkerCount()	Získá počet pracovních procesů, který se vytvoří.
isSupported(boolean)	Zkontroluje, jestli ovládací prvek mapy podporuje prohlížeč uživatele.
prewarm()	Inicializuje prostředky, jako jsou WebWorkers, které se dají sdílet napříč mapami, aby se v některých situacích snížily časy načítání. atlas.setWorkerCount, pokud používáte, musí být nastavena před zavolání prewarm() má účinek. Ve výchozím nastavení se životní cyklus těchto prostředků spravuje automaticky a při prvním vytvoření mapy se líně inicializují. Vyvoláním prewarm()se tyto prostředky vytvoří předem a po odebrání poslední mapy ze stránky nebudou vymazány. To umožňuje jejich opětovné použití novými instancemi map, které se vytvoří později. Je možné je ručně vymazat voláním atlas.clearPrewarmedResources(). To je nezbytné jenom v případě, že vaše webová stránka zůstane aktivní, ale úplně přestane používat mapy. To je primárně užitečné při použití GL-JS map v jedné stránkové aplikaci, kde by uživatel přecházení mezi různými zobrazeními, které můžou způsobit neustálé vytváření a zničení instancí mapy.
removeProtocol(string)	Odebere dříve přidaný protokol v hlavním vlákně.
setAuthenticationOptions(AuthenticationOptions)	Nastaví možnosti ověřování jako výchozí možnosti v oboru názvů atlas, který používá ovládací prvek mapy, a všechny moduly, které nutí požadavky na služby Azure Maps. Pokud se mapa inicializuje s explicitně definovanými možnostmi ověřování a vlastnost setAuthenticationOptions nebyla dříve volána, bude automaticky volána konstruktorem Map.
setDomain(string)	Nastaví výchozí doménu používanou moduly mapování a služeb, pokud není doména explicitně určena při použití těchto částí rozhraní API. Pokud je mapa inicializována s doménou explicitně definovanou a setDomain nebyla dříve volána, bude automaticky volána konstruktorem Map. Pokud není zadaný protokol https se předpokládá.
setLanguage(string)	Nastaví výchozí jazyk používaný moduly map a služeb, pokud není jazyk explicitně určen při použití těchto částí rozhraní API. Pokud je mapa inicializována pomocí jazyka explicitně definovaného a sadaLanguage nebyla dříve volána, bude automaticky volána konstruktorem Map.
setMaxParallelImageRequests(number)	Nastaví maximální počet obrázků (rastrové dlaždice, sprity, ikony) pro paralelní načtení, což má vliv na výkon v rastrových mapách. Ve výchozím nastavení je to 16.
setSessionId(string)	Nastaví výchozí ID relace používané moduly mapování a služeb, pokud není ID relace explicitně zadáno při použití těchto částí rozhraní API. Pokud je mapování inicializováno s ID relace explicitně definované a sadaSessionId nebyla dříve volána, bude automaticky volána konstruktorem Map.
setSubscriptionKey(string)	Nastaví klíč předplatného Azure Maps jako výchozí klíč předplatného v oboru názvů atlas, který používá ovládací prvek mapování a všechny moduly, které nutí požadavky na služby Azure Maps. Pokud je mapování inicializováno pomocí klíče předplatného explicitně definované a sadaSubscriptionKey nebyla dříve volána, bude automaticky volána konstruktorem Map.
setUserRegion(string)
setView(string)	Určuje, která sada geopoliticky sporných ohraničení a popisků se zobrazí na mapě. Parametr Zobrazení (označovaný také jako parametr oblasti uživatele) je 2 písmena ISO-3166 Kód země, který zobrazí správné mapy pro danou zemi/oblast. Země/oblasti, které nejsou v seznamu zobrazení nebo pokud nejsou zadané, ve výchozím nastavení se zobrazí jednotné zobrazení. Projděte si podporované [zobrazení]{@link https://aka.ms/AzureMapsLocalizationViews }. Je vaší zodpovědností určit umístění uživatelů a pak nastavit parametr View správně pro dané umístění. Parametr Zobrazení ve službě Azure Maps se musí používat v souladu s platnými zákony, včetně těch týkajících se mapování, země/oblasti, ve které jsou mapy, obrázky a další data a obsah třetích stran, ke kterému máte oprávnění přistupovat přes Azure Maps, je k dispozici.
setWorkerCount(number)	Nastaví počet instancí webových pracovních procesů na stránce. Ve výchozím nastavení je nastaveno na polovinu počtu jader procesoru (omezených na 6).

Podrobnosti funkce

addImageTemplate(string, string, boolean)

Přidá šablonu obrázku do oboru názvů atlas.

function addImageTemplate(templateName: string, template: string, override: boolean)

Parametry

templateName

string

Název šablony.

template

string

Šablona SVG, která se má přidat. Podporuje {color}, {secondaryColor}, {scale}, {text}.

override

boolean

Určuje, jestli má přepsat existující šablony, pokud již existuje jeden se stejným názvem.

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

Přidá vlastní funkci prostředku načtení, která se bude volat při použití adresy URL, která začíná vlastním schématem adresy URL.

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

Parametry

customProtocol

string

protokol pro připojení, například "vlastní".

loadFn

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

funkce, která se má použít při pokusu o načtení dlaždice určené customProtocol

clearPrewarmedResources()

Vymaže prostředky, které byly dříve vytvořeny atlas.prewarm(). Všimněte si, že to obvykle není nutné. Tuto funkci byste měli volat pouze v případě, že očekáváte, že se uživatel vaší aplikace nebude v žádném okamžiku v aplikaci vracet do zobrazení mapy.

function clearPrewarmedResources()

getAllImageTemplateNames()

Načte pole názvů pro všechny šablony obrázků, které jsou k dispozici v oboru názvů atlas.

function getAllImageTemplateNames(): string[]

Návraty

string[]

getAuthenticationOptions()

Získá výchozí možnosti ověřování, které byly poskytnuty. Pokud dříve nebyly nastaveny všechny vlastnosti, nebudou definovány.

function getAuthenticationOptions(): AuthenticationOptions

Návraty

AuthenticationOptions

getDomain()

Získá výchozí doménu, kterou jste zadali. Pokud není dříve nastavena výchozí hodnota je "atlas.microsoft.com".

function getDomain(): string

Návraty

string

getImageTemplate(string, number)

Načte šablonu SVG podle názvu.

function getImageTemplate(templateName: string, scale?: number): string

Parametry

templateName

string

Název šablony, která se má načíst.

scale

number

Určuje, kolik se má šablona škálovat. Pokud chcete dosáhnout nejlepších výsledků, škálujte ikonu na maximální velikost, kterou chcete zobrazit na mapě, a pak pomocí možnosti velikost ikon vrstev symbolů v případě potřeby vertikálně snížit kapacitu. Kvůli škálování se tím sníží rozmazanost. Výchozí hodnota: 1

Návraty

string

getLanguage()

Získá výchozí jazyk, který byl poskytnut. Pokud není dříve nastavena výchozí hodnota je "NGT".

function getLanguage(): string

Návraty

string

getMaxParallelImageRequests()

Získá maximální počet obrázků (rastrové dlaždice, sprity, ikony) pro paralelní načtení.

function getMaxParallelImageRequests(): number

Návraty

number

getSessionId()

Získá výchozí ID relace, které bylo poskytnuto. Pokud jste předtím nenastavili výchozí hodnotu, je náhodné UUID.

function getSessionId(): string

Návraty

string

getSubscriptionKey()

Získá výchozí klíč předplatného Azure Maps, který byl poskytnut.

function getSubscriptionKey(): string

Návraty

string

getUserRegion()

Upozornění

Toto rozhraní API je teď zastaralé.

use atlas.getView() instead

function getUserRegion(): string

Návraty

string

getVersion()

Aktuální číslo verze rozhraní API na základě čísla buildu

function getVersion(): string

Návraty

string

getView()

Získá výchozí zobrazení nastavení mapového ovládacího prvku. Pokud není dříve nastavena výchozí hodnota je undefined.

function getView(): string

Návraty

string

getWorkerCount()

Získá počet pracovních procesů, který se vytvoří.

function getWorkerCount(): number

Návraty

number

isSupported(boolean)

Zkontroluje, jestli ovládací prvek mapy podporuje prohlížeč uživatele.

function isSupported(failIfMajorPerformanceCaveat?: boolean): boolean

Parametry

failIfMajorPerformanceCaveat

boolean

Pokud je hodnota true, vrátí funkce hodnotu false, pokud by výkon ovládacího prvku mapy byl výrazně horší než očekávaný (například by se použil softwarový renderer WebGL).

Návraty

boolean

prewarm()

Inicializuje prostředky, jako jsou WebWorkers, které se dají sdílet napříč mapami, aby se v některých situacích snížily časy načítání. atlas.setWorkerCount, pokud používáte, musí být nastavena před zavolání prewarm() má účinek. Ve výchozím nastavení se životní cyklus těchto prostředků spravuje automaticky a při prvním vytvoření mapy se líně inicializují. Vyvoláním prewarm()se tyto prostředky vytvoří předem a po odebrání poslední mapy ze stránky nebudou vymazány. To umožňuje jejich opětovné použití novými instancemi map, které se vytvoří později. Je možné je ručně vymazat voláním atlas.clearPrewarmedResources(). To je nezbytné jenom v případě, že vaše webová stránka zůstane aktivní, ale úplně přestane používat mapy.

To je primárně užitečné při použití GL-JS map v jedné stránkové aplikaci, kde by uživatel přecházení mezi různými zobrazeními, které můžou způsobit neustálé vytváření a zničení instancí mapy.

function prewarm()

removeProtocol(string)

Odebere dříve přidaný protokol v hlavním vlákně.

function removeProtocol(customProtocol: string)

Parametry

customProtocol

string

vlastní protokol pro odebrání registrace pro

setAuthenticationOptions(AuthenticationOptions)

Nastaví možnosti ověřování jako výchozí možnosti v oboru názvů atlas, který používá ovládací prvek mapy, a všechny moduly, které nutí požadavky na služby Azure Maps. Pokud se mapa inicializuje s explicitně definovanými možnostmi ověřování a vlastnost setAuthenticationOptions nebyla dříve volána, bude automaticky volána konstruktorem Map.

function setAuthenticationOptions(options: AuthenticationOptions)

Parametry

options

AuthenticationOptions

Nové výchozí možnosti ověřování.

setDomain(string)

Nastaví výchozí doménu používanou moduly mapování a služeb, pokud není doména explicitně určena při použití těchto částí rozhraní API. Pokud je mapa inicializována s doménou explicitně definovanou a setDomain nebyla dříve volána, bude automaticky volána konstruktorem Map. Pokud není zadaný protokol https se předpokládá.

function setDomain(domain: string)

Parametry

domain

string

Nová výchozí doména.

setLanguage(string)

Nastaví výchozí jazyk používaný moduly map a služeb, pokud není jazyk explicitně určen při použití těchto částí rozhraní API. Pokud je mapa inicializována pomocí jazyka explicitně definovaného a sadaLanguage nebyla dříve volána, bude automaticky volána konstruktorem Map.

function setLanguage(language: string)

Parametry

language

string

Nový výchozí jazyk.

setMaxParallelImageRequests(number)

Nastaví maximální počet obrázků (rastrové dlaždice, sprity, ikony) pro paralelní načtení, což má vliv na výkon v rastrových mapách. Ve výchozím nastavení je to 16.

function setMaxParallelImageRequests(maxParallelImageRequests: number)

Parametry

maxParallelImageRequests

number

Maximální počet obrázků, které se mají načíst paralelně.

setSessionId(string)

Nastaví výchozí ID relace používané moduly mapování a služeb, pokud není ID relace explicitně zadáno při použití těchto částí rozhraní API. Pokud je mapování inicializováno s ID relace explicitně definované a sadaSessionId nebyla dříve volána, bude automaticky volána konstruktorem Map.

function setSessionId(id: string)

Parametry

id

string

Nové id výchozí relace.

setSubscriptionKey(string)

Nastaví klíč předplatného Azure Maps jako výchozí klíč předplatného v oboru názvů atlas, který používá ovládací prvek mapování a všechny moduly, které nutí požadavky na služby Azure Maps. Pokud je mapování inicializováno pomocí klíče předplatného explicitně definované a sadaSubscriptionKey nebyla dříve volána, bude automaticky volána konstruktorem Map.

function setSubscriptionKey(key: string)

Parametry

key

string

Nový výchozí klíč předplatného.

setUserRegion(string)

Upozornění

Toto rozhraní API je teď zastaralé.

use atlas.setView(view: string) instead.

function setUserRegion(userRegion: string)

Parametry

userRegion

string

setView(string)

Určuje, která sada geopoliticky sporných ohraničení a popisků se zobrazí na mapě. Parametr Zobrazení (označovaný také jako parametr oblasti uživatele) je 2 písmena ISO-3166 Kód země, který zobrazí správné mapy pro danou zemi/oblast. Země/oblasti, které nejsou v seznamu zobrazení nebo pokud nejsou zadané, ve výchozím nastavení se zobrazí jednotné zobrazení. Projděte si podporované [zobrazení]{@link https://aka.ms/AzureMapsLocalizationViews }. Je vaší zodpovědností určit umístění uživatelů a pak nastavit parametr View správně pro dané umístění. Parametr Zobrazení ve službě Azure Maps se musí používat v souladu s platnými zákony, včetně těch týkajících se mapování, země/oblasti, ve které jsou mapy, obrázky a další data a obsah třetích stran, ke kterému máte oprávnění přistupovat přes Azure Maps, je k dispozici.

function setView(view: string)

Parametry

view

string

Nové výchozí zobrazení

setWorkerCount(number)

Nastaví počet instancí webových pracovních procesů na stránce. Ve výchozím nastavení je nastaveno na polovinu počtu jader procesoru (omezených na 6).

function setWorkerCount(workerCount: number)

Parametry

workerCount

number

počet pracovních procesů.