StyleLayer

Базовый класс для слоёв стилей

Наследует

Evented<ErrorEventType>

Методы

fire()

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

fire(event: ErrorEvent): this

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

Параметры

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

Возвращает

this

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

Evented.fire

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

fire(type: "error", 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`	`"error"`
`properties?`	`object`

Возвращает

this

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

Evented.fire

getLayoutAffectingGlobalStateRefs()

getLayoutAffectingGlobalStateRefs(): Set<string>

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

Возвращает

Set<string>

getPaintAffectingGlobalStateRefs()

getPaintAffectingGlobalStateRefs(): Map<string, PaintPropertyEntry[]>

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

Возвращает

Map<string, PaintPropertyEntry[]>

getVisibilityAffectingGlobalStateRefs()

getVisibilityAffectingGlobalStateRefs(): Set<string>

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

Возвращает

Set<string>

listens()

listens(type: "error"): boolean

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

Параметры

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

Возвращает

boolean

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

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

Evented.listens

off()

off<T наследует "error">(type: T, listener: (event: ErrorEventType[T]) => void): this

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

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

Параметр типа
`T` наследует `"error"`

Параметры

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

Возвращает

this

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

Evented.off

on()

on<T наследует "error">(type: T, listener: (event: ErrorEventType[T]) => void): Subscription

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

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

Параметр типа
`T` наследует `"error"`

Параметры

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

Возвращает

Subscription

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

Evented.on

once()

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

once<T наследует "error">(type: T): Promise<ErrorEventType[T]>

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

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

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

Параметр типа
`T` наследует `"error"`

Параметры

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

Возвращает

Promise<ErrorEventType[T]>

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

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

Evented.once

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

once<T наследует "error">(type: T, listener: (event: ErrorEventType[T]) => void): this

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

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

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

Параметр типа
`T` наследует `"error"`

Параметры

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

Возвращает

this

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

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

Evented.once

setEventedParent()

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

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

Параметры

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

Возвращает

this

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

Evented.setEventedParent

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