公共属性及方法

当前 vConsole 的版本号。

  • 只读
  • 类型：string

例子：

vConsole.option

配置项。

  • 可写
  • 类型：object

例子：

  1. // get
  2. vConsole.option // => {...}
  3. // set
  4. vConsole.setOption('maxLogNumber', 5000);
  5. // 或者：
  6. vConsole.setOption({maxLogNumber: 5000});

vConsole.activedTab

当前激活的 tab 的 plugin id。

  • 只读
  • 类型：string
  • 默认值：”default”

例子：

  1. vConsole.activedTab // => "system"

vConsole.tabList

  • 只读
  • 类型：array(string)

例子：

    vConsole 的 HTML element。

    • 类型：HTMLDivElement

    方法

    vConsole.setOption(keyOrObj[, value])

    更新 配置项。

    参数：
    • (required) keyOrObj: 配置项的 key 值，或直接传入 key-value 格式的 object 对象。
    • (optional) value: 配置项的 value 值。
    返回：
    • 无
    例子：

    vConsole.destroy()

    析构一个 vConsole 对象实例，并将 vConsole 面板从页面中移除。

    参数：
    • 无
    返回：
    • 无
    例子：
    1. var vConsole = new VConsole();
    2. // ... do something
    3. vConsole.destroy();

    vConsole.addPlugin(plugin)

    添加一个新插件。重名的插件会被忽略。

    参数：
    • (required) plugin: 一个 VConsolePlugin 对象。
    返回：
    • Boolean: 成功为 true，失败为 false。
    例子：
    1. var myPlugin = new VConsolePlugin('my_plugin', 'My Plugin');
    2. vConsole.addPlugin(myPlugin);

    卸载一个插件。

    参数：
    • (required) pluginID: 插件的 plugin id。
    返回：
    • Boolean: 成功为 true，失败为 。
    例子：
    1. vConsole.removePlugin('my_plugin');

    vConsole.showTab(pluginID)

    此方法会触发先前激活态 tab 的 hide 事件，并触发当前激活态 tab 的 show 事件。

    参数：
    • (required) pluginID: 字符串，tab 的 plugin id。
    返回：
    • 无
    例子：

    vConsole.show()

    显示 vConsole 主面板。这个方法会触发插件事件 showConsole。

    参数：
    • 无
    返回：
    • 无
    例子：
    1. vConsole.show();

    vConsole.hide()

    隐藏 vConsole 主面板。这个方法会触发插件事件 hideConsole。

    参数：
    • 无
    返回：
    • 无
    例子：
    1. vConsole.hide();

    显示 vConsole 的开关按钮。

    参数：
    • 无
    返回：
    • 无
    例子：
    1. vConsole.showSwitch();

    vConsole.hideSwitch()

    隐藏 vConsole 的开关按钮

    隐藏后，用户将无法手动唤起 vConsole 面板。因此按钮或面板必须通过 或 vConsole.show() 来展示出来。

    参数：
    • 无
    返回：
    • 无
    例子：