Class: SpectrogramView

SpectrogramView(propertiesopt)

new SpectrogramView(propertiesopt)

Parameters:
Name Type Attributes Default Description
properties Object <optional>
 {} the properties of the view * @param {String} properties.isSim - Enable simulation mode
Source:

Extends

Methods

addLayer(layer)

Adds a layer to the view. A broadcastChannel is going to listen the new dataSources
Parameters:
Name Type Description
layer Layer The layer object
Overrides:
Source:

attachTo(divId)

Attach the view to a specific div. If the view has already been attached to a div, it will be removed from its current parent and will be attached to new one. Note: the onResize() is called at the end of the process.
Parameters:
Name Type Description
divId String The div element to attach to
Overrides:
Source:

createDataEntries()

Source:

draw()

Draws the spectrogram
Source:

getDataSourcesId() → {Array.<String>}

Gets the list of the dataSource ids contained into the view.
Overrides:
Source:
Returns:
The list of dataSource ids
Type
Array.<String>

getDivId() → {String}

Gets the div id of the DOM element.
Overrides:
Source:
Returns:
The div id of the view
Type
String

getId() → {String}

Gets the inner id of the view object.
Overrides:
Source:
Returns:
The id of the view
Type
String

hide()

Hide the view
Overrides:
Source:

removeAllFromLayer(layer)

Removes a Layer from the view.
Parameters:
Name Type Description
layer Layer The layer object
Overrides:
Source:

removeAllFromLayers()

Removes all view item from the view.
Overrides:
Source:

reset()

Calls for resetting the view.
Overrides:
Source:

setData(dataSourceId, data)

Set the data to the view. Each view has to handle the kind of the data separately.
Parameters:
Name Type Description
dataSourceId String The dataSource id of the source providing the data
data Array.<any> The data array to set
Overrides:
Source:

show(properties)

Show the view.
Parameters:
Name Type Description
properties Object A generic object
Overrides:
Source:

updateSpectrogram(props)

Updates the spectrogram data and redraw.
Parameters:
Name Type Description
props Spectogram.props The layer properties allowing the update of the spectrogram
Source:

Events

beforeAddingItems

This method is called before attaching any view items passed as arguments in the constructor of the view.
Parameters:
Name Type Description
options Object A generic object to use
Overrides:
Source:

onResize

Callback called when the view is resized
Overrides:
Source: