API Reference > ecschema-Metadata > Metadata

Metadata

Definitions of classes and interfaces that represent all EC elements.

Classes

Name Description  
ArrayProperty Beta
Constant A Constant is a specific type of Unit that represents a number. Beta
CustomAttributeClass A Typescript class representation of an ECCustomAttributeClass. Beta
ECClass A common abstract class for all of the ECClass types. Beta
ECName The name of an item in a Schema, encoded to meet restrictions on the characters usable in such names.  
ECVersion Beta
EntityClass A Typescript class representation of an ECEntityClass. Beta
Enumeration A Typescript class representation of an ECEnumeration. Beta
EnumerationArrayProperty Beta
EnumerationProperty Beta
Format Beta
InvertedUnit An InvertedUnit is a specific type of Unit that describes the inverse of a single Unit whose dimensional derivation is unit-less. Beta
KindOfQuantity A Typescript class representation of a KindOfQuantity. Beta
Mixin A Typescript class representation of a Mixin. Beta
NavigationProperty Beta
OverrideFormat Overrides of a Format, from a Schema, and is SchemaItem that is used specifically on KindOfQuantity. Beta
Phenomenon Beta
PrimitiveArrayProperty Beta
PrimitiveOrEnumPropertyBase Beta
PrimitiveProperty Beta
Property A common abstract class for all ECProperty types. Beta
PropertyCategory Beta
RelationshipClass A Typescript class representation of a ECRelationshipClass. Beta
RelationshipConstraint A Typescript class representation of a ECRelationshipConstraint. Beta
RelationshipMultiplicity Beta
Schema Beta
SchemaItem An abstract class that supplies all of the common parts of a SchemaItem. Beta
SchemaItemKey The SchemaItemKey contains a SchemaItem's name and SchemaKey. Beta
SchemaKey The SchemaKey contains a Schemas name and version. Beta
StructArrayProperty Beta
StructClass A Typescript class representation of an ECStructClass. Beta
StructProperty Beta
Unit An abstract class that adds the ability to define Units and everything that goes with them, within an ECSchema as a Beta
UnitSystem Beta

Enumerations

Name Description  
CustomAttributeContainerType Defines the valid CustomAttribute container types. Beta
DecimalPrecision Beta
ECClassModifier Beta
ECObjectsStatus Beta
FormatTraits Beta
FormatType Beta
FractionalPrecision Beta
PrimitiveType Primitive data types for ECProperties. Beta
PropertyType Beta
RelationshipEnd Identifer for an ECRelationshipConstraint. Beta
SchemaItemType Beta
SchemaMatchType Defines what sort of match should be used when locating a schema. Beta
ScientificType Beta
ShowSignOption Beta
StrengthDirection Beta
StrengthType Beta

Global Functions

Name Description  
classModifierToString Beta
containerTypeToString Creates a string representing a valid CustomAttributeContainerType. Beta
parseClassModifier Parses the provided string into an ECClassModifier if the string is a valid modifier. Beta
parseCustomAttributeContainerType Parses the given string into the appropriate CustomAttributeContainerType if the string is valid. Beta
parsePrimitiveType Tries to parse the given string as one of the 10 primitive types. Beta
parseRelationshipEnd Beta
parseSchemaItemType Tries to parse the given string as one of the 8 schema item types. Beta
parseStrength Takes a string representing a StrengthType, will parse it and return the corresponding StrengthType. Beta
parseStrengthDirection Beta
primitiveTypeToString Beta
propertyTypeToString Beta
relationshipEndToString Beta
schemaItemTypeToString Converts a valid SchemaItemType to a display string. Beta
serializeCustomAttributes Beta
strengthDirectionToString Beta
strengthToString Beta

Interfaces

Name Description  
ArrayPropertyProps Beta
ClassProps Beta
ConstantProps Beta
CustomAttribute Beta
CustomAttributeClassProps Beta
CustomAttributeContainerProps Beta
CustomAttributeSet Beta
EntityClassProps Beta
EnumerationPropertyProps Beta
EnumerationProps Beta
Enumerator Beta
EnumeratorProps Beta
FormatProps Beta
InvertedUnitProps Beta
KindOfQuantityProps Beta
MixinProps Beta
NavigationPropertyProps Beta
PhenomenonProps Beta
PrimitiveArrayPropertyProps Beta
PrimitiveOrEnumPropertyBaseProps Beta
PrimitivePropertyProps Beta
PropertyCategoryProps Beta
PropertyProps Beta
RelationshipClassProps Beta
RelationshipConstraintProps Beta
SchemaItemProps Beta
SchemaKeyProps JSON Object interface used to deserialize into a SchemaKey. Beta
SchemaProps Beta
SchemaReferenceProps Beta
StructArrayPropertyProps Beta
StructPropertyProps Beta
UnitProps Beta

Namespaces

Name Description  
PropertyTypeUtils Beta

Type Aliases

Name Description  
AnyArrayProperty Beta
AnyClass Beta
AnyClassProps Beta
AnyECType Beta
AnyEnumerationProperty Beta
AnyEnumerator Beta
AnyPrimitiveProperty Beta
AnyProperty Beta
AnyPropertyProps Beta
AnySchemaItem Beta
AnySchemaItemProps Beta
AnyStructProperty Beta
LazyLoadedConstant Beta
LazyLoadedCustomAttributeClass Beta
LazyLoadedECClass Beta
LazyLoadedEntityClass Beta
LazyLoadedEnumeration Beta
LazyLoadedFormat Beta
LazyLoadedInvertedUnit Beta
LazyLoadedKindOfQuantity Beta
LazyLoadedMixin Beta
LazyLoadedPhenomenon Beta
LazyLoadedPropertyCategory Beta
LazyLoadedRelationshipClass Beta
LazyLoadedRelationshipConstraintClass Beta
LazyLoadedSchema Beta
LazyLoadedSchemaItem Beta
LazyLoadedStructClass Beta
LazyLoadedUnit Beta
LazyLoadedUnitSystem Beta
StructClassProps Beta
UnitSystemProps Beta

Last Updated: 20 October, 2021