Evented
定义于: src/util/evented.ts:59
为其他类混入事件功能的方法。
被继承者
- GeolocateControl
- FullscreenControl
- Popup
- Marker
- Style
- GeoJSONSource
- ImageSource
- RasterTileSource
- VectorTileSource
- StyleLayer
- ImageManager
方法
listens()
listens(
type
:string
):boolean
定义于: src/util/evented.ts:165
如果Evented的这个实例或任何转发的Evented实例有指定类型的监听器,则返回true。
参数
参数 | 类型 | 描述 |
---|---|---|
type | string | 事件类型 |
返回值
boolean
如果为指定的事件类型注册了至少一个监听器,则为true
,否则为false
off()
off(
type
:string
,listener
: Listener):Evented
定义于: src/util/evented.ts:90
移除先前注册的事件监听器。
参数
参数 | 类型 | 描述 |
---|---|---|
type | string | 要移除监听器的事件类型 |
listener | Listener | 要移除的监听器函数 |
返回值
Evented
on()
on(
type
:string
,listener
: Listener): Subscription
定义于: src/util/evented.ts:73
为指定的事件类型添加监听器。
参数
参数 | 类型 | 描述 |
---|---|---|
type | string | 要添加监听的事件类型 |
listener | Listener | 事件触发时要调用的函数。监听器函数使用传递给fire的数据对象调用,该对象扩展了target和type属性 |
返回值
Subscription
once()
once(
type
:string
,listener?
: Listener):Promise
<any
> |Evented
定义于: src/util/evented.ts:106
添加一个只调用一次的监听器到指定的事件类型。
监听器将在事件首次触发后被调用。
参数
参数 | 类型 | 描述 |
---|---|---|
type | string | 要监听的事件类型 |
listener? | Listener | 事件首次触发时要调用的函数 |
返回值
Promise
<any
> | Evented
如果未提供监听器,则返回this
或一个promise
setEventedParent()
setEventedParent(
parent?
:Evented
,data?
:any
):Evented
定义于: src/util/evented.ts:176
将此Evented实例触发的所有事件冒泡到此父Evented实例。
参数
参数 | 类型 |
---|---|
parent? | Evented |
data? | any |
返回值
Evented