VectorTileSource

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

Примеры

map.addSource('some id', {
    type: 'vector',
    url: 'https://demotiles.maplibre.org/tiles/tiles.json'
});

map.addSource('some id', {
    type: 'vector',
    tiles: ['https://d25uarhxywzl1j.cloudfront.net/v0.1/{z}/{x}/{y}.mvt'],
    minzoom: 6,
    maxzoom: 14
});

map.getSource('some id').setUrl("https://demotiles.maplibre.org/tiles/tiles.json");

map.getSource('some id').setTiles(['https://d25uarhxywzl1j.cloudfront.net/v0.1/{z}/{x}/{y}.mvt']);

См. также

Добавление источника векторных тайлов

Наследует

Evented<SourceEventType>

Реализует

Source

Методы

abortTile()

abortTile(tile: Tile): Promise<void>

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

Параметры

Параметр	Тип	Описание
`tile`	`Tile`	Тайл, загрузку которого нужно прервать

Возвращает

Promise<void>

Реализация

Source.abortTile

fire()

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

fire(event: ErrorEvent | MapSourceDataEvent): this

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

Параметры

Параметр	Тип
`event`	`ErrorEvent` \| `MapSourceDataEvent`

Возвращает

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

Параметры

Параметр	Тип
`type`	keyof `SourceEventType`
`properties?`	`object`

Возвращает

this

Реализация

Source.fire

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

Evented.fire

hasTile()

hasTile(tileID: OverscaledTileID): boolean

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

Параметры

Параметр	Тип	Описание
`tileID`	`OverscaledTileID`	Идентификатор тайла

Возвращает

boolean

Реализация

Source.hasTile

hasTransition()

hasTransition(): boolean

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

Возвращает

boolean

Реализация

Source.hasTransition

listens()

listens(type: keyof SourceEventType): boolean

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

Параметры

Параметр	Тип	Описание
`type`	keyof `SourceEventType`	Тип события

Возвращает

boolean

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

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

Evented.listens

loaded()

loaded(): boolean

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

Возвращает

boolean

Реализация

Source.loaded

loadTile()

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

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

Параметры

Параметр	Тип	Описание
`tile`	`Tile`	Тайл для загрузки

Возвращает

Promise<void | LoadTileResult>

Реализация

Source.loadTile

off()

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

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

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

Параметр типа
`T` extends keyof `SourceEventType`

Параметры

Параметр	Тип	Описание
`type`	`T`	Тип события, для которого нужно удалить обработчики.
`listener`	(`event`: `SourceEventType`[`T`]) => `void`	Функция-обработчик, которую нужно удалить.

Возвращает

this

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

Evented.off

on()

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

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

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

Параметр типа
`T` extends keyof `SourceEventType`

Параметры

Параметр	Тип	Описание
`type`	`T`	Тип события, для которого нужно добавить обработчик.
`listener`	(`event`: `SourceEventType`[`T`]) => `void`	Функция, вызываемая при возникновении события. Функция-обработчик вызывается с объектом данных, переданным в `fire`, дополненным свойствами `target` и `type`.

Возвращает

Subscription

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

Evented.on

onAdd()

onAdd(map: Map): void

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

Параметры

Параметр	Тип	Описание
`map`	`Map`	Экземпляр карты

Возвращает

void

Реализация

Source.onAdd

once()

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

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

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

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

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

Параметр типа
`T` extends keyof `SourceEventType`

Параметры

Параметр	Тип	Описание
`type`	`T`	Тип события, которое нужно отслеживать.

Возвращает

Promise<SourceEventType[T]>

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

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

Evented.once

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

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

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

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

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

Параметр типа
`T` extends keyof `SourceEventType`

Параметры

Параметр	Тип	Описание
`type`	`T`	Тип события, которое нужно отслеживать.
`listener`	(`event`: `SourceEventType`[`T`]) => `void`	Функция, вызываемая при первом возникновении события.

Возвращает

this

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

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

Evented.once

onRemove()

onRemove(): void

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

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

void

Реализация

Source.onRemove

serialize()

serialize(): VectorSourceSpecification

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

VectorSourceSpecification

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

Реализация

Source.serialize

setEventedParent()

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

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

Параметры

Параметр	Тип
`parent?`	`Evented`<`EventTypeMap`>
`data?`	`EventedParentData` \| (() => `EventedParentData`)

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

this

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

Evented.setEventedParent

setTiles()

setTiles(tiles: string[]): this

Задаёт свойство tiles источника и повторно отображает карту.

Параметры

Параметр	Тип	Описание
`tiles`	`string`[]	Массив из одного или нескольких URL-адресов источников тайлов в соответствии со спецификацией TileJSON.