Interface PropertySetParams

Parameters used to define a PropertySet.

These parameters are:

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

interface PropertySetParams {
    id: string;
    name: string;
    properties: PropertyParams[];
    schema?: string;
    type: string;
}

Properties

id name properties schema? type

Properties

id

id: string

The unique identifier for the PropertySet.

PropertySets are stored by this ID in Data.propertySets and DataModel.propertySets.

name

name: string

The human-readable name of the PropertySet.

properties

properties: PropertyParams[]

The collection of Properties within the PropertySet.

Optionalschema

schema?: string

The schema this PropertySet conforms to. Optional.

  • If the owning DataModel's schema is defined (enforced mode), this value must match it or be omitted. DataModel.createPropertySet rejects a mismatching value, and a PropertySet that already exists in another DataModel can only be shared if its schema matches this DataModel's schema.

  • If the owning DataModel's schema is undefined (free mode), no check is performed and this value is stored as-is. Reused PropertySets from other DataModels are accepted regardless of their schema.

type

type: string

The type of this PropertySet.

Settings

Member Visibility

On This Page

Properties