Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface Dataset

A dataset containing all the data to be displayed.

Hierarchy

  • Dataset

Index

Properties

Optional environments

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

meta: Metadata

metadata for this dataset

properties

properties: {}

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.

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

Type declaration

structures

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 ViewersGrid.loadStructure callback should be set to translate from whatever is stored to a Structure.