Interface DataObjectParams

Parameters for creating a DataObject.

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

interface DataObjectParams {
    description?: string;
    id: string;
    name: string;
    originalSystemId?: string;
    propertySetIds?: string[];
    schema?: string;
    type: string;
}

Properties

description? id name originalSystemId? propertySetIds? schema? type

Properties

Optionaldescription

description?: string

A human-readable description of the DataObject.

id

id: string

A globally unique ID for the DataObject.

DataObjects are stored by ID in several collections, including Data.objects, Data.rootObjects, Data.objectsByType, DataModel.objects, and DataModel.rootObjects.

For further details, see @xeokit/sdk/model/scene.

name

name: string

A human-readable name for the 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.

OptionalpropertySetIds

propertySetIds?: string[]

A list of IDs for associated PropertySets, if applicable.

Optionalschema

schema?: string

The schema this DataObject conforms to. Optional.

  • If the owning DataModel's schema is defined (enforced mode), this value must match it or be omitted. DataModel.createObject rejects a mismatching value, and the DataObject inherits the DataModel's schema if left out.

  • If the owning DataModel's schema is undefined (free mode), no check is performed and this value is stored as-is — the DataObject may carry any schema or none.

type

type: string

The type of the DataObject.

Settings

Member Visibility

On This Page

Properties