Class DataObject

Represents an object within a DataModel.

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

Properties

data description? id models name? originalSystemId? propertySets? related relating type

Properties

data

data: Data

The Data instance that contains this DataObject.

Optional Readonlydescription

description?: string

A human-readable description of this DataObject.

Readonlyid

id: string

A globally unique identifier for this DataObject.

This ID is used to store the DataObject in Data.objects, Data.rootObjects, Data.objectsByType, and DataModel.rootObjects.

models

models: DataModel[]

The DataModels that share this DataObject.

Optional Readonlyname

name?: string

A human-readable name for this DataObject.

OptionaloriginalSystemId

originalSystemId?: string

The ID of this DataObject in the originating system, if available.

Defaults to the value of DataObject.id if not provided.

Optional ReadonlypropertySets

propertySets?: PropertySet[]

A list of PropertySets referenced by this DataObject.

Readonlyrelated

related: { [key: number]: Relationship[] }

A map of Relationships in which this DataObject is the relatedObject.

Relationships are categorized by Relationship.type and further indexed by relatedObject.

Readonlyrelating

relating: { [key: number]: Relationship[] }

A map of Relationships in which this DataObject is the relatingObject.

Relationships are categorized by Relationship.type and further indexed by relatingObject.

Readonlytype

type: number

The type of this DataObject.

Settings

Member Visibility

On This Page

Properties