Namespace: index

index

Source:

Methods

(static) run(viewportElement, data, options)

Initiates voxlens. Connector between specific viz libraries and voxlens

Parameters:
Name Type Description
viewportElement Object

Element that contains the viz.
data Array.<Object>

The raw json data used to create the viz.
options Object

The original options supplied to voxlens before defaults are applied.
Source:

(static) startApp(data, options, hotKeysId)

Initial voxlens start function that adds listeners for voice commands.

Parameters:
Name Type Description
data Object

The data from the viz.

Properties
Name Type Description
x Array.<string>

Values of the independent variable.
y Array.<string>

Values of the dependent variable.
options Object

The options supplied to voxlens when creating the viz.

Properties
Name Type Description
xLabel string

Label for the x-axis.
yLabel number

Label for the y-axis.
hotKeysId string

ID needed to identify a hotkey bind for the hotkeys library.
Source:

(static) voxlens(library, container, vizData, options)

Main export for the voxlens library to identify the viz library and start app

Parameters:
Name Type Description
library string

Viz library that includes voxlens.
container Object

Element that contains the viz.
vizData Object

The raw json data used to create the viz.
options Object

The original options supplied to voxlens before defaults are applied.
Source: