Module: src/util/api

src/util/api

Main visualizer API

Source:

Methods

<static> createData(name, data, filter)

Create new data and set a variable to it

Parameters:
Name Type Argument Description
name string

Name of the variable

data *

Data to set

filter string <optional>

Url of the filter to use with this variable

Source:

<static> doAction(name, value)

Send an action to all modules that are listening to it

Parameters:
Name Type Argument Description
name string

Action name

value * <optional>

Action value

Source:

<static> executeAction(name, value)

Execute a global visualizer action

Parameters:
Name Type Description
name string

Action name

value *

Action value

Source:

<static> existVariable(varName) → {boolean}

Check if a variable is defined

Parameters:
Name Type Description
varName string

Name of the variable

Source:
Returns:
Type
boolean

<static> getVariable(name) → {Variable}

Get a variable by name

Parameters:
Name Type Description
name string

Name of the variable

Source:
Returns:
Type
Variable

<static> loading(id, message)

Set a loading message or change the value of an existing message

Parameters:
Name Type Argument Description
id string

ID of the message

message string <optional>

Message content (default: value of the ID)

Source:

<static> setHighlight(element, onOff)

Change the state of a highlight

Parameters:
Name Type Description
element object | array

Object with a _highlight property or array of highlight IDs

onOff boolean
Source:

<static> setVariable(name, sourceVariable, jpath, filter)

Set a variable using a jpath

Parameters:
Name Type Argument Description
name string

Name of the variable

sourceVariable Variable <optional>

Source variable. If set, the new variable will be created relative to its jpath

jpath string[]
filter string <optional>

Url of the filter to use with this variable

Source:

<static> stopLoading(id)

Remove a loading message

Parameters:
Name Type Description
id string

ID of the message

Source:
DocStrap Copyright © 2012-2014 The contributors to the JSDoc3 and DocStrap projects.
Documentation generated by JSDoc 3.2.2 on Mon Nov 10th 2014 using the DocStrap template.