CanvasSource

Источник данных, содержащий содержимое HTML-элемента canvas. Подробное описание параметров см. в CanvasSourceSpecification.

Пример

// add to map
map.addSource('some id', {
   type: 'canvas',
   canvas: 'idOfMyHTMLCanvas',
   animate: true,
   coordinates: [
       [-76.54, 39.18],
       [-76.52, 39.18],
       [-76.52, 39.17],
       [-76.54, 39.17]
   ]
});

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

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

Наследует

• ImageSource

Методы

fire()

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

fire(event: ErrorEvent | MapSourceDataEvent): this

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

Параметры

Возвращает

this

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

ImageSource.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

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

ImageSource.fire

getCanvas()

getCanvas(): HTMLCanvasElement

Возвращает элемент HTML canvas.

Возвращает

HTMLCanvasElement

Элемент HTML canvas.

getWarp()

getWarp(): ImageSourceWarp

Experimental

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

Возвращает

ImageSourceWarp

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

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

ImageSource.getWarp

listens()

listens(type: keyof SourceEventType): boolean

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

Параметры

Возвращает

boolean

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

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

ImageSource.listens

loaded()

loaded(): boolean

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

Возвращает

boolean

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

ImageSource.loaded

loadTile()

loadTile(tile: Tile): Promise<void>

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

Параметры

Возвращает

Promise<void>

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

ImageSource.loadTile

off()

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

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

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

Параметры

Возвращает

this

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

ImageSource.off

on()

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

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

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

Параметры

Возвращает

Subscription

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

ImageSource.on

once()

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

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

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

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

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

Параметры

Возвращает

Promise<SourceEventType[T]>

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

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

ImageSource.once

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

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

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

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

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

Параметры

Возвращает

this

this, если передан прослушиватель

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

ImageSource.once

setCoordinates()

setCoordinates(coordinates: Coordinates): this

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

Параметры

Возвращает

this

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

ImageSource.setCoordinates

setEventedParent()

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

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

Параметры

Возвращает

this

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

ImageSource.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');

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

ImageSource.setWarp

updateImage()

updateImage(options: UpdateImageOptions): this

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

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

Параметры

Возвращает

this

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

ImageSource.updateImage

Свойства

id

id: string

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

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

ImageSource.id

maxzoom

maxzoom: number

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

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

ImageSource.maxzoom

minzoom

minzoom: number

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

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

ImageSource.minzoom

pause

pause: () => void

Отключает анимацию. Карта будет отображать статическую копию изображения с холста.

Возвращает

void

play

play: () => void

Включает анимацию. На каждом кадре изображение будет копироваться с холста на карту.

Возвращает

void

terrainTileRanges

terrainTileRanges: object

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

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

[zoom: string]: CanonicalTileRange

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

ImageSource.terrainTileRanges

tileSize

tileSize: number

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

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

ImageSource.tileSize