你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。
Map class
视觉对象和交互式 Web 地图的 控件。
构造函数
| Map(string | HTMLElement, Service |
显示指定容器中的映射。 |
属性
| authentication | |
| controls | |
| events | |
| image |
|
| is |
如果已释放映射，则返回 true。 |
| layers | |
| markers | |
| popups | |
| sources |
方法
| are |
返回一个布尔值，该值指示当前视区中所有源的所有磁贴是否已加载。 |
| clear() | 从地图中删除所有源、层、标记和弹出窗口。 保留用户添加的图像。 |
| disable |
禁用 3D 地形网格。 |
| dispose() | 清理地图的资源。 调用此方法后，映射将无法正常运行。 |
| enable |
基于“光栅-dem”源加载 3D 地形网格。 |
| get |
返回相机的当前属性。 |
| get |
返回绘制地图的 HTMLCanvasElement。 |
| get |
返回包含映射的 HTMLCanvasElement 的 HTMLElement。 地图的事件 (例如平移和缩放) 附加到此元素。 |
| get |
返回包含映射的 HTMLElement。 |
| get |
返回初始化地图控件时使用的服务选项。 |
| get |
返回地图控件的当前样式设置。 |
| get |
返回地图控件的当前交通设置。 |
| get |
返回地图控件的当前用户交互处理程序设置。 |
| pixels |
将 Pixel 对象的数组转换为地图上的地理位置对象数组。 |
| positions |
将 Positions 对象的数组转换为相对于地图容器的 Pixel 对象数组。 |
| resize(any) | 根据地图容器元素的尺寸调整地图大小。 |
| resize(number | string, number | string, any) | 重设映射的容器元素的大小，然后调整映射本身的大小。 |
| set |
使用动画转换设置地图控件的相机。 任何未指定的选项都将默认为其当前值。 |
| set |
设置服务选项。 |
| set |
设置地图控件的样式选项。 任何未指定的选项都将默认为其当前值。 |
| set |
设置地图的交通选项。 任何未指定的选项都将默认为其当前值。 |
| set |
设置地图控件的用户交互处理程序。 任何未指定的选项都将默认为其当前值。 |
| stop() | 停止当前正在进行的任何动画转换。 |
| trigger |
触发单个帧的呈现。 将此方法用于 WebGL 层，以在图层的属性或与层的源关联的属性发生更改时重新绘制地图。 在呈现下一帧之前多次调用此方法仍会导致仅呈现单个帧。 |
构造函数详细信息
Map(string | HTMLElement, ServiceOptions & StyleOptions & UserInteractionOptions & (CameraOptions | CameraBoundsOptions))
显示指定容器中的映射。
new Map(container: string | HTMLElement, options: ServiceOptions & StyleOptions & UserInteractionOptions & (CameraOptions | CameraBoundsOptions))参数
- container
-
string | HTMLElement
应在其中显示地图的元素的 ID。
- options
-
ServiceOptions & StyleOptions & UserInteractionOptions & (CameraOptions | CameraBoundsOptions)
用于初始显示以及与地图交互的选项。
属性详细信息
authentication
controls
events
imageSprite
isDisposed
如果已释放映射，则返回 true。
boolean isDisposed属性值
boolean
layers
markers
popups
sources
方法详细信息
areTilesLoaded()
返回一个布尔值，该值指示当前视区中所有源的所有磁贴是否已加载。
function areTilesLoaded(): boolean返回
boolean
clear()
从地图中删除所有源、层、标记和弹出窗口。 保留用户添加的图像。
function clear()
disableElevation()
禁用 3D 地形网格。
function disableElevation()dispose()
清理地图的资源。 调用此方法后，映射将无法正常运行。
function dispose()
enableElevation(string | ElevationTileSource, number)
基于“光栅-dem”源加载 3D 地形网格。
function enableElevation(elevationSource: string | ElevationTileSource, exaggeration?: number)参数
- elevationSource
-
string | ElevationTileSource
提升磁贴源
- exaggeration
-
number
高程夸大因子
getCamera()
返回相机的当前属性。
function getCamera(): CameraOptions & CameraBoundsOptions返回
getCanvas()
返回绘制地图的 HTMLCanvasElement。
function getCanvas(): HTMLCanvasElement返回
HTMLCanvasElement
getCanvasContainer()
返回包含映射的 HTMLCanvasElement 的 HTMLElement。 地图的事件 (例如平移和缩放) 附加到此元素。
function getCanvasContainer(): HTMLElement返回
HTMLElement
getMapContainer()
返回包含映射的 HTMLElement。
function getMapContainer(): HTMLElement返回
HTMLElement
getServiceOptions()
getStyle()
getTraffic()
getUserInteraction()
返回地图控件的当前用户交互处理程序设置。
function getUserInteraction(): UserInteractionOptions返回
pixelsToPositions(Pixel[])
将 Pixel 对象的数组转换为地图上的地理位置对象数组。
function pixelsToPositions(pixels: Pixel[]): Position[]参数
- pixels
-
Pixel[]
要转换的像素。
返回
Position[]
positionsToPixels(Position[])
将 Positions 对象的数组转换为相对于地图容器的 Pixel 对象数组。
function positionsToPixels(positions: Position[]): Pixel[]参数
- positions
-
Position[]
要转换的位置。
返回
Pixel[]
resize(any)
根据地图容器元素的尺寸调整地图大小。
function resize(eventData?: any)参数
- eventData
-
any
要添加到此方法触发的事件的事件对象的可选附加属性。
resize(number | string, number | string, any)
重设映射的容器元素的大小，然后调整映射本身的大小。
function resize(height: number | string, width: number | string, eventData?: any)参数
- height
-
number | string
地图及其容器元素的高度。 假定数字输入以像素为单位。
- width
-
number | string
地图及其容器元素的宽度。 假定数字输入以像素为单位。
- eventData
-
any
要添加到此方法触发的事件的事件对象的可选附加属性。
setCamera((CameraOptions | (CameraBoundsOptions & { bearing?: number, pitch?: number })) & AnimationOptions)
使用动画转换设置地图控件的相机。 任何未指定的选项都将默认为其当前值。
function setCamera(options?: (CameraOptions | (CameraBoundsOptions & { bearing?: number, pitch?: number })) & AnimationOptions)参数
- options
-
(CameraOptions | (CameraBoundsOptions & { bearing?: number, pitch?: number })) & AnimationOptions
用于设置地图相机的选项以及用于任何视图的动画的选项更改。
setServiceOptions(ServiceOptions)
setStyle(StyleOptions, boolean)
设置地图控件的样式选项。 任何未指定的选项都将默认为其当前值。
function setStyle(options?: StyleOptions, diff?: boolean)参数
- options
- StyleOptions
用于设置地图控件样式的选项。
- diff
-
boolean
如果为 false，则强制进行“完整”样式更新，删除当前样式并生成给定样式，而不是尝试基于差异的更新。 默认为 true。
setTraffic(TrafficOptions)
设置地图的交通选项。 任何未指定的选项都将默认为其当前值。
function setTraffic(options?: TrafficOptions)参数
- options
- TrafficOptions
用于定义地图的交通显示的选项。
setUserInteraction(UserInteractionOptions)
设置地图控件的用户交互处理程序。 任何未指定的选项都将默认为其当前值。
function setUserInteraction(options?: UserInteractionOptions)参数
- options
- UserInteractionOptions
用于启用/禁用用户交互处理程序的选项。
stop()
停止当前正在进行的任何动画转换。
function stop()
triggerRepaint()
触发单个帧的呈现。 将此方法用于 WebGL 层，以在图层的属性或与层的源关联的属性发生更改时重新绘制地图。 在呈现下一帧之前多次调用此方法仍会导致仅呈现单个帧。
function triggerRepaint()