Style

Базовый класс Style

Наследует

• Evented<MapEventType>

Методы

_markImagesChanged()

_markImagesChanged(ids: string[]): void

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

Параметры

Возвращает

void

addLayer()

addLayer(layerObject: AddLayerObject, before?: string, options?: StyleSetterOptions): this

Добавляет слой в стиль карты. Слой будет вставлен перед слоем с идентификатором before или добавлен в конец, если before не указан.

Параметры

Возвращает

this

addSprite()

addSprite(id: string, url: string, options?: StyleSetterOptions, completion?: (err: Error) => void): void

Добавляет спрайт.

Параметры

Возвращает

void

destroy()

destroy(): void

Уничтожает все внутренние ресурсы стиля (источники, изображения, слои и т. д.).

Возвращает

void

fire()

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

fire(event: ErrorEvent | MapStyleImageMissingEvent | MapLibreEvent<unknown> | MapSourceDataEvent | MapMovementEvent | MapContextEvent | MapStyleDataEvent | MapStyleLoadEvent | MapBoxZoomEvent | MapTouchEvent | MapMouseEvent | MapWheelEvent | MapTerrainEvent | MapLibreEvent<TouchEvent | WheelEvent> & object | MapProjectionEvent): this

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

Параметры

Возвращает

this

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

Evented.fire

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

fire(type: keyof MapEventType, 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

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

Evented.fire

getFilter()

getFilter(layer: string): void | FilterSpecification

Получает объект фильтра слоя

Параметры

Возвращает

void | FilterSpecification

фильтр слоя, если он задан

getLayer()

getLayer(id: string): StyleLayer

Возвращает объект слоя стиля с указанным id.

Параметры

Возвращает

StyleLayer

слой, если существует слой с указанным id

getLayersOrder()

getLayersOrder(): string[]

Возвращает идентификаторы всех слоёв, находящихся в данный момент в стиле, включая пользовательские слои, в порядке их расположения.

Возвращает

string[]

идентификаторы слоёв в порядке их расположения

getLayoutProperty()

getLayoutProperty<K extends keyof AllLayoutProperties>(layerId: string, name: K): AllLayoutProperties[K]

Получает значение свойства макета для указанного слоя

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

Параметры

Возвращает

AllLayoutProperties[K]

значение свойства

getSource()

getSource(id: string): Source

Получает источник по идентификатору.

Параметры

Возвращает

Source

источник

getSprite()

getSprite(): object[]

Получает текущее значение спрайта.

Возвращает

object[]

пустой массив, если спрайт не задан; в противном случае — пары «идентификатор — URL»

hasLayer()

hasLayer(id: string): boolean

Проверяет, присутствует ли указанный слой в стиле.

Параметры

Возвращает

boolean

логическое значение, указывающее, присутствует ли указанный слой

listens()

listens(type: keyof MapEventType): boolean

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

Параметры

Возвращает

boolean

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

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

Evented.listens

moveLayer()

moveLayer(id: string, before?: string): void

Перемещает слой на другую позицию по оси z. Слой будет вставлен перед слоем с ID before или добавлен в конец, если before не указан.

Параметры

Возвращает

void

off()

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

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

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

Параметры

Возвращает

this

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

Evented.off

on()

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

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

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

Параметры

Возвращает

Subscription

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

Evented.on

once()

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

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

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

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

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

Параметры

Возвращает

Promise<MapEventType[T]>

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

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

Evented.once

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

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

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

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

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

Параметры

Возвращает

this

this, если передан обработчик

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

Evented.once

removeLayer()

removeLayer(id: string): void

Удаляет из стиля слой с указанным идентификатором. Если такого слоя нет, будет вызвано событие ErrorEvent.

Параметры

Возвращает

void

removeSource()

removeSource(id: string): this

Удаляет источник из этой таблицы стилей по его идентификатору.

Параметры

Возвращает

this

Вызывает исключение

если источник с указанным идентификатором не найден

removeSprite()

removeSprite(id: string): void

Удаляет спрайт по его идентификатору. После удаления последнего спрайта весь объект this.stylesheet.sprite становится undefined. Это ложное значение undefined предотвращает последующие попытки загрузить отсутствующий спрайт.

Параметры

Возвращает

void

setEventedParent()

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

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

Параметры

Возвращает

this

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

Evented.setEventedParent

setGeoJSONSourceData()

setGeoJSONSourceData(id: string, data: string | GeoJSON<Geometry, {[name: string]: any; }>): void

Задать данные источника GeoJSON по его идентификатору.

Параметры

Возвращает

void

setSprite()

setSprite(sprite: SpriteSpecification, options?: StyleSetterOptions, completion?: (err: Error) => void): void

Задать новое значение спрайта стиля.

Параметры

Возвращает

void

setState()

setState(nextState: StyleSpecification, options?: StyleSwapOptions & StyleSetterOptions): boolean

Обновить состояние этого стиля в соответствии с заданным JSON стиля, выполняя только необходимые изменения.

Может выбросить ошибку ('Unimplemented: METHOD'), если алгоритм diff из maplibre-gl-style-spec создаст неподдерживаемую операцию.

Параметры

Возвращает

boolean

true, если были внесены изменения; иначе false

triggerSymbolPlacement()

triggerSymbolPlacement(): void

Повторно размещает символы в следующем кадре. Размещение пропускается, если входные данные кажутся неизменившимися, поэтому вызывайте этот метод, когда символы сместились из-за изменений, которые карта не может обнаружить самостоятельно.

Возвращает

void