Class: Layer

Layer(properties)

This class is in charge of defining a Layer object.

Constructor

new Layer(properties)

Parameters:
Name Type Description
properties Object contains a list of properties
Properties
Name Type Description
name string default name
description string default description
dataSourceId string default dataSourceId
visible boolean defines if the layer is visible
timestamp Number defines the timestamp of the data
getTimestamp function function which defines the timestamp of the data
onLeftClick function trigger onLeftClick marker event
onRightClick function trigger onRightClick marker event
onHover function trigger onHover marker event
Source:

Methods

addFn(dataSourceIds, fn, firstopt)

Adds a function associated to a list of dataSource ids
Parameters:
Name Type Attributes Default Description
dataSourceIds Array.<String> the list of datasources
fn function the function to add
first Boolean <optional>
 false set at the first position
Source:

clear()

Clear the layer.
Source:

getDataSourcesIds() → {Array.<String>}

Source:
Returns:
The list of dataSource ids
Type
Array.<String>

getId() → {String}

Gets the layer id.
Source:
Returns:
the layer id
Type
String

getProps() → {Object}

Clone current layer properties
Source:
Returns:
a shallow copy of current properties
Type
Object

init()

Inits the layer.
Source:

reset()

Reset to default Layer values
Source:

select(dataSourceIds)

Selects the datasource contained into the list
Parameters:
Name Type Description
dataSourceIds Array the list of datasources
Source:

(async) setData(dataSourceId, records, options)

Parameters:
Name Type Description
dataSourceId
records Array.<Object>
options
Source: