Source

Интерфейс Source должен быть реализован каждым типом источника, включая «базовые» типы (vector, raster, video и т. д.) и все пользовательские сторонние типы.

Событие data — генерируется с {dataType: 'source', sourceDataType: 'metadata'}, чтобы указать, что все необходимые метаданные загружены и можно вызывать loadTile; и с {dataType: 'source', sourceDataType: 'content'}, чтобы указать, что данные источника изменились и все текущие кэши должны быть очищены.

Методы

abortTile()?

optional abortTile(tile: Tile): Promise<void>

Позволяет прервать загрузку тайла.

Параметры

Возвращает

Promise<void>

fire()

fire(event: Event): unknown

Возможность инициировать событие для всех слушателей, см. Evented

Параметры

Возвращает

unknown

hasTile()?

optional hasTile(tileID: OverscaledTileID): boolean

True, если тайл является частью источника, иначе false.

Параметры

Возвращает

boolean

hasTransition()

hasTransition(): boolean

True, если у источника есть переход, иначе false.

Возвращает

boolean

loaded()

loaded(): boolean

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

Возвращает

boolean

loadTile()

loadTile(tile: Tile): Promise<void | LoadTileResult>

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

Параметры

Возвращает

Promise<void | LoadTileResult>

onAdd()?

optional onAdd(map: Map): void

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

Параметры

Возвращает

void

onRemove()?

optional onRemove(map: Map): void

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

Параметры

Возвращает

void

prepare()?

optional prepare(): void

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

Возвращает

void

serialize()

serialize(): any

Возвращает

any

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

unloadTile()?

optional unloadTile(tile: Tile): Promise<void>

Позволяет выгрузить тайл.

Параметры

Возвращает

Promise<void>

Свойства

attribution?

optional attribution?: string

Атрибуция источника.

calculateTileZoom?

optional calculateTileZoom?: CalculateTileZoomFunction

Необязательная функция для переопределения способа загрузки тайлов при больших углах наклона.

id

id: string

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

isTileClipped?

optional isTileClipped?: boolean

false, если тайлы могут быть отрисованы за пределами их границ, true, если нет.

maxzoom

maxzoom: number

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

minzoom

minzoom: number

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

reparseOverscaled?

optional reparseOverscaled?: boolean

true, если тайлы должны отправляться обратно в воркер для каждого превышенного уровня масштабирования, false, если нет.

roundZoom?

optional roundZoom?: boolean

true, если уровни масштабирования округляются до ближайшего целого числа в данных источника, false, если они округляются в меньшую сторону до ближайшего целого числа.

tileSize

tileSize: number

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