<!-- Generated by documentation.js. Update this documentation by updating the source code. -->

## DataSources

This module manages data sources within the editor.
You can initialize the module with the editor by passing an instance of `EditorModel`.

```js
const editor = new EditorModel();
const dsm = new DataSourceManager(editor);
```

Once the editor is instantiated, you can use the following API to manage data sources:

```js
const dsm = editor.DataSources;
```

*   [add][1] - Add a new data source.
*   [get][2] - Retrieve a data source by its ID.
*   [getAll][3] - Retrieve all data sources.
*   [remove][4] - Remove a data source by its ID.
*   [clear][5] - Remove all data sources.

Example of adding a data source:

```js
const ds = dsm.add({
  id: 'my_data_source_id',
  records: [
    { id: 'id1', name: 'value1' },
    { id: 'id2', name: 'value2' }
  ]
});
```

### Parameters

*   `em` **EditorModel** Editor model.

## add

Add new data source.

### Parameters

*   `props` **[Object][6]** Data source properties.
*   `opts` **AddOptions**  (optional, default `{}`)

### Examples

```javascript
const ds = dsm.add({
 id: 'my_data_source_id',
 records: [
   { id: 'id1', name: 'value1' },
   { id: 'id2', name: 'value2' }
 ]
});
```

Returns **[DataSource]** Added data source.

## get

Get data source.

### Parameters

*   `id` **[String][7]** Data source id.

### Examples

```javascript
const ds = dsm.get('my_data_source_id');
```

Returns **[DataSource]** Data source.

## getValue

Get value from data sources by key

### Parameters

*   `key` **[String][7]** Path to value.
*   `defValue` **any**&#x20;

Returns **any** const value = dsm.getValue('ds\_id.record\_id.propName', 'defaultValue');

## getContext

Retrieve the entire context of data sources.
This method aggregates all data records from all data sources and applies any
`onRecordRead` transformers defined within each data source. The result is an
object representing the current state of all data sources, where each data source
ID maps to an object containing its records' attributes. Each record is keyed by
both its index and its ID.

### Examples

```javascript
const context = dsm.getContext();
// e.g., { dataSourceId: { 0: { id: 'record1', name: 'value1' }, record1: { id: 'record1', name: 'value1' } } }
```

Returns **ObjectAny** The context of all data sources, with transformed records.

## remove

Remove data source.

### Parameters

*   `id` **([String][7] | [DataSource])** Id of the data source.
*   `opts` **RemoveOptions?**&#x20;

### Examples

```javascript
const removed = dsm.remove('DS_ID');
```

Returns **[DataSource]** Removed data source.

## fromPath

Retrieve a data source, data record, and optional property path based on a string path.
This method parses a string path to identify and retrieve the corresponding data source
and data record. If a property path is included in the input, it will also be returned.
The method is useful for accessing nested data within data sources.

### Parameters

*   `path` **[String][7]** The string path in the format 'dataSourceId.recordId.property'.

### Examples

```javascript
const [dataSource, dataRecord, propPath] = dsm.fromPath('my_data_source_id.record_id.myProp');
// e.g., [DataSource, DataRecord, 'myProp']
```

Returns **[DataSource?, DataRecord?, [String][7]?]** An array containing the data source,
data record, and optional property path.

[1]: #add

[2]: #get

[3]: #getall

[4]: #remove

[5]: #clear

[6]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object

[7]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String