Module basic module

Module gui

gui module

Instructions:

1
var gui = require('gui');

Static function

setVersion

set up WebView The highest simulation version of the internal ie. When the system ie version is lower than this version, the system installation version will be simulated

1
static gui.setVersion(Integer ver);

Call parameters:

  • ver: Integer, specify ie simulation version

config

Set gui global parameters, config is only valid for cef gui, and will not affect native webview

1
static gui.config(Object opt = {});

Call parameters:

  • opt: Object, specify the set parameters

The following parameters are supported:

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18
{ "cache_path": "", // 设置数据持久化目录,缺省为空,退出进程后,客户端临时数据将不会被保存 "cef_path": "", // 设置 runtime 路径,缺省时在当前目录寻找 runtime "download_path": "", // 设置下载文件保存路径,缺省时在当前目录 "download_dialog": true, // 设置是否显示下载文件对话框,缺省时显示 "debug": true, // 全局设置是否输出 WebView 内的错误和 console 信息,缺省显示 "popup": true, // 全局设置是否允许弹出新的网页,缺省允许 "menu": true, // 全局设置是否允许右键菜单,缺省允许 "headless": false, // 设置 gui 全局无窗口,缺省不使用无窗口,当命令行指定 --headless 时,此属性将被忽略 "backend": { // 设置 cef 后端处理器,可用于处理 WebView 内部请求 "http://app1/": handler1, "fibjs://app2/": handler2, }, "proxy": { // 全局设置 cef 访问代理 "mode": "fixed_servers|pac_script|auto_detect|system|direct", // 指定代理模式 "server": "localhost:8888" // 指定代理服务器地址,当 mode 为 pac_script 时,指定 pac url } }

open

Open a window and visit the specified URL

1 2
static WebView gui.open(String url, Object opt = {});

Call parameters:

  • url: String, the specified URL, can be used fs:path Access local file system
  • opt: Object, open window parameters

Return result:

  • WebView, Returns the opened window object

The following parameters are supported:

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24
{ "type": "cef", // 指定 WenView 引擎,允许值为 "native" 和 "cef",缺省为 "cef" "left": 100, // 窗口左上角 x,缺省系统自动设定 "right": 100, // 窗口左上角 y,缺省系统自动设定 "width": 100, // 窗口宽度,缺省系统自动设定 "height": 100, // 窗口高度,缺省系统自动设定 "border": true, // 是否有边框,缺省有边框 "caption": true, // 是否有标题栏,缺省有标题栏 "resizable": true, // 是否可改变尺寸,缺省可以改变 "maximize": false, // 是否最大化显示,缺省不最大化 "fullscreen": false, // 是否显示全屏窗口,缺省不全屏 "debug": true, // 是否输出 WebView 内的错误和 console 信息,缺省显示或继承全局设置 // 以下配置仅用于 cef 模式 "download_path": "", // 设置下载文件保存路径,缺省继承全局设置 "download_dialog": true, // 设置是否显示下载文件对话框,缺省继承全局设置 "popup": true, // 是否允许弹出新的网页,缺省继承全局设置 "menu": true, // 是否允许右键菜单,缺省继承全局设置 "headless": false, // 是否使用无窗口模式加载页面,缺省不使用无窗口,当命令行指定 --headless 时,此属性将被忽略 "proxy": { // 设置访问代理,为设置时继承s全局设置 "mode": "fixed_servers|pac_script|auto_detect|system|direct", // 指定代理模式 "server": "localhost:8888" // 指定代理服务器地址,当 mode 为 pac_script 时,指定 pac url } }

When width and height are set, but left or right is not set, the window will be automatically centered


Open an empty browser window

1
static WebView gui.open(Object opt = {});

Call parameters:

  • opt: Object, open window parameters

Return result:

  • WebView, Returns the opened window object

The following parameters are supported:

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21
{ "left": 100, // 窗口左上角 x,缺省系统自动设定 "right": 100, // 窗口左上角 y,缺省系统自动设定 "width": 100, // 窗口宽度,缺省系统自动设定 "height": 100, // 窗口高度,缺省系统自动设定 "border": true, // 是否有边框,缺省有边框 "caption": true, // 是否有标题栏,缺省有标题栏 "resizable": true, // 是否可改变尺寸,缺省可以改变 "maximize": false, // 是否最大化显示,缺省不最大化 "fullscreen": false, // 是否显示全屏窗口,缺省不全屏 "debug": true, // 是否输出 WebView 内的错误和 console 信息,缺省显示或继承全局设置 // 以下配置仅用于 cef 模式 "popup": true, // 是否允许弹出新的网页,缺省允许或继承全局设置 "menu": true, // 是否允许右键菜单,缺省允许或继承全局设置 "headless": false, // 是否使用无窗口模式加载页面,缺省不使用无窗口,当命令行指定 --headless 时,此属性将被忽略 "proxy": { // 设置访问代理,为设置时继承s全局设置 "mode": "fixed_servers|pac_script|auto_detect|system|direct", // 指定代理模式 "server": "localhost:8888" // 指定代理服务器地址,当 mode 为 pac_script 时,指定 pac url } }

When width and height are set, but left or right is not set, the window will be automatically centered

constant

IE7

WebView ie simulation version, specify ie7

1
const gui.IE7 = 7000;

IE8

WebView ie simulation version, specify ie8

1
const gui.IE8 = 8000;

IE9

WebView ie simulation version, specify ie9

1
const gui.IE9 = 9000;

IE10

WebView ie simulation version, specify ie10

1
const gui.IE10 = 10000;

IE11

WebView ie simulation version, specify ie11

1
const gui.IE11 = 11000;

EDGE

WebView ie simulation version, specify edge

1
const gui.EDGE = 11001;