ImageSpriteManager interface
地圖控制項影像 Sprite 的管理員。 透過 atlas 的 imageSprite 屬性公開。Map 類別。 無法由使用者具現化。
方法
add(string, string | HTMLImage |
將圖示影像新增至地圖的影像 Sprite,以搭配符號和圖樣使用。 |
clear() | 移除使用者新增的所有映射。 |
create |
建立影像,並將影像新增至地圖影像 Sprite。 提供要使用的內建範本名稱,以及要套用的色彩。 選擇性地,如果範本支援次要色彩,請指定次要色彩。 您也可以指定小數位數。 這可讓 SVG 在轉換成影像之前進行縮放,因此在相應增加時看起來更好。 傳回承諾。 在 Polygon 或 Symbol 圖層中參考此專案。 |
get |
取得已新增至地圖影像 Sprite 的所有影像識別碼清單。 |
has |
檢查影像是否已載入地圖影像 Sprite。 |
remove(string) | 從地圖的影像 Sprite 中移除影像。 |
方法詳細資料
add(string, string | HTMLImageElement | ImageData, StyleImageMetadata)
將圖示影像新增至地圖的影像 Sprite,以搭配符號和圖樣使用。
function add(id: string, icon: string | HTMLImageElement | ImageData, meta?: StyleImageMetadata): Promise<void>
參數
- id
-
string
影像的識別碼。如果指定的識別碼符合先前新增映射的識別碼,則會忽略新映射。
- icon
-
string | HTMLImageElement | ImageData
要新增至地圖 Sprite 的影像。 可以是資料 URI、內嵌 SVG 或影像 URL。
- meta
- StyleImageMetadata
描述影像的其他選項
傳回
Promise<void>
clear()
移除使用者新增的所有映射。
function clear()
createFromTemplate(string, string, string, string, number)
建立影像,並將影像新增至地圖影像 Sprite。 提供要使用的內建範本名稱,以及要套用的色彩。 選擇性地,如果範本支援次要色彩,請指定次要色彩。 您也可以指定小數位數。 這可讓 SVG 在轉換成影像之前進行縮放,因此在相應增加時看起來更好。 傳回承諾。 在 Polygon 或 Symbol 圖層中參考此專案。
function createFromTemplate(id: string, templateName: string, color?: string, secondaryColor?: string, scale?: number): Promise<void>
參數
- id
-
string
影像的識別碼。如果指定的識別碼符合先前新增映射的識別碼,則會忽略新映射。
- templateName
-
string
要使用的樣板名稱。
- color
-
string
主要色彩值。 預設值:#1A73AA
- secondaryColor
-
string
次要色彩值。 預設值:白色
- scale
-
number
指定調整範本的程度。 為了獲得最佳結果,請將圖示縮放至您想要在地圖上顯示的大小上限,然後視需要使用符號圖層圖示大小選項來相應減少。 這可減少因縮放比例而模糊。 預設值:1
傳回
Promise<void>
getImageIds()
取得已新增至地圖影像 Sprite 的所有影像識別碼清單。
function getImageIds(): string[]
傳回
string[]
hasImage(string)
檢查影像是否已載入地圖影像 Sprite。
function hasImage(id: string): boolean
參數
- id
-
string
要檢查地圖影像 Sprite 的識別碼。
傳回
boolean
remove(string)
從地圖的影像 Sprite 中移除影像。
function remove(id: string)
參數
- id
-
string
要移除之影像的識別碼。