OpenLayers v10.9.0 API - Class: FullScreen

new FullScreen(options) control/FullScreen.js, line 77

Name	Type	Description
`className`	string (defaults to 'ol-full-screen')	CSS 类名。
`label`	string \| 文本 \| HTMLElement (defaults to '\u2922')	按钮的文本标签。除了文本，也可以使用元素（例如 `span` 元素）。
`labelActive`	string \| 文本 \| HTMLElement (defaults to '\u00d7')	全屏激活时按钮的文本标签。除了文本，也可以使用元素（例如 `span` 元素）。
`activeClassName`	string (defaults to className + '-true')	全屏激活时按钮的 CSS 类名。
`inactiveClassName`	string (defaults to className + '-false')	全屏未激活时按钮的 CSS 类名。
`tipLabel`	string (defaults to 'Toggle full-screen')	用于按钮提示的文本标签。
`keys`	boolean (defaults to false)	完全键盘访问。
`target`	HTMLElement \| string \| undefined	如果希望控件在地图视口之外渲染，请指定目标。
`source`	HTMLElement \| string \| undefined	要全屏显示的元素。如果未提供，则包含地图视口的元素将全屏显示。

触发事件：

change (BaseEvent) - 通用更改事件。当修订计数器增加时触发。
enterfullscreen - Triggered after the map entered fullscreen.
error (BaseEvent) - 通用错误事件。当发生错误时触发。
leavefullscreen - Triggered after the map leave fullscreen.
propertychange (ObjectEvent) - 当属性更改时触发。

Extends

Control

Methods

changed() inherited Observable.js, line 68

增加修订计数器并分发 'change' 事件。

dispatchEvent(event){boolean | undefined} inherited events/Target.js, line 85

分发事件并调用所有监听此类型事件的监听器。事件参数可以是一个字符串或一个具有 type 属性的对象。

Name	Type	Description
`event`	BaseEvent \| string	事件对象。

返回值：

如果有人在事件对象上调用了 preventDefault 或任何监听器返回 false，则返回 false。

get(key){*} inherited Object.js, line 136

获取一个值。

Name	Type	Description
`key`	string	键名。

返回值：

值。

getKeys(){Array.<string>} inherited Object.js, line 149

获取对象属性名列表。

返回值：

属性名列表。

getMap(){Map | null} inherited control/控件。js, line 104

获取与此控件关联的地图。

返回值：

地图。

getProperties(){NoInfer.<Properties>} inherited Object.js, line 158

获取包含所有属性名和值的对象。

返回值：

对象。

getRevision(){number} inherited Observable.js, line 79

获取此对象的版本号。每次对象被修改时，其版本号将递增。

返回值：

版本号。

on(type, listener){EventsKey | Array<EventsKey>} inherited Observable.js, line 152

监听特定类型的事件。

Name	Type	Description
`type`	string \| Array.<string>	事件类型或事件类型数组。
`listener`	function	监听器函数。

返回值：

监听器的唯一键。如果第一个参数是事件类型数组，则返回键的数组。

once(type, listener){EventsKey | Array<EventsKey>} inherited Observable.js, line 164

仅监听一次特定类型的事件。

Name	Type	Description
`type`	string \| Array.<string>	事件类型或事件类型数组。
`listener`	function	监听器函数。

返回值：

监听器的唯一键。如果第一个参数是事件类型数组，则返回键的数组。

render(mapEvent) inherited control/控件。js, line 144

渲染控件。

Name	Type	Description
`mapEvent`	MapEvent	地图事件。

set(key, value, silent) inherited Object.js, line 218

设置一个值。

Name	Type	Description
`key`	string	键名。
`value`	*	值。
`silent`	boolean \| undefined	更新但不触发事件。

setMap(map) control/FullScreen.js, line 288

从当前地图移除控件并将其附加到新地图。传入 null 仅从当前地图移除控件。子类可以在此设置事件处理程序以获取地图更改的通知。

Name	Type	Description
`map`	Map \| null	地图。

setProperties(values, silent) inherited Object.js, line 238

设置一组键值对。注意，这会更改任何现有属性并添加新属性（不会移除任何现有属性）。

Name	Type	Description
`values`	Partial.<NoInfer.<Properties>>	值。
`silent`	boolean \| undefined	更新但不触发事件。

setTarget(target) inherited control/控件。js, line 155

此函数用于设置控件的目标元素。如果在控件添加到地图之后调用（即在控件上调用了 setMap 之后），则不会产生任何效果。如果在传递给控件构造函数的选项中没有设置 target，并且也没有调用 setTarget，则控件将被添加到地图的叠加容器中。

Name	Type	Description
`target`	HTMLElement \| string	目标。

un(type, listener) inherited Observable.js, line 173

取消监听特定类型的事件。

Name	Type	Description
`type`	string \| Array.<string>	事件类型或事件类型数组。
`listener`	function	监听器函数。

unset(key, silent) inherited Object.js, line 262

取消设置一个属性。

Name	Type	Description
`key`	string	键名。
`silent`	boolean \| undefined	取消设置但不触发事件。