Interface Dataset

A dataset containing all the data to be displayed.

Hierarchy

  • Dataset

Properties

environments?: Environment[]

List of atom-centered environments in the dataset.

Currently, the code assumes that every atom is associated with an environment. This may change in the future.

meta: Metadata

metadata for this dataset

properties: {
    [name: string]: Property;
}

List of properties for the structures (target == "structure"), or atom-centered environments in the structures (target == "atom").

For structure properties, the values array of the property should have the same size as the structure list in Dataset.structures.

For atomic properties, the values array of the property should have the same size as the environments list in Dataset.environments.

Type declaration

settings?: Partial<Settings>

Settings for visualization of this dataset

structures: Structure[] | UserStructure[]

List of structures in the dataset.

The structures can either follow the Structure interface, in which case they will be loaded as-defined; or contain any kind of data as a UserStructure, in which case the loadStructure callback should be set to translate from whatever is stored to a Structure.