Interface DataModelParams

Parameters used to define a DataModel.

These parameters are:

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

interface DataModelParams {
    author?: string;
    createdAt?: string;
    creatingApplication?: string;
    id: string;
    objects?: DataObjectParams[];
    projectId?: string | number;
    propertySets?: PropertySetParams[];
    relationships?: RelationshipParams[];
    revisionId?: string | number;
    schema?: string;
}

Hierarchy (View Summary)

Properties

author? createdAt? creatingApplication? id objects? projectId? propertySets? relationships? revisionId? schema?

Properties

Optionalauthor

author?: string

The author of the data model, if available.

OptionalcreatedAt

createdAt?: string

The creation date of the data model, if available.

OptionalcreatingApplication

creatingApplication?: string

The application used to create the data model, if known.

id

id: string

The unique identifier for the data model.

The DataModel is stored in Data.models under this ID.

Optionalobjects

objects?: DataObjectParams[]

Parameters for DataObjects in the DataModel.

This array contains the configuration for the DataObjects to be added to the DataModel.

OptionalprojectId

projectId?: string | number

The project ID associated with the data model, if available.

OptionalpropertySets

propertySets?: PropertySetParams[]

Parameters for PropertySets in the DataModel.

This array contains the configuration for the PropertySets that will be added to the DataModel.

Optionalrelationships

relationships?: RelationshipParams[]

Parameters for Relationships in the DataModel.

This array contains the configuration for the Relationships that will be established between the DataObjects within the DataModel.

OptionalrevisionId

revisionId?: string | number

The revision ID of the data model, if available.

Optionalschema

schema?: string

The data format / schema this DataModel conforms to (e.g. "IFC4", "AP214", "MyApp/v1").

Set once at creation and immutable thereafter (see DataModel.schema). Provide this when you want the DataModel to enforce schema homogeneity — every DataObject, PropertySet, and Relationship added afterwards must either match this value or omit its own schema field (in which case it inherits this one); mismatches are rejected by DataModel.createObject / DataModel.createPropertySet / DataModel.createRelationship.

Leave this undefined (or omit it) when the DataModel is free to hold a mix of schemas. No schema checks are performed in that case, and each component keeps whatever schema value the caller provided.

Settings

Member Visibility

On This Page

Properties