Class PropertySet

Represents a set of Properties within a DataModel.

This set is:

Created using DataModel.createPropertySet.
Stored in Data.propertySets and DataModel.propertySets.

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

Index

Constructors

Properties

id models name originalSystemId? properties type

Constructors

constructor

new PropertySet(
dataModel: DataModel,
propertySetCfg: PropertySetParams,
): PropertySet
Constructs a new PropertySet.
Parameters
- dataModel: DataModel
  The DataModel to which this PropertySet belongs.
- propertySetCfg: PropertySetParams
  Configuration parameters to initialize the PropertySet.
Returns PropertySet
- Defined in packages/sdk/src/data/PropertySet.ts:55

Properties

`Readonly`id

id: string

The unique identifier for this PropertySet.

PropertySet instances are registered by this ID in Data.propertySets and DataModel.propertySets.

`Readonly`models

models: DataModel[]

The DataModels that this PropertySet belongs to.

`Readonly`name

name: string

The human-readable name of this PropertySet.

`Optional` `Readonly`originalSystemId

originalSystemId?: string

The ID of the corresponding object in the originating system, if applicable.

`Readonly`properties

properties: Property[]

The collection of Properties within this PropertySet.

`Readonly`type

type: string

The type of this PropertySet.