ECClass Class

Beta  

A common abstract class for all of the ECClass types.

Extends

Extended by

Implements

Methods

Name Description
constructor(schema: Schema, name: string, modifier?: ECClassModifier): ECClass    
addCustomAttribute(customAttribute: CustomAttribute): void Protected    
addProperty<T extends Property>(prop: T extends Property): T extends Property Protected Convenience method for adding an already loaded ECProperty used by create*Property methods.  
buildPropertyCache(result: Property[], existingValues?: Map<string, number>, resetBaseCaches: boolean = false): Promise<void> Protected    
buildPropertyCacheSync(result: Property[], existingValues?: Map<string, number>, resetBaseCaches: boolean = false): void Protected    
createPrimitiveArrayProperty(name: string, primitiveType: PrimitiveType): Promise<PrimitiveArrayProperty> Protected Creates a PrimitiveArrayECProperty.  
createPrimitiveArrayProperty(name: string, primitiveType: Enumeration): Promise<EnumerationArrayProperty> Protected    
createPrimitiveArrayPropertySync(name: string, primitiveType: PrimitiveType): PrimitiveArrayProperty Protected Creates a PrimitiveArrayECProperty.  
createPrimitiveArrayPropertySync(name: string, primitiveType: Enumeration): EnumerationArrayProperty Protected    
createPrimitiveProperty(name: string, primitiveType: Enumeration): Promise<EnumerationProperty> Protected    
createPrimitiveProperty(name: string, primitiveType: PrimitiveType): Promise<PrimitiveProperty> Protected Creates a PrimitiveECProperty.  
createPrimitivePropertySync(name: string, primitiveType: Enumeration): EnumerationProperty Protected    
createPrimitivePropertySync(name: string, primitiveType: PrimitiveType): PrimitiveProperty Protected Creates a PrimitiveECProperty.  
createStructArrayProperty(name: string, structType: string | StructClass): Promise<StructArrayProperty> Protected    
createStructArrayPropertySync(name: string, structType: string | StructClass): StructArrayProperty Protected    
createStructProperty(name: string, structType: string | StructClass): Promise<StructProperty> Protected    
createStructPropertySync(name: string, structType: string | StructClass): StructProperty Protected    
fromJSON(classProps: ClassProps): Promise<void>    
fromJSONSync(classProps: ClassProps): void    
getAllBaseClasses(): AsyncIterableIterator<ECClass> Iterates (recursively) over all base classes and mixins, in "property override" order.  
getAllBaseClassesSync(): Iterable<AnyClass>    
getBaseClassSync(): ECClass | undefined    
getCustomAttributes(): Promise<CustomAttributeSet> Retrieve all custom attributes in the current class and its bases  
getCustomAttributesSync(): CustomAttributeSet Retrieve all custom attributes in the current class and its bases.  
getInheritedProperty(name: string): Promise<Property | undefined> Searches the base class, if one exists, for the property with the name provided.  
getInheritedPropertySync(name: string): Property | undefined Searches the base class, if one exists, for the property with the name provided.  
getProperties(resetCache: boolean = false): Promise<Property[]> Iterates all properties, including the ones merged from base classes and mixins.  
getPropertiesSync(resetCache: boolean = false): Property[] Iterates all properties, including the ones merged from base classes and mixins.  
getProperty(name: string, includeInherited: boolean = false): Promise<Property | undefined> Searches, case-insensitive, for a local ECProperty with the name provided.  
getPropertySync(name: string, includeInherited: boolean = false): Property | undefined Searches, case-insensitive, for a local ECProperty with the name provided.  
is(targetClass: ECClass): Promise<boolean>    
is(targetClass: string, schemaName: string): Promise<boolean> Indicates if the targetClass is of this type.  
isSync(targetClass: ECClass): boolean A synchronous version of the ECClass.is, indicating if the targetClass is of this type.  
loadPrimitiveType(primitiveType: string | PrimitiveType | Enumeration | undefined, schema: Schema): Promise<PrimitiveType | Enumeration> Protected    
loadPrimitiveTypeSync(primitiveType: string | PrimitiveType | Enumeration | undefined, schema: Schema): PrimitiveType | Enumeration Protected    
loadStructType(structType: string | StructClass | undefined, schema: Schema): Promise<StructClass> Protected    
loadStructTypeSync(structType: string | StructClass | undefined, schema: Schema): StructClass Protected    
toJSON(standalone: boolean = false, includeSchemaVersion: boolean = false): ClassProps Save this Classes properties to an object for serializing to JSON.  
traverseBaseClasses(callback: (ecClass: ECClass, arg?: any) => boolean, arg?: any): Promise<boolean> Asynchronously traverses through the inheritance tree, using depth-first traversal, calling the given callback  
traverseBaseClassesSync(callback: (ecClass: ECClass, arg?: any) => boolean, arg?: any): boolean Synchronously traverses through the inheritance tree, using depth-first traversal, calling the given callback  
mergeProperties(target: Property[], existingValues: Map<string, number>, propertiesToMerge: Property[], overwriteExisting: boolean): void ProtectedStatic    

Inherited methods

Name Inherited from Description
equalByKey(thisSchemaItem: SchemaItem, thatSchemaItemOrKey?: SchemaItem | SchemaItemKey): boolean Static SchemaItem Indicates if the two SchemaItem objects are equal by comparing their respective SchemaItem.key properties.
parseFullName(fullName: string): [string, string] Static SchemaItem Parses the given full name, {schemaName}.{schemaItemName} or {schemaName}:{schemaItemName}, into two separate strings.

Properties

Name Type Description
_baseClass Protected undefined | LazyLoadedECClass    
_modifier Protected ECClassModifier    
_properties Protected undefined | Map<string, Property>    
baseClass Accessor LazyLoadedECClass | undefined    
customAttributes Accessor ReadOnly CustomAttributeSet | undefined    
modifier Accessor ReadOnly ECClassModifier    
properties Accessor ReadOnly IterableIterator<Property> | undefined    

Inherited properties

Name Type Inherited from Description
_description Protected undefined | string SchemaItem  
_key Protected SchemaItemKey SchemaItem  
_label Protected undefined | string SchemaItem  
description Accessor ReadOnly undefined | string SchemaItem  
fullName Accessor ReadOnly string SchemaItem  
key Accessor ReadOnly SchemaItemKey SchemaItem  
label Accessor ReadOnly undefined | string SchemaItem  
name Accessor ReadOnly string SchemaItem  
schema Schema SchemaItem  
schemaItemType SchemaItemType SchemaItem  

Defined in

Last Updated: 15 June, 2021