ImageSpriteManager interface

パッケージ:

azure-maps-control

マップ コントロールのイメージ スプライトのマネージャー。 atlas の imageSprite プロパティを介して公開されます。マップ クラス。 ユーザーがインスタンス化することはできません。

メソッド

add(string, string | HTMLImageElement | ImageData, StyleImageMetadata)	シンボルとパターンで使用するために、マップのイメージ スプライトにアイコン イメージを追加します。
clear()	ユーザーによって追加されたすべてのイメージを削除します。
createFromTemplate(string, string, string, string, number)	マップ イメージ スプライトにイメージを作成して追加します。 使用する組み込みテンプレートの名前と、適用する色を指定します。 テンプレートでサポートされている場合は、必要に応じて 2 番目の色を指定します。 スケールを指定することもできます。 これにより、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)

マップ イメージ スプライトにイメージを作成して追加します。 使用する組み込みテンプレートの名前と、適用する色を指定します。 テンプレートでサポートされている場合は、必要に応じて 2 番目の色を指定します。 スケールを指定することもできます。 これにより、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

2 番目の色の値。 既定値: 白

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。