Spec-Zone.ru › MapLibre GL JS

RasterTileSource

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

Примеры

map.addSource('raster-source', {
    'type': 'raster',
    'tiles': ['https://tiles.stadiamaps.com/tiles/stamen_watercolor/{z}/{x}/{y}.jpg'],
    'tileSize': 256, // Set this to match tile server output to avoid blurry rendering
});

map.addSource('wms-test-source', {
     'type': 'raster',
// use the tiles option to specify a WMS tile source URL
     'tiles': [
         'https://img.nj.gov/imagerywms/Natural2015?bbox={bbox-epsg-3857}&format=image/png&service=WMS&version=1.1.1&request=GetMap&srs=EPSG:3857&transparent=true&width=256&height=256&layers=Natural2015'
     ],
     'tileSize': 256 // Important for WMS if tiles are 256px
});

См. также

  • Добавление источника растровых тайлов
  • Добавление источника WMS
  • Отображение спутниковой карты

Наследует

  • Evented<SourceEventType>

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

  • RasterDEMTileSource

Реализует

  • 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>

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

Параметры

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

Возвращает

Promise<void>

Реализация

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(): RasterSourceSpecification | RasterDEMSourceSpecification

Возвращает

RasterSourceSpecification | RasterDEMSourceSpecification

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

Реализация

Source.serialize

setEventedParent()

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

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

Параметры

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

Возвращает

this

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

Evented.setEventedParent

setPremultiplyAlpha()

setPremultiplyAlpha(premultiplyAlpha: boolean): this

Задаёт, применяется ли премультипликация альфа-канала к изображениям растровых тайлов. Установите значение false, чтобы сохранить точные значения байтов RGBA, когда альфа-канал содержит данные, а не информацию о непрозрачности.

Параметры

Параметр Тип Описание
premultiplyAlpha boolean Если false, отключает премультипликацию альфа-канала при декодировании изображений растровых тайлов и загрузке текстур.

Возвращает

this

Пример

map.getSource<RasterTileSource>('raster-source').setPremultiplyAlpha(false);

setTiles()

setTiles(tiles: string[]): this

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

Параметры

Параметр Тип Описание
tiles string[] Массив из одного или нескольких URL-адресов источников тайлов, соответствующих спецификации растровых тайлов (см. Спецификацию стилей

Возвращает

this

setUrl()

setUrl(url: string): this

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

Параметры

Параметр Тип Описание
url string URL-адрес ресурса TileJSON. Поддерживаются протоколы http: и https:.

Возвращает

this

unloadTile()

unloadTile(tile: Tile): Promise<void>

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

Параметры

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

Возвращает

Promise<void>

Реализация

Source.unloadTile

Свойства

id

id: string

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

Реализация

Source.id

maxzoom

maxzoom: number

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

Реализация

Source.maxzoom

minzoom

minzoom: number

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

Реализация

Source.minzoom

roundZoom

roundZoom: boolean

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

Реализация

Source.roundZoom

tileSize

tileSize: number

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

Реализация

Source.tileSize

© MapLibre contributors
Licensed under the 3-Clause BSD License.
https://maplibre.org/maplibre-gl-js/docs/API/classes/RasterTileSource/

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API