1. 全屏操作类
位于：BOS3D.FullScreen
1.1. 方法
1.1.1. fullScreen
将给定的 dom 元素设置为全屏状态
| 名称 | 说明 | 类型 | 是否必须 | 示例 |
|---|---|---|---|---|
| element | 将要全屏显示的 dom 对象 | dom 元素 element | 是 | \ \ |
| 返回值说明 | 类型 | 示例 |
|---|---|---|
| 是否全屏成功 | 布尔值 boolean | true |
调用方式：
<body>
<div id="MyDiv"></div>
</body>
/**
* 该方法用来将指定的DOM元素设置为全屏状态，
* @function fullScreen
* @param element {element} DOM元素
*/
var element = document.getElementById("MyDiv");
var state = BOS3D.FullScreen.fullScreen(element); //state=true or false
demo 示例
| 示例名称 | 示例地址 |
|---|---|
| 全屏操作 | 去体验 |
1.1.2. exitFullScreen
该方法用来退出全屏状态
调用方式：
/**
* 该方法用来退出全屏
* @function exitFullScreen
*/
BOS3D.FullScreen.exitFullScreen();
1.1.3. onFullScreenChanged
该方法用来在全屏状态发生改变是触发回调函数(对于浏览器中按 F11 的情况无效)
| 名称 | 说明 | 类型 | 是否必须 | 示例 |
|---|---|---|---|---|
| callback | 全屏状态发生改变时候要进行的回调函数 | 函数 function | 是 | function(){} |
调用方式：
/**
* 该方法用来在全屏状态发生改变是触发回调函数(对于浏览器中按F11的情况无效)
* @function onFullScreenChanged
* @param callback {function} 状态发生变化之后进行的回调函数
*/
BOS3D.FullScreen.onFullScreenChanged(function () {
console.log("状态改变");
});
1.1.4. inFullScreen
判断当前是否处在全屏状态
| 返回值说明 | 类型 | 示例 |
|---|---|---|
| 是否处于全屏状态 | 布尔值 boolean | true |
调用方式：
/**
* 该方法用来判断是否处于全屏 (对于浏览器中按F11的情况无效)
* @function inFullScreen
*/
var state = BOS3D.FullScreen.inFullScreen(); //state=true or false
1.1.5. findFullScreenElement
该方法用来返回当前被全屏的元素，如果没有元素处于全屏状态，那么返回 undefined
| 返回值说明 | 类型 | 示例 |
|---|---|---|
| 当前被全屏的元素 | dom 元素 element | \ \ |
调用方式：
/**
该方法用来返回当前被全屏的元素
@function findFullScreenElement
*/
var element = BOS3D.FullScreen.findFullScreenElement(); //element=dom or undefined
1.1.6. isFullScreenAvailable
该方法用来返回指定的 DOM 元素可用的全屏方法
| 名称 | 说明 | 类型 | 是否必须 | 示例 |
|---|---|---|---|---|
| element | 将要全屏显示的 dom 对象 | dom 元素 element | 是 | \ \ |
| 返回值说明 | 类型 | 示例 |
|---|---|---|
| 全屏方法 | 函数 function | function(){} |
调用方式：
<body>
<div id="MyDiv"></div>
</body>
/**
* 该方法用来返回指定的DOM元素可用的全屏方法，
* @function isFullScreenAvailable
* @param element {element} DOM元素
*/
var element = document.getElementById("MyDiv");
var state = BOS3D.FullScreen.isFullScreenAvailable(element);