Extends
Methods
addFn(dataSourceIds, fn)
Adds a function associated to a list of dataSource ids
Parameters:
| Name | Type | Description |
|---|---|---|
dataSourceIds |
Array.<String> | the list of datasources |
fn |
function | the function to add |
- Overrides:
- Source:
clear()
Clear the layer.
- Overrides:
- Source:
(async) connect()
Connect the dataSource then the protocol will be opened as well.
- Inherited From:
- Source:
disconnect()
Disconnect the dataSource then the protocol will be closed as well.
- Inherited From:
- Source:
getDataSourcesIds() → {Array.<String>}
- Overrides:
- Source:
Returns:
The list of dataSource ids
- Type
- Array.<String>
getId() → {String}
Gets the datasource id.
- Overrides:
- Source:
Returns:
the datasource id
- Type
- String
getName() → {String}
Gets the datasource name.
- Inherited From:
- Source:
Returns:
the datasource name
- Type
- String
getProps() → {Object}
Clone current layer properties
- Overrides:
- Source:
Returns:
a shallow copy of current properties
- Type
- Object
init()
Inits the layer.
- Overrides:
- Source:
(protected) initDataSource(properties)
Inits the datasource with the constructor properties.
Parameters:
| Name | Type | Description |
|---|---|---|
properties |
- Inherited From:
- Source:
onDisconnect()
Trigger when the datasource is disconnected for some reason.
- Inherited From:
- Source:
parseData(data) → {Object}
Extracts data from the message.
Parameters:
| Name | Type | Description |
|---|---|---|
data |
Object | the data to parse |
- Source:
Returns:
the parsed data
- Type
- Object
parseTimeStamp(data) → {number}
Extracts timestamp from the message. The timestamp is the first token got from split(',')
Parameters:
| Name | Type | Description |
|---|---|---|
data |
String | the data to parse |
- Source:
Returns:
the extracted timestamp
- Type
- number
reset()
Reset to default Layer values
- Overrides:
- Source:
select(dataSourceIds)
Selects the datasource contained into the list
Parameters:
| Name | Type | Description |
|---|---|---|
dataSourceIds |
Array | the list of datasources |
- Overrides:
- Source:
setData(dataSourceId, records, options)
Parameters:
| Name | Type | Description |
|---|---|---|
dataSourceId |
||
records |
Array.<Object> | |
options |
- Overrides:
- Source:
updateProperties(name, properties)
Update properties
Parameters:
| Name | Type | Description | |||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
name |
String | the datasource name | |||||||||||||||||||||||||||||||||
properties |
Object | the datasource properties
Properties
|
- Inherited From:
- Source: