ImageSpriteManager interface

Диспетчер спрайта изображения элемента управления картой. Предоставляется через свойство imageSprite атласа. Класс Map. Невозможно создать экземпляр пользователя.

Методы

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

Добавьте изображение значка в спрайт изображения карты для использования с символами и шаблонами.

clear()

Удаляет все изображения, добавленные пользователем.

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

Создает и добавляет изображение в спрайт изображений карт. Укажите имя встроенного шаблона, который будет использоваться, и цвет для применения. При необходимости означите дополнительный цвет, если шаблон поддерживает его. Также можно указать масштаб. Это позволит масштабировать SVG перед преобразованием в изображение и, таким образом, выглядит гораздо лучше при масштабировании. Возвращает обещание. Ссылка на эту ссылку на слой многоугольников или символов.

getImageIds()

Возвращает список всех идентификаторов изображений, добавленных в спрайт изображений карт.

hasImage(string)

Проверяет, загружен ли образ в спрайт изображений карт.

remove(string)

Удаляет изображение из спрайта изображения карты.

Сведения о методе

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

Добавьте изображение значка в спрайт изображения карты для использования с символами и шаблонами.

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

Параметры

id

string

Идентификатор изображения. Если указанный идентификатор соответствует идентификатору ранее добавленного изображения, новый образ будет игнорироваться.

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

Идентификатор изображения. Если указанный идентификатор соответствует идентификатору ранее добавленного изображения, новый образ будет игнорироваться.

templateName

string

Имя шаблона для использования.

color

string

Основное значение цвета. Значение по умолчанию: #1A73AA

secondaryColor

string

Дополнительное значение цвета. По умолчанию: белый

scale

number

Указывает, сколько нужно масштабировать шаблон. Чтобы получить наилучшие результаты, масштабируйте значок до максимального размера, который вы хотите отобразить на карте, а затем используйте параметр размера значка символов, чтобы уменьшить масштаб при необходимости. Это уменьшит размытость из-за масштабирования. Значение по умолчанию: 1.

Возвращаемое значение

Promise<void>

getImageIds()

Возвращает список всех идентификаторов изображений, добавленных в спрайт изображений карт.

function getImageIds(): string[]

Возвращаемое значение

string[]

hasImage(string)

Проверяет, загружен ли образ в спрайт изображений карт.

function hasImage(id: string): boolean

Параметры

id

string

Идентификатор для проверки спрайта изображения карты.

Возвращаемое значение

boolean

remove(string)

Удаляет изображение из спрайта изображения карты.

function remove(id: string)

Параметры

id

string

Идентификатор удаляемого изображения.