Schema
Classes for working with ECSchemas
Classes
| Name | Description | |
|---|---|---|
| BisCoreSchema | The BisCore schema is the lowest level Schema in an iModel. | |
| ClassRegistry | Maintains the mapping between the name of a BIS ECClass (in "schema:class" format) and the JavaScript Entity class that implements it. | |
| ECSchemaXmlContext | Context used when deserializing a Schema from an XML file. | |
| Entity | Represents one of the fundamental building block in an IModelDb: as an Element, Model, or Relationship. | |
| EntityJsClassMap | Maintains the mapping between the name of a BIS ECClass (in "schema:class" format) and the JavaScript Entity class that implements it. | |
| FunctionalSchema | ||
| GenericSchema | ||
| Schema | Base class for all schema classes - see working with schemas and elements in TypeScript. | |
| SchemaMap | Holds a map of registered schemas. | |
| Schemas | Manages registered schemas |
Global Functions
| Name | Description | |
|---|---|---|
| convertEC2SchemasToEC3Schemas | Converts EC2 Xml ECSchema(s). | |
| upgradeCustomAttributesToEC3 | Converts schema metadata to EC3 concepts by traversing custom attributes of the supplied schema and calling converters based on schemaName:customAttributeName |
Interfaces
| Name | Description | |
|---|---|---|
| CustomHandledProperty | A property of an Entity that needs to be custom handled during deserialization and serialization. | |
| DeserializeEntityArgs | Set of properties that are used to deserialize an EntityProps from an ECSqlRow. | |
| ECSqlRow | Represents a row returned by an ECSql query. |
Type Aliases
| Name | Description | |
|---|---|---|
| EntityClassType | Parameter type that can accept both abstract constructor types and non-abstract constructor types for instanceof to test. |
|
| PropertyHandler | A callback function to process properties of an Entity |
Last Updated: 11 June, 2025
Found something wrong, missing, or unclear on this page? Raise an issue in our repo.