DataProxy

The DataProxy class gives access to the tabular and graph data on the current Lucid document.

Data collections are organized into data sources. One data sources is typically produced for
each data import, and may contain multiple collections.


Constructors

new DataProxy()

new DataProxy(client): DataProxy

Parameters

ParameterType
clientEditorClient

Returns

DataProxy


Properties

dataSources

readonly dataSources: MapProxy<string, DataSourceProxy>;

Data sources on the current document, organized by their ID on this document. The ID will
remain stable for as long as the data source exists on this document, but will vary from
the data source ID on other documents if the same data is imported there.


Methods

addDataSource()

addDataSource(name, sourceConfig): DataSourceProxy

Creates a new empty data source, which you can then add collections of data to.

Parameters

ParameterTypeDescription
namestringHuman-readable name of the new data source
sourceConfigobject

Any configuration values that might be useful to reference later, such

as the upstream origin of this data source

Returns

DataSourceProxy

the newly created data source