类:全屏

ol/control/FullScreen~全屏


import FullScreen from 'ol/control/FullScreen.js';

提供一个按钮,点击后地图将全屏显示。默认情况下,全屏源元素为包含地图视口的元素,但可通过提供 source 选项进行覆盖。此时,使用该参数指定的DOM元素将以全屏模式显示。

在全屏模式下,会显示一个关闭按钮以退出全屏模式。 全屏控件(Fullscreen API)用于切换地图的全屏模式。

new FullScreen(options)

Name Type 描述
className string (defaults to 'ol-full-screen')

CSS 类名。

label string | Text | HTMLElement (defaults to '\u2922')

按钮的文本标签。除文本外,也可使用元素(例如span元素)可以使用。

labelActive string | Text | 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 - 地图进入全屏后触发。
  • error 基础事件(BaseEvent) - 通用错误事件。在发生错误时触发。
  • leavefullscreen - 地图退出全屏后触发。
  • propertychange ObjectEvent对象事件 - 当属性发生变化时触发。

继承

方法

递增修订计数器并派发'change'事件。

dispatchEvent(event){boolean | undefined} inherited

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

Name Type 描述
event BaseEvent | string

事件对象。

返回:
false 如果有人在事件对象上调用了 preventDefault,或者任何侦听器返回了 false。

返回值。

Name Type 描述
key string

键名。

返回:
值。

getKeys(){Array.<string>} inherited

获取对象属性名列表。

返回:
属性名列表。

获取该控件关联的地图。

返回:
地图.

getProperties(){Object.<string, *>} inherited

获取包含所有属性名称及其值的对象。

返回:
对象。

getRevision(){number} inherited

获取该对象的版本号。每当对象被修改时,其版本号将递增。

返回:
修订。

on(type, listener){EventsKey | Array<EventsKey>} inherited

监听特定类型的事件。

Name Type 描述
type string | Array.<string>

事件类型或事件类型数组。

listener function

监听器函数。

返回:
监听器的唯一键。若以事件类型数组作为第一个参数调用,则返回将是键的数组。

once(type, listener){EventsKey | Array<EventsKey>} inherited

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

Name Type 描述
type string | Array.<string>

事件类型或事件类型数组。

listener function

监听器函数。

返回:
监听器的唯一键。如果以事件类型数组作为第一个参数调用,则返回将是键的数组。

渲染控件。

Name Type 描述
mapEvent MapEvent

地图事件。

set(key, value, silent) inherited

设置值。

Name Type 描述
key string

键名。

value *

值。

silent boolean | undefined

更新而不触发事件。

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

Name Type 描述
map Map | null

地图.

setProperties(values, silent) inherited

设置键值对集合。注意:此操作将修改现有属性并添加新属性,但不会删除任何现有属性。

Name Type 描述
values Object.<string, *>

值。

silent boolean | undefined

在不触发事件的情况下更新。

此函数用于设置控件的目标元素。若在控件已添加到地图后调用(即在控件上调用 setMap 之后),则无效。若在传递给控件构造函数的选项中未设置 target,且未调用 setTarget,则控件将被添加到地图的覆盖物容器中。

Name Type 描述
target HTMLElement | string

目标。

un(type, listener) inherited

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

Name Type 描述
type string | Array.<string>

事件类型或事件类型数组。

listener function

监听器函数。

unset(key, silent) inherited

清除属性。

Name Type 描述
key string

键名。

silent boolean | undefined

取消设置而不触发事件。