Spot

Spot

new Spot()

Main spot object.

Source:

Members

(static) datasets :Array.<Dataset>

Collection of all datasets

Source:
Type:

(static) dataview :Dataview

A union of all active datasets

Source:
Type:

(static) isConnected :boolean

Is there a connection with a spot sever?

Source:
Type:
  • boolean

(static) isLockedDown :boolean

When the app in locked down, facets and datasets cannot be edited

Source:
Type:
  • boolean

(static) sessionType :string

Type of spot session. Must be 'client' or 'server'

Source:
Type:
  • string

Methods

(static) connectToServer()

Connect to the spot-server using a websocket and setup callbacks

Source:
Parameters:
Name Type Description
Optional. address

IP address and port number to connect to. fi. 'http://localhost:3000'

(static) disconnectFromServer()

Disconnect from the spot-server

Source:

(static) getDatasets() → {Promise}

Request a list of available datasets from the server

Depending on the driver, this can be an asyncrhonous function. It returns a Promise that resolves to the dataset collection

Source:
Returns:
Type:
Promise

(static) resetDataview(me)

Reset min, max, and categories for all facets in the dataview

Source:
Parameters:
Name Type Description
me Spot

Main spot instance

(static) toggleDataset(dataset)

Add or remove a dataset from the dataview

Source:
Parameters:
Name Type Description
dataset Dataset

Dataset set add or remove