Class DataModel

Contains a model's semantic data, as an entity-relationship graph.

This data model is:

Created using Data.createModel.
Stored in Data.models.
Composed of DataObjects, Relationships, PropertySets, and Properties.
Capable of importing and exporting various file formats.
Supports traversal and search of the data structure.
Can be built programmatically.

For detailed usage, refer to @xeokit/sdk/data.

Properties

`Optional`author

author?: string

The model author, if available.

`Optional`createdAt

createdAt?: string

The date the model was created, if available.

`Optional`creatingApplication

creatingApplication?: string

The application that created the model, if available.

`Readonly`data

data: Data

The Data that contains this DataModel.

destroyed

destroyed: boolean

Indicates whether this DataModel has been destroyed.

`Readonly`id

id: string

Unique ID of this DataModel.

DataModels are stored against this ID in Data.models.

`Optional`name

name?: string

The model name, if available.

objects

objects: { [key: string]: DataObject }

The DataObjects in this DataModel, mapped to DataObject.id.

DataObjects have globally-unique IDs and will also be stored in Data.objects.

objectsByType

objectsByType: { [key: string]: { [key: string]: DataObject } }

The DataObjects in this DataModel, mapped to DataObject.type, sub-mapped to DataObject.id.

`Optional`projectId

projectId?: string | number

The project ID, if available.

`Readonly`propertySets

propertySets: { [key: string]: PropertySet }

ThePropertySets in this DataModel, mapped to PropertySet.id.

PropertySets have globally-unique IDs and will also be stored in Data.propertySets.

relationships

relationships: Relationship[]

The Relationships in this DataModel.

The Relationships can be between DataObjects in different DataModels, but always within the same Data.

`Optional`revisionId

revisionId?: string | number

The revision ID, if available.

rootObjects

rootObjects: { [key: string]: DataObject }

The root DataObjects in this DataModel, mapped to DataObject.id.

This is the set of DataObjects in this DataModel that are not the related participant in any Relationships, where they have no incoming Relationships and their DataObject.relating property is empty.

`Readonly`stats

stats: DataModelStats

Statistics on this DataModel.

`Readonly`typeCounts

typeCounts: { [key: string]: number }

The count of each type of DataObject in this DataModel, mapped to DataObject.type.

Methods

createObject

createObject(dataObjectParams: DataObjectParams): SDKResult<DataObject>
Creates a new DataObject and registers it within the DataModel and Data.
- The new 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.
- A DataObject ID must be unique within a single DataModel but can be shared between multiple DataModels.
- Triggers an event via DataEvents.onObjectCreated.
See @xeokit/sdk/data for usage.
Parameters
- dataObjectParams: DataObjectParams
  Configuration parameters for the new DataObject.
Returns SDKResult<DataObject>
A result containing the created DataObject on success, or an error message on failure.
- Defined in packages/sdk/src/data/DataModel.ts:227

createPropertySet

createPropertySet(propertySetCfg: PropertySetParams): SDKResult<PropertySet>
Creates a new PropertySet and registers it within the DataModel and Data.
- The new 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.
- A PropertySet ID must be unique within a single DataModel but can be shared between multiple DataModels.
- Triggers an event via DataEvents.onPropertySetCreated.
See @xeokit/sdk/data for usage.
Parameters
- propertySetCfg: PropertySetParams
  Configuration parameters for the new PropertySet.
Returns SDKResult<PropertySet>
A result containing the created PropertySet on success, or an error message on failure.
- Defined in packages/sdk/src/data/DataModel.ts:177

createRelationship

createRelationship(
relationshipParams: RelationshipParams,
): SDKResult<Relationship>
Creates a new Relationship between two existing DataObjects.
- The new Relationship is stored in DataModel.relationships.
- Triggers an event via DataEvents.onRelationshipCreated.
See @xeokit/sdk/data for usage
Parameters
- relationshipParams: RelationshipParams
  Configuration parameters for the new Relationship.
Returns SDKResult<Relationship>
A result containing the created Relationship on success, or an error message on failure.
- Defined in packages/sdk/src/data/DataModel.ts:307

destroy

destroy(): SDKResult<void>
Destroys this DataModel and all its components.

Fires the DataEvents.onObjectDestroyed event.

Returns SDKResult<void>
A result indicating success or an error message on failure.
- Defined in packages/sdk/src/data/DataModel.ts:498

fromParams

fromParams(dataModelParams: DataModelContentParams): SDKResult<any>
Adds components from the specified DataModelContentParams to the DataModel.
Parameters
- dataModelParams: DataModelContentParams
  Parameters to configure and populate the DataModel.
Returns SDKResult<any>
A result indicating success or an error message on failure.
- Defined in packages/sdk/src/data/DataModel.ts:362

toParams

toParams(): SDKResult<DataModelParams>
Converts this DataModel to a DataModelParams object.

Returns SDKResult<DataModelParams>
A result containing the DataModelParams on success, or an error message on failure.
- Defined in packages/sdk/src/data/DataModel.ts:417

Class DataModel

Index

Properties

Methods

Properties

`Optional`author

`Optional`createdAt

`Optional`creatingApplication

`Readonly`data

destroyed

`Readonly`id

`Optional`name

objects

objectsByType

`Optional`projectId

`Readonly`propertySets

relationships

`Optional`revisionId

rootObjects

`Readonly`stats

`Readonly`typeCounts

Methods

createObject

Parameters

Returns SDKResult<DataObject>

createPropertySet

Parameters

Returns SDKResult<PropertySet>

createRelationship

Parameters

Returns SDKResult<Relationship>

destroy

Returns SDKResult<void>

fromParams

Parameters

Returns SDKResult<any>

toParams

Returns SDKResult<DataModelParams>

Settings

On This Page

Class DataModel

Index

Properties

Methods

Properties

Optionalauthor

OptionalcreatedAt

OptionalcreatingApplication

Readonlydata

destroyed

Readonlyid

Optionalname

objects

objectsByType

OptionalprojectId

ReadonlypropertySets

relationships

OptionalrevisionId

rootObjects

Readonlystats

ReadonlytypeCounts

Methods

createObject

Parameters

Returns SDKResult<DataObject>

createPropertySet

Parameters

Returns SDKResult<PropertySet>

createRelationship

Parameters

Returns SDKResult<Relationship>

destroy

Returns SDKResult<void>

fromParams

Parameters

Returns SDKResult<any>

toParams

Returns SDKResult<DataModelParams>

Settings

On This Page

`Optional`author

`Optional`createdAt

`Optional`creatingApplication

`Readonly`data

`Readonly`id

`Optional`name

`Optional`projectId

`Readonly`propertySets

`Optional`revisionId

`Readonly`stats

`Readonly`typeCounts