ImageSource

Источник данных, содержащий изображение. (Подробную документацию по параметрам см. в спецификации стилей.)

Пример

// add to map
map.addSource('some id', {
   type: 'image',
   url: 'https://www.maplibre.org/images/foo.png',
   coordinates: [
       [-76.54, 39.18],
       [-76.52, 39.18],
       [-76.52, 39.17],
       [-76.54, 39.17]
   ]
});

// update coordinates
let mySource = map.getSource('some id');
mySource.setCoordinates([
    [-76.54335737228394, 39.18579907229748],
    [-76.52803659439087, 39.1838364847587],
    [-76.5295386314392, 39.17683392507606],
    [-76.54520273208618, 39.17876344106642]
]);

// update url and coordinates simultaneously
mySource.updateImage({
   url: 'https://www.maplibre.org/images/bar.png',
   coordinates: [
       [-76.54335737228394, 39.18579907229748],
       [-76.52803659439087, 39.1838364847587],
       [-76.5295386314392, 39.17683392507606],
       [-76.54520273208618, 39.17876344106642]
   ]
})

// update with an already-decoded image (no network request)
const bitmap = await createImageBitmap(myCanvas);
mySource.updateImage({image: bitmap});

// create an empty source (no url), then feed it entirely via updateImage
map.addSource('empty id', {
   type: 'image',
   coordinates: [
       [-76.54, 39.18],
       [-76.52, 39.18],
       [-76.52, 39.17],
       [-76.54, 39.17]
   ]
});
(map.getSource('empty id') as ImageSource).updateImage({image: bitmap});

map.removeSource('some id');  // remove

Наследует

• Evented<SourceEventType>

Наследуется классами

• CanvasSource
• VideoSource

Реализует

• Source

Методы

fire()

Сигнатура вызова

fire(event: ErrorEvent | MapSourceDataEvent): this

Вызывает все обработчики, зарегистрированные для типа события.

Параметры

Возвращает

this

Реализация

Source.fire

Унаследовано от

Evented.fire

Сигнатура вызова

fire(type: keyof SourceEventType, properties?: object): this

Совместимость с сигнатурой (type: string, properties: Object) из предыдущих версий. См. https://github.com/mapbox/mapbox-gl-js/issues/6522, https://github.com/mapbox/mapbox-gl-draw/issues/766

Параметры

Возвращает

this

Реализация

Source.fire

Унаследовано от

Evented.fire

getWarp()

getWarp(): ImageSourceWarp

Experimental

Возвращает способ преобразования изображения в соответствии с его координатами.

Возвращает

ImageSourceWarp

Используемый способ преобразования; см. ImageSourceWarp.

hasTransition()

hasTransition(): boolean

Возвращает true, если у источника есть переход, и false в противном случае.

Возвращает

boolean

Реализация

Source.hasTransition

listens()

listens(type: keyof SourceEventType): boolean

Возвращает true, если у этого экземпляра Evented или любого перенаправленного экземпляра Evented есть обработчик для указанного типа события.

Параметры

Возвращает

boolean

true, если для указанного типа события зарегистрирован хотя бы один обработчик, и false в противном случае

Унаследовано от

Evented.listens

loaded()

loaded(): boolean

Возвращает true, если источник загружен, и false в противном случае.

Возвращает

boolean

Реализация

Source.loaded

loadTile()

loadTile(tile: Tile): Promise<void>

Этот метод выполняет основную работу по загрузке тайла. В большинстве случаев он передаёт эту задачу соответствующему источнику в рабочем процессе.

Параметры

Возвращает

Promise<void>

Реализация

Source.loadTile

off()

off<T extends keyof SourceEventType>(type: T, listener: (event: SourceEventType[T]) => void): this

Удаляет ранее зарегистрированный обработчик события.

Параметры типа

Параметры

Возвращает

this

Унаследовано от

Evented.off

on()

on<T extends keyof SourceEventType>(type: T, listener: (event: SourceEventType[T]) => void): Subscription

Добавляет обработчик для указанного типа события.

Параметры типа

Параметры

Возвращает

Subscription

Унаследовано от

Evented.on

onAdd()

onAdd(map: Map): void

Этот метод вызывается при добавлении источника на карту.

Параметры

Возвращает

void

Реализация

Source.onAdd

once()

Сигнатура вызова

once<T extends keyof SourceEventType>(type: T): Promise<SourceEventType[T]>

Добавляет обработчик для указанного типа события, который будет вызван только один раз.

Обработчик будет вызван при первом возникновении события после его регистрации.

Параметры типа

Параметры

Возвращает

Promise<SourceEventType[T]>

промис, который разрешается объектом события

Унаследовано от

Evented.once

Сигнатура вызова

once<T extends keyof SourceEventType>(type: T, listener: (event: SourceEventType[T]) => void): this

Добавляет обработчик для указанного типа события, который будет вызван только один раз.

Обработчик будет вызван при первом возникновении события после его регистрации.

Параметры типа

Параметры

Возвращает

this

this, если указан обработчик

Унаследовано от

Evented.once

onRemove()

onRemove(): void

Этот метод вызывается при удалении источника с карты.

Возвращает

void

Реализация

Source.onRemove

prepare()

prepare(): void

Позволяет выполнить этап подготовки перед использованием источника.

Возвращает

void

Реализация

Source.prepare

serialize()

serialize(): VideoSourceSpecification | ImageSourceSpecification | CanvasSourceSpecification

Возвращает

VideoSourceSpecification | ImageSourceSpecification | CanvasSourceSpecification

Обычный (преобразуемый в строку) объект JS, представляющий текущее состояние источника. Создание источника с использованием возвращённого объекта в качестве options должно привести к созданию источника, эквивалентного этому.

Реализует

Source.serialize

setCoordinates()

setCoordinates(coordinates: Coordinates): this

Задаёт координаты изображения и повторно отображает карту.

Параметры

Возвращает

this

setEventedParent()

setEventedParent(parent?: Evented<EventTypeMap>, data?: EventedParentData | (() => EventedParentData)): this

Передаёт все события, генерируемые этим экземпляром Evented, родительскому экземпляру Evented.

Параметры

Возвращает

this

Унаследовано от

Evented.setEventedParent

setWarp()

setWarp(warp: ImageSourceWarp): this

Experimental

Задаёт способ преобразования изображения в соответствии с его координатами и повторно отображает карту.

Это влияет на отображение, только если координаты не образуют прямоугольник. Параметр не входит в спецификацию стиля, поэтому его значение не сохраняется при map.setStyle.

Параметры

Возвращает

this

Пример

// Keep the image pinned to its corners while the user drags them around.
map.getSource('some id').setWarp('flat');

updateImage()

updateImage(options: UpdateImageOptions): this

Обновляет изображение и, при необходимости, координаты. Чтобы изображение не мигало после изменения, задайте для свойства рисования raster-fade-duration растрового слоя значение 0.

Укажите ровно один из параметров: url (чтобы загрузить новое изображение по сети) или image (уже декодированный HTMLImageElement, HTMLCanvasElement, ImageBitmap или ImageData для непосредственного отображения без сетевого запроса).

Параметры

Возвращает

this

Свойства

id

id: string

Идентификатор источника. Не должен совпадать с идентификатором существующего источника.

Реализует

Source.id

maxzoom

maxzoom: number

Максимальный уровень масштабирования источника.

Реализует

Source.maxzoom

minzoom

minzoom: number

Минимальный уровень масштабирования источника.

Реализует

Source.minzoom

terrainTileRanges

terrainTileRanges: object

Этот объект хранит диапазоны тайлов рельефа, перекрывающихся с данным тайлом. Он актуален для тайлов изображений, поскольку изображение выходит за границы одного тайла.

Сигнатура индекса

[zoom: string]: CanonicalTileRange

tileSize

tileSize: number

Размер тайла источника.

Реализует

Source.tileSize