atlas module

Balíček:

azure-maps-control

Třídy

EventManager	Správce událostí ovládacího prvku mapy. Vystaveno prostřednictvím vlastnosti events atlasu. Mapová třída. 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 v pixelech. Rozšíří pole [x, y].
Popup	Informační okno ukotvené na zadaném místě na mapě.
PopupTemplate	Šablona rozložení pro automaticky otevírané okno
Shape	Pomocná třída, která zabalí geometrii nebo prvek 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 pro všechny hodnoty vypočítané hodnotou mapExpression pro každý bod v clusteru. Podporované operátory: o Pro čísla: +, *, max, min o Pro logické hodnoty: all, any initialValue: Volitelné, počáteční hodnota, ve které se agreguje první počítaná hodnota. mapExpression: Výraz, který se použije pro každý bod v sadě dat.
AnimationOptions	Možnosti animace změn v kameře ovládacího prvku mapy.
AuthenticationManager	Správce pro ověřování ovládacího prvku mapy. Vystaveno prostřednictvím vlastnosti ověřování atlasu. Mapová třída. Uživatel nemůže vytvořit instanci.
AuthenticationOptions	Možnosti pro určení způsobu ověřování ovládacího prvku mapy u služeb Azure Maps
BubbleLayerOptions	Možnosti používané při vykreslování objektů Point v BubbleLayer.
CameraBoundsOptions	Možnosti nastavení hranic kamery ovládacího prvku mapy.
CameraOptions	Možnosti 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	Správce ovládacích prvků mapového ovládacího prvku. Vystaveno prostřednictvím vlastnosti ovládacích prvků atlasu. Mapová třída. 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ě. Zdroj dat musí být přidán do vrstvy, aby byl viditelný na mapě. Možnosti pro DataSourceOptions.
ElevationTileSourceOptions
HeatMapLayerOptions	Možnosti používané při vykreslování objektů Point v HeatMapLayer.
HtmlMarkerEvents
HtmlMarkerManager	Správce značek HTML ovládacího prvku mapy. Vystaveno prostřednictvím vlastnosti značek atlasu. Map – třída Uživatel nemůže vytvořit instanci.
HtmlMarkerOptions	Možnosti pro vykreslení objektu HtmlMarker
HyperLinkFormatOptions	Možnost Formátování pro řetězce hypertextových odkazů
IconOptions	Možnosti sloužící k přizpůsobení ikon v SymbolLayer
ImageLayerOptions	Možnosti používané při vykreslování objektů Point v objektu ImageLayer.
ImageSpriteManager	Správce obrázkového spritu ovládacího prvku mapy Vystaveno prostřednictvím vlastnosti imageSprite atlasu. Map – třída Uživatel nemůže vytvořit instanci.
LayerManager	Správce vrstev ovládacího prvku mapy. Vystaveno prostřednictvím vlastnosti vrstev atlasu. Map – třída 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žívané při vykreslování objektů SimpleLine, SimplePolygon, CirclePolygon, LineString, MultiLineString, Polygon a MultiPolygon ve vrstvě čáry
MapConfiguration	Představuje obsah konfigurace mapování se seznamem stylů, které jsou pro ně k dispozici.
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 chybové události.
MapEvent	Objekt události vrácený mapou, když dojde k základní události.
MapMouseEvent	Objekt události vrácený mapami, 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 události dotyku.
MediaLayerOptions	Možnosti použité při vykreslování vrstvy plátna, obrázku, rastrové dlaždice a videa
Options
Padding	Představuje množství odsazení v pixelech, které se má přidat na stranu BoundingBox při nastavování fotoaparátu mapy.
PitchControlOptions	Možnosti objektu PitchControl.
PolygonExtrusionLayerOptions	Možnosti používané při vykreslování Polygon objektů a MultiPolygon objektů v objektu PolygonExtrusionLayer.
PolygonLayerOptions	Možnosti použité při vykreslování mnohoúhelníku a MultiPolygon objekty v PolygonLayer.
PopupEvents
PopupManager	Správce automaticky otevíraného okna ovládacího prvku mapy Vystaveno popups prostřednictvím vlastnosti atlas.Map třídy . 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	Druh podrobnosti o tom, jak má být vlastnost zobrazena.
RasterTileSourceOptions
RequestParameters	Toto je typ objektu, který by měl být vrácen zpětným voláním transformRequest.
ScaleControlOptions	Možnosti objektu ScaleControl.
ServiceOptions	Globální vlastnosti používané ve všech žádostech o službu Atlas
ShapeEvents
SourceManager	Správce zdrojů ovládacího prvku mapy. Vystaveno prostřednictvím vlastnosti sources atlasu. Map – třída Uživatel nemůže vytvořit instanci.
StyleChangedEvent	Objekt události vrácený mapou po načtení nového stylu.
StyleControlOptions	Možnosti StyleControl objektu.
StyleOptions	Možnosti stylu mapy
SymbolLayerOptions	Možnosti použité při vykreslování geometrií v SymbolLayer.
TargetedEvent
TextOptions	Možnosti použité k přizpůsobení textu v SymbolLayer
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ždic obrázků v TileLayer.
TrafficControlOptions
TrafficOptions	Možnosti nastavení provozu na mapě
UserInteractionOptions	Možnosti pro povolení nebo zakázání interakce uživatelů s mapou
VectorTileSourceOptions	Zdroj dat pro správu dat obrazce, který se zobrazí na mapě. Zdroj dat musí být přidán do vrstvy, aby byl viditelný na mapě. Možnosti pro VectorTileSource.
WebGLLayerOptions	Možnosti použité k vykreslení grafiky v prohlížeči WebGLLayer.
WebGLRenderer	Rozhraní pro vykreslování grafiky WebGL v objektu WebGLLayer.
ZoomControlOptions	Možnosti objektu ZoomControl.

Aliasy typu

Expression	Lze zadat jako hodnotu filtru nebo určité možnosti 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, který pojme operátor výrazu.
getAuthTokenCallback	Funkce zpětného volání použitá k získání ověřovacího tokenu v anonymním režimu ověřování. Řešení s využitím ověřovacího tokenu nebo odmítnutí se všemi chybami.
ResourceType
StyleImageMetadata	Podpis pro options parametr předaný do ImageSpriteManager.add.

Výčty

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

Funkce

addImageTemplate(string, string, boolean)	Přidá šablonu obrázku do oboru názvů atlas.
clearPrewarmedResources()	Vymaže prostředky, které byly dříve vytvořeny nástrojem atlas.prewarm(). Mějte na paměti, ž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 v žádném okamžiku aplikace nevrátí 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 nejsou dříve nastavené, všechny vlastnosti nebudou definovány.
getDomain()	Získá výchozí doménu, která byla poskytnuta. Pokud tomu tak nebylo dříve, 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 tomu tak nebylo dříve, výchozí hodnota je "NGT".
getMaxParallelImageRequests()	Získá maximální počet obrázků (rastrové dlaždice, sprity, ikony), které se mají načíst paralelně.
getSessionId()	Získá výchozí ID relace, který byl poskytnut. Pokud jste ho předtím nenastavili, výchozí hodnotou je náhodné UUID.
getSubscriptionKey()	Získá výchozí Azure Maps klíč předplatného, který byl poskytnut.
getUserRegion()
getVersion()	Aktuální číslo verze rozhraní API na základě čísla sestavení.
getView()	Získá výchozí nastavení zobrazení mapového ovládacího prvku. Pokud tomu tak nebylo dříve, výchozí hodnota je undefined.
getWorkerCount()	Získá počet pracovních procesů, které budou vytvořeny.
isSupported(boolean)	Zkontroluje, jestli ovládací prvek mapy podporuje prohlížeč uživatele.
prewarm()	Inicializuje prostředky, jako jsou webworkery, které je možné sdílet v mapách, aby se v některých situacích snížila doba načítání. atlas.setWorkerCount, pokud se používá, musí být nastaven před prewarm() zavolání funkce , aby měla účinek. Ve výchozím nastavení se životní cyklus těchto prostředků spravuje automaticky a líně se inicializují při prvním vytvoření mapy. Vyvoláním prewarm()se tyto prostředky vytvoří předem a při odebrání poslední mapy ze stránky se nevymaže. To umožňuje jejich opětovné použití novými instancemi map vytvořenými později. Můžete je ručně vymazat voláním atlas.clearPrewarmedResources(). To je nutné jenom v případě, že vaše webová stránka zůstane aktivní, ale mapy úplně přestane používat. To je především užitečné při použití map GL-JS v aplikaci s jednou stránkou, kdy uživatel přecházení mezi různými zobrazeními, což může způsobit neustálé vytváření a zničení instancí map.
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é ho zasílají na služby Azure Maps. Pokud je mapování inicializováno s explicitně definovanými možnostmi ověřování a setAuthenticationOptions nebyla dříve volána, bude automaticky volána konstruktorem Map.
setDomain(string)	Nastaví výchozí doménu používanou moduly map a služeb, pokud není doména při použití těchto částí rozhraní API explicitně určená. Pokud je mapování inicializováno s explicitně definovanou doménou a setDomain nebyla dříve volána, bude automaticky volána konstruktorem Map. Pokud není zadaný https protokol, předpokládá se.
setLanguage(string)	Nastaví výchozí jazyk používaný moduly map a služeb, pokud není jazyk při použití těchto částí rozhraní API explicitně zadán. Pokud je map inicializován s jazykem explicitně definovaným a setLanguage nebyl dříve volán, bude automaticky volán konstruktorem Map.
setMaxParallelImageRequests(number)	Nastaví paralelně načítaný maximální počet obrázků (rastrové dlaždice, sprity, ikony), 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žby, pokud není id relace explicitně zadáno při použití těchto částí rozhraní API. Pokud je mapování inicializováno s explicitně definovaným ID relace a setSessionId 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é ho zasílají na služby Azure Maps. Pokud je mapování inicializováno s explicitně definovaným klíčem předplatného a setSubscriptionKey nebyl dříve volán, bude automaticky voláno konstruktorem Map.
setUserRegion(string)
setView(string)	Určuje, která sada geopoliticky sporných ohraničení a popisků se zobrazí na mapě. Parametr View (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 nebo oblast. Země nebo oblasti, které nejsou v seznamu Zobrazení nebo pokud nejsou zadané, budou ve výchozím nastavení používat sjednocené zobrazení. Projděte si podporované [zobrazení]{@link https://aka.ms/AzureMapsLocalizationViews }. Je na vás, abyste určili umístění uživatelů a pak pro toto umístění správně nastavili parametr View. Parametr Zobrazení v Azure Maps musí být použit v souladu s platnými zákony, včetně těch týkajících se mapování, země/oblasti, kde jsou mapy, obrázky a další data a obsah třetích stran, ke kterému máte oprávnění přistupovat prostřednictvím Azure Maps.
setWorkerCount(number)	Nastaví počet webových pracovních procesů, které se vytvoří na stránce. Ve výchozím nastavení je nastavená na polovinu počtu jader procesoru (omezený 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 šablona se stejným názvem.

clearPrewarmedResources()

Vymaže prostředky, které byly dříve vytvořeny nástrojem atlas.prewarm(). Mějte na paměti, ž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 v žádném okamžiku aplikace nevrátí 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 nejsou dříve nastavené, všechny vlastnosti nebudou definovány.

function getAuthenticationOptions(): AuthenticationOptions

Návraty

AuthenticationOptions

getDomain()

Získá výchozí doménu, která byla poskytnuta. Pokud tomu tak nebylo dříve, 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, o kolik se má šablona škálovat. Nejlepších výsledků dosáhnete, když nastavíte velikost ikony na maximální velikost, kterou chcete zobrazit na mapě, a pak v případě potřeby pomocí možnosti Velikost ikon symbolů vertikálně snižte kapacitu. Tím se sníží rozmazanost v důsledku škálování. Výchozí: 1

Návraty

string

getLanguage()

Získá výchozí jazyk, který byl poskytnut. Pokud tomu tak nebylo dříve, 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), které se mají načíst paralelně.

function getMaxParallelImageRequests(): number

Návraty

number

getSessionId()

Získá výchozí ID relace, který byl poskytnut. Pokud jste ho předtím nenastavili, výchozí hodnotou je náhodné UUID.

function getSessionId(): string

Návraty

string

getSubscriptionKey()

Získá výchozí Azure Maps klíč předplatného, 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 sestavení.

function getVersion(): string

Návraty

string

getView()

Získá výchozí nastavení zobrazení mapového ovládacího prvku. Pokud tomu tak nebylo dříve, výchozí hodnota je undefined.

function getView(): string

Návraty

string

getWorkerCount()

Získá počet pracovních procesů, které budou vytvořeny.

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ž se čekalo (například by se použil softwarový vykreslovací modul WebGL).

Návraty

boolean

prewarm()

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

To je především užitečné při použití map GL-JS v aplikaci s jednou stránkou, kdy uživatel přecházení mezi různými zobrazeními, což může způsobit neustálé vytváření a zničení instancí map.

function prewarm()

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é ho zasílají na služby Azure Maps. Pokud je mapování inicializováno s explicitně definovanými možnostmi ověřování a 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 map a služeb, pokud není doména při použití těchto částí rozhraní API explicitně určená. Pokud je mapování inicializováno s explicitně definovanou doménou a setDomain nebyla dříve volána, bude automaticky volána konstruktorem Map. Pokud není zadaný https protokol, předpokládá se.

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 při použití těchto částí rozhraní API explicitně zadán. Pokud je map inicializován s jazykem explicitně definovaným a setLanguage nebyl dříve volán, bude automaticky volán konstruktorem Map.

function setLanguage(language: string)

Parametry

language

string

Nový výchozí jazyk.

setMaxParallelImageRequests(number)

Nastaví paralelně načítaný maximální počet obrázků (rastrové dlaždice, sprity, ikony), 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žby, pokud není id relace explicitně zadáno při použití těchto částí rozhraní API. Pokud je mapování inicializováno s explicitně definovaným ID relace a setSessionId nebyla dříve volána, bude automaticky volána konstruktorem Map.

function setSessionId(id: string)

Parametry

id

string

Nové výchozí ID 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é ho zasílají na služby Azure Maps. Pokud je mapování inicializováno s explicitně definovaným klíčem předplatného a setSubscriptionKey nebyl dříve volán, bude automaticky voláno 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 View (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 nebo oblast. Země nebo oblasti, které nejsou v seznamu Zobrazení nebo pokud nejsou zadané, budou ve výchozím nastavení používat sjednocené zobrazení. Projděte si podporované [zobrazení]{@link https://aka.ms/AzureMapsLocalizationViews }. Je na vás, abyste určili umístění uživatelů a pak pro toto umístění správně nastavili parametr View. Parametr Zobrazení v Azure Maps musí být použit v souladu s platnými zákony, včetně těch týkajících se mapování, země/oblasti, kde jsou mapy, obrázky a další data a obsah třetích stran, ke kterému máte oprávnění přistupovat prostřednictvím Azure Maps.

function setView(view: string)

Parametry

view

string

Nové výchozí zobrazení

setWorkerCount(number)

Nastaví počet webových pracovních procesů, které se vytvoří na stránce. Ve výchozím nastavení je nastavená na polovinu počtu jader procesoru (omezený na 6).

function setWorkerCount(workerCount: number)

Parametry

workerCount

number

počet pracovních procesů.