API Reference › ecSchema-metadata› Schema › SchemaView › SchemaView.Class

SchemaView.Class Class @beta

Lightweight view over a class in a SchemaView. For relationship-specific fields (strength, direction, source/target constraints), narrow via isRelationship() or assertRelationship() to get a SchemaView.RelationshipClass.

Extended by

Methods

Name Description
assertRelationship(): this is SchemaView.RelationshipClass    
getOwnProperties(): ReadonlyArray<SchemaView.Property> Own properties only (not inherited), in ordinal order.  
getProperties(): ReadonlyArray<SchemaView.Property> All properties including inherited, in inheritance order (base first, then mixins, then own).  
getProperty(name: string): SchemaView.Property | undefined Find a property by name (case-insensitive).  
is(classOrName: string | SchemaView.Class): boolean IS-A check.  
isCustomAttribute(): boolean    
isEntity(): boolean    
isMixin(): boolean    
isRelationship(): this is SchemaView.RelationshipClass Type predicate - narrows to SchemaView.RelationshipClass for access to strength, direction,  
isStruct(): boolean    
isView(): boolean    

Properties

Name Type Description
_ctx Protected Readonly SchemaView    
baseClass Accessor ReadOnly SchemaView.Class | undefined Single base class.  
derivedClasses Accessor ReadOnly ReadonlyArray<SchemaView.Class> Direct derived classes.  
description Accessor ReadOnly string    
ecInstanceId Accessor ReadOnly number Row ID from ec_Class.  
fullName Accessor ReadOnly string "SchemaName:ClassName" - colon-separated, matching the EC class full name convention.  
isAbstract Accessor ReadOnly boolean    
isEffectivelyHidden Accessor ReadOnly boolean Computed hidden status that walks the base class chain (not mixins).  
isHidden Accessor ReadOnly boolean | undefined Reflects the HiddenClass custom attribute from CoreCustomAttributes.  
isSealed Accessor ReadOnly boolean    
label Accessor ReadOnly string    
mixins Accessor ReadOnly ReadonlyArray<SchemaView.Class> Applied mixins in declaration order.  
modifier Accessor ReadOnly ClassModifier    
name Accessor ReadOnly string    
schema Accessor ReadOnly SchemaView.Schema    
type Accessor ReadOnly ClassType    

Defined in

Last Updated: 27 May, 2026