你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站,请访问 https://docs.azure.cn

atlas module

EventManager

地图控件事件的管理器。 通过 atlas 的事件属性公开。Map 类。 用户无法实例化。

HtmlMarker

此类包装一个可在地图上显示的 HTML 元素。

Map

视觉对象和交互式 Web 地图的控件。

Pixel

表示像素坐标或偏移量。 扩展 [x, y] 的数组。

Popup

定位在地图上指定位置的信息窗口。

PopupTemplate

弹出窗口的布局模板。

Shape

一个帮助程序类,用于包装几何图形或特征并使其易于更新和维护。

接口

AggregateExpression

聚合表达式定义通过一组数据处理的计算。 架构:[operator: string, initialValue?: boolean | number, mapExpression: Expression] 运算符:然后针对群集中每个点 mapExpression 计算的所有值的表达式函数。 支持的运算符:o 对于数字:+*maxmin o 对于布尔值:allany initialValue:可选,这是第一个计算值所针对的初始值。 mapExpression:针对数据集中的每个点应用的表达式。

AnimationOptions

用于对地图控件的相机进行更改的选项。

AuthenticationManager

映射控件身份验证的管理器。 通过 atlas 的身份验证属性公开。Map 类。 用户无法实例化。

AuthenticationOptions

用于指定地图控件如何使用 Azure Maps 服务进行身份验证的选项。

BubbleLayerOptions

在 BubbleLayer 中呈现 Point 对象时使用的选项。

CameraBoundsOptions

设置地图控件相机边界的选项。

CameraOptions

用于设置地图控件相机的选项。

ClusteredProperties

ClusteredProperties 将存在的属性

CompassControlOptions

CompassControl 对象的选项。

Control

用于定义地图控件的接口。

ControlManager

地图控件控件的管理器。 通过 atlas 的控件属性公开。Map 类。 用户无法实例化。

ControlOptions

用于向地图添加控件的选项。

DataSourceOptions

用于管理将在地图上显示的形状数据的数据源。 数据源必须添加到图层,然后才能在地图上可见。 DataSourceOptions的选项。

ElevationTileSourceOptions
FullscreenControlOptions

FullscreenControl 对象的选项。

HeatMapLayerOptions

在 HeatMapLayer 中呈现 Point 对象时使用的选项。

HtmlMarkerEvents
HtmlMarkerManager

地图控件的 HTML 标记的管理器。 通过 atlas 的标记属性公开。Map 类。 用户无法实例化。

HtmlMarkerOptions

用于呈现 HtmlMarker 对象的选项

HyperLinkFormatOptions

超链接字符串的格式选项。

IconOptions

用于自定义 SymbolLayer 中的图标的选项

ImageLayerOptions

在 ImageLayer 中呈现 Point 对象时使用的选项。

ImageSpriteManager

地图控件的图像子画面的管理器。 通过 atlas 的 imageSprite 属性公开。Map 类。 用户无法实例化。

LayerManager

地图控件层的管理器。 通过 atlas 的 layers 属性公开。Map 类。 用户无法实例化。

LayerOptions

所有其他层选项继承自的基类。

LightOptions

地图照明的选项。

LineLayerOptions

在线条层中呈现 SimpleLine、SimplePolygon、CirclePolygon、LineString、MultiLineString、Polygon 和 MultiPolygon 对象时使用的选项。

MapConfiguration

表示包含可用样式列表的地图配置的内容。

MapConfigurationStyle

表示单个样式的信息。

MapDataEvent

发生数据事件时映射返回的事件对象。

MapErrorEvent

发生错误事件时映射返回的事件对象。

MapEvent

发生基本事件时映射返回的事件对象。

MapMouseEvent

发生鼠标事件时映射返回的事件对象。

MapMouseWheelEvent

发生 wheel 事件时地图返回的事件对象。

MapTouchEvent

发生触摸事件时映射返回的事件对象。

MediaLayerOptions

呈现画布、图像、光栅磁贴和视频层时使用的选项

Options
Padding

表示在设置地图相机时要添加到 BoundingBox 一侧的填充量(以像素为单位)。

PitchControlOptions

PitchControl 对象的选项。

PolygonExtrusionLayerOptions

PolygonExtrusionLayer中呈现 PolygonMultiPolygon 对象时使用的选项。

PolygonLayerOptions

在 PolygonLayer 中呈现多边形和 MultiPolygon 对象时使用的选项。

PopupEvents
PopupManager

地图控件弹出窗口的管理器。 通过 atlas.Map 类的 popups 属性公开。 用户无法实例化。

PopupOptions

弹出窗口的选项。

Properties

一组可用于 PopupTemplate 的属性

PropertyInfo

如何显示属性的物种详细信息。

RasterTileSourceOptions
RequestParameters

这是 transformRequest 回调应返回的对象类型。

ScaleControlOptions

ScaleControl 对象的选项。

ServiceOptions

所有 atlas 服务请求中使用的全局属性。

ShapeEvents
SourceManager

地图控件源的管理器。 通过 atlas 的源属性公开。Map 类。 用户无法实例化。

StyleChangedEvent

加载新样式后地图返回的事件对象。

StyleControlOptions

StyleControl 对象的选项。

StyleOptions

地图样式的选项。

SymbolLayerOptions

在 SymbolLayer 中呈现几何图形时使用的选项。

TargetedEvent
TextOptions

用于自定义 SymbolLayer 中的文本的选项

Tile

发生源数据事件时映射返回的图块对象。

TileId
TileLayerOptions

在 TileLayer 中呈现光栅平铺图像时使用的选项。

TrafficControlOptions
TrafficOptions

在地图上设置流量的选项。

UserInteractionOptions

启用/禁用用户与地图交互的选项。

VectorTileSourceOptions

用于管理将在地图上显示的形状数据的数据源。 数据源必须添加到图层,然后才能在地图上可见。 VectorTileSource的选项。

WebGLLayerOptions

用于在 WebGLLayer 中呈现图形的选项。

WebGLRenderer

用于在 WebGLLayer 中呈现 WebGL 图形的接口。

ZoomControlOptions

ZoomControl 对象的选项。

类型别名

Expression

可以指定为筛选器或某些层选项的值。 表达式定义用于计算属性值的公式。 表达式表示为 JSON 数组。 表达式的第一个元素是命名表达式运算符的字符串。

getAuthTokenCallback

用于在匿名身份验证模式下获取身份验证令牌的回调函数。 使用身份验证令牌解决或拒绝任何错误。

ResourceType
StyleImageMetadata

传递给 ImageSpriteManager.addoptions 参数的签名。

枚举

AuthenticationType

用于指定要使用的身份验证机制类型的枚举。

ControlPosition

可在地图上放置控件的位置。

ControlStyle

控件的可用样式。

函数

addImageTemplate(string, string, boolean)

将图像模板添加到 atlas 命名空间。

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

添加使用以自定义 URL 架构开头的 URL 时调用的自定义加载资源函数。

clearPrewarmedResources()

清除以前由 atlas.prewarm()创建的资源。 请注意,这通常是不需要的。 如果希望应用的用户不会在应用程序中的任何点返回地图视图,则仅应调用此函数。

getAllImageTemplateNames()

检索 atlas 命名空间中提供的所有图像模板的名称数组。

getAuthenticationOptions()

获取提供的默认身份验证选项。 如果以前未设置所有属性,则不会定义。

getDomain()

获取提供的默认域。 如果未设置默认值,则为 "atlas.microsoft.com"

getImageTemplate(string, number)

按名称检索 SVG 模板。

getLanguage()

获取提供的默认语言。 如果未设置默认值,则为 "NGT"

getMaxParallelImageRequests()

获取并行加载的最大图像数(光栅图块、子画面、图标)

getSessionId()

获取提供的默认会话 ID。 如果未设置默认值,则为随机 UUID。

getSubscriptionKey()

获取提供的默认 Azure Maps 订阅密钥。

getUserRegion()
getVersion()

基于内部版本号的当前 API 版本号。

getView()

获取地图控件的默认视图设置。 如果未设置默认值,则为 undefined

getWorkerCount()

获取将创建的辅助角色计数。

isSupported(boolean)

检查地图控件是否支持用户的浏览器。

prewarm()

初始化 WebWorkers 等资源,这些资源可以在地图之间共享,在某些情况下降低加载时间。 atlas.setWorkerCount(如果使用)必须先设置 prewarm() 才能生效。 默认情况下,这些资源的生命周期是自动管理的,在首次创建地图时会延迟初始化这些资源的生命周期。 通过调用 prewarm(),这些资源将提前创建,并且不会在从页面中删除最后一个地图时清除。 这样,就可以由稍后创建的新的映射实例重新使用它们。 可以通过调用 atlas.clearPrewarmedResources()手动清除它们。 仅当网页保持活动状态,但完全停止使用地图时,才有必要这样做。

在单页应用中使用 GL-JS 地图时,这主要有用,用户可在可能导致映射实例不断创建和销毁的各种视图之间导航。

removeProtocol(string)

删除主线程中以前添加的协议。

setAuthenticationOptions(AuthenticationOptions)

将身份验证选项设置为地图控件使用的 atlas 命名空间中的默认选项,以及向 Azure maps 服务发出请求的任何模块。 如果使用显式定义的身份验证选项初始化映射,并且 setAuthenticationOptions 之前尚未调用,则 Map 构造函数会自动调用它。

setDomain(string)

设置映射和服务模块使用的默认域,除非在使用 API 的这些部分时显式指定域。 如果使用显式定义的域初始化映射,并且 setDomain 之前尚未调用,则 Map 构造函数会自动调用它。 如果未指定协议,则假定为 https

setLanguage(string)

设置映射和服务模块使用的默认语言,除非在使用 API 的这些部分时显式指定了该语言。 如果映射是使用显式定义的语言初始化的,并且 setLanguage 之前尚未调用,则 Map 构造函数会自动调用它。

setMaxParallelImageRequests(number)

设置最大图像数(光栅图块、子画面、图标)以并行加载,这会影响光栅密集型地图的性能。 默认情况下为 16。

setSessionId(string)

设置映射和服务模块使用的默认会话 ID,除非在使用 API 的这些部分时显式指定会话 ID。 如果使用显式定义的会话 ID 初始化 Map,并且 setSessionId 以前尚未调用,则 Map 构造函数会自动调用它。

setSubscriptionKey(string)

将 Azure Maps 订阅密钥设置为地图控件使用的 atlas 命名空间中的默认订阅密钥,以及向 Azure maps 服务发出请求的任何模块。 如果使用显式定义的订阅密钥初始化 Map,并且 setSubscriptionKey 以前尚未调用,则 Map 构造函数会自动调用它。

setUserRegion(string)
setView(string)

指定地图上显示哪些地缘政治争议边界和标签集。 View 参数(也称为“用户区域参数”)是一个 2 字母 ISO-3166 国家/地区代码,用于显示该国家/地区的正确地图。 不在视图列表或未指定的国家/地区将默认为“统一”视图。 请参阅支持的 [Views]{@link https://aka.ms/AzureMapsLocalizationViews }。 由你负责确定用户的位置,然后为该位置正确设置 View 参数。 Azure Maps 中的 View 参数必须符合适用的法律,包括地图、图像和其他数据以及通过 Azure Maps 获得访问权限的第三方内容的国家/地区的地图、图像和其他数据以及第三方内容。

setWorkerCount(number)

设置页面上实例化的 Web 辅助角色数。 默认情况下,它设置为 CPU 核心数的一半(上限为 6)。

函数详细信息

addImageTemplate(string, string, boolean)

将图像模板添加到 atlas 命名空间。

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

参数

templateName

string

模板的名称。

template

string

要添加的 SVG 模板。 支持 {color}、{secondaryColor}、{scale}、{text}。

override

boolean

指定如果已有同名模板,则指定它是否应重写现有模板。

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

添加使用以自定义 URL 架构开头的 URL 时调用的自定义加载资源函数。

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

参数

customProtocol

string

要挂钩的协议,例如“custom”

loadFn

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

尝试提取 customProtocol 指定的磁贴时要使用的函数

clearPrewarmedResources()

清除以前由 atlas.prewarm()创建的资源。 请注意,这通常是不需要的。 如果希望应用的用户不会在应用程序中的任何点返回地图视图,则仅应调用此函数。

function clearPrewarmedResources()

getAllImageTemplateNames()

检索 atlas 命名空间中提供的所有图像模板的名称数组。

function getAllImageTemplateNames(): string[]

返回

string[]

getAuthenticationOptions()

获取提供的默认身份验证选项。 如果以前未设置所有属性,则不会定义。

function getAuthenticationOptions(): AuthenticationOptions

返回

getDomain()

获取提供的默认域。 如果未设置默认值,则为 "atlas.microsoft.com"

function getDomain(): string

返回

string

getImageTemplate(string, number)

按名称检索 SVG 模板。

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

参数

templateName

string

要检索的模板的名称。

scale

number

指定缩放模板的量。 为了获得最佳结果,请将图标缩放为要在地图上显示的最大大小,然后使用符号层图标大小选项根据需要缩减。 这可以减少缩放导致的模糊性。 默认值:1

返回

string

getLanguage()

获取提供的默认语言。 如果未设置默认值,则为 "NGT"

function getLanguage(): string

返回

string

getMaxParallelImageRequests()

获取并行加载的最大图像数(光栅图块、子画面、图标)

function getMaxParallelImageRequests(): number

返回

number

getSessionId()

获取提供的默认会话 ID。 如果未设置默认值,则为随机 UUID。

function getSessionId(): string

返回

string

getSubscriptionKey()

获取提供的默认 Azure Maps 订阅密钥。

function getSubscriptionKey(): string

返回

string

getUserRegion()

警告

现已弃用此 API。

use atlas.getView() instead

function getUserRegion(): string

返回

string

getVersion()

基于内部版本号的当前 API 版本号。

function getVersion(): string

返回

string

getView()

获取地图控件的默认视图设置。 如果未设置默认值,则为 undefined

function getView(): string

返回

string

getWorkerCount()

获取将创建的辅助角色计数。

function getWorkerCount(): number

返回

number

isSupported(boolean)

检查地图控件是否支持用户的浏览器。

function isSupported(failIfMajorPerformanceCaveat?: boolean): boolean

参数

failIfMajorPerformanceCaveat

boolean

如果为 true,则如果地图控件的性能明显比预期差(例如将使用软件 WebGL 呈现器),则函数将返回 false。

返回

boolean

prewarm()

初始化 WebWorkers 等资源,这些资源可以在地图之间共享,在某些情况下降低加载时间。 atlas.setWorkerCount(如果使用)必须先设置 prewarm() 才能生效。 默认情况下,这些资源的生命周期是自动管理的,在首次创建地图时会延迟初始化这些资源的生命周期。 通过调用 prewarm(),这些资源将提前创建,并且不会在从页面中删除最后一个地图时清除。 这样,就可以由稍后创建的新的映射实例重新使用它们。 可以通过调用 atlas.clearPrewarmedResources()手动清除它们。 仅当网页保持活动状态,但完全停止使用地图时,才有必要这样做。

在单页应用中使用 GL-JS 地图时,这主要有用,用户可在可能导致映射实例不断创建和销毁的各种视图之间导航。

function prewarm()

removeProtocol(string)

删除主线程中以前添加的协议。

function removeProtocol(customProtocol: string)

参数

customProtocol

string

要删除其注册的自定义协议

setAuthenticationOptions(AuthenticationOptions)

将身份验证选项设置为地图控件使用的 atlas 命名空间中的默认选项,以及向 Azure maps 服务发出请求的任何模块。 如果使用显式定义的身份验证选项初始化映射,并且 setAuthenticationOptions 之前尚未调用,则 Map 构造函数会自动调用它。

function setAuthenticationOptions(options: AuthenticationOptions)

参数

options
AuthenticationOptions

新的默认身份验证选项。

setDomain(string)

设置映射和服务模块使用的默认域,除非在使用 API 的这些部分时显式指定域。 如果使用显式定义的域初始化映射,并且 setDomain 之前尚未调用,则 Map 构造函数会自动调用它。 如果未指定协议,则假定为 https

function setDomain(domain: string)

参数

domain

string

新的默认域。

setLanguage(string)

设置映射和服务模块使用的默认语言,除非在使用 API 的这些部分时显式指定了该语言。 如果映射是使用显式定义的语言初始化的,并且 setLanguage 之前尚未调用,则 Map 构造函数会自动调用它。

function setLanguage(language: string)

参数

language

string

新的默认语言。

setMaxParallelImageRequests(number)

设置最大图像数(光栅图块、子画面、图标)以并行加载,这会影响光栅密集型地图的性能。 默认情况下为 16。

function setMaxParallelImageRequests(maxParallelImageRequests: number)

参数

maxParallelImageRequests

number

要并行加载的最大图像数。

setSessionId(string)

设置映射和服务模块使用的默认会话 ID,除非在使用 API 的这些部分时显式指定会话 ID。 如果使用显式定义的会话 ID 初始化 Map,并且 setSessionId 以前尚未调用,则 Map 构造函数会自动调用它。

function setSessionId(id: string)

参数

id

string

新的默认会话 ID。

setSubscriptionKey(string)

将 Azure Maps 订阅密钥设置为地图控件使用的 atlas 命名空间中的默认订阅密钥,以及向 Azure maps 服务发出请求的任何模块。 如果使用显式定义的订阅密钥初始化 Map,并且 setSubscriptionKey 以前尚未调用,则 Map 构造函数会自动调用它。

function setSubscriptionKey(key: string)

参数

key

string

新的默认订阅密钥。

setUserRegion(string)

警告

现已弃用此 API。

use atlas.setView(view: string) instead.

function setUserRegion(userRegion: string)

参数

userRegion

string

setView(string)

指定地图上显示哪些地缘政治争议边界和标签集。 View 参数(也称为“用户区域参数”)是一个 2 字母 ISO-3166 国家/地区代码,用于显示该国家/地区的正确地图。 不在视图列表或未指定的国家/地区将默认为“统一”视图。 请参阅支持的 [Views]{@link https://aka.ms/AzureMapsLocalizationViews }。 由你负责确定用户的位置,然后为该位置正确设置 View 参数。 Azure Maps 中的 View 参数必须符合适用的法律,包括地图、图像和其他数据以及通过 Azure Maps 获得访问权限的第三方内容的国家/地区的地图、图像和其他数据以及第三方内容。

function setView(view: string)

参数

view

string

新的默认视图

setWorkerCount(number)

设置页面上实例化的 Web 辅助角色数。 默认情况下,它设置为 CPU 核心数的一半(上限为 6)。

function setWorkerCount(workerCount: number)

参数

workerCount

number

工作器计数。