Public Properties & Methods

The current version of vConsole.

Readonly
Type: string

Example:

vConsole.option

A configuration object.

Writable
Type: object

Example:

// get
vConsole.option // => {...}
// set
vConsole.setOption('maxLogNumber', 5000);
// or:
vConsole.setOption({maxLogNumber: 5000});

vConsole.activedTab

The actived tab’s plugin id.

Readonly
Type: string
Default: “default”

Example:

vConsole.activedTab // => "system"

vConsole.tabList

Readonly
Type: array(string)

Example:

vConsole’s HTML element.

Type: HTMLDivElement

Methods

vConsole.setOption(keyOrObj[, value])

Update .

Parameters:

(required) keyOrObj: The key of option, or a key-value object.
(optional) value: The value of an option.

Return:

None

Example:

vConsole.destroy()

Destroy an vConsole instance object and remove vConsole panel from document.

Parameters:

None

Return:

None

Example:

var vConsole = new VConsole();
// ... do something
vConsole.destroy();

vConsole.addPlugin(plugin)

Add a new plugin to vConsole. Duplicate plugin will be ignored.

Parameters:

(required) plugin: An VConsolePlugin object.

Return:

Boolean: true for success, false for failure.

Example:

var myPlugin = new VConsolePlugin('my_plugin', 'My Plugin');
vConsole.addPlugin(myPlugin);

Remove an existing plugin.

Parameters:

(required) pluginID: A string, plugin’s id.

Return:

Boolean: true for success, for failure.

Example:

vConsole.removePlugin('my_plugin');

vConsole.showTab(pluginID)

Plugin event hide will be triggered for previous actived tab, and show for current actived tab.

Parameters:

(required) pluginID: A string, tab’s plugin id.

Return:

None

Example:

vConsole.show()

Show vConsole panel. This method will trigger plugin event showConsole.

Parameters:

None

Return:

None

Example:

vConsole.show();

vConsole.hide()

Hide vConsole panel. This method will trigger plugin event hideConsole.

Parameters:

None

Return:

None

Example:

vConsole.hide();

Show vConsole switch button.

Parameters:

None

Return:

None

Example:

vConsole.showSwitch();

vConsole.hideSwitch()

Hide vConsole switch button.

After the button is hidden, the user will not be able to call vConsole manually. The button or panel must be shown programmably via or vConsole.show().