atlas module
Sınıflar
EventManager |
Harita denetiminin olayları için bir yönetici. Atlasın events özelliği aracılığıyla kullanıma sunulur. Eşleme sınıfı. Kullanıcı tarafından örnek oluşturulamaz. |
HtmlMarker |
Bu sınıf, haritada görüntülenebilen bir HTML öğesini sarmalar. |
Map |
Görsel ve etkileşimli web haritası denetimi. |
Pixel |
Piksel koordinatı veya uzaklığını temsil edin. [x, y] dizisini genişletir. |
Popup |
Haritada belirtilen konuma sabitlenmiş bir bilgi penceresi. |
PopupTemplate |
Açılan pencere için düzen şablonu. |
Shape |
Geometriyi veya Özelliği sarmalayan ve güncelleştirme ve bakımı kolaylaştıran bir yardımcı sınıfı. |
Arabirimler
AggregateExpression |
Toplama ifadesi, bir veri kümesi üzerinde işlenen bir hesaplamayı tanımlar.
Şema: [operator: string, initialValue?: boolean | number, mapExpression: Expression] işleci: Daha sonra kümedeki her nokta için tarafından hesaplanan |
AnimationOptions |
Harita denetiminin kamerasındaki değişiklikleri görselleştirme seçenekleri. |
AuthenticationManager |
Harita denetiminin kimlik doğrulaması için bir yönetici. Atlas'ın kimlik doğrulama özelliği aracılığıyla kullanıma sunuldu. Eşleme sınıfı. Kullanıcı tarafından örnek oluşturulamaz. |
AuthenticationOptions |
Harita denetiminin Azure Haritalar hizmetlerinde nasıl kimlik doğrulaması yapması gerektiğini belirtme seçenekleri. |
BubbleLayerOptions |
Bir BubbleLayer'da Point nesneleri işlenirken kullanılan seçenekler. |
CameraBoundsOptions |
Harita denetiminin kamerasının sınırlarını ayarlama seçenekleri. |
CameraOptions |
Harita denetiminin kamerasını ayarlama seçenekleri. |
ClusteredProperties |
ClusteredProperties için mevcut olacak özellikler |
CompassControlOptions |
CompassControl nesnesinin seçenekleri. |
Control |
Haritanın denetimini tanımlamak için bir arabirim. |
ControlManager |
Harita denetiminin denetimleri için bir yönetici. Atlasın controls özelliği aracılığıyla kullanıma sunulur. Eşleme sınıfı. Kullanıcı tarafından örnek oluşturulamaz. |
ControlOptions |
Haritaya denetim ekleme seçenekleri. |
DataSourceOptions |
Haritada görüntülenecek şekil verilerini yönetmek için bir veri kaynağı.
Veri kaynağının haritada görünmeden önce katmana eklenmesi gerekir.
için |
ElevationTileSourceOptions | |
HeatMapLayerOptions |
HeatMapLayer'da Point nesneleri işlenirken kullanılan seçenekler. |
HtmlMarkerEvents | |
HtmlMarkerManager |
Harita denetiminin HTML işaretçileri için bir yönetici. Atlasın markers özelliği aracılığıyla kullanıma sunuldu. Eşleme sınıfı. Kullanıcı tarafından örnek oluşturulamaz. |
HtmlMarkerOptions |
HtmlMarker nesnesini işleme seçenekleri |
HyperLinkFormatOptions |
Köprü dizeleri için biçim seçeneği. |
IconOptions |
SymbolLayer'daki simgeleri özelleştirmek için kullanılan seçenekler |
ImageLayerOptions |
ImageLayer'da Point nesneleri işlenirken kullanılan seçenekler. |
ImageSpriteManager |
Harita denetiminin görüntü sprite yöneticisi. Atlasın imageSprite özelliği aracılığıyla kullanıma sunuldu. Eşleme sınıfı. Kullanıcı tarafından örnek oluşturulamaz. |
LayerManager |
Harita denetiminin katmanları için bir yönetici. Atlasın layers özelliği aracılığıyla kullanıma sunuldu. Eşleme sınıfı. Kullanıcı tarafından örnek oluşturulamaz. |
LayerOptions |
Diğer tüm katman seçeneklerinin devralındığı temel sınıf. |
LightOptions |
Haritanın aydınlatma seçenekleri. |
LineLayerOptions |
Bir çizgi katmanında SimpleLine, SimplePolygon, CirclePolygon, LineString, MultiLineString, Polygon ve MultiPolygon nesneleri işlenirken kullanılan seçenekler. |
MapConfiguration |
Kullanılabilir stillerin listesini içeren harita yapılandırmasının içeriğini temsil eder. |
MapConfigurationStyle |
Tek bir stilin bilgilerini temsil eder. |
MapDataEvent |
Bir veri olayı gerçekleştiğinde eşlemeler tarafından döndürülen olay nesnesi. |
MapErrorEvent |
Bir hata olayı oluştuğunda eşlemeler tarafından döndürülen olay nesnesi. |
MapEvent |
Temel bir olay gerçekleştiğinde eşlemeler tarafından döndürülen olay nesnesi. |
MapMouseEvent |
Bir fare olayı gerçekleştiğinde eşlemeler tarafından döndürülen olay nesnesi. |
MapMouseWheelEvent |
Bir tekerlek olayı gerçekleştiğinde eşlemeler tarafından döndürülen olay nesnesi. |
MapTouchEvent |
Bir dokunma olayı gerçekleştiğinde eşlemeler tarafından döndürülen olay nesnesi. |
MediaLayerOptions |
Tuval, görüntü, tarama kutucuğu ve video katmanları işlenirken kullanılan seçenekler |
Options | |
Padding |
Haritanın kamerasını ayarlarken Sınırlayıcı Kutusu'nun yanına eklenecek doldurma miktarını piksel cinsinden temsil edin. |
PitchControlOptions |
PitchControl nesnesinin seçenekleri. |
PolygonExtrusionLayerOptions |
bir |
PolygonLayerOptions |
PolygonLayer'da Polygon ve MultiPolygon nesneleri işlenirken kullanılan seçenekler. |
PopupEvents | |
PopupManager |
Harita denetiminin açılan pencereleri için bir yönetici.
sınıfının özelliği aracılığıyla |
PopupOptions |
Açılan pencere seçenekleri. |
Properties |
Ile kullanılabilecek bir özellik kümesi |
PropertyInfo |
Bir özelliğin nasıl görüntüleneceğinin tür ayrıntıları. |
RasterTileSourceOptions | |
RequestParameters |
Bu, transformRequest geri çağırması tarafından döndürülmesi beklenen nesne türüdür. |
ScaleControlOptions |
ScaleControl nesnesi için seçenekler. |
ServiceOptions |
Tüm atlas hizmet isteklerinde kullanılan genel özellikler. |
ShapeEvents | |
SourceManager |
Harita denetiminin kaynaklarının yöneticisi. Atlasın sources özelliği aracılığıyla kullanıma sunuldu. Eşleme sınıfı. Kullanıcı tarafından örnek oluşturulamaz. |
StyleChangedEvent |
Yeni bir stil yüklendikten sonra eşleme tarafından döndürülen olay nesnesi. |
StyleControlOptions |
StyleControl nesnesinin seçenekleri. |
StyleOptions |
Haritanın stili için seçenekler. |
SymbolLayerOptions |
SymbolLayer'da geometriler işlenirken kullanılan seçenekler. |
TargetedEvent | |
TextOptions |
SymbolLayer'daki metni özelleştirmek için kullanılan seçenekler |
Tile |
Kaynak veri olayı gerçekleştiğinde eşleme tarafından döndürülen kutucuk nesnesi. |
TileId | |
TileLayerOptions |
TileLayer'da raster kutucuklu görüntüleri işlenirken kullanılan seçenekler. |
TrafficControlOptions | |
TrafficOptions |
Haritada trafiği ayarlama seçenekleri. |
UserInteractionOptions |
Haritayla kullanıcı etkileşimini etkinleştirme/devre dışı bırakma seçenekleri. |
VectorTileSourceOptions |
Haritada görüntülenecek şekil verilerini yönetmek için bir veri kaynağı.
Veri kaynağının haritada görünmeden önce katmana eklenmesi gerekir.
|
WebGLLayerOptions |
WebGLLayer'da grafik işlemek için kullanılan seçenekler. |
WebGLRenderer |
WebGLLayer'da WebGL grafiklerini işleme arabirimi. |
ZoomControlOptions |
ZoomControl nesnesinin seçenekleri. |
Tür Diğer Adları
Expression |
Filtrenin değeri veya belirli katman seçenekleri olarak belirtilebilir. İfade, özelliğin değerini hesaplamaya yönelik bir formül tanımlar. İfadeler JSON dizileri olarak temsil edilir. bir ifadenin ilk öğesi, ifade işlecini adlandıran bir dizedir. |
getAuthTokenCallback |
Anonim kimlik doğrulama modunda kimlik doğrulama belirteci almak için kullanılan geri çağırma işlevi. Kimlik doğrulama belirteci ile çözümleyin veya hatalarla reddedin. |
ResourceType | |
StyleImageMetadata |
parametresine geçirilen |
Numaralandırmalar
AuthenticationType |
Kullanılacak kimlik doğrulama mekanizmasının türünü belirtmek için kullanılan bir numaralandırma. |
ControlPosition |
Denetimin haritaya yerleştirilebileceği konumlar. |
ControlStyle |
Denetim için kullanılabilir stiller. |
İşlevler
add |
Atlas ad alanına bir görüntü şablonu ekler. |
clear |
daha önce tarafından |
get |
Atlas ad alanında bulunan tüm görüntü şablonları için bir ad dizisi alır. |
get |
Sağlanan varsayılan kimlik doğrulama seçeneklerini alır. Daha önce ayarlanmadıysa tüm özellikler tanımsız olacaktır. |
get |
Sağlanan varsayılan etki alanını alır.
Önceden ayarlanmadıysa varsayılan değer olur |
get |
Ada göre bir SVG şablonu alır. |
get |
Sağlanan varsayılan dili alır.
Önceden ayarlanmadıysa varsayılan değer olur |
get |
Paralel olarak yüklenemiyor en fazla görüntü sayısını (raster kutucukları, spriteler, simgeler) alır |
get |
Sağlanan varsayılan oturum kimliğini alır. Önceden ayarlanmadıysa varsayılan değer rastgele bir UUID'dir. |
get |
Sağlanan varsayılan Azure Haritalar abonelik anahtarını alır. |
get |
|
get |
Derleme numarasına göre geçerli API sürüm numarası. |
get |
Harita denetiminin varsayılan görünüm ayarını alır.
Önceden ayarlanmadıysa varsayılan değer olur |
get |
Oluşturulacak çalışan sayısını alır. |
is |
Kullanıcının tarayıcısının harita denetimi tarafından desteklenip desteklenmediğini denetler. |
prewarm() | Bazı durumlarda yükleme sürelerini düşürmek için haritalar arasında paylaşılabilen WebWorkers gibi kaynakları başlatır. Bu, GL-JS haritalarını tek sayfalı bir uygulamada kullanırken öncelikli olarak yararlıdır. Burada bir kullanıcı, Harita örneklerinin sürekli olarak oluşturulmasına ve yok edilmesine neden olabilecek çeşitli görünümler arasında gezinebilir. |
set |
Kimlik doğrulama seçeneklerinizi, harita denetimi ve Azure haritalar hizmetlerine istekte bulunan modüller tarafından kullanılan atlas ad alanında varsayılan seçenekler olarak ayarlar. Bir Map kimlik doğrulama seçenekleri açıkça tanımlanmış ve setAuthenticationOptions önceden çağrılmamışsa, Map oluşturucu tarafından otomatik olarak çağrılır. |
set |
API'nin bu bölümleri kullanılırken etki alanı açıkça belirtilmediği sürece eşleme ve hizmet modülleri tarafından kullanılan varsayılan etki alanını ayarlar.
Bir Map, etki alanı açıkça tanımlanmış ve setDomain daha önce çağrılmamışsa, Map oluşturucu tarafından otomatik olarak çağrılır.
Protokol belirtilmezse |
set |
API'nin bu bölümleri kullanılırken dil açıkça belirtilmediği sürece harita ve hizmet modülleri tarafından kullanılan varsayılan dili ayarlar. Bir Map açıkça tanımlanan dille başlatılırsa ve setLanguage daha önce çağrılmazsa, Map oluşturucu tarafından otomatik olarak çağrılır. |
set |
En fazla görüntü sayısını (raster kutucukları, spriteler, simgeler) paralel olarak yükleyecek şekilde ayarlar ve bu da raster-heavy haritalarındaki performansı etkiler. Varsayılan olarak 16. |
set |
API'nin bu bölümleri kullanılırken oturum kimliği açıkça belirtilmediği sürece eşleme ve hizmet modülleri tarafından kullanılan varsayılan oturum kimliğini ayarlar. Bir Map, oturum kimliği açıkça tanımlanmış ve setSessionId daha önce çağrılmamışsa, Map oluşturucu tarafından otomatik olarak çağrılır. |
set |
Azure Haritalar abonelik anahtarınızı, harita denetimi ve Azure haritalar hizmetlerine istekte bulunan modüller tarafından kullanılan atlas ad alanında varsayılan abonelik anahtarı olarak ayarlar. Bir Map açıkça tanımlanmış abonelik anahtarıyla başlatılırsa ve setSubscriptionKey daha önce çağrılmazsa, Map oluşturucu tarafından otomatik olarak çağrılır. |
set |
|
set |
Haritada hangi jeopolitik olarak tartışmalı kenarlık ve etiket kümesinin görüntüleneceğini belirtir. View parametresi ("kullanıcı bölgesi parametresi" olarak da adlandırılır), bu ülke/bölge için doğru haritaları gösteren 2 harfli bir ISO-3166 Ülke Kodudur. Görünüm listesinde olmayan ülke/bölgeler veya belirtilmemişse varsayılan olarak "Birleşik" Görünüm'e ayarlanır. Lütfen desteklenen [Görünümler]{@link https://aka.ms/AzureMapsLocalizationViews } bölümüne bakın. Kullanıcılarınızın konumunu belirlemek ve ardından bu konum için View parametresini doğru ayarlamak sizin sorumluluğunuzdadır. Azure Haritalar'de View parametresi haritaların, görüntülerin ve diğer verilerin ve Azure Haritalar üzerinden erişme yetkiniz olan üçüncü taraf içeriğinin bulunduğu ülkenin/bölgenin haritalanmasıyla ilgili yasalar da dahil olmak üzere geçerli yasalara uygun olarak kullanılmalıdır. |
set |
Bir sayfada örnek olarak atanan web çalışanlarının sayısını ayarlar. Varsayılan olarak, CPU çekirdeği sayısının yarısına ayarlanır (6 ile sınırlanır). |
İşlev Ayrıntıları
addImageTemplate(string, string, boolean)
Atlas ad alanına bir görüntü şablonu ekler.
function addImageTemplate(templateName: string, template: string, override: boolean)
Parametreler
- templateName
-
string
Şablonun adı.
- template
-
string
Eklenecek SVG şablonu. {color}, {secondaryColor}, {scale}, {text} destekler.
- override
-
boolean
Aynı ada sahip bir şablon zaten varsa, mevcut şablonları geçersiz kılıp geçersiz kılması gerekmediğini belirtir.
clearPrewarmedResources()
daha önce tarafından atlas.prewarm()
oluşturulmuş kaynakları temizler.
Bunun genellikle gerekli olmadığını unutmayın. Bu işlevi yalnızca uygulamanızın kullanıcısının uygulamanızın herhangi bir noktasında Harita görünümüne dönmemesini bekliyorsanız çağırmalısınız.
function clearPrewarmedResources()
getAllImageTemplateNames()
Atlas ad alanında bulunan tüm görüntü şablonları için bir ad dizisi alır.
function getAllImageTemplateNames(): string[]
Döndürülenler
string[]
getAuthenticationOptions()
Sağlanan varsayılan kimlik doğrulama seçeneklerini alır. Daha önce ayarlanmadıysa tüm özellikler tanımsız olacaktır.
function getAuthenticationOptions(): AuthenticationOptions
Döndürülenler
getDomain()
Sağlanan varsayılan etki alanını alır.
Önceden ayarlanmadıysa varsayılan değer olur "atlas.microsoft.com"
.
function getDomain(): string
Döndürülenler
string
getImageTemplate(string, number)
Ada göre bir SVG şablonu alır.
function getImageTemplate(templateName: string, scale?: number): string
Parametreler
- templateName
-
string
Alınacak şablonun adı.
- scale
-
number
Şablonun ne kadar ölçeklendirileceklerini belirtir. En iyi sonuçları elde etmek için simgeyi haritada görüntülemek istediğiniz boyut üst sınırına ölçeklendirin, ardından gerekirse ölçeği küçültmek için simge katmanları simge boyutu seçeneğini kullanın. Bu, ölçeklendirme nedeniyle bulanıklığı azaltır. Varsayılan: 1
Döndürülenler
string
getLanguage()
Sağlanan varsayılan dili alır.
Önceden ayarlanmadıysa varsayılan değer olur "NGT"
.
function getLanguage(): string
Döndürülenler
string
getMaxParallelImageRequests()
Paralel olarak yüklenemiyor en fazla görüntü sayısını (raster kutucukları, spriteler, simgeler) alır
function getMaxParallelImageRequests(): number
Döndürülenler
number
getSessionId()
Sağlanan varsayılan oturum kimliğini alır. Önceden ayarlanmadıysa varsayılan değer rastgele bir UUID'dir.
function getSessionId(): string
Döndürülenler
string
getSubscriptionKey()
Sağlanan varsayılan Azure Haritalar abonelik anahtarını alır.
function getSubscriptionKey(): string
Döndürülenler
string
getUserRegion()
Uyarı
Bu API artık kullanım dışıdır.
use atlas.getView() instead
function getUserRegion(): string
Döndürülenler
string
getVersion()
Derleme numarasına göre geçerli API sürüm numarası.
function getVersion(): string
Döndürülenler
string
getView()
Harita denetiminin varsayılan görünüm ayarını alır.
Önceden ayarlanmadıysa varsayılan değer olur undefined
.
function getView(): string
Döndürülenler
string
getWorkerCount()
Oluşturulacak çalışan sayısını alır.
function getWorkerCount(): number
Döndürülenler
number
isSupported(boolean)
Kullanıcının tarayıcısının harita denetimi tarafından desteklenip desteklenmediğini denetler.
function isSupported(failIfMajorPerformanceCaveat?: boolean): boolean
Parametreler
- failIfMajorPerformanceCaveat
-
boolean
True ise, harita denetiminin performansı beklenenden önemli ölçüde daha kötü olacaksa işlev false döndürür (örneğin, bir yazılım WebGL işleyicisi kullanılır).
Döndürülenler
boolean
prewarm()
Bazı durumlarda yükleme sürelerini düşürmek için haritalar arasında paylaşılabilen WebWorkers gibi kaynakları başlatır. atlas.setWorkerCount
, kullanılıyorsa, bir etkiye sahip olmak için çağrılmadan önce prewarm()
ayarlanmalıdır.
Varsayılan olarak, bu kaynakların yaşam döngüsü otomatik olarak yönetilir ve bir Harita ilk oluşturulduğunda lazily başlatılır. çağrılarak prewarm()
, bu kaynaklar önceden oluşturulur ve son Harita sayfadan kaldırıldığında temizlenmez. Bu, daha sonra oluşturulan yeni Harita örnekleri tarafından yeniden kullanılmalarını sağlar. çağrılarak atlas.clearPrewarmedResources()
el ile temizlenebilirler. Bu yalnızca web sayfanız etkin kalırsa ancak haritaları kullanmayı tamamen durduruyorsa gereklidir.
Bu, GL-JS haritalarını tek sayfalı bir uygulamada kullanırken öncelikli olarak yararlıdır. Burada bir kullanıcı, Harita örneklerinin sürekli olarak oluşturulmasına ve yok edilmesine neden olabilecek çeşitli görünümler arasında gezinebilir.
function prewarm()
setAuthenticationOptions(AuthenticationOptions)
Kimlik doğrulama seçeneklerinizi, harita denetimi ve Azure haritalar hizmetlerine istekte bulunan modüller tarafından kullanılan atlas ad alanında varsayılan seçenekler olarak ayarlar. Bir Map kimlik doğrulama seçenekleri açıkça tanımlanmış ve setAuthenticationOptions önceden çağrılmamışsa, Map oluşturucu tarafından otomatik olarak çağrılır.
function setAuthenticationOptions(options: AuthenticationOptions)
Parametreler
- options
- AuthenticationOptions
Yeni varsayılan kimlik doğrulama seçenekleri.
setDomain(string)
API'nin bu bölümleri kullanılırken etki alanı açıkça belirtilmediği sürece eşleme ve hizmet modülleri tarafından kullanılan varsayılan etki alanını ayarlar.
Bir Map, etki alanı açıkça tanımlanmış ve setDomain daha önce çağrılmamışsa, Map oluşturucu tarafından otomatik olarak çağrılır.
Protokol belirtilmezse https
kabul edilir.
function setDomain(domain: string)
Parametreler
- domain
-
string
Yeni varsayılan etki alanı.
setLanguage(string)
API'nin bu bölümleri kullanılırken dil açıkça belirtilmediği sürece harita ve hizmet modülleri tarafından kullanılan varsayılan dili ayarlar. Bir Map açıkça tanımlanan dille başlatılırsa ve setLanguage daha önce çağrılmazsa, Map oluşturucu tarafından otomatik olarak çağrılır.
function setLanguage(language: string)
Parametreler
- language
-
string
Yeni varsayılan dil.
setMaxParallelImageRequests(number)
En fazla görüntü sayısını (raster kutucukları, spriteler, simgeler) paralel olarak yükleyecek şekilde ayarlar ve bu da raster-heavy haritalarındaki performansı etkiler. Varsayılan olarak 16.
function setMaxParallelImageRequests(maxParallelImageRequests: number)
Parametreler
- maxParallelImageRequests
-
number
Paralel olarak yüklenemiyor en fazla görüntü sayısı.
setSessionId(string)
API'nin bu bölümleri kullanılırken oturum kimliği açıkça belirtilmediği sürece eşleme ve hizmet modülleri tarafından kullanılan varsayılan oturum kimliğini ayarlar. Bir Map, oturum kimliği açıkça tanımlanmış ve setSessionId daha önce çağrılmamışsa, Map oluşturucu tarafından otomatik olarak çağrılır.
function setSessionId(id: string)
Parametreler
- id
-
string
Yeni varsayılan oturum kimliği.
setSubscriptionKey(string)
Azure Haritalar abonelik anahtarınızı, harita denetimi ve Azure haritalar hizmetlerine istekte bulunan modüller tarafından kullanılan atlas ad alanında varsayılan abonelik anahtarı olarak ayarlar. Bir Map açıkça tanımlanmış abonelik anahtarıyla başlatılırsa ve setSubscriptionKey daha önce çağrılmazsa, Map oluşturucu tarafından otomatik olarak çağrılır.
function setSubscriptionKey(key: string)
Parametreler
- key
-
string
Yeni varsayılan abonelik anahtarı.
setUserRegion(string)
Uyarı
Bu API artık kullanım dışıdır.
use atlas.setView(view: string) instead.
function setUserRegion(userRegion: string)
Parametreler
- userRegion
-
string
setView(string)
Haritada hangi jeopolitik olarak tartışmalı kenarlık ve etiket kümesinin görüntüleneceğini belirtir. View parametresi ("kullanıcı bölgesi parametresi" olarak da adlandırılır), bu ülke/bölge için doğru haritaları gösteren 2 harfli bir ISO-3166 Ülke Kodudur. Görünüm listesinde olmayan ülke/bölgeler veya belirtilmemişse varsayılan olarak "Birleşik" Görünüm'e ayarlanır. Lütfen desteklenen [Görünümler]{@link https://aka.ms/AzureMapsLocalizationViews } bölümüne bakın. Kullanıcılarınızın konumunu belirlemek ve ardından bu konum için View parametresini doğru ayarlamak sizin sorumluluğunuzdadır. Azure Haritalar'de View parametresi haritaların, görüntülerin ve diğer verilerin ve Azure Haritalar üzerinden erişme yetkiniz olan üçüncü taraf içeriğinin bulunduğu ülkenin/bölgenin haritalanmasıyla ilgili yasalar da dahil olmak üzere geçerli yasalara uygun olarak kullanılmalıdır.
function setView(view: string)
Parametreler
- view
-
string
Yeni varsayılan görünüm
setWorkerCount(number)
Bir sayfada örnek olarak atanan web çalışanlarının sayısını ayarlar. Varsayılan olarak, CPU çekirdeği sayısının yarısına ayarlanır (6 ile sınırlanır).
function setWorkerCount(workerCount: number)
Parametreler
- workerCount
-
number
çalışan sayısı.