OptionalauthorThe model author, if available.
OptionalcreatedThe date the model was created, if available.
OptionalcreatingThe application that created the model, if available.
ReadonlydataThe Data that contains this DataModel.
Indicates whether this DataModel has been destroyed.
ReadonlyidUnique ID of this DataModel.
DataModels are stored against this ID in Data.models.
OptionalnameThe model name, if available.
The DataObjects in this DataModel, mapped to DataObject.id.
DataObjects have globally-unique IDs and will also be stored in Data.objects.
The DataObjects in this DataModel, mapped to DataObject.type, sub-mapped to DataObject.id.
OptionalprojectThe project ID, if available.
ReadonlypropertyThePropertySets in this DataModel, mapped to PropertySet.id.
PropertySets have globally-unique IDs and will also be stored in Data.propertySets.
The Relationships in this DataModel.
OptionalrevisionThe revision ID, if available.
The root DataObjects in this DataModel, mapped to DataObject.id.
Optional ReadonlyschemaThe data format / schema this DataModel conforms to (e.g.
"IFC4", "AP214", "MyApp/v1").
Set once at construction time via DataModelParams.schema and immutable thereafter. Whether schema homogeneity is enforced depends on this value:
Defined — the DataModel runs in enforced mode. Every
DataObject, PropertySet, and Relationship
added must either match this value or omit its own schema field
(in which case it inherits this one).
DataModel.createObject, DataModel.createPropertySet
and DataModel.createRelationship reject components with a
mismatching schema, including reused components that already belong
to another DataModel with a different schema, and reject
relationships whose endpoints carry a different schema.
Undefined — the DataModel runs in free mode. No schema
checks are performed; components may carry any (or no) schema tag,
freely mix, and freely interrelate. The caller's per-component
schema value is preserved as-is.
Set the schema when you care about homogeneity (e.g. a strict IFC4 model). Leave it undefined when you want a heterogeneous bag of components — for example, federated data assembled from several sources before classification.
ReadonlystatsStatistics on this DataModel.
ReadonlytypeThe count of each type of DataObject in this DataModel, mapped to DataObject.type.
Creates a new DataObject and registers it within the DataModel and Data.
DataObject is stored in DataModel.objects and
Data.objects.DataObject IDs are globally unique. If a DataObject with the given ID already exists in the same Data,
it will be reused and shared across DataModels instead of creating a duplicate.DataObject ID must be unique within a single DataModel but can be shared between multiple DataModels.See @xeokit/sdk/model/data for usage.
Configuration parameters for the new DataObject.
A result containing the created DataObject on success, or an error message on failure.
Creates a new PropertySet and registers it within the DataModel and Data.
PropertySet is stored in DataModel.propertySets and
Data.propertySets.PropertySet IDs are globally unique. If a PropertySet with the given ID already exists in the same Data,
it will be reused and shared across DataModels instead of creating a duplicate.PropertySet ID must be unique within a single DataModel but can be shared between multiple DataModels.See @xeokit/sdk/model/data for usage.
Configuration parameters for the new PropertySet.
A result containing the created PropertySet on success, or an error message on failure.
Creates a new Relationship between two existing DataObjects.
Relationship is stored in DataModel.relationships.See @xeokit/sdk/model/data for usage
Configuration parameters for the new Relationship.
A result containing the created Relationship on success, or an error message on failure.
Destroys this DataModel and all its components.
Fires the DataEvents.onObjectDestroyed event.
A result indicating success or an error message on failure.
Adds components from the specified DataModelContentParams to the DataModel.
Parameters to configure and populate the DataModel.
A result indicating success or an error message on failure.
Converts this DataModel to a DataModelParams object.
A result containing the DataModelParams on success, or an error message on failure.
Contains a model's semantic data, as an entity-relationship graph.
This data model is:
For detailed usage, refer to @xeokit/sdk/model/data.