Class Data

Represents the root container for semantic data, including models, objects, relationships and property sets.

A Data serves as the authoritative registry and lifecycle manager of:

It provides:

  • A central event hub via DataEvents
  • Lifecycle management (creation, destruction, registration)
  • Error reporting with optional console logging

See @xeokit/sdk/data for general usage examples.

Constructors

constructor

Properties

destroyed events logging models objects objectsByType propertySets rootObjects typeCounts

Methods

clear createModel destroy getObjectIdsByType

Constructors

constructor

  • new Data(dataParams?: { logging?: boolean }): Data

    Creates a new Data.

    See @xeokit/sdk/data for usage.

    Parameters

    • OptionaldataParams: { logging?: boolean }

      Parameters for creating this Data.

      • Optionallogging?: boolean

        Indicates whether to log errors to the console for this Data.

    Returns Data

Properties

destroyed

destroyed: boolean = false

Indicates whether this Data instance has been destroyed.

Readonlyevents

events: DataEvents

Events emitted by this Data instance.

logging

logging: boolean = false

Indicates whether to log errors to the console for this Data.

Default value is false.

Readonlymodels

models: { [key: string]: DataModel }

A collection of DataModels in this Data, keyed by their ID.

Readonlyobjects

objects: { [key: string]: DataObject }

A collection of DataObjects in this Data, keyed by their ID.

ReadonlyobjectsByType

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

A collection of DataObjects grouped by their type. Each type maps to a collection of objects keyed by their ID.

ReadonlypropertySets

propertySets: { [key: string]: PropertySet }

A collection of PropertySets in this Data, keyed by their ID.

ReadonlyrootObjects

rootObjects: { [key: string]: DataObject }

A collection of root DataObjects in this Data, keyed by their ID.

Root objects are those that are not the "related" participant in any Relationships.

ReadonlytypeCounts

typeCounts: { [key: string]: number }

Tracks the count of DataObjects for each type in this Data.

Methods

clear

createModel

destroy

getObjectIdsByType

  • getObjectIdsByType(type: string): SDKResult<string[]>

    Retrieves the IDs of DataObjects that have the specified type.

    Parameters

    • type: string

      The type of the objects to retrieve.

    Returns SDKResult<string[]>

    A result containing an array of object IDs on success, or an error message on failure.

Settings

Member Visibility

On This Page

Constructors
Properties
Methods