EntityProps Interface

The persistent format of an Entity, also used as the "wire format" when transmitting information about entities between the backend and frontend. EntityProps and all of its sub-types like ElementProps are "plain old Javascript objects" - that is, objects containing no methods and no properties of class type.

Properties

Name Type Description
classFullName string The full name of the ECClass for this entity, in the form "Schema:ClassName"  
id undefined | string The Id of the entity.  
isInstanceOfEntity Readonly undefined | undefined A non-existent property used to discriminate between EntityProps and Entity.  
jsonProperties undefined | { T } Optional json properties of this Entity.  

Defined in

Last Updated: 28 March, 2024