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

ImageSpriteManager interface

参考

包:: azure-maps-control

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

方法

add(string, string \| HTMLImageElement \| ImageData, StyleImageMetadata)	将图标图像添加到地图的图像子画面中，以用于符号和模式。
clear()	删除用户添加的所有映像。
createFromTemplate(string, string, string, string, number)	创建图像并将其添加到地图图像子画面。提供要使用的内置模板的名称和要应用的颜色。（可选）如果模板支持辅助颜色，则指定辅助颜色。还可以指定缩放。这将允许在将 SVG 转换为图像之前进行缩放，从而在纵向扩展时看起来更好。返回一个承诺。在多边形或符号层中引用此值。
getImageIds()	获取已添加到地图图像子画面的所有图像 ID 的列表。
hasImage(string)	检查图像是否已加载到地图图像子画面中。
remove(string)	从地图的图像子画面中删除图像。

方法详细信息

add(string, string | HTMLImageElement | ImageData, StyleImageMetadata)

将图标图像添加到地图的图像子画面中，以用于符号和模式。

function add(id: string, icon: string | HTMLImageElement | ImageData, meta?: StyleImageMetadata): Promise<void>

参数

id: string

图像的 ID。如果指定的 ID 与以前添加的映像的 ID 匹配，将忽略新映像。

icon: string | HTMLImageElement | ImageData

要添加到地图的子画面的图像。可以是数据 URI、内联 SVG 或图像 URL。

meta: StyleImageMetadata

描述图像的其他选项

Promise<void>

clear()

删除用户添加的所有映像。

function clear()

createFromTemplate(string, string, string, string, number)

创建图像并将其添加到地图图像子画面。提供要使用的内置模板的名称和要应用的颜色。（可选）如果模板支持辅助颜色，则指定辅助颜色。还可以指定缩放。这将允许在将 SVG 转换为图像之前进行缩放，从而在纵向扩展时看起来更好。返回一个承诺。在多边形或符号层中引用此值。

function createFromTemplate(id: string, templateName: string, color?: string, secondaryColor?: string, scale?: number): Promise<void>

参数

id: string

图像的 ID。如果指定的 ID 与以前添加的映像的 ID 匹配，将忽略新映像。

templateName: string

要使用的模板的名称。

color: string

主要颜色值。默认值：#1A73AA

secondaryColor: string

辅助颜色值。默认值：白色

scale: number

指定缩放模板的缩放量。为了获得最佳结果，请将图标缩放为要在地图上显示的最大大小，然后根据需要使用符号层图标大小选项进行缩减。这将减少由于缩放而模糊。默认值：1

Promise<void>

getImageIds()

获取已添加到地图图像子画面的所有图像 ID 的列表。

function getImageIds(): string[]

string[]

hasImage(string)

检查图像是否已加载到地图图像子画面中。

function hasImage(id: string): boolean

参数

id: string

要检查地图图像子画面的 ID。

boolean

remove(string)

从地图的图像子画面中删除图像。

function remove(id: string)

参数

id: string

要删除的图像的 ID。

通过