Evented<EventType extends EventTypeMap = EventTypeMap>

Методы, добавляемые в другие классы для поддержки событий.

Расширяется классами

• Map
• GeolocateControl
• FullscreenControl
• Popup
• Marker
• Style
• GeoJSONSource
• ImageSource
• RasterTileSource
• VectorTileSource
• StyleLayer

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

Методы

fire()

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

fire(event: EventType[Extract<keyof EventType, string>]): this

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

Параметры

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

this

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

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

listens()

listens(type: Extract<keyof EventType>): boolean

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

Параметры

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

boolean

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

off()

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

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

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

Параметры

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

this

on()

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

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

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

Параметры

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

Subscription

once()

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

once<T extends string>(type: T): Promise<EventType[T]>

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

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

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

Параметры

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

Promise<EventType[T]>

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

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

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

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

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

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

Параметры

Возвращает

this

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

setEventedParent()

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

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

Параметры

Возвращает

this