FullscreenControl
定义于: src/ui/control/fullscreen_control.ts:40
FullscreenControl
控件包含一个用于切换地图进入和退出全屏模式的按钮;当不支持requestFullscreen时,全屏是通过CSS属性处理的;地图的cooperativeGestures
选项在地图处于全屏模式时会临时禁用,并在地图退出全屏模式时恢复;
参数
全屏控件选项
示例
map.addControl(new FullscreenControl({container: document.querySelector('body')}));
参见
查看全屏地图
事件
事件 当全屏模式开始时,将触发类型为Event的fullscreenstart
事件;
事件 当全屏模式结束时,将触发类型为Event的fullscreenend
事件;
继承
- Evented
实现
- IControl
构造函数
构造函数
new FullscreenControl(options: FullscreenControlOptions): FullscreenControl
定义于: src/ui/control/fullscreen_control.ts:52
参数
参数 | 类型 | 描述 |
---|---|---|
options | FullscreenControlOptions | 控件的选项 |
返回
FullscreenControl
覆盖
Evented.constructor
方法
listens()
listens(type: string): boolean
定义于: src/util/evented.ts:165
如果这个Evented实例或任何转发的Evented实例对指定类型有监听器,则返回true;
参数
参数 | 类型 | 描述 |
---|---|---|
type | string | 事件类型 |
返回
boolean
如果指定的事件类型至少有一个注册的监听器,则为true
,否则为false
继承自
Evented.listens
off()
off(type: string, listener: Listener): FullscreenControl
定义于: src/util/evented.ts:90
移除先前注册的事件监听器;
参数
参数 | 类型 | 描述 |
---|---|---|
type | string | 要移除监听器的事件类型 |
listener | Listener | 要移除的监听器函数 |
返回
FullscreenControl
继承自
Evented.off
on()
on(type: string, listener: Listener): Subscription
定义于: src/util/evented.ts:73
为指定的事件类型添加监听器;
参数
参数 | 类型 | 描述 |
---|---|---|
type | string | 要添加监听的事件类型 |
listener | Listener | 事件触发时要调用的函数;监听器函数使用传递给fire的数据对象调用,该对象扩展了target和type属性 |
返回
Subscription
继承自
Evented.on
onAdd()
onAdd(map: Map): HTMLElement
定义于: src/ui/control/fullscreen_control.ts:76
在地图上注册控件,并让其有机会注册事件监听器和资源;此方法由Map#addControl在内部调用;
参数
参数 | 类型 | 描述 |
---|---|---|
map | Map | 将添加此控件的地图 |
返回
HTMLElement
控件的容器元素;这应该由控件创建并由onAdd返回,而不附加到DOM:地图将根据需要将控件的元素插入到DOM中;
实现
IControl.onAdd
once()
once(type: string, listener?: Listener): Promise<any> | FullscreenControl
定义于: src/util/evented.ts:106
添加一个只会被调用一次的监听器到指定的事件类型;
在注册监听器后,首次触发事件时将调用该监听器;
参数
参数 | 类型 | 描述 |
---|---|---|
type | string | 要监听的事件类型 |
listener? | Listener | 首次触发事件时要调用的函数 |
返回
Promise<any> | FullscreenControl
如果未提供监听器,则返回this
或Promise
继承自
Evented.once
onRemove()
onRemove(): void
定义于: src/ui/control/fullscreen_control.ts:85
在地图上注销控件,并让其有机会分离事件监听器和资源;此方法由Map#removeControl在内部调用;
返回
void
实现
IControl.onRemove
setEventedParent()
setEventedParent(parent?: Evented, data?: any): FullscreenControl
定义于: src/util/evented.ts:176
将此Evented实例触发的所有事件冒泡到此Evented的父实例;
参数
参数 | 类型 | 描述 |
---|---|---|
parent? | Evented | |
data? | any |
返回
FullscreenControl
继承自
Evented.setEventedParent