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

SchemaView.Schema Class @beta

Lightweight view over a schema in a SchemaView. Holds only a view reference and an index - no data duplication, no mutable state.

Methods

Name Description
getClass(name: string): SchemaView.Class | undefined Find a class by name within this schema (case-insensitive).  
getClasses(filter?: ClassType): IterableIterator<SchemaView.Class> Iterate classes in this schema.  
getEnumeration(name: string): SchemaView.Enumeration | undefined Find an enumeration by name within this schema (case-insensitive).  
getEnumerations(): IterableIterator<SchemaView.Enumeration> Iterate all enumerations in this schema.  
getKindOfQuantities(): IterableIterator<SchemaView.KindOfQuantity> Iterate all KindOfQuantity items in this schema.  
getKindOfQuantity(name: string): SchemaView.KindOfQuantity | undefined Find a KindOfQuantity by name within this schema (case-insensitive).  
getPropertyCategories(): IterableIterator<SchemaView.PropertyCategory> Iterate all PropertyCategory items in this schema.  
getPropertyCategory(name: string): SchemaView.PropertyCategory | undefined Find a PropertyCategory by name within this schema (case-insensitive).  

Properties

Name Type Description
alias Accessor ReadOnly string    
description Accessor ReadOnly string    
ecInstanceId Accessor ReadOnly number Row ID from ec_Schema.  
fullName Accessor ReadOnly string "SchemaName.RR.WW.mm" - dot-separated, matching the EC schema versioning convention.  
isHidden Accessor ReadOnly boolean Reflects the HiddenSchema custom attribute from CoreCustomAttributes.  
label Accessor ReadOnly string    
minorVersion Accessor ReadOnly number    
name Accessor ReadOnly string    
readVersion Accessor ReadOnly number    
writeVersion Accessor ReadOnly number    

Defined in

Last Updated: 27 May, 2026